vtkGlyphSource2D.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 vtkGlyphSource2D_h
#define vtkGlyphSource2D_h

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

#define VTK_NO_GLYPH 0
#define VTK_VERTEX_GLYPH 1
#define VTK_DASH_GLYPH 2
#define VTK_CROSS_GLYPH 3
#define VTK_THICKCROSS_GLYPH 4
#define VTK_TRIANGLE_GLYPH 5
#define VTK_SQUARE_GLYPH 6
#define VTK_CIRCLE_GLYPH 7
#define VTK_DIAMOND_GLYPH 8
#define VTK_ARROW_GLYPH 9
#define VTK_THICKARROW_GLYPH 10
#define VTK_HOOKEDARROW_GLYPH 11
#define VTK_EDGEARROW_GLYPH 12

#define VTK_MAX_CIRCLE_RESOLUTION 1024

VTK_ABI_NAMESPACE_BEGIN
class vtkPoints;
class vtkUnsignedCharArray;
class vtkCellArray;

class VTKFILTERSSOURCES_EXPORT VTK_MARSHALAUTO vtkGlyphSource2D : public vtkPolyDataAlgorithm
{
public:
  vtkTypeMacro(vtkGlyphSource2D, vtkPolyDataAlgorithm);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkGlyphSource2D* New();


  vtkSetVector3Macro(Center, double);
  vtkGetVectorMacro(Center, double, 3);


  vtkSetClampMacro(Scale, double, 0.0, VTK_DOUBLE_MAX);
  vtkGetMacro(Scale, double);


  vtkSetClampMacro(Scale2, double, 0.0, VTK_DOUBLE_MAX);
  vtkGetMacro(Scale2, double);


  vtkSetVector3Macro(Color, double);
  vtkGetVectorMacro(Color, double, 3);


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


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


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


  vtkSetMacro(RotationAngle, double);
  vtkGetMacro(RotationAngle, double);


  vtkSetClampMacro(Resolution, int, 3, VTK_MAX_CIRCLE_RESOLUTION);
  vtkGetMacro(Resolution, int);


  vtkSetClampMacro(GlyphType, int, VTK_NO_GLYPH, VTK_EDGEARROW_GLYPH);
  vtkGetMacro(GlyphType, int);
  void SetGlyphTypeToNone() { this->SetGlyphType(VTK_NO_GLYPH); }
  void SetGlyphTypeToVertex() { this->SetGlyphType(VTK_VERTEX_GLYPH); }
  void SetGlyphTypeToDash() { this->SetGlyphType(VTK_DASH_GLYPH); }
  void SetGlyphTypeToCross() { this->SetGlyphType(VTK_CROSS_GLYPH); }
  void SetGlyphTypeToThickCross() { this->SetGlyphType(VTK_THICKCROSS_GLYPH); }
  void SetGlyphTypeToTriangle() { this->SetGlyphType(VTK_TRIANGLE_GLYPH); }
  void SetGlyphTypeToSquare() { this->SetGlyphType(VTK_SQUARE_GLYPH); }
  void SetGlyphTypeToCircle() { this->SetGlyphType(VTK_CIRCLE_GLYPH); }
  void SetGlyphTypeToDiamond() { this->SetGlyphType(VTK_DIAMOND_GLYPH); }
  void SetGlyphTypeToArrow() { this->SetGlyphType(VTK_ARROW_GLYPH); }
  void SetGlyphTypeToThickArrow() { this->SetGlyphType(VTK_THICKARROW_GLYPH); }
  void SetGlyphTypeToHookedArrow() { this->SetGlyphType(VTK_HOOKEDARROW_GLYPH); }
  void SetGlyphTypeToEdgeArrow() { this->SetGlyphType(VTK_EDGEARROW_GLYPH); }


  vtkSetMacro(OutputPointsPrecision, int);
  vtkGetMacro(OutputPointsPrecision, int);


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


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


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

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

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

  double Center[3] = { 0.0, 0.0, 0.0 };
  double Scale = 1.0;
  double Scale2 = 1.5;
  double Color[3] = { 1.0, 1.0, 1.0 };
  vtkTypeBool Filled = true;
  vtkTypeBool Dash = false;
  vtkTypeBool Cross = false;
  int GlyphType = VTK_VERTEX_GLYPH;
  double RotationAngle = 0.0;
  int Resolution = 8;
  int OutputPointsPrecision = SINGLE_PRECISION;
  double TipLength = 0.3;
  bool DoublePointed = false;
  bool PointInwards = false;

  void TransformGlyph(vtkPoints* pts);
  void ConvertColor();
  unsigned char RGB[3];

  void CreateVertex(vtkPoints* pts, vtkCellArray* verts, vtkUnsignedCharArray* colors);
  void CreateDash(vtkPoints* pts, vtkCellArray* lines, vtkCellArray* polys,
    vtkUnsignedCharArray* colors, double scale);
  void CreateCross(vtkPoints* pts, vtkCellArray* lines, vtkCellArray* polys,
    vtkUnsignedCharArray* colors, double scale);
  void CreateThickCross(
    vtkPoints* pts, vtkCellArray* lines, vtkCellArray* polys, vtkUnsignedCharArray* colors);
  void CreateTriangle(
    vtkPoints* pts, vtkCellArray* lines, vtkCellArray* polys, vtkUnsignedCharArray* colors);
  void CreateSquare(
    vtkPoints* pts, vtkCellArray* lines, vtkCellArray* polys, vtkUnsignedCharArray* colors);
  void CreateCircle(
    vtkPoints* pts, vtkCellArray* lines, vtkCellArray* polys, vtkUnsignedCharArray* colors);
  void CreateDiamond(
    vtkPoints* pts, vtkCellArray* lines, vtkCellArray* polys, vtkUnsignedCharArray* colors);
  void CreateArrow(
    vtkPoints* pts, vtkCellArray* lines, vtkCellArray* polys, vtkUnsignedCharArray* colors);
  void CreateThickArrow(
    vtkPoints* pts, vtkCellArray* lines, vtkCellArray* polys, vtkUnsignedCharArray* colors);
  void CreateHookedArrow(
    vtkPoints* pts, vtkCellArray* lines, vtkCellArray* polys, vtkUnsignedCharArray* colors);
  void CreateEdgeArrow(
    vtkPoints* pts, vtkCellArray* lines, vtkCellArray* polys, vtkUnsignedCharArray* colors);

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

VTK_ABI_NAMESPACE_END
#endif