VTK
Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkCaptionRepresentation Class Reference

represents vtkCaptionWidget in the scene More...

#include <vtkCaptionRepresentation.h>

Inheritance diagram for vtkCaptionRepresentation:
[legend]
Collaboration diagram for vtkCaptionRepresentation:
[legend]

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 ()
- Public Member Functions inherited from vtkBorderRepresentation
virtual vtkCoordinateGetPositionCoordinate ()
virtual void SetPosition (float x[2])
virtual void SetPosition (float x, float y)
virtual float * GetPosition ()
virtual vtkCoordinateGetPosition2Coordinate ()
virtual void SetPosition2 (float x[2])
virtual void SetPosition2 (float x, float y)
virtual float * GetPosition2 ()
virtual void SetShowBorder (int)
virtual int GetShowBorder ()
void SetShowBorderToOff ()
void SetShowBorderToOn ()
void SetShowBorderToActive ()
virtual vtkProperty2DGetBorderProperty ()
virtual void SetProportionalResize (int)
virtual int GetProportionalResize ()
virtual void ProportionalResizeOn ()
virtual void ProportionalResizeOff ()
virtual void SetMinimumSize (int, int)
void SetMinimumSize (int[2])
virtual int * GetMinimumSize ()
virtual void GetMinimumSize (int &, int &)
virtual void GetMinimumSize (int[2])
virtual void SetMaximumSize (int, int)
void SetMaximumSize (int[2])
virtual int * GetMaximumSize ()
virtual void GetMaximumSize (int &, int &)
virtual void GetMaximumSize (int[2])
virtual void SetTolerance (int)
virtual int GetTolerance ()
virtual double * GetSelectionPoint ()
virtual void GetSelectionPoint (double data[2])
virtual void SetMoving (int)
virtual int GetMoving ()
virtual void MovingOn ()
virtual void MovingOff ()
virtual void StartWidgetInteraction (double eventPos[2])
virtual void WidgetInteraction (double eventPos[2])
virtual int ComputeInteractionState (int X, int Y, int modify=0)
- Public Member Functions inherited from vtkWidgetRepresentation
virtual void SetRenderer (vtkRenderer *ren)
virtual vtkRendererGetRenderer ()
virtual void PlaceWidget (double *vtkNotUsed(bounds[6]))
virtual void EndWidgetInteraction (double newEventPos[2])
virtual int GetInteractionState ()
virtual void Highlight (int vtkNotUsed(highlightOn))
virtual void SetPlaceFactor (double)
virtual double GetPlaceFactor ()
virtual void SetHandleSize (double)
virtual double GetHandleSize ()
virtual int GetNeedToRender ()
virtual void SetNeedToRender (int)
virtual void NeedToRenderOn ()
virtual void NeedToRenderOff ()
virtual double * GetBounds ()
virtual void ShallowCopy (vtkProp *prop)
virtual void GetActors (vtkPropCollection *)
virtual void GetVolumes (vtkPropCollection *)
virtual int RenderOverlay (vtkViewport *vtkNotUsed(viewport))
virtual int RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport))
virtual int RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport))
virtual int RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport))
- Public Member Functions inherited from vtkProp
virtual void Pick ()
virtual unsigned long GetRedrawMTime ()
virtual bool HasKeys (vtkInformation *requiredKeys)
virtual void BuildPaths (vtkAssemblyPaths *paths, vtkAssemblyPath *path)
virtual void SetVisibility (int)
virtual int GetVisibility ()
virtual void VisibilityOn ()
virtual void VisibilityOff ()
virtual void SetPickable (int)
virtual int GetPickable ()
virtual void PickableOn ()
virtual void PickableOff ()
virtual void SetDragable (int)
virtual int GetDragable ()
virtual void DragableOn ()
virtual void DragableOff ()
virtual void SetUseBounds (bool)
virtual bool GetUseBounds ()
virtual void UseBoundsOn ()
virtual void UseBoundsOff ()
virtual void InitPathTraversal ()
virtual vtkAssemblyPathGetNextPath ()
virtual int GetNumberOfPaths ()
virtual void PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
virtual vtkMatrix4x4GetMatrix ()
virtual vtkInformationGetPropertyKeys ()
virtual void SetPropertyKeys (vtkInformation *keys)
virtual int RenderVolumetricGeometry (vtkViewport *)
virtual bool RenderFilteredOpaqueGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredTranslucentPolygonalGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredVolumetricGeometry (vtkViewport *v, vtkInformation *requiredKeys)
virtual bool RenderFilteredOverlay (vtkViewport *v, vtkInformation *requiredKeys)
virtual double GetEstimatedRenderTime (vtkViewport *)
virtual double GetEstimatedRenderTime ()
virtual void SetEstimatedRenderTime (double t)
virtual void RestoreEstimatedRenderTime ()
virtual void AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
virtual void SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
virtual double GetAllocatedRenderTime ()
void SetRenderTimeMultiplier (double t)
virtual double GetRenderTimeMultiplier ()
virtual bool GetSupportsSelection ()
virtual int GetNumberOfConsumers ()
void AddConsumer (vtkObject *c)
void RemoveConsumer (vtkObject *c)
vtkObjectGetConsumer (int i)
int IsConsumer (vtkObject *c)
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
virtual void UnRegister (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static vtkCaptionRepresentationNew ()
- Static Public Member Functions inherited from vtkBorderRepresentation

Protected Member Functions

 vtkCaptionRepresentation ()
 ~vtkCaptionRepresentation ()
virtual void AdjustCaptionBoundary ()
- Protected Member Functions inherited from vtkBorderRepresentation
 vtkBorderRepresentation ()
 ~vtkBorderRepresentation ()
virtual void NegotiateLayout ()
- Protected Member Functions inherited from vtkWidgetRepresentation
 vtkWidgetRepresentation ()
 ~vtkWidgetRepresentation ()
void AdjustBounds (double bounds[6], double newBounds[6], double center[3])
double SizeHandlesRelativeToViewport (double factor, double pos[3])
double SizeHandlesInPixels (double factor, double pos[3])
- Protected Member Functions inherited from vtkProp
 vtkProp ()
 ~vtkProp ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Protected Attributes

vtkCaptionActor2DCaptionActor2D
vtkConeSourceCaptionGlyph
int PointWidgetState
int DisplayAttachmentPoint [2]
double FontFactor
vtkPointHandleRepresentation3DAnchorRepresentation
- Protected Attributes inherited from vtkBorderRepresentation
int ShowBorder
vtkProperty2DBorderProperty
int ProportionalResize
int Tolerance
int Moving
double SelectionPoint [2]
vtkCoordinatePositionCoordinate
vtkCoordinatePosition2Coordinate
int Negotiated
double StartPosition [2]
vtkPointsBWPoints
vtkPolyDataBWPolyData
vtkTransformBWTransform
vtkTransformPolyDataFilterBWTransformFilter
vtkPolyDataMapper2DBWMapper
vtkActor2DBWActor
int MinimumSize [2]
int MaximumSize [2]
- Protected Attributes inherited from vtkWidgetRepresentation
vtkRendererRenderer
int InteractionState
double StartEventPosition [3]
double PlaceFactor
int Placed
double InitialBounds [6]
double InitialLength
int ValidPick
double HandleSize
int NeedToRender
vtkTimeStamp BuildTime
- Protected Attributes inherited from vtkProp
int Visibility
int Pickable
int Dragable
bool UseBounds
double AllocatedRenderTime
double EstimatedRenderTime
double SavedEstimatedRenderTime
double RenderTimeMultiplier
int NumberOfConsumers
vtkObject ** Consumers
vtkAssemblyPathsPaths
vtkInformationPropertyKeys
- Protected Attributes inherited from vtkObject
unsigned char Debug
vtkTimeStamp MTime
vtkSubjectHelper * SubjectHelper
- Protected Attributes inherited from vtkObjectBase
int ReferenceCount
vtkWeakPointerBase ** WeakPointers
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)

Additional Inherited Members

- Public Types inherited from vtkBorderRepresentation
enum  { BORDER_OFF = 0, BORDER_ON, BORDER_ACTIVE }
enum  _InteractionState {
  Outside = 0, Inside, AdjustingP0, AdjustingP1,
  AdjustingP2, AdjustingP3, AdjustingE0, AdjustingE1,
  AdjustingE2, AdjustingE3
}
typedef vtkWidgetRepresentation Superclass
- Friends inherited from vtkObject

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
Tests:
vtkCaptionRepresentation (Tests)

Definition at line 49 of file vtkCaptionRepresentation.h.

Member Typedef Documentation

Standard VTK class methods.

Definition at line 57 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])
inlinevirtual

Satisfy the superclasses API.

Reimplemented from vtkBorderRepresentation.

Definition at line 87 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 ( )
protectedvirtual

Member Data Documentation

vtkCaptionActor2D* vtkCaptionRepresentation::CaptionActor2D
protected

Definition at line 114 of file vtkCaptionRepresentation.h.

vtkConeSource* vtkCaptionRepresentation::CaptionGlyph
protected

Definition at line 115 of file vtkCaptionRepresentation.h.

int vtkCaptionRepresentation::PointWidgetState
protected

Definition at line 117 of file vtkCaptionRepresentation.h.

int vtkCaptionRepresentation::DisplayAttachmentPoint[2]
protected

Definition at line 118 of file vtkCaptionRepresentation.h.

double vtkCaptionRepresentation::FontFactor
protected

Definition at line 119 of file vtkCaptionRepresentation.h.

vtkPointHandleRepresentation3D* vtkCaptionRepresentation::AnchorRepresentation
protected

Definition at line 122 of file vtkCaptionRepresentation.h.


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