vtkMaskPoints.h

Go to the documentation of this file.

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

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

#include "vtkFiltersCoreModule.h" // For export macro
#include "vtkPolyDataAlgorithm.h"

class VTKFILTERSCORE_EXPORT vtkMaskPoints : public vtkPolyDataAlgorithm
{
public:
  static vtkMaskPoints *New();
  vtkTypeMacro(vtkMaskPoints,vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetClampMacro(OnRatio,int,1,VTK_INT_MAX);
  vtkGetMacro(OnRatio,int);


  vtkSetClampMacro(MaximumNumberOfPoints,vtkIdType,0,VTK_ID_MAX);
  vtkGetMacro(MaximumNumberOfPoints,vtkIdType);


  vtkSetClampMacro(Offset,vtkIdType,0,VTK_ID_MAX);
  vtkGetMacro(Offset,vtkIdType);


  vtkSetMacro(RandomMode,vtkTypeBool);
  vtkGetMacro(RandomMode,vtkTypeBool);
  vtkBooleanMacro(RandomMode,vtkTypeBool);


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


  vtkSetMacro(ProportionalMaximumNumberOfPoints, vtkTypeBool);
  vtkGetMacro(ProportionalMaximumNumberOfPoints, vtkTypeBool);
  vtkBooleanMacro(ProportionalMaximumNumberOfPoints, vtkTypeBool);


  vtkSetMacro(GenerateVertices,vtkTypeBool);
  vtkGetMacro(GenerateVertices,vtkTypeBool);
  vtkBooleanMacro(GenerateVertices,vtkTypeBool);


  vtkSetMacro(SingleVertexPerCell,vtkTypeBool);
  vtkGetMacro(SingleVertexPerCell,vtkTypeBool);
  vtkBooleanMacro(SingleVertexPerCell,vtkTypeBool);


  vtkSetMacro(OutputPointsPrecision,int);
  vtkGetMacro(OutputPointsPrecision,int);

protected:
  vtkMaskPoints();
  ~vtkMaskPoints() override {}

  int RequestData(vtkInformation *, vtkInformationVector **,
                  vtkInformationVector *) override;
  int FillInputPortInformation(int port, vtkInformation *info) override;

  int OnRatio;     // every OnRatio point is on; all others are off.
  vtkIdType Offset;      // offset (or starting point id)
  int RandomMode;  // turn on/off randomization
  vtkIdType MaximumNumberOfPoints;
  vtkTypeBool GenerateVertices; //generate polydata verts
  vtkTypeBool SingleVertexPerCell;
  int RandomModeType; // choose the random sampling mode
  vtkTypeBool ProportionalMaximumNumberOfPoints;
  int OutputPointsPrecision;

  virtual void InternalScatter(unsigned long*, unsigned long *, int, int) {}
  virtual void InternalGather(unsigned long*, unsigned long*, int, int) {}
  virtual int InternalGetNumberOfProcesses() { return 1; };
  virtual int InternalGetLocalProcessId() { return 0; };
  virtual void InternalBarrier() {}
  unsigned long GetLocalSampleSize(vtkIdType, int);

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

#endif