SB::Engine::SwitchContainer Class Reference

Inheritance diagram for SB::Engine::SwitchContainer:

Collaboration diagram for SB::Engine::SwitchContainer:

Public Member Functions
void	gatherChildrenForPlay (GatherChildrenContext &context) const override
	Collects and gathers sounds on this node and its children for play.
void	gatherParametersFromThis (GlobalParameterList &parameters) override
	Appends parameters from this node that are relevant to the runtime output.
void	setSwitchParameter (SB::Core::DatabasePtr< NamedParameter > parameter)
SB::Core::DatabasePtr< NamedParameter >	getSwitchParameter () const
std::unordered_map< SB::Core::DatabasePtr< NamedParameterValue >, SB::Core::ChildPtr< Container > >	getSwitchToChildMap () const
Public Member Functions inherited from SB::Engine::Container
void	onLoaded () override
bool	canAddChild (const SB::Core::DatabasePtr< NodeBase > &child) const override
Public Member Functions inherited from SB::Engine::Node
virtual void	gatherParameters (GlobalParameterList &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 SB::Engine::NodeBase
virtual void	setParentNode (const SB::Core::DatabasePtr< NodeBase > &parent)
virtual void	setOutputBus (const SB::Core::DatabasePtr< NodeBase > &bus)
SB_NODE_STATUS	getNodeStatus () const noexcept
NodeBase *	parent () const
NodeBase *	outputBus () const
void	addChild (const SB::Core::DatabasePtr< NodeBase > &child)
void	removeChild (const SB::Core::DatabasePtr< NodeBase > &child)
std::vector< NodeBase * >	getChildren () const
std::size_t	getChildCount () const
bool	hasChild (const SB::Core::DatabasePtr< NodeBase > &test) const
void	gatherAllDescendants (std::vector< NodeBase * > &descendants) const
void	gatherAllParents (std::vector< NodeBase * > &parents) const
Public Member Functions inherited from SB::Core::DatabaseObject
SB_ID	getDatabaseID () const
void	setDatabaseID (SB_ID id)
std::string_view	getDatabaseName () const
void	setDatabaseName (std::string_view name)
bool	getEditorHidden () const
void	setEditorHidden (bool hidden)
	operator SB_ID () const
Public Member Functions inherited from SB::Core::Object
template<typename T >
T *	tryConvertObject () noexcept
	Gets the most derived type of this object and upcasts it to T.
template<typename T >
const T *	tryConvertObject () const noexcept
rttr::type	getType () const
Public Member Functions inherited from SB::Core::ObjectUtilities
SB::Engine::System *	getSystem () const
sc_system *	getChef () const
ma_engine *	getMini () const
Public Member Functions inherited from SB::Core::DatabaseObjectUtilities
virtual void	onProjectLoaded ()
virtual void	onDestroy ()

Additional Inherited Members
Public Attributes inherited from SB::Engine::Node
SB::Core::FloatProperty	m_volume = SB::Core::FloatProperty(1.0f, 0.0f, 1.0f)
SB::Core::FloatProperty	m_pitch = SB::Core::FloatProperty(1.0f, 0.0f, 1.0f)
SB::Core::FloatProperty	m_lowpass = SB::Core::FloatProperty(1.0f, 0.0f, 100.0f)
SB::Core::FloatProperty	m_highpass = SB::Core::FloatProperty(1.0f, 0.0f, 100.0f)
std::vector< SB::Core::DatabasePtr< EffectDescription > >	m_effectDescriptions
Public Attributes inherited from SB::Core::ObjectUtilities
std::string	m_debugName
Protected Attributes inherited from SB::Engine::NodeBase
SB::Core::DatabasePtr< NodeBase >	m_parentNode
SB::Core::DatabasePtr< NodeBase >	m_outputBus
std::unordered_set< SB::Core::DatabasePtr< NodeBase > >	m_childNodes

Member Function Documentation

gatherChildrenForPlay()

void SB::Engine::SwitchContainer::gatherChildrenForPlay ( GatherChildrenContext &  context ) const

inlineoverridevirtual

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.

Implements SB::Engine::Container.

gatherParametersFromThis()

void SB::Engine::SwitchContainer::gatherParametersFromThis ( GlobalParameterList &  parameters )

inlineoverridevirtual

Appends parameters from this node that are relevant to the runtime output.

Called from gatherParameters.

Parameters

parameters

to append to.

Reimplemented from SB::Engine::Node.

---

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

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