Implements compressed tree based compositing. More...

#include <vtkCompressCompositer.h>

Inheritance diagram for vtkCompressCompositer:

Collaboration diagram for vtkCompressCompositer:

Public Types
typedef vtkCompositer	Superclass

Public Types inherited from vtkCompositer
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkCompressCompositer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	CompositeBuffer (vtkDataArray pBuf, vtkFloatArray zBuf, vtkDataArray pTmp, vtkFloatArray zTmp) override
	This method gets called on every process. More...

Public Member Functions inherited from vtkCompositer
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkCompositer *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	CompositeBuffer (vtkDataArray pBuf, vtkFloatArray zBuf, vtkDataArray pTmp, vtkFloatArray zTmp)
	This method gets called on every process. More...

virtual void	SetController (vtkMultiProcessController *)
	Access to the controller. More...

virtual vtkMultiProcessController *	GetController ()
	Access to the controller. More...

virtual void	SetNumberOfProcesses (int)
	A hack to get a sub world until I can get communicators working. More...

virtual int	GetNumberOfProcesses ()
	A hack to get a sub world until I can get communicators working. More...

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

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

Static Public Member Functions
static vtkCompressCompositer *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkCompressCompositer *	SafeDownCast (vtkObjectBase *o)

static void	Compress (vtkFloatArray zIn, vtkDataArray pIn, vtkFloatArray zOut, vtkDataArray pOut)
	I am granting access to these methods and making them static So I can create a TileDisplayCompositer which uses compression. More...

static void	Uncompress (vtkFloatArray zIn, vtkDataArray pIn, vtkFloatArray zOut, vtkDataArray pOut, int lengthOut)

static void	CompositeImagePair (vtkFloatArray localZ, vtkDataArray localP, vtkFloatArray remoteZ, vtkDataArray remoteP, vtkFloatArray outZ, vtkDataArray outP)

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

static vtkTypeBool	IsTypeOf (const char *type)

static vtkCompositer *	SafeDownCast (vtkObjectBase *o)

static void	DeleteArray (vtkDataArray *da)
	Methods that allocate and delete memory with special MPIPro calls. More...

static void	ResizeFloatArray (vtkFloatArray *fa, int numComp, vtkIdType size)
	Methods that allocate and delete memory with special MPIPro calls. More...

static void	ResizeUnsignedCharArray (vtkUnsignedCharArray *uca, int numComp, vtkIdType size)
	Methods that allocate and delete memory with special MPIPro calls. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCompressCompositer ()

	~vtkCompressCompositer () override

Protected Member Functions inherited from vtkCompositer
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCompositer ()

	~vtkCompositer () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkDataArray *	InternalPData

vtkFloatArray *	InternalZData

vtkTimerLog *	Timer

Protected Attributes inherited from vtkCompositer
vtkMultiProcessController *	Controller

int	NumberOfProcesses

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

Implements compressed tree based compositing.

vtkCompressCompositer operates in multiple processes. Each compositer has a render window. They use vtkMultiProcessController to communicate the color and depth buffer to process 0's render window. It will not handle transparency. Compositing is run length encoding of background pixels.

SECTION See Also vtkCompositeManager.

Definition at line 40 of file vtkCompressCompositer.h.

Member Typedef Documentation

◆ Superclass

typedef vtkCompositer vtkCompressCompositer::Superclass

Definition at line 44 of file vtkCompressCompositer.h.

Constructor & Destructor Documentation

◆ vtkCompressCompositer()

vtkCompressCompositer::vtkCompressCompositer ( )

protected

◆ ~vtkCompressCompositer()

vtkCompressCompositer::~vtkCompressCompositer ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkCompressCompositer * vtkCompressCompositer::New ( )

static

◆ IsTypeOf()

static vtkTypeBool vtkCompressCompositer::IsTypeOf ( const char * type )

static

◆ IsA()

virtual vtkTypeBool vtkCompressCompositer::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkCompositer.

◆ SafeDownCast()

static vtkCompressCompositer * vtkCompressCompositer::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCompressCompositer::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkCompositer.

◆ NewInstance()

vtkCompressCompositer * vtkCompressCompositer::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkCompositer.

◆ CompositeBuffer()

void vtkCompressCompositer::CompositeBuffer	(	vtkDataArray *	pBuf,
		vtkFloatArray *	zBuf,
		vtkDataArray *	pTmp,
		vtkFloatArray *	zTmp
	)

overridevirtual

This method gets called on every process.

The final image gets put into pBuf and zBuf.

Reimplemented from vtkCompositer.

◆ Compress()

static void vtkCompressCompositer::Compress	(	vtkFloatArray *	zIn,
		vtkDataArray *	pIn,
		vtkFloatArray *	zOut,
		vtkDataArray *	pOut
	)

static

I am granting access to these methods and making them static So I can create a TileDisplayCompositer which uses compression.

◆ Uncompress()

static void vtkCompressCompositer::Uncompress	(	vtkFloatArray *	zIn,
		vtkDataArray *	pIn,
		vtkFloatArray *	zOut,
		vtkDataArray *	pOut,
		int	lengthOut
	)

static

◆ CompositeImagePair()

static void vtkCompressCompositer::CompositeImagePair	(	vtkFloatArray *	localZ,
		vtkDataArray *	localP,
		vtkFloatArray *	remoteZ,
		vtkDataArray *	remoteP,
		vtkFloatArray *	outZ,
		vtkDataArray *	outP
	)

static

Member Data Documentation

◆ InternalPData

vtkDataArray* vtkCompressCompositer::InternalPData

protected

Definition at line 67 of file vtkCompressCompositer.h.

◆ InternalZData

vtkFloatArray* vtkCompressCompositer::InternalZData

protected

Definition at line 68 of file vtkCompressCompositer.h.

◆ Timer

vtkTimerLog* vtkCompressCompositer::Timer

protected

Definition at line 70 of file vtkCompressCompositer.h.

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

Rendering/Parallel/vtkCompressCompositer.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkCompressCompositer()

◆ ~vtkCompressCompositer()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ CompositeBuffer()

◆ Compress()

◆ Uncompress()

◆ CompositeImagePair()

Member Data Documentation

◆ InternalPData

◆ InternalZData

◆ Timer