vtkSampleFunction.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkSampleFunction.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 vtkSampleFunction_h
#define vtkSampleFunction_h
 
#include "vtkImageAlgorithm.h"
#include "vtkImagingHybridModule.h" // For export macro
 
class vtkImplicitFunction;
class vtkDataArray;
 
class VTKIMAGINGHYBRID_EXPORT vtkSampleFunction : public vtkImageAlgorithm
{
public:
  vtkTypeMacro(vtkSampleFunction, vtkImageAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;
 
  static vtkSampleFunction* New();
 
 
  virtual void SetImplicitFunction(vtkImplicitFunction*);
  vtkGetObjectMacro(ImplicitFunction, vtkImplicitFunction);
 
 
  vtkSetMacro(OutputScalarType, int);
  vtkGetMacro(OutputScalarType, int);
  void SetOutputScalarTypeToDouble() { this->SetOutputScalarType(VTK_DOUBLE); }
  void SetOutputScalarTypeToFloat() { this->SetOutputScalarType(VTK_FLOAT); }
  void SetOutputScalarTypeToLong() { this->SetOutputScalarType(VTK_LONG); }
  void SetOutputScalarTypeToUnsignedLong() { this->SetOutputScalarType(VTK_UNSIGNED_LONG); }
  void SetOutputScalarTypeToInt() { this->SetOutputScalarType(VTK_INT); }
  void SetOutputScalarTypeToUnsignedInt() { this->SetOutputScalarType(VTK_UNSIGNED_INT); }
  void SetOutputScalarTypeToShort() { this->SetOutputScalarType(VTK_SHORT); }
  void SetOutputScalarTypeToUnsignedShort() { this->SetOutputScalarType(VTK_UNSIGNED_SHORT); }
  void SetOutputScalarTypeToChar() { this->SetOutputScalarType(VTK_CHAR); }
  void SetOutputScalarTypeToUnsignedChar() { this->SetOutputScalarType(VTK_UNSIGNED_CHAR); }
 
  void SetSampleDimensions(int i, int j, int k);
 
 
  void SetSampleDimensions(int dim[3]);
  vtkGetVectorMacro(SampleDimensions, int, 3);
 
 
  void SetModelBounds(const double bounds[6]);
  void SetModelBounds(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax);
  vtkGetVectorMacro(ModelBounds, double, 6);
 
 
  vtkSetMacro(Capping, vtkTypeBool);
  vtkGetMacro(Capping, vtkTypeBool);
  vtkBooleanMacro(Capping, vtkTypeBool);
 
 
  vtkSetMacro(CapValue, double);
  vtkGetMacro(CapValue, double);
 
 
  vtkSetMacro(ComputeNormals, vtkTypeBool);
  vtkGetMacro(ComputeNormals, vtkTypeBool);
  vtkBooleanMacro(ComputeNormals, vtkTypeBool);
 
 
  vtkSetStringMacro(ScalarArrayName);
  vtkGetStringMacro(ScalarArrayName);
 
 
  vtkSetStringMacro(NormalArrayName);
  vtkGetStringMacro(NormalArrayName);
 
  vtkMTimeType GetMTime() override;
 
protected:
  vtkSampleFunction();
 
  ~vtkSampleFunction() override;
 
  void ReportReferences(vtkGarbageCollector*) override;
 
  void ExecuteDataWithInformation(vtkDataObject*, vtkInformation*) override;
  int RequestInformation(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;
  void Cap(vtkDataArray* s);
 
  int OutputScalarType;
  int SampleDimensions[3];
  double ModelBounds[6];
  vtkTypeBool Capping;
  double CapValue;
  vtkImplicitFunction* ImplicitFunction;
  vtkTypeBool ComputeNormals;
  char* ScalarArrayName;
  char* NormalArrayName;
 
private:
  vtkSampleFunction(const vtkSampleFunction&) = delete;
  void operator=(const vtkSampleFunction&) = delete;
};
 
#endif