painter that renders arrays encoded into pixel colors. More...

#include <vtkValuePainter.h>

Inheritance diagram for vtkValuePainter:

Collaboration diagram for vtkValuePainter:

Public Types
typedef vtkStandardPolyDataPainter	Superclass

Public Types inherited from vtkStandardPolyDataPainter
typedef vtkPolyDataPainter	Superclass

Public Types inherited from vtkPolyDataPainter
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...

vtkValuePainter *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

void	SetInputComponentToProcess (int comp)
	Set the component (0..numcomponents-1) of the specified array to be drawn. More...

void	SetScalarRange (double min, double max)
	Use the provided scalar range instead of the range of the input data array. More...


void	SetInputArrayToProcess (int fieldAssociation, const char *name)
	Set the array to be drawn. More...

void	SetInputArrayToProcess (int fieldAssociation, int fieldAttributeType)
	Set the array to be drawn. More...

Public Member Functions inherited from vtkStandardPolyDataPainter
vtkStandardPolyDataPainter *	NewInstance () const

void	AddMultiTextureCoordsArray (vtkDataArray *array)

Public Member Functions inherited from vtkPolyDataPainter
vtkPolyDataPainter *	NewInstance () const

vtkPolyData *	GetInputAsPolyData ()
	Get/set the poly data to render. More...

vtkPolyData *	GetOutputAsPolyData ()
	Get the output polydata from this Painter. More...

virtual void	Render (vtkRenderer renderer, vtkActor actor, unsigned long typeflags, bool forceCompileOnly)
	Overridden to stop the render call if input polydata is not set, since PolyDataPainter cannot paint without any polydata input. More...

Public Member Functions inherited from vtkPainter
vtkPainter *	NewInstance () const

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 vtkValuePainter *	New ()

static int	IsTypeOf (const char *type)

static vtkValuePainter *	SafeDownCast (vtkObjectBase *o)

static void	ValueToColor (double value, double min, double scale, unsigned char *color)
	Internal convenience method to convert a value to a color TODO: make this templated and programmable. More...

static void	ColorToValue (unsigned char *color, double min, double scale, double &value)


static vtkInformationIntegerKey *	SCALAR_MODE ()
	Optionally passed down from RenderPass pipeline to controls what data array to draw. More...

static vtkInformationDoubleVectorKey *	SCALAR_RANGE ()
	Optionally passed down from RenderPass pipeline to controls what data array to draw. More...

static vtkInformationIntegerKey *	ARRAY_ID ()
	Optionally passed down from RenderPass pipeline to controls what data array to draw. More...

static vtkInformationStringKey *	ARRAY_NAME ()
	Optionally passed down from RenderPass pipeline to controls what data array to draw. More...

static vtkInformationIntegerKey *	ARRAY_COMPONENT ()
	Optionally passed down from RenderPass pipeline to controls what data array to draw. More...

Static Public Member Functions inherited from vtkStandardPolyDataPainter
static int	IsTypeOf (const char *type)

static vtkStandardPolyDataPainter *	SafeDownCast (vtkObjectBase *o)

static vtkStandardPolyDataPainter *	New ()

Static Public Member Functions inherited from vtkPolyDataPainter
static int	IsTypeOf (const char *type)

static vtkPolyDataPainter *	SafeDownCast (vtkObjectBase *o)

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

static vtkInformationIntegerKey *	DISABLE_SCALAR_COLOR ()
	Key added to disable any scalar coloring for the current pass. More...

static vtkInformationObjectBaseKey *	DATA_ARRAY_TO_VERTEX_ATTRIBUTE ()

static vtkInformationObjectBaseKey *	SHADER_DEVICE_ADAPTOR ()
	Key to store the shader device adaptor. More...

Static Public Member Functions inherited from vtkPainter
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

	vtkValuePainter ()

	~vtkValuePainter ()

virtual void	ProcessInformation (vtkInformation *)
	overridden to look for informationkeys that specify what array to draw More...

virtual void	RenderInternal (vtkRenderer renderer, vtkActor actor, unsigned long typeflags, bool forceCompileOnly)
	overridden to draw the chosen array value directly as color More...

void	DrawCells (int mode, vtkCellArray connectivity, vtkIdType startCellId, vtkRenderer renderer)
	overridden implement drawlines, points, strips More...

Protected Member Functions inherited from vtkStandardPolyDataPainter
	vtkStandardPolyDataPainter ()

	~vtkStandardPolyDataPainter ()

void	DrawCells (int mode, vtkCellArray connectivity, vtkIdType startCellId, vtkShaderDeviceAdapter2 shaderDevice2, vtkRenderer *renderer, int buildnormals, int interpolation)

void	UpdateGenericAttributesCache (vtkShaderDeviceAdapter2 *shaderDevice2)

Protected Member Functions inherited from vtkPolyDataPainter
	vtkPolyDataPainter ()

	~vtkPolyDataPainter ()

virtual void	SetBuildNormals (int)

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

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

Additional Inherited Members
Protected Attributes inherited from vtkStandardPolyDataPainter
vtkIdType	TotalCells

Protected Attributes inherited from vtkPolyDataPainter
int	BuildNormals

Protected Attributes inherited from vtkPainter
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

Detailed Description

painter that renders arrays encoded into pixel colors.

vtkValuePainter renders polygonal geometry where data values are encoded into 24 bit integers and send to the screen. The pixel colors can then be read and converted back into values later.

See also: vtkValuePass, vtkValuePasses

Tests:: vtkValuePainter (Tests)

Definition at line 41 of file vtkValuePainter.h.

Member Typedef Documentation

typedef vtkStandardPolyDataPainter vtkValuePainter::Superclass

Definition at line 46 of file vtkValuePainter.h.

Constructor & Destructor Documentation

vtkValuePainter::vtkValuePainter ( )

protected

vtkValuePainter::~vtkValuePainter ( )

protected

Member Function Documentation

static vtkValuePainter* vtkValuePainter::New ( )

static

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

static

virtual int vtkValuePainter::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 vtkStandardPolyDataPainter.

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

static

virtual vtkObjectBase* vtkValuePainter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkStandardPolyDataPainter.

vtkValuePainter* vtkValuePainter::NewInstance ( ) const

void vtkValuePainter::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 vtkStandardPolyDataPainter.

void vtkValuePainter::SetInputArrayToProcess	(	int	fieldAssociation,
		const char *	name
	)

Set the array to be drawn.

By default point scalars are used. Arguments are same as those passed to vtkAlgorithm::SetInputArrayToProcess except the first 3 arguments i.e. idx, port, connection.

void vtkValuePainter::SetInputArrayToProcess	(	int	fieldAssociation,
		int	fieldAttributeType
	)

Set the array to be drawn.

By default point scalars are used. Arguments are same as those passed to vtkAlgorithm::SetInputArrayToProcess except the first 3 arguments i.e. idx, port, connection.

void vtkValuePainter::SetInputComponentToProcess ( int comp )

Set the component (0..numcomponents-1) of the specified array to be drawn.

If input array is not a multicomponent array or component is otherwise out of range the painter uses the 0'th component instead.

void vtkValuePainter::SetScalarRange	(	double	min,
		double	max
	)

Use the provided scalar range instead of the range of the input data array.

static vtkInformationIntegerKey* vtkValuePainter::SCALAR_MODE ( )

static