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

Color Mapping for piston results. More...

#include <vtkPistonScalarsColors.h>

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

Public Types

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...
 
vtkPistonScalarsColorsNewInstance () const
 
virtual void PrintSelf (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetNumberOfValues (int)
 Set number of distinct color values. More...
 
virtual int GetNumberOfValues ()
 
void SetTableRange (double range[2])
 Set/Get the minimum/maximum scalar values for scalar mapping. More...
 
virtual void SetTableRange (double rmin, double rmax)
 
virtual doubleGetTableRange ()
 
virtual void GetTableRange (double data[2])
 
virtual void SetLookupTable (vtkScalarsToColors *)
 Set lookup table to be used to map scalars to colors. More...
 
virtual vtkScalarsToColorsGetLookupTable ()
 
virtual std::vector< unsigned char > * ComputeScalarsColors (int numberOfChanels)
 Compute scalars to colors as unsigned char. More...
 
virtual std::vector< float > * ComputeScalarsColorsf (int numberOfChanels)
 Compute scalars to colors as floats. 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 PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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)
 
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)
 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)
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- 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...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
virtual void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object). More...
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object). 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...
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkPistonScalarsColorsSafeDownCast (vtkObjectBase *o)
 
static vtkPistonScalarsColorsNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPistonScalarsColors ()
 
 ~vtkPistonScalarsColors ()
 
void ComputeValues (float *values)
 Internal helper method. 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 ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double TableRange [2]
 
int NumberOfValues
 
vtkTimeStamp ComputeColorsTime
 
std::vector< unsigned char > ScalarsColors
 
vtkTimeStamp ComputeColorsfTime
 
std::vector< floatScalarsColorsf
 
vtkScalarsToColorsLookupTable
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Detailed Description

Color Mapping for piston results.

vtkPistonMapper uses this class to interface vtkScalarsToColors to GPU side code that implements color mapping.

Definition at line 34 of file vtkPistonScalarsColors.h.

Member Typedef Documentation

◆ Superclass

Definition at line 37 of file vtkPistonScalarsColors.h.

Constructor & Destructor Documentation

◆ vtkPistonScalarsColors()

vtkPistonScalarsColors::vtkPistonScalarsColors ( )
protected

◆ ~vtkPistonScalarsColors()

vtkPistonScalarsColors::~vtkPistonScalarsColors ( )
protected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

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

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkPistonScalarsColors::NewInstanceInternal ( ) const
protectedvirtual

◆ NewInstance()

vtkPistonScalarsColors* vtkPistonScalarsColors::NewInstance ( ) const

◆ New()

static vtkPistonScalarsColors* vtkPistonScalarsColors::New ( )
static

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

◆ PrintSelf()

virtual void vtkPistonScalarsColors::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 vtkObjectBase.

◆ SetNumberOfValues()

virtual void vtkPistonScalarsColors::SetNumberOfValues ( int  )
virtual

Set number of distinct color values.

◆ GetNumberOfValues()

virtual int vtkPistonScalarsColors::GetNumberOfValues ( )
virtual

◆ SetTableRange() [1/2]

void vtkPistonScalarsColors::SetTableRange ( double  range[2])

Set/Get the minimum/maximum scalar values for scalar mapping.

Scalar values less than minimum range value are clamped to minimum range value. Scalar values greater than maximum range value are clamped to maximum range value.

◆ SetTableRange() [2/2]

virtual void vtkPistonScalarsColors::SetTableRange ( double  rmin,
double  rmax 
)
virtual

◆ GetTableRange() [1/2]

virtual double* vtkPistonScalarsColors::GetTableRange ( )
virtual

◆ GetTableRange() [2/2]

virtual void vtkPistonScalarsColors::GetTableRange ( double  data[2])
virtual

◆ SetLookupTable()

virtual void vtkPistonScalarsColors::SetLookupTable ( vtkScalarsToColors )
virtual

Set lookup table to be used to map scalars to colors.

◆ GetLookupTable()

virtual vtkScalarsToColors* vtkPistonScalarsColors::GetLookupTable ( )
virtual

◆ ComputeScalarsColors()

virtual std::vector<unsigned char>* vtkPistonScalarsColors::ComputeScalarsColors ( int  numberOfChanels)
virtual

Compute scalars to colors as unsigned char.

Size of the vector returned will be NumberOfValues * numberOfChanels

◆ ComputeScalarsColorsf()

virtual std::vector<float>* vtkPistonScalarsColors::ComputeScalarsColorsf ( int  numberOfChanels)
virtual

Compute scalars to colors as floats.

Size of the vector returned will be NumberOfValues * numberOfChanels

◆ ComputeValues()

void vtkPistonScalarsColors::ComputeValues ( float values)
protected

Internal helper method.

Member Data Documentation

◆ TableRange

double vtkPistonScalarsColors::TableRange[2]
protected

Definition at line 105 of file vtkPistonScalarsColors.h.

◆ NumberOfValues

int vtkPistonScalarsColors::NumberOfValues
protected

Definition at line 106 of file vtkPistonScalarsColors.h.

◆ ComputeColorsTime

vtkTimeStamp vtkPistonScalarsColors::ComputeColorsTime
protected

Definition at line 108 of file vtkPistonScalarsColors.h.

◆ ScalarsColors

std::vector<unsigned char> vtkPistonScalarsColors::ScalarsColors
protected

Definition at line 109 of file vtkPistonScalarsColors.h.

◆ ComputeColorsfTime

vtkTimeStamp vtkPistonScalarsColors::ComputeColorsfTime
protected

Definition at line 111 of file vtkPistonScalarsColors.h.

◆ ScalarsColorsf

std::vector<float> vtkPistonScalarsColors::ScalarsColorsf
protected

Definition at line 112 of file vtkPistonScalarsColors.h.

◆ LookupTable

vtkScalarsToColors* vtkPistonScalarsColors::LookupTable
protected

Definition at line 114 of file vtkPistonScalarsColors.h.


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