Interface for Joint classes. More...

#include <Joint.h>

Inheritance diagram for ime::Joint:

Public Types
using	Ptr = std::unique_ptr< Joint >
	Unique joint pointer. More...

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

virtual JointType	getType () const =0
	Get the type of the joint. More...

virtual RigidBody *	getBodyA ()=0
	Get the first body attached to ths joint. More...

virtual const RigidBody *	getBodyA () const =0

virtual RigidBody *	getBodyB ()=0
	Get the second body attached to this joint. More...

virtual const RigidBody *	getBodyB () const =0

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

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

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

virtual float	getReactionTorque (float fpsLimit) const =0
	Get the reaction torque on body B. More...

virtual PropertyContainer &	getUserData ()=0
	Get the application specific Joint data. More...

virtual const PropertyContainer &	getUserData () const =0

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

virtual b2Joint *	getInternalJoint ()=0

virtual const b2Joint *	getInternalJoint () const =0

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

const std::string &	getTag () const
	Get the tag assigned to the object. More...

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

virtual std::string	getClassName () const =0
	Get the name of the objects concrete class. More...

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

int	onPropertyChange (const Callback< Property > &callback, bool oneTime=false)
	Add an event listener to any property change event. More...

void	suspendedEventListener (int id, bool suspend)
	Pause or resume execution of an event listener. More...

bool	isEventListenerSuspended (int id) const
	Check if an event listener is suspended or not. More...

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

bool	removeEventListener (int id)
	Remove an event listener. More...

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

bool	isSameObjectAs (const Object &other) const
	Check if another object is the same instance as this object. More...

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

void	emitDestruction ()
	Emit a destruction event. More...

Protected Attributes
EventEmitter	eventEmitter_
	Event dispatcher. More...

Detailed Description

Interface for Joint classes.

Joints are used to constrain rigid bodies to the world or to each other e.g a pulley

Note that joints are not constructed directly, use ime::PhysicsEngine::createJoint

Definition at line 44 of file Joint.h.

Member Typedef Documentation

◆ Ptr

using ime::Joint::Ptr = std::unique_ptr<Joint>

Unique joint pointer.

Definition at line 46 of file Joint.h.

Member Function Documentation

◆ canBodiesCollide()

virtual bool ime::Joint::canBodiesCollide ( ) const

pure virtual

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

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

Implemented in ime::DistanceJoint.

◆ 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

◆ emitDestruction()

void ime::Object::emitDestruction ( )

protectedinherited

Emit a destruction event.

Note: This function must be the first statement in the definition of a destructor to avoid undefined behavior. In addition, note that destruction listeners are invoked once. Therefore, multiple classes in a hierarchy may call this function but the class that makes the call first will be the one that invokes the destruction listeners

◆ getBodyA()

virtual RigidBody * ime::Joint::getBodyA ( )

pure virtual

Get the first body attached to ths joint.

Returns: The first body attached to this joint

Implemented in ime::DistanceJoint.

◆ getBodyAWorldAnchorPoint()

virtual Vector2f ime::Joint::getBodyAWorldAnchorPoint ( ) const

pure virtual

Get the anchor point on body A in world coordinates.

Returns: The anchor point in world coordinates

Implemented in ime::DistanceJoint.

◆ getBodyB()

virtual RigidBody * ime::Joint::getBodyB ( )

pure virtual

Get the second body attached to this joint.

Returns: The second body attached to this joint

Implemented in ime::DistanceJoint.

◆ getBodyBWorldAnchorPoint()

virtual Vector2f ime::Joint::getBodyBWorldAnchorPoint ( ) const

pure virtual

Get the anchor point on body B in world coordinates.

Returns: The anchor point on body B in world coordinates

Implemented in ime::DistanceJoint.

◆ getClassName()

virtual std::string ime::Object::getClassName ( ) const

pure virtualinherited

Get the name of the objects concrete class.

Returns: The name of the objects concrete class

This function is implemented by all internal classes that inherit from this class (either directly or indirectly). Example:

class ime::GameObject : public ime::Object {...}
GameObject gObject;
std::cout << gObject.getClassName(); // Prints "GameObject"

See also: getClassType

Implemented in ime::audio::Music, ime::audio::SoundEffect, ime::GameObject, ime::GridObject, ime::CyclicGridMover, ime::GridMover, ime::KeyboardGridMover, ime::RandomGridMover, ime::TargetGridMover, ime::AABB, ime::BoxCollider, ime::CircleCollider, ime::EdgeCollider, ime::PolygonCollider, ime::DistanceJoint, ime::RigidBody, ime::RenderLayer, ime::RenderLayerContainer, ime::Scene, ime::Camera, ime::CircleShape, ime::ConvexShape, ime::RectangleShape, ime::Sprite, ime::SpriteSheet, and ime::Tile.

◆ getClassType()

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

overridevirtual

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.

◆ getObjectId()

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

inherited

Get the unique id of the object.

Returns: The unique id of the object

Note that each instance of ime::Object has a unique id

See also: setTag

◆ getReactionForce()

virtual Vector2f ime::Joint::getReactionForce ( float fpsLimit ) const

pure virtual

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)

Implemented in ime::DistanceJoint.

◆ getReactionTorque()

virtual float ime::Joint::getReactionTorque ( float fpsLimit ) const

pure virtual

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

Implemented in ime::DistanceJoint.

◆ getTag()

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

inherited

Get the tag assigned to the object.

Returns: The tag of the object

See also: setTag

◆ getType()

virtual JointType ime::Joint::getType ( ) const

pure virtual

Get the type of the joint.

Returns: The type of the joint

Implemented in ime::DistanceJoint.

◆ getUserData()

virtual PropertyContainer & ime::Joint::getUserData ( )

pure virtual

Get the application specific Joint data.

Returns: Application specific joint data

This data is extracted from the JointDefinition

Implemented in ime::DistanceJoint.

◆ isEventListenerSuspended()

bool ime::Object::isEventListenerSuspended ( int id ) const

inherited

Check if an event listener is suspended or not.

Parameters

id	The identification number of the listener to be checked

Returns: True if suspended, otherwise false

This function also returns false if the specified event listener does not exist

See also: suspendedEventListener

◆ isSameObjectAs()

bool ime::Object::isSameObjectAs ( const Object & other ) const

inherited

Check if another object is the same instance as this object.

Parameters

other The object to compare against this object

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

◆ 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 unique id of the destruction listener

The destruction listener is called when the object reaches the end of its lifetime. Note that an object may have multiple destruction listeners registered to it

Warning: It's not advised to call virtual functions in the destruction callback as some parts of the object may have already been destroyed by the time the callback is invoked. In such an event, the behavior is undefined

See also: removeEventListener

◆ onPropertyChange() [1/2]

int ime::Object::onPropertyChange	(	const Callback< Property > &	callback,
		bool	oneTime = `false`
	)

inherited

Add an event listener to any property change event.

Parameters

callback	The function to be executed when any property changes
oneTime	True to execute the callback one-time or false to execute it every time the event is triggered

Returns: The unique id of the event listener

When unsubscribing the any property change event handler, you must pass "propertyChange" as the name of the event

See also: onPropertyChange(const std::string&, const ime::Callback<ime::Property>&)

◆ onPropertyChange() [2/2]

int ime::Object::onPropertyChange	(	const std::string &	property,
		const Callback< Property > &	callback,
		bool	oneTime = `false`
	)

inherited

Add an event listener to a specific property change event.

Parameters

property	The name of the property to add an event listener to
oneTime	True to execute the callback one-time or false to execute it every time the event is triggered
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, the setTag() function, modifies the tag property of the object, thus will generate a "tag" change event each time it is called

Note that multiple event listeners may be registered to the same property change event. In addition, 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");

See also: unsubscribe and onPropertyChange(const ime::Callback<ime::Property>&)

◆ removeEventListener() [1/2]

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

inherited

Remove an event listener from an event.

Parameters

event	The name of the event to remove an 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 tag of the object to console every time it changes
auto tagChangeId = object.onPropertyChange("tag", [](ime::Property tag) {
     std::cout << name.getValue<std::string>() << std::endl;
});
 
// Stop displaying the tag of the object when it changes
object.removeEventListener("tag", tagChangeId);

◆ removeEventListener() [2/2]

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

inherited

Remove an event listener.

Parameters

id	The id of the event listener to be removed

Returns: True if the event listener was removed or false if no such handler exists

◆ setTag()

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

inherited

Assign the object an alias.

Parameters

tag	The alias of the object

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

By default, the tag is an empty string

See also: getObjectId

◆ suspendedEventListener()

void ime::Object::suspendedEventListener	(	int	id,
		bool	suspend
	)

inherited

Pause or resume execution of an event listener.

Parameters

id	The event listeners unique identification number
suspend	True to suspend/pause or false to unsuspend/resume

See also: isEventListenerSuspended

Member Data Documentation

◆ eventEmitter_

EventEmitter ime::Object::eventEmitter_

protectedinherited

Event dispatcher.

Definition at line 289 of file Object.h.

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

Joint.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Ptr

Member Function Documentation

◆ canBodiesCollide()

◆ emitChange()

◆ emitDestruction()

◆ getBodyA()

◆ getBodyAWorldAnchorPoint()

◆ getBodyB()

◆ getBodyBWorldAnchorPoint()

◆ getClassName()

◆ getClassType()

◆ getObjectId()

◆ getReactionForce()

◆ getReactionTorque()

◆ getTag()

◆ getType()

◆ getUserData()

◆ isEventListenerSuspended()

◆ isSameObjectAs()

◆ onDestruction()

◆ onPropertyChange() [1/2]

◆ onPropertyChange() [2/2]

◆ removeEventListener() [1/2]

◆ removeEventListener() [2/2]

◆ setTag()

◆ suspendedEventListener()

Member Data Documentation

◆ eventEmitter_