vtkImplicitFunction.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
// SPDX-License-Identifier: BSD-3-Clause
#ifndef vtkImplicitFunction_h
#define vtkImplicitFunction_h

#include "vtkCommonDataModelModule.h" // For export macro
#include "vtkObject.h"
#include "vtkWrappingHints.h" // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class vtkDataArray;

class vtkAbstractTransform;

class VTKCOMMONDATAMODEL_EXPORT VTK_MARSHALAUTO vtkImplicitFunction : public vtkObject
{
public:
  vtkTypeMacro(vtkImplicitFunction, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  vtkMTimeType GetMTime() override;


  virtual void FunctionValue(vtkDataArray* input, vtkDataArray* output);
  double FunctionValue(const double x[3]);
  double FunctionValue(double x, double y, double z)
  {
    double xyz[3] = { x, y, z };
    return this->FunctionValue(xyz);
  }


  void FunctionGradient(const double x[3], double g[3]);
  double* FunctionGradient(const double x[3]) VTK_SIZEHINT(3)
  {
    this->FunctionGradient(x, this->ReturnValue);
    return this->ReturnValue;
  }
  double* FunctionGradient(double x, double y, double z) VTK_SIZEHINT(3)
  {
    double xyz[3] = { x, y, z };
    return this->FunctionGradient(xyz);
  }


  virtual void SetTransform(vtkAbstractTransform*);
  virtual void SetTransform(const double elements[16]);
  vtkGetObjectMacro(Transform, vtkAbstractTransform);


  virtual double EvaluateFunction(double x[3]) = 0;
  virtual void EvaluateFunction(vtkDataArray* input, vtkDataArray* output);
  virtual double EvaluateFunction(double x, double y, double z)
  {
    double xyz[3] = { x, y, z };
    return this->EvaluateFunction(xyz);
  }

  virtual void EvaluateGradient(double x[3], double g[3]) = 0;

protected:
  vtkImplicitFunction();
  ~vtkImplicitFunction() override;

  vtkAbstractTransform* Transform;
  double ReturnValue[3];

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

VTK_ABI_NAMESPACE_END
#endif