VTK
vtkProperty2D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkProperty2D.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
29 #ifndef vtkProperty2D_h
30 #define vtkProperty2D_h
31 
32 #include "vtkRenderingCoreModule.h" // For export macro
33 #include "vtkObject.h"
34 
35 class vtkViewport;
36 
37 #define VTK_BACKGROUND_LOCATION 0
38 #define VTK_FOREGROUND_LOCATION 1
39 
40 class VTKRENDERINGCORE_EXPORT vtkProperty2D : public vtkObject
41 {
42 public:
43  vtkTypeMacro(vtkProperty2D,vtkObject);
44  void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
45 
50  static vtkProperty2D *New();
51 
55  void DeepCopy(vtkProperty2D *p);
56 
58 
61  vtkSetVector3Macro(Color, double);
62  vtkGetVector3Macro(Color, double);
64 
66 
69  vtkGetMacro(Opacity, double);
70  vtkSetMacro(Opacity, double);
72 
74 
78  vtkSetClampMacro(PointSize,float,0,VTK_FLOAT_MAX);
79  vtkGetMacro(PointSize,float);
81 
83 
87  vtkSetClampMacro(LineWidth,float,0,VTK_FLOAT_MAX);
88  vtkGetMacro(LineWidth,float);
90 
92 
97  vtkSetMacro(LineStipplePattern,int);
98  vtkGetMacro(LineStipplePattern,int);
100 
102 
107  vtkSetClampMacro(LineStippleRepeatFactor,int,1,VTK_INT_MAX);
108  vtkGetMacro(LineStippleRepeatFactor,int);
110 
112 
121  vtkSetClampMacro( DisplayLocation, int,
123  vtkGetMacro( DisplayLocation, int );
125  {this->DisplayLocation = VTK_BACKGROUND_LOCATION;};
127  {this->DisplayLocation = VTK_FOREGROUND_LOCATION;};
129 
133  virtual void Render (vtkViewport* vtkNotUsed(viewport)) {}
134 
135 protected:
136  vtkProperty2D();
137  ~vtkProperty2D() VTK_OVERRIDE;
138 
139  double Color[3];
140  double Opacity;
141  float PointSize;
142  float LineWidth;
146 
147 private:
148  vtkProperty2D(const vtkProperty2D&) VTK_DELETE_FUNCTION;
149  void operator=(const vtkProperty2D&) VTK_DELETE_FUNCTION;
150 };
151 
152 #endif
abstract base class for most VTK objects
Definition: vtkObject.h:59
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
#define VTK_FOREGROUND_LOCATION
Definition: vtkProperty2D.h:38
virtual void Render(vtkViewport *vtkNotUsed(viewport))
Have the device specific subclass render this property.
abstract specification for Viewports
Definition: vtkViewport.h:47
#define VTK_INT_MAX
Definition: vtkType.h:157
#define VTK_FLOAT_MAX
Definition: vtkType.h:165
int LineStippleRepeatFactor
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkSetMacro(IgnoreDriverBugs, bool)
When set known driver bugs are ignored during driver feature detection.
void SetDisplayLocationToForeground()
The DisplayLocation is either background or foreground.
represent surface properties of a 2D image
Definition: vtkProperty2D.h:40
static vtkObject * New()
Create an object with Debug turned off, modified time initialized to zero, and reference counting on...
#define VTK_BACKGROUND_LOCATION
Definition: vtkProperty2D.h:37
void SetDisplayLocationToBackground()
The DisplayLocation is either background or foreground.