MOMENTUM_NAMESPACE::SecondaryJoint Class Reference

#include <SecondaryJoint.h>

Public Member Functions
double	getDamping () const
double	getElasticity () const
bool	getEnabled () const
void	setDamping (double damping)
void	setElasticity (double elasticity)
void	setEnabled (bool enabled)

Detailed Description

A Base class for a joint which operates on the free DOF specifies by ordinary joints such as HingeJoint, PrismaticJoint, CylindricalJoint etc.

Member Function Documentation

getDamping()

double MOMENTUM_NAMESPACE::SecondaryJoint::getDamping

(

)

const

Get the damping of the secondary constraint, depending if it is linear or rotational it is in different units, newton-seconds per meter for linear and newton-meter-seconds per radian if it is rotational.

Returns

the current damping of the secondary constraint

getElasticity()

double MOMENTUM_NAMESPACE::SecondaryJoint::getElasticity

(

)

const

Get the elasticity of the secondary constraint, depending if it is linear or rotational it is in different units, newton per meter for linear and newton per radian if it is rotational.

Returns

the current elasticity of the secondary constraint

getEnabled()

bool MOMENTUM_NAMESPACE::SecondaryJoint::getEnabled

(

)

const

Get if the secondary constraint is enabled on its parent joint.

Returns

true if the constraint is enabled for simulation

setDamping()

void MOMENTUM_NAMESPACE::SecondaryJoint::setDamping

(

double

damping

)

Set the damping of the secondary constraint, depending if it is linear or rotational it is in different units, newton-seconds per meter for linear and newton-meter-seconds per radian if it is rotational.

Parameters

damping

the new damping of the secondary constraint

Only available in simulation mode

setElasticity()

void MOMENTUM_NAMESPACE::SecondaryJoint::setElasticity

(

double

elasticity

)

Set the elasticity of the secondary constraint, depending if it is linear or rotational it is in different units, newton-seconds per meter for linear and newton-meter-seconds per radian if it is rotational.

Parameters

elasticity

the new elasticity of the secondary constraint

Only available in simulation mode

setEnabled()

void MOMENTUM_NAMESPACE::SecondaryJoint::setEnabled

(

bool

enabled

)

Set if the secondary constraint is enabled on its parent joint.

Parameters

enabled

- the new enable state for the constraint

Only available in simulation mode