arsa  2.7
Public Member Functions | List of all members
irr::scene::IBillboardTextSceneNode Class Referenceabstract

A billboard text scene node. More...

#include <IBillboardTextSceneNode.h>

Inheritance diagram for irr::scene::IBillboardTextSceneNode:
irr::scene::IBillboardSceneNode irr::scene::ISceneNode irr::io::IAttributeExchangingObject irr::IReferenceCounted

Public Member Functions

 IBillboardTextSceneNode (ISceneNode *parent, ISceneManager *mgr, s32 id, const core::vector3df &position=core::vector3df(0, 0, 0))
 Constructor. More...
 
virtual void setSize (const core::dimension2d< f32 > &size)=0
 Sets the size of the billboard. More...
 
virtual const core::dimension2d< f32 > & getSize () const =0
 Returns the size of the billboard. More...
 
virtual void setColor (const video::SColor &overallColor)=0
 Set the color of all vertices of the billboard. More...
 
virtual void setColor (const video::SColor &topColor, const video::SColor &bottomColor)=0
 Set the color of the top and bottom vertices of the billboard. More...
 
virtual void getColor (video::SColor &topColor, video::SColor &bottomColor) const =0
 Gets the color of the top and bottom vertices of the billboard. More...
 
virtual void setText (const wchar_t *text)=0
 sets the text string More...
 
virtual const wchar_t * getText () const =0
 get the text string More...
 
virtual void setTextColor (video::SColor color)
 
virtual gui::IGUIFontgetFont () const =0
 Get the font used to draw the text. More...
 
- Public Member Functions inherited from irr::scene::IBillboardSceneNode
 IBillboardSceneNode (ISceneNode *parent, ISceneManager *mgr, s32 id, const core::vector3df &position=core::vector3df(0, 0, 0))
 Constructor. More...
 
virtual void setSize (f32 height, f32 bottomEdgeWidth, f32 topEdgeWidth)=0
 Sets the size of the billboard with independent widths of the bottom and top edges. More...
 
virtual void getSize (f32 &height, f32 &bottomEdgeWidth, f32 &topEdgeWidth) const =0
 Gets the size of the the billboard and handles independent top and bottom edge widths correctly. More...
 
virtual const core::aabbox3d< f32 > & getTransformedBillboardBoundingBox (const irr::scene::ICameraSceneNode *camera)=0
 Get the real boundingbox used by the billboard, which can depend on the active camera. More...
 
- Public Member Functions inherited from irr::scene::ISceneNode
 ISceneNode (ISceneNode *parent, ISceneManager *mgr, s32 id=-1, const core::vector3df &position=core::vector3df(0, 0, 0), const core::vector3df &rotation=core::vector3df(0, 0, 0), const core::vector3df &scale=core::vector3df(1.0f, 1.0f, 1.0f))
 Constructor. More...
 
virtual ~ISceneNode ()
 Destructor. More...
 
virtual void OnRegisterSceneNode ()
 This method is called just before the rendering process of the whole scene. More...
 
virtual void OnAnimate (u32 timeMs)
 OnAnimate() is called just before rendering the whole scene. More...
 
virtual void render ()=0
 Renders the node. More...
 
virtual const c8getName () const
 Returns the name of the node. More...
 
virtual void setName (const c8 *name)
 Sets the name of the node. More...
 
virtual void setName (const core::stringc &name)
 Sets the name of the node. More...
 
virtual const core::aabbox3d< f32 > & getBoundingBox () const =0
 Get the axis aligned, not transformed bounding box of this node. More...
 
virtual const core::aabbox3d< f32getTransformedBoundingBox () const
 Get the axis aligned, transformed and animated absolute bounding box of this node. More...
 
virtual void getTransformedBoundingBoxEdges (core::array< core::vector3d< f32 > > &edges) const
 
virtual const core::matrix4getAbsoluteTransformation () const
 Get the absolute transformation of the node. Is recalculated every OnAnimate()-call. More...
 
virtual core::matrix4 getRelativeTransformation () const
 Returns the relative transformation of the scene node. More...
 
virtual bool isVisible () const
 Returns whether the node should be visible (if all of its parents are visible). More...
 
virtual bool isTrulyVisible () const
 Check whether the node is truly visible, taking into accounts its parents' visibility. More...
 
virtual void setVisible (bool isVisible)
 Sets if the node should be visible or not. More...
 
virtual s32 getID () const
 Get the id of the scene node. More...
 
virtual void setID (s32 id)
 Sets the id of the scene node. More...
 
virtual void addChild (ISceneNode *child)
 Adds a child to this scene node. More...
 
virtual bool removeChild (ISceneNode *child)
 Removes a child from this scene node. More...
 
virtual void removeAll ()
 Removes all children of this scene node. More...
 
virtual void remove ()
 Removes this scene node from the scene. More...
 
virtual void addAnimator (ISceneNodeAnimator *animator)
 Adds an animator which should animate this node. More...
 
const core::list< ISceneNodeAnimator * > & getAnimators () const
 Get a list of all scene node animators. More...
 
virtual void removeAnimator (ISceneNodeAnimator *animator)
 Removes an animator from this scene node. More...
 
virtual void removeAnimators ()
 Removes all animators from this scene node. More...
 
virtual video::SMaterialgetMaterial (u32 num)
 Returns the material based on the zero based index i. More...
 
virtual u32 getMaterialCount () const
 Get amount of materials used by this scene node. More...
 
void setMaterialFlag (video::E_MATERIAL_FLAG flag, bool newvalue)
 Sets all material flags at once to a new value. More...
 
void setMaterialTexture (u32 textureLayer, video::ITexture *texture)
 Sets the texture of the specified layer in all materials of this scene node to the new texture. More...
 
void setMaterialType (video::E_MATERIAL_TYPE newType)
 Sets the material type of all materials in this scene node to a new material type. More...
 
virtual const core::vector3dfgetScale () const
 Gets the scale of the scene node relative to its parent. More...
 
virtual void setScale (const core::vector3df &scale)
 Sets the relative scale of the scene node. More...
 
virtual const core::vector3dfgetRotation () const
 Gets the rotation of the node relative to its parent. More...
 
virtual void setRotation (const core::vector3df &rotation)
 Sets the rotation of the node relative to its parent. More...
 
virtual const core::vector3dfgetPosition () const
 Gets the position of the node relative to its parent. More...
 
virtual void setPosition (const core::vector3df &newpos)
 Sets the position of the node relative to its parent. More...
 
virtual core::vector3df getAbsolutePosition () const
 Gets the absolute position of the node in world coordinates. More...
 
void setAutomaticCulling (u32 state)
 Set a culling style or disable culling completely. More...
 
u32 getAutomaticCulling () const
 Gets the automatic culling state. More...
 
virtual void setDebugDataVisible (u32 state)
 Sets if debug data like bounding boxes should be drawn. More...
 
u32 isDebugDataVisible () const
 Returns if debug data like bounding boxes are drawn. More...
 
void setIsDebugObject (bool debugObject)
 Sets if this scene node is a debug object. More...
 
bool isDebugObject () const
 Returns if this scene node is a debug object. More...
 
const core::list< ISceneNode * > & getChildren () const
 Returns a const reference to the list of all children. More...
 
virtual void setParent (ISceneNode *newParent)
 Changes the parent of the scene node. More...
 
virtual ITriangleSelectorgetTriangleSelector () const
 Returns the triangle selector attached to this scene node. More...
 
virtual void setTriangleSelector (ITriangleSelector *selector)
 Sets the triangle selector of the scene node. More...
 
virtual void updateAbsolutePosition ()
 Updates the absolute position based on the relative and the parents position. More...
 
scene::ISceneNodegetParent () const
 Returns the parent of this scene node. More...
 
virtual ESCENE_NODE_TYPE getType () const
 Returns type of the scene node. More...
 
virtual void serializeAttributes (io::IAttributes *out, io::SAttributeReadWriteOptions *options=0) const _IRR_OVERRIDE_
 Writes attributes of the scene node. More...
 
virtual void deserializeAttributes (io::IAttributes *in, io::SAttributeReadWriteOptions *options=0) _IRR_OVERRIDE_
 Reads attributes of the scene node. More...
 
virtual ISceneNodeclone (ISceneNode *newParent=0, ISceneManager *newManager=0)
 Creates a clone of this scene node and its children. More...
 
virtual ISceneManagergetSceneManager (void) const
 Retrieve the scene manager for this node. More...
 
- Public Member Functions inherited from irr::IReferenceCounted
 IReferenceCounted ()
 Constructor. More...
 
virtual ~IReferenceCounted ()
 Destructor. More...
 
void grab () const
 Grabs the object. Increments the reference counter by one. More...
 
bool drop () const
 Drops the object. Decrements the reference counter by one. More...
 
s32 getReferenceCount () const
 Get the reference count. More...
 
const c8getDebugName () const
 Returns the debug name of the object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from irr::scene::ISceneNode
void cloneMembers (ISceneNode *toCopyFrom, ISceneManager *newManager)
 A clone function for the ISceneNode members. More...
 
void setSceneManager (ISceneManager *newManager)
 
- Protected Member Functions inherited from irr::IReferenceCounted
void setDebugName (const c8 *newName)
 Sets the debug name of the object. More...
 
- Protected Attributes inherited from irr::scene::ISceneNode
core::stringc Name
 Name of the scene node. More...
 
core::matrix4 AbsoluteTransformation
 Absolute transformation of the node. More...
 
core::vector3df RelativeTranslation
 Relative translation of the scene node. More...
 
core::vector3df RelativeRotation
 Relative rotation of the scene node. More...
 
core::vector3df RelativeScale
 Relative scale of the scene node. More...
 
ISceneNodeParent
 Pointer to the parent. More...
 
core::list< ISceneNode * > Children
 List of all children of this node. More...
 
core::list< ISceneNodeAnimator * > Animators
 List of all animator nodes. More...
 
ISceneManagerSceneManager
 Pointer to the scene manager. More...
 
ITriangleSelectorTriangleSelector
 Pointer to the triangle selector. More...
 
s32 ID
 ID of the node. More...
 
u32 AutomaticCullingState
 Automatic culling state. More...
 
u32 DebugDataVisible
 Flag if debug data should be drawn, such as Bounding Boxes. More...
 
bool IsVisible
 Is the node visible? More...
 
bool IsDebugObject
 Is debug object? More...
 

Detailed Description

A billboard text scene node.

Acts like a billboard which displays the currently set text. Due to the exclusion of RTTI in Irrlicht we have to avoid multiple inheritance. Hence, changes to the ITextSceneNode interface have to be copied here manually.

Definition at line 27 of file IBillboardTextSceneNode.h.

Constructor & Destructor Documentation

◆ IBillboardTextSceneNode()

irr::scene::IBillboardTextSceneNode::IBillboardTextSceneNode ( ISceneNode parent,
ISceneManager mgr,
s32  id,
const core::vector3df position = core::vector3df(0,0,0) 
)
inline

Constructor.

Definition at line 32 of file IBillboardTextSceneNode.h.

34  : IBillboardSceneNode(parent, mgr, id, position) {}
IBillboardSceneNode(ISceneNode *parent, ISceneManager *mgr, s32 id, const core::vector3df &position=core::vector3df(0, 0, 0))
Constructor.

Member Function Documentation

◆ getColor()

virtual void irr::scene::IBillboardTextSceneNode::getColor ( video::SColor topColor,
video::SColor bottomColor 
) const
pure virtual

Gets the color of the top and bottom vertices of the billboard.

Parameters
topColorstores the color of the top vertices
bottomColorstores the color of the bottom vertices

Implements irr::scene::IBillboardSceneNode.

◆ getFont()

virtual gui::IGUIFont* irr::scene::IBillboardTextSceneNode::getFont ( ) const
pure virtual

Get the font used to draw the text.

◆ getSize()

virtual const core::dimension2d<f32>& irr::scene::IBillboardTextSceneNode::getSize ( ) const
pure virtual

Returns the size of the billboard.

Implements irr::scene::IBillboardSceneNode.

◆ getText()

virtual const wchar_t* irr::scene::IBillboardTextSceneNode::getText ( ) const
pure virtual

get the text string

◆ setColor() [1/2]

virtual void irr::scene::IBillboardTextSceneNode::setColor ( const video::SColor overallColor)
pure virtual

Set the color of all vertices of the billboard.

Parameters
overallColorthe color to set

Implements irr::scene::IBillboardSceneNode.

◆ setColor() [2/2]

virtual void irr::scene::IBillboardTextSceneNode::setColor ( const video::SColor topColor,
const video::SColor bottomColor 
)
pure virtual

Set the color of the top and bottom vertices of the billboard.

Parameters
topColorthe color to set the top vertices
bottomColorthe color to set the bottom vertices

Implements irr::scene::IBillboardSceneNode.

◆ setSize()

virtual void irr::scene::IBillboardTextSceneNode::setSize ( const core::dimension2d< f32 > &  size)
pure virtual

Sets the size of the billboard.

Implements irr::scene::IBillboardSceneNode.

◆ setText()

virtual void irr::scene::IBillboardTextSceneNode::setText ( const wchar_t *  text)
pure virtual

sets the text string

◆ setTextColor()

virtual void irr::scene::IBillboardTextSceneNode::setTextColor ( video::SColor  color)
inlinevirtual

sets the color of the text You can use setColor instead which does the same

Definition at line 64 of file IBillboardTextSceneNode.h.

65  {
66  setColor(color);
67  }
virtual void setColor(const video::SColor &overallColor)=0
Set the color of all vertices of the billboard.
GLuint color

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