Hikari::Position Struct Reference

#include <Position.h>

Public Member Functions
	Position ()
	Position (const RelativePosition &relPosition, short offsetLeft=0, short offsetTop=0)
	Position (short absoluteLeft, short absoluteTop)

Public Attributes
bool	usingRelative
union {
struct {
RelativePosition   position
short   x
short   y
}   rel
struct {
short   left
short   top
}   abs
}	data

Detailed Description

Used by HikariManager::createFlashOverlay to define the position of the overlay.

Definition at line 50 of file Position.h.

Constructor & Destructor Documentation

Position() [1/3]

Position::Position

(

)

Creates a default Position object (absolute, top-left corner).

Definition at line 26 of file Position.cpp.

Position() [2/3]

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

Creates a relatively-positioned Position object.

Parameters

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

Definition at line 33 of file Position.cpp.

Position() [3/3]

Position::Position	(	short	absoluteLeft,
		short	absoluteTop
	)

Creates an absolutely-positioned Position object.

Parameters

absoluteLeft	The number of pixels from the left of the Render Window.
absoluteTop	The number of pixels from the top of the Render Window.

Definition at line 41 of file Position.cpp.

Member Data Documentation

[struct]

struct { ... } Hikari::Position::abs

[union]

union { ... } Hikari::Position::data

left

short Hikari::Position::left

Definition at line 55 of file Position.h.

position

RelativePosition Hikari::Position::position

Definition at line 54 of file Position.h.

[struct]

struct { ... } Hikari::Position::rel

top

short Hikari::Position::top

Definition at line 55 of file Position.h.

usingRelative

bool Hikari::Position::usingRelative

Definition at line 52 of file Position.h.

x

short Hikari::Position::x

Definition at line 54 of file Position.h.

y

short Hikari::Position::y

Definition at line 54 of file Position.h.

---

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

• include/External/hikari/Position.h
• src/External/hikari/Position.cpp