gfCAutoTestPointer.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCAutoTestPointer.h
*
*       Purpose:        Auto play input - real pointer events, taps and drags
*
*********************************************************************/
 
#ifndef gfCAutoTestPointerhdr
#define gfCAutoTestPointerhdr
 
#include <fsCore/fsBaseTypes.h>
#include <fsCore/fsPoint.h>
 
class fsCEntity;
class fsCUniqueId;
class fsIComponent;
class gfCAutoTestOverlay;
 
 
// Positions are pointer space, which is screen space: sPointerMsgParam::mPos
// goes straight to hitTest(), so aiming at screenPositionGet() needs no conversion.
class gfCAutoTestPointer
{
public:
 
        gfCAutoTestPointer(const fsIComponent& pOwner, gfCAutoTestOverlay& pOverlay, fsS32 pDragSteps);
 
        void tap(const fsPoint& pPos);
 
        // Drags run a step per update - keyOver() tests the dragged sprite's matrix,
        // which only refreshes once per update walk. pKeyEnt is the draggable being
        // picked up, if known, so the drop can be aimed by its icon.
        void dragBegin(const fsPoint& pFrom, const fsPoint& pTo, fsCEntity* pKeyEnt = nullptr);
        // True on the step the drag drops.
        fsBool dragStepAdvance();
        // Changes where the drag in flight will drop - before its first step.
        void dragRetarget(const fsPoint& pTo);
        // Lets the drag run out where it started rather than cutting it short.
        void dragHold();
        // Releases an in-flight drag rather than stranding a half-open gesture.
        void dragAbandon();
        fsBool dragActiveGet() const { return mDragActive; }
 
private:
 
        void event(const fsCUniqueId& pMessageType, const fsPoint& pPos, fsBool pDown);
        void dragOffsetCompensate();
 
        const fsIComponent& mOwner;
        gfCAutoTestOverlay& mOverlay;
 
        const fsS32 mDragSteps;
 
        fsBool mDragActive;
        fsPoint mDragFrom;
        fsPoint mDragTo;
        fsPoint mDragLastPos;
        fsS32 mDragStep;
        fsCEntity* mDragKeyEnt;
};
 
#endif