painter that converts scalars to colors. More...

#include <vtkScalarsToColorsPainter.h>

Inheritance diagram for vtkScalarsToColorsPainter:

Collaboration diagram for vtkScalarsToColorsPainter:

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

vtkScalarsToColorsPainter *	NewInstance () const

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

virtual void	CreateDefaultLookupTable ()
	Create default lookup table. More...

virtual int	GetPremultiplyColorsWithAlpha (vtkActor *actor)
	For alpha blending, we sometime premultiply the colors with alpha and change the alpha blending function. More...

virtual vtkDataObject *	GetOutput ()
	Subclasses need to override this to return the output of the pipeline. More...

virtual vtkIdType	GetTextureSizeLimit ()
	Return the texture size limit. More...

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

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

static int	IsTypeOf (const char *type)

static vtkScalarsToColorsPainter *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	USE_LOOKUP_TABLE_SCALAR_RANGE ()
	Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting. More...

static vtkInformationDoubleVectorKey *	SCALAR_RANGE ()
	Specify range in terms of scalar minimum and maximum (smin,smax). More...

static vtkInformationIntegerKey *	SCALAR_MODE ()
	Control how the painter works with scalar point data and cell attribute data. More...

static vtkInformationIntegerKey *	COLOR_MODE ()
	Control how the scalar data is mapped to colors. More...

static vtkInformationIntegerKey *	INTERPOLATE_SCALARS_BEFORE_MAPPING ()
	By default, vertex color is used to map colors to a surface. More...

static vtkInformationIntegerKey *	SCALAR_VISIBILITY ()
	Turn on/off flag to control whether scalar data is used to color objects. More...

static vtkInformationIntegerKey *	SCALAR_MATERIAL_MODE ()
	Set the light-model color mode. More...


static vtkInformationIntegerKey *	ARRAY_ACCESS_MODE ()
	Controls what data array is used to generate colors. More...

static vtkInformationIntegerKey *	ARRAY_ID ()
	Controls what data array is used to generate colors. More...

static vtkInformationStringKey *	ARRAY_NAME ()
	Controls what data array is used to generate colors. More...

static vtkInformationIntegerKey *	ARRAY_COMPONENT ()
	Controls what data array is used to generate colors. More...

static vtkInformationIntegerKey *	FIELD_DATA_TUPLE_ID ()
	Controls what data array is used to generate colors. 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

	vtkScalarsToColorsPainter ()

virtual	~vtkScalarsToColorsPainter ()

virtual vtkDataObject *	NewClone (vtkDataObject *data)
	Create a new shallow-copied clone for data with no scalars. More...

void	MapScalarsToTexture (vtkDataSet output, vtkDataArray scalars, vtkDataSet *input)
	Create texture coordinates for the output assuming a texture for the lookuptable has already been created correctly. More...

virtual void	PrepareForRendering (vtkRenderer renderer, vtkActor actor)
	Called just before RenderInternal(). More...

virtual void	MapScalars (vtkDataSet output, double alpha, int multiply_with_alpha, vtkDataSet input)
	Generates the colors, if needed. More...

virtual void	ProcessInformation (vtkInformation *)
	Called before RenderInternal() if the Information has been changed since the last time this method was called. More...

void	ReportReferences (vtkGarbageCollector *collector) override
	Take part in garbage collection. More...

int	CanUseTextureMapForColoring (vtkDataObject *input)
	Returns if we can use texture maps for scalar coloring. More...

void	UpdateColorTextureMap (double alpha, int multiply_with_alpha)
	Should not be called if CanUseTextureMapForColoring() returns 0. More...

virtual void	SetUseLookupTableScalarRange (int)

virtual void	SetScalarRange (double, double)

void	SetScalarRange (double[2])

virtual void	SetScalarMode (int)

virtual void	SetColorMode (int)

virtual void	SetInterpolateScalarsBeforeMapping (int)

virtual void	SetScalarVisibility (int)

virtual void	SetScalarMaterialMode (int)

virtual void	SetArrayAccessMode (int)

virtual void	SetArrayComponent (int)

virtual void	SetArrayId (int)

virtual void	SetArrayName (const char *)

virtual void	SetFieldDataTupleId (vtkIdType)

Protected Member Functions inherited from vtkPainter
	vtkPainter ()

	~vtkPainter ()

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	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	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
vtkDataObject *	OutputData

int	ArrayAccessMode

int	ArrayComponent

int	ArrayId

char *	ArrayName

vtkIdType	FieldDataTupleId

vtkScalarsToColors *	LookupTable

vtkSmartPointer< vtkScalarsToColors >	ScalarsLookupTable

vtkSmartPointer< vtkImageData >	ColorTextureMap

int	ColorMode

int	InterpolateScalarsBeforeMapping

int	ScalarMode

int	ScalarMaterialMode

double	LastUsedAlpha

int	LastUsedMultiplyWithAlpha

double	ScalarRange [2]

int	ScalarVisibility

int	UseLookupTableScalarRange

vtkTimeStamp	OutputUpdateTime

int	UsingScalarColoring

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

static vtkInformationObjectBaseKey *	LOOKUP_TABLE ()
	Specify a lookup table for the mapper to use. More...

void	SetLookupTable (vtkScalarsToColors *lut)
	Specify a lookup table for the mapper to use. More...

vtkScalarsToColors *	GetLookupTable ()
	Specify a lookup table for the mapper to use. More...

Detailed Description

painter that converts scalars to colors.

It enable/disables coloring state depending on the ScalarMode.

This is a painter that converts scalars to colors. It enable/disables coloring state depending on the ScalarMode. This painter is composite dataset enabled.

Tests:: vtkScalarsToColorsPainter (Tests)

Definition at line 43 of file vtkScalarsToColorsPainter.h.

Member Typedef Documentation

typedef vtkPainter vtkScalarsToColorsPainter::Superclass

Definition at line 47 of file vtkScalarsToColorsPainter.h.

Constructor & Destructor Documentation

vtkScalarsToColorsPainter::vtkScalarsToColorsPainter ( )

protected

virtual vtkScalarsToColorsPainter::~vtkScalarsToColorsPainter ( )

protectedvirtual

Member Function Documentation

static vtkScalarsToColorsPainter* vtkScalarsToColorsPainter::New ( )

static

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

static

virtual int vtkScalarsToColorsPainter::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 vtkOpenGLScalarsToColorsPainter.

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

static

virtual vtkObjectBase* vtkScalarsToColorsPainter::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkPainter.

Reimplemented in vtkOpenGLScalarsToColorsPainter.

vtkScalarsToColorsPainter* vtkScalarsToColorsPainter::NewInstance ( ) const

void vtkScalarsToColorsPainter::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.

static vtkInformationIntegerKey* vtkScalarsToColorsPainter::USE_LOOKUP_TABLE_SCALAR_RANGE ( )

static

Control whether the mapper sets the lookuptable range based on its own ScalarRange, or whether it will use the LookupTable ScalarRange regardless of it's own setting.

By default the Mapper is allowed to set the LookupTable range, but users who are sharing LookupTables between mappers/actors will probably wish to force the mapper to use the LookupTable unchanged.

static vtkInformationDoubleVectorKey* vtkScalarsToColorsPainter::SCALAR_RANGE ( )

static

Specify range in terms of scalar minimum and maximum (smin,smax).

These values are used to map scalars into lookup table. Has no effect when UseLookupTableScalarRange is true.

static vtkInformationIntegerKey* vtkScalarsToColorsPainter::SCALAR_MODE ( )

static

Control how the painter works with scalar point data and cell attribute data.

See vtkMapper::ScalarMode for more details.

static vtkInformationIntegerKey* vtkScalarsToColorsPainter::COLOR_MODE ( )

static

Control how the scalar data is mapped to colors.

By default (ColorModeToDefault), unsigned char scalars are treated as colors, and NOT mapped through the lookup table, while everything else is. Setting ColorModeToMapScalars means that all scalar data will be mapped through the lookup table.

static vtkInformationIntegerKey* vtkScalarsToColorsPainter::INTERPOLATE_SCALARS_BEFORE_MAPPING ( )

static

By default, vertex color is used to map colors to a surface.

Colors are interpolated after being mapped. This option avoids color interpolation by using a one dimensional texture map for the colors.

static vtkInformationObjectBaseKey* vtkScalarsToColorsPainter::LOOKUP_TABLE ( )

static

Specify a lookup table for the mapper to use.

void vtkScalarsToColorsPainter::SetLookupTable ( vtkScalarsToColors * lut )

Specify a lookup table for the mapper to use.

vtkScalarsToColors* vtkScalarsToColorsPainter::GetLookupTable ( )

Specify a lookup table for the mapper to use.

virtual void vtkScalarsToColorsPainter::CreateDefaultLookupTable ( )

virtual

Create default lookup table.

Generally used to create one when none is available with the scalar data.

static vtkInformationIntegerKey* vtkScalarsToColorsPainter::SCALAR_VISIBILITY ( )

static

Turn on/off flag to control whether scalar data is used to color objects.

static vtkInformationIntegerKey* vtkScalarsToColorsPainter::ARRAY_ACCESS_MODE ( )

static