WorldJoint.hpp File Reference

Declarations of free functions of World for joints identified by JointID. More...

#include <playrho/BodyID.hpp>
#include <playrho/JointID.hpp>
#include <playrho/LimitState.hpp>
#include <playrho/d2/Joint.hpp>
#include <playrho/d2/Math.hpp>

Include dependency graph for WorldJoint.hpp:

This graph shows which files directly or indirectly include this file:

Namespaces
	playrho
	playrho::d2

Functions
void	playrho::d2::EnableLimit (World &world, JointID id, bool value)
	Sets whether the identified joint's limit is enabled or not. More...
void	playrho::d2::EnableMotor (World &world, JointID id, bool value)
Length2	playrho::d2::GetAnchorA (const World &world, JointID id)
Length2	playrho::d2::GetAnchorB (const World &world, JointID id)
Angle	playrho::d2::GetAngle (const World &world, JointID id)
	Gets the angle property of the identified joint if it has it. More...
Angle	playrho::d2::GetAngularLowerLimit (const World &world, JointID id)
RotInertia	playrho::d2::GetAngularMass (const World &world, JointID id)
	Gets the computed angular rotational inertia used by the joint. More...
AngularMomentum	playrho::d2::GetAngularMotorImpulse (const World &world, JointID id)
	Gets the angular motor impulse of the identified joint if it has this property. More...
Angle	playrho::d2::GetAngularOffset (const World &world, JointID id)
	Gets the target angular offset. More...
AngularMomentum	playrho::d2::GetAngularReaction (const World &world, JointID id)
	Get the angular reaction on body-B for the identified joint. More...
Angle	playrho::d2::GetAngularUpperLimit (const World &world, JointID id)
AngularVelocity	playrho::d2::GetAngularVelocity (const World &world, JointID id)
	Gets the angular velocity of the identified joint if it has this property. More...
BodyID	playrho::d2::GetBodyA (const World &world, JointID id)
	Gets the identifier of body-A of the identified joint. More...
BodyID	playrho::d2::GetBodyB (const World &world, JointID id)
	Gets the identifier of body-B of the identified joint. More...
bool	playrho::d2::GetCollideConnected (const World &world, JointID id)
	Gets collide connected for the specified joint. More...
Length	playrho::d2::GetCurrentLengthA (const World &world, JointID id)
	Get the current length of the segment attached to body-A. More...
Length	playrho::d2::GetCurrentLengthB (const World &world, JointID id)
	Get the current length of the segment attached to body-B. More...
Real	playrho::d2::GetDampingRatio (const World &world, JointID id)
	Gets the damping ratio associated with the identified joint if it has one. More...
Frequency	playrho::d2::GetFrequency (const World &world, JointID id)
	Gets the frequency of the identified joint if it has this property. More...
Length2	playrho::d2::GetGroundAnchorA (const World &world, JointID id)
Length2	playrho::d2::GetGroundAnchorB (const World &world, JointID id)
Length	playrho::d2::GetJointTranslation (const World &world, JointID id)
	Gets the current joint translation. More...
Length	playrho::d2::GetLength (const World &world, JointID id)
	Gets the length associated with the identified joint if it has one. More...
LimitState	playrho::d2::GetLimitState (const World &world, JointID id)
	Gets the joint's limit state if it has one. More...
Momentum	playrho::d2::GetLinearMotorImpulse (const World &world, JointID id)
	Gets the linear motor impulse of the identified joint if it supports that. More...
Length2	playrho::d2::GetLinearOffset (const World &world, JointID id)
	Gets the target linear offset, in frame A. More...
Momentum2	playrho::d2::GetLinearReaction (const World &world, JointID id)
	Gets the linear reaction on body-B at the joint anchor. More...
Length2	playrho::d2::GetLocalAnchorA (const World &world, JointID id)
Length2	playrho::d2::GetLocalAnchorB (const World &world, JointID id)
UnitVec	playrho::d2::GetLocalXAxisA (const World &world, JointID id)
	Gets the local-X-axis-A property of the identified joint if it has it. More...
UnitVec	playrho::d2::GetLocalYAxisA (const World &world, JointID id)
	Gets the local-Y-axis-A property of the identified joint if it has it. More...
Torque	playrho::d2::GetMaxMotorTorque (const World &world, JointID id)
	Gets the max motor torque. More...
Force	playrho::d2::GetMotorForce (const World &world, JointID id, Frequency inv_dt)
	Gets the current motor force for the given joint, given the inverse time step. More...
AngularVelocity	playrho::d2::GetMotorSpeed (const World &world, JointID id)
	Gets the motor-speed property of the identied joint if it supports it. More...
Torque	playrho::d2::GetMotorTorque (const World &world, JointID id, Frequency inv_dt)
	Gets the current motor torque for the given joint given the inverse time step. More...
Real	playrho::d2::GetRatio (const World &world, JointID id)
	Gets the ratio property of the identified joint if it has it. More...
Angle	playrho::d2::GetReferenceAngle (const World &world, JointID id)
	Gets the reference-angle property of the identified joint if it has it. More...
Length2	playrho::d2::GetTarget (const World &world, JointID id)
	Gets the target point. More...
TypeID	playrho::d2::GetType (const World &world, JointID id)
	Gets the type of the joint. More...
JointCounter	playrho::d2::GetWorldIndex (const World &, JointID id) noexcept
	Gets the world index of the given joint. More...
bool	playrho::d2::IsEnabled (const World &world, JointID id)
	Gets the enabled/disabled state of the joint. More...
bool	playrho::d2::IsLimitEnabled (const World &world, JointID id)
	Gets whether the identified joint's limit is enabled. More...
bool	playrho::d2::IsMotorEnabled (const World &world, JointID id)
void	playrho::d2::SetAngularLimits (World &world, JointID id, Angle lower, Angle upper)
void	playrho::d2::SetAngularOffset (World &world, JointID id, Angle value)
	Sets the target angular offset. More...
void	playrho::d2::SetAwake (World &world, JointID id)
	Wakes up the joined bodies. More...
void	playrho::d2::SetFrequency (World &world, JointID id, Frequency value)
	Sets the frequency of the identified joint if it has this property. More...
void	playrho::d2::SetLinearOffset (World &world, JointID id, const Length2 &value)
	Sets the target linear offset, in frame A. More...
void	playrho::d2::SetMaxMotorTorque (World &world, JointID id, Torque value)
void	playrho::d2::SetMotorSpeed (World &world, JointID id, AngularVelocity value)
	Sets the motor-speed property of the identied joint if it supports it. More...
void	playrho::d2::SetTarget (World &world, JointID id, const Length2 &value)
	Sets the target point. More...
bool	playrho::d2::ShiftOrigin (World &world, JointID id, const Length2 &value)
	Shifts the origin of the identified joint. More...

Detailed Description

Declarations of free functions of World for joints identified by JointID.

This is a collection of non-member non-friend functions - also called "free" functions - that are related to joints within an instance of a World. Many are just "wrappers" to similarly named member functions but some are additional functionality built on those member functions. A benefit to using free functions that are now just wrappers, is that of helping to isolate your code from future changes that might occur to the underlying World member functions. Free functions in this sense are "cheap" abstractions. While using these incurs extra run-time overhead when compiled without any compiler optimizations enabled, enabling optimizations should entirely eliminate that overhead.

Note

The four basic categories of these functions are "CRUD": create, read, update, and delete.

See also

World, JointID.

https://en.wikipedia.org/wiki/Create,_read,_update_and_delete.