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

apply icons to a data set. More...

#include <vtkApplyIcons.h>

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

Public Types

enum  { SELECTED_ICON, SELECTED_OFFSET, ANNOTATION_ICON, IGNORE_SELECTION }
 
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...
 
vtkApplyIconsNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
void SetIconType (vtkVariant v, int icon)
 Edits the lookup table to use for point icons. More...
 
void SetIconType (double v, int icon)
 Edits the lookup table to use for point icons. More...
 
void SetIconType (const char *v, int icon)
 Edits the lookup table to use for point icons. More...
 
void ClearAllIconTypes ()
 Edits the lookup table to use for point icons. More...
 
virtual void SetUseLookupTable (bool)
 If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data. More...
 
virtual bool GetUseLookupTable ()
 If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data. More...
 
virtual void UseLookupTableOn ()
 If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data. More...
 
virtual void UseLookupTableOff ()
 If on, uses the point lookup table to set the colors of unannotated, unselected elements of the data. More...
 
virtual void SetDefaultIcon (int)
 The default point icon for all unannotated, unselected elements of the data. More...
 
virtual int GetDefaultIcon ()
 The default point icon for all unannotated, unselected elements of the data. More...
 
virtual void SetSelectedIcon (int)
 The point icon for all selected elements of the data. More...
 
virtual int GetSelectedIcon ()
 The point icon for all selected elements of the data. More...
 
virtual void SetIconOutputArrayName (const char *)
 The output array name for the point icon index array. More...
 
virtual char * GetIconOutputArrayName ()
 The output array name for the point icon index array. More...
 
virtual void SetSelectionMode (int)
 Changes the behavior of the icon to use for selected items. More...
 
virtual int GetSelectionMode ()
 Changes the behavior of the icon to use for selected items. More...
 
virtual void SetSelectionModeToSelectedIcon ()
 Changes the behavior of the icon to use for selected items. More...
 
virtual void SetSelectionModeToSelectedOffset ()
 Changes the behavior of the icon to use for selected items. More...
 
virtual void SetSelectionModeToAnnotationIcon ()
 Changes the behavior of the icon to use for selected items. More...
 
virtual void SetSelectionModeToIgnoreSelection ()
 Changes the behavior of the icon to use for selected items. More...
 
virtual void SetAttributeType (int)
 The attribute type to append the icon array to, used only if the input array is not specified or does not exist. More...
 
virtual int GetAttributeType ()
 The attribute type to append the icon array to, used only if the input array is not specified or does not exist. More...
 
- Public Member Functions inherited from vtkPassInputTypeAlgorithm
vtkPassInputTypeAlgorithmNewInstance () const
 
vtkDataObjectGetInput ()
 Get the input data object. More...
 
int ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details More...
 
vtkDataObjectGetOutput ()
 Get the output data object for a port on this algorithm. More...
 
vtkDataObjectGetOutput (int)
 Get the output data object for a port on this algorithm. More...
 
vtkPolyDataGetPolyDataOutput ()
 Get the output as a concrete type. More...
 
vtkStructuredPointsGetStructuredPointsOutput ()
 Get the output as a concrete type. More...
 
vtkImageDataGetImageDataOutput ()
 Get the output as a concrete type. More...
 
vtkStructuredGridGetStructuredGridOutput ()
 Get the output as a concrete type. More...
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 Get the output as a concrete type. More...
 
vtkRectilinearGridGetRectilinearGridOutput ()
 Get the output as a concrete type. More...
 
vtkGraphGetGraphOutput ()
 Get the output as a concrete type. More...
 
vtkMoleculeGetMoleculeOutput ()
 Get the output as a concrete type. More...
 
vtkTableGetTableOutput ()
 Get the output as a concrete type. More...
 
void SetInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (vtkDataObject *)
 Assign a data object as input. More...
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input. 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...
 
int 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...
 
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 SetProgress (double)
 SetProgress is deprecated. More...
 
void UpdateProgress (double amount)
 Update the progress of the process object. More...
 
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 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 int 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 int 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 vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm. More...
 
void Register (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
void UnRegister (vtkObjectBase *o) override
 Participate in garbage collection. More...
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object. More...
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object. More...
 
virtual double GetProgress ()
 Get the execution progress of a 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 ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called. More...
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state. More...
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state. More...
 
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)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process. More...
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index. More...
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index. More...
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date. More...
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date. More...
 
virtual void SetReleaseDataFlag (int)
 Turn release data flag on or off for all output ports. More...
 
virtual int GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports. More...
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports. More...
 
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)
 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...
 
intGetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents. More...
 
intGetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents. More...
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents. More...
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents. More...
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. More...
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly. 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 ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool 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...
 
vtkCommandGetCommand (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...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool 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 vtkApplyIconsNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkApplyIconsSafeDownCast (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 ()
 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkApplyIcons ()
 
 ~vtkApplyIcons () 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...
 
- 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 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)
 
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...
 
- 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...
 
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...
 
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)
 
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)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 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, 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)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
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)
 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, 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)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature. More...
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature. More...
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file. 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=nullptr)
 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

int DefaultIcon
 
int SelectedIcon
 
bool UseLookupTable
 
char * IconOutputArrayName
 
int SelectionMode
 
int AttributeType
 
Internals * Implementation
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file. More...
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 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 icons to a data set.

vtkApplyIcons performs a iconing of the dataset using default icons, lookup tables, annotations, and/or a selection. The output is a vtkIntArray containing the icon index for each element in the dataset. The first input is the dataset to be iconed, which may be a vtkTable, vtkGraph subclass, or vtkDataSet subclass.

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 icon. For annotations with icon properties, this algorithm will use the icon index of annotated 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 icon of the selection, or whether there is a set of selected icons at a particular offset in the icon sheet.

The algorithm takes an input array, specified with SetInputArrayToProcess(0, 0, 0, vtkDataObject::FIELD_ASSOCIATION_POINTS, name) This sets data arrays to use to icon the data with the associated lookup table. For vtkGraph and vtkTable inputs, you would use FIELD_ASSOCIATION_VERTICES, FIELD_ASSOCIATION_EDGES, or FIELD_ASSOCIATION_ROWS as appropriate. The icon array will be added to the same set of attributes that the input array came from. If there is no input array, the icon array will be applied to the attributes associated with the AttributeType parameter.

Icons are assigned with the following priorities:

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

Definition at line 70 of file vtkApplyIcons.h.

Member Typedef Documentation

Definition at line 74 of file vtkApplyIcons.h.

Member Enumeration Documentation

anonymous enum
Enumerator
SELECTED_ICON 
SELECTED_OFFSET 
ANNOTATION_ICON 
IGNORE_SELECTION 

Definition at line 127 of file vtkApplyIcons.h.

Constructor & Destructor Documentation

vtkApplyIcons::vtkApplyIcons ( )
protected
vtkApplyIcons::~vtkApplyIcons ( )
overrideprotected

Member Function Documentation

static vtkApplyIcons* vtkApplyIcons::New ( )
static
static vtkTypeBool vtkApplyIcons::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkApplyIcons::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.

static vtkApplyIcons* vtkApplyIcons::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkApplyIcons::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPassInputTypeAlgorithm.

vtkApplyIcons* vtkApplyIcons::NewInstance ( ) const
void vtkApplyIcons::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.

void vtkApplyIcons::SetIconType ( vtkVariant  v,
int  icon 
)

Edits the lookup table to use for point icons.

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

void vtkApplyIcons::SetIconType ( double  v,
int  icon 
)
inline

Edits the lookup table to use for point icons.

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

Definition at line 83 of file vtkApplyIcons.h.

void vtkApplyIcons::SetIconType ( const char *  v,
int  icon 
)
inline

Edits the lookup table to use for point icons.

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

Definition at line 85 of file vtkApplyIcons.h.

void vtkApplyIcons::ClearAllIconTypes ( )

Edits the lookup table to use for point icons.

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

virtual void vtkApplyIcons::SetUseLookupTable ( bool  )
virtual

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

virtual bool vtkApplyIcons::GetUseLookupTable ( )
virtual

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

virtual void vtkApplyIcons::UseLookupTableOn ( )
virtual

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

virtual void vtkApplyIcons::UseLookupTableOff ( )
virtual

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

virtual void vtkApplyIcons::SetDefaultIcon ( int  )
virtual

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

This is used if UsePointLookupTable is off.

virtual int vtkApplyIcons::GetDefaultIcon ( )
virtual

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

This is used if UsePointLookupTable is off.

virtual void vtkApplyIcons::SetSelectedIcon ( int  )
virtual

The point icon for all selected elements of the data.

This is used if the annotation input has a current selection.

virtual int vtkApplyIcons::GetSelectedIcon ( )
virtual

The point icon for all selected elements of the data.

This is used if the annotation input has a current selection.

virtual void vtkApplyIcons::SetIconOutputArrayName ( const char *  )
virtual

The output array name for the point icon index array.

Default is "vtkApplyIcons icon".

virtual char* vtkApplyIcons::GetIconOutputArrayName ( )
virtual

The output array name for the point icon index array.

Default is "vtkApplyIcons icon".

virtual void vtkApplyIcons::SetSelectionMode ( int  )
virtual

Changes the behavior of the icon to use for selected items.

  • SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
  • SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
  • ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
  • IGNORE_SELECTION does not change the icon based on the current selection.

The default is IGNORE_SELECTION.

virtual int vtkApplyIcons::GetSelectionMode ( )
virtual

Changes the behavior of the icon to use for selected items.

  • SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
  • SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
  • ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
  • IGNORE_SELECTION does not change the icon based on the current selection.

The default is IGNORE_SELECTION.

virtual void vtkApplyIcons::SetSelectionModeToSelectedIcon ( )
inlinevirtual

Changes the behavior of the icon to use for selected items.

  • SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
  • SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
  • ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
  • IGNORE_SELECTION does not change the icon based on the current selection.

The default is IGNORE_SELECTION.

Definition at line 148 of file vtkApplyIcons.h.

virtual void vtkApplyIcons::SetSelectionModeToSelectedOffset ( )
inlinevirtual

Changes the behavior of the icon to use for selected items.

  • SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
  • SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
  • ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
  • IGNORE_SELECTION does not change the icon based on the current selection.

The default is IGNORE_SELECTION.

Definition at line 150 of file vtkApplyIcons.h.

virtual void vtkApplyIcons::SetSelectionModeToAnnotationIcon ( )
inlinevirtual

Changes the behavior of the icon to use for selected items.

  • SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
  • SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
  • ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
  • IGNORE_SELECTION does not change the icon based on the current selection.

The default is IGNORE_SELECTION.

Definition at line 152 of file vtkApplyIcons.h.

virtual void vtkApplyIcons::SetSelectionModeToIgnoreSelection ( )
inlinevirtual

Changes the behavior of the icon to use for selected items.

  • SELECTED_ICON uses SelectedIcon as the icon for all selected elements.
  • SELECTED_OFFSET uses SelectedIcon as an offset to add to all selected elements.
  • ANNOTATION_ICON uses the ICON_INDEX() property of the current annotation.
  • IGNORE_SELECTION does not change the icon based on the current selection.

The default is IGNORE_SELECTION.

Definition at line 154 of file vtkApplyIcons.h.

virtual void vtkApplyIcons::SetAttributeType ( int  )
virtual

The attribute type to append the icon array to, used only if the input array is not specified or does not exist.

This is set to one of the AttributeTypes enum in vtkDataObject (e.g. POINT, CELL, VERTEX EDGE, FIELD).

virtual int vtkApplyIcons::GetAttributeType ( )
virtual

The attribute type to append the icon array to, used only if the input array is not specified or does not exist.

This is set to one of the AttributeTypes enum in vtkDataObject (e.g. POINT, CELL, VERTEX EDGE, FIELD).

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

Convert the vtkGraph into vtkPolyData.

Reimplemented from vtkPassInputTypeAlgorithm.

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

Set the input type of the algorithm to vtkGraph.

Reimplemented from vtkPassInputTypeAlgorithm.

Member Data Documentation

int vtkApplyIcons::DefaultIcon
protected

Definition at line 184 of file vtkApplyIcons.h.

int vtkApplyIcons::SelectedIcon
protected

Definition at line 185 of file vtkApplyIcons.h.

bool vtkApplyIcons::UseLookupTable
protected

Definition at line 186 of file vtkApplyIcons.h.

char* vtkApplyIcons::IconOutputArrayName
protected

Definition at line 187 of file vtkApplyIcons.h.

int vtkApplyIcons::SelectionMode
protected

Definition at line 188 of file vtkApplyIcons.h.

int vtkApplyIcons::AttributeType
protected

Definition at line 189 of file vtkApplyIcons.h.

Internals* vtkApplyIcons::Implementation
protected

Definition at line 191 of file vtkApplyIcons.h.


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