Abstract base class for image containers. More...

#include <SpriteImage.h>

Inheritance diagram for ime::SpriteImage:

Public Types
using	Ptr = std::shared_ptr< SpriteImage >
	A shared sprite pointer. More...

Public Member Functions
	SpriteImage ()
	Default constructor. More...

	SpriteImage (const std::string &sourceTexture, UIntRect area={})
	Constructor. More...

void	create (const std::string &sourceTexture, UIntRect area={})
	Create the sprite image. More...

	SpriteImage (const SpriteImage &)=default
	Copy constructor. More...

SpriteImage &	operator= (const SpriteImage &)=default
	Copy assignment operator. More...

	SpriteImage (SpriteImage &&) noexcept=default
	Move constructor. More...

SpriteImage &	operator= (SpriteImage &&) noexcept=default
	Move assignment operator. More...

Vector2u	getSize () const
	Get the size of the sprite image in pixels. More...

unsigned int	getWidth () const
	Get the width of the sprite image in pixels. More...

unsigned int	getHeight () const
	Get the height of the sprite image in pixels. More...

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

const Texture &	getTexture () const
	Get the source texture of the sprite image. More...

Vector2u	getRelativePosition () const
	Get the top-left position of the sprite image relative to the sprite image source texture. More...

	~SpriteImage () override
	Destructor. 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...

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
bool	contains (Vector2u point) const
	Check if the sprite image contains a point or not. More...

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

Abstract base class for image containers.

A sprite image is a collection of smaller images packed together into a single image. The sub-images may be of the same size or of varying dimensions. In addition, the sub-images may be arranged in grid formation or tightly packed next to each other in the sprite image. A sprite image simplifies file management and increases performance as we only have to deal with a single texture instead of multiple textures. For example, imagine a character which has a walking and running animation in all four directions (Up, right. down and left) and each animation has 15 frames. This would require 120 individual images files!. With a sprite image all that information can be stored in a single image file and accessed later using coordinates or indexes

Definition at line 51 of file SpriteImage.h.

Member Typedef Documentation

◆ Ptr

using ime::SpriteImage::Ptr = std::shared_ptr<SpriteImage>

A shared sprite pointer.

Definition at line 53 of file SpriteImage.h.

Constructor & Destructor Documentation

◆ SpriteImage() [1/4]

ime::SpriteImage::SpriteImage ( )

Default constructor.

Warning: This constructor creates an empty sprite image. You must call create() before using the class, not doing so leads to undefined behavior

See also: create

◆ SpriteImage() [2/4]

ime::SpriteImage::SpriteImage	(	const std::string &	sourceTexture,
		UIntRect	area = `{}`
	)

explicit

Constructor.

Parameters

sourceTexture	The filename of the sprite image on the disk
area	Sub-rectangle to construct sprite image from

Exceptions

FileNotFoundException If the image could not be found on the disk

The area can be used to construct the sprite image from a sub-rectangle of the sourceTexture. To construct the sprite image from the whole sourceTexture (default), leave the area argument unspecified. If the area rectangle crosses the bounds of the sourceTexture, it is adjusted to fit the sourceTexture size

◆ SpriteImage() [3/4]

ime::SpriteImage::SpriteImage ( const SpriteImage & )

default

Copy constructor.

◆ SpriteImage() [4/4]

ime::SpriteImage::SpriteImage ( SpriteImage && )

defaultnoexcept

Move constructor.

◆ ~SpriteImage()

ime::SpriteImage::~SpriteImage ( )

override

Destructor.

Member Function Documentation

◆ contains()

bool ime::SpriteImage::contains ( Vector2u point ) const

protected

Check if the sprite image contains a point or not.

Parameters

point The point to be checked

Returns: True if the sprite image contains the point otherwise false

◆ create()

void ime::SpriteImage::create	(	const std::string &	sourceTexture,
		UIntRect	area = `{}`
	)

Create the sprite image.

Parameters

sourceTexture	The filename of the sprite image on the disk
area	Sub-rectangle to construct sprite image from

Exceptions

FileNotFoundException If the image could not be found on the disk

The area can be used to construct the sprite image from a sub-rectangle of the sourceTexture. To construct the sprite image from the whole sourceTexture (default), leave the area argument unspecified. If the area rectangle crosses the bounds of the sourceTexture, it is adjusted to fit the sourceTexture size

Note: Only use this function if you've previously created an empty sprite image

See also: SpriteImage()

◆ 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

◆ 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::SpriteImage::getClassType ( ) const

overridevirtual

Get the name of this class.

Returns: The name of this class

Note that this function is only overridden 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.

◆ getHeight()

unsigned int ime::SpriteImage::getHeight ( ) const

Get the height of the sprite image in pixels.

Returns: The height of the sprite image in pixels

◆ 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

◆ getRelativePosition()

Vector2u ime::SpriteImage::getRelativePosition ( ) const

Get the top-left position of the sprite image relative to the sprite image source texture.

Returns: The relative top-left position

If the sprite image was created from the whole source texture, this function returns {0, 0}

See also: SpriteImage

◆ getSize()

Vector2u ime::SpriteImage::getSize ( ) const

Get the size of the sprite image in pixels.

Returns: The size of the sprite image in pixels

The x component is width whilst the y component is the height of the sprite image

◆ 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

◆ getTexture()

const Texture & ime::SpriteImage::getTexture ( ) const

Get the source texture of the sprite image.

Returns: The source texture of the sprite image

Warning: Don't call this function when the sprite image is not yet created. Also, the texture is destroyed when the sprite image is destroyed, exercise caution when there are Sprite objects referencing the sprite image texture

See also: create

◆ getWidth()

unsigned int ime::SpriteImage::getWidth ( ) const

Get the width of the sprite image in pixels.

Returns: The width of the sprite image in pixels

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

◆ operator=() [1/2]

SpriteImage & ime::SpriteImage::operator= ( const SpriteImage & )

default

Copy assignment operator.

◆ operator=() [2/2]

SpriteImage & ime::SpriteImage::operator= ( SpriteImage && )

defaultnoexcept

Move assignment operator.

◆ 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:

SpriteImage.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ SpriteImage() [1/4]

◆ SpriteImage() [2/4]

◆ SpriteImage() [3/4]

◆ SpriteImage() [4/4]

◆ ~SpriteImage()

Member Function Documentation

◆ contains()

◆ create()

◆ emitChange()

◆ emitDestruction()

◆ getClassName()

◆ getClassType()

◆ getHeight()

◆ getObjectId()

◆ getRelativePosition()

◆ getSize()

◆ getTag()

◆ getTexture()

◆ getWidth()

◆ isEventListenerSuspended()

◆ isSameObjectAs()

◆ onDestruction()

◆ onPropertyChange() [1/2]

◆ onPropertyChange() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ removeEventListener() [1/2]

◆ removeEventListener() [2/2]

◆ setTag()

◆ suspendedEventListener()

Member Data Documentation

◆ eventEmitter_