VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCompressCompositer Class Reference

Implements compressed tree based compositing. More...

#include <vtkCompressCompositer.h>

Inheritance diagram for vtkCompressCompositer:
[legend]
Collaboration diagram for vtkCompressCompositer:
[legend]

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...
 
vtkCompressCompositerNewInstance () 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
vtkCompositerNewInstance () const
 
virtual void SetController (vtkMultiProcessController *)
 Access to the controller. More...
 
virtual vtkMultiProcessControllerGetController ()
 
virtual void SetNumberOfProcesses (int)
 A hack to get a sub world until I can get communicators working. More...
 
virtual int GetNumberOfProcesses ()
 
- 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...
 
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)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
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)
 
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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 

Static Public Member Functions

static vtkCompressCompositerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCompressCompositerSafeDownCast (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 finalLength)
 
static void CompositeImagePair (vtkFloatArray *localZ, vtkDataArray *localP, vtkFloatArray *remoteZ, vtkDataArray *remoteP, vtkFloatArray *outZ, vtkDataArray *outP)
 
- Static Public Member Functions inherited from vtkCompositer
static vtkCompositerNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCompositerSafeDownCast (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)
 
static void ResizeUnsignedCharArray (vtkUnsignedCharArray *uca, int numComp, vtkIdType size)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCompressCompositer ()
 
 ~vtkCompressCompositer () override
 
- Protected Member Functions inherited from vtkCompositer
 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 ()
 
- 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

vtkDataArrayInternalPData
 
vtkFloatArrayInternalZData
 
vtkTimerLogTimer
 
- Protected Attributes inherited from vtkCompositer
vtkMultiProcessControllerController
 
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
 

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

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  finalLength 
)
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: