vtkAxisFollower.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkAxisFollower_h
#define vtkAxisFollower_h
 
#include "vtkFollower.h"
#include "vtkRenderingAnnotationModule.h" // For export macro
#include "vtkWrappingHints.h"             // For VTK_MARSHALAUTO
 
#include "vtkWeakPointer.h" // For vtkWeakPointer
 
// Forward declarations.
VTK_ABI_NAMESPACE_BEGIN
class vtkAxisActor;
class vtkRenderer;
 
class VTKRENDERINGANNOTATION_EXPORT VTK_MARSHALAUTO vtkAxisFollower : public vtkFollower
{
public:
  vtkTypeMacro(vtkAxisFollower, vtkFollower);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkAxisFollower* New();
 
 
  virtual void SetAxis(vtkAxisActor*);
  virtual vtkAxisActor* GetAxis();
 
 
  vtkSetMacro(AutoCenter, vtkTypeBool);
  vtkGetMacro(AutoCenter, vtkTypeBool);
  vtkBooleanMacro(AutoCenter, vtkTypeBool);
 
 
  vtkSetMacro(EnableDistanceLOD, int);
  vtkGetMacro(EnableDistanceLOD, int);
 
 
  vtkSetClampMacro(DistanceLODThreshold, double, 0.0, 1.0);
  vtkGetMacro(DistanceLODThreshold, double);
 
 
  vtkSetMacro(EnableViewAngleLOD, int);
  vtkGetMacro(EnableViewAngleLOD, int);
 
 
  vtkSetClampMacro(ViewAngleLODThreshold, double, 0.0, 1.0);
  vtkGetMacro(ViewAngleLODThreshold, double);
 
 
  double GetScreenOffset();
  void SetScreenOffset(double offset);
 
 
  vtkSetVector2Macro(ScreenOffsetVector, double);
  vtkGetVector2Macro(ScreenOffsetVector, double);
 
 
  void Render(vtkRenderer* ren) override;
 
  void ComputeMatrix() override {}
 
  virtual void ComputeTransformMatrix(vtkRenderer* ren);
 
  void ShallowCopy(vtkProp* prop) override;
 
  static double AutoScale(
    vtkViewport* viewport, vtkCamera* camera, double screenSize, double position[3]);
 
protected:
  vtkAxisFollower();
  ~vtkAxisFollower() override;
 
  void CalculateOrthogonalVectors(
    double Rx[3], double Ry[3], double Rz[3], vtkAxisActor* axis1, double* dop, vtkRenderer* ren);
 
  void ComputeRotationAndTranlation(vtkRenderer* ren, double translation[3], double Rx[3],
    double Ry[3], double Rz[3], vtkAxisActor* axis);
 
  // \NOTE: Not used as of now.
  VTK_DEPRECATED_IN_9_6_0("Unmaintained method, please do not use.")
  void ComputerAutoCenterTranslation(const double& autoScaleFactor, double translation[3]);
 
  int TestDistanceVisibility();
  void ExecuteViewAngleVisibility(double normal[3]);
 
  bool IsTextUpsideDown(double* a, double* b);
 
  vtkTypeBool AutoCenter;
 
  int EnableDistanceLOD;
  double DistanceLODThreshold;
 
  int EnableViewAngleLOD;
  double ViewAngleLODThreshold;
 
  double ScreenOffsetVector[2];
 
  vtkWeakPointer<vtkAxisActor> Axis;
 
private:
  int TextUpsideDown;
  int VisibleAtCurrentViewAngle;
 
  vtkAxisFollower(const vtkAxisFollower&) = delete;
  void operator=(const vtkAxisFollower&) = delete;
 
  // hide the two parameter Render() method from the user and the compiler.
  void Render(vtkRenderer*, vtkMapper*) override {}
};
 
VTK_ABI_NAMESPACE_END
#endif // vtkAxisFollower_h