fsIComponent.h

Go to the documentation of this file.

/********************************************************************
*
*       Created:        25/2/2014   11:48
*
*       File:           fsIComponent.h
*
*       Author:         Mick Waites
*       
*       Purpose:        Component base. Components get added to Entities.
*
*********************************************************************/
 
#ifndef fsIComponenthdr
#define fsIComponenthdr
 
#include <fsCore/fsBaseTypes.h>
 
#include "../../src/fsCAppCoreMain.h"
#include "../../fsIScene.h"
 
class fsCEntity;
class fsCVariableTable;
 
 
class fsIComponent
{
        friend class fsCComponentFactory;
 
public:
 
        template <typename TInterface>
        std::vector<fsCEntity*> appSceneEntitiesWithComponentOfFamilyType() const;
 
        template <typename TInterface>
        fsCEntity* appSceneFirstEntityWithComponentOfFamilyType() const;
 
        fsCEntity* appSceneEntityNamed(const fsStr& pName) const;
 
        void reset();
        void update(fsS32 pDeltaMs);
        void render();
        void matrixApply();
        void postLoad();
        void deserialise();
        void serialise();
        void initialiseFromVariableTable(const fsCVariableTable& pVars); // mainly gui components using layout info file, but also some minigame logic components
        void initialise(); // all components when constructed in factory after all components are created
        void finalise(); // called after childAdd run - when the parent entity is linked in
 
        fsCEntity* parentGet() const;
        fsCEntity* grandparentGet() const;
 
protected:
 
        virtual void resetDo() {}
 
        virtual void updateDo(fsS32 pDeltaMs) {}
 
        virtual void renderDo() {}
 
        virtual void matrixApplyDo() {}
 
        virtual void postLoadDo() {}
 
        virtual void deserialiseDo() {}
 
        virtual void serialiseDo() {}
 
        virtual void initialiseFromVariableTableDo(const fsCVariableTable& pVars);
 
        virtual void initialiseDo() {};
 
        virtual void finaliseDo() {};
 
        virtual ~fsIComponent();
        fsIComponent(fsCEntity* pParent);
 
private:
 
        fsCEntity* const mParent;
 
#if !defined fsRELEASE
        fsBool mHierarchyCheckSuccess;
#endif
};
 
 
template <typename TInterface>
std::vector<fsCEntity*> fsIComponent::appSceneEntitiesWithComponentOfFamilyType() const
{
        return fsCAppCoreMain::instanceGet()->sceneGet()->entitiesWithComponentsOfFamilyType<TInterface>();
}
 
template <typename TInterface>
fsCEntity* fsIComponent::appSceneFirstEntityWithComponentOfFamilyType() const
{
        return fsCAppCoreMain::instanceGet()->sceneGet()->firstEntityWithComponentsOfFamilyType<TInterface>();
}
#endif