Engine/source/console/sim.h

   1 //-----------------------------------------------------------------------------
   2 // Copyright (c) 2012 GarageGames, LLC
   3 //
   4 // Permission is hereby granted, free of charge, to any person obtaining a copy
   5 // of this software and associated documentation files (the "Software"), to
   6 // deal in the Software without restriction, including without limitation the
   7 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   8 // sell copies of the Software, and to permit persons to whom the Software is
   9 // furnished to do so, subject to the following conditions:
  10 //
  11 // The above copyright notice and this permission notice shall be included in
  12 // all copies or substantial portions of the Software.
  13 //
  14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  20 // IN THE SOFTWARE.
  21 //-----------------------------------------------------------------------------
  22
  23 #ifndef _SIM_H_
  24 #define _SIM_H_
  25
  26 #ifndef _TORQUE_TYPES_H_
  27 #include "platform/types.h"
  28 #endif
  29 #ifndef _TORQUE_STRING_H_
  30 #include "core/util/str.h"
  31 #endif
  32 #ifndef _MODULE_H_
  33 #include "core/module.h"
  34 #endif
  35 #ifndef _CONSOLE_H_
  36 #include "console/console.h"
  37 #endif
  38
  39 // Forward Refs
  40 class SimSet;
  41 class SimGroup;
  42 class SimDataBlockGroup;
  43 class SimObject;
  44 class SimEvent;
  45 class Stream;
  46
  47 // Sim Types
  48 typedef U32 SimTime;
  49 typedef U32 SimObjectId;
  50
  51 /// Definition of some basic Sim system constants.
  52 ///
  53 /// These constants define the range of ids assigned to datablocks
  54 /// (DataBlockObjectIdFirst - DataBlockObjectIdLast), and the number
  55 /// of bits used to store datablock IDs.
  56 ///
  57 /// Normal Sim objects are given the range of IDs starting at
  58 /// DynamicObjectIdFirst and going to infinity. Sim objects use
  59 /// a SimObjectId to represent their ID; this is currently a U32.
  60 ///
  61 /// The RootGroupId is assigned to gRootGroup, in which most SimObjects
  62 /// are addded as child members. See simManager.cc for details, particularly
  63 /// Sim::initRoot() and following.
  64 enum SimObjectsConstants : U32
  65 {
  66    DataBlockObjectIdFirst = 3,
  67    DataBlockObjectIdBitSize = 14,
  68    DataBlockObjectIdLast = DataBlockObjectIdFirst + (1 << DataBlockObjectIdBitSize) - 1,
  69
  70    MessageObjectIdFirst = DataBlockObjectIdLast + 1,
  71    MessageObjectIdBitSize = 6,
  72    MessageObjectIdLast = MessageObjectIdFirst + (1 << MessageObjectIdBitSize) - 1,
  73
  74    DynamicObjectIdFirst = MessageObjectIdLast + 1,
  75    InvalidEventId = 0,
  76    RootGroupId = 0xFFFFFFFF,
  77 };
  78
  79 //---------------------------------------------------------------------------
  80
  81 /// @defgroup simbase_helpermacros Helper Macros
  82 ///
  83 /// These are used for named sets and groups in the manager.
  84 /// @{
  85 #define DeclareNamedSet(set) extern SimSet *g##set;inline SimSet *get##set() { return g##set; }
  86 #define DeclareNamedGroup(set) extern SimGroup *g##set;inline SimGroup *get##set() { return g##set; }
  87 #define ImplementNamedSet(set) SimSet *g##set;
  88 #define ImplementNamedGroup(set) SimGroup *g##set;
  89 /// @}
  90
  91 //---------------------------------------------------------------------------
  92
  93 namespace Sim
  94 {
  95    DeclareNamedSet(ActiveActionMapSet)
  96    DeclareNamedSet(GhostAlwaysSet)
  97    DeclareNamedSet(WayPointSet)
  98    DeclareNamedSet(fxReplicatorSet)
  99    DeclareNamedSet(fxFoliageSet)
 100    DeclareNamedSet(BehaviorSet)
 101    DeclareNamedSet(MaterialSet)
 102    DeclareNamedSet(SFXSourceSet);
 103    DeclareNamedSet(SFXDescriptionSet);
 104    DeclareNamedSet(SFXTrackSet);
 105    DeclareNamedSet(SFXEnvironmentSet);
 106    DeclareNamedSet(SFXStateSet);
 107    DeclareNamedSet(SFXAmbienceSet);
 108    DeclareNamedSet(TerrainMaterialSet);
 109    DeclareNamedSet(DataBlockSet);
 110    DeclareNamedGroup(ActionMapGroup)
 111    DeclareNamedGroup(ClientGroup)
 112    DeclareNamedGroup(GuiGroup)
 113    DeclareNamedGroup(GuiDataGroup)
 114    DeclareNamedGroup(TCPGroup)
 115    DeclareNamedGroup(ClientConnectionGroup)
 116    DeclareNamedGroup(SFXParameterGroup);
 117
 118    DeclareNamedSet(sgMissionLightingFilterSet);
 119
 120    void init();
 121    void shutdown();
 122
 123    bool isShuttingDown();
 124
 125    SimDataBlockGroup *getDataBlockGroup();
 126    SimGroup* getRootGroup();
 127
 128    SimObject* findObject(ConsoleValueRef&);
 129    SimObject* findObject(SimObjectId);
 130    SimObject* findObject(const char* name);
 131    SimObject* findObject(const char* fileName, S32 declarationLine);
 132    template<class T> inline bool findObject(ConsoleValueRef &ref,T*&t)
 133    {
 134       t = dynamic_cast<T*>(findObject(ref));
 135       return t != NULL;
 136    }
 137    template<class T> inline bool findObject(SimObjectId iD,T*&t)
 138    {
 139       t = dynamic_cast<T*>(findObject(iD));
 140       return t != NULL;
 141    }
 142    template<class T> inline bool findObject(const char *objectName,T*&t)
 143    {
 144       t = dynamic_cast<T*>(findObject(objectName));
 145       return t != NULL;
 146    }
 147
 148    SimObject *spawnObject(String spawnClass,
 149                           String spawnDataBlock = String::EmptyString,
 150                           String spawnName = String::EmptyString,
 151                           String spawnProperties = String::EmptyString,
 152                           String spawnScript = String::EmptyString);
 153
 154    void advanceToTime(SimTime time);
 155    void advanceTime(SimTime delta);
 156    SimTime getCurrentTime();
 157    SimTime getTargetTime();
 158
 159    /// a target time of 0 on an event means current event
 160    U32 postEvent(SimObject*, SimEvent*, SimTime targetTime);
 161
 162    inline U32 postEvent(SimObjectId iD,SimEvent*evt, SimTime targetTime)
 163    {
 164       return postEvent(findObject(iD), evt, targetTime);
 165    }
 166    inline U32 postEvent(const char *objectName,SimEvent*evt, SimTime targetTime)
 167    {
 168       return postEvent(findObject(objectName), evt, targetTime);
 169    }
 170    inline U32 postCurrentEvent(SimObject*obj, SimEvent*evt)
 171    {
 172       return postEvent(obj,evt,getCurrentTime());
 173    }
 174    inline U32 postCurrentEvent(SimObjectId obj,SimEvent*evt)
 175    {
 176       return postEvent(obj,evt,getCurrentTime());
 177    }
 178    inline U32 postCurrentEvent(const char *obj,SimEvent*evt)
 179    {
 180       return postEvent(obj,evt,getCurrentTime());
 181    }
 182
 183    void cancelEvent(U32 eventId);
 184    void cancelPendingEvents(SimObject *obj);
 185    bool isEventPending(U32 eventId);
 186    U32  getEventTimeLeft(U32 eventId);
 187    U32  getTimeSinceStart(U32 eventId);
 188    U32  getScheduleDuration(U32 eventId);
 189
 190    /// Appends numbers to inName until an unused SimObject name is created
 191    String getUniqueName( const char *inName );
 192    /// Appends numbers to inName until an internal name not taken in the inSet is found.
 193    String getUniqueInternalName( const char *inName, SimSet *inSet, bool searchChildren );
 194
 195    /// Return true if the given name string makes for a valid object name.
 196    /// Empty strings and NULL are also treated as valid names (anonymous objects).
 197    bool isValidObjectName( const char* name );
 198
 199    bool saveObject(SimObject *obj, Stream *stream);
 200    SimObject *loadObjectStream(Stream *stream);
 201
 202    bool saveObject(SimObject *obj, const char *filename);
 203    SimObject *loadObjectStream(const char *filename);
 204 }
 205
 206 #endif // _SIM_H_