gfICutterComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfICutterComponent.h
*
*       Purpose:        Interface for the cutter components that cut out
*                               the various mini game tiles
*
*********************************************************************/
 
#ifndef gfICutterComponenthdr
#define gfICutterComponenthdr
 
#include <vector>
 
#include <fsCore/fsStr.h>
#include <fsCore/fsPoint.h>
#include <fsCore/src/fsCUniqueId.h>
 
#include <fsAppCore/src/components/fsIComponent.h>
 
class fsCEntity;
class gfIStencil;
class fsCBrush;
class gfIMinigameLogic;
 
 
class gfICutterComponent : public fsIComponent
{
public:
 
        static const fsCUniqueId mTypeId;
 
        static fsStr sourceImageFilenameGet(const fsStr& pLevelFolder, const fsStr& pLayerNameSansPrefix);
 
        virtual void cut(fsBool pFirstTime);
 
        virtual void stencilsCreate()
        {
        }
 
        virtual void minigameEntitiesCreate(const fsCVariableTable& pStyle, const fsStr& pLevelName, fsCEntity* pParent,
                                            const fsStr& pAutoMiniGameSourceArt, gfIMinigameLogic* pMingameLogic);
 
protected:
 
        void deserialiseDo() override;
        void serialiseDo() override;
 
        virtual void doCut(fsCEntity* pEnt, gfIStencil* pStencil, fsBool pFirstTime) = 0;
        virtual fsStr minigamePieceNameGet() const = 0;
        virtual gfIStencil* const stencilRestore() = 0;
 
        gfICutterComponent(fsCEntity* pParent);
        virtual ~gfICutterComponent();
 
        virtual void doSetup(const fsCVariableTable& pStyle, const fsStr& pLevelName) {}
 
        void setup(const fsCVariableTable& pStyle, const fsStr& pLevelName, const fsStr& pAutoMiniGameSourceArt);
 
        // If both origin and the piece-parent layer are offset they double up: fold origin into the
        // layer. Only valid when pieces actually inherit the layer's position via composition.
        fsPoint originLayerOffsetReconcile(fsCEntity* pPieceParent);
 
        // For cutter types whose pieces don't compose the layer's position (jigsaw gets swept off it
        // by draw-order management; rotate never parents pieces to it): add it into the grid math
        // directly instead, without touching the layer entity. Sets mLayerPositionBaked.
        void layerPositionBakeIntoGrid(fsCEntity* pLayerEntity);
 
        fsStr pieceNameGet(fsS32 pRow, fsS32 pCol) const;
 
        std::vector<gfIStencil*> mStencils;
        std::vector<fsCEntity*> mMinigameEnts;
 
        std::shared_ptr<fsCBrush> mSourceImage;
 
        fsS32 mPieceWidth;
        fsS32 mPieceHeight;
 
        fsS32 mCols;
        fsS32 mRows;
 
        fsPoint mGridOrigin;   // grid layout anchor; legacy scene originX/Y is folded into this
        fsBool mLayerPositionBaked;   // true once layerPositionBakeIntoGrid has run - see its comment
 
        fsCEntity* mSceneRoot;
        fsCEntity* mMinigameLogic;
 
private:
 
        static const fsStr mStencilChunkMarker;
        static const fsStr mStencilMarker;
};
 
#endif