SmTooltipKit Class Reference

The SmTooltipKit class... More...

#include <SmTooltipKit.h>

Inheritance diagram for SmTooltipKit:

Public Member Functions
	SmTooltipKit (void)
virtual void	audioRender (SoAudioRenderAction *action)
virtual void	callback (SoCallbackAction *action)
virtual void	getBoundingBox (SoGetBoundingBoxAction *action)
virtual void	getMatrix (SoGetMatrixAction *action)
virtual void	getPrimitiveCount (SoGetPrimitiveCountAction *action)
virtual void	GLRender (SoGLRenderAction *action)
virtual void	handleEvent (SoHandleEventAction *action)
virtual void	pick (SoPickAction *action)
virtual void	rayPick (SoRayPickAction *action)
virtual void	search (SoSearchAction *action)
void	setPickedPoint (const SoPickedPoint *pp, const SbViewportRegion &vp)
void	setPickedPosition (const SbVec2f &pos, const SbViewportRegion &vp)
void	setViewportRegion (const SbViewportRegion &vp)

Static Public Member Functions
static void	initClass (void)

Public Attributes
SoSFBool	autoTrigger
SoSFTime	autoTriggerTime
SoMFString	description
SoSFInt32	frameSize
SoSFBool	isActive
SoSFVec2s	offset

Protected Member Functions
virtual	~SmTooltipKit ()
virtual SbBool	affectsState (void) const

Detailed Description

The SmTooltipKit class...

FIXME: doc

Constructor & Destructor Documentation

SmTooltipKit()

SmTooltipKit::SmTooltipKit

(

void

)

Constructor.

~SmTooltipKit()

SmTooltipKit::~SmTooltipKit ( void )

protectedvirtual

Destructor.

Member Function Documentation

setPickedPoint()

void SmTooltipKit::setPickedPoint	(	const SoPickedPoint *	pp,
		const SbViewportRegion &	vp )

Convenience function that uses an SoPickedPoint to calculate the position of the tooltip.

setViewportRegion()

void SmTooltipKit::setViewportRegion

(

const SbViewportRegion &

vp

)

Sets the current viewport region. The viewport region will also be picked up when the node is traversed with SoGLRenderAction.

Member Data Documentation

autoTrigger

SoSFBool SmTooltipKit::autoTrigger

When TRUE, will search for SmTooltip nodes in front of shapes and pop up a tooltip when the mouse pointer has been resting over an object for over autoTriggerTime seconds. Default value is FALSE.

autoTriggerTime

SoSFBool SmTooltipKit::autoTriggerTime

The time before the tooltip triggers. Default value is 1.0.

description

SoMFString SmTooltipKit::description

The tooltip string.

frameSize

SoSFInt32 SmTooltipKit::frameSize

The amount of extra pixels around the frame. The default value is 3.

isActive

SoSFBool SmTooltipKit::isActive

TRUE when tooltip is active, FALSE otherwise.

---

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

• SmTooltipKit.h
• SmTooltipKit.cpp