MathEngine
Home Page       Structures       File List       Functions and Macros      

MdtHinge.h File Reference

MdtHinge API functions. More...

#include "MePrecision.h"
#include "MdtTypes.h"

Functions

MdtHingeID MdtHingeCreate (const MdtWorldID w, const MdtBodyID b1, const MdtBodyID b2)
 Creates a new hinge with default parameters. More...

void MdtHingeReset (const MdtHingeID j)
 Sets a hinge to its default values. More...

void MdtHingeDestroy (const MdtHingeID j)
 Destroys a hinge. More...

void MdtHingeLog (const MdtHingeID j)
 Debug function - output constraint using MeMessage. More...

MdtConstraintID MdtHingeQuaConstraint (const MdtHingeID j)
 Gets an MdtConstraintID from a specific constraint for performing functions common to all constraints. More...

void MdtHingeGetPosition (const MdtHingeID j, MeVector3 v)
 The Hinge joint's position vector is returned in v. More...

void MdtHingeGetAxis (const MdtHingeID j, MeVector3 v)
 The Hinge joint's axis is returned in v. More...

MdtLimitID MdtHingeGetLimit (const MdtHingeID j)
 Provides read/write access to the constraint limit. More...

void MdtHingeSetPosition (const MdtHingeID j, const MeReal x, const MeReal y, const MeReal z)
 Sets the joint position in world coordinates. More...

void MdtHingeSetAxis (const MdtHingeID j, const MeReal x, const MeReal y, const MeReal z)
 Sets the Hinge axis. More...

void MdtHingeSetLimit (const MdtHingeID j, const MdtLimitID NewLimit)
 Resets the joint limit and then copies the public attributes of NewLimit. More...


Detailed Description

MdtHinge API functions.


Define Documentation

#define MdtHingeDisable( j )

Initializer:

\
                            MdtConstraintDisable(MdtHingeQuaConstraint(j))

#define MdtHingeEnable( j )

Initializer:

\
                            MdtConstraintEnable(MdtHingeQuaConstraint(j))

#define MdtHingeGetBody( j, bodyindex )

Initializer:

\
                            MdtConstraintGetBody(MdtHingeQuaConstraint(j), bodyindex)

#define MdtHingeGetForce( j, bodyindex, f )

Initializer:

\
                            MdtConstraintGetForce(MdtHingeQuaConstraint(j), bodyindex, f)

#define MdtHingeGetTorque( j, bodyindex, t )

Initializer:

\
                            MdtConstraintGetTorque(MdtHingeQuaConstraint(j), bodyindex, t)

#define MdtHingeGetUserData( j )

Initializer:

\
                            MdtConstraintGetUserData(MdtHingeQuaConstraint(j))

#define MdtHingeGetWorld( j )

Initializer:

\
                            MdtConstraintGetWorld(MdtHingeQuaConstraint(j))

#define MdtHingeIsEnabled( j )

Initializer:

\
                            MdtConstraintIsEnabled(MdtHingeQuaConstraint(j))

#define MdtHingeSetBodies( j, b1, b2 )

Initializer:

\
                            MdtConstraintSetBodies(MdtHingeQuaConstraint(j), b1, b2)

#define MdtHingeSetUserData( j, d )

Initializer:

\
                            MdtConstraintSetUserData(MdtHingeQuaConstraint(j), d)

Function Documentation

MdtHingeID MdtHingeCreate ( MdtWorldID w,
MdtBodyID b1,
MdtBodyID b2 )

Creates a new hinge with default parameters.

See also:
MdtHingeReset()

void MdtHingeDestroy ( MdtHingeID j )

Destroys a hinge.

void MdtHingeGetAxis ( MdtHingeID j,
MeVector3 v )

The Hinge joint's axis is returned in v.

MdtLimitID MdtHingeGetLimit ( MdtHingeID j )

Provides read/write access to the constraint limit.

void MdtHingeGetPosition ( MdtHingeID j,
MeVector3 v )

The Hinge joint's position vector is returned in v.

void MdtHingeLog ( MdtHingeID j )

Debug function - output constraint using MeMessage.

MdtConstraintID MdtHingeQuaConstraint ( MdtHingeID j )

Gets an MdtConstraintID from a specific constraint for performing functions common to all constraints.

void MdtHingeReset ( MdtHingeID j )

Sets a hinge to its default values.

Note that the joint's bodies are not reset.

Default values:

Parameters:
j   hinge joint ID

void MdtHingeSetAxis ( MdtHingeID j,
MeReal x,
MeReal y,
MeReal z )

Sets the Hinge axis.

void MdtHingeSetLimit ( MdtHingeID j,
MdtLimitID NewLimit )

Resets the joint limit and then copies the public attributes of NewLimit.

void MdtHingeSetPosition ( MdtHingeID j,
MeReal x,
MeReal y,
MeReal z )

Sets the joint position in world coordinates.


MathEngine Dynamics Toolkit - Version 0.0.5 Alpha - Reference Manual generated using doxygen at Wed Oct 11 00:34:48 2000

Copyright MathEngine PLC 2000, all rights reserved.