Skip to content

Commit

Permalink
Updated b2ContactImpulse docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jtpalmer committed Sep 28, 2011
1 parent 4d032c1 commit 7b5b6f1
Showing 1 changed file with 19 additions and 21 deletions.
40 changes: 19 additions & 21 deletions lib/pods/Box2D/b2ContactImpulse.pod
Original file line number Diff line number Diff line change
@@ -1,51 +1,49 @@

=head1 NAME

Box2D::b2ContactImpulse - TODO
Box2D::b2ContactImpulse - Contact impulses for reporting.

=head1 SYNOPSIS

# TODO

=head1 DESCRIPTION
for my $i ( 0 .. $contact->GetManifold()->pointCount() - 1 ) {

my $impulse = $contactImpulse->normalImpulses( $i );

# Do something
}

=head1 METHODS

=head2 new()
=head1 DESCRIPTION

Default constructor.
Contact impulses for reporting. Impulses are used instead of forces
because sub-step forces may approach infinity for rigid body
collisions. These match up one-to-one with the contact points in
C<Box2D::b2Manifold>.

=head2 float32 b2ContactImpulse::normalImpulses[b2_maxManifoldPoints]()
=head1 METHODS

=head2 float32 b2ContactImpulse::normalImpulses[b2_maxManifoldPoints]( $float32 b2ContactImpulse::normalImpulses[b2_maxManifoldPoints] )
=head2 normalImpulses( $index )

Parameters:

=over 4

=item * C<$float32 b2ContactImpulse::normalImpulses[b2_maxManifoldPoints]> (optional)
=item * C<int> C<$index>

=back

=head2 float32 b2ContactImpulse::tangentImpulses[b2_maxManifoldPoints]()
Returns a C<float32>

=head2 float32 b2ContactImpulse::tangentImpulses[b2_maxManifoldPoints]( $float32 b2ContactImpulse::tangentImpulses[b2_maxManifoldPoints] )

Parameters:
=head1 SEE ALSO

=over 4

=item * C<$float32 b2ContactImpulse::tangentImpulses[b2_maxManifoldPoints]> (optional)
=item * L<Box2D>

=back
=item * L<Box2D::b2ContactListener>

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

=over 4

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

=back

Expand Down

0 comments on commit 7b5b6f1

Please sign in to comment.