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 (const std::string &sourceTexture, UIntRect area={})
	Constructor. 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=0
	Destructor. 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...

virtual std::string	getClassName () const =0
	Get the name of the concrete class. 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
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	emit (const std::string &event)
	Dispatch an action event. 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/3]

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

FileNotFound 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() [2/3]

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

default

Copy constructor.

◆ SpriteImage() [3/3]

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

defaultnoexcept

Move constructor.

◆ ~SpriteImage()

ime::SpriteImage::~SpriteImage ( )

overridepure virtual

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

◆ 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

◆ getClassName()

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

pure virtualinherited

Get the name of the concrete class.

Returns: The name of the objects concrete class

This function is implemented by all internal classes that inherit from this class.

See also: getClassType

Implemented in ime::Tile, ime::SpriteSheet, ime::Sprite, ime::RectangleShape, ime::ConvexShape, ime::CircleShape, ime::Camera, ime::Scene, ime::RenderLayerContainer, ime::RenderLayer, ime::TargetGridMover, ime::RandomGridMover, ime::KeyboardGridMover, ime::DistanceJoint, ime::PolygonCollider, ime::EdgeCollider, ime::CircleCollider, ime::BoxCollider, ime::Body, ime::AABB, and ime::GameObject.

◆ 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 id of the object.

Returns: The id of the object

Each object has a unique id

◆ 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 alias of the object.

Returns: The alias of the object

See also: setTag and getObjectId

◆ 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

◆ 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=() [1/2]

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

default

Copy assignment operator.

◆ operator=() [2/2]

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

defaultnoexcept

Move assignment 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

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

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

SpriteImage.h

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ Ptr

Constructor & Destructor Documentation

◆ SpriteImage() [1/3]

◆ SpriteImage() [2/3]

◆ SpriteImage() [3/3]

◆ ~SpriteImage()

Member Function Documentation

◆ contains()

◆ emit()

◆ emitChange()

◆ getClassName()

◆ getClassType()

◆ getHeight()

◆ getObjectId()

◆ getRelativePosition()

◆ getSize()

◆ getTag()

◆ getTexture()

◆ getWidth()

◆ onDestruction()

◆ onEvent()

◆ onPropertyChange() [1/2]

◆ onPropertyChange() [2/2]

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ removeDestructionListener()

◆ setTag()

◆ unsubscribe()