vtkPointHandleRepresentation3D.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkPointHandleRepresentation3D.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/
#ifndef vtkPointHandleRepresentation3D_h
#define vtkPointHandleRepresentation3D_h

#include "vtkCursor3D.h" // Needed for delegation to cursor3D
#include "vtkHandleRepresentation.h"
#include "vtkInteractionWidgetsModule.h" // For export macro

class vtkCursor3D;
class vtkProperty;
class vtkActor;
class vtkPolyDataMapper;
class vtkCellPicker;

class VTKINTERACTIONWIDGETS_EXPORT vtkPointHandleRepresentation3D : public vtkHandleRepresentation
{
public:
  static vtkPointHandleRepresentation3D* New();


  vtkTypeMacro(vtkPointHandleRepresentation3D, vtkHandleRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  using vtkHandleRepresentation::Translate;


  void SetWorldPosition(double p[3]) override;
  void SetDisplayPosition(double p[3]) override;

  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(vtkTypeBool mode);
  vtkGetMacro(TranslationMode, vtkTypeBool);
  vtkBooleanMacro(TranslationMode, vtkTypeBool);

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


  void SetProperty(vtkProperty*);
  void SetSelectedProperty(vtkProperty*);
  vtkGetObjectMacro(Property, vtkProperty);
  vtkGetObjectMacro(SelectedProperty, vtkProperty);


  vtkSetClampMacro(HotSpotSize, double, 0.0, 1.0);
  vtkGetMacro(HotSpotSize, double);

  void SetHandleSize(double size) override;


  double* GetBounds() VTK_SIZEHINT(6) override;
  void BuildRepresentation() override;
  void StartWidgetInteraction(double eventPos[2]) override;
  void WidgetInteraction(double eventPos[2]) override;
  int ComputeInteractionState(int X, int Y, int modify = 0) override;
  void PlaceWidget(double bounds[6]) override;
  void StartComplexInteraction(vtkRenderWindowInteractor* iren, vtkAbstractWidget* widget,
    unsigned long event, void* calldata) override;
  void ComplexInteraction(vtkRenderWindowInteractor* iren, vtkAbstractWidget* widget,
    unsigned long event, void* calldata) override;
  int ComputeComplexInteractionState(vtkRenderWindowInteractor* iren, vtkAbstractWidget* widget,
    unsigned long event, void* calldata, int modify = 0) override;


  void ShallowCopy(vtkProp* prop) override;
  void DeepCopy(vtkProp* prop) override;
  void GetActors(vtkPropCollection*) override;
  void ReleaseGraphicsResources(vtkWindow*) override;
  int RenderOpaqueGeometry(vtkViewport* viewport) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport* viewport) override;
  vtkTypeBool HasTranslucentPolygonalGeometry() override;

  void Highlight(int highlight) override;


  vtkSetMacro(SmoothMotion, vtkTypeBool);
  vtkGetMacro(SmoothMotion, vtkTypeBool);
  vtkBooleanMacro(SmoothMotion, vtkTypeBool);

  /*
   * Register internal Pickers within PickingManager
   */
  void RegisterPickers() override;

  void SetVisibility(vtkTypeBool visible) override;

protected:
  vtkPointHandleRepresentation3D();
  ~vtkPointHandleRepresentation3D() override;

  // the cursor3D
  vtkActor* Actor;
  vtkPolyDataMapper* Mapper;
  vtkCursor3D* Cursor3D;

  // Do the picking
  vtkCellPicker* CursorPicker;
  double LastPickPosition[3];
  double LastEventPosition[3];

  // Methods to manipulate the cursor
  int ConstraintAxis;
  virtual void Translate(const double* p1, const double* p2) override;
  void Scale(const double* p1, const double* p2, const double eventPos[2]);
  void MoveFocus(const double* p1, const double* p2);
  void SizeBounds();

  void MoveFocusRequest(
    const double* p1, const double* p2, const double currPos[2], double center[3]);

  // 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, double* startPoint);
  int WaitingForMotion;
  int WaitCount;

  // Current handle sized (may reflect scaling)
  double CurrentHandleSize;

  // Control how translation works
  vtkTypeBool TranslationMode;

  vtkTypeBool SmoothMotion;

private:
  vtkPointHandleRepresentation3D(const vtkPointHandleRepresentation3D&) = delete;
  void operator=(const vtkPointHandleRepresentation3D&) = delete;
};

#endif