create a regular, n-sided polygon and/or polyline More...
#include <vtkRegularPolygonSource.h>
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)
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
| vtkRegularPolygonSource::vtkRegularPolygonSource | ( | ) | [protected] |
| vtkRegularPolygonSource::~vtkRegularPolygonSource | ( | ) | [inline, protected] |
Definition at line 96 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.
| 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.
| static vtkRegularPolygonSource* vtkRegularPolygonSource::SafeDownCast | ( | vtkObjectBase * | o | ) | [static] |
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.
| 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 * | request, |
| vtkInformationVector ** | inputVector, | ||
| vtkInformationVector * | outputVector | ||
| ) | [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 101 of file vtkRegularPolygonSource.h.
double vtkRegularPolygonSource::Center[3] [protected] |
Definition at line 102 of file vtkRegularPolygonSource.h.
double vtkRegularPolygonSource::Normal[3] [protected] |
Definition at line 103 of file vtkRegularPolygonSource.h.
double vtkRegularPolygonSource::Radius [protected] |
Definition at line 104 of file vtkRegularPolygonSource.h.
int vtkRegularPolygonSource::GeneratePolygon [protected] |
Definition at line 105 of file vtkRegularPolygonSource.h.
int vtkRegularPolygonSource::GeneratePolyline [protected] |
Definition at line 106 of file vtkRegularPolygonSource.h.
The documentation for this class was generated from the following file:
- dox/Filters/Sources/vtkRegularPolygonSource.h
