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.

Examples:: vtkRegularPolygonSource (Examples)

Tests:: vtkRegularPolygonSource (Tests)

Definition at line 37 of file vtkRegularPolygonSource.h.


typedef vtkPolyDataAlgorithm	Superclass
static vtkRegularPolygonSource *	New ()
static int	IsTypeOf (const char *type)
static vtkRegularPolygonSource *	SafeDownCast (vtkObject *o)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
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

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

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 44 of file vtkRegularPolygonSource.h.

Constructor & Destructor Documentation

vtkRegularPolygonSource::vtkRegularPolygonSource ( ) [protected]

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

Definition at line 95 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]

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

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]`