PxJoint Class Reference
[Extensions]
a base interface providing common functionality for PhysX joints
More...
#include <PxJoint.h>
![Inheritance graph](classPxJoint__inherit__graph.png)
![Collaboration graph](classPxJoint__coll__graph.png)
Public Member Functions | |
virtual void | setActors (PxRigidActor *actor0, PxRigidActor *actor1)=0 |
Set the actors for this joint. | |
virtual void | getActors (PxRigidActor *&actor0, PxRigidActor *&actor1) const =0 |
Get the actors for this joint. | |
virtual void | setLocalPose (PxJointActorIndex::Enum actor, const PxTransform &localPose)=0 |
Set the joint local pose for an actor. | |
virtual PxTransform | getLocalPose (PxJointActorIndex::Enum actor) const =0 |
get the joint local pose for an actor. | |
virtual void | setBreakForce (PxReal force, PxReal torque)=0 |
set the break force for this joint. | |
virtual void | getBreakForce (PxReal &force, PxReal &torque) const =0 |
get the break force for this joint. | |
virtual void | setConstraintFlags (PxConstraintFlags flags)=0 |
set the constraint flags for this joint. | |
virtual void | setConstraintFlag (PxConstraintFlag::Type flag, bool value)=0 |
set a constraint flags for this joint to a specified value. | |
virtual PxConstraintFlags | getConstraintFlags () const =0 |
get the constraint flags for this joint. | |
virtual PxConstraint * | getConstraint () const =0 |
Retrieves the PxConstraint corresponding to this joint. | |
virtual void | setName (const char *name)=0 |
Sets a name string for the object that can be retrieved with getName(). | |
virtual const char * | getName () const =0 |
Retrieves the name string set with setName(). | |
virtual void | release ()=0 |
Deletes the joint. | |
virtual PxScene * | getScene () const =0 |
Retrieves the scene which this joint belongs to. | |
virtual PxJointType::Enum | getType () const =0 |
Retrieves the type of this joint. | |
PxJoint (PxRefResolver &v) | |
Static Public Member Functions | |
static void | getMetaData (PxSerialStream &stream) |
Public Attributes | |
void * | userData |
user can assign this to whatever, usually to create a 1:1 relationship with a user object. | |
Protected Member Functions | |
virtual | ~PxJoint () |
PxJoint () | |
virtual bool | isKindOf (const char *name) const |
Detailed Description
a base interface providing common functionality for PhysX jointsConstructor & Destructor Documentation
PxJoint::PxJoint | ( | PxRefResolver & | v | ) | [inline] |
virtual PxJoint::~PxJoint | ( | ) | [inline, protected, virtual] |
PxJoint::PxJoint | ( | ) | [inline, protected] |
Member Function Documentation
virtual void PxJoint::getActors | ( | PxRigidActor *& | actor0, | |
PxRigidActor *& | actor1 | |||
) | const [pure virtual] |
Get the actors for this joint.
- Parameters:
-
[out] actor0 the first actor. [out] actor1 the second actor
- See also:
- setActors()
get the break force for this joint.
- Parameters:
-
[out] force the maximum force the joint can apply before breaking [out] torque the maximum torque the joint can apply before breaking
- See also:
- setBreakForce()
virtual PxConstraint* PxJoint::getConstraint | ( | ) | const [pure virtual] |
Retrieves the PxConstraint corresponding to this joint.
This can be used to determine, among other things, the force applied at the joint.
- Returns:
- the constraint
virtual PxConstraintFlags PxJoint::getConstraintFlags | ( | ) | const [pure virtual] |
virtual PxTransform PxJoint::getLocalPose | ( | PxJointActorIndex::Enum | actor | ) | const [pure virtual] |
get the joint local pose for an actor.
- Parameters:
-
[in] actor 0 for the first actor, 1 for the second actor.
- See also:
- setLocalPose()
static void PxJoint::getMetaData | ( | PxSerialStream & | stream | ) | [static] |
Reimplemented from PxSerializable.
virtual const char* PxJoint::getName | ( | ) | const [pure virtual] |
virtual PxScene* PxJoint::getScene | ( | ) | const [pure virtual] |
Retrieves the scene which this joint belongs to.
- Returns:
- Owner Scene. NULL if not part of a scene.
- See also:
- PxScene
virtual PxJointType::Enum PxJoint::getType | ( | ) | const [pure virtual] |
Retrieves the type of this joint.
- Returns:
- the joint type
- See also:
- PxJointType
Referenced by physx::repx::getBasePtr(), and physx::repx::getExtensionNameForType().
virtual bool PxJoint::isKindOf | ( | const char * | name | ) | const [inline, protected, virtual] |
Reimplemented from PxSerializable.
Reimplemented in PxD6Joint, PxDistanceJoint, PxFixedJoint, PxPrismaticJoint, PxRevoluteJoint, and PxSphericalJoint.
References PxSerializable::isKindOf().
Referenced by PxSphericalJoint::isKindOf(), PxRevoluteJoint::isKindOf(), PxPrismaticJoint::isKindOf(), PxFixedJoint::isKindOf(), PxDistanceJoint::isKindOf(), and PxD6Joint::isKindOf().
virtual void PxJoint::release | ( | ) | [pure virtual] |
Deletes the joint.
virtual void PxJoint::setActors | ( | PxRigidActor * | actor0, | |
PxRigidActor * | actor1 | |||
) | [pure virtual] |
Set the actors for this joint.
An actor may be NULL to indicate the world frame. At most one of the actors may be NULL.
- Parameters:
-
[in] actor0 the first actor. [in] actor1 the second actor
- See also:
- getActors()
set the break force for this joint.
if the constraint force or torque on the joint exceeds the specified values, the joint will break, at which point it will not constrain the two actors and the flag PxConstraintFlag::eBROKEN will be set. The force and torque are measured in the joint frame of the first actor
- Parameters:
-
[in] force the maximum force the joint can apply before breaking [in] torque the maximum torque the joint can apply before breaking
- See also:
- getBreakForce() PxConstraintFlag::eBREAKABLE
virtual void PxJoint::setConstraintFlag | ( | PxConstraintFlag::Type | flag, | |
bool | value | |||
) | [pure virtual] |
set a constraint flags for this joint to a specified value.
- Parameters:
-
[in] flag the constraint flag [in] value the value to which to set the flag
- See also:
- PxConstraintFlag
virtual void PxJoint::setConstraintFlags | ( | PxConstraintFlags | flags | ) | [pure virtual] |
set the constraint flags for this joint.
- Parameters:
-
[in] flags the constraint flags
- See also:
- PxConstraintFlag
virtual void PxJoint::setLocalPose | ( | PxJointActorIndex::Enum | actor, | |
const PxTransform & | localPose | |||
) | [pure virtual] |
Set the joint local pose for an actor.
This is the relative pose which locates the joint frame relative to the actor.
- Parameters:
-
[in] actor 0 for the first actor, 1 for the second actor. [in] localPose the local pose for the actor this joint
- See also:
- getLocalPose()
virtual void PxJoint::setName | ( | const char * | name | ) | [pure virtual] |
Member Data Documentation
void* PxJoint::userData |
user can assign this to whatever, usually to create a 1:1 relationship with a user object.
The documentation for this class was generated from the following file:
Copyright © 2008-2012 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com