Jeffrey T. Palmer > Box2D > Box2D::b2FrictionJointDef

Download:
Box2D-0.07.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

Box2D::b2FrictionJointDef - Friction joint definition.

SYNOPSIS ^

  my $joint_def = Box2D::b2FrictionJointDef->new();
  $joint_def->Initialize( $body_a, $body_b, $anchor );
  $joint_def->maxForce( $max_force );
  $joint_def->maxTorque( $max_torque );
  my $joint = $world->CreateJoint( $joint_def );

DESCRIPTION ^

Friction joint definition.

METHODS ^

new()

Default constructor.

Returns a Box2D::b2FrictionJointDef

Initialize( $bodyA, $bodyB, $anchor )

Initialize the bodies, anchors, axis, and reference angle using the world anchor and world axis.

Parameters:

localAnchorA()

localAnchorA( $localAnchorA )

The local anchor point relative to bodyA's origin.

Parameters:

Returns a Box2D::b2Vec2

localAnchorB()

localAnchorB( $localAnchorB )

The local anchor point relative to bodyB's origin.

Parameters:

Returns a Box2D::b2Vec2

maxForce()

maxForce( $maxForce )

The maximum friction force in N.

Parameters:

Returns a float32

maxTorque()

maxTorque( $maxTorque )

The maximum friction torque in N-m.

Parameters:

Returns a float32

SEE ALSO ^

BUGS ^

See "BUGS" in Box2D

AUTHORS ^

See "AUTHORS" in Box2D

COPYRIGHT & LICENSE ^

See "COPYRIGHT & LICENSE" in Box2D

syntax highlighting: