43#ifndef vtkPolarAxesActor_h
44#define vtkPolarAxesActor_h
50#include "vtkRenderingAnnotationModule.h"
56VTK_ABI_NAMESPACE_BEGIN
90 virtual void SetPole(
double,
double,
double);
91 vtkGetVector3Macro(Pole,
double);
99 vtkSetMacro(Log,
bool);
100 vtkGetMacro(Log,
bool);
101 vtkBooleanMacro(Log,
bool);
109 vtkSetClampMacro(RequestedNumberOfRadialAxes,
vtkIdType, 0, VTK_MAXIMUM_NUMBER_OF_RADIAL_AXES);
118 vtkSetClampMacro(RequestedNumberOfPolarAxes,
vtkIdType, 0, VTK_MAXIMUM_NUMBER_OF_POLAR_AXES);
128 vtkSetMacro(AutoSubdividePolarAxis,
bool);
130 vtkGetMacro(AutoSubdividePolarAxis,
bool);
131 void AutoSubdividePolarAxisOn();
132 void AutoSubdividePolarAxisOff();
141 virtual
void SetNumberOfPolarAxisTicks(
int);
142 int GetNumberOfPolarAxisTicks();
150 vtkSetVector2Macro(Range,
double);
151 vtkGetVectorMacro(Range,
double, 2);
159 virtual
void SetMinimumRadius(
double);
160 vtkGetMacro(MinimumRadius,
double);
168 virtual
void SetMaximumRadius(
double);
169 vtkGetMacro(MaximumRadius,
double);
177 virtual
void SetMinimumAngle(
double);
178 vtkGetMacro(MinimumAngle,
double);
186 virtual
void SetMaximumAngle(
double);
187 vtkGetMacro(MaximumAngle,
double);
196 vtkSetClampMacro(SmallestVisiblePolarAngle,
double, 0., 5.);
197 vtkGetMacro(SmallestVisiblePolarAngle,
double);
208 vtkGetMacro(TickLocation,
int);
215 vtkSetMacro(RadialUnits,
bool);
216 vtkGetMacro(RadialUnits,
bool);
226 vtkSetMacro(ScreenSize,
double);
227 vtkGetMacro(ScreenSize,
double);
236 vtkSetVector2Macro(PolarTitleOffset,
double);
237 vtkGetVectorMacro(PolarTitleOffset,
double, 2);
246 vtkSetVector2Macro(RadialTitleOffset,
double);
247 vtkGetVectorMacro(RadialTitleOffset,
double, 2);
255 vtkGetMacro(PolarLabelOffset,
double);
256 vtkSetMacro(PolarLabelOffset,
double);
264 vtkGetMacro(PolarExponentOffset,
double);
265 vtkSetMacro(PolarExponentOffset,
double);
282 vtkSetStringMacro(PolarAxisTitle);
283 vtkGetStringMacro(PolarAxisTitle);
290 vtkSetStringMacro(PolarLabelFormat);
291 vtkGetStringMacro(PolarLabelFormat);
296 VTK_EXPONENT_BOTTOM = 0,
297 VTK_EXPONENT_EXTERN = 1,
298 VTK_EXPONENT_LABELS = 2
315 vtkSetStringMacro(RadialAngleFormat);
316 vtkGetStringMacro(RadialAngleFormat);
331 vtkSetMacro(EnableDistanceLOD,
bool);
332 vtkGetMacro(EnableDistanceLOD,
bool);
340 vtkSetClampMacro(DistanceLODThreshold,
double, 0.0, 1.0);
341 vtkGetMacro(DistanceLODThreshold,
double);
349 vtkSetMacro(EnableViewAngleLOD,
bool);
350 vtkGetMacro(EnableViewAngleLOD,
bool);
358 vtkSetClampMacro(ViewAngleLODThreshold,
double, 0., 1.);
359 vtkGetMacro(ViewAngleLODThreshold,
double);
367 vtkSetMacro(PolarAxisVisibility,
bool);
368 vtkGetMacro(PolarAxisVisibility,
bool);
369 vtkBooleanMacro(PolarAxisVisibility,
bool);
377 vtkSetMacro(DrawRadialGridlines,
bool);
378 vtkGetMacro(DrawRadialGridlines,
bool);
379 vtkBooleanMacro(DrawRadialGridlines,
bool);
387 vtkSetMacro(DrawPolarArcsGridlines,
bool);
388 vtkGetMacro(DrawPolarArcsGridlines,
bool);
389 vtkBooleanMacro(DrawPolarArcsGridlines,
bool);
397 vtkSetMacro(PolarTitleVisibility,
bool);
398 vtkGetMacro(PolarTitleVisibility,
bool);
399 vtkBooleanMacro(PolarTitleVisibility,
bool);
404 VTK_TITLE_BOTTOM = 0,
414 vtkSetClampMacro(RadialAxisTitleLocation,
int, VTK_TITLE_BOTTOM, VTK_TITLE_EXTERN);
415 vtkGetMacro(RadialAxisTitleLocation,
int);
424 vtkSetClampMacro(PolarAxisTitleLocation,
int, VTK_TITLE_BOTTOM, VTK_TITLE_EXTERN);
425 vtkGetMacro(PolarAxisTitleLocation,
int);
433 vtkSetMacro(PolarLabelVisibility,
bool);
434 vtkGetMacro(PolarLabelVisibility,
bool);
435 vtkBooleanMacro(PolarLabelVisibility,
bool);
445 vtkSetMacro(ArcTicksOriginToPolarAxis,
bool);
446 vtkGetMacro(ArcTicksOriginToPolarAxis,
bool);
447 vtkBooleanMacro(ArcTicksOriginToPolarAxis,
bool);
457 vtkSetMacro(RadialAxesOriginToPolarAxis,
bool);
458 vtkGetMacro(RadialAxesOriginToPolarAxis,
bool);
459 vtkBooleanMacro(RadialAxesOriginToPolarAxis,
bool);
467 vtkSetMacro(PolarTickVisibility,
bool);
468 vtkGetMacro(PolarTickVisibility,
bool);
469 vtkBooleanMacro(PolarTickVisibility,
bool);
477 vtkSetMacro(AxisTickVisibility,
bool);
478 vtkGetMacro(AxisTickVisibility,
bool);
479 vtkBooleanMacro(AxisTickVisibility,
bool);
487 vtkSetMacro(AxisMinorTickVisibility,
bool);
488 vtkGetMacro(AxisMinorTickVisibility,
bool);
489 vtkBooleanMacro(AxisMinorTickVisibility,
bool);
497 vtkSetMacro(AxisTickMatchesPolarAxes,
bool);
498 vtkGetMacro(AxisTickMatchesPolarAxes,
bool);
499 vtkBooleanMacro(AxisTickMatchesPolarAxes,
bool);
507 vtkSetMacro(ArcTickVisibility,
bool);
508 vtkGetMacro(ArcTickVisibility,
bool);
509 vtkBooleanMacro(ArcTickVisibility,
bool);
517 vtkSetMacro(ArcMinorTickVisibility,
bool);
518 vtkGetMacro(ArcMinorTickVisibility,
bool);
519 vtkBooleanMacro(ArcMinorTickVisibility,
bool);
527 vtkSetMacro(ArcTickMatchesRadialAxes,
bool);
528 vtkGetMacro(ArcTickMatchesRadialAxes,
bool);
529 vtkBooleanMacro(ArcTickMatchesRadialAxes,
bool);
538 vtkSetMacro(ArcMajorTickSize,
double);
539 vtkGetMacro(ArcMajorTickSize,
double);
548 vtkSetMacro(PolarAxisMajorTickSize,
double);
549 vtkGetMacro(PolarAxisMajorTickSize,
double);
558 vtkSetMacro(LastRadialAxisMajorTickSize,
double);
559 vtkGetMacro(LastRadialAxisMajorTickSize,
double);
567 vtkSetMacro(PolarAxisTickRatioSize,
double);
568 vtkGetMacro(PolarAxisTickRatioSize,
double);
576 vtkSetMacro(LastAxisTickRatioSize,
double);
577 vtkGetMacro(LastAxisTickRatioSize,
double);
585 vtkSetMacro(ArcTickRatioSize,
double);
586 vtkGetMacro(ArcTickRatioSize,
double);
594 vtkSetMacro(TickRatioRadiusSize,
double);
595 vtkGetMacro(TickRatioRadiusSize,
double);
603 vtkSetMacro(PolarAxisMajorTickThickness,
double);
604 vtkGetMacro(PolarAxisMajorTickThickness,
double);
612 vtkSetMacro(LastRadialAxisMajorTickThickness,
double);
613 vtkGetMacro(LastRadialAxisMajorTickThickness,
double);
621 vtkSetMacro(ArcMajorTickThickness,
double);
622 vtkGetMacro(ArcMajorTickThickness,
double);
630 vtkSetMacro(PolarAxisTickRatioThickness,
double);
631 vtkGetMacro(PolarAxisTickRatioThickness,
double);
639 vtkSetMacro(LastAxisTickRatioThickness,
double);
640 vtkGetMacro(LastAxisTickRatioThickness,
double);
648 vtkSetMacro(ArcTickRatioThickness,
double);
649 vtkGetMacro(ArcTickRatioThickness,
double);
657 vtkSetMacro(DeltaRangeMajor,
double);
658 vtkGetMacro(DeltaRangeMajor,
double);
666 vtkSetMacro(DeltaRangeMinor,
double);
667 vtkGetMacro(DeltaRangeMinor,
double);
676 vtkSetMacro(RequestedDeltaRangePolarAxes,
double);
677 vtkGetMacro(RequestedDeltaRangePolarAxes,
double);
685 vtkSetMacro(DeltaAngleMajor,
double);
686 vtkGetMacro(DeltaAngleMajor,
double);
694 vtkSetMacro(DeltaAngleMinor,
double);
695 vtkGetMacro(DeltaAngleMinor,
double);
704 vtkSetMacro(RequestedDeltaAngleRadialAxes,
double);
705 vtkGetMacro(RequestedDeltaAngleRadialAxes,
double);
715 vtkSetMacro(RadialAxesVisibility,
bool);
716 vtkGetMacro(RadialAxesVisibility,
bool);
717 vtkBooleanMacro(RadialAxesVisibility,
bool);
725 vtkSetMacro(RadialTitleVisibility,
bool);
726 vtkGetMacro(RadialTitleVisibility,
bool);
727 vtkBooleanMacro(RadialTitleVisibility,
bool);
735 vtkSetMacro(PolarArcsVisibility,
bool);
736 vtkGetMacro(PolarArcsVisibility,
bool);
737 vtkBooleanMacro(PolarArcsVisibility,
bool);
828 vtkSetVector6Macro(Bounds,
double);
831 double& xmin,
double& xmax,
double& ymin,
double& ymax,
double& zmin,
double& zmax);
840 vtkSetClampMacro(Ratio,
double, 0.001, 100.0);
841 vtkGetMacro(Ratio,
double);
849 vtkSetClampMacro(PolarArcResolutionPerDegree,
double, VTK_MINIMUM_POLAR_ARC_RESOLUTION_PER_DEG,
850 VTK_MAXIMUM_POLAR_ARC_RESOLUTION_PER_DEG);
851 vtkGetMacro(PolarArcResolutionPerDegree,
double);
903 void AutoComputeTicksProperties();
908 double ComputeIdealStep(
int subDivsRequired,
double rangeLength,
int maxSubDivs = 1000);
913 void BuildArcTicks();
919 void StoreTicksPtsFromParamEllipse(
920 double a,
double angleEllipseRad,
double tickSize,
vtkPoints* tickPts);
925 void BuildPolarAxisLabelsArcs();
930 void BuildPolarAxisLabelsArcsLog();
935 void BuildLabelsLog();
937 void BuildPolarArcsLog();
942 std::
string FindExponentAndAdjustValues(
std::list<
double>& valuesList);
954 double FSign(
double,
double);
967 static
double ComputeEllipseAngle(
double angleInDegrees,
double ratio);
981 double Pole[3] = { 0.0, 0.0, 0.0 };
986 int NumberOfRadialAxes = 0;
992 int RequestedNumberOfRadialAxes = 0;
997 int NumberOfPolarAxes = 5;
1003 int RequestedNumberOfPolarAxes = 5;
1013 double PolarArcResolutionPerDegree = 0.2;
1018 double Range[2] = { 0.0, 10.0 };
1023 double DeltaRangeMinor = 0.5;
1028 double DeltaRangeMajor = 1.0;
1033 bool AutoSubdividePolarAxis =
false;
1038 double DeltaRangePolarAxes = 0.0;
1044 double RequestedDeltaRangePolarAxes = 0.0;
1049 double DeltaAngleMinor = 22.5;
1054 double DeltaAngleMajor = 45.0;
1059 double DeltaAngleRadialAxes = 45.0;
1065 double RequestedDeltaAngleRadialAxes = 45.0;
1070 double MinimumRadius = 0.0;
1075 double MaximumRadius = 1.0;
1085 double MinimumAngle = 0.0;
1090 double MaximumAngle = 90.0;
1095 double SmallestVisiblePolarAngle = 0.5;
1131 char* PolarAxisTitle =
nullptr;
1132 char* PolarLabelFormat =
nullptr;
1138 char* RadialAngleFormat =
nullptr;
1143 bool RadialUnits =
true;
1148 bool EnableDistanceLOD =
true;
1153 double DistanceLODThreshold = 0.7;
1158 bool EnableViewAngleLOD =
true;
1164 double ViewAngleLODThreshold = 0.3;
1170 bool PolarAxisVisibility =
true;
1171 bool PolarTitleVisibility =
true;
1172 bool PolarLabelVisibility =
true;
1187 bool PolarTickVisibility =
true;
1195 bool ArcTicksOriginToPolarAxis =
true;
1203 bool RadialAxesOriginToPolarAxis =
true;
1208 bool AxisTickVisibility =
true, AxisMinorTickVisibility =
false;
1213 bool AxisTickMatchesPolarAxes =
true;
1218 bool ArcTickVisibility =
true, ArcMinorTickVisibility =
false;
1223 bool ArcTickMatchesRadialAxes =
true;
1228 double PolarAxisMajorTickSize = 0.0, LastRadialAxisMajorTickSize = 0.0, ArcMajorTickSize = 0.0;
1233 double PolarAxisTickRatioSize = 0.3, LastAxisTickRatioSize = 0.3, ArcTickRatioSize = 0.3;
1238 double TickRatioRadiusSize = 0.02;
1243 double PolarAxisMajorTickThickness = 1.0, LastRadialAxisMajorTickThickness = 1.0,
1244 ArcMajorTickThickness = 1.0;
1249 double PolarAxisTickRatioThickness = 0.5, LastAxisTickRatioThickness = 0.5,
1250 ArcTickRatioThickness = 0.5;
1256 bool RadialAxesVisibility =
true;
1257 bool RadialTitleVisibility =
true;
1263 int RadialAxisTitleLocation = VTK_TITLE_BOTTOM;
1268 int PolarAxisTitleLocation = VTK_TITLE_BOTTOM;
1279 bool PolarArcsVisibility =
true;
1284 bool DrawRadialGridlines =
true;
1289 bool DrawPolarArcsGridlines =
true;
1352 double TitleScale = -1.0;
1357 double LabelScale = -1.0;
1362 double ScreenSize = 10.0;
1368 double PolarTitleOffset[2] = { 20.0, 10.0 }, RadialTitleOffset[2] = { 20.0, 0.0 };
1369 double PolarLabelOffset = 10.0, PolarExponentOffset = 5.0;
1373 static constexpr int VTK_MAXIMUM_NUMBER_OF_POLAR_AXES = 20;
1374 static constexpr int VTK_MAXIMUM_NUMBER_OF_RADIAL_AXES = 50;
1375 static constexpr double VTK_MINIMUM_POLAR_ARC_RESOLUTION_PER_DEG = 0.05;
1376 static constexpr double VTK_MAXIMUM_POLAR_ARC_RESOLUTION_PER_DEG = 100.0;
1382VTK_ABI_NAMESPACE_END
represents an object (geometry & properties) in a rendered scene
Create an axis with tick marks and labels.
a virtual camera for 3D rendering
a simple class to control print indentation
Allocate and hold a VTK object.
represent and manipulate 3D points
create an actor of a polar axes -
vtkSmartPointer< vtkCamera > Camera
Camera attached to the polar axes system.
vtkProperty * GetLastRadialAxisProperty()
Get/Set last radial axis actor properties.
double * GetBounds() override
Explicitly specify the region in space around which to draw the bounds.
vtkTextProperty * GetLastRadialAxisTextProperty()
Set/Get the last radial axis text property.
vtkNew< vtkPoints > ArcMinorTickPts
Keep the arc minor ticks vtkPoints instances.
virtual void SetPolarAxisProperty(vtkProperty *)
Get/Set polar axis actor properties.
void CalculateBounds()
Calculate bounds based on maximum radius and angular sector.
vtkTextProperty * GetSecondaryRadialAxesTextProperty()
Set/Get the secondary radial axes text property.
vtkSmartPointer< vtkTextProperty > PolarAxisTitleTextProperty
Text properties of polar axis title and labels.
void GetBounds(double bounds[6])
Explicitly specify the region in space around which to draw the bounds.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkSmartPointer< vtkProperty > PolarAxisProperty
General properties of polar axis Behavior may be override by polar axis ticks 's actor property.
vtkNew< vtkAxisActor > PolarAxis
Control variables for polar axis.
bool GetUse2DMode()
Enable/Disable labels 2D mode (always facing the camera).
vtkNew< vtkActor > ArcTickActor
vtk object for arc Ticks
virtual void SetLastRadialAxisTextProperty(vtkTextProperty *p)
Set/Get the last radial axis text property.
virtual void SetLastRadialAxisProperty(vtkProperty *p)
Get/Set last radial axis actor properties.
virtual void SetSecondaryPolarArcsProperty(vtkProperty *p)
Get/Set secondary polar arcs actors property.
vtkNew< vtkPolyData > SecondaryPolarArcs
Structures for secondary polar arcs.
virtual void SetSecondaryRadialAxesProperty(vtkProperty *p)
Get/Set secondary radial axes actors properties.
vtkTextProperty * GetPolarAxisTitleTextProperty()
Set/Get the polar axis title text property.
vtkSmartPointer< vtkTextProperty > SecondaryRadialAxesTextProperty
Text properties of secondary radial axes.
static vtkPolarAxesActor * New()
Instantiate object with label format "6.3g" and the number of labels per axis set to 3.
void GetBounds(double &xmin, double &xmax, double &ymin, double &ymax, double &zmin, double &zmax)
Explicitly specify the region in space around which to draw the bounds.
vtkSmartPointer< vtkProperty > LastRadialAxisProperty
General properties of last radial axis.
vtkNew< vtkPolyDataMapper > ArcTickPolyDataMapper
vtk object for arc Ticks
vtkProperty * GetPolarArcsProperty()
Get/Set principal polar arc actor property.
virtual void SetPole(double[3])
Explicitly specify the coordinate of the pole.
vtkNew< vtkActor > PolarArcsActor
vtkNew< vtkPolyData > ArcTickPolyData
vtk object for arc Ticks
void CreateRadialAxes(int axisCount)
Create requested number of type X axes.
vtkSmartPointer< vtkTextProperty > LastRadialAxisTextProperty
Text properties of last radial axis.
vtkNew< vtkPolyData > PolarArcs
void BuildRadialAxes(vtkViewport *viewport=nullptr)
Build requested number of radial axes with respect to specified pole.
virtual void SetPolarAxisTitleTextProperty(vtkTextProperty *p)
Set/Get the polar axis title text property.
vtkNew< vtkPoints > ArcMajorTickPts
Keep the arc major ticks vtkPoints instances.
bool CheckMembersConsistency()
Check consistency of vtkPolarAxesActor members.
vtkProperty * GetSecondaryPolarArcsProperty()
Get/Set secondary polar arcs actors property.
vtkSmartPointer< vtkTextProperty > PolarAxisLabelTextProperty
Text properties of polar axis title and labels.
virtual void SetSecondaryRadialAxesTextProperty(vtkTextProperty *p)
Set/Get the secondary radial axes text property.
int RenderOverlay(vtkViewport *) override
Draw the polar axes.
vtkSmartPointer< vtkProperty > SecondaryRadialAxesProperty
General properties of radial axes.
vtkNew< vtkPolyData > ArcMinorTickPolyData
vtk object for arc Ticks
void SetCommonAxisAttributes(vtkAxisActor *)
Send attributes which are common to all axes, both polar and radial.
vtkProperty * GetSecondaryRadialAxesProperty()
Get/Set secondary radial axes actors properties.
vtkNew< vtkActor > ArcMinorTickActor
vtk object for arc Ticks
virtual void SetPole(double, double, double)
Explicitly specify the coordinate of the pole.
void SetUse2DMode(bool enable)
Enable/Disable labels 2D mode (always facing the camera).
int RenderOpaqueGeometry(vtkViewport *) override
Draw the polar axes.
void SetPolarAxisAttributes(vtkAxisActor *)
Set properties specific to PolarAxis.
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this actor.
vtkNew< vtkPolyDataMapper > PolarArcsMapper
vtkTextProperty * GetPolarAxisLabelTextProperty()
Set/Get the polar axis labels text property.
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
Draw the polar axes.
~vtkPolarAxesActor() override
vtkNew< vtkPolyDataMapper > ArcMinorTickPolyDataMapper
vtk object for arc Ticks
virtual void SetPolarAxisLabelTextProperty(vtkTextProperty *p)
Set/Get the polar axis labels text property.
vtkNew< vtkActor > SecondaryPolarArcsActor
Structures for secondary polar arcs.
vtkNew< vtkPolyDataMapper > SecondaryPolarArcsMapper
Structures for secondary polar arcs.
vtkProperty * GetPolarAxisProperty()
Get/Set polar axis actor properties.
void BuildAxes(vtkViewport *)
Build the axes.
virtual void SetPolarArcsProperty(vtkProperty *p)
Get/Set principal polar arc actor property.
map vtkPolyData to graphics primitives
concrete dataset represents vertices, lines, polygons, and triangle strips
represent surface properties of a geometric object
Hold a reference to a vtkObjectBase instance.
a vtkAbstractArray subclass for strings
represent text properties.
record modification and/or execution time
abstract specification for Viewports
window superclass for vtkRenderWindow
#define VTK_DEPRECATED_IN_9_3_0(reason)