#include <TIL_DeepRasterReader.h>

Inheritance diagram for TIL_DeepRasterReader:

Public Member Functions
	TIL_DeepRasterReader ()

	~TIL_DeepRasterReader () override

int64	getMemoryUsage (bool inclusive) const override

bool	loadSequenceInfo (UT_NetSocket *sock, int &pid, bool &new_sequence)
	Initialize sequence information from the net socket. More...

void	setResolution (int xres, int yres)

int	addPlane (const char *name, TIL_DataFormat storage, int vector_size, TIL_TypeInfo type_info=TIL_TI_UNDEFINED)

void	createDeepRaster (bool change_vector2_to_vector3=true)

void	setDeepRaster (TIL_DeepRaster *raster)

TIL_DeepRaster *	stealDeepRaster ()

TIL_DeepRaster *	getRaster ()

TIL_Sequence &	getSequence ()

fpreal	getPercentComplete () const

const UT_StringHolder &	getProgressMessage () const

const UT_StringHolder &	getProgressAction () const

fpreal	getElapsedTime () const

fpreal	getRenderTime () const

int64	getPeakMemUsage () const

int	getVersion () const

Public Member Functions inherited from TIL_DeepReader
	TIL_DeepReader ()

virtual	~TIL_DeepReader ()

virtual void	updateImage ()

Protected Member Functions
void	setSequence (const TIL_Sequence &src)

virtual TIL_DeepRaster *	allocRaster () const

int	getXres () const override

int	getYres () const override

int	getNumPlanes () const

int	getPlaneDataFormat (int plane_index) const override

bool	complete () override
	When no more data will be written to the reader, this method is called. More...

bool	writeTile (int plane_index, int x0, int x1, int y0, int y1, void *data) override

bool	writeSamples (int nsamples, int floats_per_sample, const UT_Vector3T< int > samples, const float data) override

bool	setTag (int plane, int tag, const char *val) override=0

bool	setTag (int plane, int tag, const UT_StringArray &values) override=0

bool	setTag (int plane, int tag, const int *values, int nvalues=1) override

bool	setTag (int plane, int tag, const float *values, int nvalues=1) override

Protected Member Functions inherited from TIL_DeepReader
virtual int	adjustPlaneIndex (int index) const

Detailed Description

Definition at line 26 of file TIL_DeepRasterReader.h.

Constructor & Destructor Documentation

TIL_DeepRasterReader::TIL_DeepRasterReader ( )

TIL_DeepRasterReader::~TIL_DeepRasterReader ( )

override

Member Function Documentation

int TIL_DeepRasterReader::addPlane	(	const char *	name,
		TIL_DataFormat	storage,
		int	vector_size,
		TIL_TypeInfo	type_info = `TIL_TI_UNDEFINED`
	)

virtual TIL_DeepRaster* TIL_DeepRasterReader::allocRaster ( ) const

protectedvirtual

bool TIL_DeepRasterReader::complete ( )

overrideprotectedvirtual

When no more data will be written to the reader, this method is called.

Reimplemented from TIL_DeepReader.

void TIL_DeepRasterReader::createDeepRaster ( bool change_vector2_to_vector3 = true )

fpreal TIL_DeepRasterReader::getElapsedTime ( ) const

inline

Definition at line 66 of file TIL_DeepRasterReader.h.

int64 TIL_DeepRasterReader::getMemoryUsage ( bool inclusive ) const

overridevirtual

Implements TIL_DeepReader.

int TIL_DeepRasterReader::getNumPlanes ( ) const

inlineprotected

Definition at line 85 of file TIL_DeepRasterReader.h.

int64 TIL_DeepRasterReader::getPeakMemUsage ( ) const

inline

Definition at line 70 of file TIL_DeepRasterReader.h.

fpreal TIL_DeepRasterReader::getPercentComplete ( ) const

int TIL_DeepRasterReader::getPlaneDataFormat ( int plane_index ) const

overrideprotectedvirtual

Implements TIL_DeepReader.

const UT_StringHolder& TIL_DeepRasterReader::getProgressAction ( ) const

inline

Definition at line 64 of file TIL_DeepRasterReader.h.

const UT_StringHolder& TIL_DeepRasterReader::getProgressMessage ( ) const

inline

Definition at line 62 of file TIL_DeepRasterReader.h.

TIL_DeepRaster* TIL_DeepRasterReader::getRaster ( )

inline

Definition at line 54 of file TIL_DeepRasterReader.h.

fpreal TIL_DeepRasterReader::getRenderTime ( ) const

inline

Definition at line 68 of file TIL_DeepRasterReader.h.

TIL_Sequence& TIL_DeepRasterReader::getSequence ( )

inline

Definition at line 55 of file TIL_DeepRasterReader.h.

int TIL_DeepRasterReader::getVersion ( ) const

inline

Definition at line 75 of file TIL_DeepRasterReader.h.

int TIL_DeepRasterReader::getXres ( ) const

overrideprotectedvirtual

Implements TIL_DeepReader.

int TIL_DeepRasterReader::getYres ( ) const

overrideprotectedvirtual

Implements TIL_DeepReader.

bool TIL_DeepRasterReader::loadSequenceInfo	(	UT_NetSocket *	sock,
		int &	pid,
		bool &	new_sequence
	)

Initialize sequence information from the net socket.

void TIL_DeepRasterReader::setDeepRaster ( TIL_DeepRaster * raster )

void TIL_DeepRasterReader::setResolution	(	int	xres,
		int	yres
	)

addPlane() returns the plane index (which can be used to set additional attributes at a later time). It's possible to create planes which are NOT renderable (i.e. vector size 5 etc.) These planes are still created, but may not have data written to them.

void TIL_DeepRasterReader::setSequence ( const TIL_Sequence & src )

inlineprotected

Definition at line 78 of file TIL_DeepRasterReader.h.

bool TIL_DeepRasterReader::setTag	(	int	plane,
		int	tag,
		const char *	val
	)

overrideprotectedpure virtual

Reimplemented from TIL_DeepReader.

bool TIL_DeepRasterReader::setTag	(	int	plane,
		int	tag,
		const UT_StringArray &	values
	)

overrideprotectedpure virtual

Reimplemented from TIL_DeepReader.

bool TIL_DeepRasterReader::setTag	(	int	plane,
		int	tag,
		const int *	values,
		int	nvalues = `1`
	)

overrideprotectedvirtual

Reimplemented from TIL_DeepReader.

bool TIL_DeepRasterReader::setTag	(	int	plane,
		int	tag,
		const float *	values,
		int	nvalues = `1`
	)

overrideprotectedvirtual

Reimplemented from TIL_DeepReader.

TIL_DeepRaster* TIL_DeepRasterReader::stealDeepRaster ( )

bool TIL_DeepRasterReader::writeSamples	(	int	nsamples,
		int	floats_per_sample,
		const UT_Vector3T< int > *	samples,
		const float *	data
	)

overrideprotectedvirtual

Implements TIL_DeepReader.

bool TIL_DeepRasterReader::writeTile	(	int	plane_index,
		int	x0,
		int	x1,
		int	y0,
		int	y1,
		void *	data
	)

overrideprotectedvirtual

This assumes that the data is in the "correct" endian-ness. Please ensure that this is done (esp. when reading from sockets).

Implements TIL_DeepReader.

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

TIL/TIL_DeepRasterReader.h

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation