Detailed Description

Base class for all 3D nodes

Inheritance diagram for Node:

Public Types
enum	Type
	Node type.

Public Member Functions
	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)

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

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)

Constructor & Destructor Documentation

Node ( const Node & orig )

Creates a node by copying the transforms, process mode, type and name

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

explicit

Creates a new node at (0.0, 0.0, 0.0) without parent

Member Function Documentation

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

Adds a child node.
Nodes can have any number of children, but a child can have only one parent.
The node will be added to the scene at the start of the next frame.

Parameters

child	the node to add
async	if `true` and the node have children all the nodes will be added in batch mode. Be careful to set the visibility of the nodes to `false`or they will appear slowly in the scene.

void addToGroup ( const string & group )

inline

Adds the node to the group. Groups can be helpful to organize a subset of nodes, for example "enemies" or "stairs".

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

inline

Creates a Tween to tweens a property of the node between an initial value and final value in a span of time equal to duration, in seconds.

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

nodiscard

Duplicates a node. Warning : not implemented on all nodes types, check documentation for the node type before using it.

Parameters

recursiveFilter only duplicate AnimationPlayer children (used by Loader::load)

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

nodiscardinline

Finds all children by type

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

nodiscardinline

Finds all children by group

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

nodiscardinline

Finds the first child by is type.

shared_ptr<T> findFirstChild ( const string & name ) const

nodiscardinline

Finds the first child by is name.

vec3 getBackVector ( ) const

nodiscardinline

Returns the normalized back vector

shared_ptr<T> getChild ( const string & name ) const

nodiscardinline

Returns the child node by is name. Not recursive

shared_ptr<T> getChildByPath ( const string & path ) const

nodiscardinline

Returns the child node by its relative path (does not start with '/')

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

inline

Returns the immutable list of children nodes

vec3 getDownVector ( ) const

nodiscardinline

Returns the normalized down vector

vec3 getFrontVector ( ) const

nodiscardinline

Returns the normalized front vector

const list<string>& getGroups ( ) const

inline

Returns a list of group names that the node has been added to.

id_t getId ( ) const

nodiscardinline

Returns the unique ID of this node

vec3 getLeftVector ( ) const

nodiscardinline

Returns the normalized left vector

const string& getName ( ) const

inline

Returns the node name

Node* getParent ( ) const

nodiscardinline

Returns the node's parent in the scene tree

string getPath ( ) const

Returns the node path

vec3 getPosition ( ) const

nodiscardinline

Returns the local space position (relative to parent)

vec3 getPositionGlobal ( ) const

nodiscardinline

Returns the world space position

ProcessMode getProcessMode ( ) const

nodiscardinline

Returns the node's processing behavior. To check if the node can process in its current mode, use isProcessed().

vec3 getRightVector ( ) const

nodiscardinline

Returns the normalized right vector

vec3 getRotation ( ) const

nodiscard

Returns the rotation of the local transformation, in euler angles in radians

vec3 getRotationGlobal ( ) const

nodiscard

Returns the rotation of the world transformation, in euler angles in radians

quat getRotationQuaternion ( ) const

nodiscardinline

Returns the rotation of the local transformation

quat getRotationQuaternionGlobal ( ) const

nodiscardinline

Returns the rotation of the world transformation

float getRotationX ( ) const

nodiscardinline

Returns the X axis rotation of the local transformation

float getRotationY ( ) const

nodiscardinline

Returns the Y axis rotation of the local transformation

float getRotationZ ( ) const

nodiscardinline

Returns the Z axis rotation of the local transformation

vec3 getScale ( ) const

nodiscard

Returns the scale part of the local transformation.

vec3 getScaleGlobal ( ) const

Returns the scale part of the global transformation.

const mat4& getTransformGlobal ( ) const

nodiscardinline

Returns the world space transformation matrix

const mat4& getTransformLocal ( ) const

nodiscardinline

Returns the local space transformation matrix

Type getType ( ) const

inline

Returns the node type

vec3 getUpVector ( ) const

nodiscardinline

Returns the normalized up vector

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

nodiscard

Returns true if the node have this child

bool isInGroup ( const string & group ) const

inline

Returns true if this node has been added to the given group

bool isInsideTree ( ) const

inline

Returns true if this node is currently inside the scene tree

bool isProcessed ( ) const

nodiscard

Returns true if the node is processed and receive input callbacks

bool isVisible ( ) const

inline

Returns the visibility of the node.

void killTween ( const shared_ptr< Tween > & tween )

Removes the tween from the processing list

shared_ptr<T> makeFrom ( )

inline

Create a new node based of the node

virtual void onEnterScene ( )

inlinevirtual

Called when a node is added to the scene

virtual void onExitScene ( )

inlinevirtual

Called when a node is removed from the scene

virtual bool onInput ( InputEvent & inputEvent )

inlinevirtual

Called on a keyboard, mouse or gamepad event

virtual void onPhysicsProcess ( const float delta )

inlinevirtual

Called just after the physics system have been updated (can be called multiple times if we have free time between frames)

virtual void onProcess ( const float alpha )

inlinevirtual

Called each frame after the physics have been updated and just before drawing the frame

virtual void onReady ( )

inlinevirtual

Called when a node is ready to initialize, before being added to the scene

void printTree ( int tab = 0 ) const

Recursively prints the node tree in the log system

void removeAllChildren ( bool async = false )

Removes all children nodes. The nodes, along with their children can be deleted depending on their reference counters. The nodes will be removed from the scene at the start of the next frame.

Parameters

async if true and the nodes will be removed in batch mode. Be careful to set the visibility of the nodes to false or they will disappear slowly from the scene.

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

Removes a child node. The node, along with its children can be deleted depending on their reference counter.
Use the iterator version in a for-each loop.
The node will be removed from the scene at the start of the next frame.

Parameters

child	the node to remove
async	if `true` and the node have children all the nodes will be removed in batch mode. Be careful to set the visibility of the nodes to `false` or they will disappear slowly from the scene.

void removeFromGroup ( const string & group )

inline

Removes the node from the given group. Does nothing if the node is not in the group

void rotate ( quat quaternion )

Rotates the local transformation

void rotateTowards	(	const quat &	targetRotation,
		float	maxAngle
	)

Interpolate the local transformation

void rotateX ( float angle )

Rotates the local transformation around the X axis by angle in radians.

void rotateY ( float angle )

Rotates the local transformation around the Y axis by angle in radians.

void rotateZ ( float angle )

Rotates the local transformation around the Z axis by angle in radians.

void setCastShadows ( bool castShadows )

Recursively sets the cast_shadows property

void setName ( const string & nodeName )

inline

Sets the node name (purely informative)

virtual void setPosition ( vec3 position )

virtual

Sets the local space position (relative to parent)

virtual void setPositionGlobal ( const vec3 & position )

virtual

Sets the world space position

void setProcessMode ( const ProcessMode mode )

inline

Changes the node's processing behavior.

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

virtual

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

Reimplemented in z0::SpotLight::setProperty(), z0::Light::setProperty(), z0::Skybox::setProperty(), z0::OmniLight::setProperty(), z0::Environment::setProperty(), z0::DirectionalLight::setProperty()

void setRotation ( const quat & quater )

Rotates the local transformation

Sets the local transformation

void setRotation ( const vec3 & rot )

Sets the local transformation

void setRotationGlobal ( const quat & quater )

Sets the world transformation

void setRotationX ( float angle )

Sets the X axis rotation of the local transformation by angle in radians.

void setRotationY ( float angle )

Sets the Y axis rotation of the local transformation by angle in radians.

void setRotationZ ( float angle )

Sets the Z axis rotation of the local transformation by angle in radians.

virtual void setScale ( const vec3 & scale )

virtual

Scales part of the local transformation.

void setScale ( float scale )

Scales part of the local transformation with the same value on each axis

virtual void setVisible ( bool visible = true )

virtual

Changes the visibility of the node.
The node stays in the scene tree and the data in VRAM.

vec3 toGlobal ( vec3 local ) const

nodiscard

Transforms a local vector from this node's local space to world space.

vec3 toLocal ( vec3 global ) const

nodiscard

Transforms a world space vector to this node's local space.

string toString ( ) const

nodiscardinlineoverridevirtual

Converts the objet to a readable text

Reimplemented from z0::Object::toString()

void translate ( const vec3 & localOffset )

Changes the node's position by the given offset vector in local space.

Detailed Description

Public Types

Public Member Functions

Constructor & Destructor Documentation

Member Function Documentation