vtkArrowSource Class Reference

#include <vtkArrowSource.h>

Inheritance diagram for vtkArrowSource:

Inheritance graph
[legend]
Collaboration diagram for vtkArrowSource:

Collaboration graph
[legend]

List of all members.


Detailed Description

Appends a cylinder to a cone to form an arrow.

vtkArrowSource was intended to be used as the source for a glyph. The shaft base is always at (0,0,0). The arrow tip is always at (1,0,0). If "Invert" is true, then the ends are flipped i.e. tip is at (0,0,0) while base is at (1, 0, 0). The resolution of the cone and shaft can be set and default to 6. The radius of the cone and shaft can be set and default to 0.03 and 0.1. The length of the tip can also be set, and defaults to 0.35.

Tests:
vtkArrowSource (Tests)

Definition at line 35 of file vtkArrowSource.h.


Public Types

typedef vtkPolyDataAlgorithm Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
virtual void SetTipLength (double)
virtual double GetTipLength ()
virtual void SetTipRadius (double)
virtual double GetTipRadius ()
virtual void SetTipResolution (int)
virtual int GetTipResolution ()
virtual void SetShaftRadius (double)
virtual double GetShaftRadius ()
virtual void SetShaftResolution (int)
virtual int GetShaftResolution ()
virtual void InvertOn ()
virtual void InvertOff ()
virtual void SetInvert (bool)
virtual bool GetInvert ()

Static Public Member Functions

static vtkArrowSourceNew ()
static int IsTypeOf (const char *type)
static vtkArrowSourceSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkArrowSource ()
 ~vtkArrowSource ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

int TipResolution
double TipLength
double TipRadius
int ShaftResolution
double ShaftRadius
bool Invert

Member Typedef Documentation

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 41 of file vtkArrowSource.h.


Constructor & Destructor Documentation

vtkArrowSource::vtkArrowSource (  )  [protected]

vtkArrowSource::~vtkArrowSource (  )  [inline, protected]

Definition at line 83 of file vtkArrowSource.h.


Member Function Documentation

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

Construct cone with angle of 45 degrees.

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

static int vtkArrowSource::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 vtkArrowSource::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 vtkArrowSource* vtkArrowSource::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkPolyDataAlgorithm.

void vtkArrowSource::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 vtkArrowSource::SetTipLength ( double   )  [virtual]

Set the length, and radius of the tip. They default to 0.35 and 0.1

virtual double vtkArrowSource::GetTipLength (  )  [virtual]

Set the length, and radius of the tip. They default to 0.35 and 0.1

virtual void vtkArrowSource::SetTipRadius ( double   )  [virtual]

Set the length, and radius of the tip. They default to 0.35 and 0.1

virtual double vtkArrowSource::GetTipRadius (  )  [virtual]

Set the length, and radius of the tip. They default to 0.35 and 0.1

virtual void vtkArrowSource::SetTipResolution ( int   )  [virtual]

Set the resolution of the tip. The tip behaves the same as a cone. Resoultion 1 gives a single triangle, 2 gives two crossed triangles.

virtual int vtkArrowSource::GetTipResolution (  )  [virtual]

Set the resolution of the tip. The tip behaves the same as a cone. Resoultion 1 gives a single triangle, 2 gives two crossed triangles.

virtual void vtkArrowSource::SetShaftRadius ( double   )  [virtual]

Set the radius of the shaft. Defaults to 0.03.

virtual double vtkArrowSource::GetShaftRadius (  )  [virtual]

Set the radius of the shaft. Defaults to 0.03.

virtual void vtkArrowSource::SetShaftResolution ( int   )  [virtual]

Set the resolution of the shaft. 2 gives a rectangle. I would like to extend the cone to produce a line, but this is not an option now.

virtual int vtkArrowSource::GetShaftResolution (  )  [virtual]

Set the resolution of the shaft. 2 gives a rectangle. I would like to extend the cone to produce a line, but this is not an option now.

virtual void vtkArrowSource::InvertOn (  )  [virtual]

Inverts the arrow direction. When set to true, base is at (1, 0, 0) while the tip is at (0, 0, 0). The default is false, i.e. base at (0, 0, 0) and the tip at (1, 0, 0).

virtual void vtkArrowSource::InvertOff (  )  [virtual]

Inverts the arrow direction. When set to true, base is at (1, 0, 0) while the tip is at (0, 0, 0). The default is false, i.e. base at (0, 0, 0) and the tip at (1, 0, 0).

virtual void vtkArrowSource::SetInvert ( bool   )  [virtual]

Inverts the arrow direction. When set to true, base is at (1, 0, 0) while the tip is at (0, 0, 0). The default is false, i.e. base at (0, 0, 0) and the tip at (1, 0, 0).

virtual bool vtkArrowSource::GetInvert (  )  [virtual]

Inverts the arrow direction. When set to true, base is at (1, 0, 0) while the tip is at (0, 0, 0). The default is false, i.e. base at (0, 0, 0) and the tip at (1, 0, 0).

int vtkArrowSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

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

Reimplemented from vtkPolyDataAlgorithm.


Member Data Documentation

Definition at line 87 of file vtkArrowSource.h.

double vtkArrowSource::TipLength [protected]

Definition at line 88 of file vtkArrowSource.h.

double vtkArrowSource::TipRadius [protected]

Definition at line 89 of file vtkArrowSource.h.

Definition at line 91 of file vtkArrowSource.h.

double vtkArrowSource::ShaftRadius [protected]

Definition at line 92 of file vtkArrowSource.h.

bool vtkArrowSource::Invert [protected]

Definition at line 93 of file vtkArrowSource.h.


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

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