1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
|
// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
/**
* @class vtkRegularPolygonSource
* @brief 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.
*/
#ifndef vtkRegularPolygonSource_h
#define vtkRegularPolygonSource_h
#include "vtkFiltersSourcesModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"
VTK_ABI_NAMESPACE_BEGIN
class VTKFILTERSSOURCES_EXPORT vtkRegularPolygonSource : public vtkPolyDataAlgorithm
{
public:
///@{
/**
* Standard methods for instantiation, obtaining type and printing instance values.
*/
static vtkRegularPolygonSource* New();
vtkTypeMacro(vtkRegularPolygonSource, vtkPolyDataAlgorithm);
void PrintSelf(ostream& os, vtkIndent indent) override;
///@}
///@{
/**
* Set/Get the number of sides of the polygon. By default, the number of sides
* is set to six.
*/
vtkSetClampMacro(NumberOfSides, int, 3, VTK_INT_MAX);
vtkGetMacro(NumberOfSides, int);
///@}
///@{
/**
* Set/Get the center of the polygon. By default, the center is set at the
* origin (0,0,0).
*/
vtkSetVector3Macro(Center, double);
vtkGetVectorMacro(Center, double, 3);
///@}
///@{
/**
* 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).
*/
vtkSetVector3Macro(Normal, double);
vtkGetVectorMacro(Normal, double, 3);
///@}
///@{
/**
* Set/Get the radius of the polygon. By default, the radius is set to 0.5.
*/
vtkSetMacro(Radius, double);
vtkGetMacro(Radius, double);
///@}
///@{
/**
* Control whether a polygon is produced. By default, GeneratePolygon is enabled.
*/
vtkSetMacro(GeneratePolygon, vtkTypeBool);
vtkGetMacro(GeneratePolygon, vtkTypeBool);
vtkBooleanMacro(GeneratePolygon, vtkTypeBool);
///@}
///@{
/**
* Control whether a polyline is produced. By default, GeneratePolyline is enabled.
*/
vtkSetMacro(GeneratePolyline, vtkTypeBool);
vtkGetMacro(GeneratePolyline, vtkTypeBool);
vtkBooleanMacro(GeneratePolyline, vtkTypeBool);
///@}
///@{
/**
* 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.
*/
vtkSetMacro(OutputPointsPrecision, int);
vtkGetMacro(OutputPointsPrecision, int);
///@}
protected:
vtkRegularPolygonSource();
~vtkRegularPolygonSource() override = default;
int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
int NumberOfSides;
double Center[3];
double Normal[3];
double Radius;
vtkTypeBool GeneratePolygon;
vtkTypeBool GeneratePolyline;
int OutputPointsPrecision;
private:
vtkRegularPolygonSource(const vtkRegularPolygonSource&) = delete;
void operator=(const vtkRegularPolygonSource&) = delete;
};
VTK_ABI_NAMESPACE_END
#endif
|