Class controlling a sound sub tree for GraphInstanceObjects usage. More...

#include <murl_logic_graph_sound_instance.h>

Detailed Description

Class controlling a sound sub tree for GraphInstanceObjects usage.

MyLogic.h

#include "murl_logic_graph_instance_objects.h"
#include "murl_logic_graph_sound_instance.h"
...
Logic::GraphInstanceObjects<Logic::GraphSoundInstance> mMyInstances;

MyLogic.cpp

Bool App::MyLogic::OnInit(const Logic::IState* state)
{
    const Graph::IRoot* root = state->GetGraphRoot();
    if (!mMyInstances.Init(root, "/MY_LOCATION", "/MY_INSTANCE_NODE", "/MY_INSTANCE"))
    {
        return false;
    }
    // other stuff
    return true;
}
Bool App::MyLogic::OnDeInit(const Logic::IState* state)
{
    Bool ret = true;
    // other stuff
    if (!mMyInstances.DeInit())
    {
        ret = false;
    }
    return ret;
}

MyGraph.xml

<Namespace id="MY_LOCATION">
  <Instance id="MY_INSTANCE_NODE" graphResourceId="MyInstanceXml" replications="10"
</Namespace>

MyInstance.xml

<Graph>
  <Namespace id="MY_INSTANCE{replication}" activeAndVisible="no">
    <Timeline id="timeline">
      <AudioSequence id="sequence"/>
    </Timeline>
  </Namespace>
</Graph>

Alternatively a replication with anonymous namespace can be accessed as follows.

Bool App::MyLogic::OnInit(const Logic::IState* state)
{
    if (!mMyInstances.Init(root->GetRootNamespace(), "/MY_LOCATION/MY_INSTANCE_NODE"))
    {
        return false;
    }
    // other stuff
    return true;
}

MyInstance.xml

<Graph>
  <Namespace activeAndVisible="no">
    <Timeline id="timeline">
      <AudioSequence id="sequence"/>
    </Timeline>
  </Namespace>
</Graph>

Inheritance diagram for Murl::Logic::GraphSoundInstance:

Public Member Functions
	GraphSoundInstance (Real masterVolume=static_cast< Real >(1.0))
	The default constructor. More...

	~GraphSoundInstance () override
	The destructor.

Bool	Init (INodeObserver nodeObserver, const Graph::IRoot root, const String &replicationIdPath, SInt32 index) override
	Initialize the object. More...

Bool	Init (INodeObserver nodeObserver, Graph::INode replicationNode, SInt32 index) override
	Initialize the object. More...

Bool	DeInit () override
	Deinitialize the object. More...

void	SetObtained (Bool isObtained) override
	Set the obtained state. More...

virtual Bool	Init (INodeObserver nodeObserver, const Graph::IRoot root, const String &timelinePath, const String &sequencePath, SInt32 index)
	Initialize the object. More...

virtual Bool	Init (INodeObserver nodeObserver, Graph::INamespace namespaceNode, const String &timelinePath, const String &sequencePath, SInt32 index)
	Initialize the object. More...

Public Member Functions inherited from Murl::Logic::BaseStepable
	BaseStepable ()
	The default constructor. More...

	~BaseStepable () override
	The destructor. More...

	operator IStepablePtr ()
	Conversion operator. More...

Public Member Functions inherited from Murl::Logic::Stepable
	~Stepable () override
	The destructor.

Bool	SetAppStepable (IAppStepablePtr appStepable) override
	Implementation of IStepable::SetAppStepable() method. More...

void	SetEnabled (Bool isEnabled) override
	Implementation of IStepable::SetEnabled() method. More...

Bool	IsEnabled () const override
	Implementation of IStepable::IsEnabled() method. More...

void	Reset () override
	Implementation of IStepable::Reset() method.

void	ProcessTick (const Logic::IState *state) override
	Implementation of IStepable::ProcessTick() method. More...

void	FinishTick (const Logic::IState *state) override
	Implementation of IStepable::FinishTick() method. More...

Public Member Functions inherited from Murl::Logic::GraphSoundObject
	GraphSoundObject ()
	The default constructor. More...

	GraphSoundObject (Real masterVolume)
	Constructor taking a master volume. More...

virtual	~GraphSoundObject ()
	The destructor.

virtual Bool	Init (INodeObserver nodeObserver, const Graph::IRoot root, const String &timelinePath, const String &sequencePath, SInt32 index)
	Initialize the object. More...

virtual Bool	Init (INodeObserver nodeObserver, Graph::INamespace namespaceNode, const String &timelinePath, const String &sequencePath, SInt32 index)
	Initialize the object. More...

virtual Bool	StartPlaying (Real startTime=0)
	Start playing the sound. More...

virtual Bool	StartPlaying (Real startTime, Real endTime)
	Start playing the sound. More...

virtual Bool	IsPlaying () const
	Check if the sound is playing. More...

virtual Bool	PausePlaying ()
	Pause playing the sound. More...

virtual Bool	ContinuePlaying ()
	Continue playing the sound. More...

virtual Bool	StopPlaying ()
	Stop playing the sound. More...

virtual void	SetVolume (Real volume)
	Set the sound volume. More...

virtual void	SetMasterVolume (Real volume)
	Set the master volume. More...

virtual Real	GetMasterVolume () const
	Get the master volume. More...

Protected Member Functions
void	OnReset () override
	Overwrite of the BaseStepable::OnReset() method. More...

Protected Member Functions inherited from Murl::Logic::BaseStepable
void	OnSetEnabled (Bool isEnabled) override
	Default implementation of IAppStepable::OnSetEnabled() method, this method is empty and can be overwritten. More...

void	OnProcessTick (const Logic::IState *state) override
	Default implementation of IAppStepable::OnProcessTick() method, this method is empty and can be overwritten. More...

void	OnFinishTick (const Logic::IState *state) override
	Default implementation of IAppStepable::OnFinishTick() method, this method is empty and can be overwritten. More...

Additional Inherited Members
Static Public Member Functions inherited from Murl::Logic::Stepable
static IStepablePtr	Create ()
	Create a stepable object. More...

Static Public Member Functions inherited from Murl::Logic::GraphSoundObject
static GraphSoundObjectPtr	Create ()
	Create a GraphSoundObject object. More...

static GraphSoundObjectPtr	Create (Real masterVolume)
	Create a GraphSoundObject object with a given master volume. More...

Public Attributes inherited from Murl::Logic::GraphSoundObject
TimelineNode	mTimelineNode
	The timeline node reference.

AudioSequenceNode	mAudioSequenceNode
	The audio sequence node reference.

Constructor & Destructor Documentation

◆ GraphSoundInstance()

Murl::Logic::GraphSoundInstance::GraphSoundInstance ( Real masterVolume = static_cast<Real>(1.0) )

inline

The default constructor.

Parameters

masterVolume The master volume in range [0.0 .. 1.0].

Member Function Documentation

◆ Init() [1/4]

Bool Murl::Logic::GraphSoundInstance::Init	(	INodeObserver *	nodeObserver,
		const Graph::IRoot *	root,
		const String &	replicationIdPath,
		SInt32	index
	)

inlineoverridevirtual

Initialize the object.

Parameters

nodeObserver	The INodeObserver object.
root	The graph root node.
replicationIdPath	The full path to the replication's graph namespace node.
index	The index of the instance.

Returns: true if successful.

Reimplemented from Murl::Logic::GraphReplication.

◆ Init() [2/4]

Bool Murl::Logic::GraphSoundInstance::Init	(	INodeObserver *	nodeObserver,
		Graph::INode *	replicationNode,
		SInt32	index
	)

inlineoverridevirtual

Initialize the object.

Parameters

nodeObserver	The INodeObserver object.
replicationNode	The replication's graph namespace node.
index	The index of the instance.

Returns: true if successful.

Implements Murl::Logic::GraphReplication.

◆ DeInit()

Bool Murl::Logic::GraphSoundInstance::DeInit ( )

inlineoverridevirtual

Deinitialize the object.

Returns: true if successful.

Implements Murl::Logic::GraphReplication.

◆ SetObtained()

void Murl::Logic::GraphSoundInstance::SetObtained ( Bool isObtained )

inlineoverridevirtual

Set the obtained state.

Parameters

isObtained The obtained state.

Implements Murl::Logic::GraphReplication.

◆ OnReset()

void Murl::Logic::GraphSoundInstance::OnReset ( )

inlineoverrideprotectedvirtual

Overwrite of the BaseStepable::OnReset() method.

Reset the master volume to 1.0 and stop playing.

Reimplemented from Murl::Logic::BaseStepable.

◆ Init() [3/4]

virtual Bool Murl::Logic::GraphSoundObject::Init

inline

Initialize the object.

Parameters

nodeObserver	The INodeObserver object.
root	The graph root node.
timelinePath	The full path to the graph timeline node instance.
sequencePath	The full path to the graph audio sequence node instance.
index	The index of the instance.

Returns: true if successful.

◆ Init() [4/4]

virtual Bool Murl::Logic::GraphSoundObject::Init

inline

Initialize the object.

Parameters

nodeObserver	The INodeObserver object.
namespaceNode	The graph namespace node.
timelinePath	The relative path to the graph timeline node instance.
sequencePath	The relative path to the graph audio sequence node instance.
index	The index of the instance.

Returns: true if successful.

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

murl_logic_graph_sound_instance.h

Detailed Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ GraphSoundInstance()

Member Function Documentation

◆ Init() [1/4]

◆ Init() [2/4]

◆ DeInit()

◆ SetObtained()

◆ OnReset()

◆ Init() [3/4]

◆ Init() [4/4]