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

Pin joints hold a set distance between points on two bodies. More...

#import <ChipmunkConstraint.h>

Inherits ChipmunkConstraint.

Instance Methods

(id) - initWithBodyA:bodyB:anchorA:anchorB:
 Initialize a pin joint between the two bodies with the given anchor points. 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

(ChipmunkPinJoint *) + pinJointWithBodyA:bodyB:anchorA:anchorB:
 Create an autoreleased pin joint between the two bodies with the given anchor points. More...
 
- Class Methods inherited from ChipmunkConstraint
(ChipmunkConstraint *) + constraintFromCPConstraint:
 Get the ChipmunkConstraint object associciated with a cpConstraint pointer. More...
 

Properties

cpVect anchorA
 The anchor point on the first body.
 
cpVect anchorB
 The anchor point on the second body.
 
cpFloat dist
 The distance between the two anchor points that the joint keeps.
 
- 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

Pin joints hold a set distance between points on two bodies.

Think of them as connecting a solid pin or rod between the two anchor points.

Method Documentation

- (id) initWithBodyA: (ChipmunkBody *)  a
bodyB: (ChipmunkBody *)  b
anchorA: (cpVect anchorA
anchorB: (cpVect anchorB 

Initialize a pin joint between the two bodies with the given anchor points.

The distance is calculated when the joint is initialized. It can be set explicitly using the property.

+ (ChipmunkPinJoint *) pinJointWithBodyA: (ChipmunkBody *)  a
bodyB: (ChipmunkBody *)  b
anchorA: (cpVect anchorA
anchorB: (cpVect anchorB 

Create an autoreleased pin joint between the two bodies with the given anchor points.

The distance is calculated when the joint is initialized. It can be set explicitly using the property.


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