Inheritance diagram for AnimatSim::Recording::KeyFrame:

Collaboration diagram for AnimatSim::Recording::KeyFrame:

Public Member Functions
	KeyFrame ()
	Default constructor. More...

virtual	~KeyFrame ()
	Destructor. More...

int	CollectInterval ()
	Gets the collect interval. More...

void	CollectInterval (int iVal)
	Sets the Collect interval. More...

virtual void	DisableVideoPlayback ()=0
	Disables the video playback. More...

virtual void	EnableVideoPlayback ()=0
	Enables the video playback. More...

virtual void	GenerateID ()
	Generates an identifier. More...

virtual void	Load (CStdXml &oXml)

virtual void	MakeCurrentFrame ()=0
	Makes the current frame. More...

virtual bool	operator< (ActivatedItem *lpItem)
	Less than comparison of two activated items. More...

virtual void	PlaybackVideoFrame ()=0
	Playback video frame. More...

virtual void	RecordVideoFrame ()=0
	Record video frame. More...

virtual void	SaveVideo (std::string strPath)=0
	Saves a video. More...

virtual void	StartVideoPlayback ()=0
	Starts a video playback. More...

virtual void	StepVideoPlayback (int iFrameCount)=0
	Step video playback. More...

virtual void	StopVideoPlayback ()=0
	Stop video playback. More...

Public Member Functions inherited from AnimatSim::ActivatedItem
	ActivatedItem ()
	Default constructor. More...

virtual	~ActivatedItem ()
	Destructor. More...

virtual void	Activate ()
	Activates this item. More...

virtual bool	AlwaysActive ()
	Gets whether this item is always active. More...

virtual void	AlwaysActive (bool bVal)
	Sets whether this item is always active. More...

virtual void	Deactivate ()
	Deactivates this item. More...

virtual bool	Enabled ()
	Gets whether the item is enabled or not. More...

virtual void	Enabled (bool bVal)
	Enables the item. More...

virtual long	EndSlice ()
	Gets the end time slice for deactivation. More...

virtual void	EndSlice (long lVal, bool bReInit=true)

virtual float	EndTime ()
	Gets the end simulation time for deactivation. More...

virtual void	EndTime (float fltVal, bool bReInit=true)

virtual void	Initialize ()
	Initializes this object. More...

bool	IsActivated ()
	Query if this object is activated. More...

bool	IsInitialized ()
	Query if this object is initialized. More...

virtual bool	LoadedTime ()
	Gets whether time was loaded or time slices. More...

virtual void	LoadedTime (bool bVal)
	Sets whether time was loaded. More...

bool	NeedToActivate ()
	Determines if this item needs to be activated. More...

bool	NeedToDeactivate ()
	Determines if this item needs to be deactivated. More...

virtual bool	NeedToStep ()
	Tells if this item needs to call StepSimulation or not. More...

virtual bool	Overlaps (ActivatedItem *lpItem)
	Query if this object overlaps the time period for another ActivatedItem. More...

virtual void	ReInitialize ()
	Re-initialize this object. More...

virtual void	ResetSimulation ()
	Resets the simulation back to time 0. More...

virtual bool	SetData (const std::string &strDataType, const std::string &strValue, bool bThrowError=true)
	Set a variable based on a string data type name. More...

virtual long	StartSlice ()
	Returns the starts slice for activation. More...

virtual void	StartSlice (long lVal, bool bReInit=true)

virtual float	StartTime ()
	Gets the simulation start time for activation. More...

virtual void	StartTime (float fltVal, bool bReInit=true)

virtual int	StepInterval ()
	Gets the step interval. More...

virtual void	StepInterval (int iVal)
	Sets the step interval. More...

virtual int	StepIntervalCount ()
	Gets the step interval count. More...

virtual void	StepIntervalCount (int iVal)
	Step interval count. More...

virtual void	TimeStepModified ()
	Notification method that the time step modified has been modified. Objects should recalculate any slice times as needed. More...

Public Member Functions inherited from AnimatSim::AnimatBase
	AnimatBase ()
	Constructs an AnimatBase object. More...

virtual	~AnimatBase ()
	Destroys the AnimatBase object.. More...

virtual bool	AddItem (const std::string &strItemType, const std::string &strXml, bool bThrowError=true, bool bDoNotInit=false)
	Adds a new object to this parent. More...

virtual void	AfterResetSimulation ()
	Called after a simulation reset for some objects. More...

virtual long	CalculateSnapshotByteSize ()
	Calculates the snapshot byte size. More...

virtual void	Copy (CStdSerialize *lpSource)

virtual float *	GetDataPointer (const std::string &strDataType)
	Returns a float pointer to a data item of interest in this object. More...

virtual NeuralModule *	GetNeuralModule ()
	Gets the neural module. More...

virtual Node *	GetNode ()
	Gets the node. More...

virtual Simulator *	GetSimulator ()
	Gets the simulator pointer. More...

virtual Structure *	GetStructure ()
	Gets the structure for this node. More...

virtual bool	HasProperty (const std::string &strName)
	Queries this object if it has a property with the given name. More...

virtual std::string	ID ()
	Gets the unique GUID ID of this object. More...

virtual void	ID (std::string strValue)
	Sets the unique GUID ID of the object. More...

virtual void	Kill (bool bState=true)
	Kills. More...

virtual void	Load (StdUtils::CStdXml &oXml)
	Loads the item using an XML data packet. More...

virtual void	LoadKeyFrameSnapshot (byte *aryBytes, long &lIndex)
	Loads a key frame snapshot. More...

virtual std::string	Name ()
	Gets the name of this object. More...

virtual void	Name (std::string strValue)
	Sets the name of the object. Blank is acceptable. More...

virtual AnimatPropertyType	PropertyType (const std::string &strName)

virtual void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
	Queries this object for a list of properties that can be changed using SetData. More...

virtual bool	RemoveItem (const std::string &strItemType, const std::string &strID, bool bThrowError=true)
	Removes a child item from this parent. More...

virtual void	Reset ()
	Resets this object. More...

virtual void	RigidBodyAdded (std::string strID)

virtual void	RigidBodyRemoved (std::string strID)

virtual void	SaveKeyFrameSnapshot (byte *aryBytes, long &lIndex)
	Saves a key frame snapshot. More...

virtual bool	Selected ()
	Tells if this items is selected or not. More...

virtual void	Selected (bool bValue, bool bSelectMultiple)
	Selects this object. More...

virtual bool	SetData (const std::string &strDataType, const float fltValue, bool bThrowError=true)
	Set a variable based on a string data type name. More...

virtual bool	SetData (const std::string &strDataType, const long lValue, bool bThrowError=true)
	Set a variable based on a string data type name. More...

virtual void	SetSystemPointers (Simulator lpSim, Structure lpStructure, NeuralModule lpModule, Node lpNode, bool bVerify)
	Sets the system pointers. More...

virtual void	SimPausing ()
	Called just before the simulation pauses. More...

virtual void	SimStarting ()
	Called just before the simulation starts. More...

virtual void	SimStopping ()
	Called just before the simulation stops. More...

virtual void	StepSimulation ()
	Step the simulation for this object. More...

virtual std::string	Type ()
	returns the string type name of this object. More...

virtual void	Type (std::string strValue)
	Sets the class type for this object. More...

virtual void	VerifySystemPointers ()
	Verify that system pointers have been set correctly. More...

virtual void	VisualSelectionModeChanged (int iNewMode)
	Visual selection mode changed. More...

Static Public Member Functions
static KeyFrame *	CastToDerived (AnimatBase *lpBase)

Static Public Member Functions inherited from AnimatSim::ActivatedItem
static ActivatedItem *	CastToDerived (AnimatBase *lpBase)

Protected Attributes
short	m_iCollectInterval
	Zero-based index of the collect interval.

std::string	m_strConfigFilename
	Filename of the string configuration file.

std::string	m_strProjectPath
	Full pathname of the string project file.

Protected Attributes inherited from AnimatSim::ActivatedItem
bool	m_bAlwaysActive
	Determines whether this item is always active during simulation.

bool	m_bInitialized
	true if item has been initialized

bool	m_bIsActivated
	true if item has been activated

bool	m_bLoadedTime

float	m_fltEndTime

float	m_fltStartTime

int	m_iStepInterval

int	m_iStepIntervalCount
	Keeps track of how many time steps have occured since it was zeroed again.

long	m_lEndSlice
	The time slice where this item is deactived.

long	m_lStartSlice
	The time slice where this item becomes active.

Protected Attributes inherited from AnimatSim::AnimatBase
bool	m_bEnabled
	Tells if this item is enabled or not. If it is not enabled then it is not run.

bool	m_bSelected
	Tells whether the object is selected or not.

AnimatSim::Behavior::NeuralModule *	m_lpModule
	The pointer to this items parentNeuralModule. If this is not relevant for this object then this is NULL.

Node *	m_lpNode
	The pointer to this items parent Node. If this is not relevant for this object then this is NULL.

Simulator *	m_lpSim
	The pointer to a Simulation.

AnimatSim::Environment::Structure *	m_lpStructure
	The pointer to this items parent Structure. If this is not relevant for this object then this is NULL.

std::string	m_strID
	The unique Id for this object.

std::string	m_strName
	The name for this object.

std::string	m_strType
	The type for this object. Examples are Box, Plane, Neuron, etc..

Additional Inherited Members
Protected Member Functions inherited from AnimatSim::ActivatedItem
virtual void	SetSliceData ()

Detailed Description

Definition at line 14 of file KeyFrame.h.

Constructor & Destructor Documentation

AnimatSim::Recording::KeyFrame::KeyFrame ( )

Default constructor.

Author: dcofer

Date: 3/24/2011

Definition at line 49 of file KeyFrame.cpp.

References m_iCollectInterval.

AnimatSim::Recording::KeyFrame::~KeyFrame ( )

virtual

Destructor.

Author: dcofer

Date: 3/24/2011

Definition at line 60 of file KeyFrame.cpp.

References StdUtils::Std_TraceMsg().

Here is the call graph for this function:

Member Function Documentation

int AnimatSim::Recording::KeyFrame::CollectInterval ( )

Gets the collect interval.

Author: dcofer

Date: 3/24/2011

Returns: Collect interval.

Definition at line 78 of file KeyFrame.cpp.

References m_iCollectInterval.

void AnimatSim::Recording::KeyFrame::CollectInterval ( int iVal )

Sets the Collect interval.

Author: dcofer

Date: 3/24/2011

Parameters

iVal	The new value.

Definition at line 88 of file KeyFrame.cpp.

References m_iCollectInterval.

virtual void AnimatSim::Recording::KeyFrame::DisableVideoPlayback ( )

pure virtual

Disables the video playback.

Author: dcofer

Date: 3/24/2011

Referenced by AnimatSim::Simulator::DisableVideoPlayback().

Here is the caller graph for this function:

virtual void AnimatSim::Recording::KeyFrame::EnableVideoPlayback ( )

pure virtual

Enables the video playback.

Author: dcofer

Date: 3/24/2011

Referenced by AnimatSim::Simulator::EnableVideoPlayback().

Here is the caller graph for this function:

void AnimatSim::Recording::KeyFrame::GenerateID ( )

virtual

Generates an identifier.

Author: dcofer

Date: 3/24/2011

Definition at line 117 of file KeyFrame.cpp.

References AnimatSim::ActivatedItem::m_lEndSlice, AnimatSim::ActivatedItem::m_lStartSlice, AnimatSim::AnimatBase::m_strID, StdUtils::Std_CheckString(), StdUtils::Std_IsAboveMin(), and AnimatSim::AnimatBase::Type().

Referenced by AnimatSim::Recording::SimulationRecorder::Add().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void AnimatSim::Recording::KeyFrame::MakeCurrentFrame ( )

pure virtual

Makes the current frame.

Author: dcofer

Date: 3/24/2011

Referenced by AnimatSim::Simulator::MoveSimulationToKeyFrame().

Here is the caller graph for this function:

bool AnimatSim::Recording::KeyFrame::operator< ( ActivatedItem * lpItem )

virtual

Less than comparison of two activated items.

Returns: true if start slice of this key frame is less than the one passed in.

Implements AnimatSim::ActivatedItem.

Definition at line 95 of file KeyFrame.cpp.

References AnimatSim::ActivatedItem::m_lEndSlice, and AnimatSim::ActivatedItem::m_lStartSlice.

virtual void AnimatSim::Recording::KeyFrame::PlaybackVideoFrame ( )

pure virtual

Playback video frame.

Author: dcofer

Date: 3/24/2011

virtual void AnimatSim::Recording::KeyFrame::RecordVideoFrame ( )

pure virtual

Record video frame.

Author: dcofer

Date: 3/24/2011

virtual void AnimatSim::Recording::KeyFrame::SaveVideo ( std::string strPath )

pure virtual

Saves a video.

Author: dcofer

Date: 3/24/2011

Parameters

strPath Full pathname of the string file.

Referenced by AnimatSim::Simulator::SaveVideo().

Here is the caller graph for this function:

virtual void AnimatSim::Recording::KeyFrame::StartVideoPlayback ( )

pure virtual

Starts a video playback.

Author: dcofer

Date: 3/24/2011

Referenced by AnimatSim::Simulator::StartVideoPlayback().

Here is the caller graph for this function:

virtual void AnimatSim::Recording::KeyFrame::StepVideoPlayback ( int iFrameCount )

pure virtual

Step video playback.

Author: dcofer

Date: 3/24/2011

Parameters

iFrameCount Number of frames.

Referenced by AnimatSim::Simulator::StepVideoPlayback().

Here is the caller graph for this function:

virtual void AnimatSim::Recording::KeyFrame::StopVideoPlayback ( )

pure virtual

Stop video playback.

Author: dcofer

Date: 3/24/2011

Referenced by AnimatSim::Simulator::StopVideoPlayback().

Here is the caller graph for this function:

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation