Cocos2d-x  v4
PhysicsJointRatchet Class Reference

Works like a socket wrench. More...

Inherits PhysicsJoint.

Public Member Functions

float getAngle () const
 Get the ratchet angle.
 
void setAngle (float angle)
 Set the ratchet angle.
 
float getPhase () const
 Get the initial offset.
 
void setPhase (float phase)
 Set the initial offset.
 
float getRatchet () const
 Get the distance between "clicks".
 
void setRatchet (float ratchet)
 Set the distance between "clicks".
 
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 PhysicsJointRatchetconstruct (PhysicsBody *a, PhysicsBody *b, float phase, float ratchet)
 Create a ratchet joint. More...
 

Detailed Description

Works like a socket wrench.

Member Function Documentation

◆ construct()

static PhysicsJointRatchet* construct ( PhysicsBody a,
PhysicsBody b,
float  phase,
float  ratchet 
)
static

Create a ratchet joint.

Parameters
aA is the body to connect.
bB is the body to connect.
phasePhase is the initial offset to use when deciding where the ratchet angles are.
ratchetRatchet is the distance between "clicks".
Returns
A object pointer.

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