PhysicsJoint Class Reference

An PhysicsJoint object connects two physics bodies together. More...

Inheritance diagram for PhysicsJoint:

Public Member Functions
PhysicsBody *	getBodyA () const
	Get physics body a connected to this joint. More...
PhysicsBody *	getBodyB () const
	Get physics body b connected to this joint. More...
PhysicsWorld *	getWorld () const
	Get the physics world. More...
int	getTag () const
	Get this joint's tag. More...
void	setTag (int tag)
	Set this joint's tag. More...
bool	isEnabled () const
	Determines if the joint is enable. More...
void	setEnable (bool enable)
	Enable/Disable the joint. More...
bool	isCollisionEnabled () const
	Determines if the collision is enable. More...
void	setCollisionEnable (bool enable)
	Enable/disable the collision between two bodies. More...
void	removeFormWorld ()
	Remove the joint from the world. More...
void	setMaxForce (float force)
	Set the max force between two bodies. More...
float	getMaxForce () const
	Get the max force setting. More...

Detailed Description

An PhysicsJoint object connects two physics bodies together.

Member Function Documentation

getBodyA()

PhysicsBody* getBodyA ( ) const

inline

Get physics body a connected to this joint.

getBodyB()

PhysicsBody* getBodyB ( ) const

inline

Get physics body b connected to this joint.

getWorld()

PhysicsWorld* getWorld ( ) const

inline

Get the physics world.

getTag()

int getTag ( ) const

inline

Get this joint's tag.

Returns

An integer number.

setTag()

void setTag ( int  tag )

inline

Set this joint's tag.

Parameters

tag	An integer number that identifies a PhysicsJoint.

isEnabled()

bool isEnabled ( ) const

inline

Determines if the joint is enable.

setEnable()

void setEnable

(

bool

enable

)

Enable/Disable the joint.

isCollisionEnabled()

bool isCollisionEnabled ( ) const

inline

Determines if the collision is enable.

setCollisionEnable()

void setCollisionEnable

(

bool

enable

)

Enable/disable the collision between two bodies.

removeFormWorld()

void removeFormWorld

(

)

Remove the joint from the world.

setMaxForce()

void setMaxForce

(

float

force

)

Set the max force between two bodies.

getMaxForce()

float getMaxForce ( ) const

inline

Get the max force setting.

---

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

• CCPhysicsJoint.h