vtkVectorNorm.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 vtkVectorNorm_h
#define vtkVectorNorm_h

#define VTK_ATTRIBUTE_MODE_DEFAULT 0
#define VTK_ATTRIBUTE_MODE_USE_POINT_DATA 1
#define VTK_ATTRIBUTE_MODE_USE_CELL_DATA 2

#include "vtkDataSetAlgorithm.h"
#include "vtkFiltersCoreModule.h" // For export macro
#include "vtkWrappingHints.h"     // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class VTKFILTERSCORE_EXPORT VTK_MARSHALAUTO vtkVectorNorm : public vtkDataSetAlgorithm
{
public:
  vtkTypeMacro(vtkVectorNorm, vtkDataSetAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkVectorNorm* New();

  // Specify whether to normalize scalar values. If the data is normalized,
  // then it will fall in the range [0,1].
  vtkSetMacro(Normalize, vtkTypeBool);
  vtkGetMacro(Normalize, vtkTypeBool);
  vtkBooleanMacro(Normalize, vtkTypeBool);


  vtkSetMacro(AttributeMode, int);
  vtkGetMacro(AttributeMode, int);
  void SetAttributeModeToDefault() { this->SetAttributeMode(VTK_ATTRIBUTE_MODE_DEFAULT); }
  void SetAttributeModeToUsePointData()
  {
    this->SetAttributeMode(VTK_ATTRIBUTE_MODE_USE_POINT_DATA);
  }
  void SetAttributeModeToUseCellData() { this->SetAttributeMode(VTK_ATTRIBUTE_MODE_USE_CELL_DATA); }
  const char* GetAttributeModeAsString();

protected:
  vtkVectorNorm();
  ~vtkVectorNorm() override = default;

  int RequestData(vtkInformation*, vtkInformationVector**, vtkInformationVector*) override;

  vtkTypeBool Normalize; // normalize 0<=n<=1 if true.
  int AttributeMode;     // control whether to use point or cell data, or both

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

VTK_ABI_NAMESPACE_END
#endif