vtkRegularPolygonSource Class Reference

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

#include <vtkRegularPolygonSource.h>

Inheritance diagram for vtkRegularPolygonSource:

Collaboration diagram for vtkRegularPolygonSource:

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 ()
virtual void	SetOutputPointsPrecision (int)
virtual int	GetOutputPointsPrecision ()
Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithm *	NewInstance () const
vtkDataObject *	GetInput ()
vtkDataObject *	GetInput (int port)
vtkPolyData *	GetPolyDataInput (int port)
vtkPolyData *	GetOutput ()
vtkPolyData *	GetOutput (int)
virtual void	SetOutput (vtkDataObject *d)
virtual int	ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void	SetInputData (vtkDataObject *)
void	SetInputData (int, vtkDataObject *)
void	AddInputData (vtkDataObject *)
void	AddInputData (int, vtkDataObject *)
Public Member Functions inherited from vtkAlgorithm
vtkAlgorithm *	NewInstance () const
int	HasExecutive ()
vtkExecutive *	GetExecutive ()
virtual void	SetExecutive (vtkExecutive *executive)
virtual int	ModifyRequest (vtkInformation *request, int when)
vtkInformation *	GetInputPortInformation (int port)
vtkInformation *	GetOutputPortInformation (int port)
int	GetNumberOfInputPorts ()
int	GetNumberOfOutputPorts ()
void	UpdateProgress (double amount)
vtkInformation *	GetInputArrayInformation (int idx)
void	RemoveAllInputs ()
vtkDataObject *	GetOutputDataObject (int port)
virtual void	RemoveInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	RemoveInputConnection (int port, int idx)
virtual void	RemoveAllInputConnections (int port)
int	GetNumberOfInputConnections (int port)
int	GetTotalNumberOfInputConnections ()
vtkAlgorithmOutput *	GetInputConnection (int port, int index)
vtkAlgorithm *	GetInputAlgorithm (int port, int index, int &algPort)
vtkAlgorithm *	GetInputAlgorithm (int port, int index)
vtkExecutive *	GetInputExecutive (int port, int index)
vtkInformation *	GetInputInformation (int port, int index)
vtkInformation *	GetOutputInformation (int port)
virtual void	UpdateInformation ()
virtual void	UpdateDataObject ()
virtual void	PropagateUpdateExtent ()
virtual void	UpdateWholeExtent ()
void	ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
int	SetUpdateExtentToWholeExtent (int port)
int	SetUpdateExtentToWholeExtent ()
void	SetUpdateExtent (int port, int extent[6])
int	ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int	ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformation *	GetInformation ()
virtual void	SetInformation (vtkInformation *)
virtual void	Register (vtkObjectBase *o)
virtual void	UnRegister (vtkObjectBase *o)
virtual void	SetAbortExecute (int)
virtual int	GetAbortExecute ()
virtual void	AbortExecuteOn ()
virtual void	AbortExecuteOff ()
virtual void	SetProgress (double)
virtual double	GetProgress ()
void	SetProgressText (const char *ptext)
virtual char *	GetProgressText ()
virtual unsigned long	GetErrorCode ()
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, const char *name)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, int fieldAssociation, int fieldAttributeType)
virtual void	SetInputArrayToProcess (int idx, vtkInformation *info)
virtual void	SetInputArrayToProcess (int idx, int port, int connection, const char *fieldAssociation, const char *attributeTypeorName)
vtkDataObject *	GetInputDataObject (int port, int connection)
virtual void	SetInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	SetInputConnection (vtkAlgorithmOutput *input)
virtual void	AddInputConnection (int port, vtkAlgorithmOutput *input)
virtual void	AddInputConnection (vtkAlgorithmOutput *input)
virtual void	SetInputDataObject (int port, vtkDataObject *data)
virtual void	SetInputDataObject (vtkDataObject *data)
virtual void	AddInputDataObject (int port, vtkDataObject *data)
virtual void	AddInputDataObject (vtkDataObject *data)
vtkAlgorithmOutput *	GetOutputPort (int index)
vtkAlgorithmOutput *	GetOutputPort ()
vtkAlgorithm *	GetInputAlgorithm ()
vtkExecutive *	GetInputExecutive ()
vtkInformation *	GetInputInformation ()
virtual void	Update (int port)
virtual void	Update ()
virtual void	SetReleaseDataFlag (int)
virtual int	GetReleaseDataFlag ()
void	ReleaseDataFlagOn ()
void	ReleaseDataFlagOff ()
int	UpdateExtentIsEmpty (vtkInformation *pinfo, vtkDataObject *output)
int	UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
void	SetUpdateExtent (int port, int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int piece, int numPieces, int ghostLevel)
void	SetUpdateExtent (int extent[6])
int *	GetUpdateExtent ()
int *	GetUpdateExtent (int port)
void	GetUpdateExtent (int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int port, int &x0, int &x1, int &y0, int &y1, int &z0, int &z1)
void	GetUpdateExtent (int extent[6])
void	GetUpdateExtent (int port, int extent[6])
int	GetUpdatePiece ()
int	GetUpdatePiece (int port)
int	GetUpdateNumberOfPieces ()
int	GetUpdateNumberOfPieces (int port)
int	GetUpdateGhostLevel ()
int	GetUpdateGhostLevel (int port)
void	SetProgressObserver (vtkProgressObserver *)
virtual vtkProgressObserver *	GetProgressObserver ()
Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const
virtual void	DebugOn ()
virtual void	DebugOff ()
bool	GetDebug ()
void	SetDebug (bool debugFlag)
virtual void	Modified ()
virtual unsigned long	GetMTime ()
unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long	AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommand *	GetCommand (unsigned long tag)
void	RemoveObserver (vtkCommand *)
void	RemoveObservers (unsigned long event, vtkCommand *)
void	RemoveObservers (const char *event, vtkCommand *)
int	HasObserver (unsigned long event, vtkCommand *)
int	HasObserver (const char *event, vtkCommand *)
void	RemoveObserver (unsigned long tag)
void	RemoveObservers (unsigned long event)
void	RemoveObservers (const char *event)
void	RemoveAllObservers ()
int	HasObserver (unsigned long event)
int	HasObserver (const char *event)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int	InvokeEvent (unsigned long event, void *callData)
int	InvokeEvent (const char *event, void *callData)
int	InvokeEvent (unsigned long event)
int	InvokeEvent (const char *event)
Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
virtual void	Delete ()
virtual void	FastDelete ()
void	Print (ostream &os)
void	SetReferenceCount (int)
void	PrintRevisions (ostream &)
virtual void	PrintHeader (ostream &os, vtkIndent indent)
virtual void	PrintTrailer (ostream &os, vtkIndent indent)
int	GetReferenceCount ()

Protected Member Functions
	vtkRegularPolygonSource ()
	~vtkRegularPolygonSource ()
int	RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Member Functions inherited from vtkPolyDataAlgorithm
	vtkPolyDataAlgorithm ()
	~vtkPolyDataAlgorithm ()
virtual int	RequestInformation (vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector)
virtual int	FillOutputPortInformation (int port, vtkInformation *info)
virtual int	FillInputPortInformation (int port, vtkInformation *info)
virtual int	RequestUpdateExtent (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
Protected Member Functions inherited from vtkAlgorithm
	vtkAlgorithm ()
	~vtkAlgorithm ()
virtual void	SetNumberOfInputPorts (int n)
virtual void	SetNumberOfOutputPorts (int n)
int	InputPortIndexInRange (int index, const char *action)
int	OutputPortIndexInRange (int index, const char *action)
int	GetInputArrayAssociation (int idx, vtkInformationVector **inputVector)
virtual vtkExecutive *	CreateDefaultExecutive ()
virtual void	ReportReferences (vtkGarbageCollector *)
virtual void	SetNumberOfInputConnections (int port, int n)
int	GetInputArrayAssociation (int idx, int connection, vtkInformationVector **inputVector)
int	GetInputArrayAssociation (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArray *	GetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArray *	GetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArray *	GetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformation *	GetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void	SetNthInputConnection (int port, int index, vtkAlgorithmOutput *input)
void	SetInputDataInternal (int port, vtkDataObject *input)
void	AddInputDataInternal (int port, vtkDataObject *input)
virtual void	SetErrorCode (unsigned long)
Protected Member Functions inherited from vtkObject
	vtkObject ()
virtual	~vtkObject ()
virtual void	RegisterInternal (vtkObjectBase *, int check)
virtual void	UnRegisterInternal (vtkObjectBase *, int check)
void	InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void	InternalReleaseFocus ()
Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()
virtual	~vtkObjectBase ()
virtual void	CollectRevisions (ostream &)
	vtkObjectBase (const vtkObjectBase &)
void	operator= (const vtkObjectBase &)

Protected Attributes
int	NumberOfSides
double	Center [3]
double	Normal [3]
double	Radius
int	GeneratePolygon
int	GeneratePolyline
int	OutputPointsPrecision
Protected Attributes inherited from vtkAlgorithm
vtkInformation *	Information
double	Progress
char *	ProgressText
vtkProgressObserver *	ProgressObserver
unsigned long	ErrorCode
Protected Attributes inherited from vtkObject
bool	Debug
vtkTimeStamp	MTime
vtkSubjectHelper *	SubjectHelper
Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount
vtkWeakPointerBase **	WeakPointers
typedef vtkPolyDataAlgorithm	Superclass
static vtkRegularPolygonSource *	New ()
static int	IsTypeOf (const char *type)
static vtkRegularPolygonSource *	SafeDownCast (vtkObjectBase *o)
virtual int	IsA (const char *type)
vtkRegularPolygonSource *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent)
virtual vtkObjectBase *	NewInstanceInternal () const

Additional Inherited Members
Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm	Superclass
Public Types inherited from vtkAlgorithm
typedef vtkObject	Superclass
enum	DesiredOutputPrecision { SINGLE_PRECISION, DOUBLE_PRECISION, DEFAULT_PRECISION }
Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass
Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkPolyDataAlgorithm *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithm *	New ()
static int	IsTypeOf (const char *type)
static vtkAlgorithm *	SafeDownCast (vtkObjectBase *o)
static vtkInformationIntegerKey *	INPUT_IS_OPTIONAL ()
static vtkInformationIntegerKey *	INPUT_IS_REPEATABLE ()
static vtkInformationInformationVectorKey *	INPUT_REQUIRED_FIELDS ()
static vtkInformationStringVectorKey *	INPUT_REQUIRED_DATA_TYPE ()
static vtkInformationInformationVectorKey *	INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKey *	INPUT_PORT ()
static vtkInformationIntegerKey *	INPUT_CONNECTION ()
static vtkInformationIntegerKey *	CAN_PRODUCE_SUB_EXTENT ()
static vtkInformationIntegerKey *	CAN_HANDLE_PIECE_REQUEST ()
static void	SetDefaultExecutivePrototype (vtkExecutive *proto)
Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)
static vtkObject *	SafeDownCast (vtkObjectBase *o)
static vtkObject *	New ()
static void	BreakOnError ()
static void	SetGlobalWarningDisplay (int val)
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
static int	GetGlobalWarningDisplay ()
Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)
static vtkObjectBase *	New ()
Public Attributes inherited from vtkAlgorithm
int	AbortExecute
Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKey *	PORT_REQUIREMENTS_FILLED ()
Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutive *	DefaultExecutivePrototype

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

typedef vtkPolyDataAlgorithm vtkRegularPolygonSource::Superclass

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

Definition at line 45 of file vtkRegularPolygonSource.h.

Constructor & Destructor Documentation

vtkRegularPolygonSource::vtkRegularPolygonSource ( )

protected

vtkRegularPolygonSource::~vtkRegularPolygonSource ( )

inlineprotected

Definition at line 105 of file vtkRegularPolygonSource.h.

Member Function Documentation

static vtkRegularPolygonSource* vtkRegularPolygonSource::New ( )

static

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

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

static

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

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.

virtual vtkObjectBase* vtkRegularPolygonSource::NewInstanceInternal ( ) const

protectedvirtual

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

Reimplemented from vtkPolyDataAlgorithm.

vtkRegularPolygonSource* vtkRegularPolygonSource::NewInstance

(

)

const

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

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.

virtual void vtkRegularPolygonSource::SetOutputPointsPrecision ( int  )

virtual

Set/get the desired precision for the output points. vtkAlgorithm::SINGLE_PRECISION - Output single-precision floating point. vtkAlgorithm::DOUBLE_PRECISION - Output double-precision floating point.

virtual int vtkRegularPolygonSource::GetOutputPointsPrecision ( )

virtual

Set/get the desired precision for the output points. vtkAlgorithm::SINGLE_PRECISION - Output single-precision floating point. vtkAlgorithm::DOUBLE_PRECISION - Output double-precision floating point.

int vtkRegularPolygonSource::RequestData ( vtkInformation *  request, vtkInformationVector **  inputVector, vtkInformationVector *  outputVector  )

protectedvirtual

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

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

int vtkRegularPolygonSource::NumberOfSides

protected

Definition at line 109 of file vtkRegularPolygonSource.h.

double vtkRegularPolygonSource::Center[3]

protected

Definition at line 110 of file vtkRegularPolygonSource.h.

double vtkRegularPolygonSource::Normal[3]

protected

Definition at line 111 of file vtkRegularPolygonSource.h.

double vtkRegularPolygonSource::Radius

protected

Definition at line 112 of file vtkRegularPolygonSource.h.

int vtkRegularPolygonSource::GeneratePolygon

protected

Definition at line 113 of file vtkRegularPolygonSource.h.

int vtkRegularPolygonSource::GeneratePolyline

protected

Definition at line 114 of file vtkRegularPolygonSource.h.

int vtkRegularPolygonSource::OutputPointsPrecision

protected

Definition at line 115 of file vtkRegularPolygonSource.h.

---

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

• dox/Filters/Sources/vtkRegularPolygonSource.h