Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
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. More...
 
var getPhase ()
 Get the angular offset of the two bodies. More...
 
local getPhase ()
 Get the angular offset of the two bodies. More...
 
void setPhase (float phase)
 Set the angular offset of the two bodies. More...
 
var setPhase ( var phase)
 Set the angular offset of the two bodies. More...
 
local setPhase ( local phase)
 Set the angular offset of the two bodies. More...
 
float getRatio () const
 Get the ratio. More...
 
void setRatio (float ratchet)
 Set the ratio. More...
 
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. More...
 
PhysicsBodygetBodyB () const
 Get physics body b connected to this joint. More...
 
local getBodyB ()
 Get physics body b connected to this joint. More...
 
PhysicsWorldgetWorld () 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 PhysicsJointGearconstruct (PhysicsBody *a, PhysicsBody *b, float phase, float ratio)
 Create a gear joint. More...
 
var construct ( var a, var b, var phase, var ratio)
 Create a gear joint. More...
 
local construct ( local a, local b, local phase, local ratio)
 Create a gear joint. More...
 

Detailed Description

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

Member Function Documentation

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.
var construct ( var  a,
var  b,
var  phase,
var  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.
local construct ( local  a,
local  b,
local  phase,
local  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.
float getPhase ( ) const

Get the angular offset of the two bodies.

var getPhase ( )

Get the angular offset of the two bodies.

local getPhase ( )

Get the angular offset of the two bodies.

void setPhase ( float  phase)

Set the angular offset of the two bodies.

var setPhase ( var  phase)

Set the angular offset of the two bodies.

local setPhase ( local  phase)

Set the angular offset of the two bodies.

float getRatio ( ) const

Get the ratio.

var getRatio ( )

Get the ratio.

local getRatio ( )

Get the ratio.

void setRatio ( float  ratchet)

Set the ratio.

var setRatio ( var  ratchet)

Set the ratio.

local setRatio ( local  ratchet)

Set the ratio.


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