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

painter that can be inserted before any vtkDataSet painting chain to handle composite datasets. More...

#include <vtkCompositePainter.h>

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

Classes

class  RenderBlockState
 

Public Types

typedef vtkPainter Superclass
 
- Public Types inherited from vtkPainter
enum  { VERTS = 0x1, LINES = 0x2, POLYS = 0x4, STRIPS = 0x8 }
 
typedef vtkObject Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkCompositePainterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkDataObjectGetOutput ()
 Get the output data object from this painter. More...
 
void SetCompositeDataDisplayAttributes (vtkCompositeDataDisplayAttributes *attributes)
 Set/get the composite data set display attributes. More...
 
virtual vtkCompositeDataDisplayAttributesGetCompositeDataDisplayAttributes ()
 
- Public Member Functions inherited from vtkPainter
vtkPainterNewInstance () const
 
virtual void Render (vtkRenderer *renderer, vtkActor *actor, unsigned long typeflags, bool forceCompileOnly)
 Generates rendering primitives of appropriate type(s). More...
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 Release any graphics resources that are being consumed by this painter. More...
 
virtual double GetTimeToDraw ()
 Get the time required to draw the geometry last time it was rendered. More...
 
virtual void UpdateBounds (double bounds[6])
 Expand or shrink the estimated bounds of the object based on the geometric transformations performed in the painter. More...
 
virtual vtkInformationGetInformation ()
 Get/Set the information object associated with this painter. More...
 
virtual void SetInformation (vtkInformation *)
 Get/Set the information object associated with this painter. More...
 
virtual vtkPainterGetDelegatePainter ()
 Set/Get the painter to which this painter should propagare its draw calls. More...
 
virtual void SetDelegatePainter (vtkPainter *)
 Set/Get the painter to which this painter should propagare its draw calls. More...
 
void Register (vtkObjectBase *o) override
 Take part in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Take part in garbage collection. More...
 
virtual void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 Set/Get the execution progress of a process object. More...
 
void SetInput (vtkDataObject *)
 Set the data object to paint. More...
 
virtual vtkDataObjectGetInput ()
 Set the data object to paint. 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 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)
 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...
 
vtkCommandGetCommand (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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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 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...
 
int GetReferenceCount ()
 Return the current reference count of this object. More...
 
void SetReferenceCount (int)
 Sets the reference count. More...
 
void PrintRevisions (ostream &)
 Legacy. 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 vtkCompositePainterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkCompositePainterSafeDownCast (vtkObjectBase *o)
 
static vtkInformationObjectBaseKeyDISPLAY_ATTRIBUTES ()
 Key used to pass a vtkCompositeDataDisplayAttributes instance doing the painter pipeline. More...
 
- Static Public Member Functions inherited from vtkPainter
static int IsTypeOf (const char *type)
 
static vtkPainterSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeySTATIC_DATA ()
 Keys used to specify control the behaviour of the painter. More...
 
static vtkInformationIntegerKeyCONSERVE_MEMORY ()
 Keys used to specify control the behaviour of the painter. More...
 
static vtkInformationIntegerKeyHIGH_QUALITY ()
 Keys used to specify control the behaviour of the painter. More...
 
- 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 ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCompositePainter ()
 
 ~vtkCompositePainter ()
 
void ReportReferences (vtkGarbageCollector *collector) override
 Take part in garbage collection. More...
 
virtual void ProcessInformation (vtkInformation *information)
 Called before RenderInternal() if the Information has been changed since the last time this method was called. More...
 
virtual void RenderInternal (vtkRenderer *renderer, vtkActor *actor, unsigned long typeflags, bool forceCompileOnly)
 Performs the actual rendering. More...
 
void RenderBlock (vtkRenderer *renderer, vtkActor *actor, unsigned long typeflags, bool forceCompileOnly, vtkDataObject *dobj, unsigned int &flat_index, RenderBlockState &state)
 
virtual void UpdateRenderingState (vtkRenderWindow *, vtkProperty *, RenderBlockState &)
 Overridden in vtkOpenGLCompositePainter to pass attributes to OpenGL. More...
 
- Protected Member Functions inherited from vtkPainter
 vtkPainter ()
 
 ~vtkPainter ()
 
void ReportReferences (vtkGarbageCollector *collector) override
 Take part in garbage collection. More...
 
void UpdateDelegatePainter ()
 Updates the delegate painter. More...
 
virtual void PassInformation (vtkPainter *toPainter)
 Pass on the information and data (output) from the this to the argument painter. More...
 
virtual void PrepareForRendering (vtkRenderer *, vtkActor *)
 Some subclasses may need to do some preprocessing before the actual rendering can be done eg. More...
 
virtual void UpdateDelegateProgress (vtkPainter *delegate, double amount)
 Called when the delegate painter reports its progress. More...
 
virtual void ObserverPainterProgress (vtkPainter *toObserve)
 Adds a progress event observer to toObserve. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
vtkAbstractArrayGetInputArrayToProcess (int fieldAssociation, int fieldAttributeType, vtkDataSet *ds, bool *use_cell_data=0)
 Helper method to get input array to process. More...
 
vtkAbstractArrayGetInputArrayToProcess (int fieldAssociation, const char *name, vtkDataSet *dsl, bool *use_cell_data=0)
 Helper method to get input array to process. More...
 
- 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=NULL)
 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 CollectRevisions (ostream &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkDataObjectOutputData
 
vtkCompositeDataDisplayAttributesCompositeDataDisplayAttributes
 
- Protected Attributes inherited from vtkPainter
vtkTimeStamp InformationProcessTime
 
vtkPainterObserverObserver
 
vtkInformationInformation
 
vtkPainterDelegatePainter
 
double Progress
 
double ProgressOffset
 
double ProgressScaleFactor
 
double TimeToDraw
 
vtkTimerLogTimer
 
vtkWeakPointer< vtkWindowLastWindow
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

painter that can be inserted before any vtkDataSet painting chain to handle composite datasets.

vtkCompositePainter iterates over the leaves in a composite datasets. This painter can also handle the case when the dataset is not a composite dataset.

Definition at line 38 of file vtkCompositePainter.h.

Member Typedef Documentation

Definition at line 42 of file vtkCompositePainter.h.

Constructor & Destructor Documentation

vtkCompositePainter::vtkCompositePainter ( )
protected
vtkCompositePainter::~vtkCompositePainter ( )
protected

Member Function Documentation

static vtkCompositePainter* vtkCompositePainter::New ( )
static
static int vtkCompositePainter::IsTypeOf ( const char *  type)
static
virtual int vtkCompositePainter::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 vtkPainter.

Reimplemented in vtkOpenGLCompositePainter.

static vtkCompositePainter* vtkCompositePainter::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkCompositePainter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPainter.

Reimplemented in vtkOpenGLCompositePainter.

vtkCompositePainter* vtkCompositePainter::NewInstance ( ) const
void vtkCompositePainter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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 vtkPainter.

Reimplemented in vtkOpenGLCompositePainter.

virtual vtkDataObject* vtkCompositePainter::GetOutput ( )
virtual

Get the output data object from this painter.

The default implementation simply forwards the input data object as the output.

Reimplemented from vtkPainter.

static vtkInformationObjectBaseKey* vtkCompositePainter::DISPLAY_ATTRIBUTES ( )
static

Key used to pass a vtkCompositeDataDisplayAttributes instance doing the painter pipeline.

void vtkCompositePainter::SetCompositeDataDisplayAttributes ( vtkCompositeDataDisplayAttributes attributes)

Set/get the composite data set display attributes.

If set, these attributes can be used by the painter to control specific rendering attributes on a per-block basis for a multi-block dataset.

virtual vtkCompositeDataDisplayAttributes* vtkCompositePainter::GetCompositeDataDisplayAttributes ( )
virtual
void vtkCompositePainter::ReportReferences ( vtkGarbageCollector collector)
overrideprotectedvirtual

Take part in garbage collection.

Reimplemented from vtkObjectBase.

virtual void vtkCompositePainter::ProcessInformation ( vtkInformation information)
protectedvirtual

Called before RenderInternal() if the Information has been changed since the last time this method was called.

Reimplemented from vtkPainter.

virtual void vtkCompositePainter::RenderInternal ( vtkRenderer renderer,
vtkActor actor,
unsigned long  typeflags,
bool  forceCompileOnly 
)
protectedvirtual

Performs the actual rendering.

Subclasses may override this method. default implementation merely call a Render on the DelegatePainter, if any. When RenderInternal() is called, it is assured that the DelegatePainter is in sync with this painter i.e. UpdateDelegatePainter() has been called.

Reimplemented from vtkPainter.

void vtkCompositePainter::RenderBlock ( vtkRenderer renderer,
vtkActor actor,
unsigned long  typeflags,
bool  forceCompileOnly,
vtkDataObject dobj,
unsigned int flat_index,
RenderBlockState state 
)
protected
virtual void vtkCompositePainter::UpdateRenderingState ( vtkRenderWindow ,
vtkProperty ,
RenderBlockState  
)
inlineprotectedvirtual

Overridden in vtkOpenGLCompositePainter to pass attributes to OpenGL.

Reimplemented in vtkOpenGLCompositePainter.

Definition at line 116 of file vtkCompositePainter.h.

Member Data Documentation

vtkDataObject* vtkCompositePainter::OutputData
protected

Definition at line 119 of file vtkCompositePainter.h.

vtkCompositeDataDisplayAttributes* vtkCompositePainter::CompositeDataDisplayAttributes
protected

Definition at line 120 of file vtkCompositePainter.h.


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