TIL_DeepRasterReader Class Reference

#include <TIL_DeepRasterReader.h>

Inheritance diagram for TIL_DeepRasterReader:

TIL_DeepReader

List of all members.

Public Member Functions

 TIL_DeepRasterReader ()
virtual ~TIL_DeepRasterReader ()
bool loadSequenceInfo (UT_NetSocket *sock, int &pid, bool &new_sequence)
 Initialize sequence information from the net socket.
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_StringgetProgressMessage () const
const UT_StringgetProgressAction () const
int getVersion () const

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.
virtual bool writeTile (int plane_index, int x0, int x1, int y0, int y1, void *data)
virtual bool setTag (int plane, const char *tag, const char *val)=0
virtual bool setTag (int plane, const char *tag, const UT_StringArray &values)=0
virtual bool setTag (int plane, const char *tag, const int *values, int nvalues=1)
virtual bool setTag (int plane, const char *tag, const fpreal *values, int nvalues=1)


Detailed Description

Definition at line 29 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 [protected, virtual]

virtual bool TIL_DeepRasterReader::complete (  )  [protected, virtual]

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  ) 

int TIL_DeepRasterReader::getNumPlanes (  )  const [inline, protected]

Definition at line 76 of file TIL_DeepRasterReader.h.

fpreal TIL_DeepRasterReader::getPercentComplete (  )  const

virtual int TIL_DeepRasterReader::getPlaneDataFormat ( int  plane_index  )  const [protected, virtual]

Implements TIL_DeepReader.

const UT_String& TIL_DeepRasterReader::getProgressAction (  )  const [inline]

Definition at line 61 of file TIL_DeepRasterReader.h.

const UT_String& TIL_DeepRasterReader::getProgressMessage (  )  const [inline]

Definition at line 59 of file TIL_DeepRasterReader.h.

TIL_DeepRaster* TIL_DeepRasterReader::getRaster (  )  [inline]

Definition at line 51 of file TIL_DeepRasterReader.h.

TIL_Sequence& TIL_DeepRasterReader::getSequence (  )  [inline]

Definition at line 52 of file TIL_DeepRasterReader.h.

int TIL_DeepRasterReader::getVersion ( void   )  const [inline]

Definition at line 66 of file TIL_DeepRasterReader.h.

virtual int TIL_DeepRasterReader::getXres (  )  const [protected, virtual]

Implements TIL_DeepReader.

virtual int TIL_DeepRasterReader::getYres (  )  const [protected, virtual]

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  )  [inline, protected]

Definition at line 69 of file TIL_DeepRasterReader.h.

virtual bool TIL_DeepRasterReader::setTag ( int  plane,
const char *  tag,
const fpreal values,
int  nvalues = 1 
) [protected, virtual]

Reimplemented from TIL_DeepReader.

virtual bool TIL_DeepRasterReader::setTag ( int  plane,
const char *  tag,
const int *  values,
int  nvalues = 1 
) [protected, virtual]

Reimplemented from TIL_DeepReader.

virtual bool TIL_DeepRasterReader::setTag ( int  plane,
const char *  tag,
const UT_StringArray values 
) [protected, pure virtual]

Reimplemented from TIL_DeepReader.

virtual bool TIL_DeepRasterReader::setTag ( int  plane,
const char *  tag,
const char *  val 
) [protected, pure virtual]

Reimplemented from TIL_DeepReader.

TIL_DeepRaster* TIL_DeepRasterReader::stealDeepRaster (  ) 

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

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:

Generated on Fri May 25 00:10:45 2012 for HDK by  doxygen 1.5.9