VTK  9.5.2
vtkCubeAxesActor.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
47#ifndef vtkCubeAxesActor_h
48#define vtkCubeAxesActor_h
49
50#include "vtkActor.h"
51#include "vtkNew.h" // For vtkNew
52#include "vtkRenderingAnnotationModule.h" // For export macro
53#include "vtkSmartPointer.h" // For vtkSmartPointer
54#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
55
56VTK_ABI_NAMESPACE_BEGIN
57class vtkAxisActor;
58class vtkCamera;
59class vtkTextProperty;
60class vtkStringArray;
61
62class VTKRENDERINGANNOTATION_EXPORT VTK_MARSHALAUTO vtkCubeAxesActor : public vtkActor
63{
64public:
65 vtkTypeMacro(vtkCubeAxesActor, vtkActor);
66 void PrintSelf(ostream& os, vtkIndent indent) override;
67
72 static vtkCubeAxesActor* New();
73
75
78 int RenderOpaqueGeometry(vtkViewport*) override;
79 virtual int RenderTranslucentGeometry(vtkViewport*);
80 int RenderTranslucentPolygonalGeometry(vtkViewport*) override;
81 int RenderOverlay(vtkViewport*) override;
82 vtkTypeBool HasTranslucentPolygonalGeometry() override;
84
86
90 vtkSetMacro(RebuildAxes, bool);
91 vtkGetMacro(RebuildAxes, bool);
93
95
101 vtkSetVector6Macro(Bounds, double);
102 using Superclass::GetBounds;
103 double* GetBounds() VTK_SIZEHINT(6) override { return this->Bounds; }
105
107
111 virtual void GetRenderedBounds(double rBounds[6]);
112 virtual double* GetRenderedBounds();
114
116
124 vtkSetVector2Macro(XAxisRange, double);
125 vtkSetVector2Macro(YAxisRange, double);
126 vtkSetVector2Macro(ZAxisRange, double);
127 vtkGetVector2Macro(XAxisRange, double);
128 vtkGetVector2Macro(YAxisRange, double);
131
135 vtkStringArray* GetAxisLabels(int axis);
136 void SetAxisLabels(int axis, vtkStringArray* value);
138
139 vtkGetVector2Macro(ZAxisRange, double);
140
142
148 void SetScreenSize(double screenSize);
149 vtkGetMacro(ScreenSize, double);
151
153
157 void SetLabelOffset(double offset);
158 vtkGetMacro(LabelOffset, double);
160
162
166 void SetTitleOffset(double titleOffset[2]);
167 vtkGetVector2Macro(TitleOffset, double);
169
171
175 virtual void SetCamera(vtkCamera*);
176 vtkCamera* GetCamera();
178
179 enum FlyMode
180 {
181 VTK_FLY_OUTER_EDGES = 0,
182 VTK_FLY_CLOSEST_TRIAD = 1,
183 VTK_FLY_FURTHEST_TRIAD = 2,
184 VTK_FLY_STATIC_TRIAD = 3,
185 VTK_FLY_STATIC_EDGES = 4
186 };
187
189
195 vtkSetClampMacro(FlyMode, int, VTK_FLY_OUTER_EDGES, VTK_FLY_STATIC_EDGES);
196 vtkGetMacro(FlyMode, int);
197 void SetFlyModeToOuterEdges() { this->SetFlyMode(VTK_FLY_OUTER_EDGES); }
198 void SetFlyModeToClosestTriad() { this->SetFlyMode(VTK_FLY_CLOSEST_TRIAD); }
199 void SetFlyModeToFurthestTriad() { this->SetFlyMode(VTK_FLY_FURTHEST_TRIAD); }
200 void SetFlyModeToStaticTriad() { this->SetFlyMode(VTK_FLY_STATIC_TRIAD); }
201 void SetFlyModeToStaticEdges() { this->SetFlyMode(VTK_FLY_STATIC_EDGES); }
203
205
209 vtkSetStringMacro(XTitle);
210 vtkGetStringMacro(XTitle);
211 vtkSetStringMacro(XUnits);
212 vtkGetStringMacro(XUnits);
213 vtkSetStringMacro(YTitle);
214 vtkGetStringMacro(YTitle);
215 vtkSetStringMacro(YUnits);
216 vtkGetStringMacro(YUnits);
217 vtkSetStringMacro(ZTitle);
218 vtkGetStringMacro(ZTitle);
219 vtkSetStringMacro(ZUnits);
220 vtkGetStringMacro(ZUnits);
222
224
228 vtkSetStringMacro(XLabelFormat);
229 vtkGetStringMacro(XLabelFormat);
230 vtkSetStringMacro(YLabelFormat);
231 vtkGetStringMacro(YLabelFormat);
232 vtkSetStringMacro(ZLabelFormat);
233 vtkGetStringMacro(ZLabelFormat);
235
237
243 vtkSetClampMacro(Inertia, int, 1, VTK_INT_MAX);
244 vtkGetMacro(Inertia, int);
246
248
254 vtkSetMacro(CornerOffset, double);
255 vtkGetMacro(CornerOffset, double);
257
263 void ReleaseGraphicsResources(vtkWindow*) override;
264
266
270 vtkSetMacro(EnableDistanceLOD, bool);
271 vtkGetMacro(EnableDistanceLOD, bool);
273
275
279 vtkSetClampMacro(DistanceLODThreshold, double, 0.0, 1.0);
280 vtkGetMacro(DistanceLODThreshold, double);
282
284
288 vtkSetMacro(EnableViewAngleLOD, bool);
289 vtkGetMacro(EnableViewAngleLOD, bool);
291
293
297 vtkSetClampMacro(ViewAngleLODThreshold, double, 0., 1.);
298 vtkGetMacro(ViewAngleLODThreshold, double);
300
302
306 vtkSetMacro(XAxisVisibility, bool);
307 vtkGetMacro(XAxisVisibility, bool);
308 vtkBooleanMacro(XAxisVisibility, bool);
309
310 vtkSetMacro(YAxisVisibility, bool);
311 vtkGetMacro(YAxisVisibility, bool);
312 vtkBooleanMacro(YAxisVisibility, bool);
313
314 vtkSetMacro(ZAxisVisibility, bool);
315 vtkGetMacro(ZAxisVisibility, bool);
316 vtkBooleanMacro(ZAxisVisibility, bool);
318
320
324 vtkSetMacro(XAxisLabelVisibility, bool);
325 vtkGetMacro(XAxisLabelVisibility, bool);
326 vtkBooleanMacro(XAxisLabelVisibility, bool);
327
328 vtkSetMacro(YAxisLabelVisibility, bool);
329 vtkGetMacro(YAxisLabelVisibility, bool);
330 vtkBooleanMacro(YAxisLabelVisibility, bool);
331
332 vtkSetMacro(ZAxisLabelVisibility, bool);
333 vtkGetMacro(ZAxisLabelVisibility, bool);
334 vtkBooleanMacro(ZAxisLabelVisibility, bool);
336
338
342 vtkSetMacro(XAxisTickVisibility, bool);
343 vtkGetMacro(XAxisTickVisibility, bool);
344 vtkBooleanMacro(XAxisTickVisibility, bool);
345
346 vtkSetMacro(YAxisTickVisibility, bool);
347 vtkGetMacro(YAxisTickVisibility, bool);
348 vtkBooleanMacro(YAxisTickVisibility, bool);
349
350 vtkSetMacro(ZAxisTickVisibility, bool);
351 vtkGetMacro(ZAxisTickVisibility, bool);
352 vtkBooleanMacro(ZAxisTickVisibility, bool);
354
356
360 vtkSetMacro(XAxisMinorTickVisibility, bool);
361 vtkGetMacro(XAxisMinorTickVisibility, bool);
362 vtkBooleanMacro(XAxisMinorTickVisibility, bool);
363
364 vtkSetMacro(YAxisMinorTickVisibility, bool);
365 vtkGetMacro(YAxisMinorTickVisibility, bool);
366 vtkBooleanMacro(YAxisMinorTickVisibility, bool);
367
368 vtkSetMacro(ZAxisMinorTickVisibility, bool);
369 vtkGetMacro(ZAxisMinorTickVisibility, bool);
370 vtkBooleanMacro(ZAxisMinorTickVisibility, bool);
372
374
378 vtkSetMacro(DrawXGridlines, bool);
379 vtkGetMacro(DrawXGridlines, bool);
380 vtkBooleanMacro(DrawXGridlines, bool);
381
382 vtkSetMacro(DrawYGridlines, bool);
383 vtkGetMacro(DrawYGridlines, bool);
384 vtkBooleanMacro(DrawYGridlines, bool);
385
386 vtkSetMacro(DrawZGridlines, bool);
387 vtkGetMacro(DrawZGridlines, bool);
388 vtkBooleanMacro(DrawZGridlines, bool);
390
392
396 vtkSetMacro(DrawXInnerGridlines, bool);
397 vtkGetMacro(DrawXInnerGridlines, bool);
398 vtkBooleanMacro(DrawXInnerGridlines, bool);
399
400 vtkSetMacro(DrawYInnerGridlines, bool);
401 vtkGetMacro(DrawYInnerGridlines, bool);
402 vtkBooleanMacro(DrawYInnerGridlines, bool);
403
404 vtkSetMacro(DrawZInnerGridlines, bool);
405 vtkGetMacro(DrawZInnerGridlines, bool);
406 vtkBooleanMacro(DrawZInnerGridlines, bool);
408
410
414 vtkSetMacro(DrawXGridpolys, bool);
415 vtkGetMacro(DrawXGridpolys, bool);
416 vtkBooleanMacro(DrawXGridpolys, bool);
417
418 vtkSetMacro(DrawYGridpolys, bool);
419 vtkGetMacro(DrawYGridpolys, bool);
420 vtkBooleanMacro(DrawYGridpolys, bool);
421
422 vtkSetMacro(DrawZGridpolys, bool);
423 vtkGetMacro(DrawZGridpolys, bool);
424 vtkBooleanMacro(DrawZGridpolys, bool);
426
428
431 vtkTextProperty* GetTitleTextProperty(int);
432 void SetXAxesTitleProperty(vtkTextProperty*);
433 vtkTextProperty* GetXAxesTitleProperty();
434 void SetYAxesTitleProperty(vtkTextProperty*);
435 vtkTextProperty* GetYAxesTitleProperty();
436 void SetZAxesTitleProperty(vtkTextProperty*);
437 vtkTextProperty* GetZAxesTitleProperty();
439
441
444 vtkTextProperty* GetLabelTextProperty(int);
445 void SetXAxesLabelProperty(vtkTextProperty*);
446 vtkTextProperty* GetXAxesLabelProperty();
447 void SetYAxesLabelProperty(vtkTextProperty*);
448 vtkTextProperty* GetYAxesLabelProperty();
449 void SetZAxesLabelProperty(vtkTextProperty*);
450 vtkTextProperty* GetZAxesLabelProperty();
452
454
457 void SetXAxesLinesProperty(vtkProperty*);
458 vtkProperty* GetXAxesLinesProperty();
459 void SetYAxesLinesProperty(vtkProperty*);
460 vtkProperty* GetYAxesLinesProperty();
461 void SetZAxesLinesProperty(vtkProperty*);
462 vtkProperty* GetZAxesLinesProperty();
464
466
469 void SetXAxesGridlinesProperty(vtkProperty*);
470 vtkProperty* GetXAxesGridlinesProperty();
471 void SetYAxesGridlinesProperty(vtkProperty*);
472 vtkProperty* GetYAxesGridlinesProperty();
473 void SetZAxesGridlinesProperty(vtkProperty*);
474 vtkProperty* GetZAxesGridlinesProperty();
476
478
481 void SetXAxesInnerGridlinesProperty(vtkProperty*);
482 vtkProperty* GetXAxesInnerGridlinesProperty();
483 void SetYAxesInnerGridlinesProperty(vtkProperty*);
484 vtkProperty* GetYAxesInnerGridlinesProperty();
485 void SetZAxesInnerGridlinesProperty(vtkProperty*);
486 vtkProperty* GetZAxesInnerGridlinesProperty();
488
490
493 void SetXAxesGridpolysProperty(vtkProperty*);
494 vtkProperty* GetXAxesGridpolysProperty();
495 void SetYAxesGridpolysProperty(vtkProperty*);
496 vtkProperty* GetYAxesGridpolysProperty();
497 void SetZAxesGridpolysProperty(vtkProperty*);
498 vtkProperty* GetZAxesGridpolysProperty();
500
501 enum TickLocation
502 {
503 VTK_TICKS_INSIDE = 0,
504 VTK_TICKS_OUTSIDE = 1,
505 VTK_TICKS_BOTH = 2
506 };
507
509
513 vtkSetClampMacro(TickLocation, int, VTK_TICKS_INSIDE, VTK_TICKS_BOTH);
514 vtkGetMacro(TickLocation, int);
516
517 void SetTickLocationToInside() { this->SetTickLocation(VTK_TICKS_INSIDE); }
518 void SetTickLocationToOutside() { this->SetTickLocation(VTK_TICKS_OUTSIDE); }
519 void SetTickLocationToBoth() { this->SetTickLocation(VTK_TICKS_BOTH); }
520
521 void SetLabelScaling(bool, int, int, int);
522
524
529 void SetUseTextActor3D(bool enable);
530 bool GetUseTextActor3D();
532
534
538 void SetUse2DMode(bool enable);
539 bool GetUse2DMode();
541
545 void SetSaveTitlePosition(int val);
546
548
552 vtkSetVector6Macro(OrientedBounds, double);
553 vtkGetVector6Macro(OrientedBounds, double);
555
557
561 vtkSetMacro(UseOrientedBounds, bool);
562 vtkGetMacro(UseOrientedBounds, bool);
564
566
570 vtkSetVector3Macro(AxisBaseForX, double);
571 vtkGetVector3Macro(AxisBaseForX, double);
573
575
579 vtkSetVector3Macro(AxisBaseForY, double);
580 vtkGetVector3Macro(AxisBaseForY, double);
582
584
588 vtkSetVector3Macro(AxisBaseForZ, double);
589 vtkGetVector3Macro(AxisBaseForZ, double);
591
593
598 vtkSetVector3Macro(AxisOrigin, double);
599 vtkGetVector3Macro(AxisOrigin, double);
601
603
607 vtkSetMacro(UseAxisOrigin, bool);
608 vtkGetMacro(UseAxisOrigin, bool);
610
612
616 vtkSetMacro(GridLineLocation, int);
617 vtkGetMacro(GridLineLocation, int);
619
621
627 vtkSetMacro(StickyAxes, bool);
628 vtkGetMacro(StickyAxes, bool);
629 vtkBooleanMacro(StickyAxes, bool);
631
633
641 vtkSetMacro(CenterStickyAxes, bool);
642 vtkGetMacro(CenterStickyAxes, bool);
643 vtkBooleanMacro(CenterStickyAxes, bool);
645
646 enum GridVisibility
647 {
648 VTK_GRID_LINES_ALL = 0,
649 VTK_GRID_LINES_CLOSEST = 1,
650 VTK_GRID_LINES_FURTHEST = 2
651 };
652
653protected:
654 vtkCubeAxesActor();
655 ~vtkCubeAxesActor() override;
656
662 void ComputeStickyAxesBoundingSphere(
663 vtkViewport* viewport, const double bounds[6], double sphereCenter[3], double& sphereRadius);
664
668 void GetViewportLimitedBounds(vtkViewport* viewport, double bounds[6]);
669
674 static void GetBoundsPointBits(
675 unsigned int pointIndex, unsigned int& xBit, unsigned int& yBit, unsigned int& zBit);
676
680 static void GetBoundsPoint(unsigned int pointIndex, const double bounds[6], double point[3]);
681
682 int LabelExponent(double min, double max);
683
684 int Digits(double min, double max);
685
686 double MaxOf(double, double);
687 double MaxOf(double, double, double, double);
688
689 double FFix(double);
690 double FSign(double, double);
691 int FRound(double fnt);
692 int GetNumTicks(double range, double fxt);
693
694 void UpdateLabels(vtkAxisActor** axis, int index);
695
696 vtkSmartPointer<vtkCamera> Camera;
697
698 int FlyMode = VTK_FLY_CLOSEST_TRIAD;
699
700 // Expose internally closest axis index computation
701 int FindClosestAxisIndex(double pts[8][3]);
702
703 // Expose internally furthest axis index computation
704 int FindFurtherstAxisIndex(double pts[8][3]);
705
706 // Expose internally the boundary edge fly mode axis index computation
707 void FindBoundaryEdge(int& indexOfAxisX, int& indexOfAxisY, int& indexOfAxisZ, double pts[8][3]);
708
714 void UpdateGridLineVisibility(int axisIndex);
715
716 // VTK_ALL_GRID_LINES 0
717 // VTK_CLOSEST_GRID_LINES 1
718 // VTK_FURTHEST_GRID_LINES 2
719 int GridLineLocation = VTK_GRID_LINES_ALL;
720
724 bool StickyAxes = false;
725
729 bool CenterStickyAxes = true;
730
735 bool EnableDistanceLOD = true;
736
741 double DistanceLODThreshold = 0.8;
742
747 bool EnableViewAngleLOD = true;
748
753 double ViewAngleLODThreshold = 0.2;
754
755 enum NumberOfAlignedAxis
756 {
757 NUMBER_OF_ALIGNED_AXIS = 4
758 };
759
761
765 vtkAxisActor* XAxes[NUMBER_OF_ALIGNED_AXIS];
766 vtkAxisActor* YAxes[NUMBER_OF_ALIGNED_AXIS];
767 vtkAxisActor* ZAxes[NUMBER_OF_ALIGNED_AXIS];
769
770 bool RebuildAxes = true;
771
772 char* XTitle = nullptr;
773 char* XUnits = nullptr;
774 char* YTitle = nullptr;
775 char* YUnits = nullptr;
776 char* ZTitle = nullptr;
777 char* ZUnits = nullptr;
778
779 char* ActualXLabel = nullptr;
780 char* ActualYLabel = nullptr;
781 char* ActualZLabel = nullptr;
782
783 int TickLocation = VTK_TICKS_INSIDE;
784
785 bool XAxisVisibility = true;
786 bool YAxisVisibility = true;
787 bool ZAxisVisibility = true;
788
789 bool XAxisTickVisibility = true;
790 bool YAxisTickVisibility = true;
791 bool ZAxisTickVisibility = true;
792
793 bool XAxisMinorTickVisibility = true;
794 bool YAxisMinorTickVisibility = true;
795 bool ZAxisMinorTickVisibility = true;
796
797 bool XAxisLabelVisibility = true;
798 bool YAxisLabelVisibility = true;
799 bool ZAxisLabelVisibility = true;
800
801 bool DrawXGridlines = false;
802 bool DrawYGridlines = false;
803 bool DrawZGridlines = false;
804
805 bool DrawXInnerGridlines = false;
806 bool DrawYInnerGridlines = false;
807 bool DrawZInnerGridlines = false;
808
809 bool DrawXGridpolys = false;
810 bool DrawYGridpolys = false;
811 bool DrawZGridpolys = false;
812
813 char* XLabelFormat = nullptr;
814 char* YLabelFormat = nullptr;
815 char* ZLabelFormat = nullptr;
816
817 double CornerOffset = 0.0;
818
819 int Inertia = 1;
820
821 int RenderCount = 0;
822
823 int InertiaLocs[3] = { -1, -1, -1 };
824
825 bool RenderSomething = false;
826
827 vtkNew<vtkTextProperty> TitleTextProperty[3];
828 vtkSmartPointer<vtkStringArray> AxisLabels[3];
829 vtkNew<vtkTextProperty> LabelTextProperty[3];
830
831 vtkNew<vtkProperty> XAxesLinesProperty;
832 vtkNew<vtkProperty> YAxesLinesProperty;
833 vtkNew<vtkProperty> ZAxesLinesProperty;
834 vtkNew<vtkProperty> XAxesGridlinesProperty;
835 vtkNew<vtkProperty> YAxesGridlinesProperty;
836 vtkNew<vtkProperty> ZAxesGridlinesProperty;
837 vtkNew<vtkProperty> XAxesInnerGridlinesProperty;
838 vtkNew<vtkProperty> YAxesInnerGridlinesProperty;
839 vtkNew<vtkProperty> ZAxesInnerGridlinesProperty;
840 vtkNew<vtkProperty> XAxesGridpolysProperty;
841 vtkNew<vtkProperty> YAxesGridpolysProperty;
842 vtkNew<vtkProperty> ZAxesGridpolysProperty;
843
844 double RenderedBounds[6] = { -1.0, 1.0, -1.0, 1.0, -1.0, 1.0 };
845 double OrientedBounds[6] = { -1.0, 1.0, -1.0, 1.0, -1.0, 1.0 };
846 bool UseOrientedBounds = false;
847
848 double AxisOrigin[3] = { 0.0, 0.0, 0.0 };
849 bool UseAxisOrigin = false;
850
851 double AxisBaseForX[3] = { 1.0, 0.0, 0.0 };
852 double AxisBaseForY[3] = { 0.0, 1.0, 0.0 };
853 double AxisBaseForZ[3] = { 0.0, 0.0, 1.0 };
854
855private:
856 vtkCubeAxesActor(const vtkCubeAxesActor&) = delete;
857 void operator=(const vtkCubeAxesActor&) = delete;
858
859 vtkSetStringMacro(ActualXLabel);
860 vtkSetStringMacro(ActualYLabel);
861 vtkSetStringMacro(ActualZLabel);
862
863 vtkTimeStamp BuildTime;
864 bool LastUseOrientedBounds = false;
865 int LastXPow = 0;
866 int LastYPow = 0;
867 int LastZPow = 0;
868
869 int UserXPow = 0;
870 int UserYPow = 0;
871 int UserZPow = 0;
872
873 bool AutoLabelScaling = true;
874
875 int LastXAxisDigits = 3;
876 int LastYAxisDigits = 3;
877 int LastZAxisDigits = 3;
878
879 double LastXRange[2] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
880 double LastYRange[2] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
881 double LastZRange[2] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
882 double LastBounds[6] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX, VTK_DOUBLE_MAX, VTK_DOUBLE_MAX,
883 VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
884
885 int LastFlyMode = -1;
886
887 int RenderAxesX[NUMBER_OF_ALIGNED_AXIS] = { 0, 1, 2, 3 };
888 int RenderAxesY[NUMBER_OF_ALIGNED_AXIS] = { 0, 1, 2, 3 };
889 int RenderAxesZ[NUMBER_OF_ALIGNED_AXIS] = { 0, 1, 2, 3 };
890
891 int NumberOfAxesX = 1;
892 int NumberOfAxesY = 1;
893 int NumberOfAxesZ = 1;
894
895 bool MustAdjustXValue = false;
896 bool MustAdjustYValue = false;
897 bool MustAdjustZValue = false;
898
899 bool ForceXLabelReset = false;
900 bool ForceYLabelReset = false;
901 bool ForceZLabelReset = false;
902
903 double XAxisRange[2] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
904 double YAxisRange[2] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
905 double ZAxisRange[2] = { VTK_DOUBLE_MAX, VTK_DOUBLE_MAX };
906
907 double LabelScale = -1.0;
908 double TitleScale = -1.0;
909
910 double ScreenSize = 10.0;
911 double LabelOffset = 20.0;
912 double TitleOffset[2] = { 20.0, 20.0 };
913
915
919 double MajorStart[3] = { 0.0, 0.0, 0.0 };
920 double DeltaMajor[3] = { 0.0, 0.0, 0.0 };
922
923 int RenderGeometry(bool& initialRender, vtkViewport* viewport, bool checkAxisVisibility,
924 int (vtkAxisActor::*renderMethod)(vtkViewport*));
925
926 void TransformBounds(vtkViewport* viewport, const double bounds[6], double pts[8][3]);
927 void AdjustAxes(double bounds[6], double xCoords[NUMBER_OF_ALIGNED_AXIS][6],
928 double yCoords[NUMBER_OF_ALIGNED_AXIS][6], double zCoords[NUMBER_OF_ALIGNED_AXIS][6],
929 double xRange[2], double yRange[2], double zRange[2]);
930
931 bool ComputeTickSize(double bounds[6]);
932 void AdjustValues(const double xRange[2], const double yRange[2], const double zRange[2]);
933 void AdjustRange(const double bounds[6]);
934 void BuildAxes(vtkViewport*);
935 void DetermineRenderAxes(vtkViewport*);
936 void SetNonDependentAttributes();
937 void BuildLabels(vtkAxisActor* axes[NUMBER_OF_ALIGNED_AXIS]);
938 void AdjustTicksComputeRange(
939 vtkAxisActor* axes[NUMBER_OF_ALIGNED_AXIS], double rangeMin, double rangeMax);
940
941 void AutoScale(vtkViewport* viewport);
942 void AutoScale(vtkViewport* viewport, vtkAxisActor* axes[NUMBER_OF_ALIGNED_AXIS]);
943 double AutoScale(vtkViewport* viewport, double screenSize, double position[3]);
944};
945
946VTK_ABI_NAMESPACE_END
947#endif
vtkActor
represents an object (geometry & properties) in a rendered scene
Definition vtkActor.h:42
vtkAxisActor
Create an axis with tick marks and labels.
Definition vtkAxisActor.h:73
vtkCamera
a virtual camera for 3D rendering
Definition vtkCamera.h:42
vtkCubeAxesActor
create a plot of a bounding box edges - used for navigation
Definition vtkCubeAxesActor.h:63
vtkCubeAxesActor::FindBoundaryEdge
void FindBoundaryEdge(int &indexOfAxisX, int &indexOfAxisY, int &indexOfAxisZ, double pts[8][3])
vtkCubeAxesActor::GetZAxesGridpolysProperty
vtkProperty * GetZAxesGridpolysProperty()
Get/Set axes gridPolys actors properties.
vtkCubeAxesActor::SetYAxesTitleProperty
void SetYAxesTitleProperty(vtkTextProperty *)
Returns the text property for the title on an axis.
vtkCubeAxesActor::GetUseTextActor3D
bool GetUseTextActor3D()
Use or not vtkTextActor3D for titles and labels.
vtkCubeAxesActor::SetXAxesGridlinesProperty
void SetXAxesGridlinesProperty(vtkProperty *)
Get/Set axes (outer) gridlines actors properties.
vtkCubeAxesActor::GetViewportLimitedBounds
void GetViewportLimitedBounds(vtkViewport *viewport, double bounds[6])
Get bounds such that the axes are entirely within a viewport.
vtkCubeAxesActor::GetCamera
vtkCamera * GetCamera()
Set/Get the camera to perform scaling and translation of the vtkCubeAxesActor.
vtkCubeAxesActor::UpdateGridLineVisibility
void UpdateGridLineVisibility(int axisIndex)
This will Update AxisActors with GridVisibility when those should be dynamaic regarding the viewport.
vtkCubeAxesActor::SetScreenSize
void SetScreenSize(double screenSize)
Explicitly specify the screen size of title and label text.
vtkCubeAxesActor::RenderOverlay
int RenderOverlay(vtkViewport *) override
Draw the axes as per the vtkProp superclass' API.
vtkCubeAxesActor::ZAxesGridlinesProperty
vtkNew< vtkProperty > ZAxesGridlinesProperty
Definition vtkCubeAxesActor.h:836
vtkCubeAxesActor::RenderTranslucentGeometry
virtual int RenderTranslucentGeometry(vtkViewport *)
Draw the axes as per the vtkProp superclass' API.
vtkCubeAxesActor::FSign
double FSign(double, double)
vtkCubeAxesActor::GetXAxesLabelProperty
vtkTextProperty * GetXAxesLabelProperty()
Returns the text property for the labels on an axis.
vtkCubeAxesActor::SetYAxesInnerGridlinesProperty
void SetYAxesInnerGridlinesProperty(vtkProperty *)
Get/Set axes inner gridlines actors properties.
vtkCubeAxesActor::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this actor.
vtkCubeAxesActor::Camera
vtkSmartPointer< vtkCamera > Camera
Definition vtkCubeAxesActor.h:696
vtkCubeAxesActor::SetZAxesLabelProperty
void SetZAxesLabelProperty(vtkTextProperty *)
Returns the text property for the labels on an axis.
vtkCubeAxesActor::GetZAxesGridlinesProperty
vtkProperty * GetZAxesGridlinesProperty()
Get/Set axes (outer) gridlines actors properties.
vtkCubeAxesActor::SetTitleOffset
void SetTitleOffset(double titleOffset[2])
Explicitly specify the offset between title and labels.
vtkCubeAxesActor::SetFlyModeToOuterEdges
void SetFlyModeToOuterEdges()
Specify a mode to control how the axes are drawn: either static, closest triad, furthest triad or out...
Definition vtkCubeAxesActor.h:197
vtkCubeAxesActor::HasTranslucentPolygonalGeometry
vtkTypeBool HasTranslucentPolygonalGeometry() override
Draw the axes as per the vtkProp superclass' API.
vtkCubeAxesActor::GetXAxesLinesProperty
vtkProperty * GetXAxesLinesProperty()
Get/Set axes actors properties.
vtkCubeAxesActor::GetYAxesLabelProperty
vtkTextProperty * GetYAxesLabelProperty()
Returns the text property for the labels on an axis.
vtkCubeAxesActor::GetXAxesInnerGridlinesProperty
vtkProperty * GetXAxesInnerGridlinesProperty()
Get/Set axes inner gridlines actors properties.
vtkCubeAxesActor::SetXAxesGridpolysProperty
void SetXAxesGridpolysProperty(vtkProperty *)
Get/Set axes gridPolys actors properties.
vtkCubeAxesActor::ZAxesInnerGridlinesProperty
vtkNew< vtkProperty > ZAxesInnerGridlinesProperty
Definition vtkCubeAxesActor.h:839
vtkCubeAxesActor::SetZAxesGridpolysProperty
void SetZAxesGridpolysProperty(vtkProperty *)
Get/Set axes gridPolys actors properties.
vtkCubeAxesActor::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkCubeAxesActor::SetYAxesLabelProperty
void SetYAxesLabelProperty(vtkTextProperty *)
Returns the text property for the labels on an axis.
vtkCubeAxesActor::SetUse2DMode
void SetUse2DMode(bool enable)
Get/Set 2D mode NB: Use vtkTextActor for titles in 2D instead of vtkAxisFollower.
vtkCubeAxesActor::YAxesGridpolysProperty
vtkNew< vtkProperty > YAxesGridpolysProperty
Definition vtkCubeAxesActor.h:841
vtkCubeAxesActor::GetZAxesLabelProperty
vtkTextProperty * GetZAxesLabelProperty()
Returns the text property for the labels on an axis.
vtkCubeAxesActor::GetBounds
double * GetBounds() override
Explicitly specify the region in space around which to draw the bounds.
Definition vtkCubeAxesActor.h:103
vtkCubeAxesActor::SetFlyModeToClosestTriad
void SetFlyModeToClosestTriad()
Specify a mode to control how the axes are drawn: either static, closest triad, furthest triad or out...
Definition vtkCubeAxesActor.h:198
vtkCubeAxesActor::SetYAxesGridpolysProperty
void SetYAxesGridpolysProperty(vtkProperty *)
Get/Set axes gridPolys actors properties.
vtkCubeAxesActor::XAxesGridlinesProperty
vtkNew< vtkProperty > XAxesGridlinesProperty
Definition vtkCubeAxesActor.h:834
vtkCubeAxesActor::SetZAxesInnerGridlinesProperty
void SetZAxesInnerGridlinesProperty(vtkProperty *)
Get/Set axes inner gridlines actors properties.
vtkCubeAxesActor::SetZAxesGridlinesProperty
void SetZAxesGridlinesProperty(vtkProperty *)
Get/Set axes (outer) gridlines actors properties.
vtkCubeAxesActor::~vtkCubeAxesActor
~vtkCubeAxesActor() override
vtkCubeAxesActor::SetAxisLabels
void SetAxisLabels(int axis, vtkStringArray *value)
Explicitly specify the axis labels along an axis as an array of strings instead of using the values.
vtkCubeAxesActor::YAxesGridlinesProperty
vtkNew< vtkProperty > YAxesGridlinesProperty
Definition vtkCubeAxesActor.h:835
vtkCubeAxesActor::New
static vtkCubeAxesActor * New()
Instantiate object with label format "6.3g" and the number of labels per axis set to 3.
vtkCubeAxesActor::FRound
int FRound(double fnt)
vtkCubeAxesActor::FindClosestAxisIndex
int FindClosestAxisIndex(double pts[8][3])
vtkCubeAxesActor::RenderOpaqueGeometry
int RenderOpaqueGeometry(vtkViewport *) override
Draw the axes as per the vtkProp superclass' API.
vtkCubeAxesActor::ComputeStickyAxesBoundingSphere
void ComputeStickyAxesBoundingSphere(vtkViewport *viewport, const double bounds[6], double sphereCenter[3], double &sphereRadius)
Computes a bounding sphere used to determine the sticky bounding box.
vtkCubeAxesActor::GetZAxesTitleProperty
vtkTextProperty * GetZAxesTitleProperty()
Returns the text property for the title on an axis.
vtkCubeAxesActor::GetBoundsPoint
static void GetBoundsPoint(unsigned int pointIndex, const double bounds[6], double point[3])
Get a point on the bounding box by point index.
vtkCubeAxesActor::GetYAxesTitleProperty
vtkTextProperty * GetYAxesTitleProperty()
Returns the text property for the title on an axis.
vtkCubeAxesActor::SetLabelOffset
void SetLabelOffset(double offset)
Explicitly specify the offset between labels and the axis.
vtkCubeAxesActor::GetUse2DMode
bool GetUse2DMode()
Get/Set 2D mode NB: Use vtkTextActor for titles in 2D instead of vtkAxisFollower.
vtkCubeAxesActor::SetUseTextActor3D
void SetUseTextActor3D(bool enable)
Use or not vtkTextActor3D for titles and labels.
vtkCubeAxesActor::GetXAxesGridlinesProperty
vtkProperty * GetXAxesGridlinesProperty()
Get/Set axes (outer) gridlines actors properties.
vtkCubeAxesActor::GetLabelTextProperty
vtkTextProperty * GetLabelTextProperty(int)
Returns the text property for the labels on an axis.
vtkCubeAxesActor::SetZAxesLinesProperty
void SetZAxesLinesProperty(vtkProperty *)
Get/Set axes actors properties.
vtkCubeAxesActor::SetFlyModeToStaticEdges
void SetFlyModeToStaticEdges()
Specify a mode to control how the axes are drawn: either static, closest triad, furthest triad or out...
Definition vtkCubeAxesActor.h:201
vtkCubeAxesActor::SetFlyModeToStaticTriad
void SetFlyModeToStaticTriad()
Specify a mode to control how the axes are drawn: either static, closest triad, furthest triad or out...
Definition vtkCubeAxesActor.h:200
vtkCubeAxesActor::SetYAxesLinesProperty
void SetYAxesLinesProperty(vtkProperty *)
Get/Set axes actors properties.
vtkCubeAxesActor::GetAxisLabels
vtkStringArray * GetAxisLabels(int axis)
Explicitly specify the axis labels along an axis as an array of strings instead of using the values.
vtkCubeAxesActor::XAxesGridpolysProperty
vtkNew< vtkProperty > XAxesGridpolysProperty
Definition vtkCubeAxesActor.h:840
vtkCubeAxesActor::GetRenderedBounds
virtual double * GetRenderedBounds()
Method used to properly return the bounds of the cube axis itself with all its labels.
vtkCubeAxesActor::GetYAxesGridlinesProperty
vtkProperty * GetYAxesGridlinesProperty()
Get/Set axes (outer) gridlines actors properties.
vtkCubeAxesActor::GetZAxesLinesProperty
vtkProperty * GetZAxesLinesProperty()
Get/Set axes actors properties.
vtkCubeAxesActor::YAxesInnerGridlinesProperty
vtkNew< vtkProperty > YAxesInnerGridlinesProperty
Definition vtkCubeAxesActor.h:838
vtkCubeAxesActor::SetSaveTitlePosition
void SetSaveTitlePosition(int val)
For 2D mode only: save axis title positions for later use.
vtkCubeAxesActor::ZAxesLinesProperty
vtkNew< vtkProperty > ZAxesLinesProperty
Definition vtkCubeAxesActor.h:833
vtkCubeAxesActor::GetTitleTextProperty
vtkTextProperty * GetTitleTextProperty(int)
Returns the text property for the title on an axis.
vtkCubeAxesActor::GetBoundsPointBits
static void GetBoundsPointBits(unsigned int pointIndex, unsigned int &xBit, unsigned int &yBit, unsigned int &zBit)
Get the bits for a bounds point.
vtkCubeAxesActor::SetXAxesInnerGridlinesProperty
void SetXAxesInnerGridlinesProperty(vtkProperty *)
Get/Set axes inner gridlines actors properties.
vtkCubeAxesActor::SetLabelScaling
void SetLabelScaling(bool, int, int, int)
vtkCubeAxesActor::YAxesLinesProperty
vtkNew< vtkProperty > YAxesLinesProperty
Definition vtkCubeAxesActor.h:832
vtkCubeAxesActor::GetXAxesTitleProperty
vtkTextProperty * GetXAxesTitleProperty()
Returns the text property for the title on an axis.
vtkCubeAxesActor::XAxesLinesProperty
vtkNew< vtkProperty > XAxesLinesProperty
Definition vtkCubeAxesActor.h:831
vtkCubeAxesActor::FFix
double FFix(double)
vtkCubeAxesActor::FindFurtherstAxisIndex
int FindFurtherstAxisIndex(double pts[8][3])
vtkCubeAxesActor::XAxesInnerGridlinesProperty
vtkNew< vtkProperty > XAxesInnerGridlinesProperty
Definition vtkCubeAxesActor.h:837
vtkCubeAxesActor::GetXAxesGridpolysProperty
vtkProperty * GetXAxesGridpolysProperty()
Get/Set axes gridPolys actors properties.
vtkCubeAxesActor::SetXAxesTitleProperty
void SetXAxesTitleProperty(vtkTextProperty *)
Returns the text property for the title on an axis.
vtkCubeAxesActor::ZAxesGridpolysProperty
vtkNew< vtkProperty > ZAxesGridpolysProperty
Definition vtkCubeAxesActor.h:842
vtkCubeAxesActor::MaxOf
double MaxOf(double, double, double, double)
vtkCubeAxesActor::GetNumTicks
int GetNumTicks(double range, double fxt)
vtkCubeAxesActor::SetXAxesLabelProperty
void SetXAxesLabelProperty(vtkTextProperty *)
Returns the text property for the labels on an axis.
vtkCubeAxesActor::UpdateLabels
void UpdateLabels(vtkAxisActor **axis, int index)
vtkCubeAxesActor::GetYAxesInnerGridlinesProperty
vtkProperty * GetYAxesInnerGridlinesProperty()
Get/Set axes inner gridlines actors properties.
vtkCubeAxesActor::Digits
int Digits(double min, double max)
vtkCubeAxesActor::RenderTranslucentPolygonalGeometry
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
Draw the axes as per the vtkProp superclass' API.
vtkCubeAxesActor::GetZAxesInnerGridlinesProperty
vtkProperty * GetZAxesInnerGridlinesProperty()
Get/Set axes inner gridlines actors properties.
vtkCubeAxesActor::SetCamera
virtual void SetCamera(vtkCamera *)
Set/Get the camera to perform scaling and translation of the vtkCubeAxesActor.
vtkCubeAxesActor::GetRenderedBounds
virtual void GetRenderedBounds(double rBounds[6])
Method used to properly return the bounds of the cube axis itself with all its labels.
vtkCubeAxesActor::MaxOf
double MaxOf(double, double)
vtkCubeAxesActor::GetYAxesLinesProperty
vtkProperty * GetYAxesLinesProperty()
Get/Set axes actors properties.
vtkCubeAxesActor::LabelExponent
int LabelExponent(double min, double max)
vtkCubeAxesActor::SetXAxesLinesProperty
void SetXAxesLinesProperty(vtkProperty *)
Get/Set axes actors properties.
vtkCubeAxesActor::SetYAxesGridlinesProperty
void SetYAxesGridlinesProperty(vtkProperty *)
Get/Set axes (outer) gridlines actors properties.
vtkCubeAxesActor::GetYAxesGridpolysProperty
vtkProperty * GetYAxesGridpolysProperty()
Get/Set axes gridPolys actors properties.
vtkCubeAxesActor::SetZAxesTitleProperty
void SetZAxesTitleProperty(vtkTextProperty *)
Returns the text property for the title on an axis.
vtkCubeAxesActor::SetFlyModeToFurthestTriad
void SetFlyModeToFurthestTriad()
Specify a mode to control how the axes are drawn: either static, closest triad, furthest triad or out...
Definition vtkCubeAxesActor.h:199
vtkIndent
a simple class to control print indentation
Definition vtkIndent.h:29
vtkNew
Allocate and hold a VTK object.
Definition vtkNew.h:58
vtkProp3D::Bounds
double Bounds[6]
Definition vtkProp3D.h:400
vtkProperty
represent surface properties of a geometric object
Definition vtkProperty.h:61
vtkSmartPointer
Hold a reference to a vtkObjectBase instance.
Definition vtkSmartPointer.h:32
vtkStringArray
a vtkAbstractArray subclass for strings
Definition vtkStringArray.h:33
vtkTextProperty
represent text properties.
Definition vtkTextProperty.h:27
vtkTimeStamp
record modification and/or execution time
Definition vtkTimeStamp.h:25
vtkViewport
abstract specification for Viewports
Definition vtkViewport.h:47
vtkWindow
window superclass for vtkRenderWindow
Definition vtkWindow.h:26
vtkTypeBool
int vtkTypeBool
Definition vtkABI.h:64
VTK_DOUBLE_MAX
#define VTK_DOUBLE_MAX
Definition vtkType.h:171
VTK_INT_MAX
#define VTK_INT_MAX
Definition vtkType.h:161
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition vtkWrappingHints.h:52
VTK_MARSHALAUTO
#define VTK_MARSHALAUTO
Definition vtkWrappingHints.h:53
max
#define max(a, b)
Definition vtkX3DExporterFIWriterHelper.h:19
Generated on Mon Oct 13 2025 16:11:48 for VTK by doxygen 1.9.8