#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...

Public Types inherited from vtkWidgetRepresentation
typedef vtkProp	Superclass
	Standard methods for instances of this class. More...

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Member Functions

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

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


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

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


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

void	SetImageSize (int[2])
	Specify the minimum size for the image. More...

virtual int *	GetImageSize ()
	Specify the minimum size for the image. More...

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

virtual void	GetImageSize (int[2])
	Specify the minimum size for the image. More...


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

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


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

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


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

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


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

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

void	SetBalloonLayoutToImageLeft ()
	Specify the layout of the image and text within the balloon. More...

void	SetBalloonLayoutToImageRight ()
	Specify the layout of the image and text within the balloon. More...

void	SetBalloonLayoutToImageBottom ()
	Specify the layout of the image and text within the balloon. More...

void	SetBalloonLayoutToImageTop ()
	Specify the layout of the image and text within the balloon. More...

void	SetBalloonLayoutToTextLeft ()
	Specify the layout of the image and text within the balloon. More...

void	SetBalloonLayoutToTextRight ()
	Specify the layout of the image and text within the balloon. More...

void	SetBalloonLayoutToTextTop ()
	Specify the layout of the image and text within the balloon. More...

void	SetBalloonLayoutToTextBottom ()
	Specify the layout of the image and text within the balloon. More...


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

void	SetOffset (int[2])
	Set/Get the offset from the mouse pointer from which to place the balloon. More...

virtual int *	GetOffset ()
	Set/Get the offset from the mouse pointer from which to place the balloon. More...

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

virtual void	GetOffset (int[2])
	Set/Get the offset from the mouse pointer from which to place the balloon. More...


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

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


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

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

void	BuildRepresentation () override
	These are methods that satisfy vtkWidgetRepresentation's API. More...

int	ComputeInteractionState (int X, int Y, int modify=0) override
	These are methods that satisfy vtkWidgetRepresentation's API. More...


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

int	RenderOverlay (vtkViewport *viewport) override
	Methods required by vtkProp superclass. More...

Public Member Functions inherited from vtkWidgetRepresentation
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))

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

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

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

void	SetPickingManaged (bool managed)
	Enable/Disable the use of a manager to process the picking. More...

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

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

virtual vtkRenderer *	GetRenderer ()
	Subclasses of vtkWidgetRepresentation must implement these methods. More...

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 ()
	Set/Get a factor representing the scaling of the widget upon placement (via the PlaceWidget() method). More...

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 ()
	Set/Get the factor that controls the size of the handles that appear as part of the widget (if any). More...

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)
	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	NeedToRenderOn ()
	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	NeedToRenderOff ()
	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...

vtkWidgetRepresentation *	NewInstance () const
	Standard methods for instances of this class. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard methods for instances of this class. 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	Pick ()
	Method fires PickEvent if the prop is picked. More...

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

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

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 void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp. More...

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

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

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

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

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

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

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

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

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

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

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable. 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 ()
	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 void	UseBoundsOn ()
	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 void	UseBoundsOff ()
	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 void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

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

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

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys. 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...

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)
	Add or remove or get or check a consumer,. More...

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,. More...

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

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

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

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

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)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

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)
	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, 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)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. 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	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...

void	PrintRevisions (ostream &)
	Legacy. More...

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

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

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

Static Public Member Functions inherited from vtkWidgetRepresentation
static vtkTypeBool	IsTypeOf (const char *type)
	Standard methods for instances of this class. More...

static vtkWidgetRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard methods for instances of this class. More...

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 ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

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

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

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 vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
	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)

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 ()
	These methods allow a command to exclusively grab all events. More...

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

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
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

typedef vtkWidgetRepresentation	Superclass
	Standard VTK methods. More...

static vtkTypeBool	IsTypeOf (const char *type)
	Standard VTK methods. More...

static vtkBalloonRepresentation *	SafeDownCast (vtkObjectBase *o)
	Standard VTK methods. More...

virtual vtkTypeBool	IsA (const char *type)
	Standard VTK methods. More...

vtkBalloonRepresentation *	NewInstance () const
	Standard VTK methods. More...

void	PrintSelf (ostream &os, vtkIndent indent) override
	Standard VTK methods. More...

virtual vtkObjectBase *	NewInstanceInternal () const
	Standard VTK methods. More...

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

Member Typedef Documentation

typedef vtkWidgetRepresentation vtkBalloonRepresentation::Superclass

Standard VTK methods.

Definition at line 94 of file vtkBalloonRepresentation.h.

Member Enumeration Documentation

anonymous enum

Enumerator
ImageLeft
ImageRight
ImageBottom
ImageTop

Definition at line 150 of file vtkBalloonRepresentation.h.

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

protected

vtkBalloonRepresentation::~vtkBalloonRepresentation ( )

overrideprotected

Member Function Documentation

static vtkBalloonRepresentation* vtkBalloonRepresentation::New ( )

static

Instantiate the class.

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

static

Standard VTK methods.

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

overridevirtual

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

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.

void vtkBalloonRepresentation::SetImageSize ( int [2] )

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.

virtual int* vtkBalloonRepresentation::GetImageSize ( )

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.

virtual void vtkBalloonRepresentation::GetImageSize	(	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.

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

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.

virtual void vtkBalloonRepresentation::SetTextProperty ( vtkTextProperty * p )

virtual

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

virtual vtkTextProperty* vtkBalloonRepresentation::GetTextProperty ( )

virtual

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

virtual void vtkBalloonRepresentation::SetFrameProperty ( vtkProperty2D * p )

virtual

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

The frame lies behind the text.

virtual vtkProperty2D* vtkBalloonRepresentation::GetFrameProperty ( )

virtual

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

The frame lies behind the text.

virtual void vtkBalloonRepresentation::SetImageProperty ( vtkProperty2D * p )

virtual

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

virtual vtkProperty2D* vtkBalloonRepresentation::GetImageProperty ( )

virtual

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

virtual void vtkBalloonRepresentation::SetBalloonLayout ( int )

virtual

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