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
45class vtkRenderer;
47class vtkConeSource;
49
50
51class VTKINTERACTIONWIDGETS_EXPORT vtkCaptionRepresentation : public vtkBorderRepresentation
52{
53public:
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
82 vtkGetObjectMacro(CaptionActor2D,vtkCaptionActor2D);
84
86
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
114
116
120 vtkSetClampMacro(FontFactor, double, 0.1, 10.0);
121 vtkGetMacro(FontFactor, double);
123
124protected:
127
128 // the text to manage
131
133 int DisplayAttachmentPoint[2];
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
142private:
143 vtkCaptionRepresentation(const vtkCaptionRepresentation&) VTK_DELETE_FUNCTION;
144 void operator=(const vtkCaptionRepresentation&) VTK_DELETE_FUNCTION;
145};
146
147#endif
represent a vtkBorderWidget
draw text label associated with a point
represents vtkCaptionWidget in the scene
virtual int HasTranslucentPolygonalGeometry()
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
static vtkCaptionRepresentation * New()
Instantiate this class.
void SetAnchorRepresentation(vtkPointHandleRepresentation3D *)
Set and get the instances of vtkPointHandleRepresention3D used to implement this representation.
virtual void AdjustCaptionBoundary()
virtual int RenderTranslucentPolygonalGeometry(vtkViewport *)
vtkPointHandleRepresentation3D * AnchorRepresentation
virtual void GetSize(double size[2])
virtual int RenderOverlay(vtkViewport *)
virtual int RenderOpaqueGeometry(vtkViewport *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
virtual void GetActors2D(vtkPropCollection *)
These methods are necessary to make this representation behave as a vtkProp.
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
virtual void BuildRepresentation()
Satisfy the superclasses API.
virtual void ReleaseGraphicsResources(vtkWindow *)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being...
void GetAnchorPosition(double pos[3])
void SetAnchorPosition(double pos[3])
Specify the position of the anchor (i.e., the point that the caption is anchored to).
void SetCaptionActor2D(vtkCaptionActor2D *captionActor)
Specify the vtkCaptionActor2D to manage.
generate polygonal cone
Definition: vtkConeSource.h:45
a simple class to control print indentation
Definition: vtkIndent.h:40
represent the position of a point in 3D space
a list of Props
abstract specification for renderers
Definition: vtkRenderer.h:64
abstract specification for Viewports
Definition: vtkViewport.h:48
window superclass for vtkRenderWindow
Definition: vtkWindow.h:35
@ size
Definition: vtkX3D.h:253