xoreos  0.0.5
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
Engines::KotOR::HUD Class Reference

#include <hud.h>

Inheritance diagram for Engines::KotOR::HUD:
Inheritance graph
[legend]
Collaboration diagram for Engines::KotOR::HUD:
Collaboration graph
[legend]

Public Member Functions

 HUD (Module &module, ::Engines::Console *console=0)
 
void setReturnStrref (uint32 id)
 
void setReturnQueryStrref (uint32 id)
 
void setReturnEnabled (bool)
 
void setMinimap (const Common::UString &map, int northAxis, float worldPt1X, float worldPt1Y, float worldPt2X, float worldPt2Y, float mapPt1X, float mapPt1Y, float mapPt2X, float mapPt2Y)
 
void setPosition (float x, float y)
 
void setRotation (float angle)
 
void showContainer (Inventory &inv)
 
void setPartyLeader (Creature *creature)
 
void setPartyMember1 (Creature *creature)
 
void setPartyMember2 (Creature *creature)
 
- Public Member Functions inherited from Engines::KotOR::GUI
 GUI (::Engines::Console *console=0)
 
 ~GUI ()
 
virtual void show ()
 Show the GUI. More...
 
virtual void hide ()
 Hide the GUI. More...
 
void convertToXoreos (float &x, float &y, const float widgetHeight) const
 Converts Kotor' GUI coordinates with a coordinate origin in the upper left corner to the Xoreos coordinate system with the coordinate origin in the center. More...
 
void convertToGUI (float &x, float &y, const float widgetHeight) const
 Converts Xoreos' coordinates with a coordinate origin in the center to Kotor's GUI coordinates with the coordinate origin in the the upper left corner. More...
 
Common::UString getName () const
 
- Public Member Functions inherited from Engines::GUI
 GUI (Console *console=0)
 
uint32 run (uint32 startCode=kStartCodeNone)
 Run the GUI. More...
 
virtual void abort ()
 Abort the currently running GUI. More...
 
void addEvent (const Events::Event &event)
 Add a single event for consideration into the GUI event queue. More...
 
uint32 processEventQueue ()
 Process the current event queue. More...
 

Protected Member Functions

virtual void callbackActive (Widget &widget)
 Callback that's triggered when a widget was activated. More...
 
- Protected Member Functions inherited from Engines::KotOR::GUI
virtual void mouseUp ()
 The mouse state has changed. More...
 
virtual void mouseDown ()
 
void load (const Common::UString &resref)
 
WidgetPanelgetPanel (const Common::UString &tag, bool vital=false)
 
WidgetLabelgetLabel (const Common::UString &tag, bool vital=false)
 
WidgetProtoItemgetProtoItem (const Common::UString &tag, bool vital=false)
 
WidgetButtongetButton (const Common::UString &tag, bool vital=false)
 
WidgetCheckBoxgetCheckBox (const Common::UString &tag, bool vital=false)
 
WidgetSlidergetSlider (const Common::UString &tag, bool vital=false)
 
WidgetScrollbargetScrollbar (const Common::UString &tag, bool vital=false)
 
WidgetProgressbargetProgressbar (const Common::UString &tag, bool vital=false)
 
WidgetListBoxgetListBox (const Common::UString &tag, bool vital=false)
 
void addBackground (const Common::UString &background, bool front=false)
 
void setCheckBoxState (const Common::UString &tag, bool state)
 
bool getCheckBoxState (const Common::UString &tag)
 
- Protected Member Functions inherited from Engines::GUI
void addWidget (Widget *widget)
 Add a widget. More...
 
void removeWidget (Widget *widget)
 Remove a widget. More...
 
void clearWidgets ()
 Clear all widgets. More...
 
bool empty ()
 Check if the gui is currently empty. More...
 
bool hasWidget (const Common::UString &tag) const
 Does this specific widget exist within the GUI? More...
 
WidgetgetWidget (const Common::UString &tag, bool vital=false)
 Return a widget in the GUI. More...
 
const WidgetgetWidget (const Common::UString &tag, bool vital=false) const
 Return a widget in the GUI. More...
 
void declareGroup (const std::list< Widget *> &group)
 Put these widgets together into a group. More...
 
void removeFocus ()
 Forcefully remove the focus from the current widget. More...
 
void updateMouse ()
 Force an update of the mouse position. More...
 
uint32 sub (GUI &gui, uint32 startCode=kStartCodeNone, bool showSelf=true, bool hideSelf=true)
 Open up a sub GUI. More...
 
void setPosition (float x, float y, float z)
 Set the GUI's position. More...
 
void getPosition (float &x, float &y, float &z) const
 Get the GUI's position. More...
 
virtual void callbackRun ()
 Callback that's triggered periodically in the run() method. More...
 
virtual void callbackTextInput (const Common::UString &text)
 Callback that's triggered when a text input is received. More...
 
virtual void callbackKeyInput (const Events::Key &key, const Events::EventType &type)
 Callback that's triggered when a key is pressed or released. More...
 
void addChild (GUI *gui)
 Add a child GUI object to this GUI. More...
 
void removeChild (GUI *gui)
 Remove a child GUI object from this GUI. More...
 

Private Member Functions

void update (int width, int height)
 
void initWidget (Widget &widget)
 
void setPortrait (uint8 n, bool visible, const Common::UString &portrait="")
 
void notifyResized (int oldWidth, int oldHeight, int newWidth, int newHeight)
 
- Private Member Functions inherited from Events::Notifyable
 Notifyable ()
 
virtual ~Notifyable ()
 

Private Attributes

Module_module
 
Menu _menu
 
Common::ScopedPtr< ContainerMenu_container
 
Common::ScopedPtr< Minimap_minimap
 
WidgetLabel_minimapPointer
 

Additional Inherited Members

- Static Public Attributes inherited from Engines::GUI
static const uint32 kStartCodeNone = 0
 
static const uint32 kReturnCodeNone = 0
 
static const uint32 kReturnCodeAbort = 0xFFFFFFFF
 
- Protected Types inherited from Engines::KotOR::GUI
enum  WidgetType {
  kWidgetTypeInvalid = - 1, kWidgetTypePanel = 2, kWidgetTypeLabel = 4, kWidgetTypeProtoItem = 5,
  kWidgetTypeButton = 6, kWidgetTypeCheckBox = 7, kWidgetTypeSlider = 8, kWidgetTypeScrollbar = 9,
  kWidgetTypeProgressbar = 10, kWidgetTypeListBox = 11
}
 
- Protected Attributes inherited from Engines::GUI
Console_console
 
Widget_currentWidget
 The widget the mouse is currently on. More...
 
uint32 _startCode
 The GUI's start code. More...
 
uint32 _returnCode
 The GUI's return code. More...
 
GUI_sub
 The currently running sub GUI. More...
 

Detailed Description

Definition at line 45 of file hud.h.

Constructor & Destructor Documentation

◆ HUD()

Engines::KotOR::HUD::HUD ( Module module,
::Engines::Console console = 0 
)

Member Function Documentation

◆ callbackActive()

void Engines::KotOR::HUD::callbackActive ( Widget widget)
protectedvirtual

Callback that's triggered when a widget was activated.

Reimplemented from Engines::GUI.

Definition at line 408 of file hud.cpp.

References Engines::Widget::getTag().

Here is the call graph for this function:

◆ initWidget()

void Engines::KotOR::HUD::initWidget ( Engines::Widget widget)
privatevirtual

Reimplemented from Engines::KotOR::GUI.

Definition at line 384 of file hud.cpp.

References Common::UString::contains(), Engines::Widget::getTag(), Engines::Widget::setInvisible(), and Common::UString::size().

Here is the call graph for this function:

◆ notifyResized()

void Engines::KotOR::HUD::notifyResized ( int  oldWidth,
int  oldHeight,
int  newWidth,
int  newHeight 
)
privatevirtual

Reimplemented from Events::Notifyable.

Definition at line 426 of file hud.cpp.

◆ setMinimap()

void Engines::KotOR::HUD::setMinimap ( const Common::UString map,
int  northAxis,
float  worldPt1X,
float  worldPt1Y,
float  worldPt2X,
float  worldPt2Y,
float  mapPt1X,
float  mapPt1Y,
float  mapPt2X,
float  mapPt2Y 
)

Definition at line 215 of file hud.cpp.

References GfxMan, Engines::KotORJadeWidget::setSubScene(), and warning().

Here is the call graph for this function:

◆ setPartyLeader()

void Engines::KotOR::HUD::setPartyLeader ( Creature creature)

Definition at line 300 of file hud.cpp.

References Engines::KotOR::Object::getPortrait().

Here is the call graph for this function:

◆ setPartyMember1()

void Engines::KotOR::HUD::setPartyMember1 ( Creature creature)

Definition at line 304 of file hud.cpp.

References Engines::KotOR::Object::getPortrait().

Here is the call graph for this function:

◆ setPartyMember2()

void Engines::KotOR::HUD::setPartyMember2 ( Creature creature)

Definition at line 308 of file hud.cpp.

References Engines::KotOR::Object::getPortrait().

Here is the call graph for this function:

◆ setPortrait()

void Engines::KotOR::HUD::setPortrait ( uint8  n,
bool  visible,
const Common::UString portrait = "" 
)
private

◆ setPosition()

void Engines::KotOR::HUD::setPosition ( float  x,
float  y 
)

Definition at line 233 of file hud.cpp.

◆ setReturnEnabled()

void Engines::KotOR::HUD::setReturnEnabled ( bool  enabled)

Definition at line 211 of file hud.cpp.

◆ setReturnQueryStrref()

void Engines::KotOR::HUD::setReturnQueryStrref ( uint32  id)

Definition at line 207 of file hud.cpp.

◆ setReturnStrref()

void Engines::KotOR::HUD::setReturnStrref ( uint32  id)

Definition at line 203 of file hud.cpp.

◆ setRotation()

void Engines::KotOR::HUD::setRotation ( float  angle)

Definition at line 238 of file hud.cpp.

References warning().

Here is the call graph for this function:

◆ showContainer()

void Engines::KotOR::HUD::showContainer ( Inventory inv)

Definition at line 251 of file hud.cpp.

References Engines::KotOR::Inventory::addItem(), Engines::KotOR::Inventory::getItems(), and Engines::KotOR::Inventory::removeAllItems().

Here is the call graph for this function:

◆ update()

void Engines::KotOR::HUD::update ( int  width,
int  height 
)
private

Member Data Documentation

◆ _container

Common::ScopedPtr<ContainerMenu> Engines::KotOR::HUD::_container
private

Definition at line 69 of file hud.h.

◆ _menu

Menu Engines::KotOR::HUD::_menu
private

Definition at line 68 of file hud.h.

◆ _minimap

Common::ScopedPtr<Minimap> Engines::KotOR::HUD::_minimap
private

Definition at line 71 of file hud.h.

◆ _minimapPointer

WidgetLabel* Engines::KotOR::HUD::_minimapPointer
private

Definition at line 72 of file hud.h.

◆ _module

Module* Engines::KotOR::HUD::_module
private

Definition at line 67 of file hud.h.


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