VTK
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
vtkDataObjectGetInput ()
vtkDataObjectGetInput (int port)
vtkPolyDataGetPolyDataInput (int port)
vtkPolyDataGetOutput ()
vtkPolyDataGetOutput (int)
virtual void SetOutput (vtkDataObject *d)
virtual int ProcessRequest (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
void SetInput (vtkDataObject *)
void SetInput (int, vtkDataObject *)
void AddInput (vtkDataObject *)
void AddInput (int, vtkDataObject *)
- Public Member Functions inherited from vtkAlgorithm
int HasExecutive ()
vtkExecutiveGetExecutive ()
virtual void SetExecutive (vtkExecutive *executive)
virtual int ModifyRequest (vtkInformation *request, int when)
vtkInformationGetInputPortInformation (int port)
vtkInformationGetOutputPortInformation (int port)
int GetNumberOfInputPorts ()
int GetNumberOfOutputPorts ()
void UpdateProgress (double amount)
vtkInformationGetInputArrayInformation (int idx)
void RemoveAllInputs ()
vtkDataObjectGetOutputDataObject (int port)
virtual void RemoveInputConnection (int port, vtkAlgorithmOutput *input)
int GetNumberOfInputConnections (int port)
int GetTotalNumberOfInputConnections ()
vtkAlgorithmOutputGetInputConnection (int port, int index)
virtual void Update ()
virtual void UpdateInformation ()
virtual void UpdateWholeExtent ()
void ConvertTotalInputToPortConnection (int ind, int &port, int &conn)
virtual double ComputePriority ()
int ProcessRequest (vtkInformation *request, vtkCollection *inInfo, vtkInformationVector *outInfo)
virtual int ComputePipelineMTime (vtkInformation *request, vtkInformationVector **inInfoVec, vtkInformationVector *outInfoVec, int requestFromOutputPort, unsigned long *mtime)
virtual vtkInformationGetInformation ()
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)
vtkAlgorithmOutputGetOutputPort (int index)
vtkAlgorithmOutputGetOutputPort ()
virtual void SetReleaseDataFlag (int)
virtual int GetReleaseDataFlag ()
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
int UpdateExtentIsEmpty (vtkDataObject *output)
int UpdateExtentIsEmpty (vtkInformation *pinfo, int extentType)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char 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)
vtkCommandGetCommand (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)
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 &os)
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 *)
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 *)
virtual void ExecuteData (vtkDataObject *output)
virtual void Execute ()
- 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)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkDataArrayGetInputArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input)
vtkDataArrayGetInputArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, int connection, vtkInformationVector **inputVector, int &association)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input)
vtkAbstractArrayGetInputAbstractArrayToProcess (int idx, vtkDataObject *input, int &association)
vtkInformationGetInputArrayFieldInformation (int idx, vtkInformationVector **inputVector)
virtual void SetNthInputConnection (int port, int index, vtkAlgorithmOutput *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 &os)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

int NumberOfSides
double Center [3]
double Normal [3]
double Radius
int GeneratePolygon
int GeneratePolyline
typedef vtkPolyDataAlgorithm Superclass
static vtkRegularPolygonSourceNew ()
static int IsTypeOf (const char *type)
static vtkRegularPolygonSourceSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Additional Inherited Members

- Public Types inherited from vtkPolyDataAlgorithm
typedef vtkAlgorithm Superclass
- Static Public Member Functions inherited from vtkAlgorithm
static void SetDefaultExecutivePrototype (vtkExecutive *proto)
static vtkInformationIntegerKeyINPUT_IS_OPTIONAL ()
static vtkInformationIntegerKeyINPUT_IS_REPEATABLE ()
static
vtkInformationInformationVectorKey
INPUT_REQUIRED_FIELDS ()
static
vtkInformationStringVectorKey
INPUT_REQUIRED_DATA_TYPE ()
static
vtkInformationInformationVectorKey
INPUT_ARRAYS_TO_PROCESS ()
static vtkInformationIntegerKeyINPUT_PORT ()
static vtkInformationIntegerKeyINPUT_CONNECTION ()
static vtkInformationIntegerKeyPRESERVES_DATASET ()
static vtkInformationIntegerKeyPRESERVES_GEOMETRY ()
static vtkInformationIntegerKeyPRESERVES_BOUNDS ()
static vtkInformationIntegerKeyPRESERVES_TOPOLOGY ()
static vtkInformationIntegerKeyPRESERVES_ATTRIBUTES ()
static vtkInformationIntegerKeyPRESERVES_RANGES ()
- Public Attributes inherited from vtkAlgorithm
int AbortExecute
- Static Protected Member Functions inherited from vtkAlgorithm
static vtkInformationIntegerKeyPORT_REQUIREMENTS_FILLED ()
- Static Protected Attributes inherited from vtkAlgorithm
static vtkExecutiveDefaultExecutivePrototype
- Friends inherited from vtkObject

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.

Member Typedef Documentation

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

Definition at line 44 of file vtkRegularPolygonSource.h.

Constructor & Destructor Documentation

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

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 
)
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 100 of file vtkRegularPolygonSource.h.

double vtkRegularPolygonSource::Center[3]
protected

Definition at line 101 of file vtkRegularPolygonSource.h.

double vtkRegularPolygonSource::Normal[3]
protected

Definition at line 102 of file vtkRegularPolygonSource.h.

double vtkRegularPolygonSource::Radius
protected

Definition at line 103 of file vtkRegularPolygonSource.h.

int vtkRegularPolygonSource::GeneratePolygon
protected

Definition at line 104 of file vtkRegularPolygonSource.h.

int vtkRegularPolygonSource::GeneratePolyline
protected

Definition at line 105 of file vtkRegularPolygonSource.h.


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