Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
PhysicsJointRatchet Class Reference

Works like a socket wrench. More...

Inherits PhysicsJoint.

Public Member Functions

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

Detailed Description

Works like a socket wrench.

Member Function Documentation

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

Get the ratchet angle.

var getAngle ( )

Get the ratchet angle.

local getAngle ( )

Get the ratchet angle.

void setAngle ( float  angle)

Set the ratchet angle.

var setAngle ( var  angle)

Set the ratchet angle.

local setAngle ( local  angle)

Set the ratchet angle.

float getPhase ( ) const

Get the initial offset.

var getPhase ( )

Get the initial offset.

local getPhase ( )

Get the initial offset.

void setPhase ( float  phase)

Set the initial offset.

var setPhase ( var  phase)

Set the initial offset.

local setPhase ( local  phase)

Set the initial offset.

float getRatchet ( ) const

Get the distance between "clicks".

var getRatchet ( )

Get the distance between "clicks".

local getRatchet ( )

Get the distance between "clicks".

void setRatchet ( float  ratchet)

Set the distance between "clicks".

var setRatchet ( var  ratchet)

Set the distance between "clicks".

local setRatchet ( local  ratchet)

Set the distance between "clicks".


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