vtkSlicerPlaneRepresentation3D.h

Go to the documentation of this file.

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

  Copyright (c) Laboratory for Percutaneous Surgery (PerkLab)
  Queen's University, Kingston, ON, Canada. All Rights Reserved.

  See COPYRIGHT.txt
  or http://www.slicer.org/copyright/copyright.txt for details.

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.

  This file was originally developed by Kyle Sunderland, PerkLab, Queen's University
  and was supported through CANARIE's Research Software Program, Cancer
  Care Ontario, OpenAnatomy, and Brigham and Women's Hospital through NIH grant R01MH112748.

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

#ifndef vtkSlicerPlaneRepresentation3D_h
#define vtkSlicerPlaneRepresentation3D_h

#include "vtkSlicerMarkupsModuleVTKWidgetsExport.h"
#include "vtkSlicerMarkupsWidgetRepresentation3D.h"

class vtkActor;
class vtkArrayCalculator;
class vtkAppendPolyData;
class vtkArrowSource;
class vtkGlyph3DMapper;
class vtkLookupTable;
class vtkMRMLInteractionEventData;
class vtkPlaneSource;
class vtkPolyDataMapper;
class vtkPolyData;
class vtkTransformPolyDataFilter;
class vtkTubeFilter;

class VTK_SLICER_MARKUPS_MODULE_VTKWIDGETS_EXPORT vtkSlicerPlaneRepresentation3D : public vtkSlicerMarkupsWidgetRepresentation3D
{
public:
  static vtkSlicerPlaneRepresentation3D *New();

  vtkTypeMacro(vtkSlicerPlaneRepresentation3D,vtkSlicerMarkupsWidgetRepresentation3D);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void UpdateFromMRML(vtkMRMLNode* caller, unsigned long event, void *callData=nullptr) override;

  void GetActors(vtkPropCollection *) override;
  void ReleaseGraphicsResources(vtkWindow *) override;
  int RenderOverlay(vtkViewport *viewport) override;
  int RenderOpaqueGeometry(vtkViewport *viewport) override;
  int RenderTranslucentPolygonalGeometry(vtkViewport *viewport) override;
  vtkTypeBool HasTranslucentPolygonalGeometry() override;

  double *GetBounds() override;

  bool GetTransformationReferencePoint(double referencePointWorld[3]) override;

  void CanInteract(vtkMRMLInteractionEventData* interactionEventData,
    int &foundComponentType, int &foundComponentIndex, double &closestDistance2) override;

  void CanInteractWithPlane(vtkMRMLInteractionEventData* interactionEventData,
    int& foundComponentType, int& foundComponentIndex, double& closestDistance2);

protected:
  vtkSlicerPlaneRepresentation3D();
  ~vtkSlicerPlaneRepresentation3D() override;

  vtkNew<vtkPlaneSource>     PlaneFillFilter;
  vtkNew<vtkArrowSource>     ArrowFilter;
  vtkNew<vtkGlyph3D>         ArrowGlypher;
  vtkNew<vtkTubeFilter>      PlaneOutlineFilter;
  vtkNew<vtkArrayCalculator> ArrowColorFilter;
  vtkNew<vtkArrayCalculator> PlaneOutlineColorFilter;
  vtkNew<vtkArrayCalculator> PlaneFillColorFilter;
  vtkNew<vtkAppendPolyData>  Append;

  vtkNew<vtkActor>           PlaneActor;
  vtkNew<vtkActor>           PlaneOccludedActor;

  vtkNew<vtkPolyDataMapper>  PlaneMapper;
  vtkNew<vtkPolyDataMapper>  PlaneOccludedMapper;

  vtkNew<vtkLookupTable>    PlaneColorLUT;

  std::string LabelFormat;

  // Setup the pipeline for plane display
  void BuildPlane();


  // Initialize interaction handle pipeline
  void SetupInteractionPipeline() override;

  // Update visibility of interaction handles for representation
  void UpdateInteractionPipeline() override;

  class VTK_SLICER_MARKUPS_MODULE_VTKWIDGETS_EXPORT MarkupsInteractionPipelinePlane : public MarkupsInteractionPipeline
  {
  public:
    MarkupsInteractionPipelinePlane(vtkSlicerMarkupsWidgetRepresentation* representation);
    ~MarkupsInteractionPipelinePlane() override = default;

    // Initialize scale handles
    void CreateScaleHandles() override;

    HandleInfoList GetHandleInfoList() override;

    // Update scale handle positions
    virtual void UpdateScaleHandles();

    // Update scale handle visibilities
    void UpdateHandleVisibility() override;

    void GetHandleColor(int type, int index, double color[4]) override;
    double GetHandleOpacity(int type, int index) override;

    void GetInteractionHandleAxisWorld(int type, int index, double axis[3]) override;
  };
  friend class vtkSlicerPlaneRepresentation2D;

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

#endif