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

create an arc between two end points More...

#include <vtkArcSource.h>

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

Public Types

typedef vtkPolyDataAlgorithm Superclass
 
- 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 Member Functions

virtual int IsA (const char *type)
 
vtkArcSourceNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent)
 
virtual void SetPoint1 (double, double, double)
 
virtual void SetPoint1 (double[3])
 
virtual double * GetPoint1 ()
 
virtual void GetPoint1 (double data[3])
 
virtual void SetPoint2 (double, double, double)
 
virtual void SetPoint2 (double[3])
 
virtual double * GetPoint2 ()
 
virtual void GetPoint2 (double data[3])
 
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 SetPolarVector (double, double, double)
 
virtual void SetPolarVector (double[3])
 
virtual double * GetPolarVector ()
 
virtual void GetPolarVector (double data[3])
 
virtual void SetAngle (double)
 
virtual double GetAngle ()
 
virtual void SetResolution (int)
 
virtual int GetResolution ()
 
virtual void SetNegative (bool)
 
virtual bool GetNegative ()
 
virtual void NegativeOn ()
 
virtual void NegativeOff ()
 
virtual void SetUseNormalAndAngle (bool)
 
virtual bool GetUseNormalAndAngle ()
 
virtual void UseNormalAndAngleOn ()
 
virtual void UseNormalAndAngleOff ()
 
- 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)
 

Static Public Member Functions

static vtkArcSourceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkArcSourceSafeDownCast (vtkObjectBase *o)
 
- 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 ()
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkArcSource (int res=1)
 
 ~vtkArcSource ()
 
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

double Point1 [3]
 
double Point2 [3]
 
double Center [3]
 
double Normal [3]
 
double PolarVector [3]
 
double Angle
 
int Resolution
 
bool Negative
 
bool UseNormalAndAngle
 
- Protected Attributes inherited from vtkAlgorithm
vtkInformation * Information
 
double Progress
 
char * ProgressText
 
unsigned long ErrorCode
 

Additional Inherited Members

- 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 an arc between two end points

vtkArcSource is a source object that creates an arc defined by two endpoints and a center. The number of segments composing the polyline is controlled by setting the object resolution. Alternatively, one can use a better API (that does not allow for inconsistent nor ambiguous inputs), using a starting point, a normal, and an angle. The default API being the original one, in order to use the improved API, one must switch the UseNormalAndAngle flag to TRUE.

The development of an improved, consistent API (based on point, normal, and angle) was supported by CEA/DIF - Commissariat a l'Energie Atomique, Centre DAM Ile-De-France, BP12, F-91297 Arpajon, France, and implemented by Philippe Pebay, Kitware SAS 2012.

Definition at line 38 of file vtkArcSource.h.

Member Typedef Documentation

Definition at line 42 of file vtkArcSource.h.

Constructor & Destructor Documentation

vtkArcSource::vtkArcSource ( int  res = 1)
protected
vtkArcSource::~vtkArcSource ( )
inlineprotected

Definition at line 113 of file vtkArcSource.h.

Member Function Documentation

static vtkArcSource* vtkArcSource::New ( )
static
static int vtkArcSource::IsTypeOf ( const char *  type)
static
virtual int vtkArcSource::IsA ( const char *  type)
virtual

Reimplemented from vtkPolyDataAlgorithm.

static vtkArcSource* vtkArcSource::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkArcSource::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

vtkArcSource* vtkArcSource::NewInstance ( ) const
void vtkArcSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
virtual void vtkArcSource::SetPoint1 ( double  ,
double  ,
double   
)
virtual

Set position of first end point.

virtual void vtkArcSource::SetPoint1 ( double  [3])
virtual

Set position of first end point.

virtual double* vtkArcSource::GetPoint1 ( )
virtual

Set position of first end point.

virtual void vtkArcSource::GetPoint1 ( double  data[3])
virtual

Set position of first end point.

virtual void vtkArcSource::SetPoint2 ( double  ,
double  ,
double   
)
virtual

Set position of other end point.

virtual void vtkArcSource::SetPoint2 ( double  [3])
virtual

Set position of other end point.

virtual double* vtkArcSource::GetPoint2 ( )
virtual

Set position of other end point.

virtual void vtkArcSource::GetPoint2 ( double  data[3])
virtual

Set position of other end point.

virtual void vtkArcSource::SetCenter ( double  ,
double  ,
double   
)
virtual

Set position of the center of the circle that define the arc. Note: you can use the function vtkMath::Solve3PointCircle to find the center from 3 points located on a circle.

virtual void vtkArcSource::SetCenter ( double  [3])
virtual

Set position of the center of the circle that define the arc. Note: you can use the function vtkMath::Solve3PointCircle to find the center from 3 points located on a circle.

virtual double* vtkArcSource::GetCenter ( )
virtual

Set position of the center of the circle that define the arc. Note: you can use the function vtkMath::Solve3PointCircle to find the center from 3 points located on a circle.

virtual void vtkArcSource::GetCenter ( double  data[3])
virtual

Set position of the center of the circle that define the arc. Note: you can use the function vtkMath::Solve3PointCircle to find the center from 3 points located on a circle.

virtual void vtkArcSource::SetNormal ( double  ,
double  ,
double   
)
virtual

Set normal vector. Note: This is only used when UseNormalAndRadius is ON.

virtual void vtkArcSource::SetNormal ( double  [3])
virtual

Set normal vector. Note: This is only used when UseNormalAndRadius is ON.

virtual double* vtkArcSource::GetNormal ( )
virtual

Set normal vector. Note: This is only used when UseNormalAndRadius is ON.

virtual void vtkArcSource::GetNormal ( double  data[3])
virtual

Set normal vector. Note: This is only used when UseNormalAndRadius is ON.

virtual void vtkArcSource::SetPolarVector ( double  ,
double  ,
double   
)
virtual

Set polar vector. Note: This is only used when UseNormalAndRadius is ON.

virtual void vtkArcSource::SetPolarVector ( double  [3])
virtual

Set polar vector. Note: This is only used when UseNormalAndRadius is ON.

virtual double* vtkArcSource::GetPolarVector ( )
virtual

Set polar vector. Note: This is only used when UseNormalAndRadius is ON.

virtual void vtkArcSource::GetPolarVector ( double  data[3])
virtual

Set polar vector. Note: This is only used when UseNormalAndRadius is ON.

virtual void vtkArcSource::SetAngle ( double  )
virtual

Angular sector occupied by the arc, beginning at Point1. Note: This is only used when UseNormalAndRadius is ON.

virtual double vtkArcSource::GetAngle ( )
virtual

Angular sector occupied by the arc, beginning at Point1. Note: This is only used when UseNormalAndRadius is ON.

virtual void vtkArcSource::SetResolution ( int  )
virtual

Divide line into resolution number of pieces. Note: if Resolution is set to 1 (default), the arc is a straight line.

virtual int vtkArcSource::GetResolution ( )
virtual

Divide line into resolution number of pieces. Note: if Resolution is set to 1 (default), the arc is a straight line.

virtual void vtkArcSource::SetNegative ( bool  )
virtual

Use the angle that is a negative coterminal of the vectors angle: the longest angle. Note: false by default.

virtual bool vtkArcSource::GetNegative ( )
virtual

Use the angle that is a negative coterminal of the vectors angle: the longest angle. Note: false by default.

virtual void vtkArcSource::NegativeOn ( )
virtual

Use the angle that is a negative coterminal of the vectors angle: the longest angle. Note: false by default.

virtual void vtkArcSource::NegativeOff ( )
virtual

Use the angle that is a negative coterminal of the vectors angle: the longest angle. Note: false by default.

virtual void vtkArcSource::SetUseNormalAndAngle ( bool  )
virtual

Activate the API based on normal and radius. The previous API (which remains the default) allows for inconsistent (when Point1 and Point2 are not equidistant from Center) or ambiguous (when Point1, Point2, and Center are aligned). Note: false by default.

virtual bool vtkArcSource::GetUseNormalAndAngle ( )
virtual

Activate the API based on normal and radius. The previous API (which remains the default) allows for inconsistent (when Point1 and Point2 are not equidistant from Center) or ambiguous (when Point1, Point2, and Center are aligned). Note: false by default.

virtual void vtkArcSource::UseNormalAndAngleOn ( )
virtual

Activate the API based on normal and radius. The previous API (which remains the default) allows for inconsistent (when Point1 and Point2 are not equidistant from Center) or ambiguous (when Point1, Point2, and Center are aligned). Note: false by default.

virtual void vtkArcSource::UseNormalAndAngleOff ( )
virtual

Activate the API based on normal and radius. The previous API (which remains the default) allows for inconsistent (when Point1 and Point2 are not equidistant from Center) or ambiguous (when Point1, Point2, and Center are aligned). Note: false by default.

int vtkArcSource::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 vtkArcSource::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protectedvirtual

Reimplemented from vtkPolyDataAlgorithm.

Member Data Documentation

double vtkArcSource::Point1[3]
protected

Definition at line 117 of file vtkArcSource.h.

double vtkArcSource::Point2[3]
protected

Definition at line 118 of file vtkArcSource.h.

double vtkArcSource::Center[3]
protected

Definition at line 119 of file vtkArcSource.h.

double vtkArcSource::Normal[3]
protected

Definition at line 120 of file vtkArcSource.h.

double vtkArcSource::PolarVector[3]
protected

Definition at line 121 of file vtkArcSource.h.

double vtkArcSource::Angle
protected

Definition at line 122 of file vtkArcSource.h.

int vtkArcSource::Resolution
protected

Definition at line 123 of file vtkArcSource.h.

bool vtkArcSource::Negative
protected

Definition at line 124 of file vtkArcSource.h.

bool vtkArcSource::UseNormalAndAngle
protected

Definition at line 125 of file vtkArcSource.h.


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