Inheritance diagram for VortexAnimatSim::Visualization::VsScriptedSimulationWindow:

Collaboration diagram for VortexAnimatSim::Visualization::VsScriptedSimulationWindow:

Public Member Functions
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 std::string	DefaultPartID ()

virtual void	DefaultPartID (std::string strID)

virtual CStdFPoint	DefaultPosition ()
	Gets the local position. (m_oPosition) More...

virtual void	DefaultPosition (CStdFPoint &oPoint, bool bUseScaling=true)
	Sets the local position. (m_oPosition) More...

virtual void	DefaultPosition (float fltX, float fltY, float fltZ, bool bUseScaling=true)
	Sets the local position. (m_oPosition) More...

virtual void	DefaultPosition (std::string strXml, bool bUseScaling=true)
	Sets the local position. (m_oPosition). This method is primarily used by the GUI to reset the local position using an xml data packet. More...

virtual int	FindCameraPath (std::string strID, bool bThrowError=true)

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

virtual void	Load (CStdXml &oXml)

virtual bool	RemoveItem (const std::string &strItemType, const std::string &strID, bool bThrowError=true)
	Removes a child item from this parent. 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 void	SimStarting ()
	Called just before the simulation starts. More...

virtual void	SortPaths ()

virtual void	Update ()
	Updates this window. More...

Public Member Functions inherited from VortexAnimatSim::Visualization::VsSimulationWindow
virtual void	Close ()
	Closes this window. More...

virtual CStdFPoint	GetCameraPosition ()

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

virtual osg::Matrix	GetScreenMatrix ()

virtual osg::Viewport *	GetViewport ()

virtual void	OnGetFocus ()
	Called by the GUI when this window gets the focus. More...

virtual void	OnLoseFocus ()
	Called by the GUI when this window loses the focus. More...

virtual void	SetCameraLookAt (CStdFPoint oTarget, bool bResetEyePos)
	Manually sets a camera look at position. More...

virtual void	SetCameraPositionAndLookAt (CStdFPoint oCameraPos, CStdFPoint oTarget)
	Manually sets a camera position and look at position. More...

virtual void	SetCameraPositionAndLookAt (osg::Vec3d vCameraPos, osg::Vec3d vTarget)

virtual void	SetCameraPostion (CStdFPoint vCameraPos)
	Manually sets a camera position. More...

virtual void	SetupTrackCamera (bool bResetEyePos)
	Sets up the camera tracking. More...

virtual BodyPart *	TrackBody ()

virtual void	UpdateBackgroundColor ()

virtual osgViewer::Viewer *	Viewer ()

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

	SimulationWindow (HWND win)
	Constructor. More...

	~SimulationWindow (void)
	Destructor. More...

virtual void	Load (std::string strXml)
	Loads this window from an xml string. More...

virtual void	LookAtBodyID (std::string strID)
	Sets the RigidBody GUID ID to look at within the specified structure. More...

virtual std::string	LookAtBodyID ()
	Gets the GUID ID of the RigidBody to look at. More...

virtual void	LookAtStructureID (std::string strID)
	Sets the GUID ID of the structure to look at with the camera. More...

virtual std::string	LookAtStructureID ()
	Gets the look at structure GUID ID. More...

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

virtual void	SetupTrackCamera (bool bTrackCamera, std::string strLookAtStructureID, std::string strLookAtBodyID)
	Sets up the track camera. More...

virtual bool	StandAlone ()
	Gets whether this window stands alone from all others. More...

virtual void	StandAlone (bool bVal)
	Sets whether this window stands alone. More...

virtual void	UsingTrackCamera (bool bVal)
	Sets whether camera tracking should be used. More...

virtual bool	UsingTrackCamera ()
	Gets wheter camera tracking is being used. More...

virtual HWND	WindowID ()
	Gets the HWND window identifier. More...

virtual void	WindowID (HWND win)
	Sets the HWND Window identifier. More...

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

virtual	~AnimatBase ()
	Destroys the AnimatBase object.. 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 void	Enabled (bool bVal)
	Tells whether this item is enabled or not. This is not actually used for all objects, only specific ones. I am putting it in the base class though to prevent numerous duplications. More...

virtual bool	Enabled ()
	Tells whether this item is enabled or not. This is not actually used for all objects, only specific ones. I am putting it in the base class though to prevent numerous duplications. 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	ReInitialize ()
	Re-initialize this object. 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	SimStopping ()
	Called just before the simulation stops. More...

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

virtual void	TimeStepModified ()
	Notification method that the time step modified has been modified. Objects should recalculate any slice times as needed. 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...

Protected Member Functions
virtual void	AddCameraPath (std::string strXml)
	Creates and adds a camera path. More...

virtual void	FindNextCameraPath ()

virtual OsgLinearPath *	LoadCameraPath (CStdXml &oXml)
	Loads the a camera path. More...

virtual void	RemoveCameraPath (std::string strID, bool bThrowError=true)
	Removes the camera path based on ID. More...

virtual void	TrackCamera ()
	Implements code to do the camera tracking. More...

Protected Member Functions inherited from VortexAnimatSim::Visualization::VsSimulationWindow
virtual void	InitEmbedded (Simulator lpSim, VsSimulator lpVsSim)

virtual void	InitStandalone (Simulator lpSim, VsSimulator lpVsSim)

Protected Attributes
CStdPtrArray< OsgLinearPath >	m_aryCameraPaths

CStdMap< double, OsgLinearPath * >	m_arySortedCameraPaths

CStdMap< double, OsgLinearPath * >::iterator	m_iCurrentPathIter

OsgLinearPath *	m_lpCurrentPath

BodyPart *	m_lpDefaultTrackBody

BodyPart *	m_lpOriginalTrackBody
	Used to keep track of the body part that was being tracked before sim started.

std::string	m_strDefaultPartID

CStdFPoint	m_vDefaultPosition

Protected Attributes inherited from VortexAnimatSim::Visualization::VsSimulationWindow
bool	m_bEyePosSet
	true if we have set the eye position at least once.

float	m_fltCameraPosX

float	m_fltCameraPosY

float	m_fltCameraPosZ

BodyPart *	m_lpTrackBody

VsSimulationWindowMgr *	m_lpWinMgr

osg::ref_ptr< osgGA::TrackballManipulator >	m_osgManip

osg::ref_ptr< osgViewer::Viewer >	m_osgViewer

Protected Attributes inherited from AnimatSim::SimulationWindow
bool	m_bStandAlone
	true if the window is seperate from all other windows.

bool	m_bTrackCamera

HWND	m_HWND
	Handle of the hwnd.

CStdFPoint	m_ptPosition
	The position of the window.

CStdFPoint	m_ptSize
	Size of the window.

std::string	m_strLookAtBodyID

std::string	m_strLookAtStructureID

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
Static Public Member Functions inherited from AnimatSim::SimulationWindow
static SimulationWindow *	CastToDerived (AnimatBase *lpBase)

Detailed Description

Definition at line 10 of file VsScriptedSimulationWindow.h.

Member Function Documentation

void VortexAnimatSim::Visualization::VsScriptedSimulationWindow::AddCameraPath ( std::string strXml )

protectedvirtual

Creates and adds a camera path.

This method is primarily used by the GUI to add a new root body to the camera paths

Author: dcofer

Date: 2/25/2011

Parameters

strXml The xml configuration data packet.

Definition at line 164 of file VsScriptedSimulationWindow.cpp.

References VortexAnimatSim::Visualization::OsgLinearPath::Initialize(), and LoadCameraPath().

Referenced by AddItem().

Here is the call graph for this function:

Here is the caller graph for this function:

bool VortexAnimatSim::Visualization::VsScriptedSimulationWindow::AddItem	(	const std::string &	strItemType,
		const std::string &	strXml,
		bool	bThrowError = `true`,
		bool	bDoNotInit = `false`
	)

virtual

Adds a new object to this parent.

Generic method to add a new child item to this parent by specifying a string item type descriptor and an xml packet that can be used to load in the new object. The GUI uses this method to create new items that were added with the user interface. The item type lets the method determine what type of item is being created, like synapse, neuron, body part, etc.. It then gets the modulename, classname, and type from the xml and calls CreateObject to create the appropriate type of object. Then it passes in the xml packet to the new objects load method and does any needed initialization and adds it to the parent.

Author: dcofer

Date: 2/22/2011

Parameters

strItemType	String descriptor of the type of item that is being created.
strXml	XML packet that is used to create and load the new item.
bThrowError	If true then throw an error if there is a problem, otherwise return false.

Returns: true if it succeeds, false if it fails.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 221 of file VsScriptedSimulationWindow.cpp.

References AddCameraPath(), and StdUtils::Std_CheckString().

Here is the call graph for this function:

CStdFPoint VortexAnimatSim::Visualization::VsScriptedSimulationWindow::DefaultPosition ( )

virtual

Gets the local position. (m_oPosition)

Author: dcofer

Date: 3/2/2011

Returns: returns m_oPosition.

Definition at line 43 of file VsScriptedSimulationWindow.cpp.

Referenced by DefaultPosition(), and SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Visualization::VsScriptedSimulationWindow::DefaultPosition	(	CStdFPoint &	oPoint,
		bool	bUseScaling = `true`
	)

virtual

Sets the local position. (m_oPosition)

Author: dcofer

Date: 3/2/2011

Parameters

[in,out]	oPoint	The new point to use to set the local position.
	bUseScaling	If true then the position values that are passed in will be scaled by the unit scaling values.

Definition at line 55 of file VsScriptedSimulationWindow.cpp.

References AnimatSim::Simulator::InverseDistanceUnits(), AnimatSim::AnimatBase::m_lpSim, and VortexAnimatSim::Visualization::VsSimulationWindow::SetCameraPositionAndLookAt().

Here is the call graph for this function:

void VortexAnimatSim::Visualization::VsScriptedSimulationWindow::DefaultPosition	(	float	fltX,
		float	fltY,
		float	fltZ,
		bool	bUseScaling = `true`
	)

virtual

Sets the local position. (m_oPosition)

Author: dcofer

Date: 3/2/2011

Parameters

fltX	The x coordinate.
fltY	The y coordinate.
fltZ	The z coordinate.
bUseScaling	If true then the position values that are passed in will be scaled by the unit scaling values.

Definition at line 84 of file VsScriptedSimulationWindow.cpp.

References DefaultPosition().

Here is the call graph for this function:

void VortexAnimatSim::Visualization::VsScriptedSimulationWindow::DefaultPosition	(	std::string	strXml,
		bool	bUseScaling = `true`
	)

virtual

Sets the local position. (m_oPosition). This method is primarily used by the GUI to reset the local position using an xml data packet.

Author: dcofer

Date: 3/2/2011

Parameters

strXml	The xml string with the data to load in the position.
bUseScaling	If true then the position values that are passed in will be scaled by the unit scaling values.

Definition at line 101 of file VsScriptedSimulationWindow.cpp.

References DefaultPosition(), and StdUtils::Std_LoadPoint().

Here is the call graph for this function:

void VortexAnimatSim::Visualization::VsScriptedSimulationWindow::Initialize ( )

virtual

Initializes this object.

After an object is loaded in it must be initialized before it can be used. This allows the object to retrieve any pointers or setup memory that it will need during execution. Each object is responsible for initializing any of its child objects, so you simply need to call this method on the containing class to init all child objects. It also calls VerifySystemPointers to make sure that the system pointers have been setup correctly.

Author: dcofer

Date: 3/1/2011

Reimplemented from VortexAnimatSim::Visualization::VsSimulationWindow.

Definition at line 255 of file VsScriptedSimulationWindow.cpp.

References VortexAnimatSim::Visualization::VsSimulationWindow::Initialize().

Here is the call graph for this function:

OsgLinearPath * VortexAnimatSim::Visualization::VsScriptedSimulationWindow::LoadCameraPath ( CStdXml & oXml )

protectedvirtual

Loads the a camera path.

Author: dcofer

Date: 2/25/2011

Parameters

[in,out] oXml The xml data packet to load.

Returns: The root.

Definition at line 384 of file VsScriptedSimulationWindow.cpp.

References VortexAnimatSim::Visualization::OsgLinearPath::Load(), AnimatSim::AnimatBase::m_lpSim, and AnimatSim::AnimatBase::SetSystemPointers().

Referenced by AddCameraPath().

Here is the call graph for this function:

Here is the caller graph for this function:

void VortexAnimatSim::Visualization::VsScriptedSimulationWindow::RemoveCameraPath	(	std::string	strID,
		bool	bThrowError = `true`
	)

protectedvirtual

Removes the camera path based on ID.

This is primarily used by the GUI to remove the root from the camera path when the user does this in the GUI.

Author: dcofer

Date: 2/25/2011

Parameters

strID	GUI ID of the path to remove
bThrowError	If true then throw an error if there is a problem, otherwise return false

Returns: true if it succeeds, false if it fails.

Definition at line 190 of file VsScriptedSimulationWindow.cpp.

Referenced by RemoveItem().

Here is the caller graph for this function:

bool VortexAnimatSim::Visualization::VsScriptedSimulationWindow::RemoveItem	(	const std::string &	strItemType,
		const std::string &	strID,
		bool	bThrowError = `true`
	)

virtual

Removes a child item from this parent.

This is a generic method that is used to delete a child object from this parent. The GUI uses this method to remove objects from the simulation that have been deleted in the UI. The item type lets the method determine what type of item is being deleted, like synapse, neuron, body part, etc.. The ID is then used to delete that specific item.

Author: dcofer

Date: 2/22/2011

Parameters

strItemType	String descriptor of the type of item that is being created.
strID	Unique ID of the item that will be removed.
bThrowError	If true then throw an error if there is a problem, otherwise return false.

Returns: true if it succeeds, false if it fails.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 238 of file VsScriptedSimulationWindow.cpp.

References RemoveCameraPath(), and StdUtils::Std_CheckString().

Here is the call graph for this function:

void VortexAnimatSim::Visualization::VsScriptedSimulationWindow::ResetSimulation ( )

virtual

Resets the simulation back to time 0.

This method calls the ResetSimulation method on all subitems in order to reset the simulation back to the beginning.

Author: dcofer

Date: 3/1/2011

Reimplemented from AnimatSim::AnimatBase.

Definition at line 282 of file VsScriptedSimulationWindow.cpp.

References TrackCamera().

Here is the call graph for this function:

bool VortexAnimatSim::Visualization::VsScriptedSimulationWindow::SetData	(	const std::string &	strDataType,
		const std::string &	strValue,
		bool	bThrowError = `true`
	)

virtual

Set a variable based on a string data type name.

This is a generic method that can be used to set any variable in an AnimatBase object by specifying the name of the variable and a string representation of that data. The GUI uses this method to set data into variables in the simulation when the user changes them in the UI. The value string can be as simple as a float or int, or as complex as an xml packet. It is the developers responsibilty to know what type of data is needed and to process it accordingly.

Author: dcofer

Date: 2/22/2011

Parameters

strDataType	string name of the data type to set.
strValue	The string value of the data. It is up to the developer to determine what this should be. For example, in most cases it is simply a float and you just have to convert it to a float and make the appropriate mutator method call. However, it can be any type of string, including an entire xml packet. It is the developers responsibility to know how to set and process the data as required.
bThrowError	true to throw error if there is a problem. If false then it will not return an error, just return false.

Returns: true if it succeeds, false if it fails.

Reimplemented from AnimatSim::SimulationWindow.

Definition at line 128 of file VsScriptedSimulationWindow.cpp.

References DefaultPosition(), AnimatSim::SimulationWindow::SetData(), and StdUtils::Std_CheckString().

Here is the call graph for this function:

void VortexAnimatSim::Visualization::VsScriptedSimulationWindow::SimStarting ( )

virtual

Called just before the simulation starts.

This method is called on each AnimatBase object when the simulation starts. It allows it to perform any intialization prior to the beginning of the simulation that is needed.