Skip to content
Find file
Fetching contributors…
Cannot retrieve contributors at this time
122 lines (96 sloc) 4.33 KB
Program: Visualization Toolkit
Module: vtkCaptionRepresentation.h
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
All rights reserved.
See Copyright.txt or for details.
This software is distributed WITHOUT ANY WARRANTY; without even
PURPOSE. See the above copyright notice for more information.
// .NAME vtkCaptionRepresentation - represents vtkCaptionWidget in the scene
// .SECTION Description
// This class represents vtkCaptionWidget. A caption is defined by some text
// with a leader (e.g., arrow) that points from the text to a point in the
// scene. The caption is defined by an instance of vtkCaptionActor2D. It uses
// the event bindings of its superclass (vtkBorderWidget) to control the
// placement of the text, and adds the ability to move the attachment point
// around. In addition, when the caption text is selected, the widget emits a
// ActivateEvent that observers can watch for. This is useful for opening GUI
// dialogoues to adjust font characteristics, etc. (Please see the superclass
// for a description of event bindings.)
// Note that this widget extends the behavior of its superclass
// vtkBorderRepresentation.
// .SECTION See Also
// vtkCaptionWidget vtkBorderWidget vtkBorderRepresentation vtkCaptionActor
#ifndef __vtkCaptionRepresentation_h
#define __vtkCaptionRepresentation_h
#include "vtkBorderRepresentation.h"
class vtkRenderer;
class vtkCaptionActor2D;
class vtkConeSource;
class vtkPointHandleRepresentation3D;
class VTK_WIDGETS_EXPORT vtkCaptionRepresentation : public vtkBorderRepresentation
// Description:
// Instantiate this class.
static vtkCaptionRepresentation *New();
// Description:
// Standard VTK class methods.
void PrintSelf(ostream& os, vtkIndent indent);
// Description:
// Specify the position of the anchor (i.e., the point that the caption is anchored to).
// Note that the position should be specified in world coordinates.
void SetAnchorPosition(double pos[3]);
void GetAnchorPosition(double pos[3]);
// Description:
// Specify the vtkCaptionActor2D to manage. If not specified, then one
// is automatically created.
void SetCaptionActor2D(vtkCaptionActor2D *captionActor);
// Description:
// Set and get the instances of vtkPointHandleRepresention3D used to implement this
// representation. Normally default representations are created, but you can
// specify the ones you want to use.
void SetAnchorRepresentation(vtkPointHandleRepresentation3D*);
// Description:
// Satisfy the superclasses API.
virtual void BuildRepresentation();
virtual void GetSize(double size[2])
{size[0]=2.0; size[1]=2.0;}
// Description:
// These methods are necessary to make this representation behave as
// a vtkProp.
virtual void GetActors2D(vtkPropCollection*);
virtual void ReleaseGraphicsResources(vtkWindow*);
virtual int RenderOverlay(vtkViewport*);
virtual int RenderOpaqueGeometry(vtkViewport*);
virtual int RenderTranslucentPolygonalGeometry(vtkViewport*);
virtual int HasTranslucentPolygonalGeometry();
// Description:
// Set/Get the factor that controls the overall size of the fonts
// of the caption when the text actor's ScaledText is OFF
vtkSetClampMacro(FontFactor, double, 0.1, 10.0);
vtkGetMacro(FontFactor, double);
// the text to manage
vtkCaptionActor2D *CaptionActor2D;
vtkConeSource *CaptionGlyph;
int PointWidgetState;
int DisplayAttachmentPoint[2];
double FontFactor;
// Internal representation for the anchor
vtkPointHandleRepresentation3D *AnchorRepresentation;
// Check and adjust boundaries according to the size of the caption text
virtual void AdjustCaptionBoundary();
vtkCaptionRepresentation(const vtkCaptionRepresentation&); //Not implemented
void operator=(const vtkCaptionRepresentation&); //Not implemented
Something went wrong with that request. Please try again.