clan::MouseJointDescription Class Reference

MouseJointDescription class. More...

#include <mouse_joint_description.h>

Public Member Functions

Construction
 MouseJointDescription ()
 Constructs a null instance. More...
 
 MouseJointDescription (const PhysicsWorld &pw)
 Constructs a MouseJointDescription object. More...
 
virtual ~MouseJointDescription ()
 
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
MouseJointDescriptionoperator= (const MouseJointDescription &copy)
 Copy assignment operator. More...
 
void set_bodies (const Body &bodyA, const Body &bodyB)
 Sets two bodies to be connected by the joint. More...
 
void set_body_a (const Body &body)
 Sets first body to be connected by the joint. More...
 
void set_body_b (const Body &body)
 Sets second body to be connected by the joint. More...
 
void set_target (const Vec2f &target)
 Sets the target position of the mouse. More...
 
void set_max_force (const float value)
 Sets the maximum force the mouse joint is allowed to have. More...
 
void set_damping_ratio (const float damping)
 Sets the damping ratio. 0 = no damping, 1 = critical damping. More...
 
void set_frequency (const float frequency)
 Sets the response speed in Hz. More...
 

Protected Attributes

Implementation
std::shared_ptr
< MouseJointDescription_Impl > 
impl
 

Friends

class MouseJoint
 

Detailed Description


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