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 =========================================================================*/
28 #ifndef __vtkProperty2D_h
29 #define __vtkProperty2D_h
30 
31 #include "vtkObject.h"
32 
33 class vtkViewport;
34 
35 #define VTK_BACKGROUND_LOCATION 0
36 #define VTK_FOREGROUND_LOCATION 1
37 
39 {
40 public:
41  vtkTypeMacro(vtkProperty2D,vtkObject);
42  void PrintSelf(ostream& os, vtkIndent indent);
43 
46  static vtkProperty2D *New();
47 
49  void DeepCopy(vtkProperty2D *p);
50 
52 
53  vtkSetVector3Macro(Color, double);
54  vtkGetVector3Macro(Color, double);
56 
58 
59  vtkGetMacro(Opacity, double);
60  vtkSetMacro(Opacity, double);
62 
64 
66  vtkSetClampMacro(PointSize,float,0,VTK_LARGE_FLOAT);
67  vtkGetMacro(PointSize,float);
69 
71 
73  vtkSetClampMacro(LineWidth,float,0,VTK_LARGE_FLOAT);
74  vtkGetMacro(LineWidth,float);
76 
78 
81  vtkSetMacro(LineStipplePattern,int);
82  vtkGetMacro(LineStipplePattern,int);
84 
86 
89  vtkSetClampMacro(LineStippleRepeatFactor,int,1,VTK_LARGE_INTEGER);
90  vtkGetMacro(LineStippleRepeatFactor,int);
92 
94 
100  vtkSetClampMacro( DisplayLocation, int,
102  vtkGetMacro( DisplayLocation, int );
104  {this->DisplayLocation = VTK_BACKGROUND_LOCATION;};
106  {this->DisplayLocation = VTK_FOREGROUND_LOCATION;};
108 
109 //BTX
111 
112  virtual void Render (vtkViewport* vtkNotUsed(viewport)) {}
113 //ETX
115 
116 protected:
117  vtkProperty2D();
118  ~vtkProperty2D();
119 
120  double Color[3];
121  double Opacity;
122  float PointSize;
123  float LineWidth;
127 
128 private:
129  vtkProperty2D(const vtkProperty2D&); // Not implemented.
130  void operator=(const vtkProperty2D&); // Not implemented.
131 };
132 
133 #endif
abstract base class for most VTK objects
Definition: vtkObject.h:60
#define VTK_FOREGROUND_LOCATION
Definition: vtkProperty2D.h:36
virtual void Render(vtkViewport *vtkNotUsed(viewport))
abstract specification for Viewports
Definition: vtkViewport.h:45
virtual void PrintSelf(ostream &os, vtkIndent indent)
int LineStippleRepeatFactor
a simple class to control print indentation
Definition: vtkIndent.h:37
#define VTK_COMMON_EXPORT
#define VTK_LARGE_FLOAT
Definition: vtkType.h:149
void SetDisplayLocationToForeground()
represent surface properties of a 2D image
Definition: vtkProperty2D.h:38
#define VTK_LARGE_INTEGER
Definition: vtkType.h:148
static vtkObject * New()
#define VTK_BACKGROUND_LOCATION
Definition: vtkProperty2D.h:35
void SetDisplayLocationToBackground()