vtkTensorGlyph.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 vtkTensorGlyph_h
#define vtkTensorGlyph_h

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

VTK_ABI_NAMESPACE_BEGIN
class VTKFILTERSCORE_EXPORT VTK_MARSHALAUTO vtkTensorGlyph : public vtkPolyDataAlgorithm
{
public:

  static vtkTensorGlyph* New();
  vtkTypeMacro(vtkTensorGlyph, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  void SetSourceData(vtkPolyData* source);
  vtkPolyData* GetSource();


  void SetSourceConnection(int id, vtkAlgorithmOutput* algOutput);
  void SetSourceConnection(vtkAlgorithmOutput* algOutput)
  {
    this->SetSourceConnection(0, algOutput);
  }


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


  vtkSetMacro(ScaleFactor, double);
  vtkGetMacro(ScaleFactor, double);


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


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


  vtkSetMacro(Length, double);
  vtkGetMacro(Length, double);


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


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

  enum
  {
    COLOR_BY_SCALARS,
    COLOR_BY_EIGENVALUES
  };


  vtkSetClampMacro(ColorMode, int, COLOR_BY_SCALARS, COLOR_BY_EIGENVALUES);
  vtkGetMacro(ColorMode, int);
  void SetColorModeToScalars() { this->SetColorMode(COLOR_BY_SCALARS); }
  void SetColorModeToEigenvalues() { this->SetColorMode(COLOR_BY_EIGENVALUES); }


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


  vtkSetMacro(MaxScaleFactor, double);
  vtkGetMacro(MaxScaleFactor, double);

protected:
  vtkTensorGlyph();
  ~vtkTensorGlyph() override;

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

  vtkTypeBool Scaling;            // Determine whether scaling of geometry is performed
  double ScaleFactor;             // Scale factor to use to scale geometry
  vtkTypeBool ExtractEigenvalues; // Boolean controls eigenfunction extraction
  vtkTypeBool ColorGlyphs;        // Boolean controls coloring with input scalar data
  int ColorMode;                  // The coloring mode to use for the glyphs.
  vtkTypeBool ClampScaling;       // Boolean controls whether scaling is clamped.
  double MaxScaleFactor;          // Maximum scale factor (ScaleFactor*eigenvalue)
  vtkTypeBool ThreeGlyphs;        // Boolean controls drawing 1 or 3 glyphs
  vtkTypeBool Symmetric;          // Boolean controls drawing a "mirror" of each glyph
  double Length;                  // Distance, in x, from the origin to the end of the glyph
private:
  vtkTensorGlyph(const vtkTensorGlyph&) = delete;
  void operator=(const vtkTensorGlyph&) = delete;
};

VTK_ABI_NAMESPACE_END
#endif