Jeffrey T. Palmer > Box2D > Box2D::b2DistanceJoint

Download:
Box2D-0.07.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

Box2D::b2DistanceJoint - Constrains two bodies at a fixed distance.

SYNOPSIS ^

  my $joint = $world->CreateJoint( $joint_def );
  my $anchor_a = $joint->GetAnchorA();
  my $anchor_b = $joint->GetAnchorB();

DESCRIPTION ^

A distance joint constrains two points on two bodies to remain at a fixed distance from each other. You can view this as a massless, rigid rod.

METHODS ^

GetAnchorA()

Get the anchor point on bodyA in world coordinates. Implements Box2D::b2Joint.

Returns a Box2D::b2Vec2

GetAnchorB()

Get the anchor point on bodyB in world coordinates. Implements Box2D::b2Joint.

Returns a Box2D::b2Vec2

GetDampingRatio()

Returns a float32

GetFrequency()

Returns a float32

GetLength()

Returns a float32

GetReactionForce( $inv_dt )

Get the reaction force on body2 at the joint anchor in Newtons. Implements Box2D::b2Joint.

Parameters:

Returns a Box2D::b2Vec2

GetReactionTorque( $inv_dt )

Get the reaction torque on body2 in N*m. Implements Box2D::b2Joint.

Parameters:

Returns a float32

SetDampingRatio( $ratio )

Parameters:

SetFrequency( $hz )

Parameters:

SetLength( $length )

Set/get the natural length. Manipulating the length can lead to non-physical behavior when the frequency is zero.

Parameters:

SEE ALSO ^

BUGS ^

See "BUGS" in Box2D

AUTHORS ^

See "AUTHORS" in Box2D

COPYRIGHT & LICENSE ^

See "COPYRIGHT & LICENSE" in Box2D

syntax highlighting: