cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
PhysicsJointLimit Class Reference

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

#include <CCPhysicsJoint.h>

Inheritance diagram for PhysicsJointLimit:
PhysicsJoint

Public Member Functions

Vec2 getAnchr1 () const
 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...
 
void setAnchr2 (const Vec2 &anchr2)
 Set the anchor point on body b. More...
 
float getMin () const
 Get the allowed min distance of the anchor points. More...
 
void setMin (float min)
 Set the min distance of the anchor points. More...
 
float getMax () const
 Get the allowed max distance of the anchor points. More...
 
void setMax (float max)
 Set the max distance of the anchor points. More...
 
virtual bool createConstraints () override
 Create constraints for this type joint. More...
 
- Public Member Functions inherited from PhysicsJoint
PhysicsBodygetBodyA () const
 Get physics body a connected to this joint. More...
 
local getBodyA ()
 Get physics body a connected to this joint. More...
 
PhysicsBodygetBodyB () const
 Get physics body b connected to this joint. More...
 
PhysicsWorldgetWorld () 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 collsion 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...
 

Static Public Member Functions

static PhysicsJointLimitconstruct (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 PhysicsJointLimitconstruct (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...
 

Protected Member Functions

 PhysicsJointLimit ()
virtual ~PhysicsJointLimit ()
- Protected Member Functions inherited from PhysicsJoint
 PhysicsJoint ()
virtual ~PhysicsJoint ()=0
bool init (PhysicsBody *a, PhysicsBody *b)
bool initJoint ()

Protected Attributes

Vec2 _anchr1
Vec2 _anchr2
float _min
float _max
- Protected Attributes inherited from PhysicsJoint
std::vector< cpConstraint * > _cpConstraints
var _cpConstraints
local _cpConstraints
PhysicsBody_bodyA
PhysicsBody_bodyB
PhysicsWorld_world
bool _enable
bool _collisionEnable
bool _destoryMark
int _tag
float _maxForce
bool _initDirty

Detailed Description

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

Constructor & Destructor Documentation

PhysicsJointLimit ( )
inlineprotected
var PhysicsJointLimit ( )
inlineprotected
local PhysicsJointLimit ( )
inlineprotected
virtual ~PhysicsJointLimit ( )
inlineprotectedvirtual
var ~PhysicsJointLimit ( )
inlineprotectedvirtual
local ~PhysicsJointLimit ( )
inlineprotectedvirtual

Member Function Documentation

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

Create a limit joint.

Parameters
aA is the body to connect.
bB is the body to connect.
anchr1Anchr1 is the anchor point on body a.
anchr2Anchr2 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
aA is the body to connect.
bB is the body to connect.
anchr1Anchr1 is the anchor point on body a.
anchr2Anchr2 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
aA is the body to connect.
bB is the body to connect.
anchr1Anchr1 is the anchor point on body a.
anchr2Anchr2 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
aA is the body to connect.
bB is the body to connect.
anchr1Anchr1 is the anchor point on body a.
anchr2Anchr2 is the anchor point on body b.
minDefine the allowed min distance of the anchor points.
maxDefine 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
aA is the body to connect.
bB is the body to connect.
anchr1Anchr1 is the anchor point on body a.
anchr2Anchr2 is the anchor point on body b.
minDefine the allowed min distance of the anchor points.
maxDefine 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
aA is the body to connect.
bB is the body to connect.
anchr1Anchr1 is the anchor point on body a.
anchr2Anchr2 is the anchor point on body b.
minDefine the allowed min distance of the anchor points.
maxDefine the allowed max distance of the anchor points.
Returns
A object pointer.
virtual bool createConstraints ( )
overridevirtual

Create constraints for this type joint.

Reimplemented from PhysicsJoint.

var createConstraints ( )
overridevirtual

Create constraints for this type joint.

Reimplemented from PhysicsJoint.

local createConstraints ( )
overridevirtual

Create constraints for this type joint.

Reimplemented from PhysicsJoint.

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.

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.

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.

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 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.

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.

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.

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.

Member Data Documentation

Vec2 _anchr1
protected
var _anchr1
protected
Vec2 _anchr2
protected
var _anchr2
protected
local _anchr2
protected
float _max
protected
var _max
protected
local _max
protected
float _min
protected
var _min
protected
local _min
protected

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