cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
PhysicsJointGear Class Reference

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

#include <CCPhysicsJoint.h>

Inheritance diagram for PhysicsJointGear:
PhysicsJoint

Public Member Functions

float getPhase () const
 Get the angular offset of the two bodies. More...
 
void setPhase (float 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. More...
 
var createConstraints ()
 Create constraints for this type joint. More...
 
local createConstraints ()
 Create constraints for this type joint. More...
 
- Public Member Functions inherited from PhysicsJoint
PhysicsBodygetBodyA () const
 Get physics body a connected to this joint. More...
 
local getBodyA ()
 Get physics body a connected to this joint. More...
 
PhysicsBodygetBodyB () const
 Get physics body b connected to this joint. More...
 
PhysicsWorldgetWorld () const
 Get the physics world. More...
 
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. More...
 
void setEnable (bool enable)
 Enable/Disable the joint. More...
 
bool isCollisionEnabled () const
 Determines if the collsion is enable. More...
 
void setCollisionEnable (bool enable)
 Enable/disable the collision between two bodies. More...
 
void removeFormWorld ()
 Remove the joint from the world. More...
 
void setMaxForce (float 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...
 
local construct ( local a, local b, local phase, local ratio)
 Create a gear joint. More...
 

Protected Member Functions

 PhysicsJointGear ()
virtual ~PhysicsJointGear ()
- Protected Member Functions inherited from PhysicsJoint
 PhysicsJoint ()
virtual ~PhysicsJoint ()=0
bool init (PhysicsBody *a, PhysicsBody *b)
bool initJoint ()

Protected Attributes

float _phase
float _ratio
- Protected Attributes inherited from PhysicsJoint
std::vector< cpConstraint * > _cpConstraints
var _cpConstraints
local _cpConstraints
PhysicsBody_bodyA
PhysicsBody_bodyB
PhysicsWorld_world
bool _enable
bool _collisionEnable
bool _destoryMark
int _tag
float _maxForce
bool _initDirty

Detailed Description

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

Constructor & Destructor Documentation

PhysicsJointGear ( )
inlineprotected
var PhysicsJointGear ( )
inlineprotected
local PhysicsJointGear ( )
inlineprotected
virtual ~PhysicsJointGear ( )
inlineprotectedvirtual
var ~PhysicsJointGear ( )
inlineprotectedvirtual
local ~PhysicsJointGear ( )
inlineprotectedvirtual

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.
virtual bool createConstraints ( )
overridevirtual

Create constraints for this type joint.

Reimplemented from PhysicsJoint.

var createConstraints ( )
overridevirtual

Create constraints for this type joint.

Reimplemented from PhysicsJoint.

local createConstraints ( )
overridevirtual

Create constraints for this type joint.

Reimplemented from PhysicsJoint.

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.

float getRatio ( ) const

Get the ratio.

var getRatio ( )

Get the ratio.

local getRatio ( )

Get the ratio.

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.

void setRatio ( float  ratchet)

Set the ratio.

var setRatio ( var  ratchet)

Set the ratio.

local setRatio ( local  ratchet)

Set the ratio.

Member Data Documentation

float _phase
protected
var _phase
protected
local _phase
protected
float _ratio
protected
var _ratio
protected
local _ratio
protected

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