ParaView
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkImageCompressor Class Referenceabstract

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

#include <vtkImageCompressor.h>

Inheritance diagram for vtkImageCompressor:
Inheritance graph
[legend]

Public Types

typedef vtkObject Superclass
 

Public Member Functions

virtual const char * GetClassName ()
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual int Compress ()=0
 Call this method to compress the input and generate the compressed data. More...
 
virtual int Decompress ()=0
 Decompresses and geenartes the decompressed data as output. More...
 
virtual void SaveConfiguration (vtkMultiProcessStream *stream)
 Serialize compressor configuration (but not the data) into the stream. More...
 
virtual bool RestoreConfiguration (vtkMultiProcessStream *stream)
 Restore state from the stream. More...
 
virtual const char * SaveConfiguration ()
 Serialize compressor configuration (but not the data) into the stream. More...
 
virtual const char * RestoreConfiguration (const char *stream)
 Restore state from the stream, The stream format for all image compressor is: [ClassName, LossLessMode, [Derived Class Stream]]. More...
 
void SetInput (vtkUnsignedCharArray *input)
 Get/Set the input to this compressor. More...
 
virtual vtkUnsignedCharArray * GetInput ()
 Get/Set the input to this compressor. More...
 
virtual vtkUnsignedCharArray * GetOutput ()
 Get/Set the output of the compressor. More...
 
void SetOutput (vtkUnsignedCharArray *)
 Get/Set the output of the compressor. More...
 
virtual void SetLossLessMode (int)
 When set the implementation must use loss-less compression, otherwise implemnetation should user provided settings. More...
 
virtual int GetLossLessMode ()
 When set the implementation must use loss-less compression, otherwise implemnetation should user provided settings. More...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkImageCompressorSafeDownCast (vtkObject *o)
 

Protected Member Functions

virtual void SetConfiguration (const char *)
 
 vtkImageCompressor ()
 Construct with NULL input array and empty but allocated output array. More...
 
virtual ~vtkImageCompressor ()
 Construct with NULL input array and empty but allocated output array. More...
 

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 38 of file vtkImageCompressor.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkImageCompressor::Superclass

Definition at line 41 of file vtkImageCompressor.h.

Constructor & Destructor Documentation

◆ vtkImageCompressor()

vtkImageCompressor::vtkImageCompressor ( )
protected

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

◆ ~vtkImageCompressor()

virtual vtkImageCompressor::~vtkImageCompressor ( )
protectedvirtual

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

Member Function Documentation

◆ GetClassName()

virtual const char* vtkImageCompressor::GetClassName ( )
virtual

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ PrintSelf()

void vtkImageCompressor::PrintSelf ( ostream &  os,
vtkIndent  indent 
)

◆ SetInput()

void vtkImageCompressor::SetInput ( vtkUnsignedCharArray *  input)

Get/Set the input to this compressor.

◆ GetInput()

virtual vtkUnsignedCharArray* vtkImageCompressor::GetInput ( )
virtual

Get/Set the input to this compressor.

◆ GetOutput()

virtual vtkUnsignedCharArray* vtkImageCompressor::GetOutput ( )
virtual

Get/Set the output of the compressor.

◆ SetOutput()

void vtkImageCompressor::SetOutput ( vtkUnsignedCharArray *  )

Get/Set the output of the compressor.

◆ SetLossLessMode()

virtual void vtkImageCompressor::SetLossLessMode ( int  )
virtual

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

Reimplemented in vtkZlibImageCompressor.

◆ GetLossLessMode()

virtual int vtkImageCompressor::GetLossLessMode ( )
virtual

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

◆ Compress()

virtual int vtkImageCompressor::Compress ( )
pure virtual

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

Implemented in vtkSquirtCompressor, vtkLZ4Compressor, and vtkZlibImageCompressor.

◆ Decompress()

virtual int vtkImageCompressor::Decompress ( )
pure virtual

Decompresses and geenartes the decompressed data as output.

Input must be compressed data.

Implemented in vtkSquirtCompressor, vtkLZ4Compressor, and vtkZlibImageCompressor.

◆ SaveConfiguration() [1/2]

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

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

Reimplemented in vtkSquirtCompressor, vtkLZ4Compressor, and vtkZlibImageCompressor.

◆ RestoreConfiguration() [1/2]

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, vtkLZ4Compressor, and vtkZlibImageCompressor.

◆ SaveConfiguration() [2/2]

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, vtkLZ4Compressor, and vtkZlibImageCompressor.

◆ RestoreConfiguration() [2/2]

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, vtkLZ4Compressor, and vtkZlibImageCompressor.

◆ SetConfiguration()

virtual void vtkImageCompressor::SetConfiguration ( const char *  )
protectedvirtual

Member Data Documentation

◆ Output

vtkUnsignedCharArray* vtkImageCompressor::Output
protected

Definition at line 116 of file vtkImageCompressor.h.

◆ Input

vtkUnsignedCharArray* vtkImageCompressor::Input
protected

Definition at line 117 of file vtkImageCompressor.h.

◆ LossLessMode

int vtkImageCompressor::LossLessMode
protected

Definition at line 119 of file vtkImageCompressor.h.

◆ Configuration

char* vtkImageCompressor::Configuration
protected

Definition at line 121 of file vtkImageCompressor.h.


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