VTK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Protected Member Functions | Protected Attributes | List of all members
vtkRegularPolygonSource Class Reference

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

#include <vtkRegularPolygonSource.h>

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

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 ()
 
- Public Member Functions inherited from vtkPolyDataAlgorithm
vtkPolyDataAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
vtkDataObjectGetInput ()
 
vtkDataObjectGetInput (int port)
 
vtkPolyDataGetPolyDataInput (int port)
 
vtkPolyDataGetOutput ()
 
vtkPolyDataGetOutput (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
vtkAlgorithmNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
int HasExecutive ()
 
vtkExecutiveGetExecutive ()
 
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 ()
 
vtkDataObjectGetOutputDataObject (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 ()
 
vtkAlgorithmOutputGetInputConnection (int port, int index)
 
vtkAlgorithmGetInputAlgorithm (int port, int index, int &algPort)
 
vtkAlgorithmGetInputAlgorithm (int port, int index)
 
vtkExecutiveGetInputExecutive (int port, int index)
 
vtkInformation * GetInputInformation (int port, int index)
 
vtkInformation * GetOutputInformation (int port)
 
virtual void UpdateInformation ()
 
virtual void PropagateUpdateExtent ()
 
virtual void UpdateWholeExtent ()
 
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
 
virtual double ComputePriority ()
 
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)
 
vtkDataObjectGetInputDataObject (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)
 
vtkAlgorithmOutputGetOutputPort (int index)
 
vtkAlgorithmOutputGetOutputPort ()
 
vtkAlgorithmGetInputAlgorithm ()
 
vtkExecutiveGetInputExecutive ()
 
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)
 

Protected Member Functions

 vtkRegularPolygonSource ()
 
 ~vtkRegularPolygonSource ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
- Protected Member Functions inherited from vtkPolyDataAlgorithm
 vtkPolyDataAlgorithm ()
 
 ~vtkPolyDataAlgorithm ()
 
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 vtkExecutiveCreateDefaultExecutive ()
 
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 Attributes

int NumberOfSides
 
double Center [3]
 
double Normal [3]
 
double Radius
 
int GeneratePolygon
 
int GeneratePolyline
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 
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 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 }
 
- Static Public Member Functions inherited from vtkPolyDataAlgorithm
static vtkPolyDataAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkPolyDataAlgorithmSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkAlgorithm
static vtkAlgorithmNew ()
 
static int IsTypeOf (const char *type)
 
static vtkAlgorithmSafeDownCast (vtkObjectBase *o)
 
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
 
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 * PRESERVES_DATASET ()
 
static vtkInformationIntegerKey * PRESERVES_GEOMETRY ()
 
static vtkInformationIntegerKey * PRESERVES_BOUNDS ()
 
static vtkInformationIntegerKey * PRESERVES_TOPOLOGY ()
 
static vtkInformationIntegerKey * PRESERVES_ATTRIBUTES ()
 
static vtkInformationIntegerKey * PRESERVES_RANGES ()
 
static vtkInformationIntegerKey * MANAGES_METAINFORMATION ()
 
- 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 vtkExecutiveDefaultExecutivePrototype
 

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.

Definition at line 45 of file vtkRegularPolygonSource.h.

Constructor & Destructor Documentation

vtkRegularPolygonSource::vtkRegularPolygonSource ( )
protected
vtkRegularPolygonSource::~vtkRegularPolygonSource ( )
inlineprotected

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.

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 
)

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

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

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

Reimplemented from vtkPolyDataAlgorithm.

int vtkRegularPolygonSource::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

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: