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
ChipmunkRotaryLimitJoint Class Reference

Constrains the angle between two bodies. More...

#import <ChipmunkConstraint.h>

Inherits ChipmunkConstraint.

Instance Methods

(id) - initWithBodyA:bodyB:min:max:
 Create an autoreleased rotary limit joint between the two bodies and angular range in radians. 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

(ChipmunkRotaryLimitJoint *) + rotaryLimitJointWithBodyA:bodyB:min:max:
 Create an autoreleased rotary limit joint between the two bodies and angular range in radians. More...
 
- Class Methods inherited from ChipmunkConstraint
(ChipmunkConstraint *) + constraintFromCPConstraint:
 Get the ChipmunkConstraint object associciated with a cpConstraint pointer. More...
 

Properties

cpFloat min
 The minimum angular delta of the joint in radians.
 
cpFloat max
 The maximum angular delta of the joint in radians.
 
- 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

Constrains the angle between two bodies.

This joint is often used in conjuction with a separate ChipmunkPivotJoint in order to limit the rotation around the pivot.

Method Documentation

- (id) initWithBodyA: (ChipmunkBody *)  a
bodyB: (ChipmunkBody *)  b
min: (cpFloat min
max: (cpFloat max 

Create an autoreleased rotary limit joint between the two bodies and angular range in radians.

Make sure you have the bodies in the right place as the joint will snap into shape as soon as you start simulating the space.

+ (ChipmunkRotaryLimitJoint *) rotaryLimitJointWithBodyA: (ChipmunkBody *)  a
bodyB: (ChipmunkBody *)  b
min: (cpFloat min
max: (cpFloat max 

Create an autoreleased rotary limit joint between the two bodies and angular range in radians.

Make sure you have the bodies in the right place as the joint will snap into shape as soon as you start simulating the space.


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