Abstract class for drawing poly data. More...

#include <vtkPainter.h>

Inheritance diagram for vtkPainter:

Collaboration diagram for vtkPainter:

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

vtkPainter *	NewInstance () const

virtual void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. 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 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 vtkDataObject *	GetOutput ()
	Get the output data object from this painter. More...


virtual vtkInformation *	GetInformation ()
	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 vtkPainter *	GetDelegatePainter ()
	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 vtkDataObject *	GetInput ()
	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...

vtkCommand *	GetCommand (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 int	IsTypeOf (const char *type)

static vtkPainter *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	STATIC_DATA ()
	Keys used to specify control the behaviour of the painter. More...

static vtkInformationIntegerKey *	CONSERVE_MEMORY ()
	Keys used to specify control the behaviour of the painter. More...

static vtkInformationIntegerKey *	HIGH_QUALITY ()
	Keys used to specify control the behaviour of the painter. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () 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...


vtkAbstractArray *	GetInputArrayToProcess (int fieldAssociation, int fieldAttributeType, vtkDataSet ds, bool use_cell_data=0)
	Helper method to get input array to process. More...

vtkAbstractArray *	GetInputArrayToProcess (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
vtkTimeStamp	InformationProcessTime

vtkPainterObserver *	Observer

vtkInformation *	Information

vtkPainter *	DelegatePainter

double	Progress

double	ProgressOffset

double	ProgressScaleFactor

double	TimeToDraw

vtkTimerLog *	Timer

vtkWeakPointer< vtkWindow >	LastWindow

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

typedef vtkObject vtkPainter::Superclass

Definition at line 64 of file vtkPainter.h.

Member Enumeration Documentation

anonymous enum

Enumerator
VERTS
LINES
POLYS
STRIPS

Definition at line 114 of file vtkPainter.h.

Constructor & Destructor Documentation

vtkPainter::vtkPainter ( )

protected

vtkPainter::~vtkPainter ( )

protected

Member Function Documentation

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

static

virtual int vtkPainter::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 vtkObjectBase.

Reimplemented in vtkSurfaceLICPainter, vtkPolyDataPainter, vtkStandardPolyDataPainter, vtkDefaultPainter, vtkScalarsToColorsPainter, vtkSurfaceLICDefaultPainter, vtkValuePainter, vtkCoincidentTopologyResolutionPainter, vtkCompositePainter, vtkPrimitivePainter, vtkOpenGLScalarsToColorsPainter, vtkChooserPainter, vtkLinesPainter, vtkHardwareSelectionPolyDataPainter, vtkOpenGLLightingPainter, vtkPointsPainter, vtkPSurfaceLICPainter, vtkOpenGLClipPlanesPainter, vtkOpenGLRepresentationPainter, vtkOpenGLDisplayListPainter, vtkClipPlanesPainter, vtkRepresentationPainter, vtkDisplayListPainter, vtkOpenGLCoincidentTopologyResolutionPainter, vtkPolygonsPainter, vtkLightingPainter, vtkOpenGLCompositePainter, and vtkTStripsPainter.

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

static

virtual vtkObjectBase* vtkPainter::NewInstanceInternal ( ) const

protectedvirtual

vtkPainter* vtkPainter::NewInstance ( ) const

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

Reimplemented in vtkSurfaceLICPainter, vtkPolyDataPainter, vtkStandardPolyDataPainter, vtkDefaultPainter, vtkScalarsToColorsPainter, vtkSurfaceLICDefaultPainter, vtkValuePainter, vtkCoincidentTopologyResolutionPainter, vtkCompositePainter, vtkPrimitivePainter, vtkOpenGLScalarsToColorsPainter, vtkChooserPainter, vtkLinesPainter, vtkHardwareSelectionPolyDataPainter, vtkOpenGLLightingPainter, vtkPointsPainter, vtkPSurfaceLICPainter, vtkOpenGLClipPlanesPainter, vtkOpenGLRepresentationPainter, vtkOpenGLDisplayListPainter, vtkClipPlanesPainter, vtkRepresentationPainter, vtkDisplayListPainter, vtkOpenGLCoincidentTopologyResolutionPainter, vtkPolygonsPainter, vtkLightingPainter, vtkOpenGLCompositePainter, and vtkTStripsPainter.

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.

void vtkPainter::Register ( vtkObjectBase * o )

overridevirtual

Take part in garbage collection.

Reimplemented from vtkObjectBase.

void vtkPainter::UnRegister ( vtkObjectBase * o )

overridevirtual

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

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, and vtkSurfaceLICDefaultPainter.

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

inlinevirtual

Get the output data object from this painter.

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

Reimplemented in vtkScalarsToColorsPainter, vtkSurfaceLICPainter, vtkPrimitivePainter, and vtkCompositePainter.

Definition at line 174 of file vtkPainter.h.

void vtkPainter::ReportReferences ( vtkGarbageCollector * collector )

overrideprotectedvirtual

Take part in garbage collection.

Reimplemented from vtkObjectBase.

Reimplemented in vtkScalarsToColorsPainter, and vtkPrimitivePainter.

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 )

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.

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 vtkScalarsToColorsPainter, vtkPrimitivePainter, and vtkChooserPainter.

Definition at line 210 of file vtkPainter.h.

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

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.

virtual void vtkPainter::ProcessInformation ( vtkInformation * )

inlineprotectedvirtual

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

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

Definition at line 233 of file vtkPainter.h.

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.

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 263 of file vtkPainter.h.

Member Data Documentation

vtkTimeStamp vtkPainter::InformationProcessTime

protected

Definition at line 262 of file vtkPainter.h.

vtkPainterObserver* vtkPainter::Observer

protected

Definition at line 264 of file vtkPainter.h.

vtkInformation* vtkPainter::Information

protected

Definition at line 266 of file vtkPainter.h.

vtkPainter* vtkPainter::DelegatePainter

protected

Definition at line 267 of file vtkPainter.h.

double vtkPainter::Progress

protected

Definition at line 269 of file vtkPainter.h.

double vtkPainter::ProgressOffset

protected

Definition at line 270 of file vtkPainter.h.

double vtkPainter::ProgressScaleFactor

protected

Definition at line 271 of file vtkPainter.h.

double vtkPainter::TimeToDraw

protected

Definition at line 273 of file vtkPainter.h.

vtkTimerLog* vtkPainter::Timer

protected

Definition at line 274 of file vtkPainter.h.

vtkWeakPointer<vtkWindow> vtkPainter::LastWindow

protected

Definition at line 277 of file vtkPainter.h.

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

/home/demarle/Builds/VTK/release/Utilities/Doxygen/dox/Rendering/OpenGL/vtkPainter.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation