A tooltip. More...

#include <tooltip.h>

Inheritance diagram for Engines::NWN::Tooltip:

Collaboration diagram for Engines::NWN::Tooltip:

[legend]

Classes
struct	Line

Public Types
enum	Type { kTypeHelp, kTypeFeedback, kTypeSpeech }

Public Member Functions
	Tooltip (Type type)

	Tooltip (Type type, Widget &parent)

	Tooltip (Type type, Graphics::Aurora::Model &parent)

	~Tooltip ()

void	clearLines ()

void	clearPortrait ()

void	addLine (const Common::UString &text, float r, float g, float b, float a)

void	setPortrait (const Common::UString &image)

void	setAlign (float align)

void	updatePosition ()

void	setPosition (float x, float y, float z)

void	show (uint32 delay, uint32 timeOut=0)
	Show the tooltip. More...

void	hide ()
	Hide the tooltip again. More...

Public Member Functions inherited from Events::Notifyable
	Notifyable ()

virtual	~Notifyable ()

Static Public Member Functions
static uint32	getDefaultDelay ()
	Returns the configured default delay, in ms, before a tooltip appears. More...

Protected Member Functions
void	notifyCameraMoved ()

Private Member Functions
void	getSize (float &width, float &height)

void	checkEmpty ()

void	redoLines (bool force=false)

void	redoBubble ()

void	redoLayout ()

bool	createTexts (float width, size_t maxLines=0)

void	deleteTexts ()

uint32	doShow (uint32 oldInterval)

uint32	doHide (uint32 oldInterval)

void	doShow ()

void	doHide ()

void	getFeedbackMode (bool &showBubble, bool &showText, bool &showPortrait) const

bool	getParentPosition (float &x, float &y, float &z) const

Static Private Member Functions
static Common::UString	getFontName ()

static Common::UString	getBubbleModel (uint32 lines, float width)

Private Attributes
Type	_type

Widget *	_parentWidget

Graphics::Aurora::Model *	_parentModel

bool	_empty

bool	_visible

float	_align

bool	_showText

bool	_showBubble

bool	_showPortrait

Common::ScopedPtr< Graphics::Aurora::Model >	_bubble

Common::ScopedPtr< Portrait >	_portrait

std::vector< Line >	_lines

Common::PtrVector< Graphics::Aurora::Text >	_texts

bool	_offscreen

float	_x

float	_y

float	_z

float	_lineHeight

float	_lineSpacing

float	_width

float	_height

Common::UString	_font

Events::TimerHandle	_timerShow

Events::TimerHandle	_timerHide

bool	_needCamera

bool	_detectEdge

Common::Mutex	_mutex

Detailed Description

A tooltip.

Definition at line 50 of file tooltip.h.

Member Enumeration Documentation

◆ Type

enum Engines::NWN::Tooltip::Type

Enumerator
kTypeHelp	Help string when mousing over a GUI widget.
kTypeFeedback	Name and/or portrait of an object in the 3D world.
kTypeSpeech	A scripted speech line on an object.

Definition at line 52 of file tooltip.h.

Constructor & Destructor Documentation

◆ Tooltip() [1/3]

Engines::NWN::Tooltip::Tooltip ( Type type )

Definition at line 49 of file tooltip.cpp.

References _showBubble, _showPortrait, _showText, and getFeedbackMode().

Here is the call graph for this function:

◆ Tooltip() [2/3]

Engines::NWN::Tooltip::Tooltip	(	Type	type,
		Widget &	parent
	)

Definition at line 59 of file tooltip.cpp.

References _showBubble, _showPortrait, _showText, and getFeedbackMode().

Here is the call graph for this function:

◆ Tooltip() [3/3]

Engines::NWN::Tooltip::Tooltip	(	Type	type,
		Graphics::Aurora::Model &	parent
	)

Definition at line 69 of file tooltip.cpp.

References _showBubble, _showPortrait, _showText, and getFeedbackMode().

Here is the call graph for this function:

◆ ~Tooltip()

Engines::NWN::Tooltip::~Tooltip ( )

Definition at line 79 of file tooltip.cpp.

References deleteTexts(), and hide().

Here is the call graph for this function:

Member Function Documentation

◆ addLine()

void Engines::NWN::Tooltip::addLine	(	const Common::UString &	text,
		float	r,
		float	g,
		float	b,
		float	a
	)

Definition at line 101 of file tooltip.cpp.

References _lines, Common::UString::empty(), hide(), redoLines(), and Common::UString::split().

Here is the call graph for this function:

◆ checkEmpty()

void Engines::NWN::Tooltip::checkEmpty ( )

private

Definition at line 305 of file tooltip.cpp.

References _empty, _lines, and _portrait.

Referenced by redoLayout().

Here is the caller graph for this function:

◆ clearLines()

void Engines::NWN::Tooltip::clearLines ( )

Definition at line 85 of file tooltip.cpp.

References _lines, hide(), and redoLines().

Here is the call graph for this function:

◆ clearPortrait()

void Engines::NWN::Tooltip::clearPortrait ( )

Definition at line 93 of file tooltip.cpp.

References _portrait, hide(), and redoLayout().

Here is the call graph for this function:

◆ createTexts()

bool Engines::NWN::Tooltip::createTexts	(	float	width,
		size_t	maxLines = `0`
	)

private

Definition at line 313 of file tooltip.cpp.

References _font, _lines, _showBubble, _showPortrait, _texts, deleteTexts(), FontMan, Graphics::Aurora::FontHandle::getFont(), and Graphics::Font::split().

Referenced by redoLines().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteTexts()

void Engines::NWN::Tooltip::deleteTexts ( )

private

Definition at line 309 of file tooltip.cpp.

References _texts, and Common::PtrVector< T, Deallocator >::clear().

Referenced by createTexts(), and ~Tooltip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doHide() [1/2]

uint32 Engines::NWN::Tooltip::doHide ( uint32 oldInterval )

private

Definition at line 462 of file tooltip.cpp.

References _mutex, _timerShow, _visible, doHide(), and TimerMan.

Here is the call graph for this function:

◆ doHide() [2/2]

void Engines::NWN::Tooltip::doHide ( )

private

Definition at line 442 of file tooltip.cpp.

References _bubble, _portrait, _texts, and GfxMan.

Referenced by doHide(), hide(), show(), and updatePosition().

Here is the caller graph for this function:

◆ doShow() [1/2]

uint32 Engines::NWN::Tooltip::doShow ( uint32 oldInterval )

private

Definition at line 456 of file tooltip.cpp.

References _mutex, and doShow().

Here is the call graph for this function:

◆ doShow() [2/2]

void Engines::NWN::Tooltip::doShow ( )

private

Definition at line 424 of file tooltip.cpp.

References _bubble, _empty, _offscreen, _portrait, _showBubble, _showPortrait, _showText, _texts, _visible, and GfxMan.

Referenced by doShow(), show(), and updatePosition().

Here is the caller graph for this function:

◆ getBubbleModel()

Common::UString Engines::NWN::Tooltip::getBubbleModel	(	uint32	lines,
		float	width
	)

staticprivate

Definition at line 503 of file tooltip.cpp.

References Common::UString::format().

Referenced by redoBubble().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultDelay()

uint32 Engines::NWN::Tooltip::getDefaultDelay ( )

static

Returns the configured default delay, in ms, before a tooltip appears.

Definition at line 539 of file tooltip.cpp.

References ConfigMan.

Referenced by Engines::NWN::NWNWidget::enter(), and Engines::NWN::Object::showFeedbackTooltip().

Here is the caller graph for this function:

◆ getFeedbackMode()

void Engines::NWN::Tooltip::getFeedbackMode	(	bool &	showBubble,
		bool &	showText,
		bool &	showPortrait
	)		const

private

Definition at line 476 of file tooltip.cpp.

References _type, ConfigMan, kTypeHelp, and kTypeSpeech.

Referenced by redoLines(), and Tooltip().

Here is the caller graph for this function:

◆ getFontName()

Common::UString Engines::NWN::Tooltip::getFontName ( )

staticprivate

Definition at line 499 of file tooltip.cpp.

References ConfigMan.

Referenced by redoLayout(), and redoLines().

Here is the caller graph for this function:

◆ getParentPosition()

bool Engines::NWN::Tooltip::getParentPosition	(	float &	x,
		float &	y,
		float &	z
	)		const

private

Definition at line 147 of file tooltip.cpp.

References _parentModel, _parentWidget, Engines::Widget::getPosition(), Graphics::Aurora::Model::getTooltipAnchor(), and GfxMan.

Referenced by updatePosition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSize()

void Engines::NWN::Tooltip::getSize	(	float &	width,
		float &	height
	)

private

Definition at line 289 of file tooltip.cpp.

References _lineHeight, _lineSpacing, _portrait, _texts, and MAX().

Referenced by redoLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hide()

void Engines::NWN::Tooltip::hide ( )

Hide the tooltip again.

Definition at line 275 of file tooltip.cpp.

References _mutex, _timerHide, _timerShow, _visible, doHide(), and TimerMan.

Referenced by addLine(), clearLines(), clearPortrait(), setAlign(), setPortrait(), setPosition(), and ~Tooltip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ notifyCameraMoved()

void Engines::NWN::Tooltip::notifyCameraMoved ( )

protectedvirtual

Reimplemented from Events::Notifyable.

Definition at line 143 of file tooltip.cpp.

References updatePosition().

Here is the call graph for this function:

◆ redoBubble()

void Engines::NWN::Tooltip::redoBubble ( )

private

Definition at line 373 of file tooltip.cpp.

References _bubble, _height, _lineHeight, _lineSpacing, _showBubble, _width, Common::UString::c_str(), getBubbleModel(), Engines::loadModelGUI(), Common::ScopedPtrBase< T, Deallocator >::reset(), and warning().

Referenced by redoLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redoLayout()

void Engines::NWN::Tooltip::redoLayout ( )

private

Definition at line 398 of file tooltip.cpp.

References _empty, _font, _height, _lineHeight, _lineSpacing, _width, checkEmpty(), Common::UString::empty(), FontMan, Graphics::Aurora::FontHandle::getFont(), getFontName(), Graphics::Font::getHeight(), Graphics::Font::getLineSpacing(), getSize(), redoBubble(), and updatePosition().

Referenced by clearPortrait(), redoLines(), setAlign(), and setPortrait().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redoLines()

void Engines::NWN::Tooltip::redoLines ( bool force = false )

private

Definition at line 334 of file tooltip.cpp.

References _font, _height, _lineHeight, _lineSpacing, _showBubble, _showPortrait, _showText, _width, createTexts(), FontMan, getFeedbackMode(), Graphics::Aurora::FontHandle::getFont(), getFontName(), Graphics::Font::getHeight(), Graphics::Font::getLineSpacing(), and redoLayout().

Referenced by addLine(), clearLines(), and show().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAlign()

void Engines::NWN::Tooltip::setAlign ( float align )

Definition at line 136 of file tooltip.cpp.

References _align, hide(), and redoLayout().

Here is the call graph for this function:

◆ setPortrait()

void Engines::NWN::Tooltip::setPortrait ( const Common::UString & image )

Definition at line 125 of file tooltip.cpp.

References _portrait, hide(), Engines::NWN::Portrait::kSizeTiny, and redoLayout().

Here is the call graph for this function:

◆ setPosition()

void Engines::NWN::Tooltip::setPosition	(	float	x,
		float	y,
		float	z
	)

Definition at line 248 of file tooltip.cpp.

References _x, _y, _z, hide(), and updatePosition().

Here is the call graph for this function:

◆ show()

void Engines::NWN::Tooltip::show	(	uint32	delay,
		uint32	timeOut = `0`
	)

Show the tooltip.

Parameters

delay	Time in ms to wait before the tooltip appears. If delay is 0, the tooltip will appear immediately.
timeOut	Time in ms, after the tooltip appeared, before it will be automatically hidden again. If timeOut is 0, the tooltip will not be automatically hidden at all. To hide it, hide() has to be called.

Definition at line 258 of file tooltip.cpp.

References _empty, _timerHide, _timerShow, _visible, doHide(), doShow(), redoLines(), and TimerMan.

Here is the call graph for this function: