Jeffrey T. Palmer > Box2D-0.07 > Box2D::b2LineJointDef

Download:
Box2D-0.07.tar.gz

Annotate this POD

View/Report Bugs
Source  

NAME ^

Box2D::b2LineJointDef - Line joint definition.

SYNOPSIS ^

  my $joint_def = Box2D::b2LineJointDef->new();
  $joint_def->Initialize( $body_a, $body_b, $anchor, $axis );
  $joint_def->enableLimit( 1 );
  $joint_def->lowerTranslation( $lower_translation );
  $joint_def->upperTranslation( $upper_translation );
  $joint_def->enableMotor( 1 );
  $joint_def->motorSpeed( $speed );
  $joint_def->maxMotorForce( $max_force );
  my $joint = $world->CreateJoint( $joint_def );

DESCRIPTION ^

Line joint definition. This requires defining a line of motion using an axis and an anchor point. The definition uses local anchor points and a local axis so that the initial configuration can violate the constraint slightly. The joint translation is zero when the local anchor points coincide in world space. Using local anchors and a local axis helps when saving and loading a game.

METHODS ^

new()

Default constructor.

Returns a Box2D::b2LineJointDef

Initialize( $bodyA, $bodyB, $anchor, $axis )

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

Parameters:

enableLimit()

enableLimit( $enableLimit )

Enable/disable the joint limit.

Parameters:

Returns a bool

enableMotor()

enableMotor( $enableMotor )

Enable/disable the joint motor.

Parameters:

Returns a bool

localAnchorA()

localAnchorA( $localAnchorA )

The local anchor point relative to body1's origin.

Parameters:

Returns a Box2D::b2Vec2

localAnchorB()

localAnchorB( $localAnchorB )

The local anchor point relative to body2's origin.

Parameters:

Returns a Box2D::b2Vec2

localAxisA()

localAxisA( $localAxisA )

The local translation axis in body1.

Parameters:

Returns a Box2D::b2Vec2

lowerTranslation()

lowerTranslation( $lowerTranslation )

The lower translation limit, usually in meters.

Parameters:

Returns a float32

maxMotorForce()

maxMotorForce( $maxMotorForce )

The maximum motor torque, usually in N-m.

Parameters:

Returns a float32

motorSpeed()

motorSpeed( $motorSpeed )

The desired motor speed in radians per second.

Parameters:

Returns a float32

upperTranslation()

upperTranslation( $upperTranslation )

The upper translation limit, usually in meters.

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: