Cocos2d-x  v4
PhysicsJointGear Class Reference

Keeps the angular velocity ratio of a pair of bodies constant. More...

Inherits PhysicsJoint.

Public Member Functions

float getPhase () const
 Get the angular offset of the two bodies.
 
void setPhase (float phase)
 Set the angular offset of the two bodies.
 
float getRatio () const
 Get the ratio.
 
void setRatio (float ratchet)
 Set the ratio.
 
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 PhysicsJointGearconstruct (PhysicsBody *a, PhysicsBody *b, float phase, float ratio)
 Create a gear joint. More...
 

Detailed Description

Keeps the angular velocity ratio of a pair of bodies constant.

Member Function Documentation

◆ construct()

static PhysicsJointGear* construct ( PhysicsBody a,
PhysicsBody b,
float  phase,
float  ratio 
)
static

Create a gear joint.

Parameters
aA is the body to connect.
bB is the body to connect.
phasePhase is the initial angular offset of the two bodies.
ratioRatio is always measured in absolute terms.
Returns
A object pointer.

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