vtkPen.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 vtkPen_h
#define vtkPen_h

#include "vtkColor.h" // Needed for vtkColor4ub
#include "vtkObject.h"
#include "vtkRenderingContext2DModule.h" // For export macro
#include "vtkWrappingHints.h"            // For VTK_MARSHALAUTO

VTK_ABI_NAMESPACE_BEGIN
class VTKRENDERINGCONTEXT2D_EXPORT VTK_MARSHALAUTO vtkPen : public vtkObject
{
public:
  vtkTypeMacro(vtkPen, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkPen* New();

  enum
  {
    NO_PEN,
    SOLID_LINE,
    DASH_LINE,
    DOT_LINE,
    DASH_DOT_LINE,
    DASH_DOT_DOT_LINE,
    DENSE_DOT_LINE
  };

  void SetLineType(int type);

  int GetLineType();

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetColorF(double color[3]);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetColorF(double r, double g, double b);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetColorF(double r, double g, double b, double a);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetOpacityF(double a);

  void SetColor(unsigned char color[3]);

  void SetColor(unsigned char r, unsigned char g, unsigned char b);


  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void SetColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a);
  void SetColor(const vtkColor4ub& color);

  void SetOpacity(unsigned char a);

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  void GetColorF(double color[3]);

  void GetColor(unsigned char color[3]);

  vtkColor4ub GetColorObject();

  unsigned char GetOpacity();

  VTK_MARSHALEXCLUDE(VTK_MARSHAL_EXCLUDE_REASON_IS_REDUNDANT)
  unsigned char* GetColor() { return this->Color; }


  vtkSetMacro(Width, float);
  vtkGetMacro(Width, float);

  void DeepCopy(vtkPen* pen);

protected:
  vtkPen();
  ~vtkPen() override;


  unsigned char* Color;
  vtkColor4ub PenColor;

  float Width;

  int LineType;

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

VTK_ABI_NAMESPACE_END
#endif // vtkPen_h