represents vtkCaptionWidget in the scene More...

#include <vtkCaptionRepresentation.h>

Inheritance diagram for vtkCaptionRepresentation:

Collaboration diagram for vtkCaptionRepresentation:

Public Member Functions

void	SetAnchorPosition (double pos[3])

void	GetAnchorPosition (double pos[3])


void	SetCaptionActor2D (vtkCaptionActor2D *captionActor)

virtual vtkCaptionActor2D *	GetCaptionActor2D ()


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 vtkCoordinate *	GetPositionCoordinate ()

virtual void	SetPosition (float x[2])

virtual void	SetPosition (float x, float y)

virtual float *	GetPosition ()

virtual vtkCoordinate *	GetPosition2Coordinate ()

virtual void	SetPosition2 (float x[2])

virtual void	SetPosition2 (float x, float y)

virtual float *	GetPosition2 ()

virtual void	SetShowBorder (int border)

virtual int	GetShowBorderMinValue ()

virtual int	GetShowBorderMaxValue ()

virtual int	GetShowBorder ()

void	SetShowBorderToOff ()

void	SetShowBorderToOn ()

void	SetShowBorderToActive ()

virtual void	SetShowVerticalBorder (int)

virtual int	GetShowVerticalBorder ()

virtual void	SetShowHorizontalBorder (int)

virtual int	GetShowHorizontalBorder ()

virtual vtkProperty2D *	GetBorderProperty ()

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)

vtkBorderRepresentation *	NewInstance () const

Public Member Functions inherited from vtkWidgetRepresentation
virtual void	PickingManagedOn ()

virtual void	PickingManagedOff ()

virtual void	SetPickingManaged (bool)

virtual bool	GetPickingManaged ()

virtual void	SetRenderer (vtkRenderer *ren)

virtual vtkRenderer *	GetRenderer ()

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))

vtkWidgetRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Pick ()

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 unsigned long	GetRedrawMTime ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual void	InitPathTraversal ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkMatrix4x4 *	GetMatrix ()

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual vtkIdType	GetConvertedPickValue (vtkIdType idIn, int vtkNotUsed(fieldassociation))

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)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

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)

vtkCommand *	GetCommand (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)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(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 &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static vtkCaptionRepresentation *	New ()

Static Public Member Functions inherited from vtkBorderRepresentation
static vtkBorderRepresentation *	New ()

static int	IsTypeOf (const char *type)

static vtkBorderRepresentation *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkWidgetRepresentation
static int	IsTypeOf (const char *type)

static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
	vtkCaptionRepresentation ()

	~vtkCaptionRepresentation ()

virtual void	AdjustCaptionBoundary ()

Protected Member Functions inherited from vtkBorderRepresentation
	vtkBorderRepresentation ()

	~vtkBorderRepresentation ()

virtual void	NegotiateLayout ()

virtual void	UpdateShowBorder ()

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation ()

void	AdjustBounds (double bounds[6], double newBounds[6], double center[3])

virtual void	RegisterPickers ()

virtual void	UnRegisterPickers ()

virtual void	PickersModified ()

vtkPickingManager *	GetPickingManager ()

double	SizeHandlesRelativeToViewport (double factor, double pos[3])

double	SizeHandlesInPixels (double factor, double pos[3])

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)

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 &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkCaptionActor2D *	CaptionActor2D

vtkConeSource *	CaptionGlyph

int	PointWidgetState

int	DisplayAttachmentPoint [2]

double	FontFactor

vtkPointHandleRepresentation3D *	AnchorRepresentation

Protected Attributes inherited from vtkBorderRepresentation
int	ShowVerticalBorder

int	ShowHorizontalBorder

vtkProperty2D *	BorderProperty

int	ProportionalResize

int	Tolerance

int	Moving

double	SelectionPoint [2]

vtkCoordinate *	PositionCoordinate

vtkCoordinate *	Position2Coordinate

int	Negotiated

double	StartPosition [2]

vtkPoints *	BWPoints

vtkPolyData *	BWPolyData

vtkTransform *	BWTransform

vtkTransformPolyDataFilter *	BWTransformFilter

vtkPolyDataMapper2D *	BWMapper

vtkActor2D *	BWActor

int	MinimumSize [2]

int	MaximumSize [2]

Protected Attributes inherited from vtkWidgetRepresentation
vtkWeakPointer< vtkRenderer >	Renderer

int	InteractionState

double	StartEventPosition [3]

double	PlaceFactor

int	Placed

double	InitialBounds [6]

double	InitialLength

int	ValidPick

bool	PickingManaged

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

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
unsigned char	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt< vtkTypeInt32 >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkBorderRepresentation	Superclass

static int	IsTypeOf (const char *type)

static vtkCaptionRepresentation *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkCaptionRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

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

Public Types inherited from vtkWidgetRepresentation
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

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 50 of file vtkCaptionRepresentation.h.

Member Typedef Documentation

typedef vtkBorderRepresentation vtkCaptionRepresentation::Superclass

Standard VTK class methods.

Definition at line 58 of file vtkCaptionRepresentation.h.

Constructor & Destructor Documentation

vtkCaptionRepresentation::vtkCaptionRepresentation ( )

protected

vtkCaptionRepresentation::~vtkCaptionRepresentation ( )

protected

Member Function Documentation

static vtkCaptionRepresentation* vtkCaptionRepresentation::New ( )

static

Instantiate this class.

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

static

Standard VTK class methods.

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

virtual

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

static vtkCaptionRepresentation* vtkCaptionRepresentation::SafeDownCast ( vtkObjectBase * o )

static

Standard VTK class methods.

virtual vtkObjectBase* vtkCaptionRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard VTK class methods.

Reimplemented from vtkBorderRepresentation.

vtkCaptionRepresentation* vtkCaptionRepresentation::NewInstance ( ) const

Standard VTK class methods.

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 88 of file vtkCaptionRepresentation.h.

virtual void vtkCaptionRepresentation::GetActors2D ( vtkPropCollection * )

virtual

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