A material type name. More...

#include <ConstraintFriction.h>

Inheritance diagram for AnimatSim::Environment::ConstraintFriction:

Collaboration diagram for AnimatSim::Environment::ConstraintFriction:

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

virtual	~ConstraintFriction ()
	Destructor. More...

virtual float	Coefficient ()
	Gets the Coefficient of friction for this constraint. More...

virtual void	Coefficient (float fltVal)
	Sets the Coefficient of friction for this constraint. 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 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	Load (CStdXml &oXml)

virtual float	Loss ()
	Gets the velocity loss for this constraint. More...

virtual void	Loss (float fltVal, bool bUseScaling=true)
	Sets the velocity loss for this constraint. More...

virtual float	MaxForce ()
	Gets the MaxForce the friction can apply. More...

virtual void	MaxForce (float fltVal, bool bUseScaling=true)
	Sets the MaxForce the friction can apply. More...

virtual bool	Proportional ()
	Gets whether the friction force should be scaled based on the amount of force applied to the joint. More...

virtual void	Proportional (bool bVal)
	Sets whether the friction force should be scaled based on the amount of force applied to the joint. More...

virtual void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
	Queries this object for a list of properties that can be changed using SetData. 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	StaticFrictionScale ()
	Gets the ratio between static and dynamic friction coefficients. More...

virtual void	StaticFrictionScale (float fltVal)
	Sets the ratio between static and dynamic friction coefficients. 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	Initialize ()
	Initializes this 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...

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

Protected Member Functions
virtual void	SetFrictionProperties ()=0

Protected Attributes
bool	m_bProportional
	Tells if the friction force should be scaled based on the force applied to the joint.

float	m_fltCoefficient
	The friction coefficient for this constraint.

float	m_fltLoss
	The velocity loss for this constraint.

float	m_fltMaxForce
	The maximum force for this constraint.

float	m_fltStaticFrictionScale
	The scale ration of static to dynamic friction.

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

A material type name.

Author: dcofer

Date: 3/22/2011

Definition at line 20 of file ConstraintFriction.h.

Constructor & Destructor Documentation

AnimatSim::Environment::ConstraintFriction::ConstraintFriction ( )

Default constructor.

Author: dcofer

Date: 3/22/2011

Definition at line 47 of file ConstraintFriction.cpp.

References AnimatSim::AnimatBase::m_bEnabled, m_bProportional, m_fltCoefficient, m_fltLoss, m_fltMaxForce, and m_fltStaticFrictionScale.

AnimatSim::Environment::ConstraintFriction::~ConstraintFriction ( )

virtual

Destructor.

Author: dcofer

Date: 3/22/2011

Definition at line 63 of file ConstraintFriction.cpp.

Member Function Documentation

float AnimatSim::Environment::ConstraintFriction::Coefficient ( )

virtual

Gets the Coefficient of friction for this constraint.

Author: dcofer

Date: 3/23/2011

Returns: Coefficient.

Definition at line 104 of file ConstraintFriction.cpp.

References m_fltCoefficient.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::Environment::ConstraintFriction::Coefficient ( float fltVal )

virtual

Sets the Coefficient of friction for this constraint.

Author: dcofer

Date: 3/23/2011

Parameters

fltVal The new value.

Definition at line 114 of file ConstraintFriction.cpp.

References m_fltCoefficient, and StdUtils::Std_IsAboveMin().

Here is the call graph for this function:

void AnimatSim::Environment::ConstraintFriction::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

Definition at line 243 of file ConstraintFriction.cpp.

References AnimatSim::Simulator::InverseMassUnits(), AnimatSim::AnimatBase::m_bEnabled, m_bProportional, m_fltCoefficient, m_fltLoss, m_fltMaxForce, m_fltStaticFrictionScale, AnimatSim::AnimatBase::m_lpSim, and AnimatSim::Simulator::MassUnits().

Here is the call graph for this function:

bool AnimatSim::Environment::ConstraintFriction::Enabled ( )

virtual

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.

Author: dcofer

Date: 2/24/2011

Returns: Whether this item is enabled.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 77 of file ConstraintFriction.cpp.

References AnimatSim::AnimatBase::m_bEnabled.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::Environment::ConstraintFriction::Enabled ( bool bVal )

virtual

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.

Author: dcofer

Date: 2/24/2011

Parameters

bVal	Sets whether this item is enabled.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 90 of file ConstraintFriction.cpp.

References AnimatSim::AnimatBase::m_bEnabled.

float AnimatSim::Environment::ConstraintFriction::Loss ( )

virtual

Gets the velocity loss for this constraint.

Velocity loss for this constraint.

Author: dcofer

Date: 3/23/2011

Returns: loss value.

Definition at line 162 of file ConstraintFriction.cpp.

References m_fltLoss.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::Environment::ConstraintFriction::Loss	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the velocity loss for this constraint.

the velocity loss for this constraint.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 175 of file ConstraintFriction.cpp.

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

Here is the call graph for this function:

float AnimatSim::Environment::ConstraintFriction::MaxForce ( )

virtual

Gets the MaxForce the friction can apply.

Author: dcofer

Date: 3/23/2011

Returns: MaxForce value.

Definition at line 130 of file ConstraintFriction.cpp.

References m_fltMaxForce.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::Environment::ConstraintFriction::MaxForce	(	float	fltVal,
		bool	bUseScaling = `true`
	)

virtual

Sets the MaxForce the friction can apply.

Author: dcofer

Date: 3/23/2011

Parameters

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

Definition at line 141 of file ConstraintFriction.cpp.

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

Here is the call graph for this function:

bool AnimatSim::Environment::ConstraintFriction::Proportional ( )

virtual

Gets whether the friction force should be scaled based on the amount of force applied to the joint.

Author: dcofer

Date: 3/23/2011

Returns: proportional flag.

Definition at line 194 of file ConstraintFriction.cpp.

References m_bProportional.

Referenced by SetData().

Here is the caller graph for this function:

void AnimatSim::Environment::ConstraintFriction::Proportional ( bool bVal )

virtual

Sets whether the friction force should be scaled based on the amount of force applied to the joint.

Author: dcofer

Date: 3/23/2011

Parameters

fltVal The new value.

Definition at line 204 of file ConstraintFriction.cpp.

References m_bProportional.

void AnimatSim::Environment::ConstraintFriction::QueryProperties ( CStdPtrArray< TypeProperty > & aryProperties )

virtual

Queries this object for a list of properties that can be changed using SetData.

The method provides a list of the properties that can be set using the SetData method. It gives the property name and the type of data that should be passed to it. Valid date types are Boolean, Float, Integer, and Xml.

Author: dcofer

Date: 2/22/2011

Parameters

aryNames	Array list of the property names.
strTypes	Array list of the type that is associated with the cooresponding name in the list.

Returns: Nothing.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 308 of file ConstraintFriction.cpp.

References AnimatSim::AnimatBase::QueryProperties().

Here is the call graph for this function:

bool AnimatSim::Environment::ConstraintFriction::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.