Murl Engine API  Version 2024.1
Murl::Resource::IInstance Interface Referenceabstract

The IInstance resource interface. More...

#include <murl_resource_i_instance.h>

Detailed Description

The IInstance resource interface.

This interface provides methods to query information about any optional graph or script instances that must be created when a package has been successfully loaded.

Inheritance diagram for Murl::Resource::IInstance:
Murl::Resource::Instance

Public Member Functions

virtual const StringGetResourceId () const =0
 Get the resource ID of the Resource::IGraph to instantiate. More...
 
virtual const StringGetParentNodeId () const =0
 Get the ID of an existing node in the scene graph where to add the instance. More...
 
virtual UInt32 GetNumberOfReplications () const =0
 Get the desired number of replications. More...
 
virtual Bool SetTags (const StringArray &tags)=0
 Set optional resource tags for this object. More...
 
virtual const StringArrayGetTags () const =0
 Get the optional resource tags held by this object. More...
 

Member Function Documentation

◆ GetResourceId()

virtual const String& Murl::Resource::IInstance::GetResourceId ( ) const
pure virtual

Get the resource ID of the Resource::IGraph to instantiate.

Returns
The resource ID.

◆ GetParentNodeId()

virtual const String& Murl::Resource::IInstance::GetParentNodeId ( ) const
pure virtual

Get the ID of an existing node in the scene graph where to add the instance.

Returns
The parent node ID.

◆ GetNumberOfReplications()

virtual UInt32 Murl::Resource::IInstance::GetNumberOfReplications ( ) const
pure virtual

Get the desired number of replications.

Returns
The number of replications.

◆ SetTags()

virtual Bool Murl::Resource::IInstance::SetTags ( const StringArray tags)
pure virtual

Set optional resource tags for this object.

Parameters
tagsThe resource tags.
Returns
true if successful.

◆ GetTags()

virtual const StringArray& Murl::Resource::IInstance::GetTags ( ) const
pure virtual

Get the optional resource tags held by this object.

Returns
The resource tags.

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