vtkPointWidget.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 vtkPointWidget_h
#define vtkPointWidget_h
 
#include "vtk3DWidget.h"
#include "vtkCursor3D.h"                 // Needed for faster access to the Cursor3D
#include "vtkInteractionWidgetsModule.h" // For export macro
 
VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkPolyDataMapper;
class vtkCellPicker;
class vtkPolyData;
class vtkProperty;
 
class VTKINTERACTIONWIDGETS_EXPORT vtkPointWidget : public vtk3DWidget
{
public:
  static vtkPointWidget* New();
 
  vtkTypeMacro(vtkPointWidget, vtk3DWidget);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetEnabled(int) override;
  void PlaceWidget(double bounds[6]) override;
  void PlaceWidget() override { this->Superclass::PlaceWidget(); }
  void PlaceWidget(
    double xmin, double xmax, double ymin, double ymax, double zmin, double zmax) override
  {
    this->Superclass::PlaceWidget(xmin, xmax, ymin, ymax, zmin, zmax);
  }


  void GetPolyData(vtkPolyData* pd);

  void SetPosition(double x, double y, double z) { this->Cursor3D->SetFocalPoint(x, y, z); }
  void SetPosition(double x[3]) { this->SetPosition(x[0], x[1], x[2]); }
  double* GetPosition() VTK_SIZEHINT(3) { return this->Cursor3D->GetFocalPoint(); }
  void GetPosition(double xyz[3]) { this->Cursor3D->GetFocalPoint(xyz); }

  void SetOutline(int o) { this->Cursor3D->SetOutline(o); }
  int GetOutline() { return this->Cursor3D->GetOutline(); }
  void OutlineOn() { this->Cursor3D->OutlineOn(); }
  void OutlineOff() { this->Cursor3D->OutlineOff(); }

  void SetXShadows(int o) { this->Cursor3D->SetXShadows(o); }
  int GetXShadows() { return this->Cursor3D->GetXShadows(); }
  void XShadowsOn() { this->Cursor3D->XShadowsOn(); }
  void XShadowsOff() { this->Cursor3D->XShadowsOff(); }

  void SetYShadows(int o) { this->Cursor3D->SetYShadows(o); }
  int GetYShadows() { return this->Cursor3D->GetYShadows(); }
  void YShadowsOn() { this->Cursor3D->YShadowsOn(); }
  void YShadowsOff() { this->Cursor3D->YShadowsOff(); }

  void SetZShadows(int o) { this->Cursor3D->SetZShadows(o); }
  int GetZShadows() { return this->Cursor3D->GetZShadows(); }
  void ZShadowsOn() { this->Cursor3D->ZShadowsOn(); }
  void ZShadowsOff() { this->Cursor3D->ZShadowsOff(); }

  void SetTranslationMode(int mode)
  {
    this->Cursor3D->SetTranslationMode(mode);
    this->Cursor3D->Update();
  }
  int GetTranslationMode() { return this->Cursor3D->GetTranslationMode(); }
  void TranslationModeOn() { this->SetTranslationMode(1); }
  void TranslationModeOff() { this->SetTranslationMode(0); }


  void AllOn()
  {
    this->OutlineOn();
    this->XShadowsOn();
    this->YShadowsOn();
    this->ZShadowsOn();
  }
  void AllOff()
  {
    this->OutlineOff();
    this->XShadowsOff();
    this->YShadowsOff();
    this->ZShadowsOff();
  }



  vtkGetObjectMacro(Property, vtkProperty);
  vtkGetObjectMacro(SelectedProperty, vtkProperty);


  vtkSetClampMacro(HotSpotSize, double, 0.0, 1.0);
  vtkGetMacro(HotSpotSize, double);
 
protected:
  vtkPointWidget();
  ~vtkPointWidget() override;
 
  // Manage the state of the widget
  friend class vtkLineWidget;
 
  int State;
  enum WidgetState
  {
    Start = 0,
    Moving,
    Scaling,
    Translating,
    Outside
  };
 
  // Handles the events
  static void ProcessEvents(
    vtkObject* object, unsigned long event, void* clientdata, void* calldata);
 
  // ProcessEvents() dispatches to these methods.
  virtual void OnMouseMove();
  virtual void OnLeftButtonDown();
  virtual void OnLeftButtonUp();
  virtual void OnMiddleButtonDown();
  virtual void OnMiddleButtonUp();
  virtual void OnRightButtonDown();
  virtual void OnRightButtonUp();
 
  // the cursor3D
  vtkActor* Actor;
  vtkPolyDataMapper* Mapper;
  vtkCursor3D* Cursor3D;
  void Highlight(int highlight);
 
  // Do the picking
  vtkCellPicker* CursorPicker;
 
  // Register internal Pickers within PickingManager
  void RegisterPickers() override;
 
  // Methods to manipulate the cursor
  int ConstraintAxis;
  void Translate(double* p1, double* p2);
  void Scale(double* p1, double* p2, int X, int Y);
  void MoveFocus(double* p1, double* p2);
  int TranslationMode;
 
  // Properties used to control the appearance of selected objects and
  // the manipulator in general.
  vtkProperty* Property;
  vtkProperty* SelectedProperty;
  void CreateDefaultProperties();
 
  // The size of the hot spot.
  double HotSpotSize;
  int DetermineConstraintAxis(int constraint, double* x);
  int WaitingForMotion;
  int WaitCount;
 
private:
  vtkPointWidget(const vtkPointWidget&) = delete;
  void operator=(const vtkPointWidget&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif