Base container type. Inherited types include sounds, random, sequence etc. More...

#include <container.h>

Inheritance diagram for sbk::engine::container:

Collaboration diagram for sbk::engine::container:

Public Member Functions
bool	can_add_child_type (const rttr::type &childType) const override

virtual void	gather_children_for_play (gather_children_context &context) const =0
	Collects and gathers sounds on this node and its children for play.

Public Member Functions inherited from sbk::engine::node
virtual void	gatherParameters (global_parameter_list &parameters)
	Gathers all parameters on this and child nodes that can effect the runtime output.

void	addEffect (sc_dsp_type type)

Public Member Functions inherited from sbk::engine::node_base
virtual void	set_parent_node (const sbk::core::database_ptr< node_base > &parent)

virtual void	set_output_bus (const sbk::core::database_ptr< node_base > &bus)

node_base *	get_parent () const

node_base *	get_output_bus () const

SB_NODE_STATUS	getNodeStatus () const noexcept

virtual bool	can_add_children () const

bool	can_add_child (const sbk::core::database_ptr< node_base > &child) const

virtual bool	can_add_parent () const

virtual bool	can_add_parent_type (const rttr::type &parentType) const

void	addChild (const sbk::core::database_ptr< node_base > &child)

void	removeChild (const sbk::core::database_ptr< node_base > &child)

std::vector< node_base * >	getChildren () const

std::size_t	getChildCount () const

bool	hasChild (const sbk::core::database_ptr< node_base > &test) const

void	gatherAllDescendants (std::vector< node_base * > &descendants) const

void	gatherAllParents (std::vector< node_base * > &parents) const

Public Member Functions inherited from sbk::core::database_object
sbk_id	get_database_id () const

void	set_database_id (sbk_id id)

std::string_view	get_database_name () const

void	set_database_name (std::string_view name)

bool	get_editor_hidden () const

void	set_editor_hidden (bool hidden)

	operator sbk_id () const

MulticastDelegate< sbk_id, sbk_id > &	get_on_update_id ()

MulticastDelegate< std::string_view, std::string_view > &	get_on_update_name ()

Public Member Functions inherited from sbk::core::object
object_owner *	owner () const

template<typename T >
T *	try_convert_object () noexcept
	Gets the most derived type of this object and upcasts it to T.

template<typename T >
const T *	try_convert_object () const noexcept

rttr::type	getType () const

void	destroy ()

MulticastDelegate< object * > &	get_on_destroy ()

Public Member Functions inherited from sbk::core::object_owner
std::shared_ptr< object >	create_runtime_object (const rttr::type &type)

std::shared_ptr< object >	load_object (YAML::Node &node)

std::shared_ptr< database_object >	create_database_object (const rttr::type &type, bool addToDatabase=true)

template<typename T >
std::shared_ptr< T >	create_runtime_object ()

template<typename T >
std::shared_ptr< T >	create_database_object ()

void	remove_object (const std::shared_ptr< object > &object)

void	destroy_all ()

std::vector< std::shared_ptr< object > > &	get_objects ()

const std::vector< std::shared_ptr< object > > &	get_objects () const

Additional Inherited Members
Public Attributes inherited from sbk::engine::node
sbk::core::float_property	m_volume = sbk::core::float_property(1.0f, 0.0f, 1.0f)

sbk::core::float_property	m_pitch = sbk::core::float_property(1.0f, 0.0f, 1.0f)

sbk::core::float_property	m_lowpass = sbk::core::float_property(1.0f, 0.0f, 100.0f)

sbk::core::float_property	m_highpass = sbk::core::float_property(1.0f, 0.0f, 100.0f)

std::vector< sbk::core::database_ptr< effect_description > >	m_effectDescriptions

Protected Member Functions inherited from sbk::engine::node
virtual void	gatherParametersFromThis (global_parameter_list &parameters)
	Appends parameters from this node that are relevant to the runtime output.

Protected Attributes inherited from sbk::engine::node_base
sbk::core::database_ptr< node_base >	m_parentNode

sbk::core::database_ptr< node_base >	m_outputBus

std::unordered_set< sbk::core::database_ptr< node_base > >	m_childNodes

Detailed Description

Base container type. Inherited types include sounds, random, sequence etc.

Member Function Documentation

◆ can_add_child_type()

bool sbk::engine::container::can_add_child_type ( const rttr::type & childType ) const

overridevirtual

Reimplemented from sbk::engine::node_base.

◆ gather_children_for_play()

virtual void sbk::engine::container::gather_children_for_play ( gather_children_context & context ) const

pure virtual

Collects and gathers sounds on this node and its children for play.

Given a context object with parameters relevant to the local reference, chooses which sounds/containers to play.

Parameters

context for this gather sounds call.

Implemented in sbk::engine::BlendContainer, sbk::engine::RandomContainer, sbk::engine::sequence_container, sbk::engine::sound_container, and sbk::engine::switch_container.

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

/var/www/soundbakery/sound-bakery/src/sound_bakery/node/container/container.h
/var/www/soundbakery/sound-bakery/src/sound_bakery/node/container/container.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ can_add_child_type()

◆ gather_children_for_play()