Detailed Description

A scene tree representing a hierarchy of nodes.

Inheritance diagram for SceneTree:

Public Member Functions
	SceneTree (const SceneConfiguration &sceneConfiguration={})

	SceneTree (const RenderingWindow &renderingWindow, const SceneConfiguration &sceneConfiguration={})

	~SceneTree () override

void	attach (const RenderingWindow &renderingWindow)

void	attach (const RenderTarget &renderTarget)

void	detach ()

void	setCamera (const lysa::Camera &camera)

void	setViewport (const vireo::Viewport &viewport)

void	setScissors (const vireo::Rect &scissors)

virtual void	onReady ()

virtual void	onPhysicsProcess (double delta)

virtual void	onProcess (double alpha)

virtual bool	onInput (const InputEvent &event)

virtual void	onResize (const vireo::Extent &extent)

virtual void	onPause ()

virtual void	onResume ()

virtual void	onAttach ()

virtual void	onDetach ()

template<typename T = Node>
const std::shared_ptr< T > &	addChild (const std::shared_ptr< T > &child, const bool async=false)

template<typename T = Node>
bool	removeChild (const std::shared_ptr< T > &child)

void	removeAllChildren ()

template<typename T >
bool	haveChild (const std::shared_ptr< T > &child, const bool recursive=true) const

bool	isPaused () const

void	setPaused (bool paused)

bool	isAttached () const

bool	isAttachedToWindow () const

RenderTarget &	getRenderTarget () const

RenderingWindow &	getRenderingWindow () const

std::optional< RayCastHit >	rayCast (const Ray &ray, const std::shared_ptr< MeshInstance > &parent=nullptr) const

std::set< RayCastHit >	rayCastAll (const Ray &ray, const std::shared_ptr< MeshInstance > &parent=nullptr) const

Protected Attributes
MaterialManager &	materialManager
	Material resource manager shared with the engine context. More...

MeshManager &	meshManager
	Mesh resource manager shared with the engine context. More...

ImageManager &	imageManager
	Image (texture) resource manager shared with the engine context. More...

Constructor & Destructor Documentation

SceneTree ( const SceneConfiguration & sceneConfiguration = {} )

Default constructor

Parameters

sceneConfiguration The configuration for the scene

SceneTree	(	const RenderingWindow &	renderingWindow,
		const SceneConfiguration &	sceneConfiguration = `{}`
	)

Constructor that attaches the scene tree to a rendering window

Parameters

renderingWindow	The window to attach to
sceneConfiguration	The configuration for the scene

~SceneTree ( )

override

Member Function Documentation

const std::shared_ptr<T>& addChild	(	const std::shared_ptr< T > &	child,
		const bool	async = `false`
	)

inline

Adds a child node to the scene tree

Template Parameters

T	The type of the child node

Parameters

child	The child node to add
async	Whether to add the child asynchronously

Returns: A reference to the added child

void attach ( const RenderingWindow & renderingWindow )

Attaches the scene tree to a rendering window

void attach ( const RenderTarget & renderTarget )

Attaches the scene tree to a render target

void detach ( )

Detaches the scene tree from its current render target & window

RenderingWindow& getRenderingWindow ( ) const

inline

Returns the rendering window the scene tree is attached to

RenderTarget& getRenderTarget ( ) const

inline

Returns the render target the scene tree is attached to

bool haveChild	(	const std::shared_ptr< T > &	child,
		const bool	recursive = `true`
	)		const

inline

Checks if the scene tree has a specific child node

Template Parameters

T	The type of the child node

Parameters

child	The child node to check for
recursive	Whether to search recursively

Returns: True if the child exists

bool isAttached ( ) const

inline

Returns whether the scene tree is attached to a render target

bool isAttachedToWindow ( ) const

inline

Returns whether the scene tree is attached to a rendering window

bool isPaused ( ) const

inline

Returns whether the scene tree is paused

virtual void onAttach ( )

inlinevirtual

Called when the scene tree is attached

virtual void onDetach ( )

inlinevirtual

Called when the scene tree is detached

virtual bool onInput ( const InputEvent & event )

inlinevirtual

Called when an input event occurs

Parameters

event The input event

Returns: True if the event was handled

virtual void onPause ( )

inlinevirtual

Called when the scene tree is paused

virtual void onPhysicsProcess ( double delta )

inlinevirtual

Called during the physics process step

Parameters

delta The time delta since the last physics step

virtual void onProcess ( double alpha )

inlinevirtual

Called during the process step

Parameters

alpha The interpolated alpha

virtual void onReady ( )

inlinevirtual

Called when the scene tree is ready

virtual void onResize ( const vireo::Extent & extent )

inlinevirtual

Called when the viewport is resized

virtual void onResume ( )

inlinevirtual

Called when the scene tree is resumed

std::optional<RayCastHit> rayCast	(	const Ray &	ray,
		const std::shared_ptr< MeshInstance > &	parent = `nullptr`
	)		const

Casts a ray (without using the physics engine) through all MeshInstances in the scene and returns the closest hit. The size of direction defines the max distance.

Parameters

ray	World-space ray origin and World-space ray direction (un-normalized; length = max distance)
parent	Optional parent to ignore

std::set<RayCastHit> rayCastAll	(	const Ray &	ray,
		const std::shared_ptr< MeshInstance > &	parent = `nullptr`
	)		const

Casts a ray through the entire scene and collects the closest hit per MeshInstance along its length.

Parameters

ray	World-space ray origin and world-space ray direction (un-normalized; length = max distance)
parent	Optional mesh to ignore

Returns: Ordered set of RayCastHit, one per MeshInstance sorted by ascending distance.

void removeAllChildren ( )

inline

Removes all child nodes from the scene tree. Each node is detached from the scene before removal.

bool removeChild ( const std::shared_ptr< T > & child )

inline

Removes a child node from the scene tree

Template Parameters

T	The type of the child node

Parameters

child The child node to remove

Returns: True if the child was removed

void setCamera ( const lysa::Camera & camera )

Sets the camera for the scene tree

void setPaused ( bool paused )

Sets whether the scene tree is paused

void setScissors ( const vireo::Rect & scissors )

Sets the scissors for the scene tree

void setViewport ( const vireo::Viewport & viewport )

Sets the viewport for the scene tree

Member Data Documentation

ImageManager& imageManager

protected

Image (texture) resource manager shared with the engine context.

MaterialManager& materialManager

protected

Material resource manager shared with the engine context.

MeshManager& meshManager

protected

Mesh resource manager shared with the engine context.

Detailed Description

Public Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation