Inheritance diagram for VortexAnimatSim::Environment::VsMaterialType:

Collaboration diagram for VortexAnimatSim::Environment::VsMaterialType:

Public Member Functions
virtual float	Compliance ()
	Gets the compliance for collisions between RigidBodies with these two materials. More...

virtual void	Compliance (float fltVal, bool bUseScaling=true)
	Sets the compliance for collisions between RigidBodies with these two materials. More...

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 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 float	FrictionAngularNormal ()
	Gets the angular normal friction coefficient. More...

virtual void	FrictionAngularNormal (float fltVal)
	Sets the angular normal friction coefficient. More...

virtual float	FrictionAngularNormalMax ()
	Gets the maximum angular normal friction allowed. More...

virtual void	FrictionAngularNormalMax (float fltVal, bool bUseScaling=true)
	Sets the maximum angular normal friction allowed. More...

virtual float	FrictionAngularPrimary ()
	Gets the angular primary friction coefficient. More...

virtual void	FrictionAngularPrimary (float fltVal)
	Sets the angular primary friction coefficient. More...

virtual float	FrictionAngularPrimaryMax ()
	Gets the maximum angular primary friction allowed. More...

virtual void	FrictionAngularPrimaryMax (float fltVal, bool bUseScaling=true)
	Sets the maximum angular primary friction allowed. More...

virtual float	FrictionAngularSecondary ()
	Gets the angular secondary friction coefficient. More...

virtual void	FrictionAngularSecondary (float fltVal)
	Sets the angular secondary friction coefficient. More...

virtual float	FrictionAngularSecondaryMax ()
	Gets the maximum angular secondary friction allowed. More...

virtual void	FrictionAngularSecondaryMax (float fltVal, bool bUseScaling=true)
	Sets the maximum angular secondary friction allowed. More...

virtual float	FrictionLinearPrimary ()
	Gets the primary friction coefficient. More...

virtual void	FrictionLinearPrimary (float fltVal)
	Sets the primary linear friction coefficient. More...

virtual float	FrictionLinearPrimaryMax ()
	Gets the maximum primary friction allowed. More...

virtual void	FrictionLinearPrimaryMax (float fltVal, bool bUseScaling=true)
	Sets the maximum primary friction allowed. More...

virtual float	FrictionLinearSecondary ()
	Gets the secondary linear friction coefficient. More...

virtual void	FrictionLinearSecondary (float fltVal)
	Sets the secondary friction coefficient. More...

virtual float	FrictionLinearSecondaryMax ()
	Gets the maximum secondary friction allowed. More...

virtual void	FrictionLinearSecondaryMax (float fltVal, bool bUseScaling=true)
	Sets the maximum secondary friction allowed. More...

virtual int	GetMaterialID (std::string strName)
	Gets a material identifier used by the physics engine. More...

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

virtual void	Load (CStdXml &oXml)

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

virtual void	MaxAdhesive (float fltVal, bool bUseScaling=true)
	Sets the maximum adhesive for collisions between RigidBodies with these two materials. More...

virtual void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)

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

virtual void	Restitution (float fltVal)
	Sets the restitution for collisions between RigidBodies with these two materials. 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 float	SlideAngularNormal ()
	Gets the angular normal slide value. More...

virtual void	SlideAngularNormal (float fltVal, bool bUseScaling=true)
	Sets the angular normal slide value. More...

virtual float	SlideAngularPrimary ()
	Gets the angular primary slide value. More...

virtual void	SlideAngularPrimary (float fltVal, bool bUseScaling=true)
	Sets the angular primary slide value. More...

virtual float	SlideAngularSecondary ()
	Gets the angular secondary slide value. More...

virtual void	SlideAngularSecondary (float fltVal, bool bUseScaling=true)
	Sets the angular secondary slide value. More...

virtual float	SlideLinearPrimary ()
	Gets the linear primary slide value. More...

virtual void	SlideLinearPrimary (float fltVal, bool bUseScaling=true)
	Sets the linear primary slide value. More...

virtual float	SlideLinearSecondary ()
	Gets the linear secondary slide value. More...

virtual void	SlideLinearSecondary (float fltVal, bool bUseScaling=true)
	Sets the linear secondary slide value. More...

virtual float	SlipAngularNormal ()
	Gets the angular normal slip value. More...

virtual void	SlipAngularNormal (float fltVal, bool bUseScaling=true)
	Sets the angular normal slip value. More...

virtual float	SlipAngularPrimary ()
	Gets the angular primary slip value. More...

virtual void	SlipAngularPrimary (float fltVal, bool bUseScaling=true)
	Sets the angular primary slip value. More...

virtual float	SlipAngularSecondary ()
	Gets the angular secondary slip value. More...

virtual void	SlipAngularSecondary (float fltVal, bool bUseScaling=true)
	Sets the angular secondary slip value. More...

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

virtual void	SlipLinearPrimary (float fltVal, bool bUseScaling=true)
	Sets the primary linear slip value. More...

virtual float	SlipLinearSecondary ()
	Gets the secondary linear slip value. More...

virtual void	SlipLinearSecondary (float fltVal, bool bUseScaling=true)
	Sets the secondary linear slip value. More...

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

virtual	~MaterialType ()
	Destructor. 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 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	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 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	RegisterMaterialType ()
	Registers the material types within the physics engine. More...

virtual void	SetMaterialProperties ()

Protected Attributes
float	m_fltCompliance
	The compliance of the collision between those two materials.

float	m_fltDamping
	The damping of the collision between those two materials.

float	m_fltFrictionAngularNormal
	The angular normal coefficient of friction parameter. (this simulates spinning resistance)

float	m_fltFrictionAngularNormalMax
	The maximum angular normal friction that can created.

float	m_fltFrictionAngularPrimary
	The angular primary coefficient of friction parameter.(this simulates rolling resistance)

float	m_fltFrictionAngularPrimaryMax
	The maximum angular primary friction that can created.

float	m_fltFrictionAngularSecondary
	The angular secondary coefficient of friction parameter.(this simulates rolling resistance)

float	m_fltFrictionAngularSecondaryMax
	The maximum angular secondary friction that can created.

float	m_fltFrictionLinearPrimary
	The primary linear coefficient of friction parameter.

float	m_fltFrictionLinearPrimaryMax
	The maximum linear primary friction that can created.

float	m_fltFrictionLinearSecondary
	The secondary linear coefficient of friction parameter.

float	m_fltFrictionLinearSecondaryMax
	The maximum linear secondary friction that can created.

float	m_fltMaxAdhesive
	The maximum adhesion of the collision between those two materials.

float	m_fltRestitution
	The restitution of the collision between those two materials.

float	m_fltSlideAngularNormal
	The angular normal slide of the collision between those two materials.

float	m_fltSlideAngularPrimary
	The angular primary slide of the collision between those two materials.

float	m_fltSlideAngularSecondary
	The angular secondary slide of the collision between those two materials.

float	m_fltSlideLinearPrimary
	The primary linear slide of the collision between those two materials.

float	m_fltSlideLinearSecondary
	The primary linear slide of the collision between those two materials.

float	m_fltSlipAngularNormal
	The angular normal slip of the collision between those two materials.

float	m_fltSlipAngularPrimary
	The angular primary slip of the collision between those two materials.

float	m_fltSlipAngularSecondary
	The angular secondary slip of the collision between those two materials.

float	m_fltSlipLinearPrimary
	The primary linear slip of the collision between those two materials.

float	m_fltSlipLinearSecondary
	The secondary linear slip of the collision between those two materials.

VxMaterial *	m_vxMaterial

VxMaterialTable *	m_vxMaterialTable

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

Detailed Description

Definition at line 11 of file VsMaterialType.h.

Member Function Documentation

float VortexAnimatSim::Environment::VsMaterialType::Compliance ( )

virtual

Gets the compliance for collisions between RigidBodies with these two materials.

Author: dcofer

Date: 3/23/2011

Returns: compliance.

Definition at line 728 of file VsMaterialType.cpp.

References m_fltCompliance.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::Compliance	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the compliance for collisions between RigidBodies with these two materials.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 739 of file VsMaterialType.cpp.

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

Here is the call graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::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

Implements AnimatSim::Environment::MaterialType.

Definition at line 862 of file VsMaterialType.cpp.

References AnimatSim::Simulator::InverseDistanceUnits(), AnimatSim::Simulator::InverseMassUnits(), m_fltCompliance, m_fltDamping, m_fltFrictionAngularNormal, m_fltFrictionAngularNormalMax, m_fltFrictionAngularPrimary, m_fltFrictionAngularPrimaryMax, m_fltFrictionAngularSecondary, m_fltFrictionAngularSecondaryMax, m_fltFrictionLinearPrimary, m_fltFrictionLinearPrimaryMax, m_fltFrictionLinearSecondary, m_fltFrictionLinearSecondaryMax, m_fltMaxAdhesive, m_fltRestitution, m_fltSlideAngularNormal, m_fltSlideAngularPrimary, m_fltSlideAngularSecondary, m_fltSlideLinearPrimary, m_fltSlideLinearSecondary, m_fltSlipAngularNormal, m_fltSlipAngularPrimary, m_fltSlipAngularSecondary, m_fltSlipLinearPrimary, m_fltSlipLinearSecondary, AnimatSim::AnimatBase::m_lpSim, and AnimatSim::Simulator::MassUnits().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::Damping ( )

virtual

Gets the damping for collisions between RigidBodies with these two materials.

Author: dcofer

Date: 3/23/2011

Returns: damping value.

Definition at line 758 of file VsMaterialType.cpp.

References m_fltDamping.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::Damping	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the damping for collisions between RigidBodies with these two materials.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 769 of file VsMaterialType.cpp.

References AnimatSim::Simulator::DisplayMassUnits(), m_fltDamping, AnimatSim::AnimatBase::m_lpSim, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::FrictionAngularNormal ( )

virtual

Gets the angular normal friction coefficient.

Author: dcofer

Date: 3/23/2011

Returns: friction coefficient.

Definition at line 112 of file VsMaterialType.cpp.

References m_fltFrictionAngularNormal.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::FrictionAngularNormal ( float fltVal )

virtual

Sets the angular normal friction coefficient.

Author: dcofer

Date: 3/23/2011

Parameters

fltVal The new value.

Definition at line 122 of file VsMaterialType.cpp.

References m_fltFrictionAngularNormal, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::FrictionAngularNormalMax ( )

virtual

Gets the maximum angular normal friction allowed.

Author: dcofer

Date: 3/23/2011

Returns: max friction.

Definition at line 250 of file VsMaterialType.cpp.

References m_fltFrictionAngularNormalMax.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::FrictionAngularNormalMax	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the maximum angular normal friction allowed.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 261 of file VsMaterialType.cpp.

References AnimatSim::Simulator::InverseDistanceUnits(), AnimatSim::Simulator::InverseMassUnits(), m_fltFrictionAngularNormalMax, AnimatSim::AnimatBase::m_lpSim, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::FrictionAngularPrimary ( )

virtual

Gets the angular primary friction coefficient.

Author: dcofer

Date: 3/23/2011

Returns: friction coefficient.

Definition at line 138 of file VsMaterialType.cpp.

References m_fltFrictionAngularPrimary.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::FrictionAngularPrimary ( float fltVal )

virtual

Sets the angular primary friction coefficient.

Author: dcofer

Date: 3/23/2011

Parameters

fltVal The new value.

Definition at line 148 of file VsMaterialType.cpp.

References m_fltFrictionAngularPrimary, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::FrictionAngularPrimaryMax ( )

virtual

Gets the maximum angular primary friction allowed.

Author: dcofer

Date: 3/23/2011

Returns: max friction.

Definition at line 280 of file VsMaterialType.cpp.

References m_fltFrictionAngularPrimaryMax.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::FrictionAngularPrimaryMax	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the maximum angular primary friction allowed.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 291 of file VsMaterialType.cpp.

References AnimatSim::Simulator::InverseDistanceUnits(), AnimatSim::Simulator::InverseMassUnits(), m_fltFrictionAngularPrimaryMax, AnimatSim::AnimatBase::m_lpSim, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::FrictionAngularSecondary ( )

virtual

Gets the angular secondary friction coefficient.

Author: dcofer

Date: 3/23/2011

Returns: friction coefficient.

Definition at line 164 of file VsMaterialType.cpp.

References m_fltFrictionAngularSecondary.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::FrictionAngularSecondary ( float fltVal )

virtual

Sets the angular secondary friction coefficient.

Author: dcofer

Date: 3/23/2011

Parameters

fltVal The new value.

Definition at line 174 of file VsMaterialType.cpp.

References m_fltFrictionAngularSecondary, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::FrictionAngularSecondaryMax ( )

virtual

Gets the maximum angular secondary friction allowed.

Author: dcofer

Date: 3/23/2011

Returns: max friction.

Definition at line 310 of file VsMaterialType.cpp.

References m_fltFrictionAngularSecondaryMax.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::FrictionAngularSecondaryMax	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the maximum angular secondary friction allowed.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 321 of file VsMaterialType.cpp.

References AnimatSim::Simulator::InverseDistanceUnits(), AnimatSim::Simulator::InverseMassUnits(), m_fltFrictionAngularSecondaryMax, AnimatSim::AnimatBase::m_lpSim, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::FrictionLinearPrimary ( )

virtual

Gets the primary friction coefficient.

Author: dcofer

Date: 3/23/2011

Returns: friction coefficient.

Definition at line 61 of file VsMaterialType.cpp.

References m_fltFrictionLinearPrimary.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::FrictionLinearPrimary ( float fltVal )

virtual

Sets the primary linear friction coefficient.

Author: dcofer

Date: 3/23/2011

Parameters

fltVal The new value.

Definition at line 71 of file VsMaterialType.cpp.

References m_fltFrictionLinearPrimary, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::FrictionLinearPrimaryMax ( )

virtual

Gets the maximum primary friction allowed.

Author: dcofer

Date: 3/23/2011

Returns: max friction.

Definition at line 190 of file VsMaterialType.cpp.

References m_fltFrictionLinearPrimaryMax.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::FrictionLinearPrimaryMax	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the maximum primary friction allowed.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 201 of file VsMaterialType.cpp.

References AnimatSim::Simulator::InverseDistanceUnits(), AnimatSim::Simulator::InverseMassUnits(), m_fltFrictionLinearPrimaryMax, AnimatSim::AnimatBase::m_lpSim, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::FrictionLinearSecondary ( )

virtual

Gets the secondary linear friction coefficient.

Author: dcofer

Date: 3/23/2011

Returns: friction coefficient.

Definition at line 87 of file VsMaterialType.cpp.

References m_fltFrictionLinearSecondary.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::FrictionLinearSecondary ( float fltVal )

virtual

Sets the secondary friction coefficient.

Author: dcofer

Date: 3/23/2011

Parameters

fltVal The new value.

Definition at line 97 of file VsMaterialType.cpp.

References m_fltFrictionLinearSecondary, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::FrictionLinearSecondaryMax ( )

virtual

Gets the maximum secondary friction allowed.

Author: dcofer

Date: 3/23/2011

Returns: max friction.

Definition at line 220 of file VsMaterialType.cpp.

References m_fltFrictionLinearSecondaryMax.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::FrictionLinearSecondaryMax	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the maximum secondary friction allowed.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 231 of file VsMaterialType.cpp.

References AnimatSim::Simulator::InverseDistanceUnits(), AnimatSim::Simulator::InverseMassUnits(), m_fltFrictionLinearSecondaryMax, AnimatSim::AnimatBase::m_lpSim, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

int VortexAnimatSim::Environment::VsMaterialType::GetMaterialID ( std::string strName )

virtual

Gets a material identifier used by the physics engine.

This is a pure virtual function that must be overridden in the derived physics class.

Author: dcofer

Date: 3/23/2011

Parameters

strName Name of the string.

Returns: The material identifier.

Implements AnimatSim::Environment::MaterialType.

Definition at line 1137 of file VsMaterialType.cpp.

void VortexAnimatSim::Environment::VsMaterialType::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 1159 of file VsMaterialType.cpp.

References RegisterMaterialType().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::MaxAdhesive ( )

virtual

Gets the maximum adhesive for collisions between RigidBodies with these two materials.

Adhesive force allows objects to stick together, as if they were glued. This property provides the minimal force needed to separate the two objects.

Author: dcofer

Date: 3/23/2011

Returns: Maximum adhesive force.

Definition at line 832 of file VsMaterialType.cpp.

References m_fltMaxAdhesive.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::MaxAdhesive	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the maximum adhesive for collisions between RigidBodies with these two materials.

Adhesive force allows objects to stick together, as if they were glued. This property provides the minimal force needed to separate the two objects.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 846 of file VsMaterialType.cpp.

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

Here is the call graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::RegisterMaterialType ( )

protectedvirtual

Registers the material types within the physics engine.

This is a pure virtual function that must be overridden in the derived physics class.

Author: dcofer

Date: 3/23/2011

Parameters

aryMaterialTypes List of types of the ary materials.

Implements AnimatSim::Environment::MaterialType.

Definition at line 1145 of file VsMaterialType.cpp.

References AnimatSim::AnimatBase::m_lpSim, and AnimatSim::AnimatBase::m_strID.

Referenced by Initialize().

Here is the caller graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::Restitution ( )

virtual

Gets the restitution for collisions between RigidBodies with these two materials.

When a collision occurs between two rigid bodies, the impulse corresponding to the force is equal to the total change in momentum that each body undergoes. This change of momentum is affected by the degree of resilience of each body, that is, the extent to which energy is diffused.
The coefficient of restitution is a parameter representing the degree of resilience of a particular material pair. To make simulations more efficient, it is best to set a restitution threshold as well. Impacts that measure less than the threshold will be ignored, to avoid jitter in the simulation. Small impulses do not add to the realism of most simulations.

Author: dcofer

Date: 3/23/2011

Returns: Restitution value.

Definition at line 796 of file VsMaterialType.cpp.

References m_fltRestitution.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::Restitution ( float fltVal )

virtual

Sets the restitution for collisions between RigidBodies with these two materials.

When a collision occurs between two rigid bodies, the impulse corresponding to the force is equal to the total change in momentum that each body undergoes. This change of momentum is affected by the degree of resilience of each body, that is, the extent to which energy is diffused.
The coefficient of restitution is a parameter representing the degree of resilience of a particular material pair. To make simulations more efficient, it is best to set a restitution threshold as well. Impacts that measure less than the threshold will be ignored, to avoid jitter in the simulation. Small impulses do not add to the realism of most simulations.

Author: dcofer

Date: 3/23/2011

Parameters

fltVal The new value.

Definition at line 814 of file VsMaterialType.cpp.

References m_fltRestitution, and StdUtils::Std_InValidRange().

Here is the call graph for this function:

bool VortexAnimatSim::Environment::VsMaterialType::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 911 of file VsMaterialType.cpp.

References Compliance(), Damping(), FrictionAngularNormal(), FrictionAngularNormalMax(), FrictionAngularPrimary(), FrictionAngularPrimaryMax(), FrictionAngularSecondary(), FrictionAngularSecondaryMax(), FrictionLinearPrimary(), FrictionLinearPrimaryMax(), FrictionLinearSecondary(), FrictionLinearSecondaryMax(), MaxAdhesive(), Restitution(), SlideAngularNormal(), SlideAngularPrimary(), SlideAngularSecondary(), SlideLinearPrimary(), SlideLinearSecondary(), SlipAngularNormal(), SlipAngularPrimary(), SlipAngularSecondary(), SlipLinearPrimary(), SlipLinearSecondary(), and StdUtils::Std_CheckString().

float VortexAnimatSim::Environment::VsMaterialType::SlideAngularNormal ( )

virtual

Gets the angular normal slide value.

The contact sliding parameter allows a desired relative linear velocity to be specified between the colliding parts at the contact position. A conveyor belt would be an example of an application. The belt part itself would not be moving.

Author: dcofer

Date: 3/23/2011

Returns: slide value.

Definition at line 615 of file VsMaterialType.cpp.

References m_fltSlideAngularNormal.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::SlideAngularNormal	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the angular normal slide value.

The contact sliding parameter allows a desired relative linear velocity to be specified between the colliding parts at the contact position. A conveyor belt would be an example of an application. The belt part itself would not be moving.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 631 of file VsMaterialType.cpp.

References AnimatSim::Simulator::InverseDistanceUnits(), m_fltSlideAngularNormal, AnimatSim::AnimatBase::m_lpSim, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::SlideAngularPrimary ( )

virtual

Gets the angular primary slide value.

The contact sliding parameter allows a desired relative Angular velocity to be specified between the colliding parts at the contact position. A conveyor belt would be an example of an application. The belt part itself would not be moving.

Author: dcofer

Date: 3/23/2011

Returns: slide value.

Definition at line 654 of file VsMaterialType.cpp.

References m_fltSlideAngularPrimary.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::SlideAngularPrimary	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the angular primary slide value.

The contact sliding parameter allows a desired relative Angular velocity to be specified between the colliding parts at the contact position. A conveyor belt would be an example of an application. The belt part itself would not be moving.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 669 of file VsMaterialType.cpp.

References AnimatSim::Simulator::InverseDistanceUnits(), m_fltSlideAngularPrimary, AnimatSim::AnimatBase::m_lpSim, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::SlideAngularSecondary ( )

virtual

Gets the angular secondary slide value.

The contact sliding parameter allows a desired relative Angular velocity to be specified between the colliding parts at the contact position. A conveyor belt would be an example of an application. The belt part itself would not be moving.

Author: dcofer

Date: 3/23/2011

Returns: slide value.

Definition at line 693 of file VsMaterialType.cpp.

References m_fltSlideAngularSecondary.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::SlideAngularSecondary	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the angular secondary slide value.

The contact sliding parameter allows a desired relative Angular velocity to be specified between the colliding parts at the contact position. A conveyor belt would be an example of an application. The belt part itself would not be moving.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 709 of file VsMaterialType.cpp.

References AnimatSim::Simulator::InverseDistanceUnits(), m_fltSlideAngularSecondary, AnimatSim::AnimatBase::m_lpSim, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::SlideLinearPrimary ( )

virtual

Gets the linear primary slide value.

The contact sliding parameter allows a desired relative linear velocity to be specified between the colliding parts at the contact position. A conveyor belt would be an example of an application. The belt part itself would not be moving.

Author: dcofer

Date: 3/23/2011

Returns: slide value.

Definition at line 537 of file VsMaterialType.cpp.

References m_fltSlideLinearPrimary.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::SlideLinearPrimary	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the linear primary slide value.

The contact sliding parameter allows a desired relative linear velocity to be specified between the colliding parts at the contact position. A conveyor belt would be an example of an application. The belt part itself would not be moving.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 552 of file VsMaterialType.cpp.

References AnimatSim::Simulator::InverseDistanceUnits(), m_fltSlideLinearPrimary, AnimatSim::AnimatBase::m_lpSim, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::SlideLinearSecondary ( )

virtual

Gets the linear secondary slide value.

The contact sliding parameter allows a desired relative linear velocity to be specified between the colliding parts at the contact position. A conveyor belt would be an example of an application. The belt part itself would not be moving.

Author: dcofer

Date: 3/23/2011

Returns: slide value.

Definition at line 576 of file VsMaterialType.cpp.

References m_fltSlideLinearSecondary.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::SlideLinearSecondary	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the linear secondary slide value.

The contact sliding parameter allows a desired relative linear velocity to be specified between the colliding parts at the contact position. A conveyor belt would be an example of an application. The belt part itself would not be moving.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 592 of file VsMaterialType.cpp.

References AnimatSim::Simulator::InverseDistanceUnits(), m_fltSlideLinearSecondary, AnimatSim::AnimatBase::m_lpSim, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::SlipAngularNormal ( )

virtual

Gets the angular normal 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 421 of file VsMaterialType.cpp.

References m_fltSlipAngularNormal.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::SlipAngularNormal	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the angular normal 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 437 of file VsMaterialType.cpp.

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

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::SlipAngularPrimary ( )

virtual

Gets the angular primary 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 460 of file VsMaterialType.cpp.

References m_fltSlipAngularPrimary.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::SlipAngularPrimary	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the angular primary 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 475 of file VsMaterialType.cpp.

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

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::SlipAngularSecondary ( )

virtual

Gets the angular secondary 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 498 of file VsMaterialType.cpp.

References m_fltSlipAngularSecondary.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::SlipAngularSecondary	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the angular secondary 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 514 of file VsMaterialType.cpp.

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

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::SlipLinearPrimary ( )

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 344 of file VsMaterialType.cpp.

References m_fltSlipLinearPrimary.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::SlipLinearPrimary	(	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 359 of file VsMaterialType.cpp.

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

Here is the call graph for this function:

float VortexAnimatSim::Environment::VsMaterialType::SlipLinearSecondary ( )

virtual

Gets the secondary 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 382 of file VsMaterialType.cpp.

References m_fltSlipLinearSecondary.

Referenced by SetData().

Here is the caller graph for this function:

void VortexAnimatSim::Environment::VsMaterialType::SlipLinearSecondary	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the secondary 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 398 of file VsMaterialType.cpp.

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

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