VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkArcPlotter Class Reference

plot data along an arbitrary polyline More...

#include <vtkArcPlotter.h>

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

List of all members.

Public Types

typedef vtkPolyDataAlgorithm Superclass
- Public Types inherited from vtkPolyDataAlgorithm
- Public Types inherited from vtkAlgorithm
- Public Types inherited from vtkObject

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
unsigned long GetMTime ()
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 (double)
virtual double GetRadius ()
virtual void SetHeight (double)
virtual double GetHeight ()
virtual void SetOffset (double)
virtual double 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 ()
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkPolyDataGetPolyDataInput (int port)
vtkPolyDataGetOutput ()
vtkPolyDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
virtual void SetInformation (vtkInformation *)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetAbortExecute (int)
virtual int GetAbortExecute ()
virtual void AbortExecuteOn ()
virtual void AbortExecuteOff ()
virtual void SetProgress (double)
virtual double GetProgress ()
void SetProgressText (const char *ptext)
virtual char * GetProgressText ()
virtual unsigned long GetErrorCode ()
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObjectGetInputDataObject (int port, int connection)
virtual void SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void SetInputConnection (vtkAlgorithmOutput *input)
virtual void AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void AddInputConnection (vtkAlgorithmOutput *input)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- 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)
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 vtkArcPlotterNew ()
static int IsTypeOf (const char *type)
static vtkArcPlotterSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkArcPlotter ()
 ~vtkArcPlotter ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int OffsetPoint (vtkIdType ptId, vtkPoints *inPts, double n[3], vtkPoints *newPts, double offset, double *range, double val)
int ProcessComponents (vtkIdType numPts, vtkPointData *pd)
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 ~vtkPolyDataAlgorithm ()
virtual int RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int FillOutputPortInformation (int port, vtkInformation *info)
virtual int FillInputPortInformation (int port, vtkInformation *info)
virtual int RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- Protected Member Functions inherited from vtkAlgorithm
 vtkAlgorithm ()
 ~vtkAlgorithm ()
virtual void SetNumberOfInputPorts (int n)
virtual void SetNumberOfOutputPorts (int n)
int InputPortIndexInRange (int index, const char *action)
int OutputPortIndexInRange (int index, const char *action)
int GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutiveCreateDefaultExecutive ()
virtual void ReportReferences (vtkGarbageCollector *)
virtual void SetNumberOfInputConnections (int port, int n)
int GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
virtual void SetErrorCode (unsigned long)
- 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)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

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

Detailed Description

plot data along an arbitrary polyline

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:
vtkXYPlotActor
Tests:
vtkArcPlotter (Tests)

Definition at line 60 of file vtkArcPlotter.h.


Member Typedef Documentation

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 66 of file vtkArcPlotter.h.


Constructor & Destructor Documentation

vtkArcPlotter::vtkArcPlotter ( )
protected
vtkArcPlotter::~vtkArcPlotter ( )
protected

Member Function Documentation

static vtkArcPlotter* vtkArcPlotter::New ( )
static

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

Reimplemented from vtkPolyDataAlgorithm.

virtual const char* vtkArcPlotter::GetClassName ( )
virtual

Reimplemented from vtkPolyDataAlgorithm.

static int vtkArcPlotter::IsTypeOf ( const char *  name)
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 vtkPolyDataAlgorithm.

virtual int vtkArcPlotter::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 vtkPolyDataAlgorithm.

static vtkArcPlotter* vtkArcPlotter::SafeDownCast ( vtkObject o)
static

Reimplemented from vtkPolyDataAlgorithm.

void vtkArcPlotter::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual

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

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

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

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.

void vtkArcPlotter::SetPlotModeToPlotScalars ( )
inline

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.

Definition at line 83 of file vtkArcPlotter.h.

void vtkArcPlotter::SetPlotModeToPlotVectors ( )
inline

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.

Definition at line 84 of file vtkArcPlotter.h.

void vtkArcPlotter::SetPlotModeToPlotNormals ( )
inline

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.

Definition at line 85 of file vtkArcPlotter.h.

void vtkArcPlotter::SetPlotModeToPlotTCoords ( )
inline

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.

Definition at line 86 of file vtkArcPlotter.h.

void vtkArcPlotter::SetPlotModeToPlotTensors ( )
inline

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.

Definition at line 87 of file vtkArcPlotter.h.

void vtkArcPlotter::SetPlotModeToPlotFieldData ( )
inline

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.

Definition at line 88 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

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 void vtkArcPlotter::SetRadius ( double  )
virtual

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

virtual double vtkArcPlotter::GetRadius ( )
virtual

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

virtual void vtkArcPlotter::SetHeight ( double  )
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 double vtkArcPlotter::GetHeight ( )
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 void vtkArcPlotter::SetOffset ( double  )
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 double vtkArcPlotter::GetOffset ( )
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 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

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

virtual void vtkArcPlotter::UseDefaultNormalOn ( )
virtual

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

virtual void vtkArcPlotter::UseDefaultNormalOff ( )
virtual

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

virtual void vtkArcPlotter::SetDefaultNormal ( float  ,
float  ,
float   
)
virtual

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

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

virtual float* vtkArcPlotter::GetDefaultNormal ( )
virtual

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::GetDefaultNormal ( float  data[3])
virtual

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::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

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

unsigned long vtkArcPlotter::GetMTime ( )
virtual

New GetMTime because of camera dependency.

Reimplemented from vtkObject.

int vtkArcPlotter::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
)
protectedvirtual

This is called by the superclass. This is the method you should override.

Reimplemented from vtkPolyDataAlgorithm.

int vtkArcPlotter::OffsetPoint ( vtkIdType  ptId,
vtkPoints inPts,
double  n[3],
vtkPoints newPts,
double  offset,
double *  range,
double  val 
)
protected
int vtkArcPlotter::ProcessComponents ( vtkIdType  numPts,
vtkPointData pd 
)
protected

Member Data Documentation

vtkCamera* vtkArcPlotter::Camera
protected

Definition at line 157 of file vtkArcPlotter.h.

int vtkArcPlotter::PlotMode
protected

Definition at line 158 of file vtkArcPlotter.h.

int vtkArcPlotter::PlotComponent
protected

Definition at line 159 of file vtkArcPlotter.h.

double vtkArcPlotter::Radius
protected

Definition at line 160 of file vtkArcPlotter.h.

double vtkArcPlotter::Height
protected

Definition at line 161 of file vtkArcPlotter.h.

double vtkArcPlotter::Offset
protected

Definition at line 162 of file vtkArcPlotter.h.

float vtkArcPlotter::DefaultNormal[3]
protected

Definition at line 163 of file vtkArcPlotter.h.

int vtkArcPlotter::UseDefaultNormal
protected

Definition at line 164 of file vtkArcPlotter.h.

int vtkArcPlotter::FieldDataArray
protected

Definition at line 165 of file vtkArcPlotter.h.


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