vtkRegularPolygonSource Class Reference
#include <vtkRegularPolygonSource.h>
Inheritance diagram for vtkRegularPolygonSource:
[legend]Collaboration diagram for vtkRegularPolygonSource:
[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.
Member Typedef Documentation
Constructor & Destructor Documentation
vtkRegularPolygonSource::vtkRegularPolygonSource |
( |
|
) |
[protected] |
|
vtkRegularPolygonSource::~vtkRegularPolygonSource |
( |
|
) |
[inline, protected] |
|
Member Function Documentation
|
Standard methods for instantiation, obtaining type and printing instance values.
Reimplemented from vtkPolyDataAlgorithm. |
virtual const char* vtkRegularPolygonSource::GetClassName |
( |
|
) |
[virtual] |
|
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. |
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. |
|
This is called by the superclass. This is the method you should override.
Reimplemented from vtkPolyDataAlgorithm. |
Member Data Documentation
The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:13:58 2008 for VTK by
1.4.3-20050530