Mako 9.1.0 API
MakoCore SDK API Documentation
Loading...
Searching...
No Matches
IDOMGroupingFunction Class Referenceabstract

Interface to encapsulate an array of x-input-1-output functions. More...

#include <edl/idomfunction.h>

Inheritance diagram for IDOMGroupingFunction:
[legend]

Classes

class  Data
 Initialization data. More...

Public Member Functions

virtual ~IDOMGroupingFunction ()
virtual uint32 getNumFunctions () const =0
 Get the number of functions in the group.
virtual IDOMFunctionPtr getFunctionAtIndex (uint32 index) const =0
 Get the function for a given function index.
Public Member Functions inherited from IDOMFunction
virtual ~IDOMFunction ()
virtual eFunctionType getFunctionType () const =0
 Retrieves function type.
virtual uint32 getNumInputValues () const =0
 Get the number of input values that this function will operate on.
virtual uint32 getNumOutputValues () const =0
 Get the number of output values that this function will produce.
virtual void getInputDomain (uint32 inputNum, float &low, float &high) const =0
 Get the input domain for a given input to the function.
virtual bool getOutputRange (uint32 outputNum, float &low, float &high) const =0
 Get the output range for a given input to the function.
virtual void evaluate (const float *inputValues, float *outputValues) const =0
 Evaluate the input through the function and return the result.
virtual void evaluate (const int32 *inputValues, float *outputValues) const =0
 Evaluate the input through the function and return the result.
Public Member Functions inherited from IEDLObject
virtual const CClassID & getClassID () const =0
 Returns class ID of IEDLObject.
virtual bool init (CClassParams *pData)
 The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
 Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void addRef () const =0
 Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool decRef () const =0
 Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to.
Public Member Functions inherited from IDOMHashable
virtual ~IDOMHashable ()
 Virtual destructor.
virtual bool hash (uint64 &hash)=0
 Retrieve a hash for this object.
virtual uint64 hashE ()
 As hash(), but throws an exception if the operation fails.

Static Public Member Functions

static const CClassID & classID ()
 Retrieves class id of IDOM.

Additional Inherited Members

Public Types inherited from IDOMFunction
enum  eFunctionType {
  eFTSampled , eFTExponential , eFTStitching , eFTGrouping ,
  eFTPostScriptCalculator
}
 An enum for the various types of functions. More...
Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.

Detailed Description

Interface to encapsulate an array of x-input-1-output functions.

      This allows an array of \e n x-input-1-output functions to be treated as a
      single x-input-n-output function. This is used in particular to represent
      arrays of functions present in certain shading patterns.

Constructor & Destructor Documentation

◆ ~IDOMGroupingFunction()

virtual IDOMGroupingFunction::~IDOMGroupingFunction ( )
inlinevirtual

Member Function Documentation

◆ classID()

const CClassID & IDOMGroupingFunction::classID ( )
inlinestatic

Retrieves class id of IDOM.

Returns
CClassID class id of the element.

◆ getFunctionAtIndex()

virtual IDOMFunctionPtr IDOMGroupingFunction::getFunctionAtIndex ( uint32 index) const
pure virtual

Get the function for a given function index.

Parameters
indexA zero based index for the desired function.
Returns
IDOMFunctionPtr The function.

◆ getNumFunctions()

virtual uint32 IDOMGroupingFunction::getNumFunctions ( ) const
pure virtual

Get the number of functions in the group.

Returns
uint32 The number of functions.

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