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

sets up a default chain of painters. More...

#include <vtkDefaultPainter.h>

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

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...
 
vtkDefaultPainterNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetScalarsToColorsPainter (vtkScalarsToColorsPainter *)
 Get/Set the painter that maps scalars to colors. More...
 
virtual vtkScalarsToColorsPainterGetScalarsToColorsPainter ()
 
void SetClipPlanesPainter (vtkClipPlanesPainter *)
 Get/Set the painter that handles clipping. More...
 
virtual vtkClipPlanesPainterGetClipPlanesPainter ()
 
void SetDisplayListPainter (vtkDisplayListPainter *)
 Get/Set the painter that builds display lists. More...
 
virtual vtkDisplayListPainterGetDisplayListPainter ()
 
void SetCompositePainter (vtkCompositePainter *)
 Get/Set the painter used to handle composite datasets. More...
 
virtual vtkCompositePainterGetCompositePainter ()
 
void SetCoincidentTopologyResolutionPainter (vtkCoincidentTopologyResolutionPainter *)
 Painter used to resolve coincident topology. More...
 
virtual vtkCoincidentTopologyResolutionPainterGetCoincidentTopologyResolutionPainter ()
 
void SetLightingPainter (vtkLightingPainter *)
 Get/Set the painter that controls lighting. More...
 
virtual vtkLightingPainterGetLightingPainter ()
 
void SetRepresentationPainter (vtkRepresentationPainter *)
 Painter used to convert polydata to Wireframe/Points representation. More...
 
virtual vtkRepresentationPainterGetRepresentationPainter ()
 
virtual void SetDelegatePainter (vtkPainter *)
 Set/Get the painter to which this painter should propagare its draw calls. More...
 
virtual vtkPainterGetDelegatePainter ()
 Set/Get the painter to which this painter should propagare its draw calls. More...
 
virtual void Render (vtkRenderer *renderer, vtkActor *actor, unsigned long typeflags, bool forceCompileOnly)
 Overridden to setup the chain of painter depending on the actor representation. More...
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 Release any graphics resources that are being consumed by this painter. More...
 
void UpdateBounds (double bounds[6])
 Expand or shrink the estimated bounds based on the geometric transformations applied in the painter. More...
 
- Public Member Functions inherited from vtkPainter
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 vtkDefaultPainterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkDefaultPainterSafeDownCast (vtkObjectBase *o)
 
- 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 ()
 
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
 
 vtkDefaultPainter ()
 
 ~vtkDefaultPainter ()
 
virtual void BuildPainterChain ()
 Setups the the painter chain. More...
 
void ReportReferences (vtkGarbageCollector *collector) override
 Take part in garbage collection. More...
 
void SetDefaultPainterDelegate (vtkPainter *)
 
- Protected Member Functions inherited from vtkPainter
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

vtkScalarsToColorsPainterScalarsToColorsPainter
 
vtkClipPlanesPainterClipPlanesPainter
 
vtkDisplayListPainterDisplayListPainter
 
vtkCompositePainterCompositePainter
 
vtkCoincidentTopologyResolutionPainterCoincidentTopologyResolutionPainter
 
vtkLightingPainterLightingPainter
 
vtkRepresentationPainterRepresentationPainter
 
vtkTimeStamp ChainBuildTime
 
vtkPainterDefaultPainterDelegate
 
- 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

sets up a default chain of painters.

This painter does not do any actual rendering. Sets up a default pipeline of painters to mimick the behaiour of old vtkPolyDataMapper. The chain is as follows: input--> vtkScalarsToColorsPainter --> vtkClipPlanesPainter --> vtkDisplayListPainter --> vtkCompositePainter --> vtkCoincidentTopologyResolutionPainter --> vtkLightingPainter --> vtkRepresentationPainter --> <Delegate of vtkDefaultPainter>. Typically, the delegate of the default painter be one that is capable of r rendering graphics primitives or a vtkChooserPainter which can select appropriate painters to do the rendering.

Definition at line 47 of file vtkDefaultPainter.h.

Member Typedef Documentation

◆ Superclass

Definition at line 51 of file vtkDefaultPainter.h.

Constructor & Destructor Documentation

◆ vtkDefaultPainter()

vtkDefaultPainter::vtkDefaultPainter ( )
protected

◆ ~vtkDefaultPainter()

vtkDefaultPainter::~vtkDefaultPainter ( )
protected

Member Function Documentation

◆ New()

static vtkDefaultPainter * vtkDefaultPainter::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual int vtkDefaultPainter::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 vtkSurfaceLICDefaultPainter.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkDefaultPainter::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPainter.

Reimplemented in vtkSurfaceLICDefaultPainter.

◆ NewInstance()

vtkDefaultPainter * vtkDefaultPainter::NewInstance ( ) const

◆ PrintSelf()

virtual void vtkDefaultPainter::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 vtkSurfaceLICDefaultPainter.

◆ SetScalarsToColorsPainter()

void vtkDefaultPainter::SetScalarsToColorsPainter ( vtkScalarsToColorsPainter )

Get/Set the painter that maps scalars to colors.

◆ GetScalarsToColorsPainter()

virtual vtkScalarsToColorsPainter * vtkDefaultPainter::GetScalarsToColorsPainter ( )
virtual

◆ SetClipPlanesPainter()

void vtkDefaultPainter::SetClipPlanesPainter ( vtkClipPlanesPainter )

Get/Set the painter that handles clipping.

◆ GetClipPlanesPainter()

virtual vtkClipPlanesPainter * vtkDefaultPainter::GetClipPlanesPainter ( )
virtual

◆ SetDisplayListPainter()

void vtkDefaultPainter::SetDisplayListPainter ( vtkDisplayListPainter )

Get/Set the painter that builds display lists.

◆ GetDisplayListPainter()

virtual vtkDisplayListPainter * vtkDefaultPainter::GetDisplayListPainter ( )
virtual

◆ SetCompositePainter()

void vtkDefaultPainter::SetCompositePainter ( vtkCompositePainter )

Get/Set the painter used to handle composite datasets.

◆ GetCompositePainter()

virtual vtkCompositePainter * vtkDefaultPainter::GetCompositePainter ( )
virtual

◆ SetCoincidentTopologyResolutionPainter()

void vtkDefaultPainter::SetCoincidentTopologyResolutionPainter ( vtkCoincidentTopologyResolutionPainter )

Painter used to resolve coincident topology.

◆ GetCoincidentTopologyResolutionPainter()

virtual vtkCoincidentTopologyResolutionPainter * vtkDefaultPainter::GetCoincidentTopologyResolutionPainter ( )
virtual

◆ SetLightingPainter()

void vtkDefaultPainter::SetLightingPainter ( vtkLightingPainter )

Get/Set the painter that controls lighting.

◆ GetLightingPainter()

virtual vtkLightingPainter * vtkDefaultPainter::GetLightingPainter ( )
virtual

◆ SetRepresentationPainter()

void vtkDefaultPainter::SetRepresentationPainter ( vtkRepresentationPainter )

Painter used to convert polydata to Wireframe/Points representation.

◆ GetRepresentationPainter()

virtual vtkRepresentationPainter * vtkDefaultPainter::GetRepresentationPainter ( )
virtual

◆ SetDelegatePainter()

virtual void vtkDefaultPainter::SetDelegatePainter ( vtkPainter )
virtual

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

These methods are overridden so that the delegate is set to the end of the Painter Chain.

Reimplemented from vtkPainter.

◆ GetDelegatePainter()

virtual vtkPainter * vtkDefaultPainter::GetDelegatePainter ( )
inlinevirtual

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

Reimplemented from vtkPainter.

Definition at line 118 of file vtkDefaultPainter.h.

◆ Render()

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

Overridden to setup the chain of painter depending on the actor representation.

The chain is rebuilt if this->MTime has changed since last BuildPainterChain(); Building of the chain does not depend on input polydata, hence it does not check if the input has changed at all.

Reimplemented from vtkPainter.

◆ ReleaseGraphicsResources()

virtual void vtkDefaultPainter::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 from vtkPainter.

◆ UpdateBounds()

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

Expand or shrink the estimated bounds based on the geometric transformations applied in the painter.

The bounds are left unchanged if the painter does not change the geometry.

Reimplemented from vtkPainter.

◆ BuildPainterChain()

virtual void vtkDefaultPainter::BuildPainterChain ( )
protectedvirtual

Setups the the painter chain.

Reimplemented in vtkSurfaceLICDefaultPainter.

◆ ReportReferences()

void vtkDefaultPainter::ReportReferences ( vtkGarbageCollector collector)
overrideprotectedvirtual

Take part in garbage collection.

Reimplemented from vtkObjectBase.

◆ SetDefaultPainterDelegate()

void vtkDefaultPainter::SetDefaultPainterDelegate ( vtkPainter )
protected

Member Data Documentation

◆ ScalarsToColorsPainter

vtkScalarsToColorsPainter* vtkDefaultPainter::ScalarsToColorsPainter
protected

Definition at line 160 of file vtkDefaultPainter.h.

◆ ClipPlanesPainter

vtkClipPlanesPainter* vtkDefaultPainter::ClipPlanesPainter
protected

Definition at line 161 of file vtkDefaultPainter.h.

◆ DisplayListPainter

vtkDisplayListPainter* vtkDefaultPainter::DisplayListPainter
protected

Definition at line 162 of file vtkDefaultPainter.h.

◆ CompositePainter

vtkCompositePainter* vtkDefaultPainter::CompositePainter
protected

Definition at line 163 of file vtkDefaultPainter.h.

◆ CoincidentTopologyResolutionPainter

vtkCoincidentTopologyResolutionPainter* vtkDefaultPainter::CoincidentTopologyResolutionPainter
protected

Definition at line 164 of file vtkDefaultPainter.h.

◆ LightingPainter

vtkLightingPainter* vtkDefaultPainter::LightingPainter
protected

Definition at line 165 of file vtkDefaultPainter.h.

◆ RepresentationPainter

vtkRepresentationPainter* vtkDefaultPainter::RepresentationPainter
protected

Definition at line 166 of file vtkDefaultPainter.h.

◆ ChainBuildTime

vtkTimeStamp vtkDefaultPainter::ChainBuildTime
protected

Definition at line 167 of file vtkDefaultPainter.h.

◆ DefaultPainterDelegate

vtkPainter* vtkDefaultPainter::DefaultPainterDelegate
protected

Definition at line 169 of file vtkDefaultPainter.h.


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