Component for rendering a sprite using a texture. More...

#include <SpriteComponent.h>

Inheritance diagram for clt::SpriteComponent:

Public Member Functions
	SpriteComponent (Texture *pTexture, int DrawOrder=0)
	Constructs a SpriteComponent with the given texture and draw order.

	SpriteComponent ()=delete

	SpriteComponent (const SpriteComponent &)=delete

SpriteComponent &	operator= (const SpriteComponent &)=delete

virtual	~SpriteComponent ()
	Destructor. Removes this component from the renderer if it has an owner.

virtual void	SetOwner (Actor *pOwner) override
	Sets the owner actor for this component.

virtual void	SetTexture (Texture *pTexture)
	Sets the texture for this sprite.

virtual void	SetTexture (const std::string &pTexture)
	Sets the texture for this sprite by name or path.

void	SetFlipX (bool pFlip)
	Sets whether the sprite is flipped horizontally.

void	SetFlipY (bool pFlipY)
	Sets whether the sprite is flipped vertically.

bool	GetFlipX () const
	Gets whether the sprite is flipped horizontally.

bool	GetFlipY () const
	Gets whether the sprite is flipped vertically.

int	GetTexWidth () const
	Gets the width of the texture.

int	GetTexHeight () const
	Gets the height of the texture.

Texture *	GetTexture () const
	Gets the texture used by this sprite.

Public Member Functions inherited from clt::Component
	Component (int pUpdateOrder=0)
	Constructor for Component.

virtual	~Component ()=default
	Virtual destructor for Component.

virtual void	Start ()
	Called when the component is started.

virtual void	Update ()
	Called every frame to update the component.

virtual void	Destroy ()
	Called to destroy the component.

void	SetActive (bool pActive)
	Enables or disables the component.

void	OnDestroy ()
	Called when the component is destroyed.

bool	IsActive () const
	Checks if the component is enabled.

int	GetUpdateOrder () const
	Gets the update order of the component.

void	SetRelativeLocation (const Vector3 &loc)
	Sets the relative location of the component.

void	SetRelativeLocation (const Vector2 &loc)
	Sets the relative location of the component.

void	SetWorldLocation (const Vector3 &loc)
	Sets the world location of the component.

void	SetRelativeScale (const Vector3 &scale)
	Sets the relative scale of the component.

void	SetRelativeScale (const Vector2 &scale)
	Sets the relative scale of the component.

void	SetRelativeRotation (Quaternion rot)
	Sets the relative rotation of the component.

void	SetRelativeRotation (Vector3 rot)
	Sets the relative rotation of the component.

void	SetWorldRotation (const Quaternion &rot)
	Sets the world rotation of the component.

void	SetWorldRotation (const Vector3 &rot)
	Sets the world rotation of the component.

void	AddRelativeRotation (Vector3 rot)
	Adds a rotation to the current relative rotation.

void	SetRelativeRotation (float rot)
	Sets the relative rotation of the component.

void	SetRelativeTransform (Transform &transform)
	Sets the relative transform of the component.

Vector3	GetRelativeLocation () const
	Gets the relative location of the component.

Vector3	GetRelativeScale () const
	Gets the relative scale of the component.

Quaternion	GetRelativeRotation () const
	Gets the relative rotation of the component.

Vector3	GetRelativeRotationEuler () const
	Gets the relative rotation of the component as Euler angles.

Transform	GetRelativeTransform () const
	Gets the relative transform of the component.

Vector3	GetWorldLocation () const
	Gets the world location of the component.

Vector3	GetWorldScale () const
	Gets the world scale of the component.

Quaternion	GetWorldRotation () const
	Gets the world rotation of the component.

virtual Transform	GetWorldTransform () const
	Gets the world transform of the component.

Actor *	GetOwner () const
	Gets the owner actor of this component.

Protected Attributes
int	mTexWidth

int	mTexHeight

bool	mFlipX

bool	mFlipY

Texture *	mTexture

Protected Attributes inherited from clt::Component
bool	mIsActive = true
	Indicates if the component is active.

int	mUpdateOrder = 0
	The order in which the component is updated.

Actor *	mOwner
	The actor that owns this component.

Transform	mRelativeTransform
	The relative transform of the component to its owner.

Additional Inherited Members
Public Attributes inherited from clt::Component
friend	Actor

Protected Member Functions inherited from clt::Component
bool	LineTrace (Vector3 start, Vector3 direction, float maxDistance, raycastHit &hit, bool debugPersistant=false)
	Performs a line trace (raycast) using the owning actor.

Detailed Description

Component for rendering a sprite using a texture.

Handles texture assignment, flipping, and integration with the renderer.

Constructor & Destructor Documentation

◆ SpriteComponent() [1/3]

SpriteComponent::SpriteComponent	(	Texture *	pTexture,
		int	DrawOrder = 0 )

Constructs a SpriteComponent with the given texture and draw order.

Parameters

pTexture	Pointer to the texture to use.
DrawOrder	Draw order for rendering (default is 0).

◆ SpriteComponent() [2/3]

clt::SpriteComponent::SpriteComponent ( )

delete

Deleted default constructor.

◆ SpriteComponent() [3/3]

clt::SpriteComponent::SpriteComponent ( const SpriteComponent & )

delete

Deleted copy constructor.

Member Function Documentation

◆ GetFlipX()

bool clt::SpriteComponent::GetFlipX ( ) const

inline

Gets whether the sprite is flipped horizontally.

Returns: True if flipped horizontally, false otherwise.

◆ GetFlipY()

bool clt::SpriteComponent::GetFlipY ( ) const

inline

Gets whether the sprite is flipped vertically.

Returns: True if flipped vertically, false otherwise.

◆ GetTexHeight()

int clt::SpriteComponent::GetTexHeight ( ) const

inline

Gets the height of the texture.

Returns: Texture height in pixels.

◆ GetTexture()

Texture * clt::SpriteComponent::GetTexture ( ) const

inline

Gets the texture used by this sprite.

Returns: Pointer to the texture.

◆ GetTexWidth()

int clt::SpriteComponent::GetTexWidth ( ) const

inline

Gets the width of the texture.

Returns: Texture width in pixels.

◆ operator=()

SpriteComponent & clt::SpriteComponent::operator= ( const SpriteComponent & )

delete

Deleted copy assignment operator.

◆ SetFlipX()

void clt::SpriteComponent::SetFlipX ( bool pFlip )

inline

Sets whether the sprite is flipped horizontally.

Parameters

pFlip True to flip horizontally, false otherwise.

◆ SetFlipY()

void clt::SpriteComponent::SetFlipY ( bool pFlipY )

inline

Sets whether the sprite is flipped vertically.

Parameters

pFlipY True to flip vertically, false otherwise.

◆ SetOwner()

void SpriteComponent::SetOwner ( Actor * pOwner )

overridevirtual

Sets the owner actor for this component.

Parameters

pOwner Pointer to the owner actor.

Reimplemented from clt::Component.

Reimplemented in clt::FlipbookComponent.

◆ SetTexture() [1/2]

void SpriteComponent::SetTexture ( const std::string & pTexture )

virtual

Sets the texture for this sprite by name or path.

Parameters

pTexture Name or path of the texture asset.

◆ SetTexture() [2/2]

void SpriteComponent::SetTexture ( Texture * pTexture )

virtual

Sets the texture for this sprite.

Parameters

pTexture Pointer to the texture to use.

Member Data Documentation

◆ mFlipX

bool clt::SpriteComponent::mFlipX

protected

Whether the sprite is flipped horizontally.

◆ mFlipY

bool clt::SpriteComponent::mFlipY

protected

Whether the sprite is flipped vertically.

◆ mTexHeight

int clt::SpriteComponent::mTexHeight

protected

Height of the texture in pixels.

◆ mTexture

Texture* clt::SpriteComponent::mTexture

protected

Pointer to the texture used by the sprite.

◆ mTexWidth

int clt::SpriteComponent::mTexWidth

protected

Width of the texture in pixels.

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

D:/DEV JEUX/2025/CPP/Opengl/ClutterEngineOpenGL/ClutterEngine/Engine/Core/ActorComponent/Components/Graphics/Sprite/SpriteComponent.h
D:/DEV JEUX/2025/CPP/Opengl/ClutterEngineOpenGL/ClutterEngine/Engine/Core/ActorComponent/Components/Graphics/Sprite/SpriteComponent.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SpriteComponent() [1/3]

◆ SpriteComponent() [2/3]

◆ SpriteComponent() [3/3]

Member Function Documentation

◆ GetFlipX()

◆ GetFlipY()

◆ GetTexHeight()

◆ GetTexture()

◆ GetTexWidth()

◆ operator=()

◆ SetFlipX()

◆ SetFlipY()

◆ SetOwner()

◆ SetTexture() [1/2]

◆ SetTexture() [2/2]

Member Data Documentation

◆ mFlipX

◆ mFlipY

◆ mTexHeight

◆ mTexture

◆ mTexWidth