ime::Object Class Reference

An abstract top-level base class for IME objects. More...

#include <Object.h>

Inheritance diagram for ime::Object:

Public Types
using	Ptr = std::unique_ptr< Object >
	Unique object pointer. More...

Public Member Functions
	Object ()
	Default constructor. More...
	Object (const Object &)
	Copy constructor. More...
Object &	operator= (const Object &)
	Copy assignment operator. More...
	Object (Object &&) noexcept=default
	Move constructor. More...
Object &	operator= (Object &&) noexcept=default
	Move assignment operator. More...
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...
virtual std::string	getClassType () const
	Get the name of the direct parent of an object instance. 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...
virtual	~Object ()
	Destructor. 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

An abstract top-level base class for IME objects.

This class is intended to group all IME objects under a common ancestor.

However, not all classes in IME inherited from it. The extension of ime::Object is not restricted to internal classes only, classes outside of IME may also extend if need be

Definition at line 40 of file Object.h.

Member Typedef Documentation

Ptr

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

Unique object pointer.

Definition at line 42 of file Object.h.

Constructor & Destructor Documentation

Object() [1/3]

ime::Object::Object

(

)

Default constructor.

Object() [2/3]

ime::Object::Object

(

const Object &

)

Copy constructor.

Object() [3/3]

ime::Object::Object ( Object &&  )

defaultnoexcept

Move constructor.

~Object()

virtual ime::Object::~Object ( )

virtual

Destructor.

Member Function Documentation

emitChange()

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

protected

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 ( )

protected

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

getClassName()

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

pure virtual

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()

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

virtual

Get the name of the direct parent of an object instance.

Returns

The name of the direct parent of an object instance

In contrast to getClassName() which returns the name of the concrete class, this function returns the name of the concrete class's base class. This function is implemented by all derived classes of ime::Object which also serve as base classes. For classes whose direct parent is this class, this function will return the name of this class

auto rectangle = ime::RectangleShape(); // RectangleShape is derived from Shape
std::cout << rectangle->getClassName(); // Prints "RectangleShape"
std::cout << rectangle->getClassType(); // Prints "Shape"

See also

getClassName

Reimplemented in ime::audio::Audio, ime::GameObject, ime::GridMover, ime::Collider, ime::Joint, ime::Drawable, ime::Shape, and ime::SpriteImage.

getObjectId()

unsigned int ime::Object::getObjectId

(

)

const

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

getTag()

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

(

)

const

Get the tag assigned to the object.

Returns

The tag of the object

See also

setTag

isEventListenerSuspended()

bool ime::Object::isEventListenerSuspended

(

int

id

)

const

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

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

)

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
	)

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
	)

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>&)

operator=() [1/2]

Object & ime::Object::operator=

(

const Object &

)

Copy assignment operator.

operator=() [2/2]

Object & ime::Object::operator= ( Object &&  )

defaultnoexcept

Move assignment operator.

removeEventListener() [1/2]

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

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

)

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

)

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
	)

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_

protected

Event dispatcher.

Definition at line 289 of file Object.h.

---

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

• Object.h