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

apply colors to a data set. More...

#include <vtkApplyColors.h>

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

Public Types

typedef vtkPassInputTypeAlgorithm Superclass
 
- Public Types inherited from vtkPassInputTypeAlgorithm
typedef vtkAlgorithm Superclass
 
- Public Types inherited from vtkAlgorithm
enum  DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
 Values used for setting the desired output precision for various algorithms. More...
 
typedef vtkObject Superclass
 

Public Member Functions

virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class. More...
 
vtkApplyColorsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void SetPointLookupTable (vtkScalarsToColors *lut)
 The lookup table to use for point colors. More...
 
virtual vtkScalarsToColorsGetPointLookupTable ()
 
virtual void SetUsePointLookupTable (bool)
 If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data. More...
 
virtual bool GetUsePointLookupTable ()
 
virtual void UsePointLookupTableOn ()
 
virtual void UsePointLookupTableOff ()
 
virtual void SetScalePointLookupTable (bool)
 If on, uses the range of the data to scale the lookup table range. More...
 
virtual bool GetScalePointLookupTable ()
 
virtual void ScalePointLookupTableOn ()
 
virtual void ScalePointLookupTableOff ()
 
virtual void SetDefaultPointColor (double, double, double)
 The default point color for all unannotated, unselected elements of the data. More...
 
virtual void SetDefaultPointColor (double[3])
 
virtual double * GetDefaultPointColor ()
 
virtual void GetDefaultPointColor (double &, double &, double &)
 
virtual void GetDefaultPointColor (double[3])
 
virtual void SetDefaultPointOpacity (double)
 The default point opacity for all unannotated, unselected elements of the data. More...
 
virtual double GetDefaultPointOpacity ()
 
virtual void SetSelectedPointColor (double, double, double)
 The point color for all selected elements of the data. More...
 
virtual void SetSelectedPointColor (double[3])
 
virtual double * GetSelectedPointColor ()
 
virtual void GetSelectedPointColor (double &, double &, double &)
 
virtual void GetSelectedPointColor (double[3])
 
virtual void SetSelectedPointOpacity (double)
 The point opacity for all selected elements of the data. More...
 
virtual double GetSelectedPointOpacity ()
 
virtual void SetPointColorOutputArrayName (const char *)
 The output array name for the point color RGBA array. More...
 
virtual char * GetPointColorOutputArrayName ()
 
virtual void SetCellLookupTable (vtkScalarsToColors *lut)
 The lookup table to use for cell colors. More...
 
virtual vtkScalarsToColorsGetCellLookupTable ()
 
virtual void SetUseCellLookupTable (bool)
 If on, uses the cell lookup table to set the colors of unannotated, unselected elements of the data. More...
 
virtual bool GetUseCellLookupTable ()
 
virtual void UseCellLookupTableOn ()
 
virtual void UseCellLookupTableOff ()
 
virtual void SetScaleCellLookupTable (bool)
 If on, uses the range of the data to scale the lookup table range. More...
 
virtual bool GetScaleCellLookupTable ()
 
virtual void ScaleCellLookupTableOn ()
 
virtual void ScaleCellLookupTableOff ()
 
virtual void SetDefaultCellColor (double, double, double)
 The default cell color for all unannotated, unselected elements of the data. More...
 
virtual void SetDefaultCellColor (double[3])
 
virtual double * GetDefaultCellColor ()
 
virtual void GetDefaultCellColor (double &, double &, double &)
 
virtual void GetDefaultCellColor (double[3])
 
virtual void SetDefaultCellOpacity (double)
 The default cell opacity for all unannotated, unselected elements of the data. More...
 
virtual double GetDefaultCellOpacity ()
 
virtual void SetSelectedCellColor (double, double, double)
 The cell color for all selected elements of the data. More...
 
virtual void SetSelectedCellColor (double[3])
 
virtual double * GetSelectedCellColor ()
 
virtual void GetSelectedCellColor (double &, double &, double &)
 
virtual void GetSelectedCellColor (double[3])
 
virtual void SetSelectedCellOpacity (double)
 The cell opacity for all selected elements of the data. More...
 
virtual double GetSelectedCellOpacity ()
 
virtual void SetCellColorOutputArrayName (const char *)
 The output array name for the cell color RGBA array. More...
 
virtual char * GetCellColorOutputArrayName ()
 
virtual void SetUseCurrentAnnotationColor (bool)
 Use the annotation to color the current annotation (i.e. More...
 
virtual bool GetUseCurrentAnnotationColor ()
 
virtual void UseCurrentAnnotationColorOn ()
 
virtual void UseCurrentAnnotationColorOff ()
 
vtkMTimeType GetMTime () override
 Retrieve the modified time for this filter. More...
 
- Public Member Functions inherited from vtkPassInputTypeAlgorithm
vtkPassInputTypeAlgorithmNewInstance () const
 
vtkDataObjectGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataObjectGetOutput (int)
 
vtkPolyDataGetPolyDataOutput ()
 Get the output as a concrete type. More...
 
vtkStructuredPointsGetStructuredPointsOutput ()
 
vtkImageDataGetImageDataOutput ()
 
vtkStructuredGridGetStructuredGridOutput ()
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 
vtkRectilinearGridGetRectilinearGridOutput ()
 
vtkGraphGetGraphOutput ()
 
vtkMoleculeGetMoleculeOutput ()
 
vtkTableGetTableOutput ()
 
vtkDataObjectGetInput ()
 Get the input data object. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
- Public Member Functions inherited from vtkAlgorithm
vtkAlgorithmNewInstance () const
 
int HasExecutive ()
 Check whether this algorithm has an assigned executive. More...
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive. More...
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive. More...
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped. More...
 
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, vtkMTimeType *mtime)
 A special version of ProcessRequest meant specifically for the pipeline modified time request. More...
 
virtual int ModifyRequest (vtkInformation *request, int when)
 This method gives the algorithm a chance to modify the contents of a request before or after (specified in the when argument) it is forwarded. More...
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port. More...
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm. More...
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Decrease the reference count (release by another object). More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 
virtual void AbortExecuteOn ()
 
virtual void AbortExecuteOff ()
 
virtual double GetProgress ()
 Get the execution progress of a process object. More...
 
void SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressShift ()
 
virtual double GetProgressScale ()
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess(). More...
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm. More...
 
void RemoveAllInputs ()
 Remove all the input data. More...
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port. More...
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index. More...
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx. More...
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections. More...
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index. More...
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port. More...
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm. More...
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port. More...
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm. More...
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair. More...
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0). More...
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection. More...
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0) More...
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection. More...
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0) More...
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 
virtual vtkTypeBool Update (int port, vtkInformationVector *requests)
 This method enables the passing of data requests to the algorithm to be used during execution (in addition to bringing a particular port up-to-date). More...
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdatePiece (int piece, int numPieces, int ghostLevels, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual int UpdateTimeStep (double time, int piece=-1, int numPieces=1, int ghostLevels=0, const int extents[6]=nullptr)
 Convenience method to update an algorithm after passing requests to its first output port. More...
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date. More...
 
virtual void UpdateDataObject ()
 Create output object(s). More...
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream. More...
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date. More...
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
 This detects when the UpdateExtent will generate no data This condition is satisfied when the UpdateExtent has zero volume (0,-1,...) or the UpdateNumberOfPieces is 0. More...
 
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
int * GetUpdateExtent (int port)
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 
void GetUpdateExtent (int extent[6])
 
void GetUpdateExtent (int port, int extent[6])
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 
int GetUpdateNumberOfPieces ()
 
int GetUpdateNumberOfPieces (int port)
 
int GetUpdateGhostLevel ()
 
int GetUpdateGhostLevel (int port)
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 
- 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...
 
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 *)
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool 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)
 
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 vtkApplyColorsNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkApplyColorsSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkPassInputTypeAlgorithm
static vtkPassInputTypeAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkPassInputTypeAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
 Keys used to specify input port requirements. More...
 
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
 
static vtkInformationInformationVectorKeyINPUT_REQUIRED_FIELDS ()
 
static vtkInformationStringVectorKeyINPUT_REQUIRED_DATA_TYPE ()
 
static vtkInformationInformationVectorKeyINPUT_ARRAYS_TO_PROCESS ()
 
static vtkInformationIntegerKeyINPUT_PORT ()
 
static vtkInformationIntegerKeyINPUT_CONNECTION ()
 
static vtkInformationIntegerKeyCAN_PRODUCE_SUB_EXTENT ()
 This key tells the executive that a particular output port is capable of producing an arbitrary subextent of the whole extent. More...
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request. More...
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance(). 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
 
 vtkApplyColors ()
 
 ~vtkApplyColors () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Convert the vtkGraph into vtkPolyData. More...
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Set the input type of the algorithm to vtkGraph. More...
 
void ProcessColorArray (vtkUnsignedCharArray *colorArr, vtkScalarsToColors *lut, vtkAbstractArray *arr, unsigned char color[4], bool scale)
 
- Protected Member Functions inherited from vtkPassInputTypeAlgorithm
 vtkPassInputTypeAlgorithm ()
 
 ~vtkPassInputTypeAlgorithm () override
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request asks for Information. More...
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateTimeDependentInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when each filter in the pipeline decides what portion of its input is needed to create the portion of its output that the downstream filter asks for. More...
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called within ProcessRequest to when a request asks the algorithm to create empty output data objects. More...
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm. More...
 
vtkDataObjectGetInput (int port)
 
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm. More...
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm. More...
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the assocition of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
 Get the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector. More...
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. More...
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port. More...
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port. More...
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input. More...
 
void AddInputDataInternal (int port, vtkDataObject *input)
 
- 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=nullptr)
 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 &)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkScalarsToColorsPointLookupTable
 
vtkScalarsToColorsCellLookupTable
 
double DefaultPointColor [3]
 
double DefaultPointOpacity
 
double DefaultCellColor [3]
 
double DefaultCellOpacity
 
double SelectedPointColor [3]
 
double SelectedPointOpacity
 
double SelectedCellColor [3]
 
double SelectedCellOpacity
 
bool ScalePointLookupTable
 
bool ScaleCellLookupTable
 
bool UsePointLookupTable
 
bool UseCellLookupTable
 
char * PointColorOutputArrayName
 
char * CellColorOutputArrayName
 
bool UseCurrentAnnotationColor
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
unsigned long ErrorCode
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
vtkTypeBool AbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

apply colors to a data set.

vtkApplyColors performs a coloring of the dataset using default colors, lookup tables, annotations, and/or a selection. The output is a four-component vtkUnsignedCharArray containing RGBA tuples for each element in the dataset. The first input is the dataset to be colored, which may be a vtkTable, vtkGraph subclass, or vtkDataSet subclass. The API of this algorithm refers to "points" and "cells". For vtkGraph, the "points" refer to the graph vertices and "cells" refer to graph edges. For vtkTable, "points" refer to table rows. For vtkDataSet subclasses, the meaning is obvious.

The second (optional) input is a vtkAnnotationLayers object, which stores a list of annotation layers, with each layer holding a list of vtkAnnotation objects. The annotation specifies a subset of data along with other properties, including color. For annotations with color properties, this algorithm will use the color to color elements, using a "top one wins" strategy.

The third (optional) input is a vtkSelection object, meant for specifying the current selection. You can control the color of the selection.

The algorithm takes two input arrays, specified with SetInputArrayToProcess(0, 0, 0, vtkDataObject::FIELD_ASSOCIATION_POINTS, name) and SetInputArrayToProcess(1, 0, 0, vtkDataObject::FIELD_ASSOCIATION_CELLS, name). These set the point and cell data arrays to use to color the data with the associated lookup table. For vtkGraph, vtkTable inputs, you would use FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, or FIELD_ASSOCIATION_ROWS as appropriate.

To use the color array generated here, you should do the following:

mapper->SetScalarModeToUseCellFieldData(); mapper->SelectColorArray("vtkApplyColors color"); mapper->SetScalarVisibility(true);

Colors are assigned with the following priorities:

  1. If an item is part of the selection, it is colored with that color.
  2. Otherwise, if the item is part of an annotation, it is colored with the color of the final (top) annotation in the set of layers.
  3. Otherwise, if the lookup table is used, it is colored using the lookup table color for the data value of the element.
  4. Otherwise it will be colored with the default color.

Note: The opacity of an unselected item is defined by the multiplication of default opacity, lookup table opacity, and annotation opacity, where opacity is taken as a number from 0 to 1. So items will never be more opaque than any of these three opacities. Selected items are always given the selection opacity directly.

Definition at line 86 of file vtkApplyColors.h.

Member Typedef Documentation

◆ Superclass

Definition at line 90 of file vtkApplyColors.h.

Constructor & Destructor Documentation

◆ vtkApplyColors()

vtkApplyColors::vtkApplyColors ( )
protected

◆ ~vtkApplyColors()

vtkApplyColors::~vtkApplyColors ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkApplyColors* vtkApplyColors::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkApplyColors::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkApplyColors::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 vtkPassInputTypeAlgorithm.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkApplyColors::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPassInputTypeAlgorithm.

◆ NewInstance()

vtkApplyColors* vtkApplyColors::NewInstance ( ) const

◆ PrintSelf()

void vtkApplyColors::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
overridevirtual

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

◆ SetPointLookupTable()

virtual void vtkApplyColors::SetPointLookupTable ( vtkScalarsToColors lut)
virtual

The lookup table to use for point colors.

This is only used if input array 0 is set and UsePointLookupTable is on.

◆ GetPointLookupTable()

virtual vtkScalarsToColors* vtkApplyColors::GetPointLookupTable ( )
virtual

◆ SetUsePointLookupTable()

virtual void vtkApplyColors::SetUsePointLookupTable ( bool  )
virtual

If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data.

◆ GetUsePointLookupTable()

virtual bool vtkApplyColors::GetUsePointLookupTable ( )
virtual

◆ UsePointLookupTableOn()

virtual void vtkApplyColors::UsePointLookupTableOn ( )
virtual

◆ UsePointLookupTableOff()

virtual void vtkApplyColors::UsePointLookupTableOff ( )
virtual

◆ SetScalePointLookupTable()

virtual void vtkApplyColors::SetScalePointLookupTable ( bool  )
virtual

If on, uses the range of the data to scale the lookup table range.

Otherwise, uses the range defined in the lookup table.

◆ GetScalePointLookupTable()

virtual bool vtkApplyColors::GetScalePointLookupTable ( )
virtual

◆ ScalePointLookupTableOn()

virtual void vtkApplyColors::ScalePointLookupTableOn ( )
virtual

◆ ScalePointLookupTableOff()

virtual void vtkApplyColors::ScalePointLookupTableOff ( )
virtual

◆ SetDefaultPointColor() [1/2]

virtual void vtkApplyColors::SetDefaultPointColor ( double  ,
double  ,
double   
)
virtual

The default point color for all unannotated, unselected elements of the data.

This is used if UsePointLookupTable is off.

◆ SetDefaultPointColor() [2/2]

virtual void vtkApplyColors::SetDefaultPointColor ( double  [3])
virtual

◆ GetDefaultPointColor() [1/3]

virtual double* vtkApplyColors::GetDefaultPointColor ( )
virtual

◆ GetDefaultPointColor() [2/3]

virtual void vtkApplyColors::GetDefaultPointColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetDefaultPointColor() [3/3]

virtual void vtkApplyColors::GetDefaultPointColor ( double  [3])
virtual

◆ SetDefaultPointOpacity()

virtual void vtkApplyColors::SetDefaultPointOpacity ( double  )
virtual

The default point opacity for all unannotated, unselected elements of the data.

This is used if UsePointLookupTable is off.

◆ GetDefaultPointOpacity()

virtual double vtkApplyColors::GetDefaultPointOpacity ( )
virtual

◆ SetSelectedPointColor() [1/2]

virtual void vtkApplyColors::SetSelectedPointColor ( double  ,
double  ,
double   
)
virtual

The point color for all selected elements of the data.

This is used if the selection input is available.

◆ SetSelectedPointColor() [2/2]

virtual void vtkApplyColors::SetSelectedPointColor ( double  [3])
virtual

◆ GetSelectedPointColor() [1/3]

virtual double* vtkApplyColors::GetSelectedPointColor ( )
virtual

◆ GetSelectedPointColor() [2/3]

virtual void vtkApplyColors::GetSelectedPointColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetSelectedPointColor() [3/3]

virtual void vtkApplyColors::GetSelectedPointColor ( double  [3])
virtual

◆ SetSelectedPointOpacity()

virtual void vtkApplyColors::SetSelectedPointOpacity ( double  )
virtual

The point opacity for all selected elements of the data.

This is used if the selection input is available.

◆ GetSelectedPointOpacity()

virtual double vtkApplyColors::GetSelectedPointOpacity ( )
virtual

◆ SetPointColorOutputArrayName()

virtual void vtkApplyColors::SetPointColorOutputArrayName ( const char *  )
virtual

The output array name for the point color RGBA array.

Default is "vtkApplyColors color".

◆ GetPointColorOutputArrayName()

virtual char* vtkApplyColors::GetPointColorOutputArrayName ( )
virtual

◆ SetCellLookupTable()

virtual void vtkApplyColors::SetCellLookupTable ( vtkScalarsToColors lut)
virtual

The lookup table to use for cell colors.

This is only used if input array 1 is set and UseCellLookupTable is on.

◆ GetCellLookupTable()

virtual vtkScalarsToColors* vtkApplyColors::GetCellLookupTable ( )
virtual

◆ SetUseCellLookupTable()

virtual void vtkApplyColors::SetUseCellLookupTable ( bool  )
virtual

If on, uses the cell lookup table to set the colors of unannotated, unselected elements of the data.

◆ GetUseCellLookupTable()

virtual bool vtkApplyColors::GetUseCellLookupTable ( )
virtual

◆ UseCellLookupTableOn()

virtual void vtkApplyColors::UseCellLookupTableOn ( )
virtual

◆ UseCellLookupTableOff()

virtual void vtkApplyColors::UseCellLookupTableOff ( )
virtual

◆ SetScaleCellLookupTable()

virtual void vtkApplyColors::SetScaleCellLookupTable ( bool  )
virtual

If on, uses the range of the data to scale the lookup table range.

Otherwise, uses the range defined in the lookup table.

◆ GetScaleCellLookupTable()

virtual bool vtkApplyColors::GetScaleCellLookupTable ( )
virtual

◆ ScaleCellLookupTableOn()

virtual void vtkApplyColors::ScaleCellLookupTableOn ( )
virtual

◆ ScaleCellLookupTableOff()

virtual void vtkApplyColors::ScaleCellLookupTableOff ( )
virtual

◆ SetDefaultCellColor() [1/2]

virtual void vtkApplyColors::SetDefaultCellColor ( double  ,
double  ,
double   
)
virtual

The default cell color for all unannotated, unselected elements of the data.

This is used if UseCellLookupTable is off.

◆ SetDefaultCellColor() [2/2]

virtual void vtkApplyColors::SetDefaultCellColor ( double  [3])
virtual

◆ GetDefaultCellColor() [1/3]

virtual double* vtkApplyColors::GetDefaultCellColor ( )
virtual

◆ GetDefaultCellColor() [2/3]

virtual void vtkApplyColors::GetDefaultCellColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetDefaultCellColor() [3/3]

virtual void vtkApplyColors::GetDefaultCellColor ( double  [3])
virtual

◆ SetDefaultCellOpacity()

virtual void vtkApplyColors::SetDefaultCellOpacity ( double  )
virtual

The default cell opacity for all unannotated, unselected elements of the data.

This is used if UseCellLookupTable is off.

◆ GetDefaultCellOpacity()

virtual double vtkApplyColors::GetDefaultCellOpacity ( )
virtual

◆ SetSelectedCellColor() [1/2]

virtual void vtkApplyColors::SetSelectedCellColor ( double  ,
double  ,
double   
)
virtual

The cell color for all selected elements of the data.

This is used if the selection input is available.

◆ SetSelectedCellColor() [2/2]

virtual void vtkApplyColors::SetSelectedCellColor ( double  [3])
virtual

◆ GetSelectedCellColor() [1/3]

virtual double* vtkApplyColors::GetSelectedCellColor ( )
virtual

◆ GetSelectedCellColor() [2/3]

virtual void vtkApplyColors::GetSelectedCellColor ( double &  ,
double &  ,
double &   
)
virtual

◆ GetSelectedCellColor() [3/3]

virtual void vtkApplyColors::GetSelectedCellColor ( double  [3])
virtual

◆ SetSelectedCellOpacity()

virtual void vtkApplyColors::SetSelectedCellOpacity ( double  )
virtual

The cell opacity for all selected elements of the data.

This is used if the selection input is available.

◆ GetSelectedCellOpacity()

virtual double vtkApplyColors::GetSelectedCellOpacity ( )
virtual

◆ SetCellColorOutputArrayName()

virtual void vtkApplyColors::SetCellColorOutputArrayName ( const char *  )
virtual

The output array name for the cell color RGBA array.

Default is "vtkApplyColors color".

◆ GetCellColorOutputArrayName()

virtual char* vtkApplyColors::GetCellColorOutputArrayName ( )
virtual

◆ SetUseCurrentAnnotationColor()

virtual void vtkApplyColors::SetUseCurrentAnnotationColor ( bool  )
virtual

Use the annotation to color the current annotation (i.e.

the current selection). Otherwise use the selection color attributes of this filter.

◆ GetUseCurrentAnnotationColor()

virtual bool vtkApplyColors::GetUseCurrentAnnotationColor ( )
virtual

◆ UseCurrentAnnotationColorOn()

virtual void vtkApplyColors::UseCurrentAnnotationColorOn ( )
virtual

◆ UseCurrentAnnotationColorOff()

virtual void vtkApplyColors::UseCurrentAnnotationColorOff ( )
virtual

◆ GetMTime()

vtkMTimeType vtkApplyColors::GetMTime ( )
overridevirtual

Retrieve the modified time for this filter.

Reimplemented from vtkObject.

◆ RequestData()

int vtkApplyColors::RequestData ( vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector  
)
overrideprotectedvirtual

Convert the vtkGraph into vtkPolyData.

Reimplemented from vtkPassInputTypeAlgorithm.

◆ FillInputPortInformation()

int vtkApplyColors::FillInputPortInformation ( int  port,
vtkInformation info 
)
overrideprotectedvirtual

Set the input type of the algorithm to vtkGraph.

Reimplemented from vtkPassInputTypeAlgorithm.

◆ ProcessColorArray()

void vtkApplyColors::ProcessColorArray ( vtkUnsignedCharArray colorArr,
vtkScalarsToColors lut,
vtkAbstractArray arr,
unsigned char  color[4],
bool  scale 
)
protected

Member Data Documentation

◆ PointLookupTable

vtkScalarsToColors* vtkApplyColors::PointLookupTable
protected

Definition at line 274 of file vtkApplyColors.h.

◆ CellLookupTable

vtkScalarsToColors* vtkApplyColors::CellLookupTable
protected

Definition at line 275 of file vtkApplyColors.h.

◆ DefaultPointColor

double vtkApplyColors::DefaultPointColor[3]
protected

Definition at line 276 of file vtkApplyColors.h.

◆ DefaultPointOpacity

double vtkApplyColors::DefaultPointOpacity
protected

Definition at line 277 of file vtkApplyColors.h.

◆ DefaultCellColor

double vtkApplyColors::DefaultCellColor[3]
protected

Definition at line 278 of file vtkApplyColors.h.

◆ DefaultCellOpacity

double vtkApplyColors::DefaultCellOpacity
protected

Definition at line 279 of file vtkApplyColors.h.

◆ SelectedPointColor

double vtkApplyColors::SelectedPointColor[3]
protected

Definition at line 280 of file vtkApplyColors.h.

◆ SelectedPointOpacity

double vtkApplyColors::SelectedPointOpacity
protected

Definition at line 281 of file vtkApplyColors.h.

◆ SelectedCellColor

double vtkApplyColors::SelectedCellColor[3]
protected

Definition at line 282 of file vtkApplyColors.h.

◆ SelectedCellOpacity

double vtkApplyColors::SelectedCellOpacity
protected

Definition at line 283 of file vtkApplyColors.h.

◆ ScalePointLookupTable

bool vtkApplyColors::ScalePointLookupTable
protected

Definition at line 284 of file vtkApplyColors.h.

◆ ScaleCellLookupTable

bool vtkApplyColors::ScaleCellLookupTable
protected

Definition at line 285 of file vtkApplyColors.h.

◆ UsePointLookupTable

bool vtkApplyColors::UsePointLookupTable
protected

Definition at line 286 of file vtkApplyColors.h.

◆ UseCellLookupTable

bool vtkApplyColors::UseCellLookupTable
protected

Definition at line 287 of file vtkApplyColors.h.

◆ PointColorOutputArrayName

char* vtkApplyColors::PointColorOutputArrayName
protected

Definition at line 288 of file vtkApplyColors.h.

◆ CellColorOutputArrayName

char* vtkApplyColors::CellColorOutputArrayName
protected

Definition at line 289 of file vtkApplyColors.h.

◆ UseCurrentAnnotationColor

bool vtkApplyColors::UseCurrentAnnotationColor
protected

Definition at line 290 of file vtkApplyColors.h.


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