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

#include <TIL_DeepRasterReader.h>

+ Inheritance diagram for TIL_DeepRasterReader:

Public Member Functions

 TIL_DeepRasterReader ()
 
virtual ~TIL_DeepRasterReader ()
 
virtual int64 getMemoryUsage (bool inclusive) const
 
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)
 
void createDeepRaster (bool change_vector2_to_vector3=true)
 
void setDeepRaster (TIL_DeepRaster *raster)
 
TIL_DeepRasterstealDeepRaster ()
 
TIL_DeepRastergetRaster ()
 
TIL_SequencegetSequence ()
 
fpreal getPercentComplete () const
 
const UT_StringHoldergetProgressMessage () const
 
const UT_StringHoldergetProgressAction () 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_DeepRasterallocRaster () const
 
virtual int getXres () const
 
virtual int getYres () const
 
int getNumPlanes () const
 
virtual int getPlaneDataFormat (int plane_index) const
 
virtual bool complete ()
 When no more data will be written to the reader, this method is called. More...
 
virtual bool writeTile (int plane_index, int x0, int x1, int y0, int y1, void *data)
 
virtual bool writeSamples (int nsamples, int floats_per_sample, const UT_Vector3T< int > *samples, const float *data)
 
virtual bool setTag (int plane, int tag, const char *val)=0
 
virtual bool setTag (int plane, int tag, const UT_StringArray &values)=0
 
virtual bool setTag (int plane, int tag, const int *values, int nvalues=1)
 
virtual bool setTag (int plane, int tag, const float *values, int nvalues=1)
 
- Protected Member Functions inherited from TIL_DeepReader
virtual int adjustPlaneIndex (int index) const
 

Detailed Description

Definition at line 25 of file TIL_DeepRasterReader.h.

Constructor & Destructor Documentation

TIL_DeepRasterReader::TIL_DeepRasterReader ( )
virtual TIL_DeepRasterReader::~TIL_DeepRasterReader ( )
virtual

Member Function Documentation

int TIL_DeepRasterReader::addPlane ( const char *  name,
TIL_DataFormat  storage,
int  vector_size 
)
virtual TIL_DeepRaster* TIL_DeepRasterReader::allocRaster ( ) const
protectedvirtual
virtual bool TIL_DeepRasterReader::complete ( )
protectedvirtual

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 62 of file TIL_DeepRasterReader.h.

virtual int64 TIL_DeepRasterReader::getMemoryUsage ( bool  inclusive) const
virtual

Implements TIL_DeepReader.

int TIL_DeepRasterReader::getNumPlanes ( ) const
inlineprotected

Definition at line 81 of file TIL_DeepRasterReader.h.

int64 TIL_DeepRasterReader::getPeakMemUsage ( ) const
inline

Definition at line 66 of file TIL_DeepRasterReader.h.

fpreal TIL_DeepRasterReader::getPercentComplete ( ) const
virtual int TIL_DeepRasterReader::getPlaneDataFormat ( int  plane_index) const
protectedvirtual

Implements TIL_DeepReader.

const UT_StringHolder& TIL_DeepRasterReader::getProgressAction ( ) const
inline

Definition at line 60 of file TIL_DeepRasterReader.h.

const UT_StringHolder& TIL_DeepRasterReader::getProgressMessage ( ) const
inline

Definition at line 58 of file TIL_DeepRasterReader.h.

TIL_DeepRaster* TIL_DeepRasterReader::getRaster ( )
inline

Definition at line 50 of file TIL_DeepRasterReader.h.

fpreal TIL_DeepRasterReader::getRenderTime ( ) const
inline

Definition at line 64 of file TIL_DeepRasterReader.h.

TIL_Sequence& TIL_DeepRasterReader::getSequence ( )
inline

Definition at line 51 of file TIL_DeepRasterReader.h.

int TIL_DeepRasterReader::getVersion ( ) const
inline

Definition at line 71 of file TIL_DeepRasterReader.h.

virtual int TIL_DeepRasterReader::getXres ( ) const
protectedvirtual

Implements TIL_DeepReader.

virtual int TIL_DeepRasterReader::getYres ( ) const
protectedvirtual

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 74 of file TIL_DeepRasterReader.h.

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

Reimplemented from TIL_DeepReader.

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

Reimplemented from TIL_DeepReader.

virtual bool TIL_DeepRasterReader::setTag ( int  plane,
int  tag,
const int values,
int  nvalues = 1 
)
protectedvirtual

Reimplemented from TIL_DeepReader.

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

Reimplemented from TIL_DeepReader.

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

Implements TIL_DeepReader.

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

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: