Atoms Crowd  4.1.0
SimulationEvent.h
1 #pragma once
2 // ===========================================================================
3 // Copyright (c) 2015 Toolchefs Ltd. All rights reserved.
4 //
5 // Use of this software is subject to the terms of the Toolchefs license
6 // agreement provided at the time of installation or download, or which
7 // otherwise accompanies this software in either electronic or hard copy form.
8 // ===========================================================================
9 
10 #include <Atoms/Globals.h>
11 #include <AtomsCore/Metadata/MapMetadata.h>
12 #include <string>
13 
14 namespace Atoms
15 {
17 
21  class ATOMS_EXPORT SimulationEvent
22  {
23  public:
24 
25  enum EventType
26  {
27  kNone = 1,
28  kNative = 2,
29  kScript = 4,
30  kAnimClipNative = 8,
31  kAnimClipScript = 16,
32  kAgentTypeNative = 32,
33  kAgentTypeScript = 64,
34  kAll = 127,
35  };
36 
39 
41  virtual ~SimulationEvent();
42 
44 
46  virtual void load();
47 
49 
51  virtual void unload();
52 
54 
56  virtual void initSimulation();
57 
59 
61  virtual void initFrame();
62 
64 
66  virtual void computeFrame();
67 
69 
71  virtual void endFrame();
72 
74 
76  virtual void endSimulation();
77 
79 
81  virtual void resetSimulation();
82 
84 
86  virtual inline std::string name();
87 
89 
91  virtual inline void setName(const std::string& name);
92 
94 
96  virtual inline short eventType();
97 
99 
101  virtual inline void setEventType(short value);
102 
104  virtual inline AtomsCore::MapMetadata& metadata();
105 
106  private:
107 
108  AtomsCore::MapMetadata m_metadata;
109 
111  std::string m_name;
112 
114  short m_eventType;
115  };
116 }
117 
118 #include "SimulationEvent.impl.h"
Atoms::SimulationEvent
Simiation Event.
Definition: SimulationEvent.h:22
Atoms::SimulationEvent::computeFrame
virtual void computeFrame()
Init frame.
Atoms::SimulationEvent::SimulationEvent
SimulationEvent()
Constructor.
Atoms::SimulationEvent::unload
virtual void unload()
Unload fuction.
Atoms::SimulationEvent::load
virtual void load()
Load fuction.
Atoms::SimulationEvent::endFrame
virtual void endFrame()
End frame.
Atoms
Atoms namespace.
Definition: Agent.h:28
AtomsCore::MapMetadata
MapMetadata class.
Definition: MapMetadata.h:24
Atoms::SimulationEvent::initSimulation
virtual void initSimulation()
Init simulation.
Atoms::SimulationEvent::resetSimulation
virtual void resetSimulation()
Reset simulation.
Atoms::SimulationEvent::initFrame
virtual void initFrame()
Init frame.
Atoms::SimulationEvent::endSimulation
virtual void endSimulation()
End simulation.
Atoms::SimulationEvent::~SimulationEvent
virtual ~SimulationEvent()
Destructor.