Cocos2d-x  v4
PhysicsJointLimit Class Reference

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.
 
void setAnchr1 (const Vec2 &anchr1)
 Set the anchor point on body a.
 
Vec2 getAnchr2 () const
 Get the anchor point on body b.
 
void setAnchr2 (const Vec2 &anchr2)
 Set the anchor point on body b.
 
float getMin () const
 Get the allowed min distance of the anchor points.
 
void setMin (float min)
 Set the min distance of the anchor points.
 
float getMax () const
 Get the allowed max distance of the anchor points.
 
void setMax (float max)
 Set the max distance of the anchor points.
 
virtual bool createConstraints () override
 Create constraints for this type joint.
 
- Public Member Functions inherited from PhysicsJoint
PhysicsBodygetBodyA () const
 Get physics body a connected to this joint.
 
PhysicsBodygetBodyB () const
 Get physics body b connected to this joint.
 
PhysicsWorldgetWorld () const
 Get the physics world.
 
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.
 
void setEnable (bool enable)
 Enable/Disable the joint.
 
bool isCollisionEnabled () const
 Determines if the collision is enable.
 
void setCollisionEnable (bool enable)
 Enable/disable the collision between two bodies.
 
void removeFormWorld ()
 Remove the joint from the world.
 
void setMaxForce (float force)
 Set the max force between two bodies.
 
float getMaxForce () const
 Get the max force setting.
 

Static Public Member Functions

static PhysicsJointLimitconstruct (PhysicsBody *a, PhysicsBody *b, const Vec2 &anchr1, const Vec2 &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...
 

Detailed Description

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

Member Function Documentation

◆ construct() [1/2]

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.

◆ construct() [2/2]

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.

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