search.cpan.org is shutting down
Tobias Leich > Box2D > Box2D::b2FrictionJointDef

# 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:

• `Box2D::b2Body` `\$bodyA`
• `Box2D::b2Body` `\$bodyB`
• `Box2D::b2Vec2` `\$anchor`

## localAnchorA( \$localAnchorA )

The local anchor point relative to bodyA's origin.

Parameters:

• `Box2D::b2Vec2` `\$localAnchorA` (optional)

Returns a `Box2D::b2Vec2`

## localAnchorB( \$localAnchorB )

The local anchor point relative to bodyB's origin.

Parameters:

• `Box2D::b2Vec2` `\$localAnchorB` (optional)

Returns a `Box2D::b2Vec2`

## maxForce( \$maxForce )

The maximum friction force in N.

Parameters:

• `float32` `\$maxForce` (optional)

Returns a `float32`

## maxTorque( \$maxTorque )

The maximum friction torque in N-m.

Parameters:

• `float32` `\$maxTorque` (optional)

Returns a `float32`