vtkZSpaceInteractorStyle.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 vtkZSpaceInteractorStyle_h
#define vtkZSpaceInteractorStyle_h
 
#include "vtkDataObject.h" // for vtkDataObject enums
#include "vtkEventData.h"  // for enums
#include "vtkInteractorStyle3D.h"
#include "vtkNew.h"                   // for ivar
#include "vtkRenderingZSpaceModule.h" // for export macro
 
VTK_ABI_NAMESPACE_BEGIN
 
class vtkCell;
class vtkPlane;
class vtkSelection;
class vtkDataSet;
class vtkTextActor;
class vtkZSpaceRayActor;
class vtkZSpaceHardwarePicker;
 
class VTKRENDERINGZSPACE_EXPORT vtkZSpaceInteractorStyle : public vtkInteractorStyle3D
{
public:
  static vtkZSpaceInteractorStyle* New();
  vtkTypeMacro(vtkZSpaceInteractorStyle, vtkInteractorStyle3D);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void OnPick3D(vtkEventData* edata) override;
  void OnPositionProp3D(vtkEventData* edata) override;
  void OnMove3D(vtkEventData* edata) override;
  void OnSelect3D(vtkEventData* edata) override;


  virtual void StartPick(vtkEventDataDevice3D*);
  virtual void EndPick(vtkEventDataDevice3D*);
  virtual void StartPositionProp(vtkEventDataDevice3D*);
  virtual void EndPositionProp(vtkEventDataDevice3D*);


  void ProbeData(vtkEventDataDevice3D*);
  virtual void PositionProp(vtkEventData*, double* lwpos = nullptr, double* lwori = nullptr);


  vtkSetMacro(HoverPick, bool);
  vtkGetMacro(HoverPick, bool);
  vtkBooleanMacro(HoverPick, bool);

  void UpdateRay(vtkEventDataDevice3D*);

  vtkSetMacro(ZSpaceRayActor, vtkZSpaceRayActor*);


  vtkSetClampMacro(PickingFieldAssociation, int, vtkDataObject::FIELD_ASSOCIATION_POINTS,
    vtkDataObject::FIELD_ASSOCIATION_CELLS);
  vtkGetMacro(PickingFieldAssociation, int);
 
protected:
  vtkZSpaceInteractorStyle();
  ~vtkZSpaceInteractorStyle() override = default;

  void EndPickCallback(vtkSelection* sel);


  void StartAction(int VTKIS_STATE, vtkEventDataDevice3D* edata);
  void EndAction(int VTKIS_STATE, vtkEventDataDevice3D* edata);

  bool HardwareSelect(vtkEventDataDevice3D* edd, bool actorPassOnly);

  bool FindDataSet(vtkSelection* sel, vtkSmartPointer<vtkDataSet>& ds, vtkIdType& aid);

  std::string GetPickedText(vtkDataSet* ds, const vtkIdType& aid);

  void CreatePickCell(vtkCell* cell);

  void CreatePickPoint(double* point);

  void UpdatePickActor();

  void RemovePickActor();

  bool HoverPick = false;
 
  // Used to draw picked cells or points
  vtkNew<vtkActor> PickActor;
  // XXX Very good chance we can swap it with this->InteractionProp
  // The text actor is linked to this prop
  vtkProp3D* PickedInteractionProp = nullptr;
  vtkNew<vtkTextActor> TextActor;
  vtkZSpaceRayActor* ZSpaceRayActor;
 
  // Used to do the actual picking action (not the interactive picking).
  vtkNew<vtkZSpaceHardwarePicker> HardwarePicker;
 
  // The field association used when picking with the ray
  int PickingFieldAssociation = vtkDataObject::FIELD_ASSOCIATION_CELLS;
 
private:
  vtkZSpaceInteractorStyle(const vtkZSpaceInteractorStyle&) = delete;
  void operator=(const vtkZSpaceInteractorStyle&) = delete;
};
 
VTK_ABI_NAMESPACE_END
 
#endif