AnimatLab  2
Test
AnimatSim::Environment::ConstraintRelaxation Class Referenceabstract

A material type name. More...

#include <ConstraintRelaxation.h>

+ Inheritance diagram for AnimatSim::Environment::ConstraintRelaxation:
+ Collaboration diagram for AnimatSim::Environment::ConstraintRelaxation:

Public Member Functions

 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 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 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 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 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 NeuralModuleGetNeuralModule ()
 Gets the neural module. More...
 
virtual NodeGetNode ()
 Gets the node. More...
 
virtual SimulatorGetSimulator ()
 Gets the simulator pointer. More...
 
virtual StructureGetStructure ()
 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 ConstraintRelaxationCastToDerived (AnimatBase *lpBase)
 

Protected Member Functions

virtual void SetRelaxationProperties ()=0
 

Protected Attributes

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::NeuralModulem_lpModule
 The pointer to this items parentNeuralModule. If this is not relevant for this object then this is NULL.
 
Nodem_lpNode
 The pointer to this items parent Node. If this is not relevant for this object then this is NULL.
 
Simulatorm_lpSim
 The pointer to a Simulation.
 
AnimatSim::Environment::Structurem_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 ConstraintRelaxation.h.

Constructor & Destructor Documentation

AnimatSim::Environment::ConstraintRelaxation::ConstraintRelaxation ( )

Default constructor.

Author
dcofer
Date
3/22/2011

Definition at line 47 of file ConstraintRelaxation.cpp.

References AnimatSim::AnimatBase::m_bEnabled, m_fltDamping, m_fltStiffness, and m_iCoordinateID.

AnimatSim::Environment::ConstraintRelaxation::~ConstraintRelaxation ( )
virtual

Destructor.

Author
dcofer
Date
3/22/2011

Definition at line 61 of file ConstraintRelaxation.cpp.

Member Function Documentation

int AnimatSim::Environment::ConstraintRelaxation::CoordinateID ( )
virtual

Gets the ID of the coordiante that this relaxation is associated with.

Author
dcofer
Date
3/1/2011
Returns
integer ID.

Definition at line 102 of file ConstraintRelaxation.cpp.

References m_iCoordinateID.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Environment::ConstraintRelaxation::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 in BulletAnimatSim::Environment::BlConstraintRelaxation, and VortexAnimatSim::Environment::VsConstraintRelaxation.

Definition at line 190 of file ConstraintRelaxation.cpp.

References AnimatSim::Simulator::InverseMassUnits(), m_fltDamping, m_fltStiffness, and AnimatSim::AnimatBase::m_lpSim.

+ Here is the call graph for this function:

float AnimatSim::Environment::ConstraintRelaxation::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 161 of file ConstraintRelaxation.cpp.

References m_fltDamping.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Environment::ConstraintRelaxation::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
fltValThe new value.
bUseScalingtrue to use unit scaling.

Reimplemented in BulletAnimatSim::Environment::BlConstraintRelaxation.

Definition at line 172 of file ConstraintRelaxation.cpp.

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

+ Here is the call graph for this function:

bool AnimatSim::Environment::ConstraintRelaxation::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 75 of file ConstraintRelaxation.cpp.

References AnimatSim::AnimatBase::m_bEnabled.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Environment::ConstraintRelaxation::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
bValSets whether this item is enabled.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 88 of file ConstraintRelaxation.cpp.

References AnimatSim::AnimatBase::m_bEnabled.

void AnimatSim::Environment::ConstraintRelaxation::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
aryNamesArray list of the property names.
strTypesArray list of the type that is associated with the cooresponding name in the list.
Returns
Nothing.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 239 of file ConstraintRelaxation.cpp.

References AnimatSim::AnimatBase::QueryProperties().

+ Here is the call graph for this function:

bool AnimatSim::Environment::ConstraintRelaxation::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
strDataTypestring name of the data type to set.
strValueThe 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.
bThrowErrortrue 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.

Reimplemented in BulletAnimatSim::Environment::BlConstraintRelaxation, and VortexAnimatSim::Environment::VsConstraintRelaxation.

Definition at line 201 of file ConstraintRelaxation.cpp.

References CoordinateID(), Damping(), Enabled(), AnimatSim::AnimatBase::SetData(), StdUtils::Std_CheckString(), StdUtils::Std_ToBool(), and Stiffness().

+ Here is the call graph for this function:

float AnimatSim::Environment::ConstraintRelaxation::Stiffness ( )
virtual

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

Author
dcofer
Date
3/23/2011
Returns
Stiffness.

Definition at line 131 of file ConstraintRelaxation.cpp.

References m_fltStiffness.

Referenced by SetData().

+ Here is the caller graph for this function:

void AnimatSim::Environment::ConstraintRelaxation::Stiffness ( float  fltVal,
bool  bUseScaling = true 
)
virtual

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

Author
dcofer
Date
3/23/2011
Parameters
fltValThe new value.
bUseScalingtrue to use unit scaling.

Definition at line 142 of file ConstraintRelaxation.cpp.

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

+ Here is the call graph for this function:


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