Chipmunk2D Pro API Reference  7.0.1
 All Classes Functions Variables Typedefs Enumerations Enumerator Properties Groups Pages
Instance Methods | Class Methods | Properties | List of all members
ChipmunkRatchetJoint Class Reference

Ratchet joints create rotary ratches similar to a socket wrench. More...

#import <ChipmunkConstraint.h>

Inherits ChipmunkConstraint.

Instance Methods

(id) - initWithBodyA:bodyB:phase:ratchet:
 Initialize a ratchet joint between the given bodies. More...
 
- Instance Methods inherited from ChipmunkConstraint
(void) - preSolve:
 Override this method to update a constraints parameters just before running the physics each step.
 
(void) - postSolve:
 Override this method to poll values from a constraint each frame after the physics runs. More...
 

Class Methods

(ChipmunkRatchetJoint *) + ratchetJointWithBodyA:bodyB:phase:ratchet:
 Create an autoreleased ratchet joint between the given bodies. More...
 
- Class Methods inherited from ChipmunkConstraint
(ChipmunkConstraint *) + constraintFromCPConstraint:
 Get the ChipmunkConstraint object associciated with a cpConstraint pointer. More...
 

Properties

cpFloat angle
 The current ratchet position in radians.
 
cpFloat phase
 The angular offset of the ratchet positions in radians.
 
cpFloat ratchet
 The angle in radians of each ratchet position. Negative values cause the ratchet to operate in the opposite direction.
 
- Properties inherited from ChipmunkConstraint
cpConstraintconstraint
 Returns a pointer to the underlying cpConstraint C struct.
 
ChipmunkBodybodyA
 The first ChipmunkBody the constraint controls.
 
ChipmunkBodybodyB
 The second ChipmunkBody the constraint controls.
 
cpFloat maxForce
 Maximum force this constraint is allowed to use (defalts to infinity). More...
 
cpFloat errorBias
 The rate at which joint error is corrected. More...
 
cpFloat maxBias
 Maximum rate (speed) that a joint can be corrected at (defaults to infinity). More...
 
BOOL collideBodies
 Whether or not the connected bodies should checked for collisions. More...
 
cpFloat impulse
 Get the most recent impulse applied by this constraint.
 
ChipmunkSpacespace
 Get the space the body is added to.
 
id userData
 An object that this constraint is associated with. More...
 

Detailed Description

Ratchet joints create rotary ratches similar to a socket wrench.

Method Documentation

- (id) initWithBodyA: (ChipmunkBody *)  a
bodyB: (ChipmunkBody *)  b
phase: (cpFloat phase
ratchet: (cpFloat ratchet 

Initialize a ratchet joint between the given bodies.

Parameters
phaseThe angular offset of the ratchet positions in radians.
ratchetThe angle in radians of each ratchet position. Negative values cause the ratchet to operate in the opposite direction.
+ (ChipmunkRatchetJoint *) ratchetJointWithBodyA: (ChipmunkBody *)  a
bodyB: (ChipmunkBody *)  b
phase: (cpFloat phase
ratchet: (cpFloat ratchet 

Create an autoreleased ratchet joint between the given bodies.

Parameters
phaseThe angular offset of the ratchet positions in radians.
ratchetThe angle in radians of each ratchet position. Negative values cause the ratchet to operate in the opposite direction.

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