A billboard scene node. More...

#include <nirtcpp/core/engine/IBillboardSceneNode.hpp>

Inheritance diagram for nirt::scene::IBillboardSceneNode:

Collaboration diagram for nirt::scene::IBillboardSceneNode:

Public Member Functions
	IBillboardSceneNode (ISceneNode parent, ISceneManager mgr, s32 id, const core::vector3df &position=core::vector3df(0, 0, 0))
	Constructor.

virtual void	setSize (const core::dimension2d< f32 > &size)=0
	Sets the size of the billboard, making it rectangular.

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.

virtual const core::dimension2d< f32 > &	getSize () const =0
	Returns the size of the billboard.

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.

virtual void	setColor (const video::SColor &overallColor)=0
	Set the color of all vertices of the billboard.

virtual void	setColor (const video::SColor &topColor, const video::SColor &bottomColor)=0
	Set the color of the top and bottom vertices of the billboard.

virtual void	getColor (video::SColor &topColor, video::SColor &bottomColor) const =0
	Gets the color of the top and bottom vertices of the billboard.

virtual const core::aabbox3d< f32 > &	getTransformedBillboardBoundingBox (const nirt::scene::ICameraSceneNode *camera)=0
	Get the real boundingbox used by the billboard, which can depend on the active camera.

virtual u32	getMeshBufferCount () const =0
	Get the amount of mesh buffers.

virtual IMeshBuffer *	getMeshBuffer (u32 nr) const =0
	Get pointer to a mesh buffer.

Public Member Functions inherited from nirt::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.

virtual	~ISceneNode ()
	Destructor.

virtual void	OnRegisterSceneNode ()
	This method is called just before the rendering process of the whole scene.

virtual void	OnAnimate (u32 timeMs)
	OnAnimate() is called just before rendering the whole scene.

virtual void	render ()=0
	Renders the node.

virtual const c8 *	getName () const
	Returns the name of the node.

virtual void	setName (const c8 *name)
	Sets the name of the node.

virtual void	setName (const core::stringc &name)
	Sets the name of the node.

virtual const core::aabbox3d< f32 > &	getBoundingBox () const =0
	Get the axis aligned, not transformed bounding box of this node.

virtual const core::aabbox3d< f32 >	getTransformedBoundingBox () const
	Get the axis aligned, transformed and animated absolute bounding box of this node.

virtual void	getTransformedBoundingBoxEdges (core::array< core::vector3d< f32 > > &edges) const

virtual const core::matrix4 &	getAbsoluteTransformation () const
	Get the absolute transformation of the node. Is recalculated every OnAnimate()-call.

virtual core::matrix4	getRelativeTransformation () const
	Returns the relative transformation of the scene node.

virtual bool	isVisible () const
	Returns whether the node should be visible (if all of its parents are visible).

virtual bool	isTrulyVisible () const
	Check whether the node is truly visible, taking into accounts its parents' visibility.

virtual void	setVisible (bool isVisible)
	Sets if the node should be visible or not.

virtual s32	getID () const
	Get the id of the scene node.

virtual void	setID (s32 id)
	Sets the id of the scene node.

virtual void	addChild (ISceneNode *child)
	Adds a child to this scene node.

virtual bool	removeChild (ISceneNode *child)
	Removes a child from this scene node.

virtual void	removeAll ()
	Removes all children of this scene node.

virtual void	remove ()
	Removes this scene node from the scene.

virtual void	addAnimator (ISceneNodeAnimator *animator)
	Adds an animator which should animate this node.

const core::list< ISceneNodeAnimator * > &	getAnimators () const
	Get a list of all scene node animators.

virtual void	removeAnimator (ISceneNodeAnimator *animator)
	Removes an animator from this scene node.

virtual void	removeAnimators ()
	Removes all animators from this scene node.

virtual video::SMaterial &	getMaterial (u32 num)
	Returns the material based on the zero based index i.

virtual u32	getMaterialCount () const
	Get amount of materials used by this scene node.

void	setMaterialFlag (video::E_MATERIAL_FLAG flag, bool newvalue)
	Sets all material flags at once to a new value.

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.

void	setMaterialType (video::E_MATERIAL_TYPE newType)
	Sets the material type of all materials in this scene node to a new material type.

virtual const core::vector3df &	getScale () const
	Gets the scale of the scene node relative to its parent.

virtual void	setScale (const core::vector3df &scale)
	Sets the relative scale of the scene node.

virtual const core::vector3df &	getRotation () const
	Gets the rotation of the node relative to its parent.

virtual void	setRotation (const core::vector3df &rotation)
	Sets the rotation of the node relative to its parent.

virtual const core::vector3df &	getPosition () const
	Gets the position of the node relative to its parent.

virtual void	setPosition (const core::vector3df &newpos)
	Sets the position of the node relative to its parent.

virtual core::vector3df	getAbsolutePosition () const
	Gets the absolute position of the node in world coordinates.

void	setAutomaticCulling (u32 state)
	Set a culling style or disable culling completely.

u32	getAutomaticCulling () const
	Gets the automatic culling state.

void	setUpdateAbsolutePosBehavior (ESCENE_NODE_UPDATE_ABS behavior)
	Set how updateAbsolutePosition calculates the absolute transformation matrix.

ESCENE_NODE_UPDATE_ABS	getUpdateAbsolutePosBehavior () const
	Get how updateAbsolutePosition calculates the absolute transformation matrix.

virtual void	setDebugDataVisible (u32 state)
	Sets if debug data like bounding boxes should be drawn.

u32	isDebugDataVisible () const
	Returns if debug data like bounding boxes are drawn.

void	setIsDebugObject (bool debugObject)
	Sets if this scene node is a debug object.

bool	isDebugObject () const
	Returns if this scene node is a debug object.

const core::list< ISceneNode * > &	getChildren () const
	Returns a const reference to the list of all children.

virtual void	setParent (ISceneNode *newParent)
	Changes the parent of the scene node.

virtual ITriangleSelector *	getTriangleSelector () const
	Returns the triangle selector attached to this scene node.

virtual void	setTriangleSelector (ITriangleSelector *selector)
	Sets the triangle selector of the scene node.

virtual void	updateAbsolutePosition ()
	Updates the absolute tranformation or position based on the relative and the parents transformation.

scene::ISceneNode *	getParent () const
	Returns the parent of this scene node.

virtual ESCENE_NODE_TYPE	getType () const
	Returns type of the scene node.

virtual void	serializeAttributes (io::IAttributes out, io::SAttributeReadWriteOptions options=0) const override
	Writes attributes of the scene node.

virtual void	deserializeAttributes (io::IAttributes in, io::SAttributeReadWriteOptions options=0) override
	Reads attributes of the scene node.

virtual ISceneNode *	clone (ISceneNode newParent=0, ISceneManager newManager=0)
	Creates a clone of this scene node and its children.

virtual ISceneManager *	getSceneManager (void) const
	Retrieve the scene manager for this node.

Public Member Functions inherited from nirt::IReferenceCounted
	IReferenceCounted ()
	Constructor.

virtual	~IReferenceCounted ()
	Destructor.

void	grab () const
	Grabs the object. Increments the reference counter by one.

bool	drop () const
	Drops the object. Decrements the reference counter by one.

s32	getReferenceCount () const
	Get the reference count.

const c8 *	getDebugName () const
	Returns the debug name of the object.

Additional Inherited Members
Protected Member Functions inherited from nirt::scene::ISceneNode
void	cloneMembers (ISceneNode toCopyFrom, ISceneManager newManager)
	A clone function for the ISceneNode members.

void	setSceneManager (ISceneManager *newManager)

Protected Member Functions inherited from nirt::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Protected Attributes inherited from nirt::scene::ISceneNode
core::stringc	Name
	Name of the scene node.

core::matrix4	AbsoluteTransformation
	Absolute transformation of the node.

core::vector3df	RelativeTranslation
	Relative translation of the scene node.

core::vector3df	RelativeRotation
	Relative rotation of the scene node.

core::vector3df	RelativeScale
	Relative scale of the scene node.

ISceneNode *	Parent
	Pointer to the parent.

core::list< ISceneNode * >	Children
	List of all children of this node.

core::list< ISceneNodeAnimator * >	Animators
	List of all animator nodes.

ISceneManager *	SceneManager
	Pointer to the scene manager.

ITriangleSelector *	TriangleSelector
	Pointer to the triangle selector.

s32	ID
	ID of the node.

ESCENE_NODE_UPDATE_ABS	UpdateAbsolutePosBehavior
	How updateAbsolutePosition calculates AbsoluteTransformation.

u32	AutomaticCullingState
	Automatic culling state.

u32	DebugDataVisible
	Flag if debug data should be drawn, such as Bounding Boxes.

bool	IsVisible
	Is the node visible?

bool	IsDebugObject
	Is debug object?

Detailed Description

A billboard scene node.

A billboard is like a 3d sprite: A 2d element, which always looks to the camera. It is usually used for explosions, fire, lensflares, particles and things like that.

Member Function Documentation

◆ getColor()

virtual void nirt::scene::IBillboardSceneNode::getColor	(	video::SColor &	topColor,
		video::SColor &	bottomColor
	)		const

pure virtual

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

Parameters

[out]	topColor	Stores the color of the top vertices
[out]	bottomColor	Stores the color of the bottom vertices

Implemented in nirt::scene::IBillboardTextSceneNode.

◆ getMeshBuffer()

virtual IMeshBuffer * nirt::scene::IBillboardSceneNode::getMeshBuffer ( u32 nr ) const

pure virtual

Get pointer to a mesh buffer.

NOTE: Positions and normals of this meshbuffers are re-calculated before rendering. So this is mainly useful to access/modify the uv-coordinates.

Parameters

nr	Zero based index of the mesh buffer.

Returns: Pointer to the mesh buffer or 0 if there is no such mesh buffer.

◆ getMeshBufferCount()

virtual u32 nirt::scene::IBillboardSceneNode::getMeshBufferCount ( ) const

pure virtual

Get the amount of mesh buffers.

Returns: Amount of mesh buffers (IMeshBuffer) in this mesh.

◆ getSize() [1/2]

virtual const core::dimension2d< f32 > & nirt::scene::IBillboardSceneNode::getSize ( ) const

pure virtual

Returns the size of the billboard.

This will return the width of the bottom edge of the billboard. Use getWidths() to retrieve the bottom and top edges independently.

Returns: Size of the billboard.

Implemented in nirt::scene::IBillboardTextSceneNode.

◆ getSize() [2/2]

virtual void nirt::scene::IBillboardSceneNode::getSize	(	f32 &	height,
		f32 &	bottomEdgeWidth,
		f32 &	topEdgeWidth
	)		const

pure virtual

Gets the size of the the billboard and handles independent top and bottom edge widths correctly.

Parameters

[out]	height	The height of the billboard.
[out]	bottomEdgeWidth	The width of the bottom edge of the billboard.
[out]	topEdgeWidth	The width of the top edge of the billboard.

◆ getTransformedBillboardBoundingBox()

virtual const core::aabbox3d< f32 > & nirt::scene::IBillboardSceneNode::getTransformedBillboardBoundingBox ( const nirt::scene::ICameraSceneNode * camera )

pure virtual

Get the real boundingbox used by the billboard, which can depend on the active camera.

The boundingbox returned will use absolute coordinates. The billboard orients itself toward the camera and some only update in render(). So we don't know the real boundingboxes before that. Which would be too late for culling. That is why the usual getBoundingBox will return a "safe" boundingbox which is guaranteed to contain the billboard. While this function can return the real one.

◆ setColor() [1/2]

virtual void nirt::scene::IBillboardSceneNode::setColor ( const video::SColor & overallColor )

pure virtual

Set the color of all vertices of the billboard.

Parameters

[in] overallColor Color to set

Implemented in nirt::scene::IBillboardTextSceneNode.

◆ setColor() [2/2]

virtual void nirt::scene::IBillboardSceneNode::setColor	(	const video::SColor &	topColor,
		const video::SColor &	bottomColor
	)

pure virtual

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

Parameters

[in]	topColor	Color to set the top vertices
[in]	bottomColor	Color to set the bottom vertices

Implemented in nirt::scene::IBillboardTextSceneNode.

◆ setSize() [1/2]

virtual void nirt::scene::IBillboardSceneNode::setSize ( const core::dimension2d< f32 > & size )

pure virtual

Sets the size of the billboard, making it rectangular.

Implemented in nirt::scene::IBillboardTextSceneNode.

◆ setSize() [2/2]

virtual void nirt::scene::IBillboardSceneNode::setSize	(	f32	height,
		f32	bottomEdgeWidth,
		f32	topEdgeWidth
	)

pure virtual

Sets the size of the billboard with independent widths of the bottom and top edges.

Parameters

[in]	height	The height of the billboard.
[in]	bottomEdgeWidth	The width of the bottom edge of the billboard.
[in]	topEdgeWidth	The width of the top edge of the billboard.

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

include/nirtcpp/core/engine/IBillboardSceneNode.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ getColor()

◆ getMeshBuffer()

◆ getMeshBufferCount()

◆ getSize() [1/2]

◆ getSize() [2/2]

◆ getTransformedBillboardBoundingBox()

◆ setColor() [1/2]

◆ setColor() [2/2]

◆ setSize() [1/2]

◆ setSize() [2/2]