Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkRegularPolygonSource Class Reference

#include <vtkRegularPolygonSource.h>

Inheritance diagram for vtkRegularPolygonSource:

Inheritance graph
[legend]
Collaboration diagram for vtkRegularPolygonSource:

Collaboration graph
[legend]
List of all members.

Detailed Description

create a regular, n-sided polygon and/or polyline

vtkRegularPolygonSource is a source object that creates a single n-sided polygon and/or polyline. The polygon is centered at a specified point, orthogonal to a specified normal, and with a circumscribing radius set by the user. The user can also specify the number of sides of the polygon ranging from [3,N].

This object can be used for seeding streamlines or defining regions for clipping/cutting.

Tests:
vtkRegularPolygonSource (Tests)

Definition at line 34 of file vtkRegularPolygonSource.h.
typedef vtkPolyDataAlgorithm Superclass
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
static vtkRegularPolygonSourceNew ()
static int IsTypeOf (const char *type)
static vtkRegularPolygonSourceSafeDownCast (vtkObject *o)

Public Member Functions

virtual void SetNumberOfSides (int)
virtual int GetNumberOfSides ()
virtual void SetCenter (double, double, double)
virtual void SetCenter (double[3])
virtual double * GetCenter ()
virtual void GetCenter (double data[3])
virtual void SetNormal (double, double, double)
virtual void SetNormal (double[3])
virtual double * GetNormal ()
virtual void GetNormal (double data[3])
virtual void SetRadius (double)
virtual double GetRadius ()
virtual void SetGeneratePolygon (int)
virtual int GetGeneratePolygon ()
virtual void GeneratePolygonOn ()
virtual void GeneratePolygonOff ()
virtual void SetGeneratePolyline (int)
virtual int GetGeneratePolyline ()
virtual void GeneratePolylineOn ()
virtual void GeneratePolylineOff ()

Protected Member Functions

 vtkRegularPolygonSource ()
 ~vtkRegularPolygonSource ()
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)

Protected Attributes

int NumberOfSides
double Center [3]
double Normal [3]
double Radius
int GeneratePolygon
int GeneratePolyline


Member Typedef Documentation

typedef vtkPolyDataAlgorithm vtkRegularPolygonSource::Superclass
 

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 41 of file vtkRegularPolygonSource.h.


Constructor & Destructor Documentation

vtkRegularPolygonSource::vtkRegularPolygonSource  )  [protected]
 

vtkRegularPolygonSource::~vtkRegularPolygonSource  )  [inline, protected]
 

Definition at line 92 of file vtkRegularPolygonSource.h.


Member Function Documentation

static vtkRegularPolygonSource* vtkRegularPolygonSource::New  )  [static]
 

Standard methods for instantiation, obtaining type and printing instance values.

Reimplemented from vtkPolyDataAlgorithm.

virtual const char* vtkRegularPolygonSource::GetClassName  )  [virtual]
 

Reimplemented from vtkPolyDataAlgorithm.

static int vtkRegularPolygonSource::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkRegularPolygonSource::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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

static vtkRegularPolygonSource* vtkRegularPolygonSource::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkPolyDataAlgorithm.

void vtkRegularPolygonSource::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 vtkRegularPolygonSource::SetNumberOfSides int   )  [virtual]
 

Set/Get the number of sides of the polygon. By default, the number of sides is set to six.

virtual int vtkRegularPolygonSource::GetNumberOfSides  )  [virtual]
 

Set/Get the number of sides of the polygon. By default, the number of sides is set to six.

virtual void vtkRegularPolygonSource::SetCenter double  ,
double  ,
double 
[virtual]
 

Set/Get the center of the polygon. By default, the center is set at the origin (0,0,0).

virtual void vtkRegularPolygonSource::SetCenter double  [3]  )  [virtual]
 

Set/Get the center of the polygon. By default, the center is set at the origin (0,0,0).

virtual double* vtkRegularPolygonSource::GetCenter  )  [virtual]
 

Set/Get the center of the polygon. By default, the center is set at the origin (0,0,0).

virtual void vtkRegularPolygonSource::GetCenter double  data[3]  )  [virtual]
 

Set/Get the center of the polygon. By default, the center is set at the origin (0,0,0).

virtual void vtkRegularPolygonSource::SetNormal double  ,
double  ,
double 
[virtual]
 

Set/Get the normal to the polygon. The ordering of the polygon will be counter-clockwise around the normal (i.e., using the right-hand rule). By default, the normal is set to (0,0,1).

virtual void vtkRegularPolygonSource::SetNormal double  [3]  )  [virtual]
 

Set/Get the normal to the polygon. The ordering of the polygon will be counter-clockwise around the normal (i.e., using the right-hand rule). By default, the normal is set to (0,0,1).

virtual double* vtkRegularPolygonSource::GetNormal  )  [virtual]
 

Set/Get the normal to the polygon. The ordering of the polygon will be counter-clockwise around the normal (i.e., using the right-hand rule). By default, the normal is set to (0,0,1).

virtual void vtkRegularPolygonSource::GetNormal double  data[3]  )  [virtual]
 

Set/Get the normal to the polygon. The ordering of the polygon will be counter-clockwise around the normal (i.e., using the right-hand rule). By default, the normal is set to (0,0,1).

virtual void vtkRegularPolygonSource::SetRadius double   )  [virtual]
 

Set/Get the radius of the polygon. By default, the radius is set to 0.5.

virtual double vtkRegularPolygonSource::GetRadius  )  [virtual]
 

Set/Get the radius of the polygon. By default, the radius is set to 0.5.

virtual void vtkRegularPolygonSource::SetGeneratePolygon int   )  [virtual]
 

Control whether a polygon is produced. By default, GeneratePolygon is enabled.

virtual int vtkRegularPolygonSource::GetGeneratePolygon  )  [virtual]
 

Control whether a polygon is produced. By default, GeneratePolygon is enabled.

virtual void vtkRegularPolygonSource::GeneratePolygonOn  )  [virtual]
 

Control whether a polygon is produced. By default, GeneratePolygon is enabled.

virtual void vtkRegularPolygonSource::GeneratePolygonOff  )  [virtual]
 

Control whether a polygon is produced. By default, GeneratePolygon is enabled.

virtual void vtkRegularPolygonSource::SetGeneratePolyline int   )  [virtual]
 

Control whether a polyline is produced. By default, GeneratePolyline is enabled.

virtual int vtkRegularPolygonSource::GetGeneratePolyline  )  [virtual]
 

Control whether a polyline is produced. By default, GeneratePolyline is enabled.

virtual void vtkRegularPolygonSource::GeneratePolylineOn  )  [virtual]
 

Control whether a polyline is produced. By default, GeneratePolyline is enabled.

virtual void vtkRegularPolygonSource::GeneratePolylineOff  )  [virtual]
 

Control whether a polyline is produced. By default, GeneratePolyline is enabled.

int vtkRegularPolygonSource::RequestData vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector
[protected, virtual]
 

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

Reimplemented from vtkPolyDataAlgorithm.

int vtkRegularPolygonSource::RequestInformation vtkInformation ,
vtkInformationVector **  ,
vtkInformationVector
[protected, virtual]
 

Reimplemented from vtkPolyDataAlgorithm.


Member Data Documentation

int vtkRegularPolygonSource::NumberOfSides [protected]
 

Definition at line 97 of file vtkRegularPolygonSource.h.

double vtkRegularPolygonSource::Center[3] [protected]
 

Definition at line 98 of file vtkRegularPolygonSource.h.

double vtkRegularPolygonSource::Normal[3] [protected]
 

Definition at line 99 of file vtkRegularPolygonSource.h.

double vtkRegularPolygonSource::Radius [protected]
 

Definition at line 100 of file vtkRegularPolygonSource.h.

int vtkRegularPolygonSource::GeneratePolygon [protected]
 

Definition at line 101 of file vtkRegularPolygonSource.h.

int vtkRegularPolygonSource::GeneratePolyline [protected]
 

Definition at line 102 of file vtkRegularPolygonSource.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:13:58 2008 for VTK by  doxygen 1.4.3-20050530