Murl::Graph::IScalable Interface Reference

The IScalable property interface. More...

#include <murl_graph_i_scalable.h>

Detailed Description

The IScalable property interface.

This interface provides setting and retrieving of a scale factor, either as a uniform value or individual values for scaling along the X, Y and Z axes.

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

Inheritance diagram for Murl::Graph::IScalable:

Public Member Functions
virtual Bool	SetScaleFactor (const Vector &scaleFactor)=0
	Set individual scaling factors for the X, Y and Z axes. More...
virtual Bool	SetScaleFactor (Real x, Real y, Real z)=0
	Set individual scaling factors for the X, Y and Z axes. More...
virtual Bool	SetScaleFactor (Real s)=0
	Set a uniform scaling factor for all three axes. More...
virtual Bool	SetScaleFactorX (Real x)=0
	Set the scaling factor for the X axis only. More...
virtual Bool	SetScaleFactorY (Real y)=0
	Set the scaling factor for the Y axis only. More...
virtual Bool	SetScaleFactorZ (Real z)=0
	Set the scaling factor for the Z axis only. More...
virtual const Vector &	GetScaleFactor () const =0
	Get the scaling factors for the X, Y and Z axes. More...
virtual Real	GetScaleFactorX () const =0
	Get the scaling factor for the X axis. More...
virtual Real	GetScaleFactorY () const =0
	Get the scaling factor for the Y axis. More...
virtual Real	GetScaleFactorZ () const =0
	Get the scaling factor for the Z axis. More...

Member Function Documentation

SetScaleFactor() [1/3]

virtual Bool Murl::Graph::IScalable::SetScaleFactor ( const Vector &  scaleFactor )

pure virtual

Set individual scaling factors for the X, Y and Z axes.

Parameters

scaleFactor

A vector containing individual scale factors.

Returns

true if successful.

SetScaleFactor() [2/3]

virtual Bool Murl::Graph::IScalable::SetScaleFactor ( Real  x, Real  y, Real  z  )

pure virtual

Set individual scaling factors for the X, Y and Z axes.

Parameters

x	The scale factor for the X axis.
y	The scale factor for the Y axis.
z	The scale factor for the Z axis.

Returns

true if successful.

SetScaleFactor() [3/3]

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

pure virtual

Set a uniform scaling factor for all three axes.

Parameters

s	The scale factor for the X, Y and Z axes.

Returns

true if successful.

SetScaleFactorX()

virtual Bool Murl::Graph::IScalable::SetScaleFactorX ( Real  x )

pure virtual

Set the scaling factor for the X axis only.

Parameters

x	The scale factor for the X axis.

Returns

true if successful.

SetScaleFactorY()

virtual Bool Murl::Graph::IScalable::SetScaleFactorY ( Real  y )

pure virtual

Set the scaling factor for the Y axis only.

Parameters

y	The scale factor for the Y axis.

Returns

true if successful.

SetScaleFactorZ()

virtual Bool Murl::Graph::IScalable::SetScaleFactorZ ( Real  z )

pure virtual

Set the scaling factor for the Z axis only.

Parameters

z	The scale factor for the Z axis.

Returns

true if successful.

GetScaleFactor()

virtual const Vector& Murl::Graph::IScalable::GetScaleFactor ( ) const

pure virtual

Get the scaling factors for the X, Y and Z axes.

Returns

A vector containing the individual scale factors.

GetScaleFactorX()

virtual Real Murl::Graph::IScalable::GetScaleFactorX ( ) const

pure virtual

Get the scaling factor for the X axis.

Returns

The scale factor for the X axis.

GetScaleFactorY()

virtual Real Murl::Graph::IScalable::GetScaleFactorY ( ) const

pure virtual

Get the scaling factor for the Y axis.

Returns

The scale factor for the Y axis.

GetScaleFactorZ()

virtual Real Murl::Graph::IScalable::GetScaleFactorZ ( ) const

pure virtual

Get the scaling factor for the Z axis.

Returns

The scale factor for the Z axis.

---

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

• murl_graph_i_scalable.h