PLScene::SNText3D Class Reference

3D ("flat") text scene node More...

#include <SNText3D.h>

Inheritance diagram for PLScene::SNText3D:

List of all members.

Public Types
enum	EFlags { NoBackfaceCulling = 1<<11 }
	Scene node flags (SceneNode flags extension) More...
Public Member Functions
virtual PLS_API void	SetText (const PLCore::String &sValue) override
virtual PLS_API void	SetFont (const PLCore::String &sValue) override
virtual PLS_API void	SetFontSize (PLCore::uint32 nValue) override
virtual PLS_API void	SetFlags (PLCore::uint32 nValue) override
PLS_API	SNText3D ()
	Default constructor.
virtual PLS_API	~SNText3D ()
	Destructor.
PLS_API const PLRenderer::MaterialHandler &	GetBackgroundMaterialHandler ()
	Returns the handler of the background material.
virtual PLS_API void	DrawTransparent (PLRenderer::Renderer &cRenderer, const VisNode *pVisNode) override
	This function is called when the transparent parts of the scene are drawn.

---

Detailed Description

3D ("flat") text scene node

Note:

• The text is drawn on the x/y plane and 'looks' into the positive z axis
• The 3D placed text has always a height of 1 to be independent of the actual 'font size'
• The 'font size' can be seen as the 'font quality'

---

Member Enumeration Documentation

enum PLScene::SNText3D::EFlags

Scene node flags (SceneNode flags extension)

Enumerator:

NoBackfaceCulling

No backface culling so 'both' sides of the text can be seen

Reimplemented from PLScene::SNText.

---

Constructor & Destructor Documentation

PLS_API PLScene::SNText3D::SNText3D

(

)

Default constructor.

virtual PLS_API PLScene::SNText3D::~SNText3D

(

)

[virtual]

Destructor.

---

Member Function Documentation

virtual PLS_API void PLScene::SNText3D::SetText

(

const PLCore::String &

sValue

)

[override, virtual]

virtual PLS_API void PLScene::SNText3D::SetFont

(

const PLCore::String &

sValue

)

[override, virtual]

Reimplemented from PLScene::SNText.

virtual PLS_API void PLScene::SNText3D::SetFontSize

(

PLCore::uint32

nValue

)

[override, virtual]

Reimplemented from PLScene::SNText.

virtual PLS_API void PLScene::SNText3D::SetFlags

(

PLCore::uint32

nValue

)

[override, virtual]

Reimplemented from PLScene::SceneNode.

PLS_API const PLRenderer::MaterialHandler& PLScene::SNText3D::GetBackgroundMaterialHandler

(

)

Returns the handler of the background material.

Returns:

Handler of the background material

virtual PLS_API void PLScene::SNText3D::DrawTransparent	(	PLRenderer::Renderer &	cRenderer,
		const VisNode *	pVisNode
	)		[override, virtual]

This function is called when the transparent parts of the scene are drawn.

Parameters:

[in]	cRenderer	The used renderer
[in]	pVisNode	The current visibility node of this scene node, can be a null pointer

Note:

• The default implementation only emits the SignalDrawTransparent signal

See also:

• DrawPre()

Reimplemented from PLScene::SceneNode.

---

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

• SNText3D.h