Superclass for image compressor/decompressor used by Composite Managers. More...

#include <vtkImageCompressor.h>

Inheritance diagram for vtkImageCompressor:

Collaboration diagram for vtkImageCompressor:

Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	Compress ()=0
virtual int	Decompress ()=0
virtual void	SaveConfiguration (vtkMultiProcessStream *stream)
virtual const char *	SaveConfiguration ()
virtual const char *	RestoreConfiguration (const char *stream)

void	SetInput (vtkUnsignedCharArray *input)
virtual vtkUnsignedCharArray *	GetInput ()

virtual vtkUnsignedCharArray *	GetOutput ()
void	SetOutput (vtkUnsignedCharArray *)

virtual void	SetLossLessMode (int)
virtual int	GetLossLessMode ()

virtual bool	RestoreConfiguration (vtkMultiProcessStream *stream)
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkImageCompressor *	SafeDownCast (vtkObject *o)
Protected Member Functions
virtual void	SetConfiguration (const char *)

	vtkImageCompressor ()
virtual	~vtkImageCompressor ()
Protected Attributes
vtkUnsignedCharArray *	Output
vtkUnsignedCharArray *	Input
int	LossLessMode
char *	Configuration

Detailed Description

Superclass for image compressor/decompressor used by Composite Managers.

vtkImageCompressor is an abstract superclass for the helper object used to compress images by the vtkParallelManager subclasses. Compressors must implement Compress,Decomperss methods, which respect the LossLessMode ivar, which is used by the composite manager to force loss less compression during a still render. Additionally compressors must be able to seriealize and restore their setting from a stream.

Definition at line 36 of file vtkImageCompressor.h.

Constructor & Destructor Documentation

vtkImageCompressor::vtkImageCompressor ( ) [protected]

Construct with NULL input array and empty but allocated output array.

virtual vtkImageCompressor::~vtkImageCompressor ( ) [protected, virtual]

Construct with NULL input array and empty but allocated output array.

Member Function Documentation

virtual const char* vtkImageCompressor::GetClassName ( ) [virtual]

Reimplemented from vtkObject.

Reimplemented in vtkSquirtCompressor, and vtkZlibImageCompressor.

static int vtkImageCompressor::IsTypeOf ( const char * type ) [static]

Reimplemented from vtkObject.

Reimplemented in vtkSquirtCompressor, and vtkZlibImageCompressor.

virtual int vtkImageCompressor::IsA ( const char * type ) [virtual]

Reimplemented from vtkObject.

Reimplemented in vtkSquirtCompressor, and vtkZlibImageCompressor.

static vtkImageCompressor* vtkImageCompressor::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkObject.

Reimplemented in vtkSquirtCompressor, and vtkZlibImageCompressor.

void vtkImageCompressor::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Reimplemented from vtkObject.

Reimplemented in vtkSquirtCompressor, and vtkZlibImageCompressor.

void vtkImageCompressor::SetInput ( vtkUnsignedCharArray * input )

Get/Set the input to this compressor.

virtual vtkUnsignedCharArray* vtkImageCompressor::GetInput ( ) [virtual]

Get/Set the input to this compressor.

virtual vtkUnsignedCharArray* vtkImageCompressor::GetOutput ( ) [virtual]

Get/Set the output of the compressor.

void vtkImageCompressor::SetOutput ( vtkUnsignedCharArray * )

Get/Set the output of the compressor.

virtual void vtkImageCompressor::SetLossLessMode ( int ) [virtual]

When set the implementation must use loss-less compression, otherwise implemnetation should user provided settings.

Reimplemented in vtkZlibImageCompressor.

virtual int vtkImageCompressor::GetLossLessMode ( ) [virtual]

When set the implementation must use loss-less compression, otherwise implemnetation should user provided settings.

virtual int vtkImageCompressor::Compress ( ) [pure virtual]

Call this method to compress the input and generate the compressed data.

Implemented in vtkSquirtCompressor, and vtkZlibImageCompressor.

virtual int vtkImageCompressor::Decompress ( ) [pure virtual]

Decompresses and geenartes the decompressed data as output. Input must be compressed data.

Implemented in vtkSquirtCompressor, and vtkZlibImageCompressor.

virtual void vtkImageCompressor::SaveConfiguration ( vtkMultiProcessStream * stream ) [virtual]

Serialize compressor configuration (but not the data) into the stream.

Reimplemented in vtkSquirtCompressor, and vtkZlibImageCompressor.

virtual bool vtkImageCompressor::RestoreConfiguration ( vtkMultiProcessStream * stream ) [virtual]

Restore state from the stream. The stream format for all image compressor is: [ClassName, LossLessMode, [Derived Class Stream]].

Reimplemented in vtkSquirtCompressor, and vtkZlibImageCompressor.

virtual const char* vtkImageCompressor::SaveConfiguration ( ) [virtual]

Serialize compressor configuration (but not the data) into the stream. A pointer to the internally managed stream is returned (ie do not free it!).

Reimplemented in vtkSquirtCompressor, and vtkZlibImageCompressor.

virtual const char* vtkImageCompressor::RestoreConfiguration ( const char * stream ) [virtual]

Restore state from the stream, The stream format for all image compressor is: [ClassName, LossLessMode, [Derived Class Stream]]. Upon success the stream is returned otherwise 0 is returned indicating an error.

Reimplemented in vtkSquirtCompressor, and vtkZlibImageCompressor.

virtual void vtkImageCompressor::SetConfiguration ( const char * ) [protected, virtual]