Atoms Crowd  7.0.0
Public Types | Public Member Functions | List of all members
Atoms::SimulationEvent Class Reference

Simiation Event. More...

#include <SimulationEvent.h>

Public Types

enum  EventType {
  kNone = 1 , kNative = 2 , kScript = 4 , kAnimClipNative = 8 ,
  kAnimClipScript = 16 , kAgentTypeNative = 32 , kAgentTypeScript = 64 , kAll = 127
}
 

Public Member Functions

 SimulationEvent ()
 Constructor.
 
virtual ~SimulationEvent ()
 Destructor.
 
virtual void load ()
 Load fuction. More...
 
virtual void unload ()
 Unload fuction. More...
 
virtual void initSimulation ()
 Init simulation. More...
 
virtual void initFrame ()
 Init frame. More...
 
virtual void computeFrame ()
 Init frame. More...
 
virtual void endFrame ()
 End frame. More...
 
virtual void endSimulation ()
 End simulation. More...
 
virtual void resetSimulation ()
 Reset simulation. More...
 
virtual std::string name ()
 Gets the name. More...
 
virtual void setName (const std::string &name)
 Sets the name. More...
 
virtual short eventType ()
 Gets the name. More...
 
virtual void setEventType (short value)
 Sets the event type. More...
 
virtual AtomsCore::MapMetadata & metadata ()
 Returns the metadata map.
 

Detailed Description

Simiation Event.

A simulation Event contains some functions that are called during the simulation. It's used to extend and add functionality to the main simulation loop. Derive this class and implement different virtual member to add new function event to the simulation.

Member Function Documentation

◆ computeFrame()

virtual void Atoms::SimulationEvent::computeFrame ( )
virtual

Init frame.

Called for each frame before atoms compute the pose of the agents

◆ endFrame()

virtual void Atoms::SimulationEvent::endFrame ( )
virtual

End frame.

Called at the end of every frame

◆ endSimulation()

virtual void Atoms::SimulationEvent::endSimulation ( )
virtual

End simulation.

Called at the end of the simulation, after the last frame

◆ eventType()

short Atoms::SimulationEvent::eventType ( )
inlinevirtual

Gets the name.

Gets the name of the simulation event

◆ initFrame()

virtual void Atoms::SimulationEvent::initFrame ( )
virtual

Init frame.

Called at the beginning of every frame

◆ initSimulation()

virtual void Atoms::SimulationEvent::initSimulation ( )
virtual

Init simulation.

Called at the beginning on the simulation, before the first frame

◆ load()

virtual void Atoms::SimulationEvent::load ( )
virtual

Load fuction.

Called when the event is loaded, or when the simulation reset is called

◆ name()

std::string Atoms::SimulationEvent::name ( )
inlinevirtual

Gets the name.

Gets the name of the simulation event

◆ resetSimulation()

virtual void Atoms::SimulationEvent::resetSimulation ( )
virtual

Reset simulation.

Called after a request to reset the simulation

◆ setEventType()

void Atoms::SimulationEvent::setEventType ( short  value)
inlinevirtual

Sets the event type.

Sets the event type

◆ setName()

void Atoms::SimulationEvent::setName ( const std::string &  name)
inlinevirtual

Sets the name.

Sets the name of the simulaiton event

◆ unload()

virtual void Atoms::SimulationEvent::unload ( )
virtual

Unload fuction.

Called when the event is unloaded

The documentation for this class was generated from the following files: