Constrains two points on two rigid bodies to remain at a fixed distance from each other. More...

#include <DistanceJoint.h>

Inheritance diagram for ime::DistanceJoint:

Public Types
using	Ptr = std::shared_ptr< Joint >

using	BodyPtr = std::shared_ptr< Body >

Public Member Functions
std::string	getClassName () const override
	Get the name of this class. More...

float	setRestLength (float length)
	Set the rest length. More...

float	getRestLength () const
	Get the rest length. More...

float	setMinimumLength (float minLength)
	Set the minimum length. More...

float	getMinimumLength () const
	Get the minimum length. More...

float	setMaxLength (float maxLength)
	Set the maximum length. More...

float	getMaximumLength () const
	Get the maximum length. More...

float	getCurrentLength () const
	Get the current length. More...

Vector2f	getBodyALocalAnchorPoint () const
	Get the anchor point on body A in local coordinates. More...

Vector2f	getBodyAWorldAnchorPoint () const override
	Get the anchor point on body A in world coordinates. More...

Vector2f	getBodyBLocalAnchorPoint () const
	Get the anchor point on body B in local coordinates. More...

Vector2f	getBodyBWorldAnchorPoint () const override
	Get the anchor point on body B in world coordinates. More...

JointType	getType () const override
	Get the type of the joint. More...

BodyPtr	getBodyA () override
	Get the first body attached to ths joint. More...

BodyPtr	getBodyB () override
	Get the second body attached to ths joint. More...

Vector2f	getReactionForce (float fpsLimit) const override
	Get the reaction force on body B at the joint anchor. More...

float	getReactionTorque (float fpsLimit) const override
	Get the reaction torque on body B. More...

PropertyContainer &	getUserData () override
	Get the application specific Joint data. More...

const PropertyContainer &	getUserData () const override

bool	canBodiesCollide () const override
	Check if the joint bodies can collide with each other or not. More...

b2Joint *	getInternalJoint () override

const b2Joint *	getInternalJoint () const override

	~DistanceJoint () override
	Destructor. More...

std::string	getClassType () const override
	Get the name of this class. More...

void	setTag (const std::string &tag)
	Assign the object an alias. More...

const std::string &	getTag () const
	Get the alias of the object. More...

unsigned int	getObjectId () const
	Get the id of the object. More...

int	onPropertyChange (const std::string &property, const Callback< Property > &callback)
	Add an event listener to a specific property change event. More...

void	onPropertyChange (const Callback< Property > &callback)
	Add an event listener to a property change event. More...

int	onEvent (const std::string &event, const Callback<> &callback)
	Add an event listener to an event. More...

bool	unsubscribe (const std::string &event, int id)
	Remove an event listener from an event. More...

int	onDestruction (const Callback<> &callback)
	Add a destruction listener. More...

bool	removeDestructionListener (int id)
	Remove a destruction listener form the object. More...

bool	operator== (const Object &rhs) const
	Check if two objects are the same object or not. More...

bool	operator!= (const Object &rhs) const
	Check if two objects are not the same object. More...

Protected Member Functions
void	emitChange (const Property &property)
	Dispatch a property change event. More...

void	emit (const std::string &event)
	Dispatch an action event. More...

Friends
class	World
	Needs access to constructor. More...

Detailed Description

Constrains two points on two rigid bodies to remain at a fixed distance from each other.

When you specify a distance joint the two bodies should already be in place. Then you specify the two anchor points in world coordinates. The first anchor point is connected to body 1, and the second anchor point is connected to body 2. These points imply the length of the distance constraint

Definition at line 81 of file DistanceJoint.h.

Constructor & Destructor Documentation

◆ ~DistanceJoint()

ime::DistanceJoint::~DistanceJoint ( )

override

Destructor.

Member Function Documentation

◆ canBodiesCollide()

bool ime::DistanceJoint::canBodiesCollide ( ) const

overridevirtual

Check if the joint bodies can collide with each other or not.

Returns: True if the bodies can collide with each other, otherwise false

Implements ime::Joint.

◆ emit()

void ime::Object::emit ( const std::string & event )

protectedinherited

Dispatch an action event.

Parameters

event The name of the event to be dispatched

This function will invoke all event listeners of the specified event. The function should be used for events that represent an action, rather than those that represent a property change (Use emitChange for that)

See also: emitChange

◆ emitChange()

void ime::Object::emitChange ( const Property & property )

protectedinherited

Dispatch a property change event.

Parameters

property The property that changed

This function will invoke all the event listeners of the specified property

See also: emit

◆ getBodyA()

BodyPtr ime::DistanceJoint::getBodyA ( )

overridevirtual

Get the first body attached to ths joint.

Returns: The first body attached to this joint

Implements ime::Joint.

◆ getBodyALocalAnchorPoint()

Vector2f ime::DistanceJoint::getBodyALocalAnchorPoint ( ) const

Get the anchor point on body A in local coordinates.

Returns: The anchor point in local coordinates

◆ getBodyAWorldAnchorPoint()

Vector2f ime::DistanceJoint::getBodyAWorldAnchorPoint ( ) const

overridevirtual

Get the anchor point on body A in world coordinates.

Returns: The anchor point in world coordinates

Implements ime::Joint.

◆ getBodyB()

BodyPtr ime::DistanceJoint::getBodyB ( )

overridevirtual

Get the second body attached to ths joint.

Returns: The second body attached to this joint

Implements ime::Joint.

◆ getBodyBLocalAnchorPoint()

Vector2f ime::DistanceJoint::getBodyBLocalAnchorPoint ( ) const

Get the anchor point on body B in local coordinates.

Returns: The anchor point on body B in local coordinates

◆ getBodyBWorldAnchorPoint()

Vector2f ime::DistanceJoint::getBodyBWorldAnchorPoint ( ) const

overridevirtual

Get the anchor point on body B in world coordinates.

Returns: The anchor point on body B in world coordinates

Implements ime::Joint.

◆ getClassName()

std::string ime::DistanceJoint::getClassName ( ) const

overridevirtual

Get the name of this class.

Returns: The name of this class

Implements ime::Object.

◆ getClassType()

std::string ime::Joint::getClassType ( ) const

overridevirtualinherited

Get the name of this class.

Returns: The name of this class

Note that this function is only implemented by child classes of Object which also serve as a base class for other classes

See also: Object::getClassType and Object::getClassName

Reimplemented from ime::Object.

◆ getCurrentLength()

float ime::DistanceJoint::getCurrentLength ( ) const

Get the current length.

Returns: The current length

◆ getMaximumLength()

float ime::DistanceJoint::getMaximumLength ( ) const

Get the maximum length.

Returns: The maximum length

By default the maximum length is

◆ getMinimumLength()

float ime::DistanceJoint::getMinimumLength ( ) const

Get the minimum length.

Returns: The minimum length

By default, the maximum length is the maximum float value on your computer (Very large number)

◆ getObjectId()

unsigned int ime::Object::getObjectId ( ) const

inherited

Get the id of the object.

Returns: The id of the object

Each object has a unique id

◆ getReactionForce()

Vector2f ime::DistanceJoint::getReactionForce ( float fpsLimit ) const

overridevirtual

Get the reaction force on body B at the joint anchor.

Parameters

fpsLimit The games Frames Per Second limit

Returns: The reaction force on Body B at the joint anchor in Newtons (N)

Implements ime::Joint.

◆ getReactionTorque()

float ime::DistanceJoint::getReactionTorque ( float fpsLimit ) const

overridevirtual

Get the reaction torque on body B.

Parameters

fpsLimit The games Frames Per Second limit

Returns: The reaction torque on body B in N*m

Implements ime::Joint.

◆ getRestLength()

float ime::DistanceJoint::getRestLength ( ) const

Get the rest length.

Returns: The rest length

◆ getTag()

const std::string& ime::Object::getTag ( ) const

inherited

Get the alias of the object.

Returns: The alias of the object

See also: setTag and getObjectId

◆ getType()

JointType ime::DistanceJoint::getType ( ) const

overridevirtual

Get the type of the joint.

Returns: The type of the joint

Implements ime::Joint.

◆ getUserData()

PropertyContainer& ime::DistanceJoint::getUserData ( )

overridevirtual

Get the application specific Joint data.

Returns: Application specific joint data

This data is extracted from the JointDefinition

Implements ime::Joint.

◆ onDestruction()

int ime::Object::onDestruction ( const Callback<> & callback )

inherited

Add a destruction listener.

Parameters

callback Function to be executed when the object is destroyed

Returns: The id of the destruction listener

Note that an object may have more than one destruction listeners, however, you have to keep the returned id if you may want to remove the callback at a later time

Warning: The callback is called when the object is destroyed. Do not try to access the object in the callback. Doing so is undefined behavior

See also: removeDestructionListener

◆ onEvent()

int ime::Object::onEvent	(	const std::string &	event,
		const Callback<> &	callback
	)

inherited

Add an event listener to an event.

Parameters

event	The name of the event to add an an event listener to
callback	The function to be executed when the event takes place

Returns: The unique identification number of the event listener

Unlike onPropertyChange, this function registers event listeners to events that occur when something happens to the object, or when the object does something (action events). Usually the name of the event/action is the name of the function:

// Add event listeners to the object
object.onEvent("attachRigidBody", [] {
    std::cout << "Rigid body attached to object << std::endl;
});
 
object.onEvent("removeRigidBody", [] {
    std::cout << "Rigid body removed from object << std::endl;
});
 
// Invokes event listener(s)
object.attachRigidBody(body);
object.removeRigidBody();

See also: onPropertyChange and unsubscribe

◆ onPropertyChange() [1/2]

void ime::Object::onPropertyChange ( const Callback< Property > & callback )

inherited

Add an event listener to a property change event.

Parameters

callback The function to be executed when the property changes

Returns: The unique id of the event listener

Note that only one callback function may be registered with this function. This means that adding a new event listener overwrites the previous event listener. To remove the callback, pass a nullptr as an argument. The function may be useful if you want to write the logic for property changes in one function.

See also: onPropertyChange(std::string, Callback)

◆ onPropertyChange() [2/2]

int ime::Object::onPropertyChange	(	const std::string &	property,
		const Callback< Property > &	callback
	)

inherited

Add an event listener to a specific property change event.

Parameters

property	The name of the property to listen for
callback	The function to be executed when the property changes

Returns: The unique id of the event listener

A property change event is triggered by any function that begins with set, where the the text after set is the name of the property. For example, for the setTag function, the property that the function modifies is Tag.

Note that when adding a property change event listener, the name of the property must be in lowercase:

// Prints the tag of the player object to the console everytime it changes
player.onPropertyChange("tag", [](const Property& property) {
     cout << "New tag: " <<  property.getValue<std::string>() << endl;
});
 
...
//Sets tag = "player1" and invokes event listener(s)
player.setTag("player1");

Unlike onPropertyChange(const Callback&) you can add multiple event listeners to the same property using this function. However you must store the unique id of the event listener if you wish to remove it at a later time

See also: unsubscribe and onPropertyChange(Callback)

◆ operator!=()

bool ime::Object::operator!= ( const Object & rhs ) const

inherited

Check if two objects are not the same object.

Parameters

rhs	Object to compare against this object

Returns: True if rhs is NOT the same object as this object, otherwise false

Two objects are different from each other if they have different object id's

See also: getObjectId and operator==

◆ operator==()

bool ime::Object::operator== ( const Object & rhs ) const

inherited

Check if two objects are the same object or not.

Parameters

rhs	Object to compare against this object

Returns: True if rhs is the same object as this object, otherwise false

Two objects are the same object if they have the same object id. Recall that each object instance has a unique id

See also: getObjectId and operator!=

◆ removeDestructionListener()

bool ime::Object::removeDestructionListener ( int id )

inherited

Remove a destruction listener form the object.

Parameters

The	id of the destruction listener to be removed

Returns: True if the destruction listener was removed or false if the listener with the given id does not exist

◆ setMaxLength()

float ime::DistanceJoint::setMaxLength ( float maxLength )

Set the maximum length.

Parameters

maxLength The new maximum length

Returns: The clamped length

◆ setMinimumLength()

float ime::DistanceJoint::setMinimumLength ( float minLength )

Set the minimum length.

Parameters

minLength The new minimum length

Returns: The clamped length

By default the minimum length is 0.0f

◆ setRestLength()

float ime::DistanceJoint::setRestLength ( float length )

Set the rest length.

Parameters

length The rest length to set

Returns: The clamped length

◆ setTag()

void ime::Object::setTag ( const std::string & tag )

inherited

Assign the object an alias.

Parameters

name	The alias of the object

This function is useful if you want to refer to the object by tag instead of its id. Unlike an object id, multiple objects may have the same tag.

By default, the tag is an empty string

◆ unsubscribe()

bool ime::Object::unsubscribe	(	const std::string &	event,
		int	id
	)

inherited

Remove an event listener from an event.

Parameters

event	The name of the event to remove event listener from
id	The unique id of the event listener to be removed

Returns: True if the event listener was removed or false if the event or the event listener is does not exist

// Display the name of the object to console every time it changes
auto nameChangeId = object.onPropertyChange("name", [](Property name) {
     std::cout << name.getValue<std::string>() << std::endl;
});
 
// Stop displaying the name of the object when it changes
object.unsubscribe("name", id);

Friends And Related Function Documentation

◆ World

friend class World

friend

Needs access to constructor.

Definition at line 251 of file DistanceJoint.h.

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

DistanceJoint.h

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ~DistanceJoint()

Member Function Documentation

◆ canBodiesCollide()

◆ emit()

◆ emitChange()

◆ getBodyA()

◆ getBodyALocalAnchorPoint()

◆ getBodyAWorldAnchorPoint()

◆ getBodyB()

◆ getBodyBLocalAnchorPoint()

◆ getBodyBWorldAnchorPoint()

◆ getClassName()

◆ getClassType()

◆ getCurrentLength()

◆ getMaximumLength()

◆ getMinimumLength()

◆ getObjectId()

◆ getReactionForce()

◆ getReactionTorque()

◆ getRestLength()

◆ getTag()

◆ getType()

◆ getUserData()

◆ onDestruction()

◆ onEvent()

◆ onPropertyChange() [1/2]

◆ onPropertyChange() [2/2]

◆ operator!=()

◆ operator==()

◆ removeDestructionListener()

◆ setMaxLength()

◆ setMinimumLength()

◆ setRestLength()

◆ setTag()

◆ unsubscribe()

Friends And Related Function Documentation

◆ World