HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TIL_ImageSourcePostprocessor Class Referenceabstract

#include <TIL_ImageSource.h>

+ Inheritance diagram for TIL_ImageSourcePostprocessor:

Public Member Functions

 TIL_ImageSourcePostprocessor (TIL_ImageSource &source)
 
virtual ~TIL_ImageSourcePostprocessor ()
 
virtual void getImageBounds (const TIL_Plane &plane, int array_index, fpreal t, int xres, int yres, const UT_Options &options, int &x1, int &y1, int &x2, int &y2)=0
 
virtual int getImage (TIL_Raster *image, fpreal t, int xres, int yres, const TIL_Plane &plane, int array_index, int xstart, int ystart, int xend, int yend, float gamma, const UT_Options &options, bool include_alpha, bool is_interactive, int fxres, int fyres)=0
 
virtual const TIL_SequencegetSequence (fpreal t, const UT_Options &options)=0
 
virtual bool isEnabled () const =0
 If false, the postprocessor will be ignored. More...
 
virtual int getVersion () const
 

Protected Member Functions

TIL_ImageSourcegetSource ()
 Get the source which this postprocessor is postprocessing. More...
 
- Protected Member Functions inherited from UT_NonCopyableNS::UT_NonCopyable
 UT_NonCopyable ()=default
 
 ~UT_NonCopyable ()=default
 
 UT_NonCopyable (const UT_NonCopyable &)=delete
 
UT_NonCopyableoperator= (const UT_NonCopyable &)=delete
 

Detailed Description

Interface that allows another class to override the behaviour of a TIL_ImageSource. The purpose is to allow postprocessing effects such as slap compositing to be applied to any TIL_ImageSource.

Definition at line 62 of file TIL_ImageSource.h.

Constructor & Destructor Documentation

TIL_ImageSourcePostprocessor::TIL_ImageSourcePostprocessor ( TIL_ImageSource source)
inline

The lifetime of the postprocessor must not exceed that of the reference image source that postprocessing will be applied to.

Definition at line 67 of file TIL_ImageSource.h.

virtual TIL_ImageSourcePostprocessor::~TIL_ImageSourcePostprocessor ( )
inlinevirtual

Definition at line 69 of file TIL_ImageSource.h.

Member Function Documentation

virtual int TIL_ImageSourcePostprocessor::getImage ( TIL_Raster image,
fpreal  t,
int  xres,
int  yres,
const TIL_Plane plane,
int  array_index,
int  xstart,
int  ystart,
int  xend,
int  yend,
float  gamma,
const UT_Options options,
bool  include_alpha,
bool  is_interactive,
int  fxres,
int  fyres 
)
pure virtual
virtual void TIL_ImageSourcePostprocessor::getImageBounds ( const TIL_Plane plane,
int  array_index,
fpreal  t,
int  xres,
int  yres,
const UT_Options options,
int x1,
int y1,
int x2,
int y2 
)
pure virtual
virtual const TIL_Sequence* TIL_ImageSourcePostprocessor::getSequence ( fpreal  t,
const UT_Options options 
)
pure virtual
TIL_ImageSource& TIL_ImageSourcePostprocessor::getSource ( )
inlineprotected

Get the source which this postprocessor is postprocessing.

Definition at line 101 of file TIL_ImageSource.h.

virtual int TIL_ImageSourcePostprocessor::getVersion ( ) const
inlinevirtual

The version is incremented whenever the postprocessor changes its behaviour, to indicate that any cached results are outdated.

Definition at line 97 of file TIL_ImageSource.h.

virtual bool TIL_ImageSourcePostprocessor::isEnabled ( ) const
pure virtual

If false, the postprocessor will be ignored.


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