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

#include <vtkImageCompressor.h>

Inheritance diagram for vtkImageCompressor:

[legend]

Collaboration diagram for vtkImageCompressor:

[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) override

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	SetImageResolution (int width, int height)
	Communicates the next expected image resolution. 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...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

virtual vtkMTimeType	GetMTime ()

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

void	PrintRevisions (ostream &)

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkImageCompressor *	SafeDownCast (vtkObject *o)

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

static vtkObjectBase *	New ()

Protected Member Functions
virtual void	SetConfiguration (const char *)


	vtkImageCompressor ()
	Construct with nullptr input array and empty but allocated output array. More...

	~vtkImageCompressor () override
	Construct with nullptr input array and empty but allocated output array. More...

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) VTK_OVERRIDE

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkUnsignedCharArray *	Output

vtkUnsignedCharArray *	Input

int	LossLessMode

char *	Configuration

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

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

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkImageCompressor::Superclass

Definition at line 30 of file vtkImageCompressor.h.

Constructor & Destructor Documentation

◆ vtkImageCompressor()

vtkImageCompressor::vtkImageCompressor ( )

protected

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

◆ ~vtkImageCompressor()

vtkImageCompressor::~vtkImageCompressor ( )

overrideprotected

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

Member Function Documentation

◆ GetClassName()

virtual const char* vtkImageCompressor::GetClassName ( )

virtual

Reimplemented in vtkSquirtCompressor, vtkZlibImageCompressor, vtkLZ4Compressor, and vtkNvPipeCompressor.

◆ IsTypeOf()

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

static

◆ IsA()

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

virtual

Reimplemented from vtkObjectBase.

Reimplemented in vtkSquirtCompressor, vtkZlibImageCompressor, vtkLZ4Compressor, and vtkNvPipeCompressor.

◆ SafeDownCast()

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

static

◆ PrintSelf()

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

overridevirtual

Reimplemented from vtkObject.

Reimplemented in vtkSquirtCompressor, vtkZlibImageCompressor, vtkLZ4Compressor, and vtkNvPipeCompressor.

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

◆ SetImageResolution()

virtual void vtkImageCompressor::SetImageResolution	(	int	width,
		int	height
	)

virtual

Communicates the next expected image resolution.

Reimplemented in vtkNvPipeCompressor.

◆ SaveConfiguration() [1/2]

virtual void vtkImageCompressor::SaveConfiguration ( vtkMultiProcessStream * stream )

virtual

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

Reimplemented in vtkSquirtCompressor, vtkLZ4Compressor, vtkNvPipeCompressor, 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, vtkNvPipeCompressor, 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, vtkNvPipeCompressor, 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, vtkNvPipeCompressor, and vtkZlibImageCompressor.

◆ SetConfiguration()

virtual void vtkImageCompressor::SetConfiguration ( const char * )

protectedvirtual

Member Data Documentation

◆ Output

vtkUnsignedCharArray* vtkImageCompressor::Output

protected

Definition at line 110 of file vtkImageCompressor.h.

◆ Input

vtkUnsignedCharArray* vtkImageCompressor::Input

protected

Definition at line 111 of file vtkImageCompressor.h.

◆ LossLessMode

int vtkImageCompressor::LossLessMode

protected

Definition at line 113 of file vtkImageCompressor.h.

◆ Configuration

char* vtkImageCompressor::Configuration

protected

Definition at line 115 of file vtkImageCompressor.h.

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

/builds/gitlab-kitware-sciviz-ci/VTKExtensions/FiltersRendering/vtkImageCompressor.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkImageCompressor()

◆ ~vtkImageCompressor()

Member Function Documentation

◆ GetClassName()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ PrintSelf()

◆ SetInput()

◆ GetInput()

◆ GetOutput()

◆ SetOutput()

◆ SetLossLessMode()

◆ GetLossLessMode()

◆ Compress()

◆ Decompress()

◆ SetImageResolution()

◆ SaveConfiguration() [1/2]

◆ RestoreConfiguration() [1/2]

◆ SaveConfiguration() [2/2]

◆ RestoreConfiguration() [2/2]

◆ SetConfiguration()

Member Data Documentation

◆ Output

◆ Input

◆ LossLessMode

◆ Configuration