Scene node which is a dynamic light. More...

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

Inheritance diagram for nirt::scene::ILightSceneNode:

Collaboration diagram for nirt::scene::ILightSceneNode:

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

virtual void	setLightData (const video::SLight &light)=0
	Sets the light data associated with this ILightSceneNode.

virtual const video::SLight &	getLightData () const =0
	Gets the light data associated with this ILightSceneNode.

virtual video::SLight &	getLightData ()=0
	Gets the light data associated with this ILightSceneNode.

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

virtual void	setRadius (f32 radius)=0
	Sets the light's radius of influence.

virtual f32	getRadius () const =0
	Gets the light's radius of influence.

virtual void	setLightType (video::E_LIGHT_TYPE type)=0
	Sets the light type.

virtual video::E_LIGHT_TYPE	getLightType () const =0
	Gets the light type.

virtual void	enableCastShadow (bool shadow=true)=0
	Sets whether this light casts shadows.

virtual bool	getCastShadow () const =0
	Check whether this light casts shadows.

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 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

Scene node which is a dynamic light.

You can switch the light on and off by making it visible or not. It can be animated by ordinary scene node animators. If the light type is directional or spot, the direction of the light source is defined by the rotation of the scene node (assuming (0,0,1) as the local direction of the light).

Member Function Documentation

◆ enableCastShadow()

virtual void nirt::scene::ILightSceneNode::enableCastShadow ( bool shadow = true )

pure virtual

Sets whether this light casts shadows.

Enabling this flag won't automatically cast shadows, the meshes will still need shadow scene nodes attached. But one can enable or disable distinct lights for shadow casting for performance reasons.

Parameters

shadow True if this light shall cast shadows.

◆ getCastShadow()

virtual bool nirt::scene::ILightSceneNode::getCastShadow ( ) const

pure virtual

Check whether this light casts shadows.

Returns: True if light would cast shadows, else false.

◆ getLightData() [1/2]

virtual const video::SLight & nirt::scene::ILightSceneNode::getLightData ( ) const

pure virtual

Gets the light data associated with this ILightSceneNode.

Returns: The light data.

◆ getLightData() [2/2]

virtual video::SLight & nirt::scene::ILightSceneNode::getLightData ( )

pure virtual

Gets the light data associated with this ILightSceneNode.

Returns: The light data.

◆ getLightType()

virtual video::E_LIGHT_TYPE nirt::scene::ILightSceneNode::getLightType ( ) const

pure virtual

Gets the light type.

Returns: The current light type.

◆ getRadius()

virtual f32 nirt::scene::ILightSceneNode::getRadius ( ) const

pure virtual

Gets the light's radius of influence.

Returns: The current radius.

◆ setLightData()

virtual void nirt::scene::ILightSceneNode::setLightData ( const video::SLight & light )

pure virtual

Sets the light data associated with this ILightSceneNode.

Parameters

light The new light data.

◆ setLightType()

virtual void nirt::scene::ILightSceneNode::setLightType ( video::E_LIGHT_TYPE type )

pure virtual

Sets the light type.

Parameters

type	The new type.

◆ setRadius()

virtual void nirt::scene::ILightSceneNode::setRadius ( f32 radius )

pure virtual

Sets the light's radius of influence.

Outside this radius the light won't lighten geometry and cast no shadows. Setting the radius will also influence the attenuation, setting it to (0,1/radius,0). If you want to override this behavior, set the attenuation after the radius. NOTE: On OpenGL only the attenuation is set, there's no hard range.

Parameters

radius The new radius.

◆ setVisible()

virtual void nirt::scene::ILightSceneNode::setVisible ( bool isVisible )

pure virtual

Sets if the node should be visible or not.

All children of this node won't be visible either, when set to true.

Parameters

isVisible If the node shall be visible.

Reimplemented from nirt::scene::ISceneNode.

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

include/nirtcpp/core/engine/ILightSceneNode.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ enableCastShadow()

◆ getCastShadow()

◆ getLightData() [1/2]

◆ getLightData() [2/2]

◆ getLightType()

◆ getRadius()

◆ setLightData()

◆ setLightType()

◆ setRadius()

◆ setVisible()