Inheritance diagram for VortexAnimatSim::Environment::VsConstraintRelaxation:

Collaboration diagram for VortexAnimatSim::Environment::VsConstraintRelaxation:

Public Member Functions
virtual void	CreateDefaultUnits ()
	This takes the default values defined in the constructor and scales them according to the distance and mass units to be acceptable values. More...

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

virtual void	Load (CStdXml &oXml)

virtual float	Loss ()
	Gets the primary linear slip value. More...

virtual void	Loss (float fltVal, bool bUseScaling=true)
	Sets the primary linear slip value. 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...

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

virtual	~ConstraintRelaxation ()
	Destructor. More...

virtual int	CoordinateID ()
	Gets the ID of the coordiante that this relaxation is associated with. More...

virtual void	CoordinateID (int iVal)

virtual float	Damping ()
	Gets the damping for collisions between RigidBodies with these two materials. More...

virtual void	Damping (float fltVal, bool bUseScaling=true)
	Sets the damping for collisions between RigidBodies with these two materials. 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 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 void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
	Queries this object for a list of properties that can be changed using SetData. More...

virtual float	Stiffness ()
	Gets the Stiffness for collisions between RigidBodies with these two materials. More...

virtual void	Stiffness (float fltVal, bool bUseScaling=true)
	Sets the Stiffness for collisions between RigidBodies with these two materials. 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	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...

Protected Member Functions
virtual void	SetRelaxationProperties ()

Protected Attributes
float	m_fltLoss
	The primary linear slip of the collision between those two materials.

Protected Attributes inherited from AnimatSim::Environment::ConstraintRelaxation
float	m_fltDamping
	The damping of the collision between those two materials.

float	m_fltStiffness
	The compliance of the collision between those two materials.

int	m_iCoordinateID
	The constraint coordinate ID.

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::Environment::ConstraintRelaxation
static ConstraintRelaxation *	CastToDerived (AnimatBase *lpBase)

Detailed Description

Definition at line 11 of file VsConstraintRelaxation.h.

Member Function Documentation

void VortexAnimatSim::Environment::VsConstraintRelaxation::CreateDefaultUnits ( )

virtual

This takes the default values defined in the constructor and scales them according to the distance and mass units to be acceptable values.

Author: dcofer

Date: 3/23/2011

Reimplemented from AnimatSim::Environment::ConstraintRelaxation.

Definition at line 89 of file VsConstraintRelaxation.cpp.

References m_fltLoss, AnimatSim::AnimatBase::m_lpSim, and AnimatSim::Simulator::MassUnits().

Here is the call graph for this function:

void VortexAnimatSim::Environment::VsConstraintRelaxation::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 AnimatSim::AnimatBase.

Definition at line 75 of file VsConstraintRelaxation.cpp.

float VortexAnimatSim::Environment::VsConstraintRelaxation::Loss ( )

virtual

Gets the primary linear slip value.

Contact slip allows a tangential loss at the contact position to be defined. For example, this is a useful parameter to set for the interaction between a cylindrical wheel and a terrain where, without a minimum amount of slip, the vehicle would have a hard time turning.

Author: dcofer

Date: 3/23/2011

Returns: slip value.

Definition at line 49 of file VsConstraintRelaxation.cpp.

References m_fltLoss.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsConstraintRelaxation::Loss	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the primary linear slip value.

Contact slip allows a tangential loss at the contact position to be defined. For example, this is a useful parameter to set for the interaction between a cylindrical wheel and a terrain where, without a minimum amount of slip, the vehicle would have a hard time turning.

Author: dcofer

Date: 3/23/2011

Parameters

fltVal	The new value.
bUseScaling	true to use unit scaling.

Definition at line 64 of file VsConstraintRelaxation.cpp.

References m_fltLoss, AnimatSim::AnimatBase::m_lpSim, AnimatSim::Simulator::MassUnits(), and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

bool VortexAnimatSim::Environment::VsConstraintRelaxation::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::Environment::ConstraintRelaxation.

Definition at line 96 of file VsConstraintRelaxation.cpp.

References Loss(), and 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

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation