Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkArcPlotter Class Reference

plot data along an arbitrary polyline. More...

#include <vtkArcPlotter.h>

Inheritance diagram for vtkArcPlotter:

Inheritance graph
Collaboration diagram for vtkArcPlotter:

Collaboration graph
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetCamera (vtkCamera *)
virtual vtkCameraGetCamera ()
virtual void SetPlotMode (int)
virtual int GetPlotMode ()
void SetPlotModeToPlotScalars ()
void SetPlotModeToPlotVectors ()
void SetPlotModeToPlotNormals ()
void SetPlotModeToPlotTCoords ()
void SetPlotModeToPlotTensors ()
void SetPlotModeToPlotFieldData ()
virtual void SetPlotComponent (int)
virtual int GetPlotComponent ()
virtual void SetRadius (float)
virtual float GetRadius ()
virtual void SetHeight (float)
virtual float GetHeight ()
virtual void SetOffset (float)
virtual float GetOffset ()
virtual void SetUseDefaultNormal (int)
virtual int GetUseDefaultNormal ()
virtual void UseDefaultNormalOn ()
virtual void UseDefaultNormalOff ()
virtual void SetDefaultNormal (float, float, float)
virtual void SetDefaultNormal (float[3])
virtual float * GetDefaultNormal ()
virtual void GetDefaultNormal (float data[3])
virtual void SetFieldDataArray (int)
virtual int GetFieldDataArray ()
unsigned long GetMTime ()

Static Public Methods

vtkArcPlotter * New ()
int IsTypeOf (const char *type)
vtkArcPlotter * SafeDownCast (vtkObject *o)

Protected Methods

 vtkArcPlotter ()
 ~vtkArcPlotter ()
 vtkArcPlotter (const vtkArcPlotter &)
void operator= (const vtkArcPlotter &)
void Execute ()
int OffsetPoint (int ptId, vtkPoints *inPts, float n[3], vtkPoints *newPts, float offset, float *range, float val)
int ProcessComponents (int numPts, vtkPointData *pd)

Protected Attributes

int PlotMode
int PlotComponent
float Radius
float Height
float Offset
float DefaultNormal [3]
int UseDefaultNormal
int FieldDataArray

Detailed Description

plot data along an arbitrary polyline.

2000/12/10 20:08:22

vtkArcPlotter performs plotting of attribute data along polylines defined with an input vtkPolyData data object. Any type of attribute data can be plotted including scalars, vectors, tensors, normals, texture coordinates, and field data. Either one or multiple data components can be plotted.

To use this class you must specify an input data set that contains one or more polylines, and some attribute data including which component of the attribute data. (By default, this class processes the first component of scalar data.) You will also need to set an offset radius (the distance of the polyline to the median line of the plot), a width for the plot (the distance that the minimum and maximum plot values are mapped into), an possibly an offset (used to offset attribute data with multiple components).

Normally the filter automatically computes normals for generating the offset arc plot. However, you can specify a default normal and use that instead.

See also:
vtkArcPlotter (examples)

Definition at line 83 of file vtkArcPlotter.h.

Constructor & Destructor Documentation

vtkArcPlotter::vtkArcPlotter   [protected]

vtkArcPlotter::~vtkArcPlotter   [protected]

vtkArcPlotter::vtkArcPlotter const vtkArcPlotter &    [inline, protected]

Definition at line 155 of file vtkArcPlotter.h.

Member Function Documentation

vtkArcPlotter* vtkArcPlotter::New   [inline, static]

Instantiate with no default camera and plot mode set to VTK_SCALARS.

Reimplemented from vtkPolyDataSource.

Definition at line 87 of file vtkArcPlotter.h.

virtual const char* vtkArcPlotter::GetClassName   [virtual]

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataToPolyDataFilter.

int vtkArcPlotter::IsTypeOf const char *    type [static]

Return 1 if this class type 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 vtkPolyDataToPolyDataFilter.

virtual int vtkArcPlotter::IsA const char *    type [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 vtkPolyDataToPolyDataFilter.

vtkArcPlotter* vtkArcPlotter::SafeDownCast vtkObject   o [static]

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataToPolyDataFilter.

void vtkArcPlotter::PrintSelf ostream &    os,
vtkIndent    indent

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 vtkSource.

virtual void vtkArcPlotter::SetCamera vtkCamera   [virtual]

Specify a camera used to orient the plot along the arc. If no camera is specified, then the orientation of the plot is arbitrary.

virtual vtkCamera* vtkArcPlotter::GetCamera   [virtual]

virtual void vtkArcPlotter::SetPlotMode int    [virtual]

Specify which data to plot: scalars, vectors, normals, texture coords, tensors, or field data. If the data has more than one component, use the method SetPlotComponent to control which component to plot.

virtual int vtkArcPlotter::GetPlotMode   [virtual]

void vtkArcPlotter::SetPlotModeToPlotScalars   [inline]

Definition at line 103 of file vtkArcPlotter.h.

void vtkArcPlotter::SetPlotModeToPlotVectors   [inline]

Definition at line 104 of file vtkArcPlotter.h.

void vtkArcPlotter::SetPlotModeToPlotNormals   [inline]

Definition at line 105 of file vtkArcPlotter.h.

void vtkArcPlotter::SetPlotModeToPlotTCoords   [inline]

Definition at line 106 of file vtkArcPlotter.h.

void vtkArcPlotter::SetPlotModeToPlotTensors   [inline]

Definition at line 107 of file vtkArcPlotter.h.

void vtkArcPlotter::SetPlotModeToPlotFieldData   [inline]

Definition at line 108 of file vtkArcPlotter.h.

virtual void vtkArcPlotter::SetPlotComponent int    [virtual]

Set/Get the component number to plot if the data has more than one component. If the value of the plot component is == (-1), then all the components will be plotted.

virtual int vtkArcPlotter::GetPlotComponent   [virtual]

virtual void vtkArcPlotter::SetRadius float    [virtual]

Set the radius of the "median" value of the first plotted component.

virtual float vtkArcPlotter::GetRadius   [virtual]

virtual void vtkArcPlotter::SetHeight float    [virtual]

Set the height of the plot. (The radius combined with the height define the location of the plot relative to the generating polyline.)

virtual float vtkArcPlotter::GetHeight   [virtual]

virtual void vtkArcPlotter::SetOffset float    [virtual]

Specify an offset that translates each subsequent plot (if there is more than one component plotted) from the defining arc (i.e., polyline).

virtual float vtkArcPlotter::GetOffset   [virtual]

virtual void vtkArcPlotter::SetUseDefaultNormal int    [virtual]

Set a boolean to control whether to use default normals. By default, normals are automatically computed from the generating polyline and camera.

virtual int vtkArcPlotter::GetUseDefaultNormal   [virtual]

virtual void vtkArcPlotter::UseDefaultNormalOn   [virtual]

virtual void vtkArcPlotter::UseDefaultNormalOff   [virtual]

virtual void vtkArcPlotter::SetDefaultNormal float   ,
float   ,

Set the default normal to use if you do not wish automatic normal calculation. The arc plot will be generated using this normal.

virtual void vtkArcPlotter::SetDefaultNormal float   [3] [virtual]

virtual float* vtkArcPlotter::GetDefaultNormal   [virtual]

virtual void vtkArcPlotter::GetDefaultNormal float    data[3] [virtual]

virtual void vtkArcPlotter::SetFieldDataArray int    [virtual]

Set/Get the field data array to plot. This instance variable is only applicable if field data is plotted.

virtual int vtkArcPlotter::GetFieldDataArray   [virtual]

unsigned long vtkArcPlotter::GetMTime   [virtual]

New GetMTime because of camera dependency.

Reimplemented from vtkObject.

void vtkArcPlotter::operator= const vtkArcPlotter &    [inline, protected]

Definition at line 156 of file vtkArcPlotter.h.

void vtkArcPlotter::Execute   [protected, virtual]

Reimplemented from vtkSource.

int vtkArcPlotter::OffsetPoint int    ptId,
vtkPoints   inPts,
float    n[3],
vtkPoints   newPts,
float    offset,
float *    range,
float    val

int vtkArcPlotter::ProcessComponents int    numPts,
vtkPointData   pd

Member Data Documentation

vtkCamera* vtkArcPlotter::Camera [protected]

Definition at line 163 of file vtkArcPlotter.h.

int vtkArcPlotter::PlotMode [protected]

Definition at line 164 of file vtkArcPlotter.h.

int vtkArcPlotter::PlotComponent [protected]

Definition at line 165 of file vtkArcPlotter.h.

float vtkArcPlotter::Radius [protected]

Definition at line 166 of file vtkArcPlotter.h.

float vtkArcPlotter::Height [protected]

Definition at line 167 of file vtkArcPlotter.h.

float vtkArcPlotter::Offset [protected]

Definition at line 168 of file vtkArcPlotter.h.

float vtkArcPlotter::DefaultNormal[3] [protected]

Definition at line 169 of file vtkArcPlotter.h.

int vtkArcPlotter::UseDefaultNormal [protected]

Definition at line 170 of file vtkArcPlotter.h.

int vtkArcPlotter::FieldDataArray [protected]

Definition at line 171 of file vtkArcPlotter.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:46:26 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001