#include <vtkBalloonRepresentation.h>

Inheritance diagram for vtkBalloonRepresentation:

Collaboration diagram for vtkBalloonRepresentation:

Public Types
enum	{ ImageLeft =0, ImageRight, ImageBottom, ImageTop }

enum	_InteractionState { Outside =0, OnText, OnImage }

Public Types inherited from vtkWidgetRepresentation
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions

virtual void	SetBalloonImage (vtkImageData *img)

virtual vtkImageData *	GetBalloonImage ()


virtual char *	GetBalloonText ()

virtual void	SetBalloonText (const char *)


virtual void	SetImageSize (int, int)

void	SetImageSize (int[2])

virtual int *	GetImageSize ()

virtual void	GetImageSize (int &, int &)

virtual void	GetImageSize (int[2])


virtual void	SetTextProperty (vtkTextProperty *p)

virtual vtkTextProperty *	GetTextProperty ()


virtual void	SetFrameProperty (vtkProperty2D *p)

virtual vtkProperty2D *	GetFrameProperty ()


virtual void	SetImageProperty (vtkProperty2D *p)

virtual vtkProperty2D *	GetImageProperty ()


virtual void	SetBalloonLayout (int)

virtual int	GetBalloonLayout ()

void	SetBalloonLayoutToImageLeft ()

void	SetBalloonLayoutToImageRight ()

void	SetBalloonLayoutToImageBottom ()

void	SetBalloonLayoutToImageTop ()

void	SetBalloonLayoutToTextLeft ()

void	SetBalloonLayoutToTextRight ()

void	SetBalloonLayoutToTextTop ()

void	SetBalloonLayoutToTextBottom ()


virtual void	SetOffset (int, int)

void	SetOffset (int[2])

virtual int *	GetOffset ()

virtual void	GetOffset (int &, int &)

virtual void	GetOffset (int[2])


virtual void	SetPadding (int)

virtual int	GetPadding ()


virtual void	StartWidgetInteraction (double e[2])

virtual void	EndWidgetInteraction (double e[2])

virtual void	BuildRepresentation ()

virtual int	ComputeInteractionState (int X, int Y, int modify=0)


virtual void	ReleaseGraphicsResources (vtkWindow *w)

virtual int	RenderOverlay (vtkViewport *viewport)

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	WidgetInteraction (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	GetActors2D (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))

virtual int	HasTranslucentPolygonalGeometry ()

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 int	RenderOpaqueGeometry (vtkViewport *)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

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

bool	GetDebug ()

void	SetDebug (bool 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 vtkBalloonRepresentation *	New ()

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

	~vtkBalloonRepresentation ()

void	AdjustImageSize (double imageSize[2])

void	ScaleImage (double imageSize[2], double scale)

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
char *	BalloonText

vtkImageData *	BalloonImage

int	BalloonLayout

int	Padding

int	Offset [2]

int	ImageSize [2]

vtkTextMapper *	TextMapper

vtkActor2D *	TextActor

vtkTextProperty *	TextProperty

vtkTexture *	Texture

vtkPolyData *	TexturePolyData

vtkPoints *	TexturePoints

vtkPolyDataMapper2D *	TextureMapper

vtkActor2D *	TextureActor

vtkProperty2D *	ImageProperty

vtkPoints *	FramePoints

vtkCellArray *	FramePolygon

vtkPolyData *	FramePolyData

vtkPolyDataMapper2D *	FrameMapper

vtkActor2D *	FrameActor

vtkProperty2D *	FrameProperty

int	TextVisible

int	ImageVisible

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
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkWidgetRepresentation	Superclass

static int	IsTypeOf (const char *type)

static vtkBalloonRepresentation *	SafeDownCast (vtkObjectBase *o)

virtual int	IsA (const char *type)

vtkBalloonRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual vtkObjectBase *	NewInstanceInternal () const

Detailed Description

represent the vtkBalloonWidget

The vtkBalloonRepresentation is used to represent the vtkBalloonWidget. This representation is defined by two items: a text string and an image. At least one of these two items must be defined, but it is allowable to specify both, or just an image or just text. If both the text and image are specified, then methods are available for positioning the text and image with respect to each other.

The balloon representation consists of three parts: text, a rectangular frame behind the text, and an image placed next to the frame and sized to match the frame.

The size of the balloon is ultimately controlled by the text properties (i.e., font size). This representation uses a layout policy as follows.

If there is just text and no image, then the text properties and padding are used to control the size of the balloon.

If there is just an image and no text, then the ImageSize[2] member is used to control the image size. (The image will fit into this rectangle, but will not necessarily fill the whole rectangle, i.e., the image is not stretched).

If there is text and an image, the following approach ia used. First, based on the font size and other related properties (e.g., padding), determine the size of the frame. Second, depending on the layout of the image and text frame, control the size of the neighboring image (since the frame and image share a common edge). However, if this results in an image that is smaller than ImageSize[2], then the image size will be set to ImageSize[2] and the frame will be adjusted accordingly. The text is always placed in the center of the frame if the frame is resized.

See also: vtkBalloonWidget

Examples:: vtkBalloonRepresentation (Examples)

Tests:: vtkBalloonRepresentation (Tests)

Definition at line 81 of file vtkBalloonRepresentation.h.

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkBalloonRepresentation::Superclass

Standard VTK methods.

Definition at line 89 of file vtkBalloonRepresentation.h.

Member Enumeration Documentation

anonymous enum

Enumerator
ImageLeft
ImageRight
ImageBottom
ImageTop

Definition at line 134 of file vtkBalloonRepresentation.h.

enum vtkBalloonRepresentation::_InteractionState

State is either outside, or inside (on the text portion ot the image).

Enumerator
Outside
OnText
OnImage

Definition at line 187 of file vtkBalloonRepresentation.h.

Constructor & Destructor Documentation

vtkBalloonRepresentation::vtkBalloonRepresentation ( )

protected

vtkBalloonRepresentation::~vtkBalloonRepresentation ( )

protected

Member Function Documentation

static vtkBalloonRepresentation* vtkBalloonRepresentation::New ( )

static

Instantiate the class.

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

static

Standard VTK methods.

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

virtual

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

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

static

Standard VTK methods.

virtual vtkObjectBase* vtkBalloonRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

vtkBalloonRepresentation* vtkBalloonRepresentation::NewInstance ( ) const

Standard VTK methods.

void vtkBalloonRepresentation::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

virtual

Standard VTK methods.

Reimplemented from vtkObject.

virtual void vtkBalloonRepresentation::SetBalloonImage ( vtkImageData * img )

virtual

Specify/retrieve the image to display in the balloon.

virtual vtkImageData* vtkBalloonRepresentation::GetBalloonImage ( )

virtual

Specify/retrieve the image to display in the balloon.

virtual char* vtkBalloonRepresentation::GetBalloonText ( )

virtual

Specify/retrieve the text to display in the balloon.

virtual void vtkBalloonRepresentation::SetBalloonText ( const char * )

virtual

Specify/retrieve the text to display in the balloon.

virtual void vtkBalloonRepresentation::SetImageSize	(	int	,
		int
	)

virtual