HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
TIL_DeepRaster Class Reference

#include <TIL_DeepRaster.h>

Public Member Functions

 TIL_DeepRaster ()
 
 TIL_DeepRaster (const TIL_DeepRaster &)
 
virtual ~TIL_DeepRaster ()
 
virtual int64 getMemoryUsage (bool inclusive) const
 
void copy (const TIL_DeepRaster &src, const char *scope=NULL, bool invert_scope=false)
 
void append (const TIL_DeepRaster &src)
 Appends the info and data from src to the existing data. More...
 
void create (const TIL_Sequence &sequence, bool change_vector2_to_vector3=true, bool allocate_raster_storage=true)
 
int getRasterCount () const
 
TIL_SequencegetSequence ()
 
const TIL_SequencegetSequence () const
 
TIL_RastergetRaster (int i)
 
const TIL_RastergetRaster (int i) const
 
bool writeTile (int plane_index, int x0, int x1, int y0, int y1, const void *data)
 Write a tile of interleaved data into the plane specified. More...
 
bool writeSamples (int nsamples, int floats_per_sample, const UT_Vector3T< int > *samples, const float *data)
 Write the given sample data into the image. More...
 
bool clearOutside (int plane_index, int x0, int x1, int y0, int y1, fpreal value=0)
 
void clearPixels (fpreal value=0, bool stash_samples=false)
 Clear all pixels to the given value. More...
 
void clearSamples (bool stash_samples=false)
 
const UT_StringHoldergetName ()
 
void setName (const UT_StringHolder &name)
 
void setCropWindow (const UT_DimRect &rect)
 
bool hasCropWindow () const
 
const UT_DimRectgetCropWindow () const
 
UT_DimRectgetCropWindow ()
 
bool hasDataWritten () const
 
UT_DimRectgetWrittenWindow ()
 
const UT_DimRectgetWrittenWindow () const
 
void setEdgeStreak (int plane, int ex0, int ex1, int ey0, int ey1)
 
bool getEdgeStreak (int plane, int &ex0, int &ex1, int &ey0, int &ey1)
 
void clearEdgeStreak (int plane)
 
void setBlackPoint (int plane, fpreal bpoint)
 
void setWhitePoint (int plane, fpreal wpoint)
 
bool swapOut ()
 
bool swapIn ()
 
void clearSwapFile ()
 
const TIL_AdaptiveImagegetAdaptiveImage () const
 
int numPlaneSourceComponents (int planei) const
 
int numPlaneDestComponents (int planei) const
 
int planeSourceStartComponent (int planei) const
 

Detailed Description

Definition at line 25 of file TIL_DeepRaster.h.

Constructor & Destructor Documentation

TIL_DeepRaster::TIL_DeepRaster ( )
TIL_DeepRaster::TIL_DeepRaster ( const TIL_DeepRaster )
virtual TIL_DeepRaster::~TIL_DeepRaster ( )
virtual

Member Function Documentation

void TIL_DeepRaster::append ( const TIL_DeepRaster src)

Appends the info and data from src to the existing data.

void TIL_DeepRaster::clearEdgeStreak ( int  plane)
bool TIL_DeepRaster::clearOutside ( int  plane_index,
int  x0,
int  x1,
int  y0,
int  y1,
fpreal  value = 0 
)

Clear the raster outside the bounding box specified. If the plane index is -1, all planes will be cleared to the color. This does not affect the "written" bounding box. To clear the whole raster, simply pass in: y0=0, y1=-1 (or y0=yres, y1=0)

void TIL_DeepRaster::clearPixels ( fpreal  value = 0,
bool  stash_samples = false 
)

Clear all pixels to the given value.

void TIL_DeepRaster::clearSamples ( bool  stash_samples = false)

Clear all samples in myAdaptiveImage, without changing the rasters.

void TIL_DeepRaster::clearSwapFile ( )
inline

Definition at line 127 of file TIL_DeepRaster.h.

void TIL_DeepRaster::copy ( const TIL_DeepRaster src,
const char *  scope = NULL,
bool  invert_scope = false 
)

Copies info and data over from src, and replaces the existing one. 'scope' allows a selective copy of planes from src (ie, "C A Pz") and 'invert_scope' will interpret the list as planes not to copy if true

void TIL_DeepRaster::create ( const TIL_Sequence sequence,
bool  change_vector2_to_vector3 = true,
bool  allocate_raster_storage = true 
)

Allocate a TIL_Raster for each plane defined by the sequence. Each raster will be allocated with interleaved packing. If the plane can't be allocated using a TIL_Raster (i.e. vector size of 7, array size of 2), then the raster is un-initialized.

When a vector size of 2 is detected as a plane type, we have the option of bumping the vector size to 3. This is so that the TIL_Raster can be displayed by the OGL code. This is turned on by default. Just be aware of this case when dealing with the rasters.

const TIL_AdaptiveImage* TIL_DeepRaster::getAdaptiveImage ( ) const
inline

Definition at line 136 of file TIL_DeepRaster.h.

const UT_DimRect& TIL_DeepRaster::getCropWindow ( ) const
inline

Definition at line 101 of file TIL_DeepRaster.h.

UT_DimRect& TIL_DeepRaster::getCropWindow ( )
inline

Definition at line 103 of file TIL_DeepRaster.h.

bool TIL_DeepRaster::getEdgeStreak ( int  plane,
int ex0,
int ex1,
int ey0,
int ey1 
)
virtual int64 TIL_DeepRaster::getMemoryUsage ( bool  inclusive) const
virtual
const UT_StringHolder& TIL_DeepRaster::getName ( void  )
inline

Definition at line 95 of file TIL_DeepRaster.h.

TIL_Raster& TIL_DeepRaster::getRaster ( int  i)
inline

Definition at line 61 of file TIL_DeepRaster.h.

const TIL_Raster& TIL_DeepRaster::getRaster ( int  i) const
inline

Definition at line 62 of file TIL_DeepRaster.h.

int TIL_DeepRaster::getRasterCount ( ) const
inline

Definition at line 57 of file TIL_DeepRaster.h.

TIL_Sequence& TIL_DeepRaster::getSequence ( )
inline

Definition at line 59 of file TIL_DeepRaster.h.

const TIL_Sequence& TIL_DeepRaster::getSequence ( ) const
inline

Definition at line 60 of file TIL_DeepRaster.h.

UT_DimRect& TIL_DeepRaster::getWrittenWindow ( )
inline

Definition at line 107 of file TIL_DeepRaster.h.

const UT_DimRect& TIL_DeepRaster::getWrittenWindow ( ) const
inline

Definition at line 109 of file TIL_DeepRaster.h.

bool TIL_DeepRaster::hasCropWindow ( ) const
inline

Definition at line 99 of file TIL_DeepRaster.h.

bool TIL_DeepRaster::hasDataWritten ( ) const
inline

Definition at line 105 of file TIL_DeepRaster.h.

int TIL_DeepRaster::numPlaneDestComponents ( int  planei) const
int TIL_DeepRaster::numPlaneSourceComponents ( int  planei) const
int TIL_DeepRaster::planeSourceStartComponent ( int  planei) const
void TIL_DeepRaster::setBlackPoint ( int  plane,
fpreal  bpoint 
)
void TIL_DeepRaster::setCropWindow ( const UT_DimRect rect)
inline

Definition at line 97 of file TIL_DeepRaster.h.

void TIL_DeepRaster::setEdgeStreak ( int  plane,
int  ex0,
int  ex1,
int  ey0,
int  ey1 
)
void TIL_DeepRaster::setName ( const UT_StringHolder name)
void TIL_DeepRaster::setWhitePoint ( int  plane,
fpreal  wpoint 
)
bool TIL_DeepRaster::swapIn ( )
inline

Definition at line 123 of file TIL_DeepRaster.h.

bool TIL_DeepRaster::swapOut ( )
inline

Definition at line 122 of file TIL_DeepRaster.h.

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

Write the given sample data into the image.

bool TIL_DeepRaster::writeTile ( int  plane_index,
int  x0,
int  x1,
int  y0,
int  y1,
const void data 
)

Write a tile of interleaved data into the plane specified.


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