Torque2D Reference

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions | Public Attributes | List of all members
b2MouseJointDef Struct Reference

`#include <b2MouseJoint.h>`

Inheritance diagram for b2MouseJointDef:

## Public Member Functions
| b2MouseJointDef ()
Public Member Functions inherited from b2JointDef
| b2JointDef ()

## Public Attributes
b2Vec2 | target
float32 | maxForce
float32 | frequencyHz
| The response speed. More...
float32 | dampingRatio
| The damping ratio. 0 = no damping, 1 = critical damping. More...
Public Attributes inherited from b2JointDef
b2JointType | type
| The joint type is set automatically for concrete joint types. More...
void * | userData
| Use this to attach application specific data to your joints. More...
b2Body * | bodyA
| The first attached body. More...
b2Body * | bodyB
| The second attached body. More...
bool | collideConnected
| Set this flag to true if the attached bodies should collide. More...

## Detailed Description

Mouse joint definition. This requires a world target point, tuning parameters, and the time step.

## Constructor & Destructor Documentation

b2MouseJointDef | ( |  | ) |
| inline

## Member Data Documentation

float32 dampingRatio

The damping ratio. 0 = no damping, 1 = critical damping.

float32 frequencyHz

The response speed.

float32 maxForce

The maximum constraint force that can be exerted to move the candidate body. Usually you will express as some multiple of the weight (multiplier * mass * gravity).

b2Vec2 target

The initial world target point. This is assumed to coincide with the body anchor initially.

The documentation for this struct was generated from the following file:

- Box2D/Dynamics/Joints/b2MouseJoint.h