Public Member Functions | Public Attributes | List of all members
ime::DistanceJointDefinition Struct Reference

#include <DistanceJoint.h>

Inheritance diagram for ime::DistanceJointDefinition:
ime::JointDefinition

Public Member Functions

 DistanceJointDefinition ()
 Constructor. More...
 
void join (RigidBody *bodyA, RigidBody *bodyB, Vector2f anchorA, Vector2f anchorB)
 Joint the bodies and initialize the rest length. More...
 

Public Attributes

Vector2f bodyALocalAnchorPoint
 The local anchor point relative to bodyA's origin. More...
 
Vector2f bodyBLocalAnchorPoint
 The local anchor point relative to bodyB's origin. More...
 
float length
 The rest length of this joint. Clamped to a stable minimum value. More...
 
float minLength
 Minimum length. Clamped to a stable minimum value. More...
 
float maxLength
 Maximum length. Must be greater than or equal to the minimum length. More...
 
JointType type
 The type of the joint defined by this definition (set automatically) More...
 
RigidBodybodyA
 The first attached body. More...
 
RigidBodybodyB
 The second attached body. More...
 
bool areBodiesCollidable
 A flag indicating whether or not the joined bodies can collide with each other. More...
 
PropertyContainer userData
 May be used to store application specific Joint data. More...
 

Detailed Description

Returns
Distance joint definition

Definition at line 41 of file DistanceJoint.h.

Constructor & Destructor Documentation

◆ DistanceJointDefinition()

ime::DistanceJointDefinition::DistanceJointDefinition ( )

Constructor.

Member Function Documentation

◆ join()

void ime::DistanceJointDefinition::join ( RigidBody bodyA,
RigidBody bodyB,
Vector2f  anchorA,
Vector2f  anchorB 
)

Joint the bodies and initialize the rest length.

Parameters
bodyAThe first body
bodyBThe second body
anchorAThe attach point on body A in world coordinates
anchorBThe attach point on body B in world coordinates

The minimum and maximum lengths are set to the rest length

Member Data Documentation

◆ areBodiesCollidable

bool ime::JointDefinition::areBodiesCollidable
inherited

A flag indicating whether or not the joined bodies can collide with each other.

Definition at line 65 of file JointDefinition.h.

◆ bodyA

RigidBody* ime::JointDefinition::bodyA
inherited

The first attached body.

Definition at line 63 of file JointDefinition.h.

◆ bodyALocalAnchorPoint

Vector2f ime::DistanceJointDefinition::bodyALocalAnchorPoint

The local anchor point relative to bodyA's origin.

Definition at line 62 of file DistanceJoint.h.

◆ bodyB

RigidBody* ime::JointDefinition::bodyB
inherited

The second attached body.

Definition at line 64 of file JointDefinition.h.

◆ bodyBLocalAnchorPoint

Vector2f ime::DistanceJointDefinition::bodyBLocalAnchorPoint

The local anchor point relative to bodyB's origin.

Definition at line 63 of file DistanceJoint.h.

◆ length

float ime::DistanceJointDefinition::length

The rest length of this joint. Clamped to a stable minimum value.

Definition at line 64 of file DistanceJoint.h.

◆ maxLength

float ime::DistanceJointDefinition::maxLength

Maximum length. Must be greater than or equal to the minimum length.

Definition at line 66 of file DistanceJoint.h.

◆ minLength

float ime::DistanceJointDefinition::minLength

Minimum length. Clamped to a stable minimum value.

Definition at line 65 of file DistanceJoint.h.

◆ type

JointType ime::JointDefinition::type
inherited

The type of the joint defined by this definition (set automatically)

Definition at line 62 of file JointDefinition.h.

◆ userData

PropertyContainer ime::JointDefinition::userData
inherited

May be used to store application specific Joint data.

Definition at line 66 of file JointDefinition.h.


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