gfCParkLensComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCParkLensComponent.h
*
*       Purpose:        Pan/zoom lens over the park's tile-map view (Phase 1).
*                               Drives the fsCView entity's scale (zoom) and position
*                               (pan) from drag/pinch gestures - the whole park, being
*                               children of the view, comes along. Sits on its own
*                               full-canvas hit-test entity so it catches gestures across
*                               the screen; its target is the view, not itself.
*
*                               Phase 2 (deferred): reconciling gesture taps with the
*                               existing tap-to-deploy components, and a desktop
*                               mouse-wheel zoom.
*
*********************************************************************/
 
#ifndef gfCParkLensComponenthdr
#define gfCParkLensComponenthdr
 
#include <fsCore/src/fsCUniqueId.h>
#include <fsCore/fsPoint.h>
 
#include <gfComponents/components/subScene/gfILensComponent.h>
 
class fsCEntity;
 
 
class gfCParkLensComponent : public gfILensComponent
{
        friend class fsCComponentFactory;
 
public:
 
        static const fsCUniqueId mTypeId;
 
        // Sets the zoom range and scroll bounds. pViewportSize is the on-screen
        // canvas; pContentSize is the map's on-screen size at min zoom (map pixels x
        // the view's fill-to-width scale). Both axes pan; starts fit-to-width and
        // centred. See fsCDrag::scrollRangeCalculate for how the two sizes bound the
        // pan range.
        void configure(const fsPoint& pViewportSize, const fsPoint& pContentSize,
                       fsF32 pMinZoom, fsF32 pMaxZoom);
 
        virtual ~gfCParkLensComponent();
 
protected:
 
        // The single park view is the pan/zoom target (it is not an fsISubScene, so
        // the base's subscene-search default won't find it).
        fsCEntity* const targetGetDo() override;
 
        // Phase 1: the park is always pannable/zoomable while the level is up.
        fsBool acceptingInputGet() const override { return true; }
 
        static fsIComponent* create(fsCEntity* pParent);
 
        gfCParkLensComponent(fsCEntity* pParent, fsBool pHandleTaps, fsBool pHandleDragEvent,
                             fsBool pHandlePinchEvents);
};
 
#endif