Mako 7.3.0 API
IDOMStitchingFunction Class Referenceabstract

Interface for stitching functions. See section 3.9.3 of the PDF 1.7 Reference. Default values are as per described in that reference. There can only be one input for this function, and the functions contained therein must also handle one input. More...

#include <idomfunction.h>

Inheritance diagram for IDOMStitchingFunction:

Classes

class  Data
 Initialization data. More...
 

Public Member Functions

virtual uint32 getNumFunctions () const =0
 Get the number of functions that are stitched. More...
 
virtual IDOMFunctionPtr getFunctionAtIndex (uint32 index) const =0
 Get the function for a given function index. More...
 
virtual const CEDLVector< float > & getBoundsVector () const =0
 Get a reference to the bounds vector for this function. More...
 
virtual const CEDLVector< float > & getEncodeVector () const =0
 Get a reference to the encode vector for this function. More...
 
- Public Member Functions inherited from IDOMFunction
virtual eFunctionType getFunctionType () const =0
 Retrieves function type. More...
 
virtual uint32 getNumInputValues () const =0
 Get the number of input values that this function will operate on. More...
 
virtual uint32 getNumOutputValues () const =0
 Get the number of output values that this function will produce. More...
 
virtual void getInputDomain (uint32 inputNum, float &low, float &high) const =0
 Get the input domain for a given input to the function. More...
 
virtual bool getOutputRange (uint32 outputNum, float &low, float &high) const =0
 Get the output range for a given input to the function. More...
 
virtual void evaluate (const float *inputValues, float *outputValues) const =0
 Evaluate the input through the function and return the result. More...
 
virtual void evaluate (const int32 *inputValues, float *outputValues) const =0
 Evaluate the input through the function and return the result. More...
 
- Public Member Functions inherited from IEDLObject
virtual const CClassIDgetClassID () const =0
 Returns class ID of IEDLObject. More...
 
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. More...
 
virtual bool clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
 Create a copy of EDLObject. More...
 
- 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. More...
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to. More...
 
- Public Member Functions inherited from IDOMHashable
virtual ~IDOMHashable ()
 Virtual destructor.
 
virtual bool hash (uint64 &hash)=0
 Retrieve a hash for this object. More...
 
virtual uint64 hashE ()
 As hash(), but throws an exception if the operation fails. More...
 

Static Public Member Functions

static const CClassIDclassID ()
 Retrieves class id of IDOM. More...
 

Additional Inherited Members

- Public Types inherited from IDOMFunction
enum  eFunctionType
 An enum for the various types of functions.
 
- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

Interface for stitching functions. See section 3.9.3 of the PDF 1.7 Reference. Default values are as per described in that reference. There can only be one input for this function, and the functions contained therein must also handle one input.

Member Function Documentation

◆ classID()

static const CClassID& IDOMStitchingFunction::classID ( )
inlinestatic

Retrieves class id of IDOM.

Returns
CClassID class id of the element

◆ getBoundsVector()

virtual const CEDLVector<float>& IDOMStitchingFunction::getBoundsVector ( ) const
pure virtual

Get a reference to the bounds vector for this function.

Returns
CEDLVector<float> Reference to a constant CEDLBuffer<float> containing the bounds.

◆ getEncodeVector()

virtual const CEDLVector<float>& IDOMStitchingFunction::getEncodeVector ( ) const
pure virtual

Get a reference to the encode vector for this function.

Returns
CEDLVector<float> Reference to a constant CEDLBuffer<float> containing the encode.

◆ getFunctionAtIndex()

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

Get the function for a given function index.

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

◆ getNumFunctions()

virtual uint32 IDOMStitchingFunction::getNumFunctions ( ) const
pure virtual

Get the number of functions that are stitched.

Returns
uint32 The number of functions

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