Inheritance diagram for CCmpOverlayRenderer:

Collaboration diagram for CCmpOverlayRenderer:

[legend]

Public Member Functions
virtual int	GetComponentTypeId () const

virtual void	Init (const CParamNode &paramNode)

virtual void	Deinit ()

virtual void	Serialize (ISerializer &serialize)

virtual void	Deserialize (const CParamNode &paramNode, IDeserializer &deserialize)

virtual void	HandleMessage (const CMessage &msg, bool global)

void	UpdateMessageSubscriptions ()

virtual void	Reset ()
	Delete all sprites that have been previously added. More...

virtual void	AddSprite (const VfsPath &textureName, const CFixedVector2D &corner0, const CFixedVector2D &corner1, const CFixedVector3D &position, const std::string &color)
	Add a new textured billboard sprite to be rendered. More...

void	Interpolate (float frameTime, float frameOffset)

void	RenderSubmit (SceneCollector &collector)

Public Member Functions inherited from IComponent
virtual	~IComponent ()

CEntityHandle	GetEntityHandle () const

void	SetEntityHandle (CEntityHandle ent)

entity_id_t	GetEntityId () const

CEntityHandle	GetSystemEntity () const

const CSimContext &	GetSimContext () const

void	SetSimContext (const CSimContext &context)

virtual bool	NewJSObject (ScriptInterface &scriptInterface, JS::MutableHandleObject out) const
	Returns false by default, indicating that a scripted wrapper of this IComponent is not supported. More...

virtual JS::Value	GetJSInstance () const

Static Public Member Functions
static void	ClassInit (CComponentManager &componentManager)

static IComponent *	Allocate (ScriptInterface &, JS::HandleValue)

static void	Deallocate (IComponent *cmp)

static std::string	GetSchema ()

Static Public Member Functions inherited from ICmpOverlayRenderer
static void	SetOverrideVisibility (bool visible)
	Enables or disables rendering of all sprites. More...

Static Public Member Functions inherited from IComponent
static std::string	GetSchema ()

static u8	GetSerializationVersion ()

Public Attributes
std::vector< SOverlaySprite >	m_Sprites

std::vector< CVector3D >	m_SpriteOffsets

bool	m_Enabled

Additional Inherited Members
Static Protected Attributes inherited from ICmpOverlayRenderer
static bool	m_OverrideVisible = true

Member Function Documentation

virtual void CCmpOverlayRenderer::AddSprite	(	const VfsPath &	textureName,
		const CFixedVector2D &	corner0,
		const CFixedVector2D &	corner1,
		const CFixedVector3D &	offset,
		const std::string &	color
	)

inlinevirtual

Add a new textured billboard sprite to be rendered.

Parameters

textureName	filename of texture to render.
corner0,corner1	coordinates of sprite's corners, in world-space units oriented with the camera plane, relative to the sprite position.
offset	world-space offset of sprite position from the entity's base position.
color	multiply color of texture

Implements ICmpOverlayRenderer.

static IComponent* CCmpOverlayRenderer::Allocate	(	ScriptInterface &	,
		JS::HandleValue
	)

inlinestatic

static void CCmpOverlayRenderer::ClassInit ( CComponentManager & componentManager )

inlinestatic

static void CCmpOverlayRenderer::Deallocate ( IComponent * cmp )

inlinestatic

virtual void CCmpOverlayRenderer::Deinit ( )

inlinevirtual

Implements IComponent.

virtual void CCmpOverlayRenderer::Deserialize	(	const CParamNode &	paramNode,
		IDeserializer &	deserialize
	)

inlinevirtual

Implements IComponent.

virtual int CCmpOverlayRenderer::GetComponentTypeId ( ) const

inlinevirtual

Implements IComponent.

static std::string CCmpOverlayRenderer::GetSchema ( )

inlinestatic

virtual void CCmpOverlayRenderer::HandleMessage	(	const CMessage &	msg,
		bool	global
	)

inlinevirtual

Reimplemented from IComponent.

virtual void CCmpOverlayRenderer::Init ( const CParamNode & paramNode )

inlinevirtual

Implements IComponent.

void CCmpOverlayRenderer::Interpolate	(	float	frameTime,
		float	frameOffset
	)

inline

void CCmpOverlayRenderer::RenderSubmit ( SceneCollector & collector )

inline

virtual void CCmpOverlayRenderer::Reset ( )

inlinevirtual

Delete all sprites that have been previously added.

Implements ICmpOverlayRenderer.

virtual void CCmpOverlayRenderer::Serialize ( ISerializer & serialize )

inlinevirtual

Implements IComponent.

void CCmpOverlayRenderer::UpdateMessageSubscriptions ( )

inline

Member Data Documentation

bool CCmpOverlayRenderer::m_Enabled

std::vector<CVector3D> CCmpOverlayRenderer::m_SpriteOffsets

std::vector<SOverlaySprite> CCmpOverlayRenderer::m_Sprites

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

/var/svn/checkout/source/simulation2/components/CCmpOverlayRenderer.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Member Function Documentation

Member Data Documentation