vtkArrowSource.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 vtkArrowSource_h
#define vtkArrowSource_h

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

VTK_ABI_NAMESPACE_BEGIN
class VTKFILTERSSOURCES_EXPORT VTK_MARSHALAUTO vtkArrowSource : public vtkPolyDataAlgorithm
{
public:
  static vtkArrowSource* New();

  vtkTypeMacro(vtkArrowSource, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;


  vtkSetClampMacro(TipLength, double, 0.0, 1.0);
  vtkGetMacro(TipLength, double);
  vtkSetClampMacro(TipRadius, double, 0.0, 10.0);
  vtkGetMacro(TipRadius, double);


  vtkSetClampMacro(TipResolution, int, 1, 128);
  vtkGetMacro(TipResolution, int);


  vtkSetClampMacro(ShaftRadius, double, 0.0, 5.0);
  vtkGetMacro(ShaftRadius, double);


  vtkSetClampMacro(ShaftResolution, int, 3, 128);
  vtkGetMacro(ShaftResolution, int);


  vtkBooleanMacro(Invert, bool);
  vtkSetMacro(Invert, bool);
  vtkGetMacro(Invert, bool);

  enum class ArrowOrigins
  {
    Default = 0,
    Center = 1
  };


  vtkSetEnumMacro(ArrowOrigin, ArrowOrigins);
  vtkGetEnumMacro(ArrowOrigin, ArrowOrigins);

  void SetArrowOriginToDefault() { this->SetArrowOrigin(ArrowOrigins::Default); }
  void SetArrowOriginToCenter() { this->SetArrowOrigin(ArrowOrigins::Center); }
  std::string GetArrowOriginAsString() const;

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

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

  int TipResolution;
  double TipLength;
  double TipRadius;

  int ShaftResolution;
  double ShaftRadius;
  bool Invert;
  ArrowOrigins ArrowOrigin;

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

VTK_ABI_NAMESPACE_END
#endif