VTK
Protected Member Functions | Protected Attributes
vtkRegularPolygonSource Class Reference

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

#include <vtkRegularPolygonSource.h>

Inheritance diagram for vtkRegularPolygonSource:
Inheritance graph
[legend]
Collaboration diagram for vtkRegularPolygonSource:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual void SetNumberOfSides (int)
virtual int GetNumberOfSides ()
virtual void SetCenter (double, double, double)
virtual void SetCenter (double[3])
virtual doubleGetCenter ()
virtual void GetCenter (double data[3])
virtual void SetNormal (double, double, double)
virtual void SetNormal (double[3])
virtual doubleGetNormal ()
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
typedef vtkPolyDataAlgorithm Superclass
static vtkRegularPolygonSourceNew ()
static int IsTypeOf (const char *type)
static vtkRegularPolygonSourceSafeDownCast (vtkObjectBase *o)
virtual int IsA (const char *type)
vtkRegularPolygonSourceNewInstance () const
void PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBaseNewInstanceInternal () const

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.

Examples:
vtkRegularPolygonSource (Examples)
Tests:
vtkRegularPolygonSource (Tests)

Definition at line 38 of file vtkRegularPolygonSource.h.


Member Typedef Documentation

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

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 45 of file vtkRegularPolygonSource.h.


Constructor & Destructor Documentation

Definition at line 96 of file vtkRegularPolygonSource.h.


Member Function Documentation

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

Reimplemented from vtkPolyDataAlgorithm.

static int vtkRegularPolygonSource::IsTypeOf ( const char *  type) [static]

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

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkRegularPolygonSource::IsA ( const char *  type) [virtual]

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

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

virtual vtkObjectBase* vtkRegularPolygonSource::NewInstanceInternal ( ) const [protected, virtual]

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

Reimplemented from vtkPolyDataAlgorithm.

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

Reimplemented from vtkPolyDataAlgorithm.

void vtkRegularPolygonSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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

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.

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

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

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.

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.

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.

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.

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

int vtkRegularPolygonSource::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.

Reimplemented from vtkPolyDataAlgorithm.


Member Data Documentation

Definition at line 101 of file vtkRegularPolygonSource.h.

Definition at line 102 of file vtkRegularPolygonSource.h.

Definition at line 103 of file vtkRegularPolygonSource.h.

Definition at line 104 of file vtkRegularPolygonSource.h.

Definition at line 105 of file vtkRegularPolygonSource.h.

Definition at line 106 of file vtkRegularPolygonSource.h.


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