clan::RevoluteJointDescription Class Reference

RevoluteJointDescription class. More...

#include <revolute_joint_description.h>

Public Member Functions

Construction
 RevoluteJointDescription ()
 Constructs a null instance. More...
 
 RevoluteJointDescription (const PhysicsWorld &pw)
 Constructs a RevoluteJointDescription object. More...
 
virtual ~RevoluteJointDescription ()
 
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...
 
bool is_motor () const
 
float get_motor_speed () const
 
Angle get_reference_angle () const
 
Angle get_lower_angle () const
 
Angle get_upper_angle () const
 
Operations
RevoluteJointDescriptionoperator= (const RevoluteJointDescription &copy)
 Copy assignment operator. More...
 
void set_bodies (const Body &bodyA, const Body &bodyB, const Vec2f &anchor)
 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_as_motor (const bool value=true)
 Enables the joint motor. More...
 
void set_motor_speed (const Angle speed)
 Apply the desired motor speed. More...
 
void set_reference_angle (const Angle angle)
 The bodyB angle minus bodyA angle in the reference state. More...
 
void set_max_motor_torque (const float value)
 Set the maximum motor torque used to achieve the desired motor speed. Usually in N-m. More...
 
void set_angle_limit (const Angle lower, const Angle upper)
 Set limits for the angle of the joint. More...
 
void set_lower_angle (const Angle angle)
 The lower angle for the joint limit. More...
 
void set_upper_angle (const Angle angle)
 The upper angle for the joint limit. More...
 

Protected Attributes

Implementation
std::shared_ptr
< RevoluteJointDescription_Impl > 
impl
 

Friends

class RevoluteJoint
 

Detailed Description


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