The IIndexed property interface. More...

#include "murl_graph_i_indexed.h"

Inheritance diagram for Murl::Graph::IIndexed:

Public Member Functions

virtual Bool SetIndex (SInt32 index)=0
 Set the current index. More...
 
virtual SInt32 GetIndex () const =0
 Get the current index. More...
 
virtual SInt32 GetFirstIndex () const =0
 Get the lowest valid index. More...
 
virtual UInt32 GetNumberOfIndices () const =0
 Get the total number of valid indices. More...
 

Detailed Description

The IIndexed property interface.

This interface provides a common way to set a generic index for an object. The meaning of the index property is not explicitly defined; nodes may use the given value for e.g. indexing into their children (see Graph::ISwitch), indexing into an atlas resource (see Graph::IPlaneSequenceGeometry) or whatever other purpose suitable.

Animation controllers may call the SetIndex() method when index keys are present in a given Resource::IAnimation.

Member Function Documentation

◆ SetIndex()

virtual Bool Murl::Graph::IIndexed::SetIndex ( SInt32  index)
pure virtual

Set the current index.

Parameters
indexThe signed index to set.
Returns
true if successful.

◆ GetIndex()

virtual SInt32 Murl::Graph::IIndexed::GetIndex ( ) const
pure virtual

Get the current index.

Returns
The current index.

◆ GetFirstIndex()

virtual SInt32 Murl::Graph::IIndexed::GetFirstIndex ( ) const
pure virtual

Get the lowest valid index.

Returns
The lowest valid index.

◆ GetNumberOfIndices()

virtual UInt32 Murl::Graph::IIndexed::GetNumberOfIndices ( ) const
pure virtual

Get the total number of valid indices.

Returns
The total number of indices.

The documentation for this interface was generated from the following file:
  • murl_graph_i_indexed.h


Copyright © 2011-2024 Spraylight GmbH.