Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

vrvis::RasterData Class Reference

Interface representing rastered (pixel) data that can be displayed in a LayerComponent. More...

#include <RasterData.hpp>

Inheritance diagram for vrvis::RasterData:

vrvis::ImageBand< DataTypeT > List of all members.

Public Member Functions

virtual ~RasterData (void)
 Destructor.
virtual void load (void)=0
 Load the contained pixel data into memory.
virtual void unload (void)=0
 Unload the contained pixel data from memory.
virtual void getSizeInPixels (int &rPixelsX, int &rPixelsY) const =0
 Return raster size in pixels.
virtual double * getValues (void) const =0
 Return pointer to the value storage.

Protected Member Functions

 RasterData (void)
 Constructor.

Detailed Description

RasterData is a purely abstract interface to be implemented by classes that want to be displayed in a LayerComponent. It asks for features like providing access to size and data information as well as possibilities for data loading and unloading.
Note:
Classes that implement the RasterData interface need to have their pixel data represented as a normalized, two-dimensional array of double in row-major order!
See also:
LayerComponent

Writing VRVis extensions


Constructor & Destructor Documentation

virtual vrvis::RasterData::~RasterData void   )  [inline, virtual]
 

Destructor

vrvis::RasterData::RasterData void   )  [inline, protected]
 

Protected constructor, to be called by implementing classes only.


Member Function Documentation

virtual void vrvis::RasterData::getSizeInPixels int &  rPixelsX,
int &  rPixelsY
const [pure virtual]
 

Return the size of the rastered data in pixels.

Parameters:
[out] rPixelsX Return width in pixels.
[out] rPixelsY Return height in pixels.

Implemented in vrvis::ImageBand< DataTypeT >.

virtual double* vrvis::RasterData::getValues void   )  const [pure virtual]
 

Return a pointer to the memory where the pixel values are stored. The RasterData should be loaded first.

Returns:
Pointer to the double data storage.
See also:
load()

Implemented in vrvis::ImageBand< DataTypeT >.

virtual void vrvis::RasterData::load void   )  [pure virtual]
 

Load the pixel data the implementing class represents into memory.

Implemented in vrvis::ImageBand< DataTypeT >.

virtual void vrvis::RasterData::unload void   )  [pure virtual]
 

Free all memory allocated by the pixel data.

Implemented in vrvis::ImageBand< DataTypeT >.


The documentation for this class was generated from the following file:
Generated on Tue Sep 21 07:31:11 2004 for VRVis by doxygen 1.3.8