igor::iSpriteRenderComponent Class Reference

#include <iSpriteRenderComponent.h>

Inherits igor::iEntityComponent.

Public Types
enum class	iRenderMode { Simple , Tiled }

Public Member Functions
	iSpriteRenderComponent ()=default
	iSpriteRenderComponent (iSpritePtr sprite, const iaVector2d &size=iaVector2d(1.0, 1.0), const iaColor4f &color=iaColor4f::white, int32 zIndex=0, iRenderMode renderMode=iRenderMode::Simple)
std::vector< iaString >	getInfo () const override
void	setSprite (iSpritePtr sprite)
IGOR_INLINE iSpritePtr	getSprite () const
void	setSize (const iaVector2d &size)
IGOR_INLINE const iaVector2d &	getSize () const
void	setColor (const iaColor4f &color)
IGOR_INLINE const iaColor4f &	getColor () const
void	setZIndex (int32 zIndex)
IGOR_INLINE int32	getZIndex () const
void	setRenderMode (iSpriteRenderComponent::iRenderMode mode)
IGOR_INLINE iSpriteRenderComponent::iRenderMode	getRenderMode () const
void	setFrameIndex (int32 frameIndex)
IGOR_INLINE int32	getFrameIndex () const
Public Member Functions inherited from igor::iEntityComponent
	iEntityComponent ()
virtual	~iEntityComponent ()=default
const iEntityComponentID &	getID () const
iEntityComponentState	getState () const
virtual std::vector< iaString >	getInfo () const
IGOR_INLINE void	setDirty ()
uint16	getVersion () const

Static Public Member Functions
static iEntityComponent *	createInstance ()
static const iaString &	getTypeName ()

Additional Inherited Members
Protected Member Functions inherited from igor::iEntityComponent
virtual bool	onLoad (iEntityPtr entity, bool &asyncLoad)
virtual void	onActivate (iEntityPtr entity)
virtual void	onDeactivate (iEntityPtr entity)
virtual void	onUnLoad (iEntityPtr entity)
virtual iEntityComponentPtr	getCopy ()=0
iEntityPtr	getEntity () const

Detailed Description

sprite render component

Member Enumeration Documentation

iRenderMode

enum class igor::iSpriteRenderComponent::iRenderMode

strong

sprite render mode

Enumerator
Simple
Tiled

Constructor & Destructor Documentation

iSpriteRenderComponent() [1/2]

igor::iSpriteRenderComponent::iSpriteRenderComponent ( )

default

default ctor

iSpriteRenderComponent() [2/2]

igor::iSpriteRenderComponent::iSpriteRenderComponent	(	iSpritePtr	sprite,
		const iaVector2d &	size = iaVector2d(1.0, 1.0),
		const iaColor4f &	color = iaColor4f::white,
		int32	zIndex = 0,
		iRenderMode	renderMode = iRenderMode::Simple
	)

ctor

Member Function Documentation

createInstance()

iEntityComponent * igor::iSpriteRenderComponent::createInstance ( )

static

creates instance of this component type

getColor()

IGOR_INLINE const iaColor4f & igor::iSpriteRenderComponent::getColor ( ) const

inline

Returns

the color

getFrameIndex()

IGOR_INLINE int32 igor::iSpriteRenderComponent::getFrameIndex ( ) const

inline

Returns

the frame index

getInfo()

std::vector< iaString > igor::iSpriteRenderComponent::getInfo ( ) const

overridevirtual

Returns

a set of info strings

Reimplemented from igor::iEntityComponent.

getRenderMode()

IGOR_INLINE iSpriteRenderComponent::iRenderMode igor::iSpriteRenderComponent::getRenderMode ( ) const

inline

Returns

the render mode

getSize()

IGOR_INLINE const iaVector2d & igor::iSpriteRenderComponent::getSize ( ) const

inline

Returns

the size

getSprite()

IGOR_INLINE iSpritePtr igor::iSpriteRenderComponent::getSprite ( ) const

inline

Returns

the sprite

getTypeName()

const iaString & igor::iSpriteRenderComponent::getTypeName ( )

static

Returns

type name of component

getZIndex()

IGOR_INLINE int32 igor::iSpriteRenderComponent::getZIndex ( ) const

inline

Returns

the z index

setColor()

void igor::iSpriteRenderComponent::setColor

(

const iaColor4f &

color

)

sets the color

Parameters

color

the new color

setFrameIndex()

void igor::iSpriteRenderComponent::setFrameIndex

(

int32

frameIndex

)

sets frame index

Parameters

frameIndex

the frame index

setRenderMode()

void igor::iSpriteRenderComponent::setRenderMode

(

iSpriteRenderComponent::iRenderMode

mode

)

sets render mode

Parameters

mode	the render mode to set

setSize()

void igor::iSpriteRenderComponent::setSize

(

const iaVector2d &

size

)

sets the size

Parameters

size	the new size

setSprite()

void igor::iSpriteRenderComponent::setSprite

(

iSpritePtr

sprite

)

sets the sprite

Parameters

sprite

the sprite to use

setZIndex()

void igor::iSpriteRenderComponent::setZIndex

(

int32

zIndex

)

sets z index

Parameters

zIndex

the z index

---

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

• /home/martin/dev/Igor/src/igor/igor/entities/components/iSpriteRenderComponent.h
• /home/martin/dev/Igor/src/igor/igor/entities/components/iSpriteRenderComponent.cpp