vtkHyperTreeGridAxisClip.h

Go to the documentation of this file.

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

  Program:   Visualization Toolkit
  Module:    vtkHyperTreeGridAxisClip.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 vtkHyperTreeGridAxisClip_h
#define vtkHyperTreeGridAxisClip_h

#include "vtkFiltersHyperTreeModule.h" // For export macro
#include "vtkHyperTreeGridAlgorithm.h"

class vtkBitArray;
class vtkHyperTreeCursor;
class vtkHyperTreeGrid;
class vtkHyperTreeGridCursor;
class vtkQuadric;

class VTKFILTERSHYPERTREE_EXPORT vtkHyperTreeGridAxisClip : public vtkHyperTreeGridAlgorithm
{
public:
  static vtkHyperTreeGridAxisClip* New();
  vtkTypeMacro( vtkHyperTreeGridAxisClip, vtkHyperTreeGridAlgorithm );
  void PrintSelf( ostream&, vtkIndent ) override;

  enum ClipType
  {
    PLANE = 0,
    BOX,
    QUADRIC,
  };


  vtkSetClampMacro(ClipType, int, 0, 2);
  vtkGetMacro(ClipType, int);
  void SetClipTypeToPlane() { this->SetClipType( vtkHyperTreeGridAxisClip::PLANE); }
  void SetClipTypeToBox() { this->SetClipType( vtkHyperTreeGridAxisClip::BOX); }
  void SetClipTypeToQuadric() { this->SetClipType( vtkHyperTreeGridAxisClip::QUADRIC); }


  vtkSetClampMacro(PlaneNormalAxis, int, 0, 2);
  vtkGetMacro(PlaneNormalAxis, int);


  vtkSetMacro(PlanePosition, double);
  vtkGetMacro(PlanePosition, double);


  vtkSetVector6Macro(Bounds,double);
  vtkGetVectorMacro(Bounds,double,6);
  void SetMinimumBounds(double x, double y, double z);
  void SetMaximumBounds(double x, double y, double z);
  void SetMinimumBounds(double[3]) VTK_SIZEHINT(3);
  void SetMaximumBounds(double[3]) VTK_SIZEHINT(3);
  void GetMinimumBounds(double[3]) VTK_SIZEHINT(3);
  void GetMaximumBounds(double[3]) VTK_SIZEHINT(3);


  vtkSetMacro(InsideOut,int);
  vtkGetMacro(InsideOut,int);
  vtkBooleanMacro(InsideOut,int);


  virtual void SetQuadric( vtkQuadric* );
  vtkGetObjectMacro(Quadric, vtkQuadric);


  void SetQuadricCoefficients(double a0, double a1, double a2, double a3,
                              double a4, double a5, double a6, double a7,
                              double a8, double a9);
  void SetQuadricCoefficients(double[10]) VTK_SIZEHINT(10) ;
  void GetQuadricCoefficients(double[10]) VTK_SIZEHINT(10);
  double* GetQuadricCoefficients();

  vtkMTimeType GetMTime() override;

protected:
  vtkHyperTreeGridAxisClip();
  ~vtkHyperTreeGridAxisClip() override;

  // For this algorithm the output is a vtkHyperTreeGrid instance
  int FillOutputPortInformation( int, vtkInformation* ) override;

  bool IsClipped( vtkHyperTreeGridCursor* );

  int ProcessTrees( vtkHyperTreeGrid*, vtkDataObject* ) override;

  void RecursivelyProcessTree( vtkHyperTreeGridCursor*,
                               vtkHyperTreeCursor*,
                               vtkBitArray* );

  int ClipType;

  int PlaneNormalAxis;

  double PlanePosition;

  double Bounds[6];

  vtkQuadric* Quadric;

  int InsideOut;

  vtkBitArray* MaterialMask;

  vtkIdType CurrentId;

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

#endif /* vtkHyperTreeGridAxisClip_h */