Cocos2d-x  v3.10
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups
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.
 
var createConstraints ()
 Create constraints for this type joint.
 
local createConstraints ()
 Create constraints for this type joint.
 
- Public Member Functions inherited from PhysicsJoint
PhysicsBodygetBodyA () const
 Get the first physics body a connected to this joint.
 
local getBodyA ()
 Get the first physics body a connected to this joint.
 
PhysicsBodygetBodyB () const
 Get the second physics body b connected to this joint.
 
PhysicsWorldgetWorld () const
 Get the physics world.
 
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...
 
bool isEnabled () const
 Determines if the joint is enable.
 
void setEnable (bool enable)
 Enable or disable the joint.
 
bool isCollisionEnabled () const
 Determines if the collsion is enable.
 
void setCollisionEnable (bool enable)
 Enable or disable collision.
 
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...
 
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.

A is the body to connect. B is the body to connect. Phase is the initial offset to use when deciding where the ratchet angles are. Ratchet is the distance between "clicks". A object pointer.

var construct ( var  a,
var  b,
var  phase,
var  ratchet 
)
static

Create a ratchet joint.

A is the body to connect. B is the body to connect. Phase is the initial offset to use when deciding where the ratchet angles are. Ratchet is the distance between "clicks". A object pointer.

local construct ( local  a,
local  b,
local  phase,
local  ratchet 
)
static

Create a ratchet joint.

A is the body to connect. B is the body to connect. Phase is the initial offset to use when deciding where the ratchet angles are. Ratchet is the distance between "clicks". A object pointer.


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