gfCVisibilityStateComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       File:           gfCVisibilityStateComponent.h
*
*       Purpose:        A component which listens for messages modify visibility
*
*********************************************************************/
 
#ifndef gfCVisibilityStateComponenthdr
#define gfCVisibilityStateComponenthdr
 
#include <fsAppCore/src/components/fsIMessageListenerComponent.h>
#include <fsCore/src/fsCUniqueId.h>
 
 
class gfCVisibilityStateComponent : public fsIMessageListenerComponent
{
        friend class fsCComponentFactory;
 
public:
 
        static const fsCUniqueId mLockBrokenMsg;
 
        static fsBool statusChangerGet(const fsStr& pEntKey);
 
        fsBool initiallyVisibleGet() const;
 
        void listenersRegisterDo() override;
        void listenersDeregisterDo() override;
        fsBool messageProcessDo(const fsCUniqueId& pMessageType,
                                const fsIMessageDispatcher::sMessageParameters& pParam) override;
 
        static const fsCUniqueId mMaskResetMsg;
        static const fsCUniqueId mMaskActionMsg;
 
        static const fsCUniqueId mTypeId;
 
        // Extension point for a consuming genre core (e.g. gfHogCore's
        // gfCMaskComponent) to add its own "is this key a mask/common-prefix
        // entity" check without this generic component needing to know about
        // that genre's mask-naming convention. Same pattern as
        // gfICollectableComponent::extraPersistentTagCheckProviderSet.
        static void maskKeyCheckProviderSet(fsBool (*pProvider)(const fsStr& pKeyName));
 
protected:
 
        static fsIComponent* create(fsCEntity* pParent);
 
        gfCVisibilityStateComponent(fsCEntity* pParent);
        virtual ~gfCVisibilityStateComponent();
 
private:
 
        void animationComponentsProcess(fsBool pActive);
 
        fsBool messageForMe(const fsIMessageDispatcher::sMessageParameters& pParam) const;
 
        fsStr mKeyName;
};
 
#endif