vtkPainter Class Reference

#include <vtkPainter.h>

Inheritance diagram for vtkPainter:

Inheritance graph
[legend]
Collaboration diagram for vtkPainter:

Collaboration graph
[legend]

List of all members.


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
Events:
vtkCommand::ProgressEvent

Definition at line 62 of file vtkPainter.h.


Public Types

enum  { VERTS = 0x1, LINES = 0x2, POLYS = 0x4, STRIPS = 0x8 }
typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
virtual void PrintSelf (ostream &os, vtkIndent indent)
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual double GetTimeToDraw ()
virtual void UpdateBounds (double bounds[6])
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual vtkPainterGetDelegatePainter ()
virtual void SetDelegatePainter (vtkPainter *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void Render (vtkRenderer *renderer, vtkActor *actor, unsigned long typeflags, bool forceCompileOnly)
virtual void SetProgress (double)
virtual double GetProgress ()
void SetInput (vtkDataObject *)
virtual vtkDataObjectGetInput ()
virtual vtkDataObjectGetOutput ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkPainterSafeDownCast (vtkObject *o)
static vtkInformationIntegerKeySTATIC_DATA ()
static vtkInformationIntegerKeyCONSERVE_MEMORY ()
static vtkInformationIntegerKeyHIGH_QUALITY ()

Protected Member Functions

 vtkPainter ()
 ~vtkPainter ()
virtual void ReportReferences (vtkGarbageCollector *collector)
void UpdateDelegatePainter ()
virtual void PassInformation (vtkPainter *toPainter)
virtual void PrepareForRendering (vtkRenderer *, vtkActor *)
virtual void UpdateDelegateProgress (vtkPainter *delegate, double amount)
virtual void ProcessInformation (vtkInformation *)
virtual void ObserverPainterProgress (vtkPainter *toObserve)
void UpdateProgress (double amount)
virtual void RenderInternal (vtkRenderer *renderer, vtkActor *actor, unsigned long typeflags, bool forceCompileOnly)
vtkAbstractArrayGetInputArrayToProcess (int fieldAssociation, int fieldAttributeType, vtkDataSet *ds, bool *use_cell_data=0)
vtkAbstractArrayGetInputArrayToProcess (int fieldAssociation, const char *name, vtkDataSet *dsl, bool *use_cell_data=0)

Protected Attributes

vtkTimeStamp InformationProcessTime
vtkPainterObserver * Observer
vtkInformationInformation
vtkPainterDelegatePainter
double Progress
double ProgressOffset
double ProgressScaleFactor
double TimeToDraw
vtkTimerLogTimer
vtkWeakPointer< vtkWindowLastWindow

Friends

class vtkPainterObserver

Member Typedef Documentation


Member Enumeration Documentation

anonymous enum

Enumerator:
VERTS 
LINES 
POLYS 
STRIPS 

Definition at line 105 of file vtkPainter.h.


Constructor & Destructor Documentation

vtkPainter::vtkPainter (  )  [protected]

vtkPainter::~vtkPainter (  )  [protected]


Member Function Documentation

virtual const char* vtkPainter::GetClassName (  )  [virtual]

static int vtkPainter::IsTypeOf ( const char *  name  )  [static]

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

static vtkPainter* vtkPainter::SafeDownCast ( vtkObject o  )  [static]

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

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.

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.

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.

virtual vtkInformation* vtkPainter::GetInformation (  )  [virtual]

Get/Set the information object associated with this painter.

virtual void vtkPainter::SetInformation ( vtkInformation  )  [virtual]

Get/Set the information object associated with this painter.

virtual vtkPainter* vtkPainter::GetDelegatePainter (  )  [virtual]

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

Reimplemented in vtkDefaultPainter.

virtual void vtkPainter::SetDelegatePainter ( vtkPainter  )  [virtual]

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

Reimplemented in vtkDefaultPainter.

virtual void vtkPainter::Register ( vtkObjectBase o  )  [virtual]

Take part in garbage collection.

Reimplemented from vtkObjectBase.

virtual void vtkPainter::UnRegister ( vtkObjectBase o  )  [virtual]

Take part in garbage collection.

Reimplemented from vtkObjectBase.

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.

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, vtkMesaDisplayListPainter, vtkMesaScalarsToColorsPainter, vtkOpenGLDisplayListPainter, and vtkOpenGLScalarsToColorsPainter.

virtual void vtkPainter::SetProgress ( double   )  [virtual]

Set/Get the execution progress of a process object.

virtual double vtkPainter::GetProgress (  )  [virtual]

Set/Get the execution progress of a process object.

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.

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

void vtkPainter::SetInput ( vtkDataObject  ) 

Set the data object to paint. Currently we only support one data object per painter chain.

virtual vtkDataObject* vtkPainter::GetInput (  )  [virtual]

Set the data object to paint. Currently we only support one data object per painter chain.

virtual vtkDataObject* vtkPainter::GetOutput (  )  [inline, virtual]

Get the output data object from this painter. The default implementation simply forwards the input data object as the output.

Reimplemented in vtkCompositePainter, vtkPrimitivePainter, and vtkScalarsToColorsPainter.

Definition at line 155 of file vtkPainter.h.

virtual void vtkPainter::ReportReferences ( vtkGarbageCollector collector  )  [protected, virtual]

Take part in garbage collection.

Reimplemented from vtkObjectBase.

Reimplemented in vtkChooserPainter, vtkCompositePainter, vtkDefaultPainter, vtkPrimitivePainter, and vtkScalarsToColorsPainter.

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().

virtual void vtkPainter::PassInformation ( vtkPainter toPainter  )  [protected, virtual]

Pass on the information and data (output) from the this to the argument painter. The method passes the information only if it has changed.

virtual void vtkPainter::PrepareForRendering ( vtkRenderer ,
vtkActor  
) [inline, protected, virtual]

Some subclasses may need to do some preprocessing before the actual rendering can be done eg. build effecient 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 183 of file vtkPainter.h.

virtual void vtkPainter::RenderInternal ( vtkRenderer renderer,
vtkActor actor,
unsigned long  typeflags,
bool  forceCompileOnly 
) [protected, virtual]

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 vtkChooserPainter, vtkCompositePainter, vtkHardwareSelectionPolyDataPainter, vtkIdentColoredPainter, vtkLinesPainter, vtkOpenGLClipPlanesPainter, vtkOpenGLCoincidentTopologyResolutionPainter, vtkOpenGLDisplayListPainter, vtkOpenGLLightingPainter, vtkOpenGLRepresentationPainter, vtkOpenGLScalarsToColorsPainter, vtkPrimitivePainter, and vtkStandardPolyDataPainter.

virtual void vtkPainter::UpdateDelegateProgress ( vtkPainter delegate,
double  amount 
) [protected, virtual]

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

virtual void vtkPainter::ProcessInformation ( vtkInformation  )  [inline, protected, virtual]

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

Reimplemented in vtkClipPlanesPainter, vtkCoincidentTopologyResolutionPainter, vtkCompositePainter, vtkDisplayListPainter, vtkPolyDataPainter, vtkPrimitivePainter, vtkScalarsToColorsPainter, and vtkStandardPolyDataPainter.

Definition at line 201 of file vtkPainter.h.

virtual void vtkPainter::ObserverPainterProgress ( vtkPainter toObserve  )  [protected, virtual]

Adds a progress event observer to toObserve. This provides a means for the subclasses to observe progress events from painters.

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.

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

Helper method to get input array to process.

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

Helper method to get input array to process.


Friends And Related Function Documentation

friend class vtkPainterObserver [friend]

Definition at line 225 of file vtkPainter.h.


Member Data Documentation

Definition at line 224 of file vtkPainter.h.

vtkPainterObserver* vtkPainter::Observer [protected]

Definition at line 226 of file vtkPainter.h.

Definition at line 228 of file vtkPainter.h.

Definition at line 229 of file vtkPainter.h.

double vtkPainter::Progress [protected]

Definition at line 231 of file vtkPainter.h.

double vtkPainter::ProgressOffset [protected]

Definition at line 232 of file vtkPainter.h.

double vtkPainter::ProgressScaleFactor [protected]

Definition at line 233 of file vtkPainter.h.

double vtkPainter::TimeToDraw [protected]

Definition at line 235 of file vtkPainter.h.

Definition at line 236 of file vtkPainter.h.

Definition at line 238 of file vtkPainter.h.


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

Generated on Wed Jun 3 19:21:56 2009 for VTK by  doxygen 1.5.6