Package pybox2d :: Module Box2D :: Class b2PrismaticJoint |
[hide private]
[frames] | no frames]

# type b2PrismaticJoint

source code

A prismatic joint. This joint provides one degree of freedom: translation along an axis fixed in body1. Relative rotation is prevented. You can use a joint limit to restrict the range of motion and a joint motor to drive the motion or to model joint friction.

Instance Methods | [hide private]
__init__(self, *args) __init__(self, b2PrismaticJointDef _def) -> b2PrismaticJoint | source code
__repr__(self) | source code
__getstate__(self, world=None) Get the state of a joint. | source code
__setstate__(self, data) The factory output cannot be created just yet, so store the necessary information to create it later. | source code
_pickle_finalize(data, world) Finalize a joint. | source code
__swig_destroy__(...) delete_b2PrismaticJoint(b2PrismaticJoint self) |
GetJointTranslation(...) b2PrismaticJoint_GetJointTranslation(b2PrismaticJoint self) -> float32 | source code
GetJointSpeed(...) b2PrismaticJoint_GetJointSpeed(b2PrismaticJoint self) -> float32 | source code
IsLimitEnabled(...) b2PrismaticJoint_IsLimitEnabled(b2PrismaticJoint self) -> bool | source code
EnableLimit(...) b2PrismaticJoint_EnableLimit(b2PrismaticJoint self, bool flag) | source code
GetLowerLimit(...) b2PrismaticJoint_GetLowerLimit(b2PrismaticJoint self) -> float32 | source code
GetUpperLimit(...) b2PrismaticJoint_GetUpperLimit(b2PrismaticJoint self) -> float32 | source code
SetLimits(...) b2PrismaticJoint_SetLimits(b2PrismaticJoint self, float32 lower, float32 upper) | source code
IsMotorEnabled(...) b2PrismaticJoint_IsMotorEnabled(b2PrismaticJoint self) -> bool | source code
EnableMotor(...) b2PrismaticJoint_EnableMotor(b2PrismaticJoint self, bool flag) | source code
SetMotorSpeed(...) b2PrismaticJoint_SetMotorSpeed(b2PrismaticJoint self, float32 speed) | source code
GetMotorSpeed(...) b2PrismaticJoint_GetMotorSpeed(b2PrismaticJoint self) -> float32 | source code
SetMaxMotorForce(...) b2PrismaticJoint_SetMaxMotorForce(b2PrismaticJoint self, float32 force) | source code
GetMotorForce(...) b2PrismaticJoint_GetMotorForce(b2PrismaticJoint self) -> float32 | source code
InitVelocityConstraints(...) b2PrismaticJoint_InitVelocityConstraints(b2PrismaticJoint self, b2TimeStep step) | source code
SolveVelocityConstraints(...) b2PrismaticJoint_SolveVelocityConstraints(b2PrismaticJoint self, b2TimeStep step) | source code
SolvePositionConstraints(...) b2PrismaticJoint_SolvePositionConstraints(b2PrismaticJoint self, float32 baumgarte) -> bool | source code
Inherited from b2Joint
ClearUserData(...) b2Joint_ClearUserData(b2Joint self) | source code
GetAnchor1(...) b2Joint_GetAnchor1(b2Joint self) -> b2Vec2 | source code
GetAnchor2(...) b2Joint_GetAnchor2(b2Joint self) -> b2Vec2 | source code
GetBody1(...) b2Joint_GetBody1(b2Joint self) -> b2Body | source code
GetBody2(...) b2Joint_GetBody2(b2Joint self) -> b2Body | source code
GetCollideConnected(...) b2Joint_GetCollideConnected(b2Joint self) -> bool | source code
GetNext(...) b2Joint_GetNext(b2Joint self) -> b2Joint | source code
GetReactionForce(...) b2Joint_GetReactionForce(b2Joint self, float32 inv_dt) -> b2Vec2 | source code
GetReactionTorque(...) b2Joint_GetReactionTorque(b2Joint self, float32 inv_dt) -> float32 | source code
GetType(...) b2Joint_GetType(b2Joint self) -> b2JointType | source code
GetUserData(...) b2Joint_GetUserData(b2Joint self) -> PyObject | source code
SetUserData(...) b2Joint_SetUserData(b2Joint self, PyObject data) | source code
__eq__(a, b) | source code
__hash__(...) b2Joint___hash__(b2Joint self) -> int32 | source code
__ne__(self, other) | source code
asDistanceJoint(...) b2Joint_asDistanceJoint(b2Joint self) -> b2DistanceJoint | source code
asGearJoint(...) b2Joint_asGearJoint(b2Joint self) -> b2GearJoint | source code
asLineJoint(...) b2Joint_asLineJoint(b2Joint self) -> b2LineJoint | source code
asMouseJoint(...) b2Joint_asMouseJoint(b2Joint self) -> b2MouseJoint | source code
asPrismaticJoint(...) b2Joint_asPrismaticJoint(b2Joint self) -> b2PrismaticJoint | source code
asPulleyJoint(...) b2Joint_asPulleyJoint(b2Joint self) -> b2PulleyJoint | source code
asRevoluteJoint(...) b2Joint_asRevoluteJoint(b2Joint self) -> b2RevoluteJoint | source code
getAsType(self) Return a typecasted version of the joint | source code
typeName(self) Return the name of the joint from:... | source code

Properties | [hide private]
| thisown The membership flag
| localAnchor1 b2PrismaticJoint_localAnchor1_get(b2PrismaticJoint self) -> b2Vec2
| localAnchor2 b2PrismaticJoint_localAnchor2_get(b2PrismaticJoint self) -> b2Vec2
| localXAxis1 b2PrismaticJoint_localXAxis1_get(b2PrismaticJoint self) -> b2Vec2
| localYAxis1 b2PrismaticJoint_localYAxis1_get(b2PrismaticJoint self) -> b2Vec2
| referenceAngle b2PrismaticJoint_referenceAngle_get(b2PrismaticJoint self) -> float32
| axis b2PrismaticJoint_axis_get(b2PrismaticJoint self) -> b2Vec2
| perp b2PrismaticJoint_perp_get(b2PrismaticJoint self) -> b2Vec2
| s1 b2PrismaticJoint_s1_get(b2PrismaticJoint self) -> float32
| s2 b2PrismaticJoint_s2_get(b2PrismaticJoint self) -> float32
| a1 b2PrismaticJoint_a1_get(b2PrismaticJoint self) -> float32
| a2 b2PrismaticJoint_a2_get(b2PrismaticJoint self) -> float32
| K b2PrismaticJoint_K_get(b2PrismaticJoint self) -> b2Mat33
| impulse b2PrismaticJoint_impulse_get(b2PrismaticJoint self) -> b2Vec3
| motorMass b2PrismaticJoint_motorMass_get(b2PrismaticJoint self) -> float32
| motorImpulse b2PrismaticJoint_motorImpulse_get(b2PrismaticJoint self) -> float32
| lowerTranslation b2PrismaticJoint_lowerTranslation_get(b2PrismaticJoint self) -> float32
| upperTranslation b2PrismaticJoint_upperTranslation_get(b2PrismaticJoint self) -> float32
| maxMotorForce b2PrismaticJoint_maxMotorForce_get(b2PrismaticJoint self) -> float32
| motorSpeed b2PrismaticJoint_motorSpeed_get(b2PrismaticJoint self) -> float32
| enableLimit b2PrismaticJoint_enableLimit_get(b2PrismaticJoint self) -> bool
| enableMotor b2PrismaticJoint_enableMotor_get(b2PrismaticJoint self) -> bool
| limitState b2PrismaticJoint_limitState_get(b2PrismaticJoint self) -> b2LimitState
Inherited from b2Joint
| body1 GetBody1(self) -> b2Body
| body2 GetBody2(self) -> b2Body
| collideConnected GetCollideConnected(self) -> bool
| type GetType(self) -> b2JointType
| userData GetUserData(self) -> PyObject

Method Details | [hide private]

### __init__(self, *args) (Constructor) | source code
__init__(self, b2PrismaticJointDef _def) -> b2PrismaticJoint A prismatic joint. This joint provides one degree of freedom: translation along an axis fixed in body1. Relative rotation is prevented. You can use a joint limit to restrict the range of motion and a joint motor to drive the motion or to model joint friction. Overrides: b2Joint.__init__

### __repr__(self) (Representation operator) | source code
Overrides: b2Joint.__repr__

### __getstate__(self, world=None) | source code
Get the state of a joint. Overrides: no_pickle

### __setstate__(self, data) | source code
The factory output cannot be created just yet, so store the necessary information to create it later. Overrides: _generic_setstate

### _pickle_finalize(data, world) | source code
Finalize a joint. The bodies and joints need to be retrieved from the world list in order to make the joint.

### GetJointTranslation(...) | source code
b2PrismaticJoint_GetJointTranslation(b2PrismaticJoint self) -> float32 Get the current joint translation, usually in meters.

### GetJointSpeed(...) | source code
b2PrismaticJoint_GetJointSpeed(b2PrismaticJoint self) -> float32 Get the current joint translation speed, usually in meters per second.

### IsLimitEnabled(...) | source code
b2PrismaticJoint_IsLimitEnabled(b2PrismaticJoint self) -> bool Is the joint limit enabled?

### EnableLimit(...) | source code
b2PrismaticJoint_EnableLimit(b2PrismaticJoint self, bool flag) Enable/disable the joint limit.

### GetLowerLimit(...) | source code
b2PrismaticJoint_GetLowerLimit(b2PrismaticJoint self) -> float32 Get the lower joint limit, usually in meters.

### GetUpperLimit(...) | source code
b2PrismaticJoint_GetUpperLimit(b2PrismaticJoint self) -> float32 Get the upper joint limit, usually in meters.

### SetLimits(...) | source code
b2PrismaticJoint_SetLimits(b2PrismaticJoint self, float32 lower, float32 upper) Set the joint limits, usually in meters.

### IsMotorEnabled(...) | source code
b2PrismaticJoint_IsMotorEnabled(b2PrismaticJoint self) -> bool Is the joint motor enabled?

### EnableMotor(...) | source code
b2PrismaticJoint_EnableMotor(b2PrismaticJoint self, bool flag) Enable/disable the joint motor.

### SetMotorSpeed(...) | source code
b2PrismaticJoint_SetMotorSpeed(b2PrismaticJoint self, float32 speed) Set the motor speed, usually in meters per second.

### GetMotorSpeed(...) | source code
b2PrismaticJoint_GetMotorSpeed(b2PrismaticJoint self) -> float32 Get the motor speed, usually in meters per second.

### SetMaxMotorForce(...) | source code
b2PrismaticJoint_SetMaxMotorForce(b2PrismaticJoint self, float32 force) Set the maximum motor force, usually in N.

### GetMotorForce(...) | source code
b2PrismaticJoint_GetMotorForce(b2PrismaticJoint self) -> float32 Get the current motor force, usually in N.

Property Details | [hide private]

### thisown The membership flag

### localAnchor1 b2PrismaticJoint_localAnchor1_get(b2PrismaticJoint self) -> b2Vec2

### localAnchor2 b2PrismaticJoint_localAnchor2_get(b2PrismaticJoint self) -> b2Vec2

### localXAxis1 b2PrismaticJoint_localXAxis1_get(b2PrismaticJoint self) -> b2Vec2

### localYAxis1 b2PrismaticJoint_localYAxis1_get(b2PrismaticJoint self) -> b2Vec2

### referenceAngle b2PrismaticJoint_referenceAngle_get(b2PrismaticJoint self) -> float32

### axis b2PrismaticJoint_axis_get(b2PrismaticJoint self) -> b2Vec2

### perp b2PrismaticJoint_perp_get(b2PrismaticJoint self) -> b2Vec2

### s1 b2PrismaticJoint_s1_get(b2PrismaticJoint self) -> float32

### s2 b2PrismaticJoint_s2_get(b2PrismaticJoint self) -> float32

### a1 b2PrismaticJoint_a1_get(b2PrismaticJoint self) -> float32

### a2 b2PrismaticJoint_a2_get(b2PrismaticJoint self) -> float32

### K b2PrismaticJoint_K_get(b2PrismaticJoint self) -> b2Mat33

### impulse b2PrismaticJoint_impulse_get(b2PrismaticJoint self) -> b2Vec3

### motorMass b2PrismaticJoint_motorMass_get(b2PrismaticJoint self) -> float32

### motorImpulse b2PrismaticJoint_motorImpulse_get(b2PrismaticJoint self) -> float32

### lowerTranslation b2PrismaticJoint_lowerTranslation_get(b2PrismaticJoint self) -> float32

### upperTranslation b2PrismaticJoint_upperTranslation_get(b2PrismaticJoint self) -> float32

### maxMotorForce b2PrismaticJoint_maxMotorForce_get(b2PrismaticJoint self) -> float32

### motorSpeed b2PrismaticJoint_motorSpeed_get(b2PrismaticJoint self) -> float32

### enableLimit b2PrismaticJoint_enableLimit_get(b2PrismaticJoint self) -> bool

### enableMotor b2PrismaticJoint_enableMotor_get(b2PrismaticJoint self) -> bool

### limitState b2PrismaticJoint_limitState_get(b2PrismaticJoint self) -> b2LimitState