VTK
vtkCaptionRepresentation.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkCaptionRepresentation.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 =========================================================================*/
39 #ifndef vtkCaptionRepresentation_h
40 #define vtkCaptionRepresentation_h
41 
42 #include "vtkInteractionWidgetsModule.h" // For export macro
44 
45 class vtkRenderer;
46 class vtkCaptionActor2D;
47 class vtkConeSource;
49 
50 
51 class VTKINTERACTIONWIDGETS_EXPORT vtkCaptionRepresentation : public vtkBorderRepresentation
52 {
53 public:
57  static vtkCaptionRepresentation *New();
58 
60 
64  void PrintSelf(ostream& os, vtkIndent indent);
66 
68 
72  void SetAnchorPosition(double pos[3]);
73  void GetAnchorPosition(double pos[3]);
75 
77 
81  void SetCaptionActor2D(vtkCaptionActor2D *captionActor);
82  vtkGetObjectMacro(CaptionActor2D,vtkCaptionActor2D);
84 
86 
91  void SetAnchorRepresentation(vtkPointHandleRepresentation3D*);
92  vtkGetObjectMacro(AnchorRepresentation,vtkPointHandleRepresentation3D);
94 
98  virtual void BuildRepresentation();
99  virtual void GetSize(double size[2])
100  {size[0]=2.0; size[1]=2.0;}
101 
103 
107  virtual void GetActors2D(vtkPropCollection*);
108  virtual void ReleaseGraphicsResources(vtkWindow*);
109  virtual int RenderOverlay(vtkViewport*);
110  virtual int RenderOpaqueGeometry(vtkViewport*);
112  virtual int HasTranslucentPolygonalGeometry();
114 
116 
120  vtkSetClampMacro(FontFactor, double, 0.1, 10.0);
121  vtkGetMacro(FontFactor, double);
123 
124 protected:
127 
128  // the text to manage
131 
133  int DisplayAttachmentPoint[2];
134  double FontFactor;
135 
136  // Internal representation for the anchor
138 
139  // Check and adjust boundaries according to the size of the caption text
140  virtual void AdjustCaptionBoundary();
141 
142 private:
143  vtkCaptionRepresentation(const vtkCaptionRepresentation&) VTK_DELETE_FUNCTION;
144  void operator=(const vtkCaptionRepresentation&) VTK_DELETE_FUNCTION;
145 };
146 
147 #endif
vtkBorderRepresentation::HasTranslucentPolygonalGeometry
virtual int HasTranslucentPolygonalGeometry()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
vtkCaptionRepresentation::CaptionActor2D
vtkCaptionActor2D * CaptionActor2D
Definition: vtkCaptionRepresentation.h:129
vtkCaptionRepresentation::FontFactor
double FontFactor
Definition: vtkCaptionRepresentation.h:134
vtkBorderRepresentation
represent a vtkBorderWidget
Definition: vtkBorderRepresentation.h:58
vtkBorderRepresentation::GetActors2D
virtual void GetActors2D(vtkPropCollection *)
These methods are necessary to make this representation behave as a vtkProp.
vtkCaptionRepresentation::PointWidgetState
int PointWidgetState
Definition: vtkCaptionRepresentation.h:132
vtkPointHandleRepresentation3D
represent the position of a point in 3D space
Definition: vtkPointHandleRepresentation3D.h:43
vtkBorderRepresentation::New
static vtkBorderRepresentation * New()
Instantiate this class.
vtkCaptionRepresentation
represents vtkCaptionWidget in the scene
Definition: vtkCaptionRepresentation.h:51
vtkBorderRepresentation::RenderTranslucentPolygonalGeometry
virtual int RenderTranslucentPolygonalGeometry(vtkViewport *)
vtkConeSource
generate polygonal cone
Definition: vtkConeSource.h:44
vtkBorderRepresentation::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
vtkCaptionRepresentation::GetSize
virtual void GetSize(double size[2])
Definition: vtkCaptionRepresentation.h:99
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:34
vtkBorderRepresentation::RenderOpaqueGeometry
virtual int RenderOpaqueGeometry(vtkViewport *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
vtkCaptionRepresentation::AnchorRepresentation
vtkPointHandleRepresentation3D * AnchorRepresentation
Definition: vtkCaptionRepresentation.h:137
vtkBorderRepresentation.h
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkBorderRepresentation::BuildRepresentation
virtual void BuildRepresentation()
Subclasses should implement these methods.
vtkCaptionRepresentation::CaptionGlyph
vtkConeSource * CaptionGlyph
Definition: vtkCaptionRepresentation.h:130
vtkX3D::size
@ size
Definition: vtkX3D.h:253
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:47
vtkBorderRepresentation::RenderOverlay
virtual int RenderOverlay(vtkViewport *)
vtkCaptionActor2D
draw text label associated with a point
Definition: vtkCaptionActor2D.h:77
vtkBorderRepresentation::ReleaseGraphicsResources
virtual void ReleaseGraphicsResources(vtkWindow *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
vtkRenderer
abstract specification for renderers
Definition: vtkRenderer.h:63
vtkPropCollection
a list of Props
Definition: vtkPropCollection.h:38