vtkSpiderPlotActor Class Reference

#include <vtkSpiderPlotActor.h>

Inheritance diagram for vtkSpiderPlotActor:

Inheritance graph
[legend]
Collaboration diagram for vtkSpiderPlotActor:

Collaboration graph
[legend]

List of all members.


Detailed Description

create a spider plot from input field

vtkSpiderPlotActor generates a spider plot from an input field (i.e., vtkDataObject). A spider plot represents N-dimensional data by using a set of N axes that originate from the center of a circle, and form the spokes of a wheel (like a spider web). Each N-dimensional point is plotted as a polyline that forms a closed polygon; the vertices of the polygon are plotted against the radial axes.

To use this class, you must specify an input data object. You'll probably also want to specify the position of the plot be setting the Position and Position2 instance variables, which define a rectangle in which the plot lies. Another important parameter is the IndependentVariables ivar, which tells the instance how to interpret the field data (independent variables as the rows or columns of the field). There are also many other instance variables that control the look of the plot includes its title and legend.

Set the text property/attributes of the title and the labels through the vtkTextProperty objects associated with these components.

Warning:
Field data is not necessarily "rectangular" in shape. In these cases, some of the data may not be plotted.

Field data can contain non-numeric arrays (i.e. arrays not subclasses of vtkDataArray). Such arrays are skipped.

See also:
vtkParallelCoordinatesActor vtkXYPlotActor2D
Tests:
vtkSpiderPlotActor (Tests)

Definition at line 71 of file vtkSpiderPlotActor.h.

typedef vtkActor2D Superclass
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
static int IsTypeOf (const char *type)
static vtkSpiderPlotActorSafeDownCast (vtkObject *o)

Public Member Functions

virtual void SetInput (vtkDataObject *)
virtual void SetLabelVisibility (int)
virtual int GetLabelVisibility ()
virtual void LabelVisibilityOn ()
virtual void LabelVisibilityOff ()
virtual int HasTranslucentPolygonalGeometry ()
void ReleaseGraphicsResources (vtkWindow *)
virtual vtkDataObjectGetInput ()
virtual void SetIndependentVariables (int)
virtual int GetIndependentVariables ()
void SetIndependentVariablesToColumns ()
void SetIndependentVariablesToRows ()
virtual void SetTitleVisibility (int)
virtual int GetTitleVisibility ()
virtual void TitleVisibilityOn ()
virtual void TitleVisibilityOff ()
virtual void SetTitle (const char *)
virtual char * GetTitle ()
virtual void SetTitleTextProperty (vtkTextProperty *p)
virtual vtkTextPropertyGetTitleTextProperty ()
virtual void SetLabelTextProperty (vtkTextProperty *p)
virtual vtkTextPropertyGetLabelTextProperty ()
virtual void SetNumberOfRings (int)
virtual int GetNumberOfRings ()
void SetAxisLabel (const int i, const char *)
const char * GetAxisLabel (int i)
void SetAxisRange (int i, double min, double max)
void SetAxisRange (int i, double range[2])
void GetAxisRange (int i, double range[2])
void SetPlotColor (int i, double r, double g, double b)
void SetPlotColor (int i, const double color[3])
double * GetPlotColor (int i)
virtual void SetLegendVisibility (int)
virtual int GetLegendVisibility ()
virtual void LegendVisibilityOn ()
virtual void LegendVisibilityOff ()
virtual vtkLegendBoxActorGetLegendActor ()
int RenderOverlay (vtkViewport *)
int RenderOpaqueGeometry (vtkViewport *)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)

Static Public Member Functions

static vtkSpiderPlotActorNew ()

Protected Member Functions

 vtkSpiderPlotActor ()
 ~vtkSpiderPlotActor ()

Member Typedef Documentation

Standard methods for type information and printing.

Reimplemented from vtkActor2D.

Definition at line 76 of file vtkSpiderPlotActor.h.


Constructor & Destructor Documentation

vtkSpiderPlotActor::vtkSpiderPlotActor (  )  [protected]

vtkSpiderPlotActor::~vtkSpiderPlotActor (  )  [protected]


Member Function Documentation

virtual const char* vtkSpiderPlotActor::GetClassName (  )  [virtual]

Standard methods for type information and printing.

Reimplemented from vtkActor2D.

static int vtkSpiderPlotActor::IsTypeOf ( const char *  type  )  [static]

Standard methods for type information and printing.

Reimplemented from vtkActor2D.

virtual int vtkSpiderPlotActor::IsA ( const char *  type  )  [virtual]

Standard methods for type information and printing.

Reimplemented from vtkActor2D.

static vtkSpiderPlotActor* vtkSpiderPlotActor::SafeDownCast ( vtkObject o  )  [static]

Standard methods for type information and printing.

Reimplemented from vtkActor2D.

void vtkSpiderPlotActor::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Standard methods for type information and printing.

Reimplemented from vtkActor2D.

static vtkSpiderPlotActor* vtkSpiderPlotActor::New (  )  [static]

Instantiate this class.

Reimplemented from vtkActor2D.

virtual void vtkSpiderPlotActor::SetInput ( vtkDataObject  )  [virtual]

Set the input to the spider plot actor.

virtual vtkDataObject* vtkSpiderPlotActor::GetInput (  )  [virtual]

Get the input data object to this actor.

virtual void vtkSpiderPlotActor::SetIndependentVariables ( int   )  [virtual]

Specify whether to use the rows or columns as independent variables. If columns, then each row represents a separate point. If rows, then each column represents a separate point.

virtual int vtkSpiderPlotActor::GetIndependentVariables (  )  [virtual]

Specify whether to use the rows or columns as independent variables. If columns, then each row represents a separate point. If rows, then each column represents a separate point.

void vtkSpiderPlotActor::SetIndependentVariablesToColumns (  )  [inline]

Specify whether to use the rows or columns as independent variables. If columns, then each row represents a separate point. If rows, then each column represents a separate point.

Definition at line 97 of file vtkSpiderPlotActor.h.

void vtkSpiderPlotActor::SetIndependentVariablesToRows (  )  [inline]

Specify whether to use the rows or columns as independent variables. If columns, then each row represents a separate point. If rows, then each column represents a separate point.

Definition at line 99 of file vtkSpiderPlotActor.h.

virtual void vtkSpiderPlotActor::SetTitleVisibility ( int   )  [virtual]

Enable/Disable the display of a plot title.

virtual int vtkSpiderPlotActor::GetTitleVisibility (  )  [virtual]

Enable/Disable the display of a plot title.

virtual void vtkSpiderPlotActor::TitleVisibilityOn (  )  [virtual]

Enable/Disable the display of a plot title.

virtual void vtkSpiderPlotActor::TitleVisibilityOff (  )  [virtual]

Enable/Disable the display of a plot title.

virtual void vtkSpiderPlotActor::SetTitle ( const char *   )  [virtual]

Set/Get the title of the spider plot.

virtual char* vtkSpiderPlotActor::GetTitle (  )  [virtual]

Set/Get the title of the spider plot.

virtual void vtkSpiderPlotActor::SetTitleTextProperty ( vtkTextProperty p  )  [virtual]

Set/Get the title text property.

virtual vtkTextProperty* vtkSpiderPlotActor::GetTitleTextProperty (  )  [virtual]

Set/Get the title text property.

virtual void vtkSpiderPlotActor::SetLabelVisibility ( int   )  [virtual]

virtual int vtkSpiderPlotActor::GetLabelVisibility (  )  [virtual]

virtual void vtkSpiderPlotActor::LabelVisibilityOn (  )  [virtual]

virtual void vtkSpiderPlotActor::LabelVisibilityOff (  )  [virtual]

virtual void vtkSpiderPlotActor::SetLabelTextProperty ( vtkTextProperty p  )  [virtual]

Enable/Disable the creation of a legend. If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

virtual vtkTextProperty* vtkSpiderPlotActor::GetLabelTextProperty (  )  [virtual]

Enable/Disable the creation of a legend. If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

virtual void vtkSpiderPlotActor::SetNumberOfRings ( int   )  [virtual]

Specify the number of circumferential rings. If set to zero, then none will be shown; othewise the specified number will be shown.

virtual int vtkSpiderPlotActor::GetNumberOfRings (  )  [virtual]

Specify the number of circumferential rings. If set to zero, then none will be shown; othewise the specified number will be shown.

void vtkSpiderPlotActor::SetAxisLabel ( const int  i,
const char *   
)

Specify the names of the radial spokes (i.e., the radial axes). If not specified, then an integer number is automatically generated.

const char* vtkSpiderPlotActor::GetAxisLabel ( int  i  ) 

Specify the names of the radial spokes (i.e., the radial axes). If not specified, then an integer number is automatically generated.

void vtkSpiderPlotActor::SetAxisRange ( int  i,
double  min,
double  max 
)

Specify the range of data on each radial axis. If not specified, then the range is computed automatically.

void vtkSpiderPlotActor::SetAxisRange ( int  i,
double  range[2] 
)

Specify the range of data on each radial axis. If not specified, then the range is computed automatically.

void vtkSpiderPlotActor::GetAxisRange ( int  i,
double  range[2] 
)

Specify the range of data on each radial axis. If not specified, then the range is computed automatically.

void vtkSpiderPlotActor::SetPlotColor ( int  i,
double  r,
double  g,
double  b 
)

Specify colors for each plot. If not specified, they are automatically generated.

void vtkSpiderPlotActor::SetPlotColor ( int  i,
const double  color[3] 
) [inline]

Specify colors for each plot. If not specified, they are automatically generated.

Definition at line 164 of file vtkSpiderPlotActor.h.

double* vtkSpiderPlotActor::GetPlotColor ( int  i  ) 

Specify colors for each plot. If not specified, they are automatically generated.

virtual void vtkSpiderPlotActor::SetLegendVisibility ( int   )  [virtual]

Enable/Disable the creation of a legend. If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

virtual int vtkSpiderPlotActor::GetLegendVisibility (  )  [virtual]

Enable/Disable the creation of a legend. If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

virtual void vtkSpiderPlotActor::LegendVisibilityOn (  )  [virtual]

Enable/Disable the creation of a legend. If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

virtual void vtkSpiderPlotActor::LegendVisibilityOff (  )  [virtual]

Enable/Disable the creation of a legend. If on, the legend labels will be created automatically unless the per plot legend symbol has been set.

virtual vtkLegendBoxActor* vtkSpiderPlotActor::GetLegendActor (  )  [virtual]

Retrieve handles to the legend box. This is useful if you would like to manually control the legend appearance.

int vtkSpiderPlotActor::RenderOverlay ( vtkViewport  )  [virtual]

Draw the spider plot.

Reimplemented from vtkActor2D.

int vtkSpiderPlotActor::RenderOpaqueGeometry ( vtkViewport  )  [virtual]

Draw the spider plot.

Reimplemented from vtkActor2D.

virtual int vtkSpiderPlotActor::RenderTranslucentPolygonalGeometry ( vtkViewport  )  [inline, virtual]

Draw the spider plot.

Reimplemented from vtkActor2D.

Definition at line 188 of file vtkSpiderPlotActor.h.

virtual int vtkSpiderPlotActor::HasTranslucentPolygonalGeometry (  )  [virtual]

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkActor2D.

void vtkSpiderPlotActor::ReleaseGraphicsResources ( vtkWindow  )  [virtual]

Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkActor2D.


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

Generated on Mon Sep 27 18:51:26 2010 for VTK by  doxygen 1.5.6