gfCPhotographableComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCPhotographableComponent.h
*
*       Purpose:        Marks an entity as being eligible for photo capture
*                               and reuses its particle emitter hit testing.
*
*********************************************************************/
 
#ifndef gfCPhotographableComponenthdr
#define gfCPhotographableComponenthdr
 
#include <fsCore/src/fsCUniqueId.h>
 
#include "gfICollectableComponent.h"
 
struct fsPoint;
class fsRect;
 
 
class gfCPhotographableComponent : public gfICollectableComponent
{
        friend class fsCComponentFactory;
 
public:
 
        static const fsCUniqueId mTypeId;
        static const fsStr mEntityPrefix;
 
        const fsStr& subjectIdGet() const;
        fsBool hitTest(const fsPoint& pScreenPos) const;
        fsS32 photoScoreGet(const fsRect& pScreenRect) const;
 
protected:
 
        void resetDo() override;
        void finaliseDo() override;
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        static fsIComponent* create(fsCEntity* pParent);
 
        gfCPhotographableComponent(fsCEntity* pParent);
        virtual ~gfCPhotographableComponent();
};
 
#endif