PackageBox2D.Dynamics.Joints
Classpublic class b2PrismaticJoint
Inheritanceb2PrismaticJoint Inheritance b2Joint
Sourceb2PrismaticJoint.as

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.

See also

b2PrismaticJointDef


Public Methods
 MethodDefined by
  
EnableLimit(flag:Boolean):void
Enable/disable the joint limit.
b2PrismaticJoint
  
EnableMotor(flag:Boolean):void
Enable/disable the joint motor.
b2PrismaticJoint
  
Get the anchor point on body1 in world coordinates.
b2PrismaticJoint
  
Get the anchor point on body2 in world coordinates.
b2PrismaticJoint
 Inherited
Get the first body attached to this joint.
b2Joint
 Inherited
Get the second body attached to this joint.
b2Joint
  
GetJointSpeed():Number
Get the current joint translation speed, usually in meters per second.
b2PrismaticJoint
  
Get the current joint translation, usually in meters.
b2PrismaticJoint
  
GetLowerLimit():Number
Get the lower joint limit, usually in meters.
b2PrismaticJoint
  
GetMotorForce():Number
Get the current motor force, usually in N.
b2PrismaticJoint
  
GetMotorSpeed():Number
Get the motor speed, usually in meters per second.
b2PrismaticJoint
 Inherited
Get the next joint the world joint list.
b2Joint
  
GetReactionForce(inv_dt:Number):b2Vec2
Get the reaction force on body2 at the joint anchor.
b2PrismaticJoint
  
GetReactionTorque(inv_dt:Number):Number
Get the reaction torque on body2.
b2PrismaticJoint
 Inherited
GetType():int
Get the type of the concrete joint.
b2Joint
  
GetUpperLimit():Number
Get the upper joint limit, usually in meters.
b2PrismaticJoint
 Inherited
Get the user data pointer.
b2Joint
  
IsLimitEnabled():Boolean
Is the joint limit enabled?
b2PrismaticJoint
  
IsMotorEnabled():Boolean
Is the joint motor enabled?
b2PrismaticJoint
  
SetLimits(lower:Number, upper:Number):void
Set the joint limits, usually in meters.
b2PrismaticJoint
  
SetMaxMotorForce(force:Number):void
Set the maximum motor force, usually in N.
b2PrismaticJoint
  
SetMotorSpeed(speed:Number):void
Set the motor speed, usually in meters per second.
b2PrismaticJoint
 Inherited
SetUserData(data:*):void
Set the user data pointer.
b2Joint
Method detail
EnableLimit()method
public function EnableLimit(flag:Boolean):void

Enable/disable the joint limit.

Parameters
flag:Boolean
EnableMotor()method 
public function EnableMotor(flag:Boolean):void

Enable/disable the joint motor.

Parameters
flag:Boolean
GetAnchor1()method 
public override function GetAnchor1():b2Vec2

Get the anchor point on body1 in world coordinates.

Returns
b2Vec2
GetAnchor2()method 
public override function GetAnchor2():b2Vec2

Get the anchor point on body2 in world coordinates.

Returns
b2Vec2
GetJointSpeed()method 
public function GetJointSpeed():Number

Get the current joint translation speed, usually in meters per second.

Returns
Number
GetJointTranslation()method 
public function GetJointTranslation():Number

Get the current joint translation, usually in meters.

Returns
Number
GetLowerLimit()method 
public function GetLowerLimit():Number

Get the lower joint limit, usually in meters.

Returns
Number
GetMotorForce()method 
public function GetMotorForce():Number

Get the current motor force, usually in N.

Returns
Number
GetMotorSpeed()method 
public function GetMotorSpeed():Number

Get the motor speed, usually in meters per second.

Returns
Number
GetReactionForce()method 
public override function GetReactionForce(inv_dt:Number):b2Vec2

Get the reaction force on body2 at the joint anchor.

Parameters
inv_dt:Number

Returns
b2Vec2
GetReactionTorque()method 
public override function GetReactionTorque(inv_dt:Number):Number

Get the reaction torque on body2.

Parameters
inv_dt:Number

Returns
Number
GetUpperLimit()method 
public function GetUpperLimit():Number

Get the upper joint limit, usually in meters.

Returns
Number
IsLimitEnabled()method 
public function IsLimitEnabled():Boolean

Is the joint limit enabled?

Returns
Boolean
IsMotorEnabled()method 
public function IsMotorEnabled():Boolean

Is the joint motor enabled?

Returns
Boolean
SetLimits()method 
public function SetLimits(lower:Number, upper:Number):void

Set the joint limits, usually in meters.

Parameters
lower:Number
 
upper:Number
SetMaxMotorForce()method 
public function SetMaxMotorForce(force:Number):void

Set the maximum motor force, usually in N.

Parameters
force:Number
SetMotorSpeed()method 
public function SetMotorSpeed(speed:Number):void

Set the motor speed, usually in meters per second.

Parameters
speed:Number