clan::DistanceJointDescription Class Reference

DistanceJointDescription class. More...

#include <distance_joint_description.h>

Public Member Functions

Construction
 DistanceJointDescription ()
 Constructs a null instance. More...
 
 DistanceJointDescription (const PhysicsWorld &pw)
 Constructs a DistanceJointDescription object. More...
 
virtual ~DistanceJointDescription ()
 
Attributes
bool is_null () const
 Returns true if this object is invalid. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 
bool is_active () const
 Short-cut function to determine if either body is inactive. More...
 
Operations
DistanceJointDescriptionoperator= (const DistanceJointDescription &copy)
 Copy assignment operator. More...
 
void set_bodies (const Body &bodyA, const Body &bodyB, const Vec2f &anchorA, const Vec2f &anchorB)
 Sets two bodies to be connected by the joint. More...
 
void set_body_a (const Body &body, const Vec2f &anchor)
 Sets first body to be connected by the joint. More...
 
void set_body_b (const Body &body, const Vec2f &anchor)
 Sets second body to be connected by the joint. More...
 
void set_damping_ratio (const float damping)
 Sets the damping ratio. 0 = no damping, 1 = critical damping. More...
 
void set_length (const float length)
 Sets the natural length between the anchor points. More...
 

Protected Attributes

Implementation
std::shared_ptr
< DistanceJointDescription_Impl > 
impl
 

Friends

class DistanceJoint
 

Detailed Description


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