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>

Inherits vtkPolyDataAlgorithm.

Public Types

typedef vtkPolyDataAlgorithm Superclass
 

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

Static Public Member Functions

static vtkArcSourceNew ()
 
static int IsTypeOf (const char *type)
 
static vtkArcSourceSafeDownCast (vtkObjectBase *o)
 

Protected Member Functions

virtual vtkObjectBase * NewInstanceInternal () const
 
 vtkArcSource (int res=1)
 
 ~vtkArcSource ()
 
int RequestData (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 
int RequestInformation (vtkInformation *, vtkInformationVector **, vtkInformationVector *)
 

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
 

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

typedef vtkPolyDataAlgorithm vtkArcSource::Superclass

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
static vtkArcSource* vtkArcSource::SafeDownCast ( vtkObjectBase *  o)
static
virtual vtkObjectBase* vtkArcSource::NewInstanceInternal ( ) const
protectedvirtual
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 *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected
int vtkArcSource::RequestInformation ( vtkInformation *  ,
vtkInformationVector **  ,
vtkInformationVector *   
)
protected

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: