vtkProperty2D.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 vtkProperty2D_h
#define vtkProperty2D_h
 
#include "vtkObject.h"
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkWrappingHints.h"       // For VTK_MARSHALAUTO
 
VTK_ABI_NAMESPACE_BEGIN
class vtkViewport;
 
#define VTK_BACKGROUND_LOCATION 0
#define VTK_FOREGROUND_LOCATION 1
 
class VTKRENDERINGCORE_EXPORT VTK_MARSHALAUTO vtkProperty2D : public vtkObject
{
public:
  vtkTypeMacro(vtkProperty2D, vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent) override;

  static vtkProperty2D* New();

  void DeepCopy(vtkProperty2D* p);


  vtkSetVector3Macro(Color, double);
  vtkGetVector3Macro(Color, double);


  vtkGetMacro(Opacity, double);
  vtkSetMacro(Opacity, double);


  vtkSetClampMacro(PointSize, float, 0, VTK_FLOAT_MAX);
  vtkGetMacro(PointSize, float);


  vtkSetClampMacro(LineWidth, float, 0, VTK_FLOAT_MAX);
  vtkGetMacro(LineWidth, float);


  vtkSetMacro(LineStipplePattern, int);
  vtkGetMacro(LineStipplePattern, int);


  vtkSetClampMacro(LineStippleRepeatFactor, int, 1, VTK_INT_MAX);
  vtkGetMacro(LineStippleRepeatFactor, int);


  vtkSetClampMacro(DisplayLocation, int, VTK_BACKGROUND_LOCATION, VTK_FOREGROUND_LOCATION);
  vtkGetMacro(DisplayLocation, int);
  void SetDisplayLocationToBackground() { this->DisplayLocation = VTK_BACKGROUND_LOCATION; }
  void SetDisplayLocationToForeground() { this->DisplayLocation = VTK_FOREGROUND_LOCATION; }

  virtual void Render(vtkViewport* vtkNotUsed(viewport)) {}
 
protected:
  vtkProperty2D();
  ~vtkProperty2D() override;
 
  double Color[3];
  double Opacity;
  float PointSize;
  float LineWidth;
  int LineStipplePattern;
  int LineStippleRepeatFactor;
  int DisplayLocation;
 
private:
  vtkProperty2D(const vtkProperty2D&) = delete;
  void operator=(const vtkProperty2D&) = delete;
};
 
VTK_ABI_NAMESPACE_END
#endif