Inheritance diagram for fge::ObjSpriteCluster:

Public Types
enum class	DrawModes : uint8_t { DRAW_IF_ON_TARGET , DRAW_ALWAYS_HIDDEN , DRAW_ALWAYS_DRAWN , DRAW_DEFAULT = DRAW_IF_ON_TARGET }

enum class	CallbackContextModes : uint8_t { CONTEXT_MANUAL , CONTEXT_AUTO , CONTEXT_DEFAULT = CONTEXT_AUTO }

enum	ChildrenControlFlags : uint8_t { CHILDREN_AUTO_CLEAR_ON_REMOVE = 1 << 0 , CHILDREN_AUTO_UPDATE = 1 << 1 , CHILDREN_AUTO_DRAW = 1 << 2 , CHILDREN_DEFAULT = CHILDREN_AUTO_CLEAR_ON_REMOVE }

using	ChildrenControlFlags_t = std::underlying_type_t<ChildrenControlFlags>

enum class	Types : uint8_t { ANCHOR_NONE , ANCHOR_UPLEFT_CORNER , ANCHOR_UPRIGHT_CORNER , ANCHOR_DOWNLEFT_CORNER , ANCHOR_DOWNRIGHT_CORNER }

enum class	Shifts : uint8_t { SHIFT_NONE , SHIFT_POSITIVE_BOUNDS , SHIFT_NEGATIVE_BOUNDS }

Public Member Functions
	ObjSpriteCluster (ObjSpriteCluster const &r)

	ObjSpriteCluster (fge::Texture texture)

fge::Object *	copy () override
	Duplicate the object.

void	setTexture (fge::Texture texture)

void	clear ()

void	addSprite (fge::RectInt const &rectangle, fge::Vector2f const &offset={0.0f, 0.0f})

void	resize (std::size_t size)

void	setTextureRect (std::size_t index, fge::RectInt const &rectangle)

void	setColor (std::size_t index, fge::Color const &color)

void	setOffset (std::size_t index, fge::Vector2f const &offset)

fge::Texture const &	getTexture () const

std::optional< fge::RectInt >	getTextureRect (std::size_t index) const

std::optional< fge::Color >	getColor (std::size_t index) const

std::optional< fge::Vector2f >	getOffset (std::size_t index) const

void	draw (fge::RenderTarget &target, const fge::RenderStates &states) const override
	Method called every frame to draw the object.

void	save (nlohmann::json &jsonObject, fge::Scene *scene) override
	Save the object to a json object.

void	load (nlohmann::json &jsonObject, fge::Scene *scene) override
	Load the object from a json object.

void	pack (fge::net::Packet &pck) override
	Pack the object into a packet.

void	unpack (fge::net::Packet const &pck) override
	Unpack the object from a packet.

char const *	getClassName () const override
	Get the unique class name of the object.

char const *	getReadableClassName () const override
	Get a readable version of the class name.

fge::RectFloat	getGlobalBounds () const override
	Get the global bounds of the object.

std::optional< fge::RectFloat >	getGlobalBounds (std::size_t index) const

fge::RectFloat	getLocalBounds () const override
	Get the local bounds of the object (without any transformations)

std::optional< fge::RectFloat >	getLocalBounds (std::size_t index) const

virtual void	first (fge::Scene &scene)
	Method called when the object is added to a scene for initialization purposes.

virtual void	transfered (fge::Scene &oldScene, fge::Scene &newScene)
	Method called when the object is transferred from a scene to another.

virtual void	callbackRegister (fge::Event &event, fge::GuiElementHandler *guiElementHandlerPtr)
	Ask the object to register all callbacks it needs to receive events.

virtual void	update (fge::RenderWindow &screen, fge::Event &event, std::chrono::microseconds const &deltaTime, fge::Scene &scene)
	Main method called every frame.

void	update (fge::RenderWindow &screen, fge::Event &event, std::chrono::microseconds const &deltaTime)

virtual void	networkRegister ()
	Register all network types needed by the object.

virtual void	netSignaled (int8_t signal)
	Method called when the object is signaled by the network.

virtual void	removed (fge::Scene &scene)
	Method called when the object is removed from a scene.

virtual fge::Quad	getGlobalQuad () const

virtual fge::Quad	getLocalQuad () const

bool	saveInFile (std::string const &path)
	Save the object in a file.

bool	loadFromFile (std::string const &path)
	Load the object from a file.

virtual fge::GuiElement *	getGuiElement ()
	Get the GuiElement attached to this object if there is one.

glm::mat4	getParentsTransform () const
	Retrieve recursively all parents transform by combining them.

fge::Vector2f	getParentsScale () const
	Retrieve recursively all parents scale by combining them.

void	setPosition (Vector2f const &position)

Vector2f const &	getPosition () const

void	move (Vector2f const &offset)

void	setRotation (float angle)

float	getRotation () const

void	rotate (float angle)

void	setScale (Vector2f const &factors)

void	setScale (float factor)

Vector2f const &	getScale () const

void	scale (Vector2f const &factor)

void	scale (float factor)

void	setOrigin (Vector2f const &origin)

Vector2f const &	getOrigin () const

glm::mat4 const &	getTransform () const

glm::mat4 const &	getInverseTransform () const

void	updateAnchor (fge::Vector2f const &customTargetSize={0.0f, 0.0f})

void	setAnchor (Types type, fge::Vector2< Shifts > const &shift, fge::ObjectSid target=std::numeric_limits< fge::ObjectSid >::max())

void	setAnchorType (Types type)

void	setAnchorShift (fge::Vector2< Shifts > const &shift)

void	setAnchorTarget (fge::ObjectSid target)

Types	getAnchorType () const

fge::Vector2< Shifts > const &	getAnchorShift () const

fge::ObjectSid	getAnchorTarget () const

fge::Object *	getAnchorOwner () const

void	setAnchorSuccessor (fge::ObjectDataWeak successor)

fge::ObjectDataWeak	getAnchorSuccessor () const

void	needAnchorUpdate (bool flag)

bool	isNeedingAnchorUpdate () const

Static Public Member Functions
static fge::Object *	LoadFromFile (std::string const &path)
	Static form of the loadFromFile method.

Public Attributes
fge::TagList	_tags
	The tags of the object.

fge::PropertyList	_properties
	The properties of the object.

fge::net::NetworkTypeHandler	_netList
	The network types container of the object.

fge::ObjectDataWeak	_myObjectData
	The object data of the object (valid only if the object is in a scene)

fge::Object::DrawModes	_drawMode
	Tell a scene when this object should be drawn.

fge::Object::CallbackContextModes	_callbackContextMode
	Tell a scene how the callbackRegister must be called.

ChildrenControlFlags_t	_childrenControlFlags {CHILDREN_DEFAULT}
	The control flags of the child objects.

fge::ChildObjectsAccessor	_children
	An access to child objects of this object.

Member Function Documentation

◆ callbackRegister()

virtual void fge::Object::callbackRegister	(	fge::Event &	event,
		fge::GuiElementHandler *	guiElementHandlerPtr )

virtualinherited

Ask the object to register all callbacks it needs to receive events.

Parameters

event	The event system
guiElementHandlerPtr	The GUI element handler

Reimplemented in fge::ObjButton, fge::ObjSelectBox, fge::ObjSlider, fge::ObjTextInputBox, fge::ObjTextList, and fge::ObjWindow.

◆ copy()

fge::Object * fge::ObjSpriteCluster::copy ( )

inlineoverridevirtual

Duplicate the object.

By default, if the copy method is not overridden, the object is duplicated with the help of the register manager (and the object class have to be registered).

Returns: A allocated pointer to the duplicated object

Reimplemented from fge::Object.

◆ draw()

void fge::ObjSpriteCluster::draw	(	fge::RenderTarget &	target,
		const fge::RenderStates &	states ) const

overridevirtual

Method called every frame to draw the object.

Parameters

target	The target where the object is drawn
states	The render states

Reimplemented from fge::Object.

◆ first()

virtual void fge::Object::first ( fge::Scene & scene )

virtualinherited

Method called when the object is added to a scene for initialization purposes.

Parameters

scene The scene where the object is added

Reimplemented in fge::ObjLight, fge::ObjRenderMap, fge::ObjShaderChain, fge::ObjShape, fge::ObjSlider, fge::ObjTextList, and fge::ObjWindow.

◆ getClassName()

char const * fge::ObjSpriteCluster::getClassName ( ) const

overridevirtual

Get the unique class name of the object.

Returns: The unique class name of the object

Reimplemented from fge::Object.

◆ getGlobalBounds()

fge::RectFloat fge::ObjSpriteCluster::getGlobalBounds ( ) const

nodiscardoverridevirtual

Get the global bounds of the object.

Returns: The global bounds of the object

Reimplemented from fge::Object.

◆ getGuiElement()

virtual fge::GuiElement * fge::Object::getGuiElement ( )

virtualinherited

Get the GuiElement attached to this object if there is one.

Returns: The GuiElement pointer or nullptr

Reimplemented in fge::ObjButton, fge::ObjSelectBox, fge::ObjSlider, fge::ObjTextInputBox, and fge::ObjWindow.

◆ getLocalBounds()

fge::RectFloat fge::ObjSpriteCluster::getLocalBounds ( ) const

nodiscardoverridevirtual

Get the local bounds of the object (without any transformations)

Returns: The local bounds of the object

Reimplemented from fge::Object.

◆ getParentsScale()

fge::Vector2f fge::Object::getParentsScale ( ) const

inherited

Retrieve recursively all parents scale by combining them.

Returns: Parents scale

◆ getParentsTransform()

glm::mat4 fge::Object::getParentsTransform ( ) const

inherited

Retrieve recursively all parents transform by combining them.

Returns: Parents transform

◆ getReadableClassName()

char const * fge::ObjSpriteCluster::getReadableClassName ( ) const

overridevirtual

Get a readable version of the class name.

Returns: A readable version of the class name

Reimplemented from fge::Object.

◆ load()

void fge::ObjSpriteCluster::load	(	nlohmann::json &	jsonObject,
		fge::Scene *	scene )

overridevirtual

Load the object from a json object.

Parameters

jsonObject	The json object where the object is loaded
scene	The scene where the object is loaded (can be nullptr)

Reimplemented from fge::Object.

◆ LoadFromFile()

static fge::Object * fge::Object::LoadFromFile ( std::string const & path )

staticinherited

Static form of the loadFromFile method.

Parameters

path	The path of the file

Returns: The allocated pointer of the loaded object or nullptr if the object was not loaded

◆ loadFromFile()

bool fge::Object::loadFromFile ( std::string const & path )

inherited

Load the object from a file.

Parameters

path	The path of the file

Returns: true if the object was loaded, false otherwise

◆ netSignaled()

virtual void fge::Object::netSignaled ( int8_t signal )

virtualinherited

Method called when the object is signaled by the network.

Parameters

signal The signal received

◆ networkRegister()

virtual void fge::Object::networkRegister ( )

virtualinherited

Register all network types needed by the object.

◆ pack()

void fge::ObjSpriteCluster::pack ( fge::net::Packet & pck )

overridevirtual

Pack the object into a packet.

Parameters

pck	The packet where the object is packed

Reimplemented from fge::Object.

◆ removed()

virtual void fge::Object::removed ( fge::Scene & scene )

virtualinherited

Method called when the object is removed from a scene.

Parameters

scene The scene where the object is removed

Reimplemented in fge::ObjRenderMap, and fge::ObjWindow.

◆ save()

void fge::ObjSpriteCluster::save	(	nlohmann::json &	jsonObject,
		fge::Scene *	scene )

overridevirtual

Save the object to a json object.

Parameters

jsonObject	The json object where the object is saved
scene	The scene where the object is saved (can be nullptr)

Reimplemented from fge::Object.

◆ saveInFile()

bool fge::Object::saveInFile ( std::string const & path )

inherited

Save the object in a file.

Parameters

path	The path of the file

Returns: true if the object was saved, false otherwise

◆ transfered()

virtual void fge::Object::transfered	(	fge::Scene &	oldScene,
		fge::Scene &	newScene )

virtualinherited

Method called when the object is transferred from a scene to another.

This method is called after the object is removed from the old scene and added to the new scene. The _myObjectData is updated to the new scene when this method is called.

Parameters

oldScene	The old scene where the object was
newScene	The new scene where the object is

◆ unpack()

void fge::ObjSpriteCluster::unpack ( fge::net::Packet const & pck )

overridevirtual

Unpack the object from a packet.

Parameters

pck	The packet where the object is unpacked

Reimplemented from fge::Object.

◆ update()

virtual void fge::Object::update	(	fge::RenderWindow &	screen,
		fge::Event &	event,
		std::chrono::microseconds const &	deltaTime,
		fge::Scene &	scene )

virtualinherited

Main method called every frame.

Parameters

screen	The screen where the object is drawn
event	The event system
deltaTime	The time since the last frame
scene	The scene where the object is updated

Reimplemented in fge::ObjAnimation, fge::ObjLight, fge::ObjRenderMap, fge::ObjSwitch, and fge::ObjWindow.

Member Data Documentation

◆ _callbackContextMode

fge::Object::CallbackContextModes fge::Object::_callbackContextMode

inherited

Initial value:

{
            fge::Object::CallbackContextModes::
                    CONTEXT_DEFAULT}

Tell a scene how the callbackRegister must be called.

◆ _children

fge::ChildObjectsAccessor fge::Object::_children

inherited

An access to child objects of this object.

◆ _childrenControlFlags

ChildrenControlFlags_t fge::Object::_childrenControlFlags {CHILDREN_DEFAULT}

inherited

The control flags of the child objects.

◆ _drawMode

fge::Object::DrawModes fge::Object::_drawMode

inherited

Initial value:

{

fge::Object::DrawModes::DRAW_DEFAULT}

Tell a scene when this object should be drawn.

◆ _myObjectData

fge::ObjectDataWeak fge::Object::_myObjectData

inherited

The object data of the object (valid only if the object is in a scene)

◆ _netList

fge::net::NetworkTypeHandler fge::Object::_netList

inherited

The network types container of the object.

◆ _properties

fge::PropertyList fge::Object::_properties

inherited

The properties of the object.

◆ _tags

fge::TagList fge::Object::_tags

inherited

The tags of the object.

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

C_objSpriteCluster.hpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Member Function Documentation

◆ callbackRegister()

◆ copy()

◆ draw()

◆ first()

◆ getClassName()

◆ getGlobalBounds()

◆ getGuiElement()

◆ getLocalBounds()

◆ getParentsScale()

◆ getParentsTransform()

◆ getReadableClassName()

◆ load()

◆ LoadFromFile()

◆ loadFromFile()

◆ netSignaled()

◆ networkRegister()

◆ pack()

◆ removed()

◆ save()

◆ saveInFile()

◆ transfered()

◆ unpack()

◆ update()

Member Data Documentation

◆ _callbackContextMode

◆ _children

◆ _childrenControlFlags

◆ _drawMode

◆ _myObjectData

◆ _netList

◆ _properties

◆ _tags