vtkPen.h

Go to the documentation of this file.

/*=========================================================================

  Program:   Visualization Toolkit
  Module:    vtkPen.h

  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
  All rights reserved.
  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.

     This software is distributed WITHOUT ANY WARRANTY; without even
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
     PURPOSE.  See the above copyright notice for more information.

=========================================================================*/

#ifndef vtkPen_h
#define vtkPen_h

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

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

  static vtkPen *New();

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

  void SetLineType(int type);

  int GetLineType();

  void SetColorF(double color[3]);

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

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

  void SetOpacityF(double a);

  void SetColor(unsigned char color[3]);

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


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

  void SetOpacity(unsigned char a);

  void GetColorF(double color[3]);

  void GetColor(unsigned char color[3]);

  vtkColor4ub GetColorObject();

  unsigned char GetOpacity();

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


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

  void DeepCopy(vtkPen *pen);

protected:
  vtkPen();
  ~vtkPen();


  unsigned char* Color;
  vtkColor4ub PenColor;

  float Width;

  int LineType;

private:
  vtkPen(const vtkPen &) VTK_DELETE_FUNCTION;
  void operator=(const vtkPen &) VTK_DELETE_FUNCTION;

};

#endif //vtkPen_h