Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members | Related Pages

Common/vtkProperty2D.h

Go to the documentation of this file.
00001 /*=========================================================================
00002 
00003   Program:   Visualization Toolkit
00004   Module:    $RCSfile: vtkProperty2D.h,v $
00005   Language:  C++
00006 
00007   Copyright (c) 1993-2002 Ken Martin, Will Schroeder, Bill Lorensen 
00008   All rights reserved.
00009   See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
00010 
00011      This software is distributed WITHOUT ANY WARRANTY; without even 
00012      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
00013      PURPOSE.  See the above copyright notice for more information.
00014 
00015 =========================================================================*/
00028 #ifndef __vtkProperty2D_h
00029 #define __vtkProperty2D_h
00030 
00031 #include "vtkObject.h"
00032 
00033 class vtkViewport;
00034 
00035 #define VTK_BACKGROUND_LOCATION 0
00036 #define VTK_FOREGROUND_LOCATION 1
00037 
00038 class VTK_COMMON_EXPORT vtkProperty2D : public vtkObject
00039 {
00040 public:
00041   vtkTypeRevisionMacro(vtkProperty2D,vtkObject);
00042   void PrintSelf(ostream& os, vtkIndent indent);
00043 
00046   static vtkProperty2D *New();
00047 
00049   void DeepCopy(vtkProperty2D *p);
00050 
00052 
00053   vtkSetVector3Macro(Color, float);
00054   vtkGetVectorMacro(Color, float, 3);
00056 
00058 
00059   vtkGetMacro(Opacity, float);
00060   vtkSetMacro(Opacity, float);
00062 
00064 
00066   vtkSetClampMacro(PointSize,float,0,VTK_LARGE_FLOAT);
00067   vtkGetMacro(PointSize,float);
00069 
00071 
00073   vtkSetClampMacro(LineWidth,float,0,VTK_LARGE_FLOAT);
00074   vtkGetMacro(LineWidth,float);
00076 
00078 
00081   vtkSetMacro(LineStipplePattern,int);
00082   vtkGetMacro(LineStipplePattern,int);
00084 
00086 
00089   vtkSetClampMacro(LineStippleRepeatFactor,int,1,VTK_LARGE_INTEGER);
00090   vtkGetMacro(LineStippleRepeatFactor,int);
00092 
00094 
00100   vtkSetClampMacro( DisplayLocation, int, 
00101                     VTK_BACKGROUND_LOCATION, VTK_FOREGROUND_LOCATION );
00102   vtkGetMacro( DisplayLocation, int );
00103   void SetDisplayLocationToBackground() 
00104     {this->DisplayLocation = VTK_BACKGROUND_LOCATION;};
00105   void SetDisplayLocationToForeground() 
00106     {this->DisplayLocation = VTK_FOREGROUND_LOCATION;};
00108   
00109   
00111   virtual void Render (vtkViewport* vtkNotUsed(viewport))  {}
00112   
00113 protected:
00114   vtkProperty2D();
00115   ~vtkProperty2D();
00116 
00117   float Color[3];
00118   float Opacity;
00119   float PointSize;
00120   float LineWidth;
00121   int   LineStipplePattern;
00122   int   LineStippleRepeatFactor;
00123   int   DisplayLocation;
00124 private:
00125   vtkProperty2D(const vtkProperty2D&);  // Not implemented.
00126   void operator=(const vtkProperty2D&);  // Not implemented.
00127 };
00128   
00129   
00130 #endif
00131 
00132 
00133