NPuzzleActivity

class NPuzzleActivity : AppCompatActivity

Class handling the core functionalities of this 8-puzzle app, including the actual gameplay.

Constructors

NPuzzleActivity

fun NPuzzleActivity()

Types

Companion

object Companion

Companion object containing constants related to the state, display, and statistics of this 8-puzzle app.

Properties

blankImageChunks

private lateinit var blankImageChunks: ArrayList<Bitmap>

Split puzzle images with dark color filter applied.

blankTilePos

private var blankTilePos: Int

Position of the blank tile in the puzzle grid (zero-based, following row-major order).

btnShuffle

private lateinit var btnShuffle: Button

Button for shuffling the puzzle tiles (if the game is not yet in session) or displaying the solution (if the game is already in session).

btnUpload

private lateinit var btnUpload: Button

Button for selecting a custom puzzle image from the Gallery (if the game is not yet in session) or skipping the solution (if the solution walkthrough is currently being played).

clRoot

private lateinit var clRoot: ConstraintLayout

Root of the layout.

fastestTime

private var fastestTime: Long

Fastest time taken by the user to solve an 8-puzzle.

fewestMoves

private var fewestMoves: Long

Fewest number of moves taken by the user to solve an 8-puzzle.

galleryLauncher

private lateinit var galleryLauncher: ActivityResultLauncher<Intent>

Activity result launcher related to choosing photos from the Gallery.

goalPuzzleState

private lateinit var goalPuzzleState: ArrayList<Int>

Goal puzzle state.

gvgPuzzle

private lateinit var gvgPuzzle: GridViewGesture

Puzzle grid.

imageChunks

private lateinit var imageChunks: ArrayList<Bitmap>

Split puzzle images.

indexOfCustom

private var indexOfCustom: Int = 0

Index of the custom image (that is, the option that allows the user to select a photo from the Gallery) in the selection of puzzle images.

isGalleryImageChosen

private var isGalleryImageChosen: Boolean = false

true if the current puzzle image was selected from the user's Gallery; false, otherwise.

isGameInSession

private var isGameInSession: Boolean = false

true if a game is ongoing; false, otherwise.

isPuzzleGridFrozen

private var isPuzzleGridFrozen: Boolean = false

true if the components of the puzzle grid (for example, the tiles) can be moved or clicked; false, otherwise.

isSolutionDisplay

private var isSolutionDisplay: Boolean = false

true if the solution walkthrough is currently being played; false, otherwise.

isSolutionPlay

private var isSolutionPlay: Boolean = false

true if the solution walkthrough resumes playing (after being paused); false, otherwise (that is, if the solution walkthrough is currently paused).

isSolutionSkip

private var isSolutionSkip: Boolean = false

true if the solution is skipped; false, otherwise.

isTimerRunning

private var isTimerRunning: Boolean = false

true if the timer is running (that is, a game is in session and the first move has been made); false, otherwise.

numMoves

private var numMoves: Long = 0

Tracks the number of moves for the current game.

numMovesSolution

private var numMovesSolution: Int = 0

Number of moves in the solution found by the app via the A* algorithm implemented in SolveUtil.

pbShuffle

private lateinit var pbShuffle: ProgressBar

Progress bar displayed during shuffling.

puzzleDimen

private var puzzleDimen: Int = 0

Dimension of the entire (square) puzzle grid.

puzzleImage

private lateinit var puzzleImage: Bitmap

Puzzle image.

puzzleImageChoices

private lateinit var puzzleImageChoices: Array<PuzzleImage>

Selection of puzzle images that come with the app.

puzzleImageIndex

private var puzzleImageIndex: Int = 0

Index of the currently selected puzzle image.

puzzleSolution

private var puzzleSolution: Stack<StatePair>? = null

Sequence of states from the current puzzle state to the goal state.

puzzleState

private lateinit var puzzleState: ArrayList<Int>

Current puzzle state.

shuffleHandler

private lateinit var shuffleHandler: Handler

Handler for shuffling the puzzle tiles.

shuffleRunnable

private lateinit var shuffleRunnable: ShuffleRunnable

Runnable related to shuffling the puzzle tiles.

shuffleScheduler

private lateinit var shuffleScheduler: ScheduledExecutorService

Scheduled executor service for shuffling the puzzle tiles.

solveDisplayHandler

private lateinit var solveDisplayHandler: Handler

Handler for displaying the solution to the 8-puzzle.

solveHandler

private lateinit var solveHandler: Handler

Handler for solving the 8-puzzle.

private lateinit var sp: SharedPreferences

Points to a file containing key-value pairs or, in the context of this app, the statistics related to the fewest number of moves and the fastest time taken in solving an 8-puzzle.

spnPuzzle

private lateinit var spnPuzzle: Spinner

Spinner for selecting the puzzle image.

tileDimen

private var tileDimen: Int = 0

Dimension of a (square) puzzle tile.

tileImages

private lateinit var tileImages: ArrayList<ImageButton>

Puzzle tiles.

timerHandler

private lateinit var timerHandler: Handler

Handler for keeping track of the time since the user has made the first move (provided that a game is in session).

timeTaken

private var timeTaken: Long = 0

Tracks the time taken for the current game.

tvFastestTime

private lateinit var tvFastestTime: TextView

Text view for the fastest time to solve the puzzle.

tvFewestMoves

private lateinit var tvFewestMoves: TextView

Text view for the fewest number of moves to solve the puzzle.

tvMoveNumber

private lateinit var tvMoveNumber: TextView

Text view for the current number of moves taken in the current attempt to solve the puzzle.

tvSuccess

private lateinit var tvSuccess: TextView

Text view for the success message.

tvTimeTaken

private lateinit var tvTimeTaken: TextView

Text view for the current time taken in the current attempt to solve the puzzle.

tvTitle

private lateinit var tvTitle: TextView

Text view for the title of the app.

tvTrivia

private lateinit var tvTrivia: TextView

Text view for the trivia.

Inherited properties

mActivityResultRegistry

private val mActivityResultRegistry: ActivityResultRegistry

mContentLayoutId

@LayoutRes()

private val mContentLayoutId: Int

mContextAwareHelper

val mContextAwareHelper: ContextAwareHelper

mCreated

val mCreated: Boolean

mDefaultFactory

private val mDefaultFactory: ViewModelProvider.Factory

mDelegate

private val mDelegate: AppCompatDelegate

mExtraDataMap

private val mExtraDataMap: SimpleArrayMap<Class<out ComponentActivity.ExtraData>, ComponentActivity.ExtraData>

mFragmentLifecycleRegistry

val mFragmentLifecycleRegistry: LifecycleRegistry

mFragments

val mFragments: FragmentController

mLifecycleRegistry

private val mLifecycleRegistry: LifecycleRegistry

mNextLocalRequestCode

private val mNextLocalRequestCode: AtomicInteger

mOnBackPressedDispatcher

private val mOnBackPressedDispatcher: OnBackPressedDispatcher

mResources

private val mResources: Resources

mResumed

val mResumed: Boolean

mSavedStateRegistryController

val mSavedStateRegistryController: SavedStateRegistryController

mStopped

val mStopped: Boolean

mViewModelStore

private val mViewModelStore: ViewModelStore

Functions

animateSolution

private fun animateSolution()

Handles the animation of the puzzle tiles during the solution walkthrough.

blankDisplayedStats

private fun blankDisplayedStats()

Removes the statistics displayed (replacing them with hyphen placeholders) when the solution walkthrough is played.

controlSolutionDisplay

private fun controlSolutionDisplay()

Updates the display depending on whether the solution walkthrough is paused or resumed.

disableClickables

private fun disableClickables()

Disables all the clickable components.

displayBlankPuzzle

private fun displayBlankPuzzle()

Display the puzzle grid with all 9 tiles having a dark color filter applied.

displayFastestTime

private fun displayFastestTime()

Displays the fewest time taken to solve the 8-puzzle.

displayFewestMoves

private fun displayFewestMoves()

Displays the fewest number of moves taken to solve the 8-puzzle.

displayPuzzle

private fun displayPuzzle()

Displays the puzzle grid, with the correct tile images (8 tiles with no filter applied and 1 tile with a dark color filter applied to designate it as the blank tile).

displaySolution

private fun displaySolution()

Displays the solution found by the app via the A* algorithm implemented in SolveUtil.

displayStats

private fun displayStats()

Displays the game statistics (namely the fewest number of moves and the fastest time taken to solve the 8-puzzle).

displaySuccessMessage

private fun displaySuccessMessage(solveStatus: SolveStatus)

Displays the pertinent success message based on the game status, which, in turn, depends on whether the user solves the puzzle or opts to play the solution walkthrough instead.

enableClickables

private fun enableClickables()

Enables all the clickable components.

endGame

private fun endGame(solveStatus: SolveStatus)

Ends the game that is currently in session, in effect stopping the timer, displaying the pertinent success message, and resetting the variables in preparation for a new game if the user was able to solve the puzzle or for displaying the solution, otherwise.

endSolution

private fun endSolution()

Invoked when the solution walkthrough finishes.

finishShuffling

private fun finishShuffling()

Updates the components when the shuffling animation is fully completed.

getValidShuffledState

private fun getValidShuffledState()

Generates a valid shuffling of the puzzle tiles.

halfwayShuffling

private fun halfwayShuffling()

Updates the components when the shuffling animation is halfway finished.

hideSystemUI

private fun hideSystemUI()

Hides the navigation bar, status bar, and app bar, and displays the app in sticky immersive mode.

initChunks

private fun initChunks()

Sets the image chunks displayed on the individual puzzle tiles.

initComponents

private fun initComponents()

Initializes the components of this activity, particularly the layouts, widgets, listeners, and adapters.

initGalleryLauncher

private fun initGalleryLauncher()

Initializes the activity result launcher related to choosing an image from the Gallery.

initHandlers

private fun initHandlers()

Initializes the handlers related to shuffling the tiles, triggering the game timer, and displaying the solution.

initPuzzle

private fun initPuzzle()

Initializes the dynamic components and listeners related to the puzzle grid.

initPuzzleImage

private fun initPuzzleImage()

Sets the puzzle image to the most recently selected image (persists even when the app is closed) and resizes (crops) it to fit the dimensions of the puzzle grid.

initSharedPreferences

private fun initSharedPreferences()

Retrieves the values stored using shared preferences, particularly those pertaining to the game statistics (and displays them as well).

initStateAndTileImages

private fun initStateAndTileImages()

Initializes the puzzle state and the images of the tiles in the grid.

launchTimer

private fun launchTimer()

Launches and starts the timer when a game in session, updating its display every second until halted when the game ends.

loadPuzzle

private fun loadPuzzle(imagePath: Uri?)

Sets the puzzle image to the photo chosen from the Gallery and performs the necessary bitmap manipulations to update the display on the puzzle grid.

private fun loadPuzzle(position: Int)

Loads and displays the puzzle grid, with the correct tile images (8 tiles with no filter applied and 1 tile with a dark color filter applied to designate it as the blank tile).

moveTile

private fun moveTile(direction: FlingDirection, position: Int)

Moves the specified tile in the given direction of the user's fling gesture.

onCreate

protected open override fun onCreate(savedInstanceState: Bundle?)

Called when the activity is first created.

onRequestPermissionsResult

open override fun onRequestPermissionsResult(requestCode: Int, permissions: Array<out String>, grantResults: IntArray)

Callback for the result from requesting permissions.

onResume

protected open override fun onResume()

Called after onRestoreInstanceState(Bundle), onRestart(), or onPause().

onWindowFocusChanged

open override fun onWindowFocusChanged(hasFocus: Boolean)

Called when the current Window of the activity gains or loses focus.

pauseSolution

private fun pauseSolution()

Pauses the solution walkthrough.

permissionsResult

private fun permissionsResult(grantResults: IntArray)

Defines the behavior related to choosing an image from the Gallery based on the permissions granted by the user.

prepareForNewGame

private fun prepareForNewGame()

Handles the back-end and front-end operations in preparation for a new game.

prepareForSolution

private fun prepareForSolution()

Updates the components in preparation for showing the solution found by the app via the A* algorithm implemented in SolveUtil.

resetDisplayedStats

private fun resetDisplayedStats()

Resets the statistics displayed (setting their values to 0) at the start of a game (that is, immediately after the shuffling animation finishes).

resetState

private fun resetState()

Resets the puzzle state back to the original state (that is, the goal state).

resumeSolution

private fun resumeSolution()

Resumes playing the solution walkthrough.

saveFastestTime

private fun saveFastestTime()

Updates the saved fastest time taken to solve the puzzle by storing the new values in the shared preferences file.

saveFewestAndFastest

private fun saveFewestAndFastest()

Updates the saved fewest number of moves and fastest time taken to solve the puzzle by storing the new values in the shared preferences file.

saveFewestMoves

private fun saveFewestMoves()

Updates the saved fewest number of moves taken to solve the puzzle by storing the new values in the shared preferences file.

saveStats

private fun saveStats(solveStatus: SolveStatus)

Updates the saved statistics (namely the fewest number of moves and fastest time taken to solve the puzzle) at the end of a game provided that the user has set a new record for these statistics.

setBtnShuffleAction

private fun setBtnShuffleAction()

Sets the click event listener for the button for shuffling the tiles (if the game is not yet in session) or displaying the solution (if the game is already in session).

setBtnUploadAction

private fun setBtnUploadAction()

Sets the click event listener for the button for selecting a custom puzzle image from the Gallery (if the game is not yet in session) or skipping the solution (if the solution walkthrough is currently being played).

setDimensions

private fun setDimensions()

Sets the dimensions of the puzzle grid and its individual tiles.

setOnFlingListener

private fun setOnFlingListener()

Sets the listener for responding to detected fling gestures.

setSpnPuzzleAction

private fun setSpnPuzzleAction()

Sets the item selection event listener for the spinner.

setTouchSlopThreshold

private fun setTouchSlopThreshold()

Sets the distance in pixels a touch can wander before it is registered as a fling gesture.

showTileAt

private fun showTileAt(position: Int)

Removes the dark color filter on the specified tile as part of the shuffling animation.

shuffle

private fun shuffle()

Handles the back-end and front-end operations when the puzzle tiles are shuffled.

skipSolution

private fun skipSolution()

Skips the solution walkthrough.

solve

private fun solve()

Handles the back-end and front-end operations when the user opts to display the solution found by the app via the A* algorithm implemented in SolveUtil.

startShowingTiles

private fun startShowingTiles()

Removes the dark color filter on the eight non-blank tiles at random intervals as part of the shuffling animation.

startSolution

private fun startSolution()

Invoked when the solution walkthrough starts.

trackMove

private fun trackMove()

Updates and displays the number of movies every time a user moves a tile.

updateComponents

private fun updateComponents()

Updates the components depending on whether the shuffling animation is halfway finished or fully completed.