Detailed Description

Base class for different kinds of light nodes

Inheritance diagram for Light:

Public Types
enum	LightType

Public Types inherited from Node
enum	Type
	Node type.

Public Member Functions
const auto &	getColorAndIntensity () const

void	setColorAndIntensity (const vec4 colorAndIntensity)

auto	getCastShadows () const

void	setCastShadows (bool castShadows)

auto	getLightType () const

void	setProperty (const string &property, const string &value) override

Public Member Functions inherited from Node
	Node (const Node &orig)

	Node (const string &nodeName="Node", Type type=NODE)

virtual void	onReady ()

virtual void	onEnterScene ()

virtual void	onExitScene ()

virtual void	onProcess (const float alpha)

virtual void	onPhysicsProcess (const float delta)

virtual bool	onInput (InputEvent &inputEvent)

const mat4 &	getTransformLocal () const

const mat4 &	getTransformGlobal () const

vec3	toGlobal (vec3 local) const

vec3	toLocal (vec3 global) const

virtual void	setPosition (vec3 position)

vec3	getPosition () const

void	translate (const vec3 &localOffset)

virtual void	setPositionGlobal (const vec3 &position)

vec3	getPositionGlobal () const

void	rotate (quat quaternion)

void	rotateTowards (const quat &targetRotation, float maxAngle)

void	rotateX (float angle)

void	rotateY (float angle)

void	rotateZ (float angle)

void	setRotation (const quat &quater)

void	setRotationGlobal (const quat &quater)

void	setRotation (const vec3 &rot)

void	setRotationX (float angle)

void	setRotationY (float angle)

void	setRotationZ (float angle)

vec3	getRotation () const

vec3	getRotationGlobal () const

quat	getRotationQuaternion () const

quat	getRotationQuaternionGlobal () const

float	getRotationX () const

float	getRotationY () const

float	getRotationZ () const

virtual void	setScale (const vec3 &scale)

void	setScale (float scale)

vec3	getScale () const

vec3	getScaleGlobal () const

ProcessMode	getProcessMode () const

void	setProcessMode (const ProcessMode mode)

bool	isProcessed () const

Node *	getParent () const

bool	addChild (shared_ptr< Node > child, bool async=false)

bool	removeChild (const shared_ptr< Node > &child, bool async=false)

void	removeAllChildren (bool async=false)

bool	haveChild (const shared_ptr< Node > &child, bool recursive) const

template<typename T = Node>
shared_ptr< T >	getChild (const string &name) const

template<typename T = Node>
shared_ptr< T >	getChildByPath (const string &path) const

template<typename T = Node>
shared_ptr< T >	findFirstChild (const string &name) const

void	printTree (int tab=0) const

string	toString () const override

id_t	getId () const

shared_ptr< Node >	duplicate (bool recursiveFilter=false) const

template<typename T = Node>
shared_ptr< T >	makeFrom ()

template<typename T >
shared_ptr< T >	findFirstChild (const bool recursive=true) const

template<typename T >
list< shared_ptr< T > >	findAllChildren (const bool recursive=true) const

template<typename T = Node>
list< shared_ptr< T > >	findAllChildrenByGroup (const string &groupName, const bool recursive=true) const

vec3	getRightVector () const

vec3	getLeftVector () const

vec3	getFrontVector () const

vec3	getBackVector () const

vec3	getUpVector () const

vec3	getDownVector () const

template<typename T >
shared_ptr< Tween >	createPropertyTween (PropertyTween< T >::Setter set, T initial, T final, float duration, const TransitionType ttype=TransitionType::LINEAR, const Tween::Callback &callback=nullptr)

void	killTween (const shared_ptr< Tween > &tween)

void	setName (const string &nodeName)

const list< shared_ptr< Node > > &	getChildren () const

Type	getType () const

const string &	getName () const

string	getPath () const

const list< string > &	getGroups () const

void	addToGroup (const string &group)

void	removeFromGroup (const string &group)

bool	isInGroup (const string &group) const

bool	isVisible () const

virtual void	setVisible (bool visible=true)

bool	isInsideTree () const

void	setCastShadows (bool castShadows)

Public Member Functions inherited from Object
void	connect (const Signal::signal &name, const Signal::Handler &handler)

void	connect (const Signal::signal &name, const function< void ()> &handler)

void	emit (const Signal::signal &name, void *params=nullptr)

Member Enumeration Documentation

enum LightType

Light type, mainly used by the fragment shader

Member Function Documentation

auto getCastShadows ( ) const

nodiscardinline

If true, the light will cast real-time shadows.
This has a significant performance cost. Only enable shadow rendering when it makes a noticeable difference in the scene's appearance.

const auto& getColorAndIntensity ( ) const

nodiscardinline

Returns the RGB color and the intensity factor

auto getLightType ( ) const

nodiscardinline

Returns the light type

void setCastShadows ( bool castShadows )

Sets to true to makes the light cast real-time shadow.
This has a significant performance cost. Only enable shadow rendering when it makes a noticeable difference in the scene's appearance.
Changing this parameter have no effect after adding the light to the scene (to avoid destroying shadow map renderers during frame rendering), you have to remove the light from the scene, change the setting, then add the light to the scene (adding and removing nodes from the scene if a deferred process).

void setColorAndIntensity ( const vec4 colorAndIntensity )

inline

Sets the RGB color and the intensity factor

void setProperty	(	const string &	property,
		const string &	value
	)

overridevirtual

Sets a property by is name and value. Currently, not all properties in all nodes classes are supported.

Reimplemented from z0::Node::setProperty()

Reimplemented in z0::SpotLight::setProperty(), z0::OmniLight::setProperty()

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation