VTKViewer_FramedTextActor.h

Go to the documentation of this file.

// Copyright (C) 2007-2025  CEA, EDF, OPEN CASCADE
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef VTKVIEWER_FRAMEDTEXTACTOR_H
#define VTKVIEWER_FRAMEDTEXTACTOR_H
 
#include "VTKViewer.h"
 
#include <vtkActor2D.h>
 
class vtkPolyData;
class vtkPolyDataMapper2D;
class vtkRenderer;
class vtkTimeStamp;
class vtkTextMapper;
class vtkTextProperty;
class vtkViewport;
class vtkWindow;
class vtkTextActor;
 
class VTKVIEWER_EXPORT VTKViewer_FramedTextActor : public vtkActor2D
{
public:
  enum ModePosition { BelowPoint = 0, TopLeft, TopRight, BottomLeft, BottomRight };
  enum LayoutType { Vertical = 0, Horizontal };
 
public:
  vtkTypeMacro(VTKViewer_FramedTextActor,vtkActor2D)
  static VTKViewer_FramedTextActor *New();
 
  virtual int                 RenderOpaqueGeometry(vtkViewport*);
  virtual int                 RenderTranslucentGeometry(vtkViewport*) { return 0; }
  virtual int                 RenderOverlay(vtkViewport*);
  virtual void                ReleaseGraphicsResources(vtkWindow*);
 
  virtual void                SetVisibility(int);
  virtual int                 GetVisibility();
  virtual void                SetPickable(int);
  virtual int                 GetPickable();
 
  virtual void                GetSize(vtkRenderer* vport, double theSize[2]) const;
 
  void                        SetText(const char* theText);
  char*                       GetText();
 
  void                        SetModePosition(const int theMode);
  int                         GetModePosition() const;
 
  void                        SetLayoutType(const int theType);
  int                         GetLayoutType() const;
 
  void                        SetWorldPoint(const double theWorldPoint[4]);
  const double* GetWorldPoint() const;
 
  void                        SetDistance(const double theDistance);
  double        GetDistance() const;
 
  void                        SetMoveFrameFlag(const int flag);
  int                         GetMoveFrameFlag() const;
 
  void                        SetForegroundColor(const double r,
                                                 const double g,
                                                 const double b);
  void                        GetForegroundColor(double& r,
                                                 double& g,
                                                 double& b);
 
  void                        SetBackgroundColor(const double r,
                                                 const double g,
                                                 const double b);
  void                        GetBackgroundColor(double& r,
                                                 double& g,
                                                 double& b);
 
  void                        SetTransparency(const double theTransparency);
  double        GetTransparency() const;
 
  void                        SetTextMargin(const int theMargin);
  int                         GetTextMargin() const;
 
  void                        SetOffset(const double theOffset[2]);
 
protected:
  VTKViewer_FramedTextActor();
  ~VTKViewer_FramedTextActor();
 
protected:
  vtkPolyData*                myBar;
  vtkPolyDataMapper2D*        myBarMapper;
  vtkActor2D*                 myBarActor;
 
  vtkTextProperty*            myTextProperty;
  vtkTextActor*               myTextActor;
 
  vtkTimeStamp                myBuildTime;
 
  int                         myModePosition;
  int                         myLayoutType;
  int                         myMoveFrameFlag;
 
  double        myWorldPoint[4];
  double        myDistance;
  double        myTransparency;
 
  int                         myTextMargin;
 
  int                         myHorizontalOffset;
  int                         myVerticalOffset;
 
private:
  VTKViewer_FramedTextActor(const VTKViewer_FramedTextActor&);  // Not implemented.
  void operator=(const VTKViewer_FramedTextActor&);  // Not implemented.
};
 
#endif