vtkParallelopipedRepresentation.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 vtkParallelopipedRepresentation_h
#define vtkParallelopipedRepresentation_h
 
#include "vtkInteractionWidgetsModule.h" // For export macro
#include "vtkWidgetRepresentation.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkActor;
class vtkPlane;
class vtkPoints;
class vtkPolyData;
class vtkPolyDataMapper;
class vtkProperty;
class vtkCellArray;
class vtkTransform;
class vtkHandleRepresentation;
class vtkClosedSurfacePointPlacer;
class vtkPlaneCollection;
class vtkParallelopipedTopology;
 
class VTKINTERACTIONWIDGETS_EXPORT VTK_MARSHALAUTO vtkParallelopipedRepresentation
  : public vtkWidgetRepresentation
{
public:
  static vtkParallelopipedRepresentation* New();


  vtkTypeMacro(vtkParallelopipedRepresentation, vtkWidgetRepresentation);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void GetActors(vtkPropCollection* pc) override;


  virtual void PlaceWidget(double corners[8][3]);
  void PlaceWidget(double bounds[6]) override;


  vtkSetMacro(InteractionState, int);

  void GetBoundingPlanes(vtkPlaneCollection* pc);

  void GetPolyData(vtkPolyData* pd);

  double* GetBounds() VTK_SIZEHINT(6) override;


  virtual void SetHandleProperty(vtkProperty*);
  virtual void SetHoveredHandleProperty(vtkProperty*);
  virtual void SetSelectedHandleProperty(vtkProperty*);
  vtkGetObjectMacro(HandleProperty, vtkProperty);
  vtkGetObjectMacro(HoveredHandleProperty, vtkProperty);
  vtkGetObjectMacro(SelectedHandleProperty, vtkProperty);
 
  void SetHandleRepresentation(vtkHandleRepresentation* handle);
  vtkHandleRepresentation* GetHandleRepresentation(int index);


  void HandlesOn();
  void HandlesOff();


  vtkGetObjectMacro(FaceProperty, vtkProperty);
  vtkGetObjectMacro(SelectedFaceProperty, vtkProperty);


  vtkGetObjectMacro(OutlineProperty, vtkProperty);
  vtkGetObjectMacro(SelectedOutlineProperty, vtkProperty);

  void BuildRepresentation() override;


  void ReleaseGraphicsResources(vtkWindow* w) override;
  int RenderOverlay(vtkViewport* viewport) override;
  int RenderOpaqueGeometry(vtkViewport* viewport) override;

  int ComputeInteractionState(int X, int Y, int modify = 0) override;
 
  // Manage the state of the widget
  enum InteractionStateType
  {
    Outside = 0,
    Inside,
    RequestResizeParallelopiped,
    RequestResizeParallelopipedAlongAnAxis,
    RequestChairMode,
    RequestTranslateParallelopiped,
    RequestScaleParallelopiped,
    RequestRotateParallelopiped,
    ResizingParallelopiped,
    ResizingParallelopipedAlongAnAxis,
    ChairMode,
    TranslatingParallelopiped,
    ScalingParallelopiped,
    RotatingParallelopiped
  };
 
  // Methods to manipulate the piped.
  virtual void Translate(double translation[3]);
  virtual void Translate(int X, int Y);
  virtual void Scale(int X, int Y);

  virtual void PositionHandles();


  vtkSetMacro(MinimumThickness, double);
  vtkGetMacro(MinimumThickness, double);
 
protected:
  vtkParallelopipedRepresentation();
  ~vtkParallelopipedRepresentation() override;

  void TranslatePoint(int n, const double motionVector[3]);

  void SetHandleHighlight(int handleIdx, vtkProperty* property);


  void SetFaceHighlight(vtkCellArray* face, vtkProperty*);
  void HighlightAllFaces();
  void UnHighlightAllFaces();
 
  // Node can be a value within [0,7]. This will create a chair one one of
  // the handle corners. '0 < InitialChairDepth < 1' value dictates the starting
  // depth of the cavity.
  void UpdateChairAtNode(int node);
 
  // Removes any existing chairs.
  void RemoveExistingChairs();
 
  // Convenience method to get just the planes that define the parallelopiped.
  // If we aren't in chair mode, this will be the same as GetBoundingPlanes().
  // If we are in chair mode, this will be the first 6 planes from amongst
  // those returned by "GetBoundingPlanes".
  // All planes have their normals pointing inwards.
  void GetParallelopipedBoundingPlanes(vtkPlaneCollection* pc);
 
  // Convenience method to edefine a plane passing through 3 points.
  void DefinePlane(vtkPlane*, double p[3][3]);
 
  // Convenience method to edefine a plane passing through 3 pointIds of the
  // parallelopiped. The point Ids must like in the range [0,15], ie the
  // 15 points comprising the parallelopiped and the chair (also modelled
  // as a parallelopiped)
  void DefinePlane(vtkPlane*, vtkIdType, vtkIdType, vtkIdType);
 
  vtkActor* HexActor;
  vtkPolyDataMapper* HexMapper;
  vtkPolyData* HexPolyData;
  vtkPoints* Points;
  vtkActor* HexFaceActor;
  vtkPolyDataMapper* HexFaceMapper;
  vtkPolyData* HexFacePolyData;
 
  double LastEventPosition[2];
 
  // Cache the axis index used for face aligned resize.
  int LastResizeAxisIdx;
 
  vtkHandleRepresentation* HandleRepresentation;
  vtkHandleRepresentation** HandleRepresentations;
  int CurrentHandleIdx;
  int ChairHandleIdx;
 
  // When a chair is carved out for the first time, this is the initial
  // depth of the chair
  double InitialChairDepth;
 
  vtkProperty* HandleProperty;
  vtkProperty* HoveredHandleProperty;
  vtkProperty* FaceProperty;
  vtkProperty* OutlineProperty;
  vtkProperty* SelectedHandleProperty;
  vtkProperty* SelectedFaceProperty;
  vtkProperty* SelectedOutlineProperty;
  vtkClosedSurfacePointPlacer* ChairPointPlacer;
  vtkParallelopipedTopology* Topology;
  double MinimumThickness;
  double AbsoluteMinimumThickness;
 
private:
  vtkParallelopipedRepresentation(const vtkParallelopipedRepresentation&) = delete;
  void operator=(const vtkParallelopipedRepresentation&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif