vtkCaptionRepresentation Class Reference

#include <vtkCaptionRepresentation.h>

Inheritance diagram for vtkCaptionRepresentation:

Inheritance graph
[legend]
Collaboration diagram for vtkCaptionRepresentation:

Collaboration graph
[legend]

List of all members.


Detailed Description

represents vtkCaptionWidget in the scene

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.

See also:
vtkCaptionWidget vtkBorderWidget vtkBorderRepresentation vtkCaptionActor

Definition at line 46 of file vtkCaptionRepresentation.h.

typedef vtkBorderRepresentation Superclass
static int IsTypeOf (const char *type)
static vtkCaptionRepresentationSafeDownCast (vtkObject *o)
virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)

Public Member Functions

void SetAnchorPosition (double pos[3])
void GetAnchorPosition (double pos[3])
void SetCaptionActor2D (vtkCaptionActor2D *captionActor)
virtual vtkCaptionActor2DGetCaptionActor2D ()
void SetAnchorRepresentation (vtkPointHandleRepresentation3D *)
virtual
vtkPointHandleRepresentation3D
GetAnchorRepresentation ()
virtual void BuildRepresentation ()
virtual void GetSize (double size[2])
virtual void GetActors2D (vtkPropCollection *)
virtual void ReleaseGraphicsResources (vtkWindow *)
virtual int RenderOverlay (vtkViewport *)
virtual int RenderOpaqueGeometry (vtkViewport *)
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *)
virtual int HasTranslucentPolygonalGeometry ()
virtual void SetFontFactor (double)
virtual double GetFontFactor ()

Static Public Member Functions

static vtkCaptionRepresentationNew ()

Protected Member Functions

 vtkCaptionRepresentation ()
 ~vtkCaptionRepresentation ()
virtual void AdjustCaptionBoundary ()

Protected Attributes

vtkCaptionActor2DCaptionActor2D
vtkConeSourceCaptionGlyph
int PointWidgetState
int DisplayAttachmentPoint [2]
double FontFactor
vtkPointHandleRepresentation3DAnchorRepresentation

Member Typedef Documentation

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

Definition at line 54 of file vtkCaptionRepresentation.h.


Constructor & Destructor Documentation

vtkCaptionRepresentation::vtkCaptionRepresentation (  )  [protected]

vtkCaptionRepresentation::~vtkCaptionRepresentation (  )  [protected]


Member Function Documentation

static vtkCaptionRepresentation* vtkCaptionRepresentation::New (  )  [static]

Instantiate this class.

Reimplemented from vtkBorderRepresentation.

virtual const char* vtkCaptionRepresentation::GetClassName (  )  [virtual]

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

static int vtkCaptionRepresentation::IsTypeOf ( const char *  type  )  [static]

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

virtual int vtkCaptionRepresentation::IsA ( const char *  type  )  [virtual]

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

static vtkCaptionRepresentation* vtkCaptionRepresentation::SafeDownCast ( vtkObject o  )  [static]

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

void vtkCaptionRepresentation::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

void vtkCaptionRepresentation::SetAnchorPosition ( double  pos[3]  ) 

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 vtkCaptionRepresentation::GetAnchorPosition ( double  pos[3]  ) 

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 vtkCaptionRepresentation::SetCaptionActor2D ( vtkCaptionActor2D captionActor  ) 

Specify the vtkCaptionActor2D to manage. If not specified, then one is automatically created.

virtual vtkCaptionActor2D* vtkCaptionRepresentation::GetCaptionActor2D (  )  [virtual]

Specify the vtkCaptionActor2D to manage. If not specified, then one is automatically created.

void vtkCaptionRepresentation::SetAnchorRepresentation ( vtkPointHandleRepresentation3D  ) 

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.

virtual vtkPointHandleRepresentation3D* vtkCaptionRepresentation::GetAnchorRepresentation (  )  [virtual]

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.

virtual void vtkCaptionRepresentation::BuildRepresentation (  )  [virtual]

Satisfy the superclasses API.

Reimplemented from vtkBorderRepresentation.

virtual void vtkCaptionRepresentation::GetSize ( double  size[2]  )  [inline, virtual]

Satisfy the superclasses API.

Reimplemented from vtkBorderRepresentation.

Definition at line 84 of file vtkCaptionRepresentation.h.

virtual void vtkCaptionRepresentation::GetActors2D ( vtkPropCollection  )  [virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual void vtkCaptionRepresentation::ReleaseGraphicsResources ( vtkWindow  )  [virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual int vtkCaptionRepresentation::RenderOverlay ( vtkViewport  )  [virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual int vtkCaptionRepresentation::RenderOpaqueGeometry ( vtkViewport  )  [virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual int vtkCaptionRepresentation::RenderTranslucentPolygonalGeometry ( vtkViewport  )  [virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual int vtkCaptionRepresentation::HasTranslucentPolygonalGeometry (  )  [virtual]

These methods are necessary to make this representation behave as a vtkProp.

Reimplemented from vtkBorderRepresentation.

virtual void vtkCaptionRepresentation::SetFontFactor ( double   )  [virtual]

Set/Get the factor that controls the overall size of the fonts of the caption when the text actor's ScaledText is OFF

virtual double vtkCaptionRepresentation::GetFontFactor (  )  [virtual]

Set/Get the factor that controls the overall size of the fonts of the caption when the text actor's ScaledText is OFF

virtual void vtkCaptionRepresentation::AdjustCaptionBoundary (  )  [protected, virtual]


Member Data Documentation

Definition at line 111 of file vtkCaptionRepresentation.h.

Definition at line 112 of file vtkCaptionRepresentation.h.

Definition at line 114 of file vtkCaptionRepresentation.h.

Definition at line 115 of file vtkCaptionRepresentation.h.

Definition at line 116 of file vtkCaptionRepresentation.h.

Definition at line 119 of file vtkCaptionRepresentation.h.


The documentation for this class was generated from the following file:

Generated on Sat Dec 27 13:19:01 2008 for VTK by  doxygen 1.5.6