hydroqguielementutil Namespace Reference

Defines levels for z-buffering in views. Simple z-buffering, higher-z items obscure (are in front of) lower-z items (just like QCanvas) only z levels between Z_BACKGROUND and Z_FOREGROUND inclusively are painted. More...

Classes
class	Cov2d
struct	GuiElementInfo
	Essential information required by all GUI elements. More...
struct	GuiElementStuff
	Information common to all GUI elements. More...
class	GuiElement
	A basic GUI component with a type and a unique ID. More...
class	GuiElement2d
class	IHumanManager
	Interface for managing the humans: allows display of messages and access to menus/tool-bars. More...
class	IKnowsPlatformPosition2d
	GUIs need to paint some things centred on a platform's position. Inheriting from this interface means that the GUI element knows where the platform is located. More...
class	MouseEventManager
	Manages sharing of mouse events: a global resource. More...
class	PoseHistory
class	ScopedSaver
class	ShortcutKeyManager
	manages sharing of shortcut keys (a global resource) between GuiElements. More...
class	ShortcutKeyReservation
	a RAII tool for managing reservations on shortcut-keys: unsubscribes when it falls out of scope. More...
Functions
void	paintOrigin (QPainter *p, const QColor &colour, float radius, float lineThickness=0.2)
	Paint crosshairs with length of cross = 2 x radius.
void	paintCylindricalPlatformPose (QPainter *p, float radius, float transparencyMultiplier=1.0, float minRadius=0.0)
	As above but paints a circular platform.
void	paintCubicPlatformPose (QPainter *p, float length, float width, float transparencyMultiplier, float minLength)
void	paintUncertaintyWedge (QPainter *p, float ptt, float length)
	Paints a little wedge of sidelength 'length' representing rotational uncertainty.
void	paintCovarianceEllipse (QPainter *p, float pxx, float pxy, float pyy)
	Paints 2-sigma ellipse for the position uncertainty.
QColor	getTransparentVersion (const QColor &c, float opacity)
QColor	getDarkVersion (const QColor &color)
	Get a darker version of the given colour.
void	paintWaypoint (QPainter *p, const QColor &fillColor, const QColor &drawColor, int targetHeading,float distanceTolerance, int headingTolerance)
	Paint a waypoint with distance tolerance [m] as a circle and heading tolerance [deg/16] as a wedge around targetHeading [deg].
double	worldMatrixScale (QPainter *p)

---

Detailed Description

Defines levels for z-buffering in views. Simple z-buffering, higher-z items obscure (are in front of) lower-z items (just like QCanvas) only z levels between Z_BACKGROUND and Z_FOREGROUND inclusively are painted.

Library useful to build Qt GUI elements for 2d robotics applications.

Note: It's important that the paintable levels are 1->12 inclusive. If this changes, remember to change qgraphics2d also!

This namespace is part of a library which contains classes for building Qt GUI elements for 2d robotics applications.

See also:

libHydroQGuiElementUtil

---

Function Documentation

QColor hydroqguielementutil::getTransparentVersion	(	const QColor &	c,
		float	opacity = 0.5
	)

Get a more transparent version of the given colour opacity=1.0 gives the same colour.

void hydroqguielementutil::paintCubicPlatformPose	(	QPainter *	p,
		float	length,
		float	width,
		float	transparencyMultiplier = 1.0,
		float	minLength = 0.0
	)

Paints a rectangular robot icon. All physical units are in meters. The painter needs to be translated and rotated before calling this function. The robot's geometry extends around the painter's current position. If minLength is specified, the robot is never painted smaller than this, independent of the zoom configuration.

double hydroqguielementutil::worldMatrixScale

(

QPainter *

p

)

Returns the scaling factor currently associated with the painter's worldMatrix. The units are pixels/metre. (Note that in general there's an x and a y scaling factor, but we assume that x and y are scaled equally).