VTK  9.1.0
vtkAxisFollower.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkAxisFollower.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
29#ifndef vtkAxisFollower_h
30#define vtkAxisFollower_h
31
32#include "vtkFollower.h"
33#include "vtkRenderingAnnotationModule.h" // For export macro
34
35#include "vtkWeakPointer.h" // For vtkWeakPointer
36
37// Forward declarations.
38class vtkAxisActor;
39class vtkRenderer;
40
41class VTKRENDERINGANNOTATION_EXPORT vtkAxisFollower : public vtkFollower
42{
43public:
45 void PrintSelf(ostream& os, vtkIndent indent) override;
46
51
53
56 virtual void SetAxis(vtkAxisActor*);
59
61
66 vtkSetMacro(AutoCenter, vtkTypeBool);
67 vtkGetMacro(AutoCenter, vtkTypeBool);
68 vtkBooleanMacro(AutoCenter, vtkTypeBool);
70
72
77 vtkSetMacro(EnableDistanceLOD, int);
78 vtkGetMacro(EnableDistanceLOD, int);
80
82
87 vtkSetClampMacro(DistanceLODThreshold, double, 0.0, 1.0);
88 vtkGetMacro(DistanceLODThreshold, double);
90
92
97 vtkSetMacro(EnableViewAngleLOD, int);
98 vtkGetMacro(EnableViewAngleLOD, int);
100
102
107 vtkSetClampMacro(ViewAngleLODThreshold, double, 0.0, 1.0);
108 vtkGetMacro(ViewAngleLODThreshold, double);
110
112
119
121
125 vtkSetVector2Macro(ScreenOffsetVector, double);
126 vtkGetVector2Macro(ScreenOffsetVector, double);
128
130
135 void Render(vtkRenderer* ren) override;
137
142 virtual void ComputeMatrix() override{};
143
149
153 void ShallowCopy(vtkProp* prop) override;
154
159 static double AutoScale(
160 vtkViewport* viewport, vtkCamera* camera, double screenSize, double position[3]);
161
162protected:
165
167 double Rx[3], double Ry[3], double Rz[3], vtkAxisActor* axis1, double* dop, vtkRenderer* ren);
168
169 void ComputeRotationAndTranlation(vtkRenderer* ren, double translation[3], double Rx[3],
170 double Ry[3], double Rz[3], vtkAxisActor* axis);
171
172 // \NOTE: Not used as of now.
173 void ComputerAutoCenterTranslation(const double& autoScaleFactor, double translation[3]);
174
176 void ExecuteViewAngleVisibility(double normal[3]);
177
178 bool IsTextUpsideDown(double* a, double* b);
179
181
184
187
188 double ScreenOffsetVector[2];
189
191
192private:
193 int TextUpsideDown;
194 int VisibleAtCurrentViewAngle;
195
196 vtkAxisFollower(const vtkAxisFollower&) = delete;
197 void operator=(const vtkAxisFollower&) = delete;
198
199 // hide the two parameter Render() method from the user and the compiler.
200 void Render(vtkRenderer*, vtkMapper*) override {}
201};
202
203#endif // vtkAxisFollower_h
Create an axis with tick marks and labels.
Definition: vtkAxisActor.h:91
a subclass of vtkFollower that ensures that data is always parallel to the axis defined by a vtkAxisA...
void SetScreenOffset(double offset)
Set/Get the desired screen offset from the axis.
void ComputeRotationAndTranlation(vtkRenderer *ren, double translation[3], double Rx[3], double Ry[3], double Rz[3], vtkAxisActor *axis)
virtual void ComputeMatrix() override
Overriden to disable this function, and use ComputeTransformMatrix instead, as we need a renderer to ...
static vtkAxisFollower * New()
Creates a follower with no camera set.
static double AutoScale(vtkViewport *viewport, vtkCamera *camera, double screenSize, double position[3])
Calculate scale factor to maintain same size of a object on the screen.
~vtkAxisFollower() override
double GetScreenOffset()
Set/Get the desired screen offset from the axis.
void ExecuteViewAngleVisibility(double normal[3])
vtkTypeBool AutoCenter
bool IsTextUpsideDown(double *a, double *b)
void ComputerAutoCenterTranslation(const double &autoScaleFactor, double translation[3])
virtual void SetAxis(vtkAxisActor *)
Set axis that needs to be followed.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void ShallowCopy(vtkProp *prop) override
Shallow copy of a follower.
virtual vtkAxisActor * GetAxis()
Set axis that needs to be followed.
int TestDistanceVisibility()
double DistanceLODThreshold
vtkWeakPointer< vtkAxisActor > Axis
void CalculateOrthogonalVectors(double Rx[3], double Ry[3], double Rz[3], vtkAxisActor *axis1, double *dop, vtkRenderer *ren)
void Render(vtkRenderer *ren) override
This causes the actor to be rendered.
double ViewAngleLODThreshold
virtual void ComputeTransformMatrix(vtkRenderer *ren)
Generate the matrix based on ivars.
a virtual camera for 3D rendering
Definition: vtkCamera.h:155
a subclass of actor that always faces the camera
Definition: vtkFollower.h:120
virtual void Render(vtkRenderer *ren)
This causes the actor to be rendered.
a simple class to control print indentation
Definition: vtkIndent.h:113
abstract class specifies interface to map data to graphics primitives
Definition: vtkMapper.h:171
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:67
abstract specification for renderers
Definition: vtkRenderer.h:173
abstract specification for Viewports
Definition: vtkViewport.h:47
@ translation
Definition: vtkX3D.h:238
@ position
Definition: vtkX3D.h:267
@ offset
Definition: vtkX3D.h:444
int vtkTypeBool
Definition: vtkABI.h:69