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

Abstract class for drawing poly data. More...

#include <vtkPainter.h>

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

Public Types

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...
 
vtkPainterNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual vtkInformationGetInformation ()
 Get/Set the information object associated with this painter. More...
 
virtual void SetInformation (vtkInformation *)
 
virtual vtkPainterGetDelegatePainter ()
 Set/Get the painter to which this painter should propagare its draw calls. More...
 
virtual void SetDelegatePainter (vtkPainter *)
 
void Register (vtkObjectBase *o) override
 Take part in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
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 void SetProgress (double)
 Set/Get the execution progress of a process object. More...
 
virtual double GetProgress ()
 
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...
 
void SetInput (vtkDataObject *)
 Set the data object to paint. More...
 
virtual vtkDataObjectGetInput ()
 
virtual vtkDataObjectGetOutput ()
 Get the output data object from this painter. 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...
 
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 *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
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)
 
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 vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) 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 PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. 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 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 ()
 
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
 
 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 RenderInternal (vtkRenderer *renderer, vtkActor *actor, unsigned long typeflags, bool forceCompileOnly)
 Performs the actual rendering. More...
 
virtual void UpdateDelegateProgress (vtkPainter *delegate, double amount)
 Called when the delegate painter reports its progress. More...
 
virtual void ProcessInformation (vtkInformation *)
 Called before RenderInternal() if the Information has been changed since the last time this method was called. 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)
 
- 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
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

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
 

Friends

class vtkPainterObserver
 

Detailed Description

Abstract class for drawing poly data.

This defines the interface for a Painter. Painters are helpers used by Mapper to perform the rendering. The mapper sets up a chain of painters and passes the render request to the painter. Every painter may have a delegate painter to which the render request is forwarded. The Painter may modify the request or data before passing it to the delegate painter. All the information to control the rendering must be passed to the painter using the vtkInformation object. A concrete painter may read special keys from the vtkInformation object and affect the rendering.

See also
vtkPainterPolyDataMapper

Definition at line 61 of file vtkPainter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 64 of file vtkPainter.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
VERTS 
LINES 
POLYS 
STRIPS 

Definition at line 114 of file vtkPainter.h.

Constructor & Destructor Documentation

◆ vtkPainter()

vtkPainter::vtkPainter ( )
protected

◆ ~vtkPainter()

vtkPainter::~vtkPainter ( )
protected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual int vtkPainter::IsA ( const char *  name)
virtual

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPainter::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkPainter * vtkPainter::NewInstance ( ) const

◆ PrintSelf()

virtual void vtkPainter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

◆ STATIC_DATA()

static vtkInformationIntegerKey * vtkPainter::STATIC_DATA ( )
static

Keys used to specify control the behaviour of the painter.

When on, the painter assumes that the poly data changes infrequently. It is thus more likely to take time and memory to build auxiliary data structures for faster frame rates. Is off by default.

◆ CONSERVE_MEMORY()

static vtkInformationIntegerKey * vtkPainter::CONSERVE_MEMORY ( )
static

Keys used to specify control the behaviour of the painter.

When on, the painter avoids using more memory than it has to. Thus, auxiliary data structures for faster rendering may not be built. Is off by default.

◆ HIGH_QUALITY()

static vtkInformationIntegerKey * vtkPainter::HIGH_QUALITY ( )
static

Keys used to specify control the behaviour of the painter.

When off, the painter may make approximations that will make the rendering go faster but may degrade image quality. Is on by default.

◆ GetInformation()

virtual vtkInformation * vtkPainter::GetInformation ( )
virtual

Get/Set the information object associated with this painter.

◆ SetInformation()

virtual void vtkPainter::SetInformation ( vtkInformation )
virtual

◆ GetDelegatePainter()

virtual vtkPainter * vtkPainter::GetDelegatePainter ( )
virtual

Set/Get the painter to which this painter should propagare its draw calls.

Reimplemented in vtkDefaultPainter.

◆ SetDelegatePainter()

virtual void vtkPainter::SetDelegatePainter ( vtkPainter )
virtual

Reimplemented in vtkDefaultPainter.

◆ Register()

void vtkPainter::Register ( vtkObjectBase o)
overridevirtual

Take part in garbage collection.

Reimplemented from vtkObjectBase.

◆ UnRegister()

void vtkPainter::UnRegister ( vtkObjectBase o)
overridevirtual

Decrease the reference count (release by another object).

This has the same effect as invoking Delete() (i.e., it reduces the reference count by 1).

Reimplemented from vtkObjectBase.

◆ Render()

virtual void vtkPainter::Render ( vtkRenderer renderer,
vtkActor actor,
unsigned long  typeflags,
bool  forceCompileOnly 
)
virtual

Generates rendering primitives of appropriate type(s).

Multiple types of primitives can be requested by or-ring the primitive flags. Default implementation calls UpdateDelegatePainter() to update the deletagate painter and then calls RenderInternal(). forceCompileOnly is passed to the display list painters.

Reimplemented in vtkDefaultPainter, and vtkPolyDataPainter.

◆ ReleaseGraphicsResources()

virtual void vtkPainter::ReleaseGraphicsResources ( vtkWindow )
virtual

Release any graphics resources that are being consumed by this painter.

The parameter window could be used to determine which graphic resources to release. The call is propagated to the delegate painter, if any.

Reimplemented in vtkDefaultPainter, vtkOpenGLDisplayListPainter, vtkOpenGLScalarsToColorsPainter, and vtkSurfaceLICPainter.

◆ SetProgress()

virtual void vtkPainter::SetProgress ( double  )
virtual

Set/Get the execution progress of a process object.

◆ GetProgress()

virtual double vtkPainter::GetProgress ( )
virtual

◆ GetTimeToDraw()

virtual double vtkPainter::GetTimeToDraw ( )
virtual

Get the time required to draw the geometry last time it was rendered.

Default implementation adds the current TimeToDraw with that of the delegate painter.

Reimplemented in vtkDisplayListPainter, vtkOpenGLLightingPainter, and vtkOpenGLRepresentationPainter.

◆ UpdateBounds()

virtual void vtkPainter::UpdateBounds ( double  bounds[6])
virtual

Expand or shrink the estimated bounds of the object based on the geometric transformations performed in the painter.

If the painter does not modify the geometry, the bounds are passed through.

Reimplemented in vtkSurfaceLICDefaultPainter, and vtkDefaultPainter.

◆ SetInput()

void vtkPainter::SetInput ( vtkDataObject )

Set the data object to paint.

Currently we only support one data object per painter chain.

◆ GetInput()

virtual vtkDataObject * vtkPainter::GetInput ( )
virtual

◆ GetOutput()

virtual vtkDataObject * vtkPainter::GetOutput ( )
inlinevirtual

Get the output data object from this painter.

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

Reimplemented in vtkSurfaceLICPainter, vtkCompositePainter, vtkPrimitivePainter, and vtkScalarsToColorsPainter.

Definition at line 174 of file vtkPainter.h.

◆ ReportReferences()

void vtkPainter::ReportReferences ( vtkGarbageCollector collector)
overrideprotectedvirtual

Take part in garbage collection.

Reimplemented from vtkObjectBase.

Reimplemented in vtkPrimitivePainter, and vtkScalarsToColorsPainter.

◆ UpdateDelegatePainter()

void vtkPainter::UpdateDelegatePainter ( )
protected

Updates the delegate painter.

This method is called just before the Render call is passed on to the DelegatePainter. Hence, it gets called only if the DelegatePainter is set. Internally calls PassInformation with argument as this->DelegatePainter. Subclasses must not override this method, instead override PassInformation().

◆ PassInformation()

virtual void vtkPainter::PassInformation ( vtkPainter toPainter)
protectedvirtual

Pass on the information and data (output) from the this to the argument painter.

The method passes the information only if it has changed.

◆ PrepareForRendering()

virtual void vtkPainter::PrepareForRendering ( vtkRenderer ,
vtkActor  
)
inlineprotectedvirtual

Some subclasses may need to do some preprocessing before the actual rendering can be done eg.

build efficient representation for the data etc. This should be done here. This method get called after the ProcessInformation() but before RenderInternal().

Reimplemented in vtkChooserPainter, vtkPrimitivePainter, and vtkScalarsToColorsPainter.

Definition at line 210 of file vtkPainter.h.

◆ RenderInternal()

virtual void vtkPainter::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 in vtkSurfaceLICPainter, vtkChooserPainter, vtkCompositePainter, vtkHardwareSelectionPolyDataPainter, vtkLinesPainter, vtkOpenGLClipPlanesPainter, vtkOpenGLCoincidentTopologyResolutionPainter, vtkOpenGLDisplayListPainter, vtkOpenGLLightingPainter, vtkOpenGLRepresentationPainter, vtkOpenGLScalarsToColorsPainter, vtkPrimitivePainter, vtkStandardPolyDataPainter, and vtkValuePainter.

◆ UpdateDelegateProgress()

virtual void vtkPainter::UpdateDelegateProgress ( vtkPainter delegate,
double  amount 
)
protectedvirtual

Called when the delegate painter reports its progress.

Default implementation reports the delegate's progress as its own.

◆ ProcessInformation()

virtual void vtkPainter::ProcessInformation ( vtkInformation )
inlineprotectedvirtual

◆ ObserverPainterProgress()

virtual void vtkPainter::ObserverPainterProgress ( vtkPainter toObserve)
protectedvirtual

Adds a progress event observer to toObserve.

This provides a means for the subclasses to observe progress events from painters.

◆ UpdateProgress()

void vtkPainter::UpdateProgress ( double  amount)
protected

Update the progress of the process object.

Then set the Progress ivar to amount. The parameter amount should range between (0,1). Raises vtkCommand::ProgressEvent.

◆ GetInputArrayToProcess() [1/2]

vtkAbstractArray * vtkPainter::GetInputArrayToProcess ( int  fieldAssociation,
int  fieldAttributeType,
vtkDataSet ds,
bool *  use_cell_data = 0 
)
protected

Helper method to get input array to process.

◆ GetInputArrayToProcess() [2/2]

vtkAbstractArray * vtkPainter::GetInputArrayToProcess ( int  fieldAssociation,
const char *  name,
vtkDataSet dsl,
bool *  use_cell_data = 0 
)
protected

Friends And Related Function Documentation

◆ vtkPainterObserver

friend class vtkPainterObserver
friend

Definition at line 263 of file vtkPainter.h.

Member Data Documentation

◆ InformationProcessTime

vtkTimeStamp vtkPainter::InformationProcessTime
protected

Definition at line 262 of file vtkPainter.h.

◆ Observer

vtkPainterObserver* vtkPainter::Observer
protected

Definition at line 264 of file vtkPainter.h.

◆ Information

vtkInformation* vtkPainter::Information
protected

Definition at line 266 of file vtkPainter.h.

◆ DelegatePainter

vtkPainter* vtkPainter::DelegatePainter
protected

Definition at line 267 of file vtkPainter.h.

◆ Progress

double vtkPainter::Progress
protected

Definition at line 269 of file vtkPainter.h.

◆ ProgressOffset

double vtkPainter::ProgressOffset
protected

Definition at line 270 of file vtkPainter.h.

◆ ProgressScaleFactor

double vtkPainter::ProgressScaleFactor
protected

Definition at line 271 of file vtkPainter.h.

◆ TimeToDraw

double vtkPainter::TimeToDraw
protected

Definition at line 273 of file vtkPainter.h.

◆ Timer

vtkTimerLog* vtkPainter::Timer
protected

Definition at line 274 of file vtkPainter.h.

◆ LastWindow

vtkWeakPointer<vtkWindow> vtkPainter::LastWindow
protected

Definition at line 277 of file vtkPainter.h.


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