vtkBoundedWidgetRepresentation.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 vtkBoundedWidgetRepresentation_h
#define vtkBoundedWidgetRepresentation_h
 
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkNew.h"
#include "vtkWidgetRepresentation.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
 
class vtkActor;
class vtkImageData;
class vtkOutlineFilter;
class vtkPolyDataMapper;
class vtkProperty;
 
class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkBoundedWidgetRepresentation
  : public vtkWidgetRepresentation
{
public:
 
  vtkTypeMacro(vtkBoundedWidgetRepresentation, vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  vtkSetMacro(OutlineTranslation, bool);
  vtkGetMacro(OutlineTranslation, bool);
  vtkBooleanMacro(OutlineTranslation, bool);
 
  vtkSetMacro(OutsideBounds, bool);
  vtkGetMacro(OutsideBounds, bool);
  vtkBooleanMacro(OutsideBounds, bool);
 
  vtkSetMacro(ConstrainToWidgetBounds, bool);
  vtkGetMacro(ConstrainToWidgetBounds, bool);
  vtkBooleanMacro(ConstrainToWidgetBounds, bool);
 
  vtkGetObjectMacro(OutlineProperty, vtkProperty);
  vtkGetObjectMacro(SelectedOutlineProperty, vtkProperty);
 
 
  vtkSetVector6Macro(WidgetBounds, double);
  vtkGetVector6Macro(WidgetBounds, double);
 
 
  vtkGetMacro(TranslationAxis, int);
  vtkSetClampMacro(TranslationAxis, int, -1, 2);
 
 
  void SetXTranslationAxisOn() { this->SetTranslationAxis(Axis::XAxis); }
  void SetYTranslationAxisOn() { this->SetTranslationAxis(Axis::YAxis); }
  void SetZTranslationAxisOn() { this->SetTranslationAxis(Axis::ZAxis); }
  void SetTranslationAxisOff() { this->SetTranslationAxis(Axis::NONE); }
 
protected:
  vtkBoundedWidgetRepresentation();
  ~vtkBoundedWidgetRepresentation() override;
 
  vtkActor* GetOutlineActor() { return this->OutlineActor; }
 
  void HighlightOutline(int highlight);
 
  void TranslateOutline(double* p1, double* p2);
 
  virtual void TranslateRepresentation(const vtkVector3d&){};
 
  bool IsTranslationConstrained() { return this->TranslationAxis != Axis::NONE; }
 
  double GetDiagonalLength();
 
  void SetOutlineBounds(double bounds[6]);
  void GetOutlineBounds(double bounds[6]);
 
  void TransformBounds(vtkTransform* transform);
 
  void UpdateCenterAndBounds(double center[6]);
 
  virtual void CreateDefaultProperties();
 
  void SetOutlineColor(double r, double g, double b);
  void SetSelectedOutlineColor(double r, double g, double b);
 
  void UpdateOutline();
 
  vtkImageData* GetBox() { return this->Box; }
 
private:
  vtkBoundedWidgetRepresentation(const vtkBoundedWidgetRepresentation&) = delete;
  void operator=(const vtkBoundedWidgetRepresentation&) = delete;
 
  void UpdateWidgetBounds();
 
  vtkNew<vtkImageData> Box;
  vtkNew<vtkOutlineFilter> Outline;
  vtkNew<vtkPolyDataMapper> OutlineMapper;
  vtkNew<vtkActor> OutlineActor;
 
  vtkNew<vtkProperty> OutlineProperty;
  vtkNew<vtkProperty> SelectedOutlineProperty;
 
  bool OutlineTranslation = true;
  bool OutsideBounds = true;
  bool ConstrainToWidgetBounds = true;
 
  int TranslationAxis = Axis::NONE;
 
  double WidgetBounds[6] = { 1, -1, 1, -1, 1, -1 };
};
 
VTK_ABI_NAMESPACE_END
#endif