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

#include <vtkRenderedHierarchyRepresentation.h>

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

Public Types

typedef vtkRenderedGraphRepresentation Superclass
 
- Public Types inherited from vtkRenderedGraphRepresentation
typedef vtkRenderedRepresentation Superclass
 
- Public Types inherited from vtkRenderedRepresentation
typedef vtkDataRepresentation Superclass
 
- Public Types inherited from vtkDataRepresentation
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.
 
vtkRenderedHierarchyRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void SetGraphEdgeLabelVisibility (bool vis)
 
virtual void SetGraphEdgeLabelVisibility (bool vis, int idx)
 
virtual bool GetGraphEdgeLabelVisibility ()
 
virtual bool GetGraphEdgeLabelVisibility (int idx)
 
virtual void GraphEdgeLabelVisibilityOn ()
 
virtual void GraphEdgeLabelVisibilityOff ()
 
virtual void SetGraphEdgeColorArrayName (const char *name)
 
virtual void SetGraphEdgeColorArrayName (const char *name, int idx)
 
virtual const char * GetGraphEdgeColorArrayName ()
 
virtual const char * GetGraphEdgeColorArrayName (int idx)
 
virtual void SetColorGraphEdgesByArray (bool vis)
 
virtual void SetColorGraphEdgesByArray (bool vis, int idx)
 
virtual bool GetColorGraphEdgesByArray ()
 
virtual bool GetColorGraphEdgesByArray (int idx)
 
virtual void ColorGraphEdgesByArrayOn ()
 
virtual void ColorGraphEdgesByArrayOff ()
 
virtual void SetGraphEdgeColorToSplineFraction ()
 
virtual void SetGraphEdgeColorToSplineFraction (int idx)
 
virtual void SetGraphVisibility (bool vis)
 
virtual void SetGraphVisibility (bool vis, int idx)
 
virtual bool GetGraphVisibility ()
 
virtual bool GetGraphVisibility (int idx)
 
virtual void GraphVisibilityOn ()
 
virtual void GraphVisibilityOff ()
 
virtual void SetBundlingStrength (double strength)
 
virtual void SetBundlingStrength (double strength, int idx)
 
virtual double GetBundlingStrength ()
 
virtual double GetBundlingStrength (int idx)
 
virtual void SetGraphEdgeLabelFontSize (int size)
 
virtual void SetGraphEdgeLabelFontSize (int size, int idx)
 
virtual int GetGraphEdgeLabelFontSize ()
 
virtual int GetGraphEdgeLabelFontSize (int idx)
 
virtual void SetGraphEdgeLabelArrayName (const char *name)
 
virtual void SetGraphEdgeLabelArrayName (const char *name, int idx)
 
virtual const char * GetGraphEdgeLabelArrayName ()
 
virtual const char * GetGraphEdgeLabelArrayName (int idx)
 
virtual void SetGraphSplineType (int type, int idx)
 Sets the spline type for the graph edges.
 
virtual int GetGraphSplineType (int idx)
 Sets the spline type for the graph edges.
 
- Public Member Functions inherited from vtkRenderedGraphRepresentation
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkRenderedGraphRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void SetVertexLabelArrayName (const char *name)
 
virtual const char * GetVertexLabelArrayName ()
 
virtual void SetVertexLabelPriorityArrayName (const char *name)
 
virtual const char * GetVertexLabelPriorityArrayName ()
 
virtual void SetVertexLabelVisibility (bool b)
 
virtual bool GetVertexLabelVisibility ()
 
virtual void VertexLabelVisibilityOn ()
 
virtual void VertexLabelVisibilityOff ()
 
virtual void SetVertexLabelTextProperty (vtkTextProperty *p)
 
virtual vtkTextPropertyGetVertexLabelTextProperty ()
 
virtual void SetVertexHoverArrayName (const char *)
 
virtual char * GetVertexHoverArrayName ()
 
virtual void SetEdgeLabelArrayName (const char *name)
 
virtual const char * GetEdgeLabelArrayName ()
 
virtual void SetEdgeLabelPriorityArrayName (const char *name)
 
virtual const char * GetEdgeLabelPriorityArrayName ()
 
virtual void SetEdgeLabelVisibility (bool b)
 
virtual bool GetEdgeLabelVisibility ()
 
virtual void EdgeLabelVisibilityOn ()
 
virtual void EdgeLabelVisibilityOff ()
 
virtual void SetEdgeLabelTextProperty (vtkTextProperty *p)
 
virtual vtkTextPropertyGetEdgeLabelTextProperty ()
 
virtual void SetEdgeHoverArrayName (const char *)
 
virtual char * GetEdgeHoverArrayName ()
 
virtual void SetVertexIconArrayName (const char *name)
 
virtual const char * GetVertexIconArrayName ()
 
virtual void SetVertexIconPriorityArrayName (const char *name)
 
virtual const char * GetVertexIconPriorityArrayName ()
 
virtual void SetVertexIconVisibility (bool b)
 
virtual bool GetVertexIconVisibility ()
 
virtual void VertexIconVisibilityOn ()
 
virtual void VertexIconVisibilityOff ()
 
virtual void AddVertexIconType (const char *name, int type)
 
virtual void ClearVertexIconTypes ()
 
virtual void SetUseVertexIconTypeMap (bool b)
 
virtual bool GetUseVertexIconTypeMap ()
 
virtual void UseVertexIconTypeMapOn ()
 
virtual void UseVertexIconTypeMapOff ()
 
virtual void SetVertexIconAlignment (int align)
 
virtual int GetVertexIconAlignment ()
 
virtual void SetVertexSelectedIcon (int icon)
 
virtual int GetVertexSelectedIcon ()
 
virtual void SetVertexDefaultIcon (int icon)
 
virtual int GetVertexDefaultIcon ()
 
virtual void SetEdgeIconArrayName (const char *name)
 
virtual const char * GetEdgeIconArrayName ()
 
virtual void SetEdgeIconPriorityArrayName (const char *name)
 
virtual const char * GetEdgeIconPriorityArrayName ()
 
virtual void SetEdgeIconVisibility (bool b)
 
virtual bool GetEdgeIconVisibility ()
 
virtual void EdgeIconVisibilityOn ()
 
virtual void EdgeIconVisibilityOff ()
 
virtual void AddEdgeIconType (const char *name, int type)
 
virtual void ClearEdgeIconTypes ()
 
virtual void SetUseEdgeIconTypeMap (bool b)
 
virtual bool GetUseEdgeIconTypeMap ()
 
virtual void UseEdgeIconTypeMapOn ()
 
virtual void UseEdgeIconTypeMapOff ()
 
virtual void SetEdgeIconAlignment (int align)
 
virtual int GetEdgeIconAlignment ()
 
virtual void SetColorVerticesByArray (bool b)
 
virtual bool GetColorVerticesByArray ()
 
virtual void ColorVerticesByArrayOn ()
 
virtual void ColorVerticesByArrayOff ()
 
virtual void SetVertexColorArrayName (const char *name)
 
virtual const char * GetVertexColorArrayName ()
 
virtual void SetColorEdgesByArray (bool b)
 
virtual bool GetColorEdgesByArray ()
 
virtual void ColorEdgesByArrayOn ()
 
virtual void ColorEdgesByArrayOff ()
 
virtual void SetEdgeColorArrayName (const char *name)
 
virtual const char * GetEdgeColorArrayName ()
 
virtual void SetEnableVerticesByArray (bool b)
 
virtual bool GetEnableVerticesByArray ()
 
virtual void EnableVerticesByArrayOn ()
 
virtual void EnableVerticesByArrayOff ()
 
virtual void SetEnabledVerticesArrayName (const char *name)
 
virtual const char * GetEnabledVerticesArrayName ()
 
virtual void SetEnableEdgesByArray (bool b)
 
virtual bool GetEnableEdgesByArray ()
 
virtual void EnableEdgesByArrayOn ()
 
virtual void EnableEdgesByArrayOff ()
 
virtual void SetEnabledEdgesArrayName (const char *name)
 
virtual const char * GetEnabledEdgesArrayName ()
 
virtual void SetEdgeVisibility (bool b)
 
virtual bool GetEdgeVisibility ()
 
virtual void EdgeVisibilityOn ()
 
virtual void EdgeVisibilityOff ()
 
void SetEdgeSelection (bool b)
 
bool GetEdgeSelection ()
 
void SetLayoutStrategyToRandom ()
 Set predefined layout strategies.
 
void SetLayoutStrategyToForceDirected ()
 
void SetLayoutStrategyToSimple2D ()
 
void SetLayoutStrategyToClustering2D ()
 
void SetLayoutStrategyToCommunity2D ()
 
void SetLayoutStrategyToFast2D ()
 
void SetLayoutStrategyToPassThrough ()
 
void SetLayoutStrategyToCircular ()
 
void SetLayoutStrategyToTree ()
 
void SetLayoutStrategyToCosmicTree ()
 
void SetLayoutStrategyToCone ()
 
void SetLayoutStrategyToSpanTree ()
 
virtual void SetLayoutStrategyToAssignCoordinates (const char *xarr, const char *yarr=nullptr, const char *zarr=nullptr)
 Set the layout strategy to use coordinates from arrays.
 
virtual void SetLayoutStrategyToTree (bool radial, double angle=90, double leafSpacing=0.9, double logSpacing=1.0)
 Set the layout strategy to a tree layout.
 
virtual void SetLayoutStrategyToCosmicTree (const char *nodeSizeArrayName, bool sizeLeafNodesOnly=true, int layoutDepth=0, vtkIdType layoutRoot=-1)
 Set the layout strategy to a cosmic tree layout.
 
virtual void SetEdgeLayoutStrategyToGeo (double explodeFactor=0.2)
 Set the edge layout strategy to a geospatial arced strategy appropriate for vtkGeoView.
 
void ApplyViewTheme (vtkViewTheme *theme) override
 Apply a theme to this representation.
 
virtual bool IsLayoutComplete ()
 Whether the current graph layout is complete.
 
virtual void UpdateLayout ()
 Performs another iteration on the graph layout.
 
void ComputeSelectedGraphBounds (double bounds[6])
 Compute the bounding box of the selected subgraph.
 
virtual void SetHideVertexLabelsOnInteraction (bool)
 Whether to hide the display of vertex labels during mouse interaction.
 
virtual bool GetHideVertexLabelsOnInteraction ()
 Whether to hide the display of vertex labels during mouse interaction.
 
virtual void HideVertexLabelsOnInteractionOn ()
 Whether to hide the display of vertex labels during mouse interaction.
 
virtual void HideVertexLabelsOnInteractionOff ()
 Whether to hide the display of vertex labels during mouse interaction.
 
virtual void SetHideEdgeLabelsOnInteraction (bool)
 Whether to hide the display of edge labels during mouse interaction.
 
virtual bool GetHideEdgeLabelsOnInteraction ()
 Whether to hide the display of edge labels during mouse interaction.
 
virtual void HideEdgeLabelsOnInteractionOn ()
 Whether to hide the display of edge labels during mouse interaction.
 
virtual void HideEdgeLabelsOnInteractionOff ()
 Whether to hide the display of edge labels during mouse interaction.
 
virtual void SetVertexIconSelectionMode (int mode)
 Set the mode to one of.
 
virtual int GetVertexIconSelectionMode ()
 Set the mode to one of.
 
virtual void SetVertexIconSelectionModeToSelectedIcon ()
 Set the mode to one of.
 
virtual void SetVertexIconSelectionModeToSelectedOffset ()
 Set the mode to one of.
 
virtual void SetVertexIconSelectionModeToAnnotationIcon ()
 Set the mode to one of.
 
virtual void SetVertexIconSelectionModeToIgnoreSelection ()
 Set the mode to one of.
 
virtual void SetLayoutStrategy (vtkGraphLayoutStrategy *strategy)
 Set/get the graph layout strategy.
 
virtual vtkGraphLayoutStrategyGetLayoutStrategy ()
 Set/get the graph layout strategy.
 
virtual void SetLayoutStrategy (const char *name)
 Get/set the layout strategy by name.
 
virtual char * GetLayoutStrategyName ()
 Get/set the layout strategy by name.
 
virtual void SetEdgeLayoutStrategy (vtkEdgeLayoutStrategy *strategy)
 Set/get the graph layout strategy.
 
virtual vtkEdgeLayoutStrategyGetEdgeLayoutStrategy ()
 Set/get the graph layout strategy.
 
void SetEdgeLayoutStrategyToArcParallel ()
 Set/get the graph layout strategy.
 
void SetEdgeLayoutStrategyToPassThrough ()
 Set/get the graph layout strategy.
 
virtual void SetEdgeLayoutStrategy (const char *name)
 Set the edge layout strategy by name.
 
virtual char * GetEdgeLayoutStrategyName ()
 Set the edge layout strategy by name.
 
virtual void SetGlyphType (int type)
 Set the graph vertex glyph type.
 
virtual int GetGlyphType ()
 Set the graph vertex glyph type.
 
virtual void SetScaling (bool b)
 Set whether to scale vertex glyphs.
 
virtual bool GetScaling ()
 Set whether to scale vertex glyphs.
 
virtual void ScalingOn ()
 Set whether to scale vertex glyphs.
 
virtual void ScalingOff ()
 Set whether to scale vertex glyphs.
 
virtual void SetScalingArrayName (const char *name)
 Set the glyph scaling array name.
 
virtual const char * GetScalingArrayName ()
 Set the glyph scaling array name.
 
virtual void SetVertexScalarBarVisibility (bool b)
 Vertex/edge scalar bar visibility.
 
virtual bool GetVertexScalarBarVisibility ()
 Vertex/edge scalar bar visibility.
 
virtual void SetEdgeScalarBarVisibility (bool b)
 Vertex/edge scalar bar visibility.
 
virtual bool GetEdgeScalarBarVisibility ()
 Vertex/edge scalar bar visibility.
 
virtual vtkScalarBarWidgetGetVertexScalarBar ()
 Obtain the scalar bar widget used to draw a legend for the vertices/edges.
 
virtual vtkScalarBarWidgetGetEdgeScalarBar ()
 Obtain the scalar bar widget used to draw a legend for the vertices/edges.
 
- Public Member Functions inherited from vtkRenderedRepresentation
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkRenderedRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
virtual void SetLabelRenderMode (int)
 Set the label render mode.
 
virtual int GetLabelRenderMode ()
 Set the label render mode.
 
- Public Member Functions inherited from vtkDataRepresentation
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkDataRepresentationNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkAlgorithmOutputGetInputConnection (int port=0, int index=0)
 Convenience override method for obtaining the input connection without specifying the port or index.
 
vtkAnnotationLinkGetAnnotationLink ()
 The annotation link for this representation.
 
void SetAnnotationLink (vtkAnnotationLink *link)
 
virtual void ApplyViewTheme (vtkViewTheme *vtkNotUsed(theme))
 Apply a theme to this representation.
 
void Select (vtkView *view, vtkSelection *selection)
 The view calls this method when a selection occurs.
 
void Select (vtkView *view, vtkSelection *selection, bool extend)
 
void Annotate (vtkView *view, vtkAnnotationLayers *annotations)
 Analogous to Select().
 
void Annotate (vtkView *view, vtkAnnotationLayers *annotations, bool extend)
 
void UpdateSelection (vtkSelection *selection)
 Updates the selection in the selection link and fires a selection change event.
 
void UpdateSelection (vtkSelection *selection, bool extend)
 
void UpdateAnnotations (vtkAnnotationLayers *annotations)
 Updates the selection in the selection link and fires a selection change event.
 
void UpdateAnnotations (vtkAnnotationLayers *annotations, bool extend)
 
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort ()
 The output port that contains the annotations whose selections are localized for a particular input data object.
 
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort (int port)
 
virtual vtkAlgorithmOutputGetInternalAnnotationOutputPort (int port, int conn)
 
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort ()
 The output port that contains the selection associated with the current annotation (normally the interactive selection).
 
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort (int port)
 
virtual vtkAlgorithmOutputGetInternalSelectionOutputPort (int port, int conn)
 
virtual vtkAlgorithmOutputGetInternalOutputPort ()
 Retrieves an output port for the input data object at the specified port and connection index.
 
virtual vtkAlgorithmOutputGetInternalOutputPort (int port)
 
virtual vtkAlgorithmOutputGetInternalOutputPort (int port, int conn)
 
virtual vtkSelectionConvertSelection (vtkView *view, vtkSelection *selection)
 Convert the selection to a type appropriate for sharing with other representations through vtkAnnotationLink, possibly using the view.
 
virtual void SetSelectable (bool)
 Whether this representation is able to handle a selection.
 
virtual bool GetSelectable ()
 Whether this representation is able to handle a selection.
 
virtual void SelectableOn ()
 Whether this representation is able to handle a selection.
 
virtual void SelectableOff ()
 Whether this representation is able to handle a selection.
 
virtual void SetSelectionType (int)
 Set the selection type produced by this view.
 
virtual int GetSelectionType ()
 Set the selection type produced by this view.
 
virtual void SetSelectionArrayNames (vtkStringArray *names)
 If a VALUES selection, the arrays used to produce a selection.
 
virtual vtkStringArrayGetSelectionArrayNames ()
 If a VALUES selection, the arrays used to produce a selection.
 
virtual void SetSelectionArrayName (const char *name)
 If a VALUES selection, the array used to produce a selection.
 
virtual const char * GetSelectionArrayName ()
 If a VALUES selection, the array used to produce a selection.
 
- Public Member Functions inherited from vtkPassInputTypeAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkPassInputTypeAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkDataObjectGetInput ()
 Get the input data object.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 see vtkAlgorithm for details
 
vtkDataObjectGetOutput ()
 Get the output data object for a port on this algorithm.
 
vtkDataObjectGetOutput (int)
 Get the output data object for a port on this algorithm.
 
vtkPolyDataGetPolyDataOutput ()
 Get the output as a concrete type.
 
vtkStructuredPointsGetStructuredPointsOutput ()
 Get the output as a concrete type.
 
vtkImageDataGetImageDataOutput ()
 Get the output as a concrete type.
 
vtkStructuredGridGetStructuredGridOutput ()
 Get the output as a concrete type.
 
vtkUnstructuredGridGetUnstructuredGridOutput ()
 Get the output as a concrete type.
 
vtkRectilinearGridGetRectilinearGridOutput ()
 Get the output as a concrete type.
 
vtkGraphGetGraphOutput ()
 Get the output as a concrete type.
 
vtkMoleculeGetMoleculeOutput ()
 Get the output as a concrete type.
 
vtkTableGetTableOutput ()
 Get the output as a concrete type.
 
vtkHyperTreeGridGetHyperTreeGridOutput ()
 Get the output as a concrete type.
 
void SetInputData (vtkDataObject *)
 Assign a data object as input.
 
void SetInputData (int, vtkDataObject *)
 Assign a data object as input.
 
void AddInputData (vtkDataObject *)
 Assign a data object as input.
 
void AddInputData (int, vtkDataObject *)
 Assign a data object as input.
 
- Public Member Functions inherited from vtkAlgorithm
virtual vtkTypeBool IsA (const char *type)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
vtkTypeBool HasExecutive ()
 Check whether this algorithm has an assigned executive.
 
vtkExecutiveGetExecutive ()
 Get this algorithm's executive.
 
virtual void SetExecutive (vtkExecutive *executive)
 Set this algorithm's executive.
 
virtual vtkTypeBool ProcessRequest (vtkInformation *request, vtkInformationVector **inInfo, vtkInformationVector *outInfo)
 Upstream/Downstream requests form the generalized interface through which executives invoke a algorithm's functionality.
 
vtkTypeBool ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
 Version of ProcessRequest() that is wrapped.
 
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.
 
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.
 
vtkInformationGetInputPortInformation (int port)
 Get the information object associated with an input port.
 
vtkInformationGetOutputPortInformation (int port)
 Get the information object associated with an output port.
 
int GetNumberOfInputPorts ()
 Get the number of input ports used by the algorithm.
 
int GetNumberOfOutputPorts ()
 Get the number of output ports provided by the algorithm.
 
void SetAbortExecuteAndUpdateTime ()
 Set AbortExecute Flag and update LastAbortTime.
 
void UpdateProgress (double amount)
 Update the progress of the process object.
 
bool CheckAbort ()
 Checks to see if this filter should abort.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
 String based versions of SetInputArrayToProcess().
 
vtkInformationGetInputArrayInformation (int idx)
 Get the info object for the specified input array to this algorithm.
 
void RemoveAllInputs ()
 Remove all the input data.
 
vtkDataObjectGetOutputDataObject (int port)
 Get the data object that will contain the algorithm output for the given port.
 
vtkDataObjectGetInputDataObject (int port, int connection)
 Get the data object that will contain the algorithm input for the given port and given connection.
 
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
 Remove a connection from the given input port index.
 
virtual void RemoveInputConnection (int port, int idx)
 Remove a connection given by index idx.
 
virtual void RemoveAllInputConnections (int port)
 Removes all input connections.
 
virtual void SetInputDataObject (int port, vtkDataObject *data)
 Sets the data-object as an input on the given port index.
 
virtual void SetInputDataObject (vtkDataObject *data)
 
virtual void AddInputDataObject (int port, vtkDataObject *data)
 Add the data-object as an input to this given port.
 
virtual void AddInputDataObject (vtkDataObject *data)
 
vtkAlgorithmOutputGetOutputPort (int index)
 Get a proxy object corresponding to the given output port of this algorithm.
 
vtkAlgorithmOutputGetOutputPort ()
 
int GetNumberOfInputConnections (int port)
 Get the number of inputs currently connected to a port.
 
int GetTotalNumberOfInputConnections ()
 Get the total number of inputs for this algorithm.
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 Get the algorithm output port connected to an input port.
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 Returns the algorithm and the output port index of that algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 Returns the algorithm connected to a port-index pair.
 
vtkAlgorithmGetInputAlgorithm ()
 Equivalent to GetInputAlgorithm(0, 0).
 
vtkExecutiveGetInputExecutive (int port, int index)
 Returns the executive associated with a particular input connection.
 
vtkExecutiveGetInputExecutive ()
 Equivalent to GetInputExecutive(0, 0)
 
vtkInformationGetInputInformation (int port, int index)
 Return the information object that is associated with a particular input connection.
 
vtkInformationGetInputInformation ()
 Equivalent to GetInputInformation(0, 0)
 
vtkInformationGetOutputInformation (int port)
 Return the information object that is associated with a particular output port.
 
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).
 
virtual vtkTypeBool Update (vtkInformation *requests)
 Convenience method to update an algorithm after passing requests to its first output port.
 
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.
 
virtual int UpdateExtent (const int extents[6])
 Convenience method to update an algorithm after passing requests to its first output port.
 
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.
 
virtual void UpdateInformation ()
 Bring the algorithm's information up-to-date.
 
virtual void UpdateDataObject ()
 Create output object(s).
 
virtual void PropagateUpdateExtent ()
 Propagate meta-data upstream.
 
virtual void UpdateWholeExtent ()
 Bring this algorithm's outputs up-to-date.
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 Convenience routine to convert from a linear ordering of input connections to a port/connection pair.
 
void RemoveNoPriorTemporalAccessInformationKey ()
 Removes any information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS() to all output ports of this vtkAlgorithm.
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this algorithm.
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this algorithm.
 
bool UsesGarbageCollector () const override
 Participate in garbage collection.
 
virtual void SetAbortExecute (vtkTypeBool)
 Set/Get the AbortExecute flag for the process object.
 
virtual vtkTypeBool GetAbortExecute ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOn ()
 Set/Get the AbortExecute flag for the process object.
 
virtual void AbortExecuteOff ()
 Set/Get the AbortExecute flag for the process object.
 
virtual double GetProgress ()
 Get the execution progress of a process object.
 
void SetContainerAlgorithm (vtkAlgorithm *containerAlg)
 Set/get a Container algorithm for this algorithm.
 
vtkAlgorithmGetContainerAlgorithm ()
 Set/get a Container algorithm for this algorithm.
 
virtual void SetAbortOutput (bool)
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
virtual bool GetAbortOutput ()
 Set/Get an internal variable used to communicate between the algorithm and executive.
 
void SetProgressShiftScale (double shift, double scale)
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressShift ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
virtual double GetProgressScale ()
 Specify the shift and scale values to use to apply to the progress amount when UpdateProgress is called.
 
void SetProgressText (const char *ptext)
 Set the current text message associated with the progress state.
 
virtual char * GetProgressText ()
 Set the current text message associated with the progress state.
 
virtual unsigned long GetErrorCode ()
 The error code contains a possible error that occurred while reading or writing the file.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
 Set the input data arrays that this algorithm will process.
 
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 Set the connection for the given input port index.
 
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void AddInputConnection (vtkAlgorithmOutput *input)
 Add a connection to the given input port index.
 
virtual void Update (int port)
 Bring this algorithm's outputs up-to-date.
 
virtual void Update ()
 Bring this algorithm's outputs up-to-date.
 
virtual void SetReleaseDataFlag (vtkTypeBool)
 Turn release data flag on or off for all output ports.
 
virtual vtkTypeBool GetReleaseDataFlag ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOn ()
 Turn release data flag on or off for all output ports.
 
void ReleaseDataFlagOff ()
 Turn release data flag on or off for all output ports.
 
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.
 
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.
 
int * GetUpdateExtent ()
 These functions return the update extent for output ports that use 3D extents.
 
int * GetUpdateExtent (int port)
 These functions return the update extent for output ports that use 3D extents.
 
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.
 
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.
 
void GetUpdateExtent (int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
void GetUpdateExtent (int port, int extent[6])
 These functions return the update extent for output ports that use 3D extents.
 
int GetUpdatePiece ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdatePiece (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateNumberOfPieces (int port)
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel ()
 These functions return the update extent for output ports that use piece extents.
 
int GetUpdateGhostLevel (int port)
 These functions return the update extent for output ports that use piece extents.
 
void SetProgressObserver (vtkProgressObserver *)
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
virtual vtkProgressObserverGetProgressObserver ()
 If an ProgressObserver is set, the algorithm will report progress through it rather than directly.
 
void SetNoPriorTemporalAccessInformationKey (int key)
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
void SetNoPriorTemporalAccessInformationKey ()
 Set to all output ports of this algorithm the information key vtkStreamingDemandDrivenPipeline::NO_PRIOR_TEMPORAL_ACCESS().
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on.
 
virtual void DebugOff ()
 Turn debugging output off.
 
bool GetDebug ()
 Get the value of the debug flag.
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag.
 
virtual void Modified ()
 Update the modification time for this object.
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time.
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
 
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)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output.
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object.
 
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.
 
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.
 
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.
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not.
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes.
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes.
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string.
 
virtual std::string GetObjectDescription () const
 The object description printed in messages and PrintSelf output.
 
virtual vtkTypeBool IsA (const char *name)
 Return 1 if this class is the same type of (or a subclass of) the named class.
 
virtual vtkIdType GetNumberOfGenerationsFromBase (const char *name)
 Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
virtual void Delete ()
 Delete a VTK object.
 
virtual void FastDelete ()
 Delete a reference to this object.
 
void InitializeObjectBase ()
 
void Print (ostream &os)
 Print an object to an ostream.
 
void Register (vtkObjectBase *o)
 Increase the reference count (mark as used by another object).
 
virtual void UnRegister (vtkObjectBase *o)
 Decrease the reference count (release by another object).
 
int GetReferenceCount ()
 Return the current reference count of this object.
 
void SetReferenceCount (int)
 Sets the reference count.
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space.
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses.
 

Static Public Member Functions

static vtkRenderedHierarchyRepresentationNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderedHierarchyRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderedGraphRepresentation
static vtkRenderedGraphRepresentationNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderedGraphRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkRenderedRepresentation
static vtkRenderedRepresentationNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkRenderedRepresentationSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkDataRepresentation
static vtkDataRepresentationNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkDataRepresentationSafeDownCast (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.
 
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.
 
static vtkInformationIntegerKeyCAN_HANDLE_PIECE_REQUEST ()
 Key that tells the pipeline that a particular algorithm can or cannot handle piece request.
 
static vtkInformationIntegerKeyABORTED ()
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 If the DefaultExecutivePrototype is set, a copy of it is created in CreateDefaultExecutive() using NewInstance().
 
- 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.
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes.
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed.
 
- 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.
 
static vtkIdType GetNumberOfGenerationsFromBaseType (const char *name)
 Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class).
 
static vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on.
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.
 
static bool GetUsingMemkind ()
 A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space.
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRenderedHierarchyRepresentation ()
 
 ~vtkRenderedHierarchyRepresentation () override
 
bool ValidIndex (int idx)
 Whether idx is a valid graph index.
 
vtkSelectionConvertSelection (vtkView *view, vtkSelection *sel) override
 Convert the selection to a type appropriate for sharing with other representations through vtkAnnotationLink, possibly using the view.
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Sets up the input connections for this representation.
 
void ApplyViewTheme (vtkViewTheme *theme) override
 
bool AddToView (vtkView *view) override
 Called by the view to add/remove this representation.
 
bool RemoveFromView (vtkView *view) override
 Called by the view to add/remove this representation.
 
- Protected Member Functions inherited from vtkRenderedGraphRepresentation
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRenderedGraphRepresentation ()
 
 ~vtkRenderedGraphRepresentation () override
 
void PrepareForRendering (vtkRenderView *view) override
 The view will call this method before every render.
 
vtkSelectionConvertSelection (vtkView *view, vtkSelection *sel) override
 Convert the selection to a type appropriate for sharing with other representations through vtkAnnotationLink, possibly using the view.
 
std::string GetHoverStringInternal (vtkSelection *sel) override
 Subclasses may override this method to generate the hover text.
 
int RequestData (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
 Connect inputs to internal pipeline.
 
virtual void SetVertexColorArrayNameInternal (const char *)
 
virtual char * GetVertexColorArrayNameInternal ()
 
virtual void SetEdgeColorArrayNameInternal (const char *)
 
virtual char * GetEdgeColorArrayNameInternal ()
 
virtual void SetScalingArrayNameInternal (const char *)
 
virtual char * GetScalingArrayNameInternal ()
 
virtual void SetLayoutStrategyName (const char *)
 
virtual void SetEdgeLayoutStrategyName (const char *)
 
bool AddToView (vtkView *view) override
 Called by the view to add/remove this representation.
 
bool RemoveFromView (vtkView *view) override
 Called by the view to add/remove this representation.
 
- Protected Member Functions inherited from vtkRenderedRepresentation
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkRenderedRepresentation ()
 
 ~vtkRenderedRepresentation () override
 
std::string GetHoverString (vtkView *view, vtkProp *prop, vtkIdType cell)
 Obtains the hover text for a particular prop and cell.
 
virtual std::string GetHoverStringInternal (vtkSelection *)
 Subclasses may override this method to generate the hover text.
 
virtual void PrepareForRendering (vtkRenderView *view)
 The view will call this method before every render.
 
void AddPropOnNextRender (vtkProp *p)
 Subclasses may call these methods to add or remove props from the representation.
 
void RemovePropOnNextRender (vtkProp *p)
 Subclasses may call these methods to add or remove props from the representation.
 
- Protected Member Functions inherited from vtkDataRepresentation
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkDataRepresentation ()
 
 ~vtkDataRepresentation () override
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *) override
 Subclasses should override this to connect inputs to the internal pipeline as necessary.
 
virtual void ProcessEvents (vtkObject *caller, unsigned long eventId, void *callData)
 Clear the input shallow copy caches if the algorithm is in "release data" mode.
 
virtual bool AddToView (vtkView *vtkNotUsed(view))
 Adds the representation to the view.
 
virtual bool RemoveFromView (vtkView *vtkNotUsed(view))
 Removes the representation to the view.
 
virtual vtkAnnotationLayersConvertAnnotations (vtkView *view, vtkAnnotationLayers *annotations)
 Analogous to ConvertSelection(), allows subclasses to manipulate annotations before passing them off to vtkAnnotationLink.
 
vtkTrivialProducerGetInternalInput (int port, int conn)
 
void SetInternalInput (int port, int conn, vtkTrivialProducer *producer)
 
virtual void SetAnnotationLinkInternal (vtkAnnotationLink *link)
 The annotation link for this representation.
 
- Protected Member Functions inherited from vtkPassInputTypeAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkPassInputTypeAlgorithm ()
 
 ~vtkPassInputTypeAlgorithm () override=default
 
virtual int RequestDataObject (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
 This is called within ProcessRequest when a request asks the algorithm to create empty output data objects.
 
virtual int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request asks for Information.
 
virtual int RequestUpdateTime (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request ask for temporal information to be updated.
 
virtual int RequestUpdateTimeDependentInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request ask for meta information to be updated.
 
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.
 
virtual int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 This is called within ProcessRequest when a request asks the algorithm to do its work.
 
int FillOutputPortInformation (int port, vtkInformation *info) override
 Fill the output port information objects for this algorithm.
 
int FillInputPortInformation (int port, vtkInformation *info) override
 Fill the input port information objects for this algorithm.
 
vtkDataObjectGetInput (int port)
 
- Protected Member Functions inherited from vtkAlgorithm
virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkAlgorithm ()
 
 ~vtkAlgorithm () override
 
bool CheckUpstreamAbort ()
 Checks to see if an upstream filter has been aborted.
 
virtual int FillInputPortInformation (int port, vtkInformation *info)
 Fill the input port information objects for this algorithm.
 
virtual int FillOutputPortInformation (int port, vtkInformation *info)
 Fill the output port information objects for this algorithm.
 
virtual void SetNumberOfInputPorts (int n)
 Set the number of input ports used by the algorithm.
 
virtual void SetNumberOfOutputPorts (int n)
 Set the number of output ports provided by the algorithm.
 
int InputPortIndexInRange (int index, const char *action)
 
int OutputPortIndexInRange (int index, const char *action)
 
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
 Get the association of the actual data array for the input array specified by idx, this is only reasonable during the REQUEST_DATA pass.
 
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
 This method takes in an index (as specified in SetInputArrayToProcess) and a pipeline information vector.
 
virtual vtkExecutiveCreateDefaultExecutive ()
 Create a default executive.
 
void ReportReferences (vtkGarbageCollector *) override
 
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
 Replace the Nth connection on the given input port.
 
virtual void SetNumberOfInputConnections (int port, int n)
 Set the number of input connections on the given input port.
 
void SetInputDataInternal (int port, vtkDataObject *input)
 These methods are used by subclasses to implement methods to set data objects directly as input.
 
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.
 
int GetInputArrayAssociation (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
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.
 
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.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
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.
 
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.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
 Filters that have multiple connections on one port can use this signature.
 
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
 Filters that have multiple connections on one port can use this signature.
 
virtual void SetErrorCode (unsigned long)
 The error code contains a possible error that occurred while reading or writing the file.
 
- 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.
 
void InternalReleaseFocus ()
 These methods allow a command to exclusively grab all events.
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void RegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
virtual void ObjectFinalize ()
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

Internals * Implementation
 
- Protected Attributes inherited from vtkRenderedGraphRepresentation
char * VertexHoverArrayName
 
char * EdgeHoverArrayName
 
char * VertexColorArrayNameInternal
 
char * EdgeColorArrayNameInternal
 
char * ScalingArrayNameInternal
 
char * LayoutStrategyName
 
char * EdgeLayoutStrategyName
 
bool HideVertexLabelsOnInteraction
 
bool HideEdgeLabelsOnInteraction
 
bool EdgeSelection
 
vtkSmartPointer< vtkApplyColorsApplyColors
 Internal filter classes.
 
vtkSmartPointer< vtkVertexDegreeVertexDegree
 Internal filter classes.
 
vtkSmartPointer< vtkPolyDataEmptyPolyData
 Internal filter classes.
 
vtkSmartPointer< vtkEdgeCentersEdgeCenters
 Internal filter classes.
 
vtkSmartPointer< vtkGraphToPointsGraphToPoints
 Internal filter classes.
 
vtkSmartPointer< vtkPointSetToLabelHierarchyVertexLabelHierarchy
 Internal filter classes.
 
vtkSmartPointer< vtkPointSetToLabelHierarchyEdgeLabelHierarchy
 Internal filter classes.
 
vtkSmartPointer< vtkGraphLayoutLayout
 Internal filter classes.
 
vtkSmartPointer< vtkPerturbCoincidentVerticesCoincident
 Internal filter classes.
 
vtkSmartPointer< vtkEdgeLayoutEdgeLayout
 Internal filter classes.
 
vtkSmartPointer< vtkGraphToPolyDataGraphToPoly
 Internal filter classes.
 
vtkSmartPointer< vtkPolyDataMapperEdgeMapper
 Internal filter classes.
 
vtkSmartPointer< vtkActorEdgeActor
 Internal filter classes.
 
vtkSmartPointer< vtkGraphToGlyphsVertexGlyph
 Internal filter classes.
 
vtkSmartPointer< vtkPolyDataMapperVertexMapper
 Internal filter classes.
 
vtkSmartPointer< vtkActorVertexActor
 Internal filter classes.
 
vtkSmartPointer< vtkGraphToGlyphsOutlineGlyph
 Internal filter classes.
 
vtkSmartPointer< vtkPolyDataMapperOutlineMapper
 Internal filter classes.
 
vtkSmartPointer< vtkActorOutlineActor
 Internal filter classes.
 
vtkSmartPointer< vtkScalarBarWidgetVertexScalarBar
 Internal filter classes.
 
vtkSmartPointer< vtkScalarBarWidgetEdgeScalarBar
 Internal filter classes.
 
vtkSmartPointer< vtkRemoveHiddenDataRemoveHiddenGraph
 Internal filter classes.
 
vtkSmartPointer< vtkApplyIconsApplyVertexIcons
 Internal filter classes.
 
vtkSmartPointer< vtkGraphToPointsVertexIconPoints
 Internal filter classes.
 
vtkSmartPointer< vtkTransformCoordinateSystemsVertexIconTransform
 Internal filter classes.
 
vtkSmartPointer< vtkIconGlyphFilterVertexIconGlyph
 Internal filter classes.
 
vtkSmartPointer< vtkPolyDataMapper2DVertexIconMapper
 Internal filter classes.
 
vtkSmartPointer< vtkTexturedActor2DVertexIconActor
 Internal filter classes.
 
- Protected Attributes inherited from vtkRenderedRepresentation
int LabelRenderMode
 
- Protected Attributes inherited from vtkDataRepresentation
bool Selectable
 
int SelectionType
 The selection type created by the view.
 
vtkStringArraySelectionArrayNames
 If a VALUES selection, the array names used in the selection.
 
CommandObserver
 
vtkAnnotationLinkAnnotationLinkInternal
 The annotation link for this representation.
 
- Protected Attributes inherited from vtkAlgorithm
vtkTimeStamp LastAbortCheckTime
 
vtkInformationInformation
 
double Progress
 
char * ProgressText
 
vtkProgressObserverProgressObserver
 
unsigned long ErrorCode
 The error code contains a possible error that occurred while reading or writing the file.
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
std::string ObjectName
 
- Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t > ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Additional Inherited Members

- Public Attributes inherited from vtkAlgorithm
std::atomic< vtkTypeBoolAbortExecute
 
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
 
- Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
 
static vtkReallocingFunction GetCurrentReallocFunction ()
 
static vtkFreeingFunction GetCurrentFreeFunction ()
 
static vtkFreeingFunction GetAlternateFreeFunction ()
 
- Static Protected Attributes inherited from vtkAlgorithm
static vtkTimeStamp LastAbortTime
 
static vtkExecutiveDefaultExecutivePrototype
 

Detailed Description

Tests:
vtkRenderedHierarchyRepresentation (Tests)

Definition at line 20 of file vtkRenderedHierarchyRepresentation.h.

Member Typedef Documentation

◆ Superclass

Definition at line 25 of file vtkRenderedHierarchyRepresentation.h.

Constructor & Destructor Documentation

◆ vtkRenderedHierarchyRepresentation()

vtkRenderedHierarchyRepresentation::vtkRenderedHierarchyRepresentation ( )
protected

◆ ~vtkRenderedHierarchyRepresentation()

vtkRenderedHierarchyRepresentation::~vtkRenderedHierarchyRepresentation ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkRenderedHierarchyRepresentation * vtkRenderedHierarchyRepresentation::New ( )
static

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkRenderedHierarchyRepresentation::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 vtkRenderedGraphRepresentation.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkRenderedHierarchyRepresentation::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkRenderedGraphRepresentation.

◆ NewInstance()

vtkRenderedHierarchyRepresentation * vtkRenderedHierarchyRepresentation::NewInstance ( ) const

◆ PrintSelf()

void vtkRenderedHierarchyRepresentation::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 vtkRenderedGraphRepresentation.

◆ SetGraphEdgeLabelArrayName() [1/2]

virtual void vtkRenderedHierarchyRepresentation::SetGraphEdgeLabelArrayName ( const char *  name)
inlinevirtual

Definition at line 32 of file vtkRenderedHierarchyRepresentation.h.

◆ SetGraphEdgeLabelArrayName() [2/2]

virtual void vtkRenderedHierarchyRepresentation::SetGraphEdgeLabelArrayName ( const char *  name,
int  idx 
)
virtual

◆ GetGraphEdgeLabelArrayName() [1/2]

virtual const char * vtkRenderedHierarchyRepresentation::GetGraphEdgeLabelArrayName ( )
inlinevirtual

Definition at line 37 of file vtkRenderedHierarchyRepresentation.h.

◆ GetGraphEdgeLabelArrayName() [2/2]

virtual const char * vtkRenderedHierarchyRepresentation::GetGraphEdgeLabelArrayName ( int  idx)
virtual

◆ SetGraphEdgeLabelVisibility() [1/2]

virtual void vtkRenderedHierarchyRepresentation::SetGraphEdgeLabelVisibility ( bool  vis)
inlinevirtual

Definition at line 41 of file vtkRenderedHierarchyRepresentation.h.

◆ SetGraphEdgeLabelVisibility() [2/2]

virtual void vtkRenderedHierarchyRepresentation::SetGraphEdgeLabelVisibility ( bool  vis,
int  idx 
)
virtual

◆ GetGraphEdgeLabelVisibility() [1/2]

virtual bool vtkRenderedHierarchyRepresentation::GetGraphEdgeLabelVisibility ( )
inlinevirtual

Definition at line 43 of file vtkRenderedHierarchyRepresentation.h.

◆ GetGraphEdgeLabelVisibility() [2/2]

virtual bool vtkRenderedHierarchyRepresentation::GetGraphEdgeLabelVisibility ( int  idx)
virtual

◆ GraphEdgeLabelVisibilityOn()

virtual void vtkRenderedHierarchyRepresentation::GraphEdgeLabelVisibilityOn ( )
virtual

◆ GraphEdgeLabelVisibilityOff()

virtual void vtkRenderedHierarchyRepresentation::GraphEdgeLabelVisibilityOff ( )
virtual

◆ SetGraphEdgeColorArrayName() [1/2]

virtual void vtkRenderedHierarchyRepresentation::SetGraphEdgeColorArrayName ( const char *  name)
inlinevirtual

Definition at line 47 of file vtkRenderedHierarchyRepresentation.h.

◆ SetGraphEdgeColorArrayName() [2/2]

virtual void vtkRenderedHierarchyRepresentation::SetGraphEdgeColorArrayName ( const char *  name,
int  idx 
)
virtual

◆ GetGraphEdgeColorArrayName() [1/2]

virtual const char * vtkRenderedHierarchyRepresentation::GetGraphEdgeColorArrayName ( )
inlinevirtual

Definition at line 52 of file vtkRenderedHierarchyRepresentation.h.

◆ GetGraphEdgeColorArrayName() [2/2]

virtual const char * vtkRenderedHierarchyRepresentation::GetGraphEdgeColorArrayName ( int  idx)
virtual

◆ SetColorGraphEdgesByArray() [1/2]

virtual void vtkRenderedHierarchyRepresentation::SetColorGraphEdgesByArray ( bool  vis)
inlinevirtual

Definition at line 55 of file vtkRenderedHierarchyRepresentation.h.

◆ SetColorGraphEdgesByArray() [2/2]

virtual void vtkRenderedHierarchyRepresentation::SetColorGraphEdgesByArray ( bool  vis,
int  idx 
)
virtual

◆ GetColorGraphEdgesByArray() [1/2]

virtual bool vtkRenderedHierarchyRepresentation::GetColorGraphEdgesByArray ( )
inlinevirtual

Definition at line 57 of file vtkRenderedHierarchyRepresentation.h.

◆ GetColorGraphEdgesByArray() [2/2]

virtual bool vtkRenderedHierarchyRepresentation::GetColorGraphEdgesByArray ( int  idx)
virtual

◆ ColorGraphEdgesByArrayOn()

virtual void vtkRenderedHierarchyRepresentation::ColorGraphEdgesByArrayOn ( )
virtual

◆ ColorGraphEdgesByArrayOff()

virtual void vtkRenderedHierarchyRepresentation::ColorGraphEdgesByArrayOff ( )
virtual

◆ SetGraphEdgeColorToSplineFraction() [1/2]

virtual void vtkRenderedHierarchyRepresentation::SetGraphEdgeColorToSplineFraction ( )
inlinevirtual

Definition at line 61 of file vtkRenderedHierarchyRepresentation.h.

◆ SetGraphEdgeColorToSplineFraction() [2/2]

virtual void vtkRenderedHierarchyRepresentation::SetGraphEdgeColorToSplineFraction ( int  idx)
inlinevirtual

Definition at line 65 of file vtkRenderedHierarchyRepresentation.h.

◆ SetGraphVisibility() [1/2]

virtual void vtkRenderedHierarchyRepresentation::SetGraphVisibility ( bool  vis)
inlinevirtual

Definition at line 70 of file vtkRenderedHierarchyRepresentation.h.

◆ SetGraphVisibility() [2/2]

virtual void vtkRenderedHierarchyRepresentation::SetGraphVisibility ( bool  vis,
int  idx 
)
virtual

◆ GetGraphVisibility() [1/2]

virtual bool vtkRenderedHierarchyRepresentation::GetGraphVisibility ( )
inlinevirtual

Definition at line 72 of file vtkRenderedHierarchyRepresentation.h.

◆ GetGraphVisibility() [2/2]

virtual bool vtkRenderedHierarchyRepresentation::GetGraphVisibility ( int  idx)
virtual

◆ GraphVisibilityOn()

virtual void vtkRenderedHierarchyRepresentation::GraphVisibilityOn ( )
virtual

◆ GraphVisibilityOff()

virtual void vtkRenderedHierarchyRepresentation::GraphVisibilityOff ( )
virtual

◆ SetBundlingStrength() [1/2]

virtual void vtkRenderedHierarchyRepresentation::SetBundlingStrength ( double  strength)
inlinevirtual

Definition at line 76 of file vtkRenderedHierarchyRepresentation.h.

◆ SetBundlingStrength() [2/2]

virtual void vtkRenderedHierarchyRepresentation::SetBundlingStrength ( double  strength,
int  idx 
)
virtual

◆ GetBundlingStrength() [1/2]

virtual double vtkRenderedHierarchyRepresentation::GetBundlingStrength ( )
inlinevirtual

Definition at line 78 of file vtkRenderedHierarchyRepresentation.h.

◆ GetBundlingStrength() [2/2]

virtual double vtkRenderedHierarchyRepresentation::GetBundlingStrength ( int  idx)
virtual

◆ SetGraphSplineType()

virtual void vtkRenderedHierarchyRepresentation::SetGraphSplineType ( int  type,
int  idx 
)
virtual

Sets the spline type for the graph edges.

vtkSplineGraphEdges::CUSTOM uses a vtkCardinalSpline. vtkSplineGraphEdges::BSPLINE uses a b-spline. The default is BSPLINE.

◆ GetGraphSplineType()

virtual int vtkRenderedHierarchyRepresentation::GetGraphSplineType ( int  idx)
virtual

Sets the spline type for the graph edges.

vtkSplineGraphEdges::CUSTOM uses a vtkCardinalSpline. vtkSplineGraphEdges::BSPLINE uses a b-spline. The default is BSPLINE.

◆ SetGraphEdgeLabelFontSize() [1/2]

virtual void vtkRenderedHierarchyRepresentation::SetGraphEdgeLabelFontSize ( int  size)
inlinevirtual

Definition at line 92 of file vtkRenderedHierarchyRepresentation.h.

◆ SetGraphEdgeLabelFontSize() [2/2]

virtual void vtkRenderedHierarchyRepresentation::SetGraphEdgeLabelFontSize ( int  size,
int  idx 
)
virtual

◆ GetGraphEdgeLabelFontSize() [1/2]

virtual int vtkRenderedHierarchyRepresentation::GetGraphEdgeLabelFontSize ( )
inlinevirtual

Definition at line 94 of file vtkRenderedHierarchyRepresentation.h.

◆ GetGraphEdgeLabelFontSize() [2/2]

virtual int vtkRenderedHierarchyRepresentation::GetGraphEdgeLabelFontSize ( int  idx)
virtual

◆ AddToView()

bool vtkRenderedHierarchyRepresentation::AddToView ( vtkView view)
overrideprotected

Called by the view to add/remove this representation.

◆ RemoveFromView()

bool vtkRenderedHierarchyRepresentation::RemoveFromView ( vtkView view)
overrideprotected

Called by the view to add/remove this representation.

◆ ValidIndex()

bool vtkRenderedHierarchyRepresentation::ValidIndex ( int  idx)
protected

Whether idx is a valid graph index.

◆ ConvertSelection()

vtkSelection * vtkRenderedHierarchyRepresentation::ConvertSelection ( vtkView view,
vtkSelection selection 
)
overrideprotectedvirtual

Convert the selection to a type appropriate for sharing with other representations through vtkAnnotationLink, possibly using the view.

For the superclass, we just return the same selection. Subclasses may do something more fancy, like convert the selection from a frustrum to a list of pedigree ids. If the selection cannot be applied to this representation, return nullptr.

Reimplemented from vtkRenderedGraphRepresentation.

◆ FillInputPortInformation()

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

Fill the input port information objects for this algorithm.

This is invoked by the first call to GetInputPortInformation for each port so subclasses can specify what they can handle.

Reimplemented from vtkPassInputTypeAlgorithm.

◆ RequestData()

int vtkRenderedHierarchyRepresentation::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
overrideprotectedvirtual

Sets up the input connections for this representation.

Reimplemented from vtkRenderedGraphRepresentation.

◆ ApplyViewTheme()

void vtkRenderedHierarchyRepresentation::ApplyViewTheme ( vtkViewTheme theme)
overrideprotected

Member Data Documentation

◆ Implementation

Internals* vtkRenderedHierarchyRepresentation::Implementation
protected

Definition at line 127 of file vtkRenderedHierarchyRepresentation.h.


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