clan::PrismaticJointDescription Class Reference

PrismaticJointDescription class. More...

#include <prismatic_joint_description.h>

Public Member Functions

Construction
 PrismaticJointDescription ()
 Constructs a null instance. More...
 
 PrismaticJointDescription (const PhysicsWorld &pw)
 Constructs a PrismaticJointDescription object. More...
 
virtual ~PrismaticJointDescription ()
 
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
PrismaticJointDescriptionoperator= (const PrismaticJointDescription &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_axis_a (const Vec2f &axis)
 Sets the local translation unit axis in bodyA. More...
 
void set_reference_angle (const Angle &angle)
 Sets The constrained angle between the bodies: bodyB_angle - bodyA_angle. More...
 
void enable_limit (const bool value=true)
 Enable/disable the joint limit. More...
 
void set_translation_limits (const float min, const float max)
 Sets the translation limits for the prismatic joint. Usually in meters. More...
 
void set_translation_min (const float value)
 Sets The lower translation limit, usually in meters. More...
 
void set_translation_max (const float value)
 Sets The upper translation limit, usually in meters. More...
 
void set_as_motor (const bool value=true)
 Enable/disable the joint motor. More...
 
void set_max_motor_force (const float value)
 Sets The maximum motor torque, usually in N-m. More...
 
void set_motor_speed (const Angle &angle)
 Sets the desired motor speed. More...
 

Protected Attributes

Implementation
std::shared_ptr
< PrismaticJointDescription_Impl > 
impl
 

Friends

class PrismaticJoint
 

Detailed Description


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