gfCAutoTestSweep.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCAutoTestSweep.h
*
*       Purpose:        Auto play blind coverage - where a tap may land
*
*********************************************************************/
 
#ifndef gfCAutoTestSweephdr
#define gfCAutoTestSweephdr
 
#include <vector>
 
#include <fsCore/fsBaseTypes.h>
#include <fsCore/fsPoint.h>
 
class fsCEntity;
class fsIComponent;
 
 
// A jittered walk over a cell grid, barred from places a blind tap must not
// land. It knows nothing about targets - that is gfCAutoTestAim's job.
class gfCAutoTestSweep
{
public:
 
        gfCAutoTestSweep(const fsIComponent& pOwner, fsS32 pPitch, fsS32 pSkipLimit);
 
        // The sub-scene the player is in - input cannot reach anything outside it.
        static fsCEntity* currentSubSceneEntGet();
 
        // Sized from the current display, so call per level.
        void geometryInit();
        // Rebuilds the minigame piece lists. A scene walk - once a step, not per tap.
        void sceneRefresh();
 
        // Advances the sweep, allowed or not.
        fsPoint pointNextGet();
        // Walks the sweep on past barred points, up to the skip limit.
        fsBool allowedPointNextGet(fsPoint& pPoint);
        fsBool randomAllowedPointGet(fsPoint& pPoint) const;
        // A random point outside pEnt's sprite.
        fsBool randomPointOutsideGet(fsCEntity* pEnt, fsPoint& pPoint) const;
 
        fsBool tapAllowedGet(const fsPoint& pPos) const;
 
        // The visible exit of an open sub-scene, which closes it on a tap outside.
        fsCEntity* openSubSceneEntGet() const;
 
        // Round robin over loose jigsaw pieces; nullptr when there are none.
        fsCEntity* jigsawPieceNextGet();
        const std::vector<fsCEntity*>& jigsawPiecesGet() const { return mJigsawPieces; }
 
private:
 
        fsPoint randomPointGet() const;
 
        const fsIComponent& mOwner;
 
        // Cell size, and the band left clear of the top and bottom Gui bars.
        const fsS32 mPitch;
        const fsS32 mYMin;
        fsS32 mYMax;
 
        fsS32 mColumns;
        fsS32 mCellCount;
        // Coprime to the cell count, so a pass still visits every cell exactly once.
        fsS32 mStride;
        fsS32 mIndex;
        const fsS32 mSkipLimit;
 
        // Pieces already home. Tapping one picks it back up and undoes the progress.
        std::vector<fsCEntity*> mCompletedPieces;
        // A tap rotates a jigsaw piece, so only a drag moves one towards home.
        std::vector<fsCEntity*> mJigsawPieces;
        fsS32 mJigsawCursor;
};
 
#endif