TIL_Plane Class Reference

#include <TIL_Plane.h>

Inheritance diagram for TIL_Plane:

Public Member Functions
	TIL_Plane (const char *name, TIL_DataFormat format, const char *n1=0, const char *n2=0, const char *n3=0, const char *n4=0, TIL_TypeInfo typeinfo=TIL_TI_UNDEFINED, PXL_ColorSpace cs=PXL_CS_UNKNOWN, const UT_StringHolder &ocio_colorspace=UT_StringHolder())
	TIL_Plane (const TIL_Plane &)
	TIL_Plane ()
	~TIL_Plane ()
int64	getMemoryUsage (bool inclusive) const
TIL_Plane &	operator= (const TIL_Plane &)
int	operator== (const TIL_Plane &eq) const
int	operator!= (const TIL_Plane &eq) const
bool	matches (const TIL_Plane &) const
bool	isCompatible (const TIL_Plane &) const
const char *	getName () const
void	setName (const char *name)
bool	isAlphaPlane () const
bool	isColorPlane () const
bool	isPointPlane () const
bool	isNormalPlane () const
bool	isDepthPlane () const
bool	isGeometricPlane () const
TIL_DataFormat	getFormat () const
void	setFormat (TIL_DataFormat format)
TIL_TypeInfo	getTypeInfo () const
void	setTypeInfo (TIL_TypeInfo typeinfo)
int	getArraySize () const
void	setArraySize (int n)
int	getVectorSize () const
void	setVectorSize (int n)
const char *	getSubName (int i) const
void	setSubName (const char *subname, int i)
int	hasElement (const char *planename)
int	getPlaneMask (int i) const
void	setPlaneMask (int enable, int i)
void	copyPlaneMask (const TIL_Plane &plane)
void	setScoped (int enable)
bool	isScoped () const
bool	isPartiallyScoped () const
bool	scopeMatches (const TIL_Plane &plane) const
int	getArrayMask (int i) const
void	setArrayMask (int start, int end, int step)
bool	isConstantPlane () const
bool	isConstantComponent (int i) const
bool	isAnyComponentConstant () const
void	setConstantFlag (int i, bool enable)
int	usesBlackWhitePoints () const
void	getBlackWhitePoints (unsigned int &b, unsigned int &w) const
void	getBlackWhitePoints (float &b, float &w) const
void	setBlackWhitePoints (unsigned int b, unsigned int w)
void	debugPrint (std::ostream &os) const
int64	getMemSize () const
void	setColorSpace (PXL_ColorSpace cs, const UT_StringHolder &ocio=UT_StringHolder())
PXL_ColorSpace	getColorSpace () const
const UT_StringHolder &	getOCIOColorSpace () const
unsigned	getHash () const
void	dump () const
void	dump (UT_JSONWriter &w) const

Additional Inherited Members
Static Public Member Functions inherited from UT_SmallObject< TIL_Plane, UT_SMALLOBJECT_CLEANPAGES_OFF, 250, UT_SMALLOBJECT_THREADSAFE_ON >
static void *	operator new (size_t size)
	Regular new/delete operators. More...
static void	operator delete (void *p, size_t size)
	Regular new/delete operators. More...
static void *	operator new (size_t, void *p)
static void	operator delete (void *, void *)

Detailed Description

Examples:

COP2/COP2_FullImageFilter.C, COP2/COP2_FullImageFilter.h, COP2/COP2_MultiInputWipe.C, COP2/COP2_MultiInputWipe.h, COP2/COP2_PixelAdd.C, COP2/COP2_PixelAdd.h, COP2/COP2_SampleFilter.C, COP2/COP2_SampleFilter.h, COP2/COP2_SampleGenerator.C, and COP2/COP2_SampleGenerator.h.

Definition at line 24 of file TIL_Plane.h.

Constructor & Destructor Documentation

TIL_Plane::TIL_Plane	(	const char *	name,
		TIL_DataFormat	format,
		const char *	n1 = 0,
		const char *	n2 = 0,
		const char *	n3 = 0,
		const char *	n4 = 0,
		TIL_TypeInfo	typeinfo = TIL_TI_UNDEFINED,
		PXL_ColorSpace	cs = PXL_CS_UNKNOWN,
		const UT_StringHolder &	ocio_colorspace = UT_StringHolder()
	)

TIL_Plane::TIL_Plane

(

const TIL_Plane &

)

TIL_Plane::TIL_Plane

(

)

TIL_Plane::~TIL_Plane

(

)

Member Function Documentation

void TIL_Plane::copyPlaneMask

(

const TIL_Plane &

plane

)

void TIL_Plane::debugPrint

(

std::ostream &

os

)

const

void TIL_Plane::dump

(

)

const

void TIL_Plane::dump

(

UT_JSONWriter &

w

)

const

int TIL_Plane::getArrayMask

(

int

i

)

const

int TIL_Plane::getArraySize ( ) const

inline

Definition at line 82 of file TIL_Plane.h.

void TIL_Plane::getBlackWhitePoints ( unsigned int &  b, unsigned int &  w  ) const

inline

Definition at line 125 of file TIL_Plane.h.

void TIL_Plane::getBlackWhitePoints	(	float &	b,
		float &	w
	)		const

PXL_ColorSpace TIL_Plane::getColorSpace ( ) const

inline

Definition at line 140 of file TIL_Plane.h.

TIL_DataFormat TIL_Plane::getFormat ( ) const

inline

Definition at line 72 of file TIL_Plane.h.

unsigned TIL_Plane::getHash

(

)

const

int64 TIL_Plane::getMemoryUsage

(

bool

inclusive

)

const

int64 TIL_Plane::getMemSize

(

)

const

const char* TIL_Plane::getName ( ) const

inline

Examples:

COP2/COP2_FullImageFilter.C, and COP2/COP2_MultiInputWipe.C.

Definition at line 61 of file TIL_Plane.h.

const UT_StringHolder& TIL_Plane::getOCIOColorSpace ( ) const

inline

Definition at line 141 of file TIL_Plane.h.

int TIL_Plane::getPlaneMask ( int  i ) const

inline

Definition at line 101 of file TIL_Plane.h.

const char* TIL_Plane::getSubName ( int  i ) const

inline

Definition at line 90 of file TIL_Plane.h.

TIL_TypeInfo TIL_Plane::getTypeInfo ( ) const

inline

Definition at line 76 of file TIL_Plane.h.

int TIL_Plane::getVectorSize ( ) const

inline

Definition at line 86 of file TIL_Plane.h.

int TIL_Plane::hasElement

(

const char *

planename

)

bool TIL_Plane::isAlphaPlane

(

)

const

Examples:

COP2/COP2_PixelAdd.C.

bool TIL_Plane::isAnyComponentConstant

(

)

const

bool TIL_Plane::isColorPlane

(

)

const

bool TIL_Plane::isCompatible

(

const TIL_Plane &

)

const

Examples:

COP2/COP2_MultiInputWipe.C.

bool TIL_Plane::isConstantComponent

(

int

i

)

const

bool TIL_Plane::isConstantPlane

(

)

const

bool TIL_Plane::isDepthPlane

(

)

const

bool TIL_Plane::isGeometricPlane

(

)

const

bool TIL_Plane::isNormalPlane

(

)

const

bool TIL_Plane::isPartiallyScoped

(

)

const

bool TIL_Plane::isPointPlane

(

)

const

bool TIL_Plane::isScoped

(

)

const

bool TIL_Plane::matches

(

const TIL_Plane &

)

const

int TIL_Plane::operator!= ( const TIL_Plane &  eq ) const

inline

Definition at line 53 of file TIL_Plane.h.

TIL_Plane& TIL_Plane::operator=

(

const TIL_Plane &

)

int TIL_Plane::operator== ( const TIL_Plane &  eq ) const

inline

Definition at line 50 of file TIL_Plane.h.

bool TIL_Plane::scopeMatches

(

const TIL_Plane &

plane

)

const

void TIL_Plane::setArrayMask	(	int	start,
		int	end,
		int	step
	)

void TIL_Plane::setArraySize

(

int

n

)

void TIL_Plane::setBlackWhitePoints	(	unsigned int	b,
		unsigned int	w
	)

void TIL_Plane::setColorSpace ( PXL_ColorSpace  cs, const UT_StringHolder &  ocio = UT_StringHolder()  )

inline

Definition at line 134 of file TIL_Plane.h.

void TIL_Plane::setConstantFlag	(	int	i,
		bool	enable
	)

void TIL_Plane::setFormat

(

TIL_DataFormat

format

)

Examples:

COP2/COP2_FullImageFilter.C.

void TIL_Plane::setName

(

const char *

name

)

void TIL_Plane::setPlaneMask	(	int	enable,
		int	i
	)

void TIL_Plane::setScoped ( int  enable )

inline

Definition at line 106 of file TIL_Plane.h.

void TIL_Plane::setSubName	(	const char *	subname,
		int	i
	)

void TIL_Plane::setTypeInfo ( TIL_TypeInfo  typeinfo )

inline

Definition at line 77 of file TIL_Plane.h.

void TIL_Plane::setVectorSize

(

int

n

)

int TIL_Plane::usesBlackWhitePoints

(

)

const

---

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

• TIL/TIL_Plane.h