D:/work/nytro/include/game/nyEntity.h

Go to the documentation of this file.

#ifndef __NYTRO_Entity_H
#define __NYTRO_Entity_H

//*****************************************************************************
// Nytro GameEngine
//
// © Copyright 7thFACTOR Entertainment
// All rights reserved
//*****************************************************************************

#include "system/nyCommon.h"
#include "system/nyBase.h"
#include "system/nyParameterList.h"
#include "scene/nySceneNode.h"
#include "physics/nyPhysicsProvider.h"
#include "gui/nyUi.h"

namespace Nytro
{
    namespace Game
    {
        using namespace Core;
        using namespace Math;

        class Entity;
        class FlowGraphEventNode;

        #define kEntityCategory_General "General"
        #define kEntityCategory_Environment "Environment"
        #define kEntityCategory_Ai "Artificial Intelligence"
        #define kEntityCategory_Cinematic "Cinematic"
        #define kEntityCategory_Effects "Effects"
        #define kEntityCategory_Audio "Audio"

        class NYTRO_API EntityGroup
        {
            public:

                EntityGroup()
                {
                    m_bOpened = false;
                }

                string          m_name;
                bool            m_bOpened;
        };

        class NYTRO_API EntityLayer
        {
            public:

                EntityLayer()
                {
                    m_bVisible = true;
                    m_bLocked = false;
                }

                string  m_name, m_description;
                bool    m_bVisible;
                bool    m_bLocked;
        };

        class NYTRO_API PrefabEntityData
        {
            public:

                void copyPropertiesAndAttributesTo( Base* pObj );

                string              m_className;
                map<string,string>  m_properties,
                                    m_attributes;
        };

        class NYTRO_API PrefabData : public Resource
        {
            public:

                NYTRO_CLASS_NAME( PrefabData );

                PrefabData();
                ~PrefabData();

                EResult  load( const char* pFilename = NULL );
                EResult  save( const char* pFilename = NULL );
                EResult  unload();
                vector<PrefabEntityData>& getPrefabEntities();

            protected:

                vector<PrefabEntityData> m_prefabEntities;
        };

        class NYTRO_API EntityEvent: public Base
        {
            public:

                EntityEvent( const char* pName = "", Variant* pParams = NULL, uint32 aParamCount = 0 );

                virtual void trigger( Base* pInitiator, ParameterList* pParams = NULL );
                virtual void resetTrigger();

                char*               m_pEventName;
                uint32              m_maxTriggerCount,
                                    m_currentTriggerCount;
                Base*               m_pInitiator;
                Entity*             m_pOwner;
                ParameterList       m_params;
                FlowGraph*          m_pFlowGraph;
                FlowGraphEventNode* m_pGraphEventNode;
                bool                m_bTriggerOnClientSide, m_bTriggered;
        };

        class NYTRO_API EntityVisualEditHandle : public SceneNode
        {
            public:

                EntityVisualEditHandle()
                {
                    m_bHandleMouseHovered = m_bHandleSelected = false;
                }

                bool m_bHandleMouseHovered, m_bHandleSelected;
        };

        class NYTRO_API Entity : public SceneNode, public ResourceObserver
        {
            public:

                enum EEntityFlags
                {
                    eEntityFlag_Selectable  = NYTRO_BIT(0),
                    eEntityFlag_Selected = NYTRO_BIT(1),
                    eEntityFlag_CastShadows = NYTRO_BIT(2),
                    eEntityFlag_ReceiveShadows = NYTRO_BIT(3),
                    eEntityFlag_CanBeReflected = NYTRO_BIT(4), 
                    eEntityFlag_StaticEntity = NYTRO_BIT(5),
                    eEntityFlag_CanBeHiddenByOcclusion = NYTRO_BIT(6)
                };

                Entity();
                virtual ~Entity();

                EntityGroup*                getGroup();
                string                      getPrefabFileName();
                PrefabData*                 getPrefab();
                uint32                      getEntityFlags();
                void                        setEntityFlags( uint32 aFlags );
                virtual void                setGroup( EntityGroup* pGroup );
                virtual void                setPrefabFileName( const char* pFileName );
                virtual void                setPrefab( PrefabData* pPrefab );
                virtual bool                traceRay( Ray& rRay, SceneNodeHitInfo* pHit, ETraceRayAccuracy aAccuracy = eTraceRayAccuracy_Brute );
                virtual void                schematicRender();
                virtual void                triggerEvent( EntityEvent* pEvent, Base* pInitiator, ParameterList* pParams = NULL );
                void                        triggerEvent( const char* pEvent, Base* pInitiator, ParameterList* pParams = NULL );
                map<char*,EntityEvent*>&    getEvents();
                void                        addEvent( EntityEvent* pEvent );
                void                        resetEvents();
                EntityLayer*                getLayer();
                void                        setLayer( EntityLayer* pLayer );
                virtual EResult             loadFromStream( Stream* pStream );
                virtual EResult             saveToStream( Stream* pStream );

                //
                // Events of various types
                //

                virtual void                onEvent( EntityEvent* pEvent );
                virtual bool                onEditorDelete();
                virtual void                onEditorUndoDelete();
                virtual void                onStartSimulation();
                virtual void                onStopSimulation();
                virtual void                onBeforeUnloadResource( Resource* pRes );
                virtual void                onAfterReloadResource( Resource* pRes );
                virtual void                onPropertyValueChanged( voidptr pPropertyData );
                virtual void                onFormatGetPropertyValue( voidptr pPropertyData, string& rOutValue );
                virtual void                prepare();

                //
                // Editing methods
                //

                vector<EntityVisualEditHandle*>&    getVisualEditHandles();
                virtual void                        onVisualEditHandleMove( EntityVisualEditHandle* pHandle );
                virtual bool                        onVisualEditHandleDelete( EntityVisualEditHandle* pHandle );
                static void                         setShowConstantSizedEntityIcons( bool bShow );
                static UiFxTimer&                   getSelectionBlinkTimer();
                
                NYTRO_CLASS_HAS_PROPERTIES;

        protected:

                static bool                         s_bShowConstantSizedEntityIcons;
                static UiFxTimer                    s_selectionBlinkTimer;

                void drawEntityIcon();

                Vector3D                            m_initialTranslation, m_initialScale, m_iconOffsetFromAabbCenter;
                Quaternion                          m_initialRotation;
                EntityGroup*                        m_pGroup;
                string                              m_prefabFileName;
                int32                               m_layerIndex, m_groupIndex;
                PrefabData*                         m_pPrefab;
                Vector3D                            m_entityIconCorners[4];
                Texture*                            m_pEntityIconTexture;
                EntityLayer*                        m_pLayer;
                uint32                              m_entityFlags;
                uint8                               m_performanceCost;
                map<char*,EntityEvent*>             m_events;
                vector<EntityVisualEditHandle*>     m_visualEditHandles;
        };

        class NYTRO_API PrefabEntity : public Entity
        {
            public:

                NYTRO_CLASS_NAME( PrefabEntity );
                
                PrefabEntity();
                virtual ~PrefabEntity();

                virtual EResult preCache();
                virtual void    free();
                void            disassemble();

            protected:

        };

        #define NYTRO_ADD_ENTITY_EVENT( eventName, ... ) \
                                Variant __##eventName##Params[] = { __VA_ARGS__ }; \
                                addEvent( new EntityEvent( ""#eventName, __##eventName##Params, sizeof(__##eventName##Params)/sizeof(Variant) ) );
    };
};

#endif