Creates a constraint as configurable as the 6Dof constraint, but has added support for spring motion. More...

#include <constraint.h>

Inheritance diagram for Mezzanine::Physics::Generic6DofSpringConstraint:

Collaboration diagram for Mezzanine::Physics::Generic6DofSpringConstraint:

Public Types
enum	UsableAxis { LinearX = 0, LinearY = 1, LinearZ = 2, AngularX = 3, AngularY = 4, AngularZ = 5 }
	Identify the Axis a bit easier when iterating over them is less convienent than typing an Identifier. More...

Public Types inherited from Mezzanine::Physics::Generic6DofConstraint
enum	UsableAxis { LinearX = 0, LinearY = 1, LinearZ = 2, AngularX = 3, AngularY = 4, AngularZ = 5, AngularXAsRotationalAxis = 0, AngularYAsRotationalAxis = 1, AngularZAsRotationalAxis = 2 }
	Identify the Axis a bit easier when iterating over them is less convienent than typing an Identifier. More...

Public Member Functions
	Generic6DofSpringConstraint (RigidProxy ProxyA, RigidProxy ProxyB, const Vector3 &VectorA, const Vector3 &VectorB, const Quaternion &QuaternionA, const Quaternion &QuaternionB, bool UseLinearReferenceA=false)
	Two proxy Verbose constructor. More...

	Generic6DofSpringConstraint (RigidProxy ProxyA, RigidProxy ProxyB, const Transform &TransformA, const Transform &TransformB, bool UseLinearReferenceA=false)
	Two proxy Terse constructor. More...

virtual	~Generic6DofSpringConstraint ()
	Class destructor. More...

virtual void	CalculateSpringEquilibriumPoint ()

virtual void	CalculateSpringEquilibriumPoint (int Index)

virtual Vector3	GetCurrentSpringAngularEquilibriumPoints () const

virtual Real	GetCurrentSpringEquilibriumPoint (int Index) const

virtual Vector3	GetCurrentSpringLinearEquilibriumPoints () const

virtual Vector3	GetSpringAngularDamping () const
	Get the Damping for all Angular Axis. More...

virtual Vector3	GetSpringAngularEnabled () const
	Get the Enabled Status for all Angular Axis. More...

virtual Vector3	GetSpringAngularStiffness () const
	Get the Stiffness for all Angular Axis. More...

virtual Real	GetSpringDamping (int Index) const
	Retrieve the Damping of the spring on the given axis. More...

virtual bool	GetSpringEnabled (int Index) const
	Retrieve the EnabledStatus of the spring on the given axis. More...

virtual Vector3	GetSpringLinearDamping () const
	Get the Damping for all Linear Axis. More...

virtual Vector3	GetSpringLinearEnabled () const
	Get the Enabled Status for all Linear Axis. More...

virtual Vector3	GetSpringLinearStiffness () const
	Get the Stiffness for all Linear Axis. More...

virtual Real	GetSpringStiffness (int Index) const
	Retrieve the Stiffness of the spring on the given axis. More...

virtual void	ProtoDeSerialize (const XML::Node &OneNode)
	Take the data stored in an XML and overwrite this instance of this object with it. More...

virtual void	ProtoSerialize (XML::Node &CurrentRoot) const
	Convert this class to an XML::Node ready for serialization. More...

virtual void	SetSpringAngularDamping (const Vector3 &Damps)
	Set the Damping of the springs on each Angular Axis. More...

virtual void	SetSpringAngularEnabled (const Vector3 &Enableness)
	Set the Stiffness of the springs on each Angular Axis. More...

virtual void	SetSpringAngularStiffness (const Vector3 &Stiffies)
	Set the Stiffness of the springs on each Angular Axis. More...

virtual void	SetSpringDamping (int Index, Real Damping)
	Set the spring Damping on a given axis. More...

virtual void	SetSpringEnabled (int Index, bool Enable)
	Set the spring's enabled status on a given axis. More...

virtual void	SetSpringLinearDamping (const Vector3 &Damps)
	Set the Damping of the springs on each Linear Axis. More...

virtual void	SetSpringLinearEnabled (const Vector3 &Enableness)
	Set the Stiffness of the springs on each Linear Axis. More...

virtual void	SetSpringLinearStiffness (const Vector3 &Stiffies)
	Set the Stiffness of the springs on each Linear Axis. More...

virtual void	SetSpringStiffness (int Index, Real Stiffness)
	Set the spring stiffness on a given axis. More...

Public Member Functions inherited from Mezzanine::Physics::Generic6DofConstraint
	Generic6DofConstraint (RigidProxy ProxyA, RigidProxy ProxyB, const Vector3 &VectorA, const Vector3 &VectorB, const Quaternion &QuaternionA, const Quaternion &QuaternionB, bool UseLinearReferenceA=false)
	Two proxy Verbose constructor. More...

	Generic6DofConstraint (RigidProxy ProxyA, RigidProxy ProxyB, const Transform &TransformA, const Transform &TransformB, bool UseLinearReferenceA=false)
	Two proxy Terse constructor. More...

	Generic6DofConstraint (RigidProxy *ProxyB, const Vector3 &VectorB, const Quaternion &QuaternionB, bool UseLinearReferenceB=true)
	Body and World Verbose constructor. More...

	Generic6DofConstraint (RigidProxy *ProxyB, const Transform &TransformB, bool UseLinearReferenceB=true)
	Body and World Terse constructor. More...

virtual	~Generic6DofConstraint ()
	Class destructor.

virtual int	AxisToAngularAxis (int Axis) const
	Convert to internal Axis IDs from external or internal axis IDs. More...

virtual Vector3	GetAngularLimitLower () const
	Get the Upper limits on rotation. More...

Real	GetAngularLimitLowerOnAxis (int RotationalAxis) const
	Get a specific lower rotational limit. More...

virtual Vector3	GetAngularLimitMaxForce () const
	Get the Maximimum amount of force applied to ensure limits are not surpassed. More...

virtual Real	GetAngularLimitMaxForceOnAxis (int Axis) const
	Get the Maximimum amount of force applied to ensure a limit one axis is not surpassed. More...

virtual Vector3	GetAngularLimitUpper () const
	Get the Power limits on rotation. More...

Real	GetAngularLimitUpperOnAxis (int RotationalAxis) const
	Get a specific upper rotational limit. More...

virtual Vector3	GetAngularMotorDamping () const
	Get the Damping for all Angular Axis. More...

virtual Real	GetAngularMotorDampingOnAxis (int Axis) const
	Get the Damping for one given Axis. More...

virtual Vector3	GetAngularMotorEnabled () const
	Get a Vector3 with 3 zero or nonzero values that store whether or not a given rotational motor is enable. More...

virtual bool	GetAngularMotorEnabledOnAxis (int Axis) const
	Is a specific rotational motor enabled. More...

virtual Vector3	GetAngularMotorMaxForce () const
	Get the Max Motor Force for each Axis. More...

virtual Real	GetAngularMotorMaxForceOnAxis (int Axis) const
	Get the Max motor Force on a certain Axis. More...

virtual Vector3	GetAngularMotorRestitution () const
	Get the Restistution values for all three axis. More...

virtual Real	GetAngularMotorRestitutionOnAxis (int Axis) const
	Get the Restistution/Bounciness for a single Axis. More...

virtual Vector3	GetAngularMotorTargetVelocity () const
	Get the target velocity for all angular Axis. More...

virtual Real	GetAngularMotorTargetVelocityOnAxis (int Axis) const
	Get the Target Velocity for one axis. More...

virtual btTypedConstraint *	GetConstraintBase () const
	Get the Bullet constraint that this class encapsulates. More...

virtual Real	GetLinearLimitDamping () const
	Get the Damping of the linear Limits. More...

virtual Vector3	GetLinearLimitLower () const
	Get the Upper limits on translation. More...

virtual Real	GetLinearLimitRestitution () const
	Get the Restitution of the linear Limits. More...

virtual Real	GetLinearLimitSoftness () const
	Get the Softness of the linear Limits. More...

virtual Vector3	GetLinearLimitUpper () const
	Get the lower limits on translation. More...

virtual Vector3	GetLinearMotorEnabled () const
	Get a Vector3 with 3 zero or nonzero values that store whether or not a given rotational motor is enable. More...

virtual bool	GetLinearMotorEnabledOnAxis (int Axis) const
	Is a specific Linear motor enabled. More...

virtual Vector3	GetLinearMotorMaxForce () const
	Get the Max Motor Force for each Axis. More...

virtual Real	GetLinearMotorMaxForceOnAxis (int Axis) const
	Get the Max motor Force on a certain Axis. More...

virtual Vector3	GetLinearMotorTargetVelocity () const
	Get the target velocity for all Linear Axis. More...

virtual Real	GetLinearMotorTargetVelocityOnAxis (int Axis) const
	Get the Target Velocity for one axis. More...

virtual Vector3	GetPivotALocation () const
	Get the location of the pivot relative to ActorA's Center of gravity. More...

virtual Quaternion	GetPivotARotation () const
	Get the relative rotation for ActorA. More...

virtual Transform	GetPivotATransform () const
	Get the current Rotation and Location of Actor A. More...

virtual Vector3	GetPivotBLocation () const
	Get the location of the pivot relative to ActorB's Center of gravity. More...

virtual Quaternion	GetPivotBRotation () const
	Get the relative rotation for ActorB. More...

virtual Transform	GetPivotBTransform () const
	Get the current Rotation and Location of Actor B. More...

virtual bool	GetUseFrameOffset () const
	Retrieve the stored value from the physics subsystem(bullet) More...

virtual bool	HasParamBeenSet (ConstraintParam Param, int Axis) const

virtual void	SetAngularLimitLower (const Vector3 &Limit)
	Set the Lower limits on rotation. More...

virtual void	SetAngularLimitMaxForce (const Vector3 &MaxLimitForces)
	Set the Maximimum amount of force applied to ensure limits are not surpassed. More...

virtual void	SetAngularLimitMaxForceOnAxis (Real MaxLimitForce, int Axis)
	Set the Maximimum amount of force applied to ensure a limit on one axis is not surpassed. More...

virtual void	SetAngularLimitUpper (const Vector3 &Limit)
	Set the Upper limits on rotation. More...

virtual void	SetAngularMotorDamping (const Vector3 &Dampings)
	Set the Angular Motor Damping for each Angular Axis. More...

virtual void	SetAngularMotorDampingOnAxis (Real Damping, int Axis)
	For one Axis, set the Damping. More...

virtual void	SetAngularMotorEnabled (const Vector3 &Enableds)
	Set whether or not the motor is enabled for all Axis Simultaneously. More...

virtual void	SetAngularMotorEnabledOnAxis (bool Enabled, int Axis)
	For one Axis, set whether or not the motor is enabled. More...

virtual void	SetAngularMotorMaxForce (const Vector3 &Forces)
	Set the Angular Motor Maximum force on all 3 rotational axis. More...

virtual void	SetAngularMotorMaxForceOnAxis (Real Force, int Axis)
	For one Axis, set the Maximimum Motor Force. More...

virtual void	SetAngularMotorRestitution (const Vector3 &Restistutions)
	Set the Bounciness/Restition for rotation on all three Axis. More...

virtual void	SetAngularMotorRestitutionOnAxis (Real Restistution, int Axis)
	For one Axis, set the Restistution/Bounciness/. More...

virtual void	SetAngularMotorTargetVelocity (const Vector3 &Velocities)
	Set the Target velocity of the motor on each anuglar axis. More...

virtual void	SetAngularMotorTargetVelocityOnAxis (Real Velocity, int Axis)
	For one Axis, set the target velocity of the angular motor. More...

virtual void	SetLimit (int Axis, Real Lower, Real Upper)
	Change the upper and lower limit for one axis of translation or rotation limit. More...

virtual void	SetLinearLimitDamping (Real Damping)
	Set the Damping of the linear Limits. More...

virtual void	SetLinearLimitLower (const Vector3 &Limit)
	Set the Upper limits on translation. More...

virtual void	SetLinearLimitRestitution (Real Restitution)
	Set the Restitution of the linear Limits. More...

virtual void	SetLinearLimitSoftness (Real Softness)
	Set the Softness of the linear Limits. More...

virtual void	SetLinearLimitUpper (const Vector3 &Limit)
	Set the lower limits on translation. More...

virtual void	SetLinearMotorEnabled (const Vector3 &Enableds)
	Set whether or not the motor is enabled for all Linear Axis Simultaneously. More...

virtual void	SetLinearMotorEnabledOnAxis (bool Enabled, int Axis)
	For one Axis, set whether or not the motor is enabled. More...

virtual void	SetLinearMotorMaxForce (const Vector3 &Forces)
	Set the Linear Motor Maximum force on all 3 translation axis. More...

virtual void	SetLinearMotorMaxForceOnAxis (Real Force, int Axis)
	For one Axis, set the Maximimum Motor Force. More...

virtual void	SetLinearMotorTargetVelocity (const Vector3 &Velocities)
	Set the Target velocity of the motor on each anuglar axis. More...

virtual void	SetLinearMotorTargetVelocityOnAxis (Real Velocity, int Axis)
	For one Axis, set the target velocity of the Linear motor. More...

virtual void	SetPivotALocation (const Vector3 &Location)
	Set The relative location of the pivot from ActorA's Center of gravity. More...

virtual void	SetPivotARotation (const Quaternion &Rotation)
	Set The relative rotation of ActorA. More...

virtual void	SetPivotATransform (const Transform &TranA)
	Set the Position and Rotation using a Transform. More...

virtual void	SetPivotBLocation (const Vector3 &Location)
	Set The relative location of the pivot from ActorB's Center of gravity. More...

virtual void	SetPivotBRotation (const Quaternion &Rotation)
	Set The relative rotation of ActorB. More...

virtual void	SetPivotBTransform (const Transform &TranB)
	Set the Position and Rotation using a Transform. More...

virtual void	SetUseFrameOffset (bool FrameOffset)
	Set the stored value for UseFrameOffset on this hinge in the physics subsystem(bullet) More...

virtual Constraint::AxisList	ValidAngularAxis () const
	Get A list sorted (low to high) of all axis that operate Angularly (that lock sliding/translation) More...

virtual Constraint::AxisList	ValidLinearAxis () const
	Get a sorted (low to high) list of all axis that operate linearly (that lock sliding/translation) More...

virtual Constraint::ParamList	ValidParamOnAxis (int Axis) const
	Get a sorted (low to high) list of Parameters that are valid on this Axis. More...

Static Public Member Functions
static String	SerializableName ()
	Get the name of the the XML tag this class will leave behind as its instances are serialized. More...

Static Public Member Functions inherited from Mezzanine::Physics::Generic6DofConstraint
static String	SerializableName ()
	Get the name of the the XML tag this class will leave behind as its instances are serialized. More...

Static Public Member Functions inherited from Mezzanine::Physics::DualTransformConstraint
static String	SerializableName ()
	Get the name of the the XML tag this class will leave behind as its instances are serialized. More...

Static Public Member Functions inherited from Mezzanine::Physics::Constraint
static String	SerializableName ()
	Get the name of the the XML tag this class will leave behind as its instances are serialized. More...

Protected Member Functions
	Generic6DofSpringConstraint ()
	Inheritance Constructor. More...

virtual btGeneric6DofSpringConstraint *	Generic6dofSpring () const

Protected Member Functions inherited from Mezzanine::Physics::Generic6DofConstraint
	Generic6DofConstraint ()
	Inheritance Constructor. More...

Additional Inherited Members
Protected Attributes inherited from Mezzanine::Physics::Generic6DofConstraint
btGeneric6DofConstraint *	Generic6dof
	Bullet constraint that this class encapsulates.

Detailed Description

Creates a constraint as configurable as the 6Dof constraint, but has added support for spring motion.

When using functions of this class that require you to specify the index, the springs are arranged like so:

0: Translation X
1: Translation Y
2: Translation Z
3: Rotation X
4: Rotation Y
5: Rotation Z

Definition at line 63 of file generic6dofspringconstraint.h.

Member Enumeration Documentation

enum Mezzanine::Physics::Generic6DofSpringConstraint::UsableAxis

Identify the Axis a bit easier when iterating over them is less convienent than typing an Identifier.

Enumerator
LinearX	Translation on the X axis.
LinearY	Translation on the Y axis.
LinearZ	Translation on the Z axis.
AngularX	Rotation on the X axis.
AngularY	Rotation on the Y axis.
AngularZ	Rotation on the Z axis.

Definition at line 73 of file generic6dofspringconstraint.h.

Constructor & Destructor Documentation

Mezzanine::Physics::Generic6DofSpringConstraint::Generic6DofSpringConstraint ( )

protected

Inheritance Constructor.

This is only called by derived classes, and shouldn't be called manually.

Definition at line 58 of file generic6dofspringconstraint.cpp.

Mezzanine::Physics::Generic6DofSpringConstraint::Generic6DofSpringConstraint	(	RigidProxy *	ProxyA,
		RigidProxy *	ProxyB,
		const Vector3 &	VectorA,
		const Vector3 &	VectorB,
		const Quaternion &	QuaternionA,
		const Quaternion &	QuaternionB,
		bool	UseLinearReferenceA = `false`
	)

Two proxy Verbose constructor.

Parameters

ProxyA	The First proxy to be bound.
ProxyB	The Second proxy to be bound.
VectorA	The offset from ProxyAs center of gravity to get to match an offset from ProxyB.
VectorB	The offset from ProxyBs center of gravity.
QuaternionA	Relative rotation from ProxyA.
QuaternionB	Relative rotation from ProxyB.
UseLinearReferenceA	Perform Linear math from ProxyA's perspective, default to false.

Definition at line 64 of file generic6dofspringconstraint.cpp.

Mezzanine::Physics::Generic6DofSpringConstraint::Generic6DofSpringConstraint	(	RigidProxy *	ProxyA,
		RigidProxy *	ProxyB,
		const Transform &	TransformA,
		const Transform &	TransformB,
		bool	UseLinearReferenceA = `false`
	)

Two proxy Terse constructor.

Parameters

ProxyA	The First proxy to be bound.
ProxyB	The Second proxy to be bound.
TransformA	The offset and rotation from ProxyAs center of gravity to get to match an offset from ProxyB.
TransformB	The offset and rotation from ProxyBs center of gravity.
UseLinearReferenceA	Perform Linear math from ProxyA's perspective, default to false.

Definition at line 73 of file generic6dofspringconstraint.cpp.

Mezzanine::Physics::Generic6DofSpringConstraint::~Generic6DofSpringConstraint ( )

virtual

Class destructor.

The class destructor.

Definition at line 81 of file generic6dofspringconstraint.cpp.

Member Function Documentation

void Mezzanine::Physics::Generic6DofSpringConstraint::CalculateSpringEquilibriumPoint ( )

virtual

Definition at line 156 of file generic6dofspringconstraint.cpp.

void Mezzanine::Physics::Generic6DofSpringConstraint::CalculateSpringEquilibriumPoint ( int Index)

virtual

Definition at line 159 of file generic6dofspringconstraint.cpp.

btGeneric6DofSpringConstraint * Mezzanine::Physics::Generic6DofSpringConstraint::Generic6dofSpring ( ) const

protectedvirtual

Definition at line 61 of file generic6dofspringconstraint.cpp.

Vector3 Mezzanine::Physics::Generic6DofSpringConstraint::GetCurrentSpringAngularEquilibriumPoints ( ) const

virtual

Definition at line 162 of file generic6dofspringconstraint.cpp.

Real Mezzanine::Physics::Generic6DofSpringConstraint::GetCurrentSpringEquilibriumPoint ( int Index) const

virtual

Definition at line 168 of file generic6dofspringconstraint.cpp.

Vector3 Mezzanine::Physics::Generic6DofSpringConstraint::GetCurrentSpringLinearEquilibriumPoints ( ) const

virtual

Definition at line 165 of file generic6dofspringconstraint.cpp.

Vector3 Mezzanine::Physics::Generic6DofSpringConstraint::GetSpringAngularDamping ( ) const

virtual

Get the Damping for all Angular Axis.

Returns: A Vector3 with the Damping on the X, Y and Z Angular Axis.

Definition at line 126 of file generic6dofspringconstraint.cpp.

Vector3 Mezzanine::Physics::Generic6DofSpringConstraint::GetSpringAngularEnabled ( ) const

virtual

Get the Enabled Status for all Angular Axis.

Returns: A Vector3 with the Enabled Status on the X, Y and Z Angular Axis.

Definition at line 129 of file generic6dofspringconstraint.cpp.

Vector3 Mezzanine::Physics::Generic6DofSpringConstraint::GetSpringAngularStiffness ( ) const

virtual

Get the Stiffness for all Angular Axis.

Returns: A Vector3 with the Stiffness on the X, Y and Z Angular Axis.

Definition at line 123 of file generic6dofspringconstraint.cpp.

Real Mezzanine::Physics::Generic6DofSpringConstraint::GetSpringDamping ( int Index) const

virtual

Retrieve the Damping of the spring on the given axis.

Parameters

Index The Desired axis. This accepts 0,1,2 for Linear X,Y, and Z or 3,4,5 for Angular X,Y, and Z. This can also accept Item from this classes Usable Axis enum;

Returns: A real with the requested value.

Definition at line 147 of file generic6dofspringconstraint.cpp.

bool Mezzanine::Physics::Generic6DofSpringConstraint::GetSpringEnabled ( int Index) const

virtual

Retrieve the EnabledStatus of the spring on the given axis.

Parameters

Index The Desired axis. This accepts 0,1,2 for Linear X,Y, and Z or 3,4,5 for Angular X,Y, and Z. This can also accept Item from this classes Usable Axis enum;

Returns: A bool with the requested value.

Definition at line 150 of file generic6dofspringconstraint.cpp.

Vector3 Mezzanine::Physics::Generic6DofSpringConstraint::GetSpringLinearDamping ( ) const

virtual

Get the Damping for all Linear Axis.

Returns: A Vector3 with the Damping on the X, Y and Z Linear Axis.

Definition at line 105 of file generic6dofspringconstraint.cpp.

Vector3 Mezzanine::Physics::Generic6DofSpringConstraint::GetSpringLinearEnabled ( ) const

virtual

Get the Enabled Status for all Linear Axis.

Returns: A Vector3 with the Enabled Status on the X, Y and Z Linear Axis.

Definition at line 108 of file generic6dofspringconstraint.cpp.

Vector3 Mezzanine::Physics::Generic6DofSpringConstraint::GetSpringLinearStiffness ( ) const

virtual

Get the Stiffness for all Linear Axis.

Returns: A Vector3 with the Stiffness on the X, Y and Z Linear Axis.

Definition at line 102 of file generic6dofspringconstraint.cpp.

Real Mezzanine::Physics::Generic6DofSpringConstraint::GetSpringStiffness ( int Index) const

virtual

Retrieve the Stiffness of the spring on the given axis.

Parameters

Index The Desired axis. This accepts 0,1,2 for Linear X,Y, and Z or 3,4,5 for Angular X,Y, and Z. This can also accept Item from this classes Usable Axis enum;

Returns: A real with the requested value;

Definition at line 144 of file generic6dofspringconstraint.cpp.

void Mezzanine::Physics::Generic6DofSpringConstraint::ProtoDeSerialize ( const XML::Node & OneNode)

virtual

Take the data stored in an XML and overwrite this instance of this object with it.

Parameters

OneNode and XML::Node containing the data.

Warning: A precondition of using this is that all of the actors intended for use must already be Deserialized.

Reimplemented from Mezzanine::Physics::Generic6DofConstraint.

Definition at line 219 of file generic6dofspringconstraint.cpp.

void Mezzanine::Physics::Generic6DofSpringConstraint::ProtoSerialize ( XML::Node & CurrentRoot) const

virtual

Convert this class to an XML::Node ready for serialization.

Parameters

CurrentRoot The point in the XML hierarchy that all this vectorw should be appended to.

Reimplemented from Mezzanine::Physics::Generic6DofConstraint.

Definition at line 174 of file generic6dofspringconstraint.cpp.

String Mezzanine::Physics::Generic6DofSpringConstraint::SerializableName ( )

static

Get the name of the the XML tag this class will leave behind as its instances are serialized.

Returns: A string containing "Generic6DofConstraint"

Definition at line 277 of file generic6dofspringconstraint.cpp.

void Mezzanine::Physics::Generic6DofSpringConstraint::SetSpringAngularDamping ( const Vector3 & Damps)

virtual

Set the Damping of the springs on each Angular Axis.

Parameters

Damps A Vector3 containing the X, Y and Z desired damping.

Definition at line 117 of file generic6dofspringconstraint.cpp.

void Mezzanine::Physics::Generic6DofSpringConstraint::SetSpringAngularEnabled ( const Vector3 & Enableness)

virtual

Set the Stiffness of the springs on each Angular Axis.

Parameters

Stiffies A Vector3 containing the X, Y and Z enabled statuses. This is interpretted as 0 for false and any other value for true.

Definition at line 120 of file generic6dofspringconstraint.cpp.

void Mezzanine::Physics::Generic6DofSpringConstraint::SetSpringAngularStiffness ( const Vector3 & Stiffies)

virtual

Set the Stiffness of the springs on each Angular Axis.

Parameters

Stiffies A Vector3 containing the X, Y and Z stiffnesses.

Definition at line 114 of file generic6dofspringconstraint.cpp.

void Mezzanine::Physics::Generic6DofSpringConstraint::SetSpringDamping	(	int	Index,
		Real	Damping
	)

virtual

Set the spring Damping on a given axis.

Parameters

Index	The Desired axis. This accepts 0,1,2 for Linear X,Y, and Z or 3,4,5 for Angular X,Y, and Z. This can also accept Item from this classes Usable Axis enum;
Damping	A real with the new desired Damping.

Definition at line 138 of file generic6dofspringconstraint.cpp.

void Mezzanine::Physics::Generic6DofSpringConstraint::SetSpringEnabled	(	int	Index,
		bool	Enable
	)

virtual

Set the spring's enabled status on a given axis.

Parameters

Index	The Desired axis. This accepts 0,1,2 for Linear X,Y, and Z or 3,4,5 for Angular X,Y, and Z. This can also accept Item from this classes Usable Axis enum;
Enable	A bool with the spring's enabled status.

Definition at line 141 of file generic6dofspringconstraint.cpp.

void Mezzanine::Physics::Generic6DofSpringConstraint::SetSpringLinearDamping ( const Vector3 & Damps)

virtual

Set the Damping of the springs on each Linear Axis.

Parameters

Damps A Vector3 containing the X, Y and Z desired damping.

Definition at line 96 of file generic6dofspringconstraint.cpp.

void Mezzanine::Physics::Generic6DofSpringConstraint::SetSpringLinearEnabled ( const Vector3 & Enableness)

virtual

Set the Stiffness of the springs on each Linear Axis.

Parameters

Stiffies A Vector3 containing the X, Y and Z enabled statuses. This is interpretted as 0 for false and any other value for true.

Definition at line 99 of file generic6dofspringconstraint.cpp.

void Mezzanine::Physics::Generic6DofSpringConstraint::SetSpringLinearStiffness ( const Vector3 & Stiffies)

virtual

Set the Stiffness of the springs on each Linear Axis.

Parameters

Stiffies A Vector3 containing the X, Y and Z stiffnesses.

Definition at line 93 of file generic6dofspringconstraint.cpp.

void Mezzanine::Physics::Generic6DofSpringConstraint::SetSpringStiffness	(	int	Index,
		Real	Stiffness
	)

virtual

Set the spring stiffness on a given axis.

Parameters

Index	The Desired axis. This accepts 0,1,2 for Linear X,Y, and Z or 3,4,5 for Angular X,Y, and Z. This can also accept Item from this classes Usable Axis enum;
Stiffness	A real with the new desired stiffness.

Definition at line 135 of file generic6dofspringconstraint.cpp.

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

/home/sqeaky/Code/Mezzanine/Mezzanine/src/Physics/generic6dofspringconstraint.h
/home/sqeaky/Code/Mezzanine/Mezzanine/src/Physics/generic6dofspringconstraint.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation