#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 }
	State is either outside, or inside (on the text portion of the image). More...

typedef vtkWidgetRepresentation	Superclass
	Standard VTK methods. More...

Public Types inherited from vtkWidgetRepresentation
enum	Axis { NONE = -1, XAxis = 0, YAxis = 1, ZAxis = 2 }
	Axis labels. More...

typedef vtkProp	Superclass
	Standard methods for instances of this class. More...

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkBalloonRepresentation *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	SetBalloonImage (vtkImageData *img)
	Specify/retrieve the image to display in the balloon. More...

virtual vtkImageData *	GetBalloonImage ()

virtual char *	GetBalloonText ()
	Specify/retrieve the text to display in the balloon. More...

virtual void	SetBalloonText (const char *)

virtual void	SetImageSize (int, int)
	Specify the minimum size for the image. More...

void	SetImageSize (int[2])

virtual int *	GetImageSize ()

virtual void	GetImageSize (int &, int &)

virtual void	GetImageSize (int[2])

virtual void	SetTextProperty (vtkTextProperty *p)
	Set/get the text property (relevant only if text is shown). More...

virtual vtkTextProperty *	GetTextProperty ()

virtual void	SetFrameProperty (vtkProperty2D *p)
	Set/get the frame property (relevant only if text is shown). More...

virtual vtkProperty2D *	GetFrameProperty ()

virtual void	SetImageProperty (vtkProperty2D *p)
	Set/get the image property (relevant only if an image is shown). More...

virtual vtkProperty2D *	GetImageProperty ()

virtual void	SetBalloonLayout (int)
	Specify the layout of the image and text within the balloon. More...

virtual int	GetBalloonLayout ()

void	SetBalloonLayoutToImageLeft ()

void	SetBalloonLayoutToImageRight ()

void	SetBalloonLayoutToImageBottom ()

void	SetBalloonLayoutToImageTop ()

void	SetBalloonLayoutToTextLeft ()

void	SetBalloonLayoutToTextRight ()

void	SetBalloonLayoutToTextTop ()

void	SetBalloonLayoutToTextBottom ()

virtual void	SetOffset (int, int)
	Set/Get the offset from the mouse pointer from which to place the balloon. More...

void	SetOffset (int[2])

virtual int *	GetOffset ()

virtual void	GetOffset (int &, int &)

virtual void	GetOffset (int[2])

virtual void	SetPadding (int)
	Set/Get the padding (in pixels) that is used between the text and the frame. More...

virtual int	GetPadding ()

void	StartWidgetInteraction (double e[2]) override
	These are methods that satisfy vtkWidgetRepresentation's API. More...

void	EndWidgetInteraction (double e[2]) override

void	BuildRepresentation () override

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

void	ReleaseGraphicsResources (vtkWindow *w) override
	Methods required by vtkProp superclass. More...

int	RenderOverlay (vtkViewport *viewport) override

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

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PickingManagedOn ()
	Enable/Disable the use of a manager to process the picking. More...

virtual void	PickingManagedOff ()

void	SetPickingManaged (bool managed)

virtual bool	GetPickingManaged ()

virtual void	SetRenderer (vtkRenderer *ren)
	Subclasses of vtkWidgetRepresentation must implement these methods. More...

virtual vtkRenderer *	GetRenderer ()

virtual void	PlaceWidget (double *vtkNotUsed(bounds[6]))
	The following is a suggested API for widget representations. More...

virtual void	WidgetInteraction (double newEventPos[2])

virtual int	GetInteractionState ()

virtual void	Highlight (int vtkNotUsed(highlightOn))

virtual void	StartComplexInteraction (vtkRenderWindowInteractor , vtkAbstractWidget , unsigned long, void *)

virtual void	ComplexInteraction (vtkRenderWindowInteractor , vtkAbstractWidget , unsigned long, void *)

virtual void	EndComplexInteraction (vtkRenderWindowInteractor , vtkAbstractWidget , unsigned long, void *)

virtual int	ComputeComplexInteractionState (vtkRenderWindowInteractor iren, vtkAbstractWidget widget, unsigned long event, void *callData, int modify=0)

virtual void	SetPlaceFactor (double)
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...

virtual double	GetPlaceFactor ()

virtual void	SetHandleSize (double)
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...

virtual double	GetHandleSize ()

virtual vtkTypeBool	GetNeedToRender ()
	Some subclasses use this data member to keep track of whether to render or not (i.e., to minimize the total number of renders). More...

virtual void	SetNeedToRender (vtkTypeBool)

virtual void	NeedToRenderOn ()

virtual void	NeedToRenderOff ()

double *	GetBounds () override
	Methods to make this class behave as a vtkProp. More...

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkProp. More...

void	GetActors (vtkPropCollection *) override
	For some exporters and other other operations we must be able to collect all the actors or volumes. More...

void	GetActors2D (vtkPropCollection *) override

void	GetVolumes (vtkPropCollection *) override

void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE Release any graphics resources that are being consumed by this actor. More...

int	RenderOverlay (vtkViewport *vtkNotUsed(viewport)) override

int	RenderOpaqueGeometry (vtkViewport *vtkNotUsed(viewport)) override

int	RenderTranslucentPolygonalGeometry (vtkViewport *vtkNotUsed(viewport)) override

int	RenderVolumetricGeometry (vtkViewport *vtkNotUsed(viewport)) override

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some translucent polygonal geometry? This method is called during the rendering process to know if there is some translucent polygonal geometry. More...

virtual void	RegisterPickers ()
	Register internal Pickers in the Picking Manager. More...

virtual void	UnRegisterPickers ()
	Unregister internal pickers from the Picking Manager. More...

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

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp. More...

virtual vtkTypeBool	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable. More...

virtual vtkTypeBool	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	Pick ()
	Method fires PickEvent if the prop is picked. More...

virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable. More...

virtual vtkTypeBool	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently. More...

virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...

virtual vtkMatrix4x4 *	GetMatrix ()

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys. More...

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys. More...

virtual int	RenderOpaqueGeometry (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS All concrete subclasses must be able to render themselves. More...

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys. More...

virtual vtkTypeBool	HasOpaqueGeometry ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS Does this prop have some opaque geometry? This method is called during the rendering process to know if there is some opaque geometry. More...

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...

virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers More...

virtual int	GetNumberOfConsumers ()
	Get the number of consumers. More...

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

virtual void	SetShaderProperty (vtkShaderProperty *property)
	Set/Get the shader property. More...

virtual vtkShaderProperty *	GetShaderProperty ()

virtual bool	IsRenderingTranslucentPolygonalGeometry ()

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time. More...

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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 )

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)

vtkTypeBool	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

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)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

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
	Return the class name as a string. More...

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space. More...

Static Public Member Functions
static vtkBalloonRepresentation *	New ()
	Instantiate the class. More...

static vtkTypeBool	IsTypeOf (const char *type)

static vtkBalloonRepresentation *	SafeDownCast (vtkObjectBase *o)

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

static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)

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

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...

static bool	GetUsingMemkind ()
	A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkBalloonRepresentation ()

	~vtkBalloonRepresentation () override

void	AdjustImageSize (double imageSize[2])

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

Protected Member Functions inherited from vtkWidgetRepresentation
	vtkWidgetRepresentation ()

	~vtkWidgetRepresentation () override

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

vtkPickingManager *	GetPickingManager ()
	Return the picking manager associated on the context on which the widget representation currently belong. More...

vtkAssemblyPath *	GetAssemblyPath (double X, double Y, double Z, vtkAbstractPropPicker *picker)
	Proceed to a pick, whether through the PickingManager if the picking is managed or directly using the registered picker, and return the assembly path. More...

vtkAssemblyPath *	GetAssemblyPath3DPoint (double pos[3], vtkAbstractPropPicker *picker)

bool	NearbyEvent (int X, int Y, double bounds[6])

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

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

void	UpdatePropPose (vtkProp3D prop, const double pos1, const double orient1, const double pos2, const double *orient2)

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

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

vtkTexturedActor2D *	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

vtkTypeBool	NeedToRender

vtkTimeStamp	BuildTime

vtkNew< vtkTransform >	TempTransform

vtkNew< vtkMatrix4x4 >	TempMatrix

Protected Attributes inherited from vtkProp
vtkTypeBool	Visibility

vtkTypeBool	Pickable

vtkTypeBool	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

vtkShaderProperty *	ShaderProperty

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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

Definition at line 76 of file vtkBalloonRepresentation.h.

Member Typedef Documentation

◆ Superclass

typedef vtkWidgetRepresentation vtkBalloonRepresentation::Superclass

Standard VTK methods.

Definition at line 88 of file vtkBalloonRepresentation.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
ImageLeft
ImageRight
ImageBottom
ImageTop

Definition at line 144 of file vtkBalloonRepresentation.h.

◆ _InteractionState

enum vtkBalloonRepresentation::_InteractionState

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

Enumerator
Outside
OnText
OnImage

Definition at line 213 of file vtkBalloonRepresentation.h.

Constructor & Destructor Documentation

◆ vtkBalloonRepresentation()

vtkBalloonRepresentation::vtkBalloonRepresentation ( )

protected

◆ ~vtkBalloonRepresentation()

vtkBalloonRepresentation::~vtkBalloonRepresentation ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkBalloonRepresentation* vtkBalloonRepresentation::New ( )

static

Instantiate the class.

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkBalloonRepresentation::IsA ( const char * name )

virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkWidgetRepresentation.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkBalloonRepresentation::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkWidgetRepresentation.

◆ NewInstance()

vtkBalloonRepresentation* vtkBalloonRepresentation::NewInstance ( ) const

◆ PrintSelf()

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

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

◆ SetBalloonImage()

virtual void vtkBalloonRepresentation::SetBalloonImage ( vtkImageData * img )

virtual

Specify/retrieve the image to display in the balloon.

◆ GetBalloonImage()

virtual vtkImageData* vtkBalloonRepresentation::GetBalloonImage ( )

virtual

◆ GetBalloonText()

virtual char* vtkBalloonRepresentation::GetBalloonText ( )

virtual

Specify/retrieve the text to display in the balloon.

◆ SetBalloonText()

virtual void vtkBalloonRepresentation::SetBalloonText ( const char * )

virtual

◆ SetImageSize() [1/2]

virtual void vtkBalloonRepresentation::SetImageSize	(	int	,
		int
	)

virtual

Specify the minimum size for the image.

Note that this is a bounding rectangle, the image will fit inside of it. However, if the balloon consists of text plus an image, then the image may be bigger than ImageSize[2] to fit into the balloon frame.

◆ SetImageSize() [2/2]

void vtkBalloonRepresentation::SetImageSize ( int [2] )

◆ GetImageSize() [1/3]

virtual int* vtkBalloonRepresentation::GetImageSize ( )

virtual

◆ GetImageSize() [2/3]

virtual void vtkBalloonRepresentation::GetImageSize	(	int &	,
		int &
	)

virtual

◆ GetImageSize() [3/3]

virtual void vtkBalloonRepresentation::GetImageSize ( int [2] )

virtual

◆ SetTextProperty()

virtual void vtkBalloonRepresentation::SetTextProperty ( vtkTextProperty * p )

virtual

Set/get the text property (relevant only if text is shown).

◆ GetTextProperty()

virtual vtkTextProperty* vtkBalloonRepresentation::GetTextProperty ( )

virtual

◆ SetFrameProperty()

virtual void vtkBalloonRepresentation::SetFrameProperty ( vtkProperty2D * p )

virtual

Set/get the frame property (relevant only if text is shown).

The frame lies behind the text.

◆ GetFrameProperty()

virtual vtkProperty2D* vtkBalloonRepresentation::GetFrameProperty ( )

virtual

◆ SetImageProperty()

virtual void vtkBalloonRepresentation::SetImageProperty ( vtkProperty2D * p )

virtual

Set/get the image property (relevant only if an image is shown).

◆ GetImageProperty()

virtual vtkProperty2D* vtkBalloonRepresentation::GetImageProperty ( )

virtual

◆ SetBalloonLayout()

virtual void vtkBalloonRepresentation::SetBalloonLayout ( int )

virtual

Specify the layout of the image and text within the balloon.

Note that there are reduncies in these methods, for example SetBalloonLayoutToImageLeft() results in the same effect as SetBalloonLayoutToTextRight(). If only text is specified, or only an image is specified, then it doesn't matter how the layout is specified.

◆ GetBalloonLayout()

virtual int vtkBalloonRepresentation::GetBalloonLayout ( )

virtual

◆ SetBalloonLayoutToImageLeft()

void vtkBalloonRepresentation::SetBalloonLayoutToImageLeft ( )

inline

Definition at line 162 of file vtkBalloonRepresentation.h.

◆ SetBalloonLayoutToImageRight()

void vtkBalloonRepresentation::SetBalloonLayoutToImageRight ( )

inline

Definition at line 163 of file vtkBalloonRepresentation.h.

◆ SetBalloonLayoutToImageBottom()

void vtkBalloonRepresentation::SetBalloonLayoutToImageBottom ( )

inline

Definition at line 164 of file vtkBalloonRepresentation.h.

◆ SetBalloonLayoutToImageTop()

void vtkBalloonRepresentation::SetBalloonLayoutToImageTop ( )

inline

Definition at line 165 of file vtkBalloonRepresentation.h.

◆ SetBalloonLayoutToTextLeft()

void vtkBalloonRepresentation::SetBalloonLayoutToTextLeft ( )

inline

Definition at line 166 of file vtkBalloonRepresentation.h.

◆ SetBalloonLayoutToTextRight()

void vtkBalloonRepresentation::SetBalloonLayoutToTextRight ( )

inline

Definition at line 167 of file vtkBalloonRepresentation.h.

◆ SetBalloonLayoutToTextTop()

void vtkBalloonRepresentation::SetBalloonLayoutToTextTop ( )

inline

Definition at line 168 of file vtkBalloonRepresentation.h.

◆ SetBalloonLayoutToTextBottom()

void vtkBalloonRepresentation::SetBalloonLayoutToTextBottom ( )

inline

Definition at line 169 of file vtkBalloonRepresentation.h.

◆ SetOffset() [1/2]

virtual void vtkBalloonRepresentation::SetOffset	(	int	,
		int
	)

virtual

Set/Get the offset from the mouse pointer from which to place the balloon.

The representation will try and honor this offset unless there is a collision with the side of the renderer, in which case the balloon will be repositioned to lie within the rendering window.

◆ SetOffset() [2/2]

void vtkBalloonRepresentation::SetOffset ( int [2] )

◆ GetOffset() [1/3]

virtual int* vtkBalloonRepresentation::GetOffset ( )

virtual

◆ GetOffset() [2/3]

virtual void vtkBalloonRepresentation::GetOffset	(	int &	,
		int &
	)

virtual

◆ GetOffset() [3/3]

virtual void vtkBalloonRepresentation::GetOffset ( int [2] )

virtual

◆ SetPadding()

virtual void vtkBalloonRepresentation::SetPadding ( int )

virtual

Set/Get the padding (in pixels) that is used between the text and the frame.

◆ GetPadding()

virtual int vtkBalloonRepresentation::GetPadding ( )

virtual

◆ StartWidgetInteraction()

void vtkBalloonRepresentation::StartWidgetInteraction ( double e[2] )

overridevirtual

These are methods that satisfy vtkWidgetRepresentation's API.

Reimplemented from vtkWidgetRepresentation.

◆ EndWidgetInteraction()

void vtkBalloonRepresentation::EndWidgetInteraction ( double e[2] )

overridevirtual

Reimplemented from vtkWidgetRepresentation.

◆ BuildRepresentation()

void vtkBalloonRepresentation::BuildRepresentation ( )

overridevirtual

Implements vtkWidgetRepresentation.

◆ ComputeInteractionState()

int vtkBalloonRepresentation::ComputeInteractionState	(	int	X,
		int	Y,
		int	modify = `0`
	)

overridevirtual

Reimplemented from vtkWidgetRepresentation.

◆ ReleaseGraphicsResources()

void vtkBalloonRepresentation::ReleaseGraphicsResources ( vtkWindow * w )

overridevirtual

Methods required by vtkProp superclass.

Reimplemented from vtkProp.

◆ RenderOverlay()

int vtkBalloonRepresentation::RenderOverlay ( vtkViewport * viewport )

overridevirtual

Reimplemented from vtkProp.

◆ AdjustImageSize()

void vtkBalloonRepresentation::AdjustImageSize ( double imageSize[2] )

protected

◆ ScaleImage()

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

protected

Member Data Documentation

◆ BalloonText

char* vtkBalloonRepresentation::BalloonText

protected

Definition at line 225 of file vtkBalloonRepresentation.h.

◆ BalloonImage

vtkImageData* vtkBalloonRepresentation::BalloonImage

protected

Definition at line 226 of file vtkBalloonRepresentation.h.

◆ BalloonLayout

int vtkBalloonRepresentation::BalloonLayout

protected

Definition at line 229 of file vtkBalloonRepresentation.h.

◆ Padding

int vtkBalloonRepresentation::Padding

protected

Definition at line 232 of file vtkBalloonRepresentation.h.

◆ Offset

int vtkBalloonRepresentation::Offset[2]

protected

Definition at line 233 of file vtkBalloonRepresentation.h.

◆ ImageSize

int vtkBalloonRepresentation::ImageSize[2]

protected

Definition at line 234 of file vtkBalloonRepresentation.h.

◆ TextMapper

vtkTextMapper* vtkBalloonRepresentation::TextMapper

protected

Definition at line 237 of file vtkBalloonRepresentation.h.

◆ TextActor

vtkActor2D* vtkBalloonRepresentation::TextActor

protected

Definition at line 238 of file vtkBalloonRepresentation.h.

◆ TextProperty

vtkTextProperty* vtkBalloonRepresentation::TextProperty

protected

Definition at line 239 of file vtkBalloonRepresentation.h.

◆ Texture

vtkTexture* vtkBalloonRepresentation::Texture

protected

Definition at line 242 of file vtkBalloonRepresentation.h.

◆ TexturePolyData

vtkPolyData* vtkBalloonRepresentation::TexturePolyData

protected

Definition at line 243 of file vtkBalloonRepresentation.h.

◆ TexturePoints

vtkPoints* vtkBalloonRepresentation::TexturePoints

protected

Definition at line 244 of file vtkBalloonRepresentation.h.

◆ TextureMapper

vtkPolyDataMapper2D* vtkBalloonRepresentation::TextureMapper

protected

Definition at line 245 of file vtkBalloonRepresentation.h.

◆ TextureActor

vtkTexturedActor2D* vtkBalloonRepresentation::TextureActor

protected

Definition at line 246 of file vtkBalloonRepresentation.h.

◆ ImageProperty

vtkProperty2D* vtkBalloonRepresentation::ImageProperty

protected

Definition at line 247 of file vtkBalloonRepresentation.h.

◆ FramePoints

vtkPoints* vtkBalloonRepresentation::FramePoints

protected

Definition at line 250 of file vtkBalloonRepresentation.h.

◆ FramePolygon

vtkCellArray* vtkBalloonRepresentation::FramePolygon

protected

Definition at line 251 of file vtkBalloonRepresentation.h.

◆ FramePolyData

vtkPolyData* vtkBalloonRepresentation::FramePolyData

protected

Definition at line 252 of file vtkBalloonRepresentation.h.

◆ FrameMapper

vtkPolyDataMapper2D* vtkBalloonRepresentation::FrameMapper

protected

Definition at line 253 of file vtkBalloonRepresentation.h.

◆ FrameActor

vtkActor2D* vtkBalloonRepresentation::FrameActor

protected

Definition at line 254 of file vtkBalloonRepresentation.h.

◆ FrameProperty

vtkProperty2D* vtkBalloonRepresentation::FrameProperty

protected

Definition at line 255 of file vtkBalloonRepresentation.h.

◆ TextVisible

int vtkBalloonRepresentation::TextVisible

protected

Definition at line 258 of file vtkBalloonRepresentation.h.

◆ ImageVisible

int vtkBalloonRepresentation::ImageVisible

protected

Definition at line 259 of file vtkBalloonRepresentation.h.

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

Interaction/Widgets/vtkBalloonRepresentation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ _InteractionState

Constructor & Destructor Documentation

◆ vtkBalloonRepresentation()

◆ ~vtkBalloonRepresentation()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ SetBalloonImage()

◆ GetBalloonImage()

◆ GetBalloonText()

◆ SetBalloonText()

◆ SetImageSize() [1/2]

◆ SetImageSize() [2/2]

◆ GetImageSize() [1/3]

◆ GetImageSize() [2/3]

◆ GetImageSize() [3/3]

◆ SetTextProperty()

◆ GetTextProperty()

◆ SetFrameProperty()

◆ GetFrameProperty()

◆ SetImageProperty()

◆ GetImageProperty()

◆ SetBalloonLayout()

◆ GetBalloonLayout()

◆ SetBalloonLayoutToImageLeft()

◆ SetBalloonLayoutToImageRight()

◆ SetBalloonLayoutToImageBottom()

◆ SetBalloonLayoutToImageTop()

◆ SetBalloonLayoutToTextLeft()

◆ SetBalloonLayoutToTextRight()

◆ SetBalloonLayoutToTextTop()

◆ SetBalloonLayoutToTextBottom()

◆ SetOffset() [1/2]

◆ SetOffset() [2/2]

◆ GetOffset() [1/3]

◆ GetOffset() [2/3]

◆ GetOffset() [3/3]

◆ SetPadding()

◆ GetPadding()

◆ StartWidgetInteraction()

◆ EndWidgetInteraction()

◆ BuildRepresentation()

◆ ComputeInteractionState()

◆ ReleaseGraphicsResources()

◆ RenderOverlay()

◆ AdjustImageSize()

◆ ScaleImage()

Member Data Documentation

◆ BalloonText

◆ BalloonImage

◆ BalloonLayout

◆ Padding

◆ Offset

◆ ImageSize

◆ TextMapper

◆ TextActor

◆ TextProperty

◆ Texture

◆ TexturePolyData

◆ TexturePoints

◆ TextureMapper

◆ TextureActor

◆ ImageProperty

◆ FramePoints