Project

General

Profile

SO3Engine
OgreNewt::KinematicController Class Reference

Kinematic controller joint. More...

#include <OgreNewt_BasicJoints.h>

Inheritance diagram for OgreNewt::KinematicController:
OgreNewt::Joint

Public Member Functions

 KinematicController (const OgreNewt::Body *child, const Ogre::Vector3 &pos)
 constructor
 
 ~KinematicController ()
 destructor.
 
void setPickingMode (int mode)
 enable limits.
 
void setMaxLinearFriction (Ogre::Real accel)
 set the linear acceleration the joint can take before the joint is violated .
 
void setMaxAngularFriction (Ogre::Real alpha)
 set the angular acceleration the joint can take before the joint is violated .
 
void setTargetPosit (const Ogre::Vector3 &position)
 set the position part of the attachment matrix
 
void setTargetRotation (const Ogre::Quaternion &rotation)
 set the orientation part of the attachment matrix
 
void setTargetMatrix (const Ogre::Vector3 &position, const Ogre::Quaternion &rotation)
 set the position and orientation part of the attachment matrix
 
void getTargetMatrix (Ogre::Vector3 &position, Ogre::Quaternion &rotation) const
 set the position and orientation part of the attachment matrix
 
- Public Member Functions inherited from OgreNewt::Joint
 Joint ()
 constructor
 
virtual ~Joint ()
 destructor
 
BodygetBody0 () const
 get the pointer to the first rigid body
 
BodygetBody1 () const
 get the pointer to the first rigid body
 
const OgreNewt::WorldgetWorld ()
 get the pointer to the world
 
virtual void submitConstraint (Ogre::Real timeStep, int threadIndex)
 must be define for a functioning joint.
 
virtual void showDebugData (Ogre::SceneNode *debugRootNode)
 show joint visual debugging data
 
int getCollisionState () const
 returns collision state
 
void setCollisionState (int state) const
 sets the collision state
 
Ogre::Real getStiffness () const
 get joint stiffness
 
void setStiffness (Ogre::Real stiffness) const
 set joint stiffness
 

Additional Inherited Members

- Protected Member Functions inherited from OgreNewt::Joint
void addLinearRow (const Ogre::Vector3 &pt0, const Ogre::Vector3 &pt1, const Ogre::Vector3 &dir) const
 
void addAngularRow (Ogre::Radian relativeAngleError, const Ogre::Vector3 &dir) const
 
void addGeneralRow (const Ogre::Vector3 &linear0, const Ogre::Vector3 &angular0, const Ogre::Vector3 &linear1, const Ogre::Vector3 &angular1) const
 
void setRowMinimumFriction (Ogre::Real friction) const
 
void setRowMaximumFriction (Ogre::Real friction) const
 
void setRowStiffness (Ogre::Real stiffness) const
 
void setRowAcceleration (Ogre::Real accel) const
 
void setRowSpringDamper (Ogre::Real springK, Ogre::Real springD) const
 
void SetSupportJoint (CustomJoint *supportJoint)
 SetSupportJoint.
 
CustomJoint * GetSupportJoint () const
 GetSupportJoint.
 
- Static Protected Member Functions inherited from OgreNewt::Joint
static void _CDECL destructorCallback (const CustomJoint *me)
 joint destructor callback glue
 
static void _CDECL submitConstraintCallback (const CustomJoint *me, dFloat timestep, int threadIndex)
 submintContraint
 
- Protected Attributes inherited from OgreNewt::Joint
CustomJoint * m_joint
 

Detailed Description

Kinematic controller joint.

simple Kinematic controller. used it to make a simple object follow a path or a position.

Definition at line 579 of file OgreNewt_BasicJoints.h.

Constructor & Destructor Documentation

◆ KinematicController()

OgreNewt::KinematicController::KinematicController ( const OgreNewt::Body child,
const Ogre::Vector3 &  pos 
)

constructor

Parameters
childpointer to the controlled rigid body.
attachmentpoint in global space

Definition at line 781 of file OgreNewt_BasicJoints.cpp.

◆ ~KinematicController()

OgreNewt::KinematicController::~KinematicController ( )

destructor.

Definition at line 793 of file OgreNewt_BasicJoints.cpp.

Member Function Documentation

◆ getTargetMatrix()

void OgreNewt::KinematicController::getTargetMatrix ( Ogre::Vector3 &  position,
Ogre::Quaternion &  rotation 
) const

set the position and orientation part of the attachment matrix

Parameters
positionnew destination position in global space
rotationnew destination position in global space

Definition at line 841 of file OgreNewt_BasicJoints.cpp.

◆ setMaxAngularFriction()

void OgreNewt::KinematicController::setMaxAngularFriction ( Ogre::Real  alpha)

set the angular acceleration the joint can take before the joint is violated .

Parameters
alphamaximum acceleration at the attachment point

Definition at line 809 of file OgreNewt_BasicJoints.cpp.

◆ setMaxLinearFriction()

void OgreNewt::KinematicController::setMaxLinearFriction ( Ogre::Real  accel)

set the linear acceleration the joint can take before the joint is violated .

Parameters
accelmaximum acceleration at the attachment point

Definition at line 803 of file OgreNewt_BasicJoints.cpp.

◆ setPickingMode()

void OgreNewt::KinematicController::setPickingMode ( int  mode)

enable limits.

Parameters
mode1 at like control by position and rotation, 0 control rotation only

Definition at line 797 of file OgreNewt_BasicJoints.cpp.

◆ setTargetMatrix()

void OgreNewt::KinematicController::setTargetMatrix ( const Ogre::Vector3 &  position,
const Ogre::Quaternion &  rotation 
)

set the position and orientation part of the attachment matrix

Parameters
positionnew destination position in global space
rotationnew destination position in global space

Definition at line 832 of file OgreNewt_BasicJoints.cpp.

◆ setTargetPosit()

void OgreNewt::KinematicController::setTargetPosit ( const Ogre::Vector3 &  position)

set the position part of the attachment matrix

Parameters
positionnew destination position in global space

Definition at line 816 of file OgreNewt_BasicJoints.cpp.

◆ setTargetRotation()

void OgreNewt::KinematicController::setTargetRotation ( const Ogre::Quaternion &  rotation)

set the orientation part of the attachment matrix

Parameters
rotationnew destination position in global space

Definition at line 823 of file OgreNewt_BasicJoints.cpp.


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