VTK
Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkSpiderPlotActor Class Reference

create a spider plot from input field More...

#include <vtkSpiderPlotActor.h>

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

List of all members.

- Public Types inherited from vtkActor2D - Public Types inherited from vtkProp - Public Types inherited from vtkObject

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 *)
- Public Member Functions inherited from vtkActor2D
vtkProperty2DGetProperty ()
virtual void SetProperty (vtkProperty2D *)
void SetDisplayPosition (int, int)
virtual unsigned long GetMTime ()
virtual void GetActors2D (vtkPropCollection *pc)
virtual void ShallowCopy (vtkProp *prop)
virtual void SetMapper (vtkMapper2D *mapper)
virtual vtkMapper2DGetMapper ()
virtual void SetLayerNumber (int)
virtual int GetLayerNumber ()
virtual vtkCoordinateGetPositionCoordinate ()
virtual void SetPosition (float x[2])
virtual void SetPosition (float x, float y)
virtual float * GetPosition ()
virtual vtkCoordinateGetPosition2Coordinate ()
virtual void SetPosition2 (float x[2])
virtual void SetPosition2 (float x, float y)
virtual float * GetPosition2 ()
void SetWidth (double w)
double GetWidth ()
void SetHeight (double h)
double GetHeight ()
virtual vtkCoordinateGetActualPositionCoordinate (void)
virtual vtkCoordinateGetActualPosition2Coordinate (void)
- Public Member Functions inherited from vtkProp
virtual void Pick ()
virtual unsigned long GetRedrawMTime ()
virtual double * GetBounds ()
virtual bool HasKeys (vtkInformation *requiredKeys)
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
virtual void GetActors (vtkPropCollection *)
virtual void GetVolumes (vtkPropCollection *)
virtual void SetVisibility (int)
virtual int GetVisibility ()
virtual void VisibilityOn ()
virtual void VisibilityOff ()
virtual void SetPickable (int)
virtual int GetPickable ()
virtual void PickableOn ()
virtual void PickableOff ()
virtual void SetDragable (int)
virtual int GetDragable ()
virtual void DragableOn ()
virtual void DragableOff ()
virtual void SetUseBounds (bool)
virtual bool GetUseBounds ()
virtual void UseBoundsOn ()
virtual void UseBoundsOff ()
virtual void InitPathTraversal ()
virtual vtkAssemblyPathGetNextPath ()
virtual int GetNumberOfPaths ()
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
virtual vtkMatrix4x4GetMatrix ()
virtual vtkInformationGetPropertyKeys ()
virtual void SetPropertyKeys (vtkInformation *keys)
virtual int RenderVolumetricGeometry (vtkViewport *)
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
virtual double GetEstimatedRenderTime (vtkViewport *)
virtual double GetEstimatedRenderTime ()
virtual void SetEstimatedRenderTime (double t)
virtual void RestoreEstimatedRenderTime ()
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
virtual double GetAllocatedRenderTime ()
void SetRenderTimeMultiplier (double t)
virtual double GetRenderTimeMultiplier ()
virtual bool GetSupportsSelection ()
virtual int GetNumberOfConsumers ()
void AddConsumer (vtkObject *c)
void RemoveConsumer (vtkObject *c)
vtkObjectGetConsumer (int i)
int IsConsumer (vtkObject *c)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkSpiderPlotActorNew ()

Protected Member Functions

 vtkSpiderPlotActor ()
 ~vtkSpiderPlotActor ()
- Protected Member Functions inherited from vtkActor2D
 vtkActor2D ()
 ~vtkActor2D ()
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 ~vtkProp ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)
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)

Additional Inherited Members

- Protected Attributes inherited from vtkActor2D
vtkMapper2DMapper
int LayerNumber
vtkProperty2DProperty
vtkCoordinatePositionCoordinate
vtkCoordinatePosition2Coordinate
- Protected Attributes inherited from vtkProp
int Visibility
int Pickable
int Dragable
bool UseBounds
double AllocatedRenderTime
double EstimatedRenderTime
double SavedEstimatedRenderTime
double RenderTimeMultiplier
int NumberOfConsumers
vtkObject ** Consumers
vtkAssemblyPathsPaths
vtkInformationPropertyKeys
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers

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.


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 )
inlinevirtual

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: