Inheritance diagram for VortexAnimatSim::Visualization::ControlPoint:

Collaboration diagram for VortexAnimatSim::Visualization::ControlPoint:

Public Member Functions
	ControlPoint (const double t, const osg::Vec3d pos, const osg::Vec3d v)

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

virtual OsgLinearPath *	ParentSpline ()

virtual void	ParentSpline (OsgLinearPath *lpParentSpline)

virtual osg::Vec3d	Position ()
	Gets the local position. (m_oPosition) More...

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

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

virtual void	Position (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 void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)

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 double	Time ()

virtual void	Time (double dblVal)

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 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 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	Initialize ()
	Initializes this object. More...

virtual void	Kill (bool bState=true)
	Kills. 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 void	ReInitialize ()
	Re-initialize this object. 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	ResetSimulation ()
	Resets the simulation back to time 0. 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 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...

Public Attributes
double	m_dblDist

bool	m_IsDirty

OsgLinearPath *	m_lpParentSpline

osg::Vec3d	m_Pos

osg::Vec3d	m_ReportPos

double	m_T

double	m_Tnext

osg::Vec3d	m_Uv

osg::Vec3d	m_V

osg::Vec3d	m_vDist

Additional Inherited Members
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..

Detailed Description

Definition at line 13 of file VortexAnimatSim/OsgLinearPath.h.

Member Function Documentation

void VortexAnimatSim::Visualization::ControlPoint::Load ( StdUtils::CStdXml & oXml )

virtual

Loads the item using an XML data packet.

This method is responsible for loading the structure from a XMl configuration file. You should call this method even in your overriden function becuase it loads all of the base properties for this object like ID and Name. It also includes this object in the simulators AddToObjectList so that the simulator knows about this object when you do a FindObject call. If you do not call this base method then it is up to you to add your item to the simulators list of objects.

Author: dcofer

Date: 3/1/2011

Parameters

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

Reimplemented from AnimatSim::AnimatBase.

Definition at line 1053 of file VortexAnimatSim/OsgLinearPath.cpp.

References StdUtils::CStdXml::GetChildDouble(), StdUtils::CStdXml::IntoElem(), StdUtils::CStdXml::OutOfElem(), and StdUtils::Std_LoadPoint().

Here is the call graph for this function:

osg::Vec3d VortexAnimatSim::Visualization::ControlPoint::Position ( )

virtual

Gets the local position. (m_oPosition)

Author: dcofer

Date: 3/2/2011

Returns: returns m_oPosition.

Definition at line 912 of file VortexAnimatSim/OsgLinearPath.cpp.

void VortexAnimatSim::Visualization::ControlPoint::Position	(	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 924 of file VortexAnimatSim/OsgLinearPath.cpp.

References AnimatSim::Simulator::DistanceUnits(), AnimatSim::Simulator::InverseDistanceUnits(), and AnimatSim::AnimatBase::m_lpSim.

Here is the call graph for this function:

void VortexAnimatSim::Visualization::ControlPoint::Position	(	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 957 of file VortexAnimatSim/OsgLinearPath.cpp.

void VortexAnimatSim::Visualization::ControlPoint::Position	(	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 974 of file VortexAnimatSim/OsgLinearPath.cpp.

References StdUtils::Std_LoadPoint().

Here is the call graph for this function:

bool VortexAnimatSim::Visualization::ControlPoint::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::AnimatBase.

Definition at line 997 of file VortexAnimatSim/OsgLinearPath.cpp.

References StdUtils::Std_CheckString().

Here is the call graph for this function:

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

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation