VTK  9.7.20261119
vtkPlotRadViz Class Reference

#include <vtkPlotRadViz.h>

Detailed Description

Radial plot of multivariate data that shows the relations among these variables.

Radial plot of multivariate data (a tuple with multiple components corresponds to a point) that shows the relations among these variables (components). The plot accepts either a vtkTable, whose visible columns must have one component, or a vtkDataSet as input. It uses vtkMultiVariateToRGBA to compute the point generalized barycentric coordinates (GBC) and the color (RGBA) for a tuple. The point position and color represent the normalized value of each component in relation to each other while the opacity represents the average normalized value for all components. For example, in three-component data, both (0.1, 0.1, 0.2) and (0.4, 0.4, 0.8) will have the same point position and color but the second point will be 4 times more opaque.

You can specify a partition of the set of components in groups (subsets) (see SetPartitionIndices) so that components in each group (subset) are normalized together. By default, all components are in one group. This can be used when value ranges of different components are very different.

You can show an HSL (hue, saturation and lightness=0.55) ColorWheel (ColorWheelVisibility) that shows the color computed for a point at that position using the same computation as for vtkMultiVariateToRGBA.

Alternatively, you can use ScalarVisibility to show the color on the points. If ScalarVisibility is off, all points use the color of the pen. The opacity of the points is computed from the data in both cases, the opacity of the pen is not used.

The components are shown as vertices on the outer circle outline of the plot. The first vertex is at the top and the following vertices are placed clockwise, in the same order as the colors of the color wheel (see VerticesClockwiseOrdering). The vertices can be rotated using VerticesRotation, which changes the points' positions and colors.

Points' opacity can be further modified using a lens which modifies the opacity of the points outside the lens (see OutsideLensAlpha). By default the lens does not change the points' opacity. The lens can be shown or hidden using LensVisibility.

The implementation is based on the paper: RadViz Deluxe: An Attribute-Aware Display for Multivariate Data. Shenghui Cheng, Wei Xu and Klaus Mueller.

See also
vtkChartRadViz, vtkMultiVariateToRGBA
vtkPlotParallelCoordinates
Tests:
vtkPlotRadViz (Tests)

Definition at line 92 of file vtkPlotRadViz.h.

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

Public Types

typedef vtkPlot Superclass
Public Types inherited from vtkPlot
typedef vtkContextItem Superclass
Public Types inherited from vtkContextItem
typedef vtkAbstractContextItem Superclass
Public Types inherited from vtkAbstractContextItem
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.
vtkPlotRadViz * NewInstance () const
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses.
virtual void SetInputDataSet (vtkDataSet *dataset)
void SetInputArray (int index, const vtkStdString &name) override
 Selects the array 'name' of a dataset input for index 0, searching the point data then the cell data, or the active scalars, the default, for an empty name.
vtkStringArray * GetLabels () override
 Returns the labels set with SetLabels(), or nullptr.
bool Paint (vtkContext2D *painter) override
 Paint event for the item.
const double * GetSceneCenter () const
 Center of the plot in scene coordinates.
double GetSceneRadius () const
 Radius of the plot in scene coordinates.
void SetVariableVisibility (const std::string &name, bool visible)
 Variable visibility, by name or index.
void SetVariableVisibility (int index, bool visible)
 Variable visibility, by name or index.
void SetVariableVisibilityAll (bool visible)
 Variable visibility, by name or index.
bool GetVariableVisibility (const std::string &name)
 Variable visibility, by name or index.
bool GetVariableVisibility (int index)
 Variable visibility, by name or index.
vtkStringArray * GetVisibleVariables ()
 Variable visibility, by name or index.
void SetVisibleVariables (vtkStringArray *names)
 Variable visibility, by name or index.
bool GetVariablesVisibleByDefault () VTK_FUTURE_CONST
 Variable visibility, by name or index.
void SetVariablesVisibleByDefault (bool visible)
 Variable visibility, by name or index.
std::vector< std::string > GetNameVisibilityExceptions () VTK_FUTURE_CONST
 Variable visibility, by name or index.
void SetNameVisibilityExceptions (const std::vector< std::string > &names)
 Variable visibility, by name or index.
std::vector< int > GetIndexVisibilityExceptions () VTK_FUTURE_CONST
 Variable visibility, by name or index.
void SetIndexVisibilityExceptions (const std::vector< int > &indices)
 Variable visibility, by name or index.
void SetVisibleVariableIndices (const std::vector< int > &indices)
 Variable visibility, by name or index.
std::vector< int > GetVisibleVariableIndices ()
 Variable visibility, by name or index.
void ResetVisibleVariableIndices ()
 Variable visibility, by name or index.
void AddVisibleVariableIndex (int index)
 Variable visibility, by name or index.
void SetDimensions (int arg1, int arg2, int arg3, int arg4)
 Set/Get the bounding box of the plot.
void SetDimensions (const int arg[4])
 Set/Get the bounding box of the plot.
virtual int * GetDimensions ()
 Set/Get the bounding box of the plot.
virtual void GetDimensions (int &, int &, int &, int &)
 Set/Get the bounding box of the plot.
virtual void GetDimensions (int[4])
 Set/Get the bounding box of the plot.
virtual void SetColorWheelSegmentCount (int)
 Number of segments used when drawing the color wheel.
virtual int GetColorWheelSegmentCount ()
 Number of segments used when drawing the color wheel.
virtual void SetColorWheelRingCount (int)
 Number of concentric rings used when drawing the color wheel.
virtual int GetColorWheelRingCount ()
 Number of concentric rings used when drawing the color wheel.
virtual void SetColorWheelVisibility (bool)
 Show the color wheel if true, hide it otherwise.
virtual bool GetColorWheelVisibility ()
 Show the color wheel if true, hide it otherwise.
virtual void ColorWheelVisibilityOn ()
 Show the color wheel if true, hide it otherwise.
virtual void ColorWheelVisibilityOff ()
 Show the color wheel if true, hide it otherwise.
virtual void SetScalarVisibility (bool)
 Turn on/off flag to control whether scalar data is used to color objects.
virtual bool GetScalarVisibility ()
 Turn on/off flag to control whether scalar data is used to color objects.
virtual void ScalarVisibilityOn ()
 Turn on/off flag to control whether scalar data is used to color objects.
virtual void ScalarVisibilityOff ()
 Turn on/off flag to control whether scalar data is used to color objects.
virtual void SetMarkerOutlineWidth (double)
 Width in pixels of the black outline drawn around the data points and the vertices.
virtual double GetMarkerOutlineWidth ()
 Width in pixels of the black outline drawn around the data points and the vertices.
virtual void SetVerticesPen (vtkPen *)
 Controls how the vertices are drawn.
virtual vtkPen * GetVerticesPen ()
 Controls how the vertices are drawn.
virtual vtkPoints2D * GetVertices ()
 Return the vertex positions of the plot.
virtual void SetVerticesRotation (double rotation)
 Angle in degrees to rotate the vertices encoding the multivariate attributes.
virtual double GetVerticesRotation ()
 Controls how the vertices are drawn.
virtual void SetVerticesClockwiseOrdering (bool)
 If true, the vertices are placed clockwise, otherwise counter-clockwise.
virtual bool GetVerticesClockwiseOrdering ()
 If true, the vertices are placed clockwise, otherwise counter-clockwise.
virtual void VerticesClockwiseOrderingOn ()
 If true, the vertices are placed clockwise, otherwise counter-clockwise.
virtual void VerticesClockwiseOrderingOff ()
 If true, the vertices are placed clockwise, otherwise counter-clockwise.
virtual void SetLensCenter (double, double)
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
void SetLensCenter (double[2])
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual double * GetLensCenter ()
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual void GetLensCenter (double &, double &)
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual void GetLensCenter (double[2])
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual void SetLensRadius (double radius)
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual double GetLensRadius ()
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual void SetSceneLensCenter (const double *center)
 Center of the lens in scene coordinates.
double * GetSceneLensCenter ()
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual void SetSceneLensRadius (double radius)
 Radius of the lens in scene coordinates, see SetSceneLensCenter, including why these functions are excluded from serialization.
double GetSceneLensRadius ()
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual void SetLensPen (vtkPen *)
 Controls how the lens circle outline is drawn.
virtual vtkPen * GetLensPen ()
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual void SetOutsideLensAlpha (double)
 Alpha (opacity) cap for points outside the lens.
virtual double GetOutsideLensAlpha ()
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual void SetLensVisibility (bool)
 Show the lens if true.
virtual bool GetLensVisibility ()
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual void LensVisibilityOn ()
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual void LensVisibilityOff ()
 Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).
virtual void SetActiveColor (vtkColor4ub)
 Color used for active vertex, active lens circle or active lens center.
virtual vtkColor4ub GetActiveColor ()
 Color used for active vertex, active lens circle or active lens center.
virtual void SetActiveVertexIndex (int)
 The index of the active vertex (mouse over it or rotating the vertices by dragging that vertex), -1 when no vertex is active.
virtual int GetActiveVertexIndex ()
 Color used for active vertex, active lens circle or active lens center.
virtual void SetActiveLensOutline (bool)
 Set to true when the mouse is over the lens outline or when the lens is resized and set to false otherwise.
virtual bool GetActiveLensOutline ()
 Color used for active vertex, active lens circle or active lens center.
virtual void SetActiveLensInterior (bool)
 Set to true when the mouse is over the lens interior or when the lens is dragged and set to false otherwise.
virtual bool GetActiveLensInterior ()
 Color used for active vertex, active lens circle or active lens center.
virtual void SetLabelsProperties (vtkTextProperty *)
 Get the vtkTextProperty that governs how the vertex labels are displayed.
virtual vtkTextProperty * GetLabelsProperties ()
 Get the vtkTextProperty that governs how the vertex labels are displayed.
void SetPartitionIndices (const std::vector< int > &partitionIndices)
 Variables can be partitioned into several groups.
std::vector< int > GetPartitionIndices () VTK_FUTURE_CONST
 Variables can be partitioned into several groups.
void SetPartitionOffsets (const std::vector< int > &partitionOffsets)
 Variables can be partitioned into several groups.
std::vector< int > GetPartitionOffsets () VTK_FUTURE_CONST
 Variables can be partitioned into several groups.
void ClearPartitionIndices ()
 Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().
void AddPartitionIndex (int index)
 Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().
void ClearPartitionOffsets ()
 Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().
void AddPartitionOffset (int offset)
 Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().
void SetCustomRange (const std::vector< double > &customRange)
 Custom ranges used as the global min/max when normalizing scalars, instead of the range computed from the data, one [min, max] range per partition group.
std::vector< double > GetCustomRange () VTK_FUTURE_CONST
 Custom ranges used as the global min/max when normalizing scalars, instead of the range computed from the data, one [min, max] range per partition group.
Public Member Functions inherited from vtkPlot
vtkPlot * NewInstance () const
void Update () override
 Perform any updates to the item that may be necessary before rendering.
virtual bool PaintLegend (vtkContext2D *painter, const vtkRectf &rect, int legendIndex)
 Paint legend event for the plot, called whenever the legend needs the plot items symbol/mark/line drawn.
virtual vtkStdString GetTooltipLabel (const vtkVector2d &plotPos, vtkIdType seriesIndex, vtkIdType segmentIndex)
 Generate and return the tooltip label string for this plot The segmentIndex parameter is ignored, except for vtkPlotBar.
virtual vtkIdType GetNearestPoint (const vtkVector2f &point, const vtkVector2f &tolerance, vtkVector2f *location, vtkIdType *segmentId)
 Function to query a plot for the nearest point to the specified coordinate.
virtual bool SelectPoints (const vtkVector2f &min, const vtkVector2f &max)
 Select all points in the specified rectangle.
virtual bool SelectPointsInPolygon (const vtkContextPolygon &polygon)
 Select all points in the specified polygon.
virtual void SetLabel (const vtkStdString &label)
 Set the label of this plot.
virtual vtkStdString GetLabel ()
 Get the label of this plot.
virtual void SetLabels (vtkStringArray *labels)
 Set the plot labels, these are used for stacked chart variants, with the index referring to the stacking index.
virtual int GetNumberOfLabels ()
 Get the number of labels associated with this plot.
vtkStdString GetLabel (vtkIdType index)
 Get the label at the specified index.
void SetIndexedLabels (vtkStringArray *labels)
 Set indexed labels for the plot.
virtual vtkStringArray * GetIndexedLabels ()
 Get the indexed labels array.
vtkContextMapper2D * GetData ()
 Get the data object that the plot will draw.
virtual vtkTable * GetInput ()
 Get the input table used by the plot.
vtkAlgorithmOutput * GetInputConnection ()
 Get the input connection used by the plot.
virtual void GetBounds (double bounds[4])
 Get the bounds for this plot as (Xmin, Xmax, Ymin, Ymax).
virtual void GetUnscaledInputBounds (double bounds[4])
 Provide un-log-scaled bounds for the plot inputs.
bool Hit (const vtkContextMouseEvent &mouse) override
 Returns true if the supplied x, y coordinate is inside the item.
virtual bool UpdateCache ()
 Update the internal cache.
virtual void SetLegendVisibility (bool)
 Set whether the plot renders an entry in the legend.
virtual bool GetLegendVisibility ()
 Set whether the plot renders an entry in the legend.
virtual void LegendVisibilityOn ()
 Set whether the plot renders an entry in the legend.
virtual void LegendVisibilityOff ()
 Set whether the plot renders an entry in the legend.
virtual void SetTooltipLabelFormat (const vtkStdString &label)
 Sets/gets a std::format or printf style string to build custom tooltip labels from.
virtual vtkStdString GetTooltipLabelFormat ()
 Sets/gets a std::format or printf style string to build custom tooltip labels from.
virtual void SetTooltipNotation (int notation)
 Sets/gets the tooltip notation style.
virtual int GetTooltipNotation ()
 Sets/gets the tooltip notation style.
virtual void SetTooltipPrecision (int precision)
 Sets/gets the tooltip precision.
virtual int GetTooltipPrecision ()
 Sets/gets the tooltip precision.
virtual void SetColor (unsigned char r, unsigned char g, unsigned char b, unsigned char a)
 Set the plot color with integer values (comprised between 0 and 255).
virtual void SetColor (unsigned char r, unsigned char g, unsigned char b)
 Set the plot color with integer values (comprised between 0 and 255).
virtual void SetColorF (double r, double g, double b, double a)
 Set the plot color with floating values (comprised between 0.0 and 1.0).
virtual void SetColorF (double r, double g, double b)
 Set the plot color with floating values (comprised between 0.0 and 1.0).
virtual void GetColor (unsigned char rgb[3])
 Get the plot color as integer rgb values (comprised between 0 and 255).
void GetColorRGBA (unsigned char rgba[4])
 Get the plot color as integer rgb values (comprised between 0 and 255).
virtual void GetColorF (double rgb[3])
 Get the plot color as floating rgb values (comprised between 0.0 and 1.0).
virtual void SetWidth (float width)
 @
virtual float GetWidth ()
 Get the width of the line.
void SetPen (vtkPen *pen)
 Set/get the vtkPen object that controls how this plot draws (out)lines.
vtkPen * GetPen ()
 Get the plot color as floating rgb values (comprised between 0.0 and 1.0).
void SetBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills shapes.
vtkBrush * GetBrush ()
 Set/get the vtkBrush object that controls how this plot fills shapes.
void SetSelectionPen (vtkPen *pen)
 Set/get the vtkBrush object that controls how this plot fills selected shapes.
vtkPen * GetSelectionPen ()
 Set/get the vtkBrush object that controls how this plot fills selected shapes.
void SetSelectionBrush (vtkBrush *brush)
 Set/get the vtkBrush object that controls how this plot fills selected shapes.
vtkBrush * GetSelectionBrush ()
 Set/get the vtkBrush object that controls how this plot fills selected shapes.
virtual bool GetUseIndexForXSeries ()
 Use the Y array index for the X value.
virtual void SetUseIndexForXSeries (bool)
 Use the Y array index for the X value.
virtual void SetInputData (vtkTable *table)
 This is a convenience function to set the input table and the x, y column for the plot.
virtual void SetInputData (vtkTable *table, const vtkStdString &xColumn, const vtkStdString &yColumn)
 This is a convenience function to set the input table and the x, y column for the plot.
void SetInputData (vtkTable *table, vtkIdType xColumn, vtkIdType yColumn)
 This is a convenience function to set the input table and the x, y column for the plot.
virtual void SetInputConnection (vtkAlgorithmOutput *input)
 This is a convenience function to set the input connection for the plot.
void SetXAxisInputArrayToProcess (const std::string &name)
 Convenient function to directly set/get the names of columns used for X and Y axis respectively.
std::string GetXAxisInputArrayToProcess ()
 Convenient function to directly set/get the names of columns used for X and Y axis respectively.
void SetYAxisInputArrayToProcess (const std::string &name)
 Convenient function to directly set/get the names of columns used for X and Y axis respectively.
std::string GetYAxisInputArrayToProcess ()
 Convenient function to directly set/get the names of columns used for X and Y axis respectively.
virtual void SetSelectable (bool)
 Set whether the plot can be selected.
virtual bool GetSelectable ()
 Set whether the plot can be selected.
virtual void SelectableOn ()
 Set whether the plot can be selected.
virtual void SelectableOff ()
 Set whether the plot can be selected.
virtual void SetSelection (vtkIdTypeArray *id)
 Sets the list of points that must be selected.
virtual vtkIdTypeArray * GetSelection ()
 Sets the list of points that must be selected.
virtual vtkAxis * GetXAxis ()
 Get/set the X axis associated with this plot.
virtual void SetXAxis (vtkAxis *axis)
 Get/set the X axis associated with this plot.
virtual vtkAxis * GetYAxis ()
 Get/set the Y axis associated with this plot.
virtual void SetYAxis (vtkAxis *axis)
 Get/set the Y axis associated with this plot.
void SetShiftScale (const vtkRectd &shiftScale)
 Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range.
vtkRectd GetShiftScale ()
 Get/set the origin shift and scaling factor used by the plot, this is normally 0.0 offset and 1.0 scaling, but can be used to render data outside of the single precision range.
virtual void SetProperty (const vtkStdString &property, const vtkVariant &var)
 A General setter/getter that should be overridden.
virtual vtkVariant GetProperty (const vtkStdString &property)
 A General setter/getter that should be overridden.
virtual bool ClampPos (double pos[2])
 Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise.
Public Member Functions inherited from vtkContextItem
vtkContextItem * NewInstance () const
virtual void SetTransform (vtkContextTransform *)
 Set the transform of the item.
virtual double GetOpacity ()
 Get the opacity of the item.
virtual void SetOpacity (double)
 Set the opacity of the item.
Public Member Functions inherited from vtkAbstractContextItem
vtkAbstractContextItem * NewInstance () const
virtual bool PaintChildren (vtkContext2D *painter)
 Paint the children of the item, should be called whenever the children need to be rendered.
virtual void ReleaseGraphicsResources ()
 Release graphics resources hold by the item.
virtual vtkIdType AddItem (vtkAbstractContextItem *item)
 Add child items to this item.
bool RemoveItem (vtkAbstractContextItem *item)
 Remove child item from this item.
bool RemoveItem (vtkIdType index)
 Remove child item from this item.
virtual vtkAbstractContextItem * GetItem (vtkIdType index)
 Get the item at the specified index.
vtkIdType GetItemIndex (vtkAbstractContextItem *item)
 Get the index of the specified item in itemIndex.
vtkIdType GetNumberOfItems () VTK_FUTURE_CONST
 Get the number of child items.
void ClearItems ()
 Remove all child items from this item.
vtkIdType Raise (vtkIdType index)
 Raises the child to the top of the item's stack.
virtual vtkIdType StackAbove (vtkIdType index, vtkIdType under)
 Raises the child above the under sibling.
vtkIdType Lower (vtkIdType index)
 Lowers the child to the bottom of the item's stack.
virtual vtkIdType StackUnder (vtkIdType child, vtkIdType above)
 Lowers the child under the above sibling.
virtual vtkAbstractContextItem * GetPickedItem (const vtkContextMouseEvent &mouse)
 Return the item under the mouse.
virtual bool MouseEnterEvent (const vtkContextMouseEvent &mouse)
 Mouse enter event.
virtual bool MouseMoveEvent (const vtkContextMouseEvent &mouse)
 Mouse move event.
virtual bool MouseLeaveEvent (const vtkContextMouseEvent &mouse)
 Mouse leave event.
virtual bool MouseButtonPressEvent (const vtkContextMouseEvent &mouse)
 Mouse button down event Return true if the item holds the event, false if the event can be propagated to other items.
virtual bool MouseButtonReleaseEvent (const vtkContextMouseEvent &mouse)
 Mouse button release event.
virtual bool MouseDoubleClickEvent (const vtkContextMouseEvent &mouse)
 Mouse button double click event.
virtual bool MouseWheelEvent (const vtkContextMouseEvent &mouse, int delta)
 Mouse wheel event, positive delta indicates forward movement of the wheel.
virtual bool KeyPressEvent (const vtkContextKeyEvent &key)
 Key press event.
virtual bool KeyReleaseEvent (const vtkContextKeyEvent &key)
 Key release event.
virtual void SetScene (vtkContextScene *scene)
 Set the vtkContextScene for the item, always set for an item in a scene.
vtkContextScene * GetScene ()
 Get the vtkContextScene for the item, always set for an item in a scene.
virtual void SetParent (vtkAbstractContextItem *parent)
 Set the parent item.
vtkAbstractContextItem * GetParent ()
 Get the parent item.
virtual vtkVector2f MapToParent (const vtkVector2f &point)
 Maps the point to the parent coordinate system.
virtual vtkVector2f MapFromParent (const vtkVector2f &point)
 Maps the point from the parent coordinate system.
virtual vtkVector2f MapToScene (const vtkVector2f &point)
 Maps the point to the scene coordinate system.
virtual vtkVector2f MapFromScene (const vtkVector2f &point)
 Maps the point from the scene coordinate system.
virtual bool GetVisible ()
 Get the visibility of the item (should it be drawn).
virtual void SetVisible (bool)
 Set the visibility of the item (should it be drawn).
virtual bool GetInteractive ()
 Get if the item is interactive (should respond to mouse events).
virtual void SetInteractive (bool)
 Set if the item is interactive (should respond to mouse events).
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 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.
vtkCommand * GetCommand (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 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.
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not.

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
static vtkPlotRadViz * SafeDownCast (vtkObjectBase *o)
static vtkPlotRadViz * New ()
static int GetColorWheelStartAngle ()
 Angle in degrees at which the starting color (red) is placed on the color wheel.
static bool GetColorWheelClockwiseOrdering ()
 Colors are laid out in clockwise order if true, counter-clockwise otherwise.
Static Public Member Functions inherited from vtkPlot
static vtkTypeBool IsTypeOf (const char *type)
static vtkPlot * SafeDownCast (vtkObjectBase *o)
static void FilterSelectedPoints (vtkDataArray *points, vtkDataArray *selectedPoints, vtkIdTypeArray *selectedIds)
 Utility function that fills up selectedPoints with tuples from points.
static bool ClampPos (double pos[2], double bounds[4])
 Clamp the given 2D pos into the provided bounds Return true if the pos has been clamped, false otherwise.
Static Public Member Functions inherited from vtkContextItem
static vtkTypeBool IsTypeOf (const char *type)
static vtkContextItem * SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAbstractContextItem
static vtkTypeBool IsTypeOf (const char *type)
static vtkAbstractContextItem * SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkObject
static vtkObject * New ()
 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 vtkObjectBase * New ()
 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 vtkObjectBase * NewInstanceInternal () const
 vtkPlotRadViz ()
 ~vtkPlotRadViz () override
void DrawColorWheel (vtkContext2D *painter)
vtkSmartPointer< vtkPoints2D > DrawColoredMarkers (vtkContext2D *painter, vtkDataArray *points, vtkPen *pen, vtkDataArray *color=nullptr)
 Draw the points using the 'pen' attributes and 'color' instead of the 'pen' color.
vtkSmartPointer< vtkPoints2D > DrawMarkers (vtkContext2D *painter, vtkDataArray *points, vtkPen *pen, int activeIndex=-1)
 Draw the points using the 'pen' attributes.
void DrawLabels (vtkContext2D *painter, vtkDataArray *vertices, vtkPen *pen)
void DrawLens (vtkContext2D *painter)
void ComputeVisibleLabels ()
 Computes VisibleLabels from the visible variables.
void UpdateFilterInput ()
 Updates the producer of the plot input, then passes the input and the array selection of the plot to ComputeGBC, so that it computes, and reports the variables of, the current plot input.
void UpdateCenterAndRadius (vtkContext2D *painter)
 Recomputes the plot circle's center and radius from Dimensions, shrinking the radius so that there is enough room around the circle for the vertex labels (measured using LabelsProperties and painter) to fit within Dimensions without being clipped.
vtkSmartPointer< vtkPoints2D > TransformPoints (vtkDataArray *points)
vtkSmartPointer< vtkUnsignedCharArray > TransformColors (vtkDataArray *rgba)
vtkSmartPointer< vtkDoubleArray > ApplyPenColor (vtkPen *pen, vtkDataArray *rgba)
 Returns a per-point RGBA array using 'pen' color for RGB and 'rgba's A component for alpha.
void ShiftLabelByPenWidth (double width, double transformedXy[2])
Protected Member Functions inherited from vtkPlot
 vtkPlot ()
 ~vtkPlot () override
vtkStdString GetNumber (double position, vtkAxis *axis)
 Get the properly formatted number for the supplied position and axis.
virtual bool CacheRequiresUpdate ()
 Test if the internal cache requires an update.
virtual void TransformScreenToData (const vtkVector2f &in, vtkVector2f &out)
 Transform the mouse event in the control-points space.
virtual void TransformDataToScreen (const vtkVector2f &in, vtkVector2f &out)
 Transform the mouse event in the control-points space.
virtual void TransformScreenToData (double inX, double inY, double &outX, double &outY)
 Transform the mouse event in the control-points space.
virtual void TransformDataToScreen (double inX, double inY, double &outX, double &outY)
 Transform the mouse event in the control-points space.
Protected Member Functions inherited from vtkContextItem
 vtkContextItem ()=default
 ~vtkContextItem () override
Protected Member Functions inherited from vtkAbstractContextItem
 vtkAbstractContextItem ()
 ~vtkAbstractContextItem () override
virtual void ReleaseGraphicsCache ()
 Release cache entries created by this context item.
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 ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Static Protected Member Functions

static std::pair< int, int > GetJustification (double xy[2])
 Returns the horizontal and vertical text justification for xy coordinates.
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction GetCurrentMallocFunction ()
static vtkReallocingFunction GetCurrentReallocFunction ()
static vtkFreeingFunction GetCurrentFreeFunction ()
static vtkFreeingFunction GetAlternateFreeFunction ()

Protected Attributes

int Dimensions [4] = { 0, 0, 0, 0 }
vtkSmartPointer< vtkPen > VerticesPen = vtkSmartPointer<vtkPen>::New()
 Controls how the vertices are drawn.
double MarkerOutlineWidth = 1.0
 Width of the black outline of the markers.
vtkSmartPointer< vtkPen > LensPen = vtkSmartPointer<vtkPen>::New()
 Controls how the lens circle outline is drawn.
vtkColor4ub ActiveColor = vtkColor4ub(255, 0, 0, 255)
 Pen used for active vertex, active lens circle or active lens center.
int ActiveVertexIndex = -1
 The index of the active vertex (mouse over it or rotating the vertices by dragging that vertex), -1 when no vertex is active.
bool ActiveLensOutline = false
 Set to true when the mouse is over the lens outline or when the lens is resized and set to false otherwise.
bool ActiveLensInterior = false
 Set to true when the mouse is over the lens interior or when the lens is dragged and set to false otherwise.
double OutsideLensAlpha = 1.0
 Alpha cap for points outside the lens.
bool LensVisibility = false
 Show the lens if true.
double LensCenter [2] = { 0.0, 0.0 }
 The lens in GBC space.
double LensRadius = 1.0
double SceneLensCenter [2] = { 0.0, 0.0 }
 Storage for GetSceneLensCenter().
vtkSmartPointer< vtkPoints2D > Vertices
double VerticesRotation = 0.0
bool VerticesClockwiseOrdering = true
vtkSmartPointer< vtkTextProperty > LabelsProperties = vtkSmartPointer<vtkTextProperty>::New()
 The text properties associated with the vertex labels.
vtkSmartPointer< vtkStringArray > VisibleLabels
 The label of each vertex: the labels set with SetLabels for the visible variables, or their names if SetLabels was not given one label per variable of the input.
int ColorWheelSegmentCount = 120
int ColorWheelRingCount = 16
bool ColorWheelVisibility = true
bool ScalarVisibility = false
vtkNew< vtkMultiVariateToRGBA > ComputeGBC
 Persistent filter used to compute the GBC/RGBA values, and that also owns the variable visibility configuration (see SetVariableVisibility).
Protected Attributes inherited from vtkPlot
vtkTimeStamp BuildTime
 The point cache is marked dirty until it has been initialized.
vtkSmartPointer< vtkPen > Pen
 This object stores the vtkPen that controls how the plot is drawn.
vtkSmartPointer< vtkBrush > Brush
 This object stores the vtkBrush that controls how the plot is drawn.
vtkSmartPointer< vtkPen > SelectionPen
 This object stores the vtkPen that controls how the selected elements of the plot are drawn.
vtkSmartPointer< vtkBrush > SelectionBrush
 This object stores the vtkBrush that controls how the selected elements of the plot are drawn.
vtkSmartPointer< vtkStringArray > Labels
 Plot labels, used by legend.
vtkSmartPointer< vtkStringArray > AutoLabels
 Holds Labels when they're auto-created.
vtkSmartPointer< vtkStringArray > IndexedLabels
 Holds Labels when they're auto-created.
bool UseIndexForXSeries
 Use the Y array index for the X value.
vtkSmartPointer< vtkContextMapper2D > Data
 This data member contains the data that will be plotted, it inherits from vtkAlgorithm.
bool Selectable
 Whether plot points can be selected or not.
vtkIdTypeArray * Selection
 Selected indices for the table the plot is rendering.
vtkAxis * XAxis
 The X axis associated with this plot.
vtkAxis * YAxis
 The X axis associated with this plot.
vtkStdString TooltipLabelFormat
 A printf-style string to build custom tooltip labels from.
vtkStdString TooltipDefaultLabelFormat
 The default printf-style string to build custom tooltip labels from.
int TooltipNotation
int TooltipPrecision
vtkRectd ShiftScale
 The current shift in origin and scaling factor applied to the plot.
bool LegendVisibility
Protected Attributes inherited from vtkContextItem
double Opacity = 1.0
vtkContextTransform * Transform = nullptr
Protected Attributes inherited from vtkAbstractContextItem
vtkContextScene * Scene
 Point to the scene the item is on - can be null.
vtkAbstractContextItem * Parent
 Point to the parent item - can be null.
vtkContextScenePrivate * Children
 This structure provides a list of children, along with convenience functions to paint the children etc.
bool Visible
 Store the visibility of the item (default is true).
bool Interactive
 Store whether the item should respond to interactions (default is true).
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
std::tuple< vtkDataArray *, vtkDataArray *, vtkDataArray * > GetVerticesGbcRgba (vtkDataObject *output)
 Returns the arrays named 'vertices', 'gbc' and 'rgba' from a table or dataset, or throws std::runtime_error if not found.
static vtkDataArray * GetArray (vtkDataSetAttributes *attributes, const char *name)
 Returns the array 'name' of 'attributes' or throws std::runtime_error if the array is not found.

Member Typedef Documentation

◆ Superclass

Definition at line 95 of file vtkPlotRadViz.h.

Constructor & Destructor Documentation

◆ vtkPlotRadViz()

vtkPlotRadViz::vtkPlotRadViz ( )
protected

◆ ~vtkPlotRadViz()

vtkPlotRadViz::~vtkPlotRadViz ( )
overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

◆ IsA()

virtual vtkTypeBool vtkPlotRadViz::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 vtkPlot.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPlotRadViz::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPlot.

◆ NewInstance()

vtkPlotRadViz * vtkPlotRadViz::NewInstance ( ) const

◆ PrintSelf()

void vtkPlotRadViz::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 vtkPlot.

◆ New()

vtkPlotRadViz * vtkPlotRadViz::New ( )
static

◆ SetInputDataSet()

virtual void vtkPlotRadViz::SetInputDataSet ( vtkDataSet * dataset)
virtual

◆ SetInputArray()

void vtkPlotRadViz::SetInputArray ( int index,
const vtkStdString & name )
overridevirtual

Selects the array 'name' of a dataset input for index 0, searching the point data then the cell data, or the active scalars, the default, for an empty name.

A table input uses its columns instead.

Reimplemented from vtkPlot.

◆ GetLabels()

vtkStringArray * vtkPlotRadViz::GetLabels ( )
overridevirtual

Returns the labels set with SetLabels(), or nullptr.

Unlike vtkPlot, it does not fall back on labels computed from the input, so serialization saves and restores only the labels that were set.

Reimplemented from vtkPlot.

◆ Paint()

bool vtkPlotRadViz::Paint ( vtkContext2D * painter)
overridevirtual

Paint event for the item.

Reimplemented from vtkAbstractContextItem.

◆ SetVariableVisibility() [1/2]

void vtkPlotRadViz::SetVariableVisibility ( const std::string & name,
bool visible )

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ SetVariableVisibility() [2/2]

void vtkPlotRadViz::SetVariableVisibility ( int index,
bool visible )

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ SetVariableVisibilityAll()

void vtkPlotRadViz::SetVariableVisibilityAll ( bool visible)

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ GetVariableVisibility() [1/2]

bool vtkPlotRadViz::GetVariableVisibility ( const std::string & name)

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ GetVariableVisibility() [2/2]

bool vtkPlotRadViz::GetVariableVisibility ( int index)

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ GetVisibleVariables()

vtkStringArray * vtkPlotRadViz::GetVisibleVariables ( )

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ SetVisibleVariables()

void vtkPlotRadViz::SetVisibleVariables ( vtkStringArray * names)

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ GetVariablesVisibleByDefault()

bool vtkPlotRadViz::GetVariablesVisibleByDefault ( )

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ SetVariablesVisibleByDefault()

void vtkPlotRadViz::SetVariablesVisibleByDefault ( bool visible)

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ GetNameVisibilityExceptions()

std::vector< std::string > vtkPlotRadViz::GetNameVisibilityExceptions ( )

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ SetNameVisibilityExceptions()

void vtkPlotRadViz::SetNameVisibilityExceptions ( const std::vector< std::string > & names)

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ GetIndexVisibilityExceptions()

std::vector< int > vtkPlotRadViz::GetIndexVisibilityExceptions ( )

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ SetIndexVisibilityExceptions()

void vtkPlotRadViz::SetIndexVisibilityExceptions ( const std::vector< int > & indices)

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ SetVisibleVariableIndices()

void vtkPlotRadViz::SetVisibleVariableIndices ( const std::vector< int > & indices)

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ GetVisibleVariableIndices()

std::vector< int > vtkPlotRadViz::GetVisibleVariableIndices ( )

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ ResetVisibleVariableIndices()

void vtkPlotRadViz::ResetVisibleVariableIndices ( )

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ AddVisibleVariableIndex()

void vtkPlotRadViz::AddVisibleVariableIndex ( int index)

Variable visibility, by name or index.

Variables are the columns of an input table or the components of the array processed for an input dataset, and only the visible ones are used to compute the plot. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetVariableVisibility for details. Every variable of the input set with SetInputDataSet/SetInputData is visible by default, and non-numeric table columns are never visible. Labels set with SetLabels are one per variable of the input, in order, and only the ones of visible variables are drawn. If their number does not match, the variable names are drawn instead. ResetVisibleVariableIndices() and AddVisibleVariableIndex() are for the ParaView server manager XML, see vtkMultiVariateToRGBA::AddVisibleVariableIndex.

Serialization saves the visibility as stored (VariablesVisibleByDefault and the visibility exceptions, see vtkMultiVariateToRGBA), which does not depend on the input. The visible variables are a view of it, so they are excluded.

◆ SetDimensions() [1/2]

void vtkPlotRadViz::SetDimensions ( int arg1,
int arg2,
int arg3,
int arg4 )

Set/Get the bounding box of the plot.

Arguments 1 and 2 are the x and y coordinates of the bottom corner. Arguments 3 and 4 are the width and height. Set is called from vtkChartRadViz.

◆ SetDimensions() [2/2]

void vtkPlotRadViz::SetDimensions ( const int arg[4])

Set/Get the bounding box of the plot.

Arguments 1 and 2 are the x and y coordinates of the bottom corner. Arguments 3 and 4 are the width and height. Set is called from vtkChartRadViz.

◆ GetDimensions() [1/3]

virtual int * vtkPlotRadViz::GetDimensions ( )
virtual

Set/Get the bounding box of the plot.

Arguments 1 and 2 are the x and y coordinates of the bottom corner. Arguments 3 and 4 are the width and height. Set is called from vtkChartRadViz.

◆ GetDimensions() [2/3]

virtual void vtkPlotRadViz::GetDimensions ( int & ,
int & ,
int & ,
int &  )
virtual

Set/Get the bounding box of the plot.

Arguments 1 and 2 are the x and y coordinates of the bottom corner. Arguments 3 and 4 are the width and height. Set is called from vtkChartRadViz.

◆ GetDimensions() [3/3]

virtual void vtkPlotRadViz::GetDimensions ( int [4])
virtual

Set/Get the bounding box of the plot.

Arguments 1 and 2 are the x and y coordinates of the bottom corner. Arguments 3 and 4 are the width and height. Set is called from vtkChartRadViz.

◆ SetColorWheelSegmentCount()

virtual void vtkPlotRadViz::SetColorWheelSegmentCount ( int )
virtual

Number of segments used when drawing the color wheel.

More segments produce a smoother gradient. The default is 120.

◆ GetColorWheelSegmentCount()

virtual int vtkPlotRadViz::GetColorWheelSegmentCount ( )
virtual

Number of segments used when drawing the color wheel.

More segments produce a smoother gradient. The default is 120.

◆ SetColorWheelRingCount()

virtual void vtkPlotRadViz::SetColorWheelRingCount ( int )
virtual

Number of concentric rings used when drawing the color wheel.

More rings produce a smoother gradient from the center outward. The default is 16.

◆ GetColorWheelRingCount()

virtual int vtkPlotRadViz::GetColorWheelRingCount ( )
virtual

Number of concentric rings used when drawing the color wheel.

More rings produce a smoother gradient from the center outward. The default is 16.

◆ GetColorWheelStartAngle()

int vtkPlotRadViz::GetColorWheelStartAngle ( )
static

Angle in degrees at which the starting color (red) is placed on the color wheel.

It is read from vtkMultiVariateToRGBA, so that the color wheel matches the colors computed for the points.

◆ GetColorWheelClockwiseOrdering()

bool vtkPlotRadViz::GetColorWheelClockwiseOrdering ( )
static

Colors are laid out in clockwise order if true, counter-clockwise otherwise.

It is read from vtkMultiVariateToRGBA, so that the color wheel matches the colors computed for the points.

◆ SetColorWheelVisibility()

virtual void vtkPlotRadViz::SetColorWheelVisibility ( bool )
virtual

Show the color wheel if true, hide it otherwise.

Default is true.

◆ GetColorWheelVisibility()

virtual bool vtkPlotRadViz::GetColorWheelVisibility ( )
virtual

Show the color wheel if true, hide it otherwise.

Default is true.

◆ ColorWheelVisibilityOn()

virtual void vtkPlotRadViz::ColorWheelVisibilityOn ( )
virtual

Show the color wheel if true, hide it otherwise.

Default is true.

◆ ColorWheelVisibilityOff()

virtual void vtkPlotRadViz::ColorWheelVisibilityOff ( )
virtual

Show the color wheel if true, hide it otherwise.

Default is true.

◆ SetScalarVisibility()

virtual void vtkPlotRadViz::SetScalarVisibility ( bool )
virtual

Turn on/off flag to control whether scalar data is used to color objects.

The RGBA colors are automatically computed by vtkMultiVariateToRGBA. If off, the points use the color of the pen. The opacity of the points is the computed one (A) in both cases. Default is off.

◆ GetScalarVisibility()

virtual bool vtkPlotRadViz::GetScalarVisibility ( )
virtual

Turn on/off flag to control whether scalar data is used to color objects.

The RGBA colors are automatically computed by vtkMultiVariateToRGBA. If off, the points use the color of the pen. The opacity of the points is the computed one (A) in both cases. Default is off.

◆ ScalarVisibilityOn()

virtual void vtkPlotRadViz::ScalarVisibilityOn ( )
virtual

Turn on/off flag to control whether scalar data is used to color objects.

The RGBA colors are automatically computed by vtkMultiVariateToRGBA. If off, the points use the color of the pen. The opacity of the points is the computed one (A) in both cases. Default is off.

◆ ScalarVisibilityOff()

virtual void vtkPlotRadViz::ScalarVisibilityOff ( )
virtual

Turn on/off flag to control whether scalar data is used to color objects.

The RGBA colors are automatically computed by vtkMultiVariateToRGBA. If off, the points use the color of the pen. The opacity of the points is the computed one (A) in both cases. Default is off.

◆ SetMarkerOutlineWidth()

virtual void vtkPlotRadViz::SetMarkerOutlineWidth ( double )
virtual

Width in pixels of the black outline drawn around the data points and the vertices.

The outline is drawn inside the marker, so it does not change the marker size (the pen width). All outlines are drawn before all fills, so overlapping markers share one outline. Default is 1, use 0 for no outline.

◆ GetMarkerOutlineWidth()

virtual double vtkPlotRadViz::GetMarkerOutlineWidth ( )
virtual

Width in pixels of the black outline drawn around the data points and the vertices.

The outline is drawn inside the marker, so it does not change the marker size (the pen width). All outlines are drawn before all fills, so overlapping markers share one outline. Default is 1, use 0 for no outline.

◆ SetVerticesPen()

virtual void vtkPlotRadViz::SetVerticesPen ( vtkPen * )
virtual

Controls how the vertices are drawn.

Default is white, with a width (marker diameter) of 10.

◆ GetVerticesPen()

virtual vtkPen * vtkPlotRadViz::GetVerticesPen ( )
virtual

Controls how the vertices are drawn.

Default is white, with a width (marker diameter) of 10.

◆ GetVertices()

virtual vtkPoints2D * vtkPlotRadViz::GetVertices ( )
virtual

Return the vertex positions of the plot.

Valid after the first Paint.

◆ SetVerticesRotation()

virtual void vtkPlotRadViz::SetVerticesRotation ( double rotation)
virtual

Angle in degrees to rotate the vertices encoding the multivariate attributes.

Default is 0 degrees. This angle affects the GBC positions and the computed colors. The angle stored will be between [0, 360).

◆ GetVerticesRotation()

virtual double vtkPlotRadViz::GetVerticesRotation ( )
virtual

Controls how the vertices are drawn.

Default is white, with a width (marker diameter) of 10.

◆ SetVerticesClockwiseOrdering()

virtual void vtkPlotRadViz::SetVerticesClockwiseOrdering ( bool )
virtual

If true, the vertices are placed clockwise, otherwise counter-clockwise.

The first vertex is at the top in both cases, before VerticesRotation is applied. Default is true: the vertices follow the colors of the color wheel.

See also
vtkMultiVariateToRGBA

◆ GetVerticesClockwiseOrdering()

virtual bool vtkPlotRadViz::GetVerticesClockwiseOrdering ( )
virtual

If true, the vertices are placed clockwise, otherwise counter-clockwise.

The first vertex is at the top in both cases, before VerticesRotation is applied. Default is true: the vertices follow the colors of the color wheel.

See also
vtkMultiVariateToRGBA

◆ VerticesClockwiseOrderingOn()

virtual void vtkPlotRadViz::VerticesClockwiseOrderingOn ( )
virtual

If true, the vertices are placed clockwise, otherwise counter-clockwise.

The first vertex is at the top in both cases, before VerticesRotation is applied. Default is true: the vertices follow the colors of the color wheel.

See also
vtkMultiVariateToRGBA

◆ VerticesClockwiseOrderingOff()

virtual void vtkPlotRadViz::VerticesClockwiseOrderingOff ( )
virtual

If true, the vertices are placed clockwise, otherwise counter-clockwise.

The first vertex is at the top in both cases, before VerticesRotation is applied. Default is true: the vertices follow the colors of the color wheel.

See also
vtkMultiVariateToRGBA

◆ SetLensCenter() [1/2]

virtual void vtkPlotRadViz::SetLensCenter ( double ,
double  )
virtual

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ SetLensCenter() [2/2]

void vtkPlotRadViz::SetLensCenter ( double [2])

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ GetLensCenter() [1/3]

virtual double * vtkPlotRadViz::GetLensCenter ( )
virtual

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ GetLensCenter() [2/3]

virtual void vtkPlotRadViz::GetLensCenter ( double & ,
double &  )
virtual

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ GetLensCenter() [3/3]

virtual void vtkPlotRadViz::GetLensCenter ( double [2])
virtual

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ SetLensRadius()

virtual void vtkPlotRadViz::SetLensRadius ( double radius)
virtual

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ GetLensRadius()

virtual double vtkPlotRadViz::GetLensRadius ( )
virtual

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ SetSceneLensCenter()

virtual void vtkPlotRadViz::SetSceneLensCenter ( const double * center)
virtual

Center of the lens in scene coordinates.

Only valid once the plot has been painted: before that, the set function is ignored with a warning. The set function ensures that the lens intersects the GBC circle.

These functions are excluded from serialization: the GBC values (LensCenter, LensRadius) are the state and the scene values are a view of it. Only the state should be serialized.

◆ GetSceneLensCenter()

double * vtkPlotRadViz::GetSceneLensCenter ( )

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ SetSceneLensRadius()

virtual void vtkPlotRadViz::SetSceneLensRadius ( double radius)
virtual

Radius of the lens in scene coordinates, see SetSceneLensCenter, including why these functions are excluded from serialization.

◆ GetSceneLensRadius()

double vtkPlotRadViz::GetSceneLensRadius ( )

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ SetLensPen()

virtual void vtkPlotRadViz::SetLensPen ( vtkPen * )
virtual

Controls how the lens circle outline is drawn.

Its width is also the size of the lens center dot, which is shown only when ActiveLensInterior is true, using ActiveColor. Default is half-transparent red, with a width of 8.

◆ GetLensPen()

virtual vtkPen * vtkPlotRadViz::GetLensPen ( )
virtual

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ SetOutsideLensAlpha()

virtual void vtkPlotRadViz::SetOutsideLensAlpha ( double )
virtual

Alpha (opacity) cap for points outside the lens.

Each point's alpha is clamped to min(its alpha, OutsideLensAlpha). Default is 1 (points outside the lens keep their computed opacity). Set a lower value to fade or hide the points outside the lens.

◆ GetOutsideLensAlpha()

virtual double vtkPlotRadViz::GetOutsideLensAlpha ( )
virtual

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ SetLensVisibility()

virtual void vtkPlotRadViz::SetLensVisibility ( bool )
virtual

Show the lens if true.

Default is false.

◆ GetLensVisibility()

virtual bool vtkPlotRadViz::GetLensVisibility ( )
virtual

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ LensVisibilityOn()

virtual void vtkPlotRadViz::LensVisibilityOn ( )
virtual

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ LensVisibilityOff()

virtual void vtkPlotRadViz::LensVisibilityOff ( )
virtual

Center and radius of the lens in GBC space (the unit circle centered at the origin, as in vtkMultiVariateToRGBA).

This is how the lens is stored, so it can be set before the plot is rendered. The default, center (0, 0) and radius 1, covers the whole plot. A negative radius is an error and leaves the radius unchanged.

◆ SetActiveColor()

virtual void vtkPlotRadViz::SetActiveColor ( vtkColor4ub )
virtual

Color used for active vertex, active lens circle or active lens center.

◆ GetActiveColor()

virtual vtkColor4ub vtkPlotRadViz::GetActiveColor ( )
virtual

Color used for active vertex, active lens circle or active lens center.

◆ SetActiveVertexIndex()

virtual void vtkPlotRadViz::SetActiveVertexIndex ( int )
virtual

The index of the active vertex (mouse over it or rotating the vertices by dragging that vertex), -1 when no vertex is active.

◆ GetActiveVertexIndex()

virtual int vtkPlotRadViz::GetActiveVertexIndex ( )
virtual

Color used for active vertex, active lens circle or active lens center.

◆ SetActiveLensOutline()

virtual void vtkPlotRadViz::SetActiveLensOutline ( bool )
virtual

Set to true when the mouse is over the lens outline or when the lens is resized and set to false otherwise.

◆ GetActiveLensOutline()

virtual bool vtkPlotRadViz::GetActiveLensOutline ( )
virtual

Color used for active vertex, active lens circle or active lens center.

◆ SetActiveLensInterior()

virtual void vtkPlotRadViz::SetActiveLensInterior ( bool )
virtual

Set to true when the mouse is over the lens interior or when the lens is dragged and set to false otherwise.

The lens center dot is shown only when this is true.

◆ GetActiveLensInterior()

virtual bool vtkPlotRadViz::GetActiveLensInterior ( )
virtual

Color used for active vertex, active lens circle or active lens center.

◆ GetSceneCenter()

const double * vtkPlotRadViz::GetSceneCenter ( ) const

Center of the plot in scene coordinates.

◆ GetSceneRadius()

double vtkPlotRadViz::GetSceneRadius ( ) const

Radius of the plot in scene coordinates.

◆ SetLabelsProperties()

virtual void vtkPlotRadViz::SetLabelsProperties ( vtkTextProperty * )
virtual

Get the vtkTextProperty that governs how the vertex labels are displayed.

Default is bold, black Arial with a font size of 16. Its justification is not used: each label is justified away from the plot.

◆ GetLabelsProperties()

virtual vtkTextProperty * vtkPlotRadViz::GetLabelsProperties ( )
virtual

Get the vtkTextProperty that governs how the vertex labels are displayed.

Default is bold, black Arial with a font size of 16. Its justification is not used: each label is justified away from the plot.

◆ SetPartitionIndices()

void vtkPlotRadViz::SetPartitionIndices ( const std::vector< int > & partitionIndices)

Variables can be partitioned into several groups.

After that, all multivariate scalars in a group are normalized together. By default, all variables (components) are in one group.

PartitionIndices holds component indices for each group, with groups stored contiguously. PartitionOffsets holds, for each group, the offset of the (last_element + 1) of that group in PartitionIndices, in the order the groups appear in PartitionIndices.

For example, to normalize indices [0, 1, 2] together and [3, 4] together, set PartitionIndices to [0, 1, 2, 3, 4] and PartitionOffsets to [3, 5]. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetPartitionIndices for details.

◆ GetPartitionIndices()

std::vector< int > vtkPlotRadViz::GetPartitionIndices ( )

Variables can be partitioned into several groups.

After that, all multivariate scalars in a group are normalized together. By default, all variables (components) are in one group.

PartitionIndices holds component indices for each group, with groups stored contiguously. PartitionOffsets holds, for each group, the offset of the (last_element + 1) of that group in PartitionIndices, in the order the groups appear in PartitionIndices.

For example, to normalize indices [0, 1, 2] together and [3, 4] together, set PartitionIndices to [0, 1, 2, 3, 4] and PartitionOffsets to [3, 5]. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetPartitionIndices for details.

◆ SetPartitionOffsets()

void vtkPlotRadViz::SetPartitionOffsets ( const std::vector< int > & partitionOffsets)

Variables can be partitioned into several groups.

After that, all multivariate scalars in a group are normalized together. By default, all variables (components) are in one group.

PartitionIndices holds component indices for each group, with groups stored contiguously. PartitionOffsets holds, for each group, the offset of the (last_element + 1) of that group in PartitionIndices, in the order the groups appear in PartitionIndices.

For example, to normalize indices [0, 1, 2] together and [3, 4] together, set PartitionIndices to [0, 1, 2, 3, 4] and PartitionOffsets to [3, 5]. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetPartitionIndices for details.

◆ GetPartitionOffsets()

std::vector< int > vtkPlotRadViz::GetPartitionOffsets ( )

Variables can be partitioned into several groups.

After that, all multivariate scalars in a group are normalized together. By default, all variables (components) are in one group.

PartitionIndices holds component indices for each group, with groups stored contiguously. PartitionOffsets holds, for each group, the offset of the (last_element + 1) of that group in PartitionIndices, in the order the groups appear in PartitionIndices.

For example, to normalize indices [0, 1, 2] together and [3, 4] together, set PartitionIndices to [0, 1, 2, 3, 4] and PartitionOffsets to [3, 5]. These are passthroughs to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetPartitionIndices for details.

◆ ClearPartitionIndices()

void vtkPlotRadViz::ClearPartitionIndices ( )

Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().

The ParaView server manager XML cannot invoke a method taking a std::vector argument, so it instead calls ClearPartitionIndices()/ClearPartitionOffsets() once to empty the list, followed by one AddPartitionIndex()/AddPartitionOffset() call per value.

◆ AddPartitionIndex()

void vtkPlotRadViz::AddPartitionIndex ( int index)

Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().

The ParaView server manager XML cannot invoke a method taking a std::vector argument, so it instead calls ClearPartitionIndices()/ClearPartitionOffsets() once to empty the list, followed by one AddPartitionIndex()/AddPartitionOffset() call per value.

◆ ClearPartitionOffsets()

void vtkPlotRadViz::ClearPartitionOffsets ( )

Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().

The ParaView server manager XML cannot invoke a method taking a std::vector argument, so it instead calls ClearPartitionIndices()/ClearPartitionOffsets() once to empty the list, followed by one AddPartitionIndex()/AddPartitionOffset() call per value.

◆ AddPartitionOffset()

void vtkPlotRadViz::AddPartitionOffset ( int offset)

Element-wise, ClientServer-wrappable equivalents of SetPartitionIndices() and SetPartitionOffsets().

The ParaView server manager XML cannot invoke a method taking a std::vector argument, so it instead calls ClearPartitionIndices()/ClearPartitionOffsets() once to empty the list, followed by one AddPartitionIndex()/AddPartitionOffset() call per value.

◆ SetCustomRange()

void vtkPlotRadViz::SetCustomRange ( const std::vector< double > & customRange)

Custom ranges used as the global min/max when normalizing scalars, instead of the range computed from the data, one [min, max] range per partition group.

This is a passthrough to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetCustomRange for details, including the flat [min0, max0, min1, max1, ...] layout.

This has to be set when running in ParaView Catalyst to enable using a global range for all ranks. vtkMultiVariateToRGBA::GetRange can be used to compute the global range from data.

◆ GetCustomRange()

std::vector< double > vtkPlotRadViz::GetCustomRange ( )

Custom ranges used as the global min/max when normalizing scalars, instead of the range computed from the data, one [min, max] range per partition group.

This is a passthrough to the underlying vtkMultiVariateToRGBA; see vtkMultiVariateToRGBA::SetCustomRange for details, including the flat [min0, max0, min1, max1, ...] layout.

This has to be set when running in ParaView Catalyst to enable using a global range for all ranks. vtkMultiVariateToRGBA::GetRange can be used to compute the global range from data.

◆ DrawColorWheel()

void vtkPlotRadViz::DrawColorWheel ( vtkContext2D * painter)
protected

◆ DrawColoredMarkers()

vtkSmartPointer< vtkPoints2D > vtkPlotRadViz::DrawColoredMarkers ( vtkContext2D * painter,
vtkDataArray * points,
vtkPen * pen,
vtkDataArray * color = nullptr )
protected

Draw the points using the 'pen' attributes and 'color' instead of the 'pen' color.

The 'points' are in the [-1, 1] space.

◆ DrawMarkers()

vtkSmartPointer< vtkPoints2D > vtkPlotRadViz::DrawMarkers ( vtkContext2D * painter,
vtkDataArray * points,
vtkPen * pen,
int activeIndex = -1 )
protected

Draw the points using the 'pen' attributes.

The 'points' are in the [-1, 1] space. If activeIndex >= 0, draw that point using the ActiveColor.

◆ DrawLabels()

void vtkPlotRadViz::DrawLabels ( vtkContext2D * painter,
vtkDataArray * vertices,
vtkPen * pen )
protected

◆ DrawLens()

void vtkPlotRadViz::DrawLens ( vtkContext2D * painter)
protected

◆ ComputeVisibleLabels()

void vtkPlotRadViz::ComputeVisibleLabels ( )
protected

Computes VisibleLabels from the visible variables.

◆ UpdateFilterInput()

void vtkPlotRadViz::UpdateFilterInput ( )
protected

Updates the producer of the plot input, then passes the input and the array selection of the plot to ComputeGBC, so that it computes, and reports the variables of, the current plot input.

◆ UpdateCenterAndRadius()

void vtkPlotRadViz::UpdateCenterAndRadius ( vtkContext2D * painter)
protected

Recomputes the plot circle's center and radius from Dimensions, shrinking the radius so that there is enough room around the circle for the vertex labels (measured using LabelsProperties and painter) to fit within Dimensions without being clipped.

This keeps the lens position and size proportional to the plot circle when the radius changes.

◆ TransformPoints()

vtkSmartPointer< vtkPoints2D > vtkPlotRadViz::TransformPoints ( vtkDataArray * points)
protected

◆ TransformColors()

vtkSmartPointer< vtkUnsignedCharArray > vtkPlotRadViz::TransformColors ( vtkDataArray * rgba)
protected

◆ ApplyPenColor()

vtkSmartPointer< vtkDoubleArray > vtkPlotRadViz::ApplyPenColor ( vtkPen * pen,
vtkDataArray * rgba )
protected

Returns a per-point RGBA array using 'pen' color for RGB and 'rgba's A component for alpha.

Used to apply the already computed opacity (including the lens's OutsideLensAlpha) to a single-color plot when ScalarVisibility is off.

◆ GetJustification()

std::pair< int, int > vtkPlotRadViz::GetJustification ( double xy[2])
staticprotected

Returns the horizontal and vertical text justification for xy coordinates.

◆ ShiftLabelByPenWidth()

void vtkPlotRadViz::ShiftLabelByPenWidth ( double width,
double transformedXy[2] )
protected

◆ GetVerticesGbcRgba()

std::tuple< vtkDataArray *, vtkDataArray *, vtkDataArray * > vtkPlotRadViz::GetVerticesGbcRgba ( vtkDataObject * output)
protected

Returns the arrays named 'vertices', 'gbc' and 'rgba' from a table or dataset, or throws std::runtime_error if not found.

For a dataset, 'gbc' and 'rgba' are taken from the point or cell data of the array processed, not from the other one.

◆ GetArray()

vtkDataArray * vtkPlotRadViz::GetArray ( vtkDataSetAttributes * attributes,
const char * name )
staticprotected

Returns the array 'name' of 'attributes' or throws std::runtime_error if the array is not found.

Member Data Documentation

◆ Dimensions

int vtkPlotRadViz::Dimensions[4] = { 0, 0, 0, 0 }
protected

Definition at line 496 of file vtkPlotRadViz.h.

◆ VerticesPen

vtkSmartPointer<vtkPen> vtkPlotRadViz::VerticesPen = vtkSmartPointer<vtkPen>::New()
protected

Controls how the vertices are drawn.

These are the markers on the circle for the variables.

Definition at line 501 of file vtkPlotRadViz.h.

◆ MarkerOutlineWidth

double vtkPlotRadViz::MarkerOutlineWidth = 1.0
protected

Width of the black outline of the markers.

Definition at line 505 of file vtkPlotRadViz.h.

◆ LensPen

vtkSmartPointer<vtkPen> vtkPlotRadViz::LensPen = vtkSmartPointer<vtkPen>::New()
protected

Controls how the lens circle outline is drawn.

Definition at line 509 of file vtkPlotRadViz.h.

◆ ActiveColor

vtkColor4ub vtkPlotRadViz::ActiveColor = vtkColor4ub(255, 0, 0, 255)
protected

Pen used for active vertex, active lens circle or active lens center.

Only the color is used.

Definition at line 514 of file vtkPlotRadViz.h.

◆ ActiveVertexIndex

int vtkPlotRadViz::ActiveVertexIndex = -1
protected

The index of the active vertex (mouse over it or rotating the vertices by dragging that vertex), -1 when no vertex is active.

Definition at line 519 of file vtkPlotRadViz.h.

◆ ActiveLensOutline

bool vtkPlotRadViz::ActiveLensOutline = false
protected

Set to true when the mouse is over the lens outline or when the lens is resized and set to false otherwise.

Definition at line 524 of file vtkPlotRadViz.h.

◆ ActiveLensInterior

bool vtkPlotRadViz::ActiveLensInterior = false
protected

Set to true when the mouse is over the lens interior or when the lens is dragged and set to false otherwise.

Definition at line 529 of file vtkPlotRadViz.h.

◆ OutsideLensAlpha

double vtkPlotRadViz::OutsideLensAlpha = 1.0
protected

Alpha cap for points outside the lens.

Definition at line 533 of file vtkPlotRadViz.h.

◆ LensVisibility

bool vtkPlotRadViz::LensVisibility = false
protected

Show the lens if true.

Definition at line 537 of file vtkPlotRadViz.h.

◆ LensCenter

double vtkPlotRadViz::LensCenter[2] = { 0.0, 0.0 }
protected

The lens in GBC space.

Definition at line 541 of file vtkPlotRadViz.h.

◆ LensRadius

double vtkPlotRadViz::LensRadius = 1.0
protected

Definition at line 542 of file vtkPlotRadViz.h.

◆ SceneLensCenter

double vtkPlotRadViz::SceneLensCenter[2] = { 0.0, 0.0 }
protected

Storage for GetSceneLensCenter().

Definition at line 546 of file vtkPlotRadViz.h.

◆ Vertices

vtkSmartPointer<vtkPoints2D> vtkPlotRadViz::Vertices
protected

Definition at line 548 of file vtkPlotRadViz.h.

◆ VerticesRotation

double vtkPlotRadViz::VerticesRotation = 0.0
protected

Definition at line 549 of file vtkPlotRadViz.h.

◆ VerticesClockwiseOrdering

bool vtkPlotRadViz::VerticesClockwiseOrdering = true
protected

Definition at line 550 of file vtkPlotRadViz.h.

◆ LabelsProperties

vtkSmartPointer<vtkTextProperty> vtkPlotRadViz::LabelsProperties = vtkSmartPointer<vtkTextProperty>::New()
protected

The text properties associated with the vertex labels.

Definition at line 555 of file vtkPlotRadViz.h.

◆ VisibleLabels

vtkSmartPointer<vtkStringArray> vtkPlotRadViz::VisibleLabels
protected

The label of each vertex: the labels set with SetLabels for the visible variables, or their names if SetLabels was not given one label per variable of the input.

For example, for variables a, b, c, d with b hidden, VisibleLabels is {A, C, D} after SetLabels({A, B, C, D}), or {a, c, d} without SetLabels or after SetLabels({A, B}).

Definition at line 563 of file vtkPlotRadViz.h.

◆ ColorWheelSegmentCount

int vtkPlotRadViz::ColorWheelSegmentCount = 120
protected

Definition at line 564 of file vtkPlotRadViz.h.

◆ ColorWheelRingCount

int vtkPlotRadViz::ColorWheelRingCount = 16
protected

Definition at line 565 of file vtkPlotRadViz.h.

◆ ColorWheelVisibility

bool vtkPlotRadViz::ColorWheelVisibility = true
protected

Definition at line 566 of file vtkPlotRadViz.h.

◆ ScalarVisibility

bool vtkPlotRadViz::ScalarVisibility = false
protected

Definition at line 567 of file vtkPlotRadViz.h.

◆ ComputeGBC

vtkNew<vtkMultiVariateToRGBA> vtkPlotRadViz::ComputeGBC
protected

Persistent filter used to compute the GBC/RGBA values, and that also owns the variable visibility configuration (see SetVariableVisibility).

Kept alive across Paint() calls so that the visibility configuration and the vtkAlgorithm modified-time tracking both persist between renders.

Definition at line 576 of file vtkPlotRadViz.h.


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