vtkClipVolume.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkClipVolume.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 vtkClipVolume_h
#define vtkClipVolume_h
 
#include "vtkFiltersGeneralModule.h" // For export macro
#include "vtkUnstructuredGridAlgorithm.h"
 
class vtkCellData;
class vtkDataArray;
class vtkIdList;
class vtkImplicitFunction;
class vtkMergePoints;
class vtkOrderedTriangulator;
class vtkPointData;
class vtkIncrementalPointLocator;
class vtkPoints;
class vtkUnstructuredGrid;
class vtkCell;
class vtkTetra;
class vtkCellArray;
class vtkIdTypeArray;
class vtkUnsignedCharArray;
 
class VTKFILTERSGENERAL_EXPORT vtkClipVolume : public vtkUnstructuredGridAlgorithm
{
public:
  vtkTypeMacro(vtkClipVolume, vtkUnstructuredGridAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkClipVolume* New();
 
 
  vtkSetMacro(Value, double);
  vtkGetMacro(Value, double);
 
 
  vtkSetMacro(InsideOut, vtkTypeBool);
  vtkGetMacro(InsideOut, vtkTypeBool);
  vtkBooleanMacro(InsideOut, vtkTypeBool);
 
 
  virtual void SetClipFunction(vtkImplicitFunction*);
  vtkGetObjectMacro(ClipFunction, vtkImplicitFunction);
 
 
  vtkSetMacro(GenerateClipScalars, vtkTypeBool);
  vtkGetMacro(GenerateClipScalars, vtkTypeBool);
  vtkBooleanMacro(GenerateClipScalars, vtkTypeBool);
 
 
  vtkSetMacro(GenerateClippedOutput, vtkTypeBool);
  vtkGetMacro(GenerateClippedOutput, vtkTypeBool);
  vtkBooleanMacro(GenerateClippedOutput, vtkTypeBool);
 
  vtkUnstructuredGrid* GetClippedOutput();
 
 
  vtkSetMacro(Mixed3DCellGeneration, vtkTypeBool);
  vtkGetMacro(Mixed3DCellGeneration, vtkTypeBool);
  vtkBooleanMacro(Mixed3DCellGeneration, vtkTypeBool);
 
 
  vtkSetClampMacro(MergeTolerance, double, 0.0001, 0.25);
  vtkGetMacro(MergeTolerance, double);
 
 
  void SetLocator(vtkIncrementalPointLocator* locator);
  vtkGetObjectMacro(Locator, vtkIncrementalPointLocator);
 
  void CreateDefaultLocator();
 
  vtkMTimeType GetMTime() override;
 
protected:
  vtkClipVolume(vtkImplicitFunction* cf = nullptr);
  ~vtkClipVolume() override;
 
  void ReportReferences(vtkGarbageCollector*) override;
 
  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  int FillInputPortInformation(int port, vtkInformation* info) override;
 
  void ClipTets(double value, vtkTetra* clipTetra, vtkDataArray* clipScalars,
    vtkDataArray* cellScalars, vtkIdList* tetraIds, vtkPoints* tetraPts, vtkPointData* inPD,
    vtkPointData* outPD, vtkCellData* inCD, vtkIdType cellId, vtkCellData* outCD,
    vtkCellData* clippedCD, int insideOut);
  void ClipVoxel(double value, vtkDataArray* cellScalars, int flip, double origin[3],
    double spacing[3], vtkIdList* cellIds, vtkPoints* cellPts, vtkPointData* inPD,
    vtkPointData* outPD, vtkCellData* inCD, vtkIdType cellId, vtkCellData* outCD,
    vtkCellData* clippedCD);
 
  vtkImplicitFunction* ClipFunction;
  vtkIncrementalPointLocator* Locator;
  vtkTypeBool InsideOut;
  double Value;
  vtkTypeBool GenerateClipScalars;
  double MergeTolerance;
  vtkTypeBool Mixed3DCellGeneration;
  vtkTypeBool GenerateClippedOutput;
  vtkUnstructuredGrid* ClippedOutput;
 
private:
  vtkOrderedTriangulator* Triangulator;
 
  // Used temporarily to pass data around
  vtkIdType NumberOfCells;
  vtkCellArray* Connectivity;
  vtkUnsignedCharArray* Types;
  vtkIdType NumberOfClippedCells;
  vtkCellArray* ClippedConnectivity;
  vtkUnsignedCharArray* ClippedTypes;
 
private:
  vtkClipVolume(const vtkClipVolume&) = delete;
  void operator=(const vtkClipVolume&) = delete;
};
 
#endif