Murl::Graph::ITextStyleImage Interface Reference

The ITextStyleImage graph node interface. More...

#include "murl_graph_i_text_style_image.h"

Inheritance diagram for Murl::Graph::ITextStyleImage:

Public Member Functions
virtual INode *	GetNodeInterface ()=0
	Get the mutable Graph::INode interface. More...
virtual const INode *	GetNodeInterface () const =0
	Get the constant Graph::INode interface. More...
virtual IAtlasResourceTarget *	GetAtlasResourceTarget ()=0
	Get a mutable Graph::IAtlasResourceTarget container. More...
virtual const IAtlasResourceTarget *	GetAtlasResourceTarget () const =0
	Get a constant Graph::IAtlasResourceTarget container. More...
virtual Bool	SetRectangleName (const String &rectangleName)=0
	Set the current atlas rectangle by name. More...
virtual String	GetRectangleName () const =0
	Get the current rectangle's name. More...
virtual Bool	SetRectangleIndex (SInt32 index)=0
	Set the current rectangle index. More...
virtual SInt32	GetRectangleIndex () const =0
	Get the current rectangle index. More...
virtual Bool	SetScaleFactor (Real s)=0
	Set th scaling factor. More...
virtual Real	GetScaleFactor () const =0
	Get the scaling factor. More...
virtual Bool	SetMaterialSlot (SInt32 slot)=0
	Set the material slot used for rendering. More...
virtual SInt32	GetMaterialSlot () const =0
	Get the material slot used for rendering. More...
virtual Bool	SetTextureSlot (UInt32 unit, SInt32 slot)=0
	Set the texture slot used for rendering. More...
virtual SInt32	GetTextureSlot (UInt32 unit) const =0
	Get the texture slot used for rendering. More...
virtual Real	GetFrameSizeX () const =0
	Get the width of the currently displayed atlas rectangle. More...
virtual Real	GetFrameSizeY () const =0
	Get the height of the currently displayed atlas rectangle. More...
Public Member Functions inherited from Murl::Graph::ITagged
virtual Bool	SetStartTag (const String &tag)=0
	Set the start tag. More...
virtual const String &	GetStartTag () const =0
	Get the start tag. More...
virtual Bool	SetEndTag (const String &tag)=0
	Set the end tag. More...
virtual const String &	GetEndTag () const =0
	Get the end tag. More...

Detailed Description

The ITextStyleImage graph node interface.

Member Function Documentation

GetNodeInterface() [1/2]

virtual INode* Murl::Graph::ITextStyleImage::GetNodeInterface ( )

pure virtual

Get the mutable Graph::INode interface.

This method returns a mutable pointer to the node's Graph::INode interface, to be able to query or modify common node properties such as active state, visibility or ID.

Returns

The mutable Graph::INode interface, or null if not available

GetNodeInterface() [2/2]

virtual const INode* Murl::Graph::ITextStyleImage::GetNodeInterface ( ) const

pure virtual

Get the constant Graph::INode interface.

This method returns a constant pointer to the node's Graph::INode interface, to be able to query common node properties such as active state, visibility or ID.

Returns

The constant Graph::INode interface, or null if not available

GetAtlasResourceTarget() [1/2]

virtual IAtlasResourceTarget* Murl::Graph::ITextStyleImage::GetAtlasResourceTarget ( )

pure virtual

Get a mutable Graph::IAtlasResourceTarget container.

This method returns a mutable pointer to a Graph::IAtlasResourceTarget container, which allows to add, remove or query the atlas resources referenced by a node implementing this interface.

Returns

The mutable Graph::IAtlasResourceTarget container, or null if not available

GetAtlasResourceTarget() [2/2]

virtual const IAtlasResourceTarget* Murl::Graph::ITextStyleImage::GetAtlasResourceTarget ( ) const

pure virtual

Get a constant Graph::IAtlasResourceTarget container.

This method returns a constant pointer to a Graph::IAtlasResourceTarget container, which allows to query the atlas resources referenced by a node implementing this interface.

Returns

The constant Graph::IAtlasResourceTarget container, or null if not available

SetRectangleName()

virtual Bool Murl::Graph::ITextStyleImage::SetRectangleName ( const String &  rectangleName )

pure virtual

Set the current atlas rectangle by name.

If the given name is empty, the rectangle is explicitly set via a given index (see SetIndex()). This method fails if no atlas resource is set, or the given name is not found within the atlas resource.

Parameters

rectangleName

The rectangle name.

Returns

true if successful.

GetRectangleName()

virtual String Murl::Graph::ITextStyleImage::GetRectangleName ( ) const

pure virtual

Get the current rectangle's name.

This method returns an empty string when no atlas resource is defined or the currently active rectangle is unnamed.

Returns

The rectangle name if available.

SetRectangleIndex()

virtual Bool Murl::Graph::ITextStyleImage::SetRectangleIndex ( SInt32  index )

pure virtual

Set the current rectangle index.

Parameters

index

The signed index to set.

Returns

true if successful.

GetRectangleIndex()

virtual SInt32 Murl::Graph::ITextStyleImage::GetRectangleIndex ( ) const

pure virtual

Get the current rectangle index.

Returns

The current index.

SetScaleFactor()

virtual Bool Murl::Graph::ITextStyleImage::SetScaleFactor ( Real  s )

pure virtual

Set th scaling factor.

Parameters

s	The scale factor.

Returns

true if successful.

GetScaleFactor()

virtual Real Murl::Graph::ITextStyleImage::GetScaleFactor ( ) const

pure virtual

Get the scaling factor.

Returns

The scale factor.

SetMaterialSlot()

virtual Bool Murl::Graph::ITextStyleImage::SetMaterialSlot ( SInt32  slot )

pure virtual

Set the material slot used for rendering.

Parameters

slot	The material slot.

Returns

true if successful.

GetMaterialSlot()

virtual SInt32 Murl::Graph::ITextStyleImage::GetMaterialSlot ( ) const

pure virtual

Get the material slot used for rendering.

Returns

The material slot.

SetTextureSlot()

virtual Bool Murl::Graph::ITextStyleImage::SetTextureSlot ( UInt32  unit, SInt32  slot  )

pure virtual

Set the texture slot used for rendering.

Parameters

unit	The texture unit for which to set the slot.
slot	The texture slot.

Returns

true if successful.

GetTextureSlot()

virtual SInt32 Murl::Graph::ITextStyleImage::GetTextureSlot ( UInt32  unit ) const

pure virtual

Get the texture slot used for rendering.

Parameters

unit	The texture unit for which to query the slot.

Returns

The texture slot.

GetFrameSizeX()

virtual Real Murl::Graph::ITextStyleImage::GetFrameSizeX ( ) const

pure virtual

Get the width of the currently displayed atlas rectangle.

Returns

The current atlas rectangle width.

GetFrameSizeY()

virtual Real Murl::Graph::ITextStyleImage::GetFrameSizeY ( ) const

pure virtual

Get the height of the currently displayed atlas rectangle.

Returns

The current atlas rectangle height.

---

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

• murl_graph_i_text_style_image.h