The TextSprite class defines the text sprite from JugiMap Editor. More...

#include <jmSprites.h>

Inherits Sprite.

Inherited by TextSpriteAGK, TextSpriteCC, TextSpriteNC, and TextSpriteSFML.

Public Member Functions
	TextSprite ()
	Constructor. More...

virtual void	InitEngineObjects () override
	Initialize the engine sprite. More...

virtual void	CopyProperties (Sprite *_sprite, int copyFlags) override
	Copy properties from the given _sprite. More...

virtual void	UpdateBoundingBox () override
	Update the map bounding box of this sprite. More...

virtual bool	PointInside (Vec2f _pos) override
	Returns true if the given point _pos is inside the shape(s) of this sprite; otherwise returns false. More...

Font *	GetFont ()
	Returns the font of this text sprite. More...

void	SetTextString (const std::string &_textString)
	Set the text string of this text sprite to the given _textString. More...

std::string	GetTextString ()
	Returns the string of this text sprite. More...

void	SetColor (ColorRGBA _color)
	Set the color of this text sprite to the given _color. More...

ColorRGBA	GetColor ()
	Returns the color of this text sprite. More...

float	GetHeight ()
	Returns the height of this text sprite. More...

float	GetWidth ()
	Returns the width of this text sprite. More...

Vec2f	GetSize ()
	Returns the size of this text sprite. More...

Vec2f	GetRelativeHandle ()
	Returns the relative handle of this text sprite. More...

void	_SetSize (Vec2f _size)
	Set this text sprite to be clickable. More...

Public Member Functions inherited from Sprite
	Sprite ()
	Constructor. More...

Sprite *	MakePassiveCopy ()
	Create a new sprite which is a passive copy of this sprite. More...

Sprite *	MakeActiveCopy ()
	Create a new sprite which is an active copy of this sprite. More...

virtual void	UpdateEngineObjects ()
	Update the engine sprite. More...

virtual void	DrawEngineSprite ()
	Draw the engine sprite. More...

virtual bool	IsEngineSpriteInitialized ()
	Returns true if the engine sprite of this sprite has been initialized; otherwise returns false. More...

virtual void	SetVisible (bool _visible)
	Set the visibility of this sprite. More...

bool	IsVisible ()
	Returns true if this sprite is visible; otherwise returns false. More...

void	SetDisabledEngineSpriteUpdate (bool _engineSpriteUsedDirectly)
	Set a boolean flag which indicates if this sprite's engine sprite is used directly. More...

bool	IsEngineSpriteUsedDirectly ()
	Returns true if this sprite's engine sprite is used directly. More...

Rectf	GetBoundingBox ()
	Returns the world bounding rectangle of this sprite. More...

virtual void	CaptureForLerpDrawing ()
	Capture the sprite properties, usually the position only, required for the lerp drawing. More...

SpriteLayer *	GetLayer ()
	Returns a sprite layer where this sprite is stored. More...

SourceSprite *	GetSourceSprite ()
	Returns the source sprite of this sprite. More...

ComposedSprite *	GetParentComposedSprite ()
	Returns the parent composed sprite of this sprite. More...

SpriteKind	GetKind ()
	Returns the kind of this sprite. More...

void	SetId (int _id)
	Set the id of this sprite to the given _id. More...

int	GetId ()
	Returns the id of this sprite. More...

void	SetName (const std::string &_nameID)
	Set the name of this sprite to the given _nameID. More...

std::string	GetName ()
	Returns the name of this sprite. More...

void	SetTag (int _tag)
	Set the tag of this sprite to the given _tag. More...

int	GetTag ()
	Returns the tag of this sprite. More...

void	SetCustomObject (CustomObject *_customObject)
	Assign a custom object of this sprite to the given _customObject. More...

CustomObject *	GetCustomObject ()
	Returns the custom object of this sprite if exists; otherwise returns nullptr. More...

std::vector< jugimap::Parameter > &	GetParameters ()
	Returns a reference to the vector of stored parameters in this sprite. More...

int	GetDataFlags ()
	Returns the dataFlags of this sprite. More...

void	SetPosition (Vec2f _position)
	Set the position of this sprite to the given _position. More...

Vec2f	GetPosition (bool _includeAnimatedProperties=true)
	Returns the position of this sprite. More...

Vec2f	GetGlobalPosition (bool _includeAnimatedProperties=true)
	Returns the global position of this sprite. More...

void	SetScale (Vec2f _scale)
	Set the horizontal and vertical scale factor of this sprite to the given _scale. More...

Vec2f	GetScale (bool _includeAnimatedProperties=true)
	Returns the horizontal and vertical scale factor of this sprite. More...

Vec2f	GetGlobalScale (bool _includeAnimatedProperties=true)
	Returns the global scale factor of this sprite. More...

void	SetRotation (float _rotation)
	Set the rotation of this sprite to the given _rotation. More...

float	GetRotation (bool _includeAnimatedProperties=true)
	Returns the rotation of this sprite in degrees. More...

float	GetGlobalRotation (bool _includeAnimatedProperties=true)
	Returns the global rotation of this sprite. More...

void	SetFlip (Vec2i _flip)
	Set the horizontal and vertical flip factor of this sprite to the given _flip. More...

Vec2i	GetFlip (bool _includeAnimatedProperties=true)
	Returns the horizontal and vertical flip factor of this sprite. More...

Vec2i	GetGlobalFlip (bool _includeAnimatedProperties=true)
	Returns the horizontal and vertical world flip factor of this sprite. More...

virtual void	SetHandle (Vec2f _handle)
	Set the handle point of this sprite to the given _handle point. More...

Vec2f	GetHandle ()
	Returns the handle point of this sprite. More...

void	SetAlpha (float _alpha)
	Set the alpha of this sprite to the given _alpha. More...

float	GetAlpha (bool _includeAnimatedProperties=true)
	Returns the alpha of this sprite. More...

void	SetOwnBlend (Blend _blend)
	Set the own blend of this sprite to the given _blend. More...

Blend	GetOwnBlend ()
	Returns the own blend of this sprite. More...

void	SetColorOverlayActive (bool _colorOverlayActive)
	Set to true to make the color overlay active; set to false to disable the color overlay. More...

bool	IsOverlayColorActive ()
	Returns true if the overlay color of this sprite is active; otherwise returns false. More...

void	SetColorOverlayRGBA (ColorRGBA _colorOverlayRGBA)
	Set the color overlay of this sprite to the given _colorOverlayRGBA. More...

ColorRGBA	GetOverlayColorRGBA (bool _includeAnimatedProperties=true)
	Returns the overlay color of this sprite. More...

void	SetColorOverlayBlend (ColorOverlayBlend _colorOverlayBlend)
	Set the color overlay blend of this sprite to the given _colorOverlayBlend. More...

ColorOverlayBlend	GetOverlayColorBlend (bool _includeAnimatedProperties=true)
	Returns the overlay color blend of this sprite. More...

AnimatedProperties *	GetAnimatedProperties ()
	Returns the pre-animation properties. More...

virtual void	CreateAnimatedPropertiesIfNone ()
	Store current properties for animation purposes. More...

virtual void	ResetAnimatedProperties ()
	Set sprite properties to pre-animation state. More...

virtual void	AppendAnimatedProperties (AnimatedProperties &_ap)
	Set sprite properties from the given _ap object. More...

virtual bool	HasCollider ()
	Returns true if this sprite has assigned a collider; otherwise returns false. More...

virtual bool	Overlaps (Sprite *_sprite)
	Returns true if the shapes of this and the given _sprite overelaps; otherwise returns false. More...

virtual bool	RaycastHit (Vec2f _rayStart, Vec2f _rayEnd, Vec2f &_hitPos)
	Returns true if a ray (line segment) from _rayStart to _rayEnd 'hits' at the shape(s) of this sprite; otherwise return false. More...

void	SetChangeFlags (int _changeFlags)
	Set the change flags of this sprite to the given _changeFlags. More...

void	AppendToChangeFlags (int _changeFlags)
	Append the given _changeFlags to the change flags of this sprite with a biwise operation. /// The _changeFlags must be a value or a bitwise combination of values defined in the Property enumerator. More...

int	GetChangeFlags ()
	Returns the change flags of this sprite. More...

void	_SetSourceSprite (SourceSprite *_sourceSprite)
	Set the source sprite of this sprite to the given _sourceSprite. More...

void	_SetLayer (SpriteLayer *_spriteLayer)
	Set the layer of this sprite to the given _sourceSprite. More...

Additional Inherited Members
Public Types inherited from Sprite
enum	Property
	The Property enumerator provides flags for sprite properties. More...

Protected Member Functions inherited from Sprite
virtual	~Sprite ()
	Destructor. More...

Detailed Description

The TextSprite class defines the text sprite from JugiMap Editor.

Constructor & Destructor Documentation

◆ TextSprite()

TextSprite ( )

inline

Constructor.

Member Function Documentation

◆ InitEngineObjects()

void InitEngineObjects ( )

overridevirtual

Initialize the engine sprite.

This function creates and initialize the engine sprite. It gets called in the SpriteLayer::InitEngineLayer at the map engine initialization but we can use it also to initilaze sprites created with MakePassiveCopy.

Reimplemented from Sprite.

Reimplemented in TextSpriteAGK, TextSpriteSFML, TextSpriteNC, and TextSpriteCC.

◆ CopyProperties()

void CopyProperties	(	Sprite *	_sprite,
		int	copyFlags
	)

overridevirtual

Copy properties from the given **_sprite**.

The given copyFlags must consists of flags defined in the Property enumerator. Important: This function does not copy core sprite properties: source Sprite, layer, parentComposedSprite;

Reimplemented from Sprite.

◆ UpdateBoundingBox()

void UpdateBoundingBox ( )

overridevirtual

Update the map bounding box of this sprite.

The dimensions of bounding box are based on the size of the active texture. If a sprite is not scaled or rotated the bounding box and the texture have the same size. Usually you don't need to use this function as other functions call it when required.

Reimplemented from Sprite.

◆ PointInside()

bool PointInside ( Vec2f _pos )

overridevirtual

Returns true if the given point **_pos** is inside the shape(s) of this sprite; otherwise returns false.

The given point must be in global coordinate system. This function uses a sprite collider to obtain the result. It returns false if this sprite has no collider assigned.

See also: Collider

Reimplemented from Sprite.

◆ GetFont()

Font* GetFont ( )

inline

Returns the font of this text sprite.

◆ SetTextString()

void SetTextString ( const std::string & _textString )

Set the text string of this text sprite to the given _textString.

See also: GetTextString

◆ GetTextString()

std::string GetTextString ( )

inline

Returns the string of this text sprite.

See also: SetTextString

◆ SetColor()

void SetColor ( ColorRGBA _color )

Set the color of this text sprite to the given _color.

Only red, green and blue componenet will be used for the text color. Alpha component is set with SetAlpha.

See also: GetColor, SetAlpha

◆ GetColor()

ColorRGBA GetColor ( )

inline

Returns the color of this text sprite.

See also: SetColor

◆ GetHeight()

float GetHeight ( )

Returns the height of this text sprite.

This function require initialized engine text.

See also: GetSize, GetWidth

◆ GetWidth()

float GetWidth ( )

Returns the width of this text sprite.

This function require initialized engine text.

See also: GetSize, GetHeight

◆ GetSize()

Vec2f GetSize ( )

Returns the size of this text sprite.

This function require initialized engine text.

See also: GetWidth, GetHeight

◆ GetRelativeHandle()

Vec2f GetRelativeHandle ( )

inline

Returns the relative handle of this text sprite.

The relative handle has coordinates in range from 0.0 to 1.0.

◆ _SetSize()

void _SetSize ( Vec2f _size )

Set this text sprite to be clickable.

If a text sprite is clickable you can check A clickable tex sprite can

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

C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmSprites.h
C:/Development/JugiMapProject/JugiMapFRM/framework_c++/jugimap/jmSprites.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextSprite()

Member Function Documentation

◆ InitEngineObjects()

◆ CopyProperties()

◆ UpdateBoundingBox()

◆ PointInside()

◆ GetFont()

◆ SetTextString()

◆ GetTextString()

◆ SetColor()

◆ GetColor()

◆ GetHeight()

◆ GetWidth()

◆ GetSize()

◆ GetRelativeHandle()

◆ _SetSize()