Sirikata::OverlayPosition Class Reference

Describes the position of a viewport-overlay in relative/absolute metrics. More...

#include <OverlayPosition.hpp>

Collaboration diagram for Sirikata::OverlayPosition:

List of all members.

Public Member Functions
	OverlayPosition (const RelativePosition &relPosition, short offsetLeft=0, short offsetTop=0)
	Creates a relatively-positioned OverlayPosition object.
	OverlayPosition (short absoluteLeft, short absoluteTop)
	Creates an absolutely-positioned OverlayPosition object.
	OverlayPosition ()
	Creates an empty OverlayPosition object (defaults to top-left corner).
Public Attributes
bool	usingRelative
union {
struct {
RelativePosition   position
short   x
short   y
}   rel
struct {
short   left
short   top
}   abs
}	data

---

Detailed Description

Describes the position of a viewport-overlay in relative/absolute metrics.

Used by WebViewListener and ProxyWebViewObject.

---

Constructor & Destructor Documentation

Sirikata::OverlayPosition::OverlayPosition	(	const RelativePosition &	relPosition,
		short	offsetLeft = 0,
		short	offsetTop = 0
	)

Creates a relatively-positioned OverlayPosition object.

Parameters:

relPosition	The position of the ViewportOverlay in relation to the Viewport
offsetLeft	How many pixels from the left to offset the ViewportOverlay from the relative position.
offsetTop	How many pixels from the top to offset the ViewportOverlay from the relative position.

References data, and usingRelative.

Sirikata::OverlayPosition::OverlayPosition	(	short	absoluteLeft,
		short	absoluteTop
	)

Creates an absolutely-positioned OverlayPosition object.

Parameters:

absoluteLeft	The number of pixels from the left of the Viewport
absoluteTop	The number of pixels from the top of the Viewport.

References data, and usingRelative.

Sirikata::OverlayPosition::OverlayPosition

(

)

Creates an empty OverlayPosition object (defaults to top-left corner).

References data, and usingRelative.

---

Member Data Documentation

struct { ... } Sirikata::OverlayPosition::abs

Referenced by Sirikata::Graphics::ViewportOverlay::resetPosition().

union { ... } Sirikata::OverlayPosition::data

Referenced by OverlayPosition(), and Sirikata::Graphics::ViewportOverlay::resetPosition().

short Sirikata::OverlayPosition::left

RelativePosition Sirikata::OverlayPosition::position

struct { ... } Sirikata::OverlayPosition::rel

Referenced by Sirikata::Graphics::ViewportOverlay::resetPosition().

short Sirikata::OverlayPosition::top

bool Sirikata::OverlayPosition::usingRelative

Referenced by OverlayPosition(), and Sirikata::Graphics::ViewportOverlay::resetPosition().

short Sirikata::OverlayPosition::x

short Sirikata::OverlayPosition::y

---

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

• libogre/include/sirikata/ogre/OverlayPosition.hpp
• libogre/src/OverlayPosition.cpp