vtkBalloonRepresentation Class Reference

#include <vtkBalloonRepresentation.h>

Inheritance diagram for vtkBalloonRepresentation:

[legend]

Collaboration diagram for vtkBalloonRepresentation:

[legend]

List of all members.

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 80 of file vtkBalloonRepresentation.h.


typedef vtkWidgetRepresentation	Superclass
static int	IsTypeOf (const char *type)
static vtkBalloonRepresentation *	SafeDownCast (vtkObject *o)
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
Public Types
enum	{ ImageLeft = 0, ImageRight, ImageBottom, ImageTop }
enum	_InteractionState { Outside = 0, OnText, OnImage }
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)
Static Public Member Functions
static vtkBalloonRepresentation *	New ()
Protected Member Functions
	vtkBalloonRepresentation ()
	~vtkBalloonRepresentation ()
void	AdjustImageSize (double imageSize[2])
void	ScaleImage (double imageSize[2], double scale)
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

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkBalloonRepresentation::Superclass

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

Definition at line 88 of file vtkBalloonRepresentation.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

ImageLeft
ImageRight
ImageBottom
ImageTop

Definition at line 133 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 186 of file vtkBalloonRepresentation.h.

Constructor & Destructor Documentation

vtkBalloonRepresentation::vtkBalloonRepresentation ( ) [protected]

vtkBalloonRepresentation::~vtkBalloonRepresentation ( ) [protected]

Member Function Documentation

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

Instantiate the class.

Reimplemented from vtkObject.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

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

Standard VTK methods.

Reimplemented from vtkWidgetRepresentation.

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]`