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

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

#include <vtkValuePainter.h>

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

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 Types inherited from vtkObject
typedef vtkObjectBase Superclass
 

Public Member Functions

virtual int IsA (const char *type)
 
vtkValuePainterNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
void SetInputComponentToProcess (int comp)
 
void SetScalarRange (double min, double max)
 
void SetInputArrayToProcess (int fieldAssociation, const char *name)
 
void SetInputArrayToProcess (int fieldAssociation, int fieldAttributeType)
 
- Public Member Functions inherited from vtkStandardPolyDataPainter
vtkStandardPolyDataPainterNewInstance () const
 
void AddMultiTextureCoordsArray (vtkDataArray *array)
 
- Public Member Functions inherited from vtkPolyDataPainter
vtkPolyDataPainterNewInstance () const
 
vtkPolyDataGetInputAsPolyData ()
 
vtkPolyDataGetOutputAsPolyData ()
 
virtual void Render (vtkRenderer *renderer, vtkActor *actor, unsigned long typeflags, bool forceCompileOnly)
 
- Public Member Functions inherited from vtkPainter
vtkPainterNewInstance () const
 
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 SetProgress (double)
 
virtual double GetProgress ()
 
void SetInput (vtkDataObject *)
 
virtual vtkDataObjectGetInput ()
 
virtual vtkDataObjectGetOutput ()
 
- Public Member Functions inherited from vtkObject
vtkObjectNewInstance () const
 
virtual void DebugOn ()
 
virtual void DebugOff ()
 
bool GetDebug ()
 
void SetDebug (bool debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
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)
 
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)
 
int InvokeEvent (unsigned long event, void *callData)
 
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
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static vtkValuePainterNew ()
 
static int IsTypeOf (const char *type)
 
static vtkValuePainterSafeDownCast (vtkObjectBase *o)
 
static void ColorToValue (unsigned char *color, double min, double scale, double &value)
 
static vtkInformationIntegerKeySCALAR_MODE ()
 
static vtkInformationDoubleVectorKeySCALAR_RANGE ()
 
static vtkInformationIntegerKeyARRAY_ID ()
 
static vtkInformationStringKeyARRAY_NAME ()
 
static vtkInformationIntegerKeyARRAY_COMPONENT ()
 
static void ValueToColor (double value, double min, double scale, unsigned char *color)
 
- Static Public Member Functions inherited from vtkStandardPolyDataPainter
static int IsTypeOf (const char *type)
 
static vtkStandardPolyDataPainterSafeDownCast (vtkObjectBase *o)
 
static vtkStandardPolyDataPainterNew ()
 
- Static Public Member Functions inherited from vtkPolyDataPainter
static int IsTypeOf (const char *type)
 
static vtkPolyDataPainterSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyBUILD_NORMALS ()
 
static vtkInformationIntegerKeyDISABLE_SCALAR_COLOR ()
 
static vtkInformationObjectBaseKeyDATA_ARRAY_TO_VERTEX_ATTRIBUTE ()
 
static vtkInformationObjectBaseKeySHADER_DEVICE_ADAPTOR ()
 
- Static Public Member Functions inherited from vtkPainter
static int IsTypeOf (const char *type)
 
static vtkPainterSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeySTATIC_DATA ()
 
static vtkInformationIntegerKeyCONSERVE_MEMORY ()
 
static vtkInformationIntegerKeyHIGH_QUALITY ()
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObjectBase *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkValuePainter ()
 
 ~vtkValuePainter ()
 
virtual void ProcessInformation (vtkInformation *)
 
virtual void RenderInternal (vtkRenderer *renderer, vtkActor *actor, unsigned long typeflags, bool forceCompileOnly)
 
void DrawCells (int mode, vtkCellArray *connectivity, vtkIdType startCellId, vtkRenderer *renderer)
 
- 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 ()
 
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 ObserverPainterProgress (vtkPainter *toObserve)
 
void UpdateProgress (double amount)
 
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 Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- 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
 
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

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 40 of file vtkValuePainter.h.

Member Typedef Documentation

Definition at line 45 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

Optionally passed down from RenderPass pipeline to controls what data array to draw.

static vtkInformationDoubleVectorKey* vtkValuePainter::SCALAR_RANGE ( )
static

Optionally passed down from RenderPass pipeline to controls what data array to draw.

static vtkInformationIntegerKey* vtkValuePainter::ARRAY_ID ( )
static

Optionally passed down from RenderPass pipeline to controls what data array to draw.

static vtkInformationStringKey* vtkValuePainter::ARRAY_NAME ( )
static

Optionally passed down from RenderPass pipeline to controls what data array to draw.

static vtkInformationIntegerKey* vtkValuePainter::ARRAY_COMPONENT ( )
static

Optionally passed down from RenderPass pipeline to controls what data array to draw.

static void vtkValuePainter::ValueToColor ( double  value,
double  min,
double  scale,
unsigned char *  color 
)
static

Internal convenience method to convert a value to a color TODO: make this templated and programmable

static void vtkValuePainter::ColorToValue ( unsigned char *  color,
double  min,
double  scale,
double value 
)
static
virtual void vtkValuePainter::ProcessInformation ( vtkInformation )
protectedvirtual

overridden to look for informationkeys that specify what array to draw

Reimplemented from vtkStandardPolyDataPainter.

virtual void vtkValuePainter::RenderInternal ( vtkRenderer renderer,
vtkActor actor,
unsigned long  typeflags,
bool  forceCompileOnly 
)
protectedvirtual

overridden to draw the chosen array value directly as color

Reimplemented from vtkStandardPolyDataPainter.

void vtkValuePainter::DrawCells ( int  mode,
vtkCellArray connectivity,
vtkIdType  startCellId,
vtkRenderer renderer 
)
protected

overridden implement drawlines, points, strips


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