vtkProperty2D.h

Go to the documentation of this file.

/*=========================================================================
 
  Program:   Visualization Toolkit
  Module:    vtkProperty2D.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 vtkProperty2D_h
#define vtkProperty2D_h
 
#include "vtkRenderingCoreModule.h" // For export macro
#include "vtkObject.h"
 
class vtkViewport;
 
#define VTK_BACKGROUND_LOCATION 0
#define VTK_FOREGROUND_LOCATION 1
 
class VTKRENDERINGCORE_EXPORT vtkProperty2D : public vtkObject
{
public:
  vtkTypeMacro(vtkProperty2D,vtkObject);
  void PrintSelf(ostream& os, vtkIndent indent);
 
  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;};
 
//BTX
 
  virtual void Render (vtkViewport* vtkNotUsed(viewport))  {}
//ETX
 
protected:
  vtkProperty2D();
  ~vtkProperty2D();
 
  double Color[3];
  double Opacity;
  float PointSize;
  float LineWidth;
  int   LineStipplePattern;
  int   LineStippleRepeatFactor;
  int   DisplayLocation;
 
private:
  vtkProperty2D(const vtkProperty2D&);  // Not implemented.
  void operator=(const vtkProperty2D&);  // Not implemented.
};
 
#endif