VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
vtkArcSource Class Reference

create an arc between two end points More...

#include <vtkArcSource.h>

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

List of all members.

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 doubleGetPoint1 ()
virtual void GetPoint1 (double data[3])
virtual void SetPoint2 (double, double, double)
virtual void SetPoint2 (double[3])
virtual doubleGetPoint2 ()
virtual void GetPoint2 (double data[3])
virtual void SetCenter (double, double, double)
virtual void SetCenter (double[3])
virtual doubleGetCenter ()
virtual void GetCenter (double data[3])
virtual void SetNormal (double, double, double)
virtual void SetNormal (double[3])
virtual doubleGetNormal ()
virtual void GetNormal (double data[3])
virtual void SetPolarVector (double, double, double)
virtual void SetPolarVector (double[3])
virtual doubleGetPolarVector ()
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 ()
virtual void SetOutputPointsPrecision (int)
virtual int GetOutputPointsPrecision ()

Static Public Member Functions

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

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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
int OutputPointsPrecision

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.

Tests:
vtkArcSource (Tests)

Definition at line 41 of file vtkArcSource.h.


Member Typedef Documentation

Reimplemented from vtkPolyDataAlgorithm.

Definition at line 45 of file vtkArcSource.h.


Constructor & Destructor Documentation

vtkArcSource::vtkArcSource ( int  res = 1) [protected]
vtkArcSource::~vtkArcSource ( ) [inline, protected]

Definition at line 125 of file vtkArcSource.h.


Member Function Documentation

static vtkArcSource* vtkArcSource::New ( ) [static]

Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

Reimplemented from vtkPolyDataAlgorithm.

static int vtkArcSource::IsTypeOf ( const char *  name) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

virtual int vtkArcSource::IsA ( const char *  name) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented from vtkPolyDataAlgorithm.

virtual vtkObjectBase* vtkArcSource::NewInstanceInternal ( ) const [protected, virtual]

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented from vtkPolyDataAlgorithm.

void vtkArcSource::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkPolyDataAlgorithm.

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.

virtual void vtkArcSource::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.

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 vtkArcSource::RequestData ( vtkInformation request,
vtkInformationVector **  inputVector,
vtkInformationVector outputVector 
) [protected, virtual]

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

Reimplemented from vtkPolyDataAlgorithm.

Reimplemented from vtkPolyDataAlgorithm.


Member Data Documentation

double vtkArcSource::Point1[3] [protected]

Definition at line 129 of file vtkArcSource.h.

double vtkArcSource::Point2[3] [protected]

Definition at line 130 of file vtkArcSource.h.

double vtkArcSource::Center[3] [protected]

Definition at line 131 of file vtkArcSource.h.

double vtkArcSource::Normal[3] [protected]

Definition at line 132 of file vtkArcSource.h.

Definition at line 133 of file vtkArcSource.h.

Definition at line 134 of file vtkArcSource.h.

Definition at line 135 of file vtkArcSource.h.

bool vtkArcSource::Negative [protected]

Definition at line 136 of file vtkArcSource.h.

Definition at line 137 of file vtkArcSource.h.

Definition at line 138 of file vtkArcSource.h.


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