vtkSegmentationLabelmapSurfaceMapper.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.
 
  The signed distance field computation (jump flooding) and the ray casting
  are based on SlicerLive by Steve Pieper (https://github.com/pieper/SlicerLive,
  Apache License 2.0).
 
==============================================================================*/
 
#ifndef __vtkSegmentationLabelmapSurfaceMapper_h
#define __vtkSegmentationLabelmapSurfaceMapper_h
 
#include "vtkSlicerSegmentationsModuleMRMLDisplayableManagerExport.h"
 
// MRMLDisplayableManager includes
#include <vtkMRMLRayCastMapper.h>
 
class vtkOrientedImageData;

class VTK_SLICER_SEGMENTATIONS_MODULE_MRMLDISPLAYABLEMANAGER_EXPORT vtkSegmentationLabelmapSurfaceMapper : public vtkMRMLRayCastMapper
{
public:
  static vtkSegmentationLabelmapSurfaceMapper* New();
  vtkTypeMacro(vtkSegmentationLabelmapSurfaceMapper, vtkMRMLRayCastMapper);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  void SetLabelmap(vtkOrientedImageData* labelmap);
  vtkOrientedImageData* GetLabelmap();

  void SetLabelColor(int labelValue, double r, double g, double b, double opacity = 1.0);
  void RemoveAllLabelColors();

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

  vtkSetClampMacro(MaximumNumberOfVoxels, vtkIdType, 4096, VTK_ID_MAX);
  vtkGetMacro(MaximumNumberOfVoxels, vtkIdType);

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

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

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

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

  vtkSetVector3Macro(OutlineColor, double);
  vtkGetVector3Macro(OutlineColor, double);

  vtkSetClampMacro(OutlineWidth, double, 0.5, 100.0);
  vtkGetMacro(OutlineWidth, double);

  vtkSetClampMacro(ImageSampleDistance, double, 1.0, 8.0);
  vtkGetMacro(ImageSampleDistance, double);

  vtkGetMacro(NumberOfDistanceFieldComputations, int);

  bool IntersectWithRay(const double p1[3], const double p2[3], double t1, double t2, vtkMatrix4x4* toWorld, double& t, double xyz[3], double n[3]) override;

  int GetShownLabelAtPosition(const double ijk[3], double maximumDistance = 1.5);
 
  void Render(vtkRenderer* ren, vtkActor* actor) override;
  void ReleaseGraphicsResources(vtkWindow* window) override;
  using Superclass::GetBounds;
  double* GetBounds() VTK_SIZEHINT(6) override;
 
protected:
  vtkSegmentationLabelmapSurfaceMapper();
  ~vtkSegmentationLabelmapSurfaceMapper() override;
 
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  double SmoothingFactor{ 0.5 };
  double ImageSampleDistance{ 1.0 };
  bool CapClippedSurface{ true };
  double CapOpacity{ 1.0 };
  bool KeepWhereAnyClippingPlaneKeeps{ false };
  bool ClippingOutline{ false };
  double OutlineColor[3]{ 0.0, 0.0, 0.0 };
  double OutlineWidth{ 1.0 };
  vtkIdType MaximumNumberOfVoxels{ 32 * 1024 * 1024 };
  int NumberOfDistanceFieldComputations{ 0 };
 
private:
  vtkSegmentationLabelmapSurfaceMapper(const vtkSegmentationLabelmapSurfaceMapper&) = delete;
  void operator=(const vtkSegmentationLabelmapSurfaceMapper&) = delete;
 
  class vtkInternal;
  vtkInternal* Internal;
};
 
#endif