PxConstraint Class Reference
[Physics]
a plugin class for implementing constraints
More...
#include <PxConstraint.h>
![Inheritance graph](classPxConstraint__inherit__graph.png)
![Collaboration graph](classPxConstraint__coll__graph.png)
Public Member Functions | |
virtual void | release ()=0 |
virtual PxScene * | getScene () const =0 |
Retrieves the scene which this constraint belongs to. | |
virtual void | getActors (PxRigidActor *&actor0, PxRigidActor *&actor1) const =0 |
Retrieves the actors for this constraint. | |
virtual void | setActors (PxRigidActor *actor0, PxRigidActor *actor1)=0 |
Sets the actors for this constraint. | |
virtual void | markDirty ()=0 |
Notify the scene that the constraint shader data has been updated by the application. | |
virtual void | setFlags (PxConstraintFlags flags)=0 |
Set the flags for this constraint. | |
virtual PxConstraintFlags | getFlags () const =0 |
Retrieve the flags for this constraint. | |
virtual void | getForce (PxVec3 &linear, PxVec3 &angular) const =0 |
Retrieve the constraint force most recently applied to maintain this constraint. | |
virtual void | setBreakForce (PxReal linear, PxReal angular)=0 |
Set the break force and torque thresholds for this constraint. | |
virtual void | getBreakForce (PxReal &linear, PxReal &angular) const =0 |
Retrieve the constraint break force and torque thresholds. | |
virtual void * | getExternalReference (PxU32 &typeID)=0 |
Fetch external owner of the constraint. | |
virtual void | setConstraintFunctions (PxConstraintConnector &connector, const PxConstraintShaderTable &shaders)=0 |
Set the constraint functions for this constraint. | |
virtual const char * | getConcreteTypeName () const |
returns string name of dynamic type. | |
Protected Member Functions | |
PxConstraint () | |
PxConstraint (PxRefResolver &v) | |
virtual | ~PxConstraint () |
virtual bool | isKindOf (const char *name) const |
Detailed Description
a plugin class for implementing constraints
- See also:
- PxConstraint
Constructor & Destructor Documentation
PxConstraint::PxConstraint | ( | ) | [inline, protected] |
PxConstraint::PxConstraint | ( | PxRefResolver & | v | ) | [inline, protected] |
virtual PxConstraint::~PxConstraint | ( | ) | [inline, protected, virtual] |
Member Function Documentation
virtual void PxConstraint::getActors | ( | PxRigidActor *& | actor0, | |
PxRigidActor *& | actor1 | |||
) | const [pure virtual] |
Retrieves the actors for this constraint.
- Parameters:
-
[out] actor0 a reference to the pointer for the first actor [out] actor1 a reference to the pointer for the second actor
- See also:
- PxActor
Retrieve the constraint break force and torque thresholds.
- Parameters:
-
[out] linear the linear break threshold [out] angular the angular break threshold
virtual const char* PxConstraint::getConcreteTypeName | ( | ) | const [inline, virtual] |
returns string name of dynamic type.
- Returns:
- class name of most derived type of this object.
Reimplemented from PxSerializable.
virtual void* PxConstraint::getExternalReference | ( | PxU32 & | typeID | ) | [pure virtual] |
Fetch external owner of the constraint.
Provides a reference to the external owner of a constraint and a unique owner type ID.
- Parameters:
-
[out] typeID Unique type identifier of the external object.
- Returns:
- Reference to the external object which owns the constraint.
virtual PxConstraintFlags PxConstraint::getFlags | ( | ) | const [pure virtual] |
Retrieve the constraint force most recently applied to maintain this constraint.
- Parameters:
-
[out] linear the constraint force [out] angular the constraint torque
virtual PxScene* PxConstraint::getScene | ( | ) | const [pure virtual] |
Retrieves the scene which this constraint belongs to.
- Returns:
- Owner Scene. NULL if not part of a scene.
- See also:
- PxScene
virtual bool PxConstraint::isKindOf | ( | const char * | name | ) | const [inline, protected, virtual] |
virtual void PxConstraint::markDirty | ( | ) | [pure virtual] |
Notify the scene that the constraint shader data has been updated by the application.
virtual void PxConstraint::release | ( | ) | [pure virtual] |
virtual void PxConstraint::setActors | ( | PxRigidActor * | actor0, | |
PxRigidActor * | actor1 | |||
) | [pure virtual] |
Sets the actors for this constraint.
- Parameters:
-
[in] actor0 a reference to the pointer for the first actor [in] actor1 a reference to the pointer for the second actor
- See also:
- PxActor
Set the break force and torque thresholds for this constraint.
If either the force or torque measured at the constraint exceed these thresholds the constraint will break.
- Parameters:
-
[in] linear the linear break threshold [in] angular the angular break threshold
virtual void PxConstraint::setConstraintFunctions | ( | PxConstraintConnector & | connector, | |
const PxConstraintShaderTable & | shaders | |||
) | [pure virtual] |
Set the constraint functions for this constraint.
- Parameters:
-
[in] connector the constraint connector object by which the SDK communicates with the constraint. [in] shaders the shader table for the constraint
virtual void PxConstraint::setFlags | ( | PxConstraintFlags | flags | ) | [pure virtual] |
Set the flags for this constraint.
- Parameters:
-
[in] flags the new constraint flags
- See also:
- PxConstraintFlags
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