A limit joint imposes a maximum distance between the two bodies, as if they were connected by a rope. More...

Inherits PhysicsJoint.

Public Member Functions
Vec2	getAnchr1 () const
	Get the anchor point on body a. More...

var	getAnchr1 ()
	Get the anchor point on body a. More...

local	getAnchr1 ()
	Get the anchor point on body a. More...

void	setAnchr1 (const Vec2 &anchr1)
	Set the anchor point on body a. More...

Vec2	getAnchr2 () const
	Get the anchor point on body b. More...

local	getAnchr2 ()
	Get the anchor point on body b. More...

void	setAnchr2 (const Vec2 &anchr2)
	Set the anchor point on body b. More...

local	setAnchr2 ( local anchr2)
	Set the anchor point on body b. More...

float	getMin () const
	Get the allowed min distance of the anchor points. More...

local	getMin ()
	Get the allowed min distance of the anchor points. More...

void	setMin (float min)
	Set the min distance of the anchor points. More...

local	setMin ( local min)
	Set the min distance of the anchor points. More...

float	getMax () const
	Get the allowed max distance of the anchor points. More...

local	getMax ()
	Get the allowed max distance of the anchor points. More...

void	setMax (float max)
	Set the max distance of the anchor points. More...

local	setMax ( local max)
	Set the max distance of the anchor points. More...

virtual bool	createConstraints () override
	Create constraints for this type joint.

local	createConstraints ()
	Create constraints for this type joint.

Public Member Functions inherited from PhysicsJoint
PhysicsBody *	getBodyA () const
	Get physics body a connected to this joint. More...

PhysicsBody *	getBodyB () const
	Get physics body b connected to this joint. More...

local	getBodyB ()
	Get physics body b connected to this joint. More...

PhysicsWorld *	getWorld () const
	Get the physics world. More...

local	getWorld ()
	Get the physics world. More...

int	getTag () const
	Get this joint's tag. More...

local	getTag ()
	Get this joint's tag. More...

void	setTag (int tag)
	Set this joint's tag. More...

var	setTag ( var tag)
	Set this joint's tag. More...

local	setTag ( local tag)
	Set this joint's tag. More...

bool	isEnabled () const
	Determines if the joint is enable. More...

local	isEnabled ()
	Determines if the joint is enable. More...

void	setEnable (bool enable)
	Enable/Disable the joint. More...

local	setEnable ( local enable)
	Enable/Disable the joint. More...

bool	isCollisionEnabled () const
	Determines if the collision is enable. More...

local	isCollisionEnabled ()
	Determines if the collision is enable. More...

void	setCollisionEnable (bool enable)
	Enable/disable the collision between two bodies. More...

local	setCollisionEnable ( local enable)
	Enable/disable the collision between two bodies. More...

void	removeFormWorld ()
	Remove the joint from the world. More...

local	removeFormWorld ()
	Remove the joint from the world. More...

void	setMaxForce (float force)
	Set the max force between two bodies. More...

local	setMaxForce ( local force)
	Set the max force between two bodies. More...

float	getMaxForce () const
	Get the max force setting. More...

Static Public Member Functions
static PhysicsJointLimit *	construct (PhysicsBody a, PhysicsBody b, const Vec2 &anchr1, const Vec2 &anchr2)
	Create a limit joint. More...

local	construct ( local a, local b, local anchr1, local anchr2)
	Create a limit joint. More...

static PhysicsJointLimit *	construct (PhysicsBody a, PhysicsBody b, const Vec2 &anchr1, const Vec2 &anchr2, float min, float max)
	Create a limit joint. More...

local	construct ( local a, local b, local anchr1, local anchr2, local min, local max)
	Create a limit joint. More...

Detailed Description

A limit joint imposes a maximum distance between the two bodies, as if they were connected by a rope.

Member Function Documentation

static PhysicsJointLimit* construct	(	PhysicsBody *	a,
		PhysicsBody *	b,
		const Vec2 &	anchr1,
		const Vec2 &	anchr2
	)

static

Create a limit joint.

Parameters

a	A is the body to connect.
b	B is the body to connect.
anchr1	Anchr1 is the anchor point on body a.
anchr2	Anchr2 is the anchor point on body b.

Returns: A object pointer.

var construct	(	var	a,
		var	b,
		var	anchr1,
		var	anchr2
	)

static

Create a limit joint.

Parameters

a	A is the body to connect.
b	B is the body to connect.
anchr1	Anchr1 is the anchor point on body a.
anchr2	Anchr2 is the anchor point on body b.

Returns: A object pointer.

local construct	(	local	a,
		local	b,
		local	anchr1,
		local	anchr2
	)

static

Create a limit joint.

Parameters

a	A is the body to connect.
b	B is the body to connect.
anchr1	Anchr1 is the anchor point on body a.
anchr2	Anchr2 is the anchor point on body b.

Returns: A object pointer.

static PhysicsJointLimit* construct	(	PhysicsBody *	a,
		PhysicsBody *	b,
		const Vec2 &	anchr1,
		const Vec2 &	anchr2,
		float	min,
		float	max
	)

static

Create a limit joint.

Parameters

a	A is the body to connect.
b	B is the body to connect.
anchr1	Anchr1 is the anchor point on body a.
anchr2	Anchr2 is the anchor point on body b.
min	Define the allowed min distance of the anchor points.
max	Define the allowed max distance of the anchor points.

Returns: A object pointer.

var construct	(	var	a,
		var	b,
		var	anchr1,
		var	anchr2,
		var	min,
		var	max
	)

static

Create a limit joint.

Parameters

a	A is the body to connect.
b	B is the body to connect.
anchr1	Anchr1 is the anchor point on body a.
anchr2	Anchr2 is the anchor point on body b.
min	Define the allowed min distance of the anchor points.
max	Define the allowed max distance of the anchor points.

Returns: A object pointer.

local construct	(	local	a,
		local	b,
		local	anchr1,
		local	anchr2,
		local	min,
		local	max
	)

static

Create a limit joint.

Parameters

a	A is the body to connect.
b	B is the body to connect.
anchr1	Anchr1 is the anchor point on body a.
anchr2	Anchr2 is the anchor point on body b.
min	Define the allowed min distance of the anchor points.
max	Define the allowed max distance of the anchor points.

Returns: A object pointer.

Vec2 getAnchr1 ( ) const

Get the anchor point on body a.

var getAnchr1 ( )

Get the anchor point on body a.

local getAnchr1 ( )

Get the anchor point on body a.

void setAnchr1 ( const Vec2 & anchr1 )

Set the anchor point on body a.

var setAnchr1 ( var anchr1 )

Set the anchor point on body a.

local setAnchr1 ( local anchr1 )

Set the anchor point on body a.

Vec2 getAnchr2 ( ) const

Get the anchor point on body b.

var getAnchr2 ( )

Get the anchor point on body b.

local getAnchr2 ( )

Get the anchor point on body b.

void setAnchr2 ( const Vec2 & anchr2 )

Set the anchor point on body b.

var setAnchr2 ( var anchr2 )

Set the anchor point on body b.

local setAnchr2 ( local anchr2 )

Set the anchor point on body b.

float getMin ( ) const

Get the allowed min distance of the anchor points.

var getMin ( )

Get the allowed min distance of the anchor points.

local getMin ( )

Get the allowed min distance of the anchor points.

void setMin ( float min )

Set the min distance of the anchor points.

var setMin ( var min )

Set the min distance of the anchor points.

local setMin ( local min )

Set the min distance of the anchor points.

float getMax ( ) const

Get the allowed max distance of the anchor points.

var getMax ( )

Get the allowed max distance of the anchor points.

local getMax ( )

Get the allowed max distance of the anchor points.

void setMax ( float max )

Set the max distance of the anchor points.

var setMax ( var max )

Set the max distance of the anchor points.

local setMax ( local max )

Set the max distance of the anchor points.

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

CCPhysicsJoint.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation