BRAY_FilterBase Class Reference

Base class for image filters. These are any filters which process AOV data. More...

#include <BRAY_FilterBase.h>

Inheritance diagram for BRAY_FilterBase:

Public Member Functions
	BRAY_FilterBase (const UT_Options *o)
virtual	~BRAY_FilterBase ()
virtual const char *	className () const =0
	Return an identifier for this plugin. More...
void	initialize (BRAY_FilterInit &init, const UT_StringArray &all_aovs)
SYS_HashType	optionsHash () const
	Hash of the options passed to the constructor. More...
virtual bool	getAOVs (BRAY_FilterInit &init, const UT_StringArray &available, UT_StringArray &write, UT_StringArray &read)=0
virtual const UT_StringHolder &	errorMessage () const
UT_StringHolder	makeError (const char *fmt,...) SYS_PRINTF_CHECK_ATTRIBUTE(2
	Convenience method to add an error using printf style formatting. More...
const UT_StringArray &	writePlanes () const
const UT_StringArray &	readPlanes () const

Detailed Description

Base class for image filters. These are any filters which process AOV data.

Definition at line 25 of file BRAY_FilterBase.h.

Constructor & Destructor Documentation

BRAY_FilterBase::BRAY_FilterBase

(

const UT_Options *

o

)

virtual BRAY_FilterBase::~BRAY_FilterBase ( )

virtual

Member Function Documentation

virtual const char* BRAY_FilterBase::className ( ) const

pure virtual

Return an identifier for this plugin.

virtual const UT_StringHolder& BRAY_FilterBase::errorMessage ( ) const

inlinevirtual

Return the error if processImage() fails. By default, this returns an empty string.

Definition at line 71 of file BRAY_FilterBase.h.

virtual bool BRAY_FilterBase::getAOVs ( BRAY_FilterInit &  init, const UT_StringArray &  available, UT_StringArray &  write, UT_StringArray &  read  )

pure virtual

The list of available AOV planes in the render is passed in. This is the list the renderer has been told to create. The plugin should fill the string array of planes which it will write into, but also planes which it will read from. For example, if you want to apply color correction to an image plane, you would need to add the plane to the write array but also to the read array.

The method should return true if the plugin is valid (false if invalid).

void BRAY_FilterBase::initialize ( BRAY_FilterInit &  init, const UT_StringArray &  all_aovs  )

inline

Definition at line 40 of file BRAY_FilterBase.h.

UT_StringHolder BRAY_FilterBase::makeError	(	const char *	fmt,
			...
	)

Convenience method to add an error using printf style formatting.

SYS_HashType BRAY_FilterBase::optionsHash ( ) const

inline

Hash of the options passed to the constructor.

Definition at line 53 of file BRAY_FilterBase.h.

const UT_StringArray& BRAY_FilterBase::readPlanes ( ) const

inline

Return the rasters written and read by this plugin (as computed during initialization)

Definition at line 38 of file BRAY_FilterBase.h.

const UT_StringArray& BRAY_FilterBase::writePlanes ( ) const

inline

Return the rasters written and read by this plugin (as computed during initialization)

Definition at line 37 of file BRAY_FilterBase.h.

---

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

• BRAY/BRAY_FilterBase.h