Skip to content

Commit

Permalink
Updated b2RevoluteJoint docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jtpalmer committed Oct 6, 2011
1 parent 723b709 commit 06efee1
Showing 1 changed file with 24 additions and 56 deletions.
80 changes: 24 additions & 56 deletions lib/pods/Box2D/b2RevoluteJoint.pod
@@ -1,30 +1,27 @@

=head1 NAME

Box2D::b2RevoluteJoint - TODO
Box2D::b2RevoluteJoint - Constrains two bodies to share a common point.

=head1 SYNOPSIS

# TODO
my $joint = $world->CreateJoint( $joint_def );
$joint->EnableMotor( 1 );
$joint->SetMaxMotorTorque( $torque );
$joint->SetMotorSpeed( $speed );

=head1 DESCRIPTION


A revolute joint constrains two bodies to share a common point while
they are free to rotate about the point. The relative rotation about
the shared point is the joint angle. You can limit the relative
rotation with a joint limit that specifies a lower and upper angle. You
can use a motor to drive the relative rotation about the shared point.
A maximum motor torque is provided so that infinite forces are not
generated.

=head1 METHODS

=head2 new( $def )

Constructor.

Parameters:

=over 4

=item * C<Box2D::b2RevoluteJointDef> C<$def>

=back

=head2 EnableLimit( $flag )

Enable/disable the joint limit.
Expand All @@ -51,13 +48,15 @@ Parameters:

=head2 GetAnchorA()

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

Returns a C<Box2D::b2Vec2>

=head2 GetAnchorB()

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

Returns a C<Box2D::b2Vec2>

Expand Down Expand Up @@ -93,7 +92,8 @@ Returns a C<float32>

=head2 GetReactionForce( $inv_dt )

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

Parameters:

Expand All @@ -107,7 +107,7 @@ Returns a C<Box2D::b2Vec2>

=head2 GetReactionTorque( $inv_dt )

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

Parameters:

Expand All @@ -125,18 +125,6 @@ Get the upper joint limit in radians.

Returns a C<float32>

=head2 InitVelocityConstraints( $step )

Implements b2Joint.

Parameters:

=over 4

=item * C<Box2D::b2TimeStep> C<$step>

=back

=head2 IsLimitEnabled()

Is the joint limit enabled?
Expand Down Expand Up @@ -187,37 +175,17 @@ Parameters:

=back

=head2 SolvePositionConstraints( $baumgarte )

Implements b2Joint.

Parameters:

=over 4

=item * C<float32> C<$baumgarte>

=back

Returns a C<bool>

=head2 SolveVelocityConstraints( $step )

Implements b2Joint.

Parameters:
=head1 SEE ALSO

=over 4

=item * C<Box2D::b2TimeStep> C<$step>

=back
=item * L<Box2D>

=head1 SEE ALSO
=item * L<Box2D::b2RevoluteJointDef>

=over 4
=item * L<Box2D::b2Joint>

=item * L<Box2D>
=item * L<Box2D::b2World>

=back

Expand Down

0 comments on commit 06efee1

Please sign in to comment.