Wartbed:Framework

From Dark Omen Wiki

(Difference between revisions)
Jump to: navigation, search
(Classes: Added a few)
Line 47: Line 47:
{| class="prettytable" style="border:1px solid black; width:100%;"
{| class="prettytable" style="border:1px solid black; width:100%;"
! Symbol !! #include !! Description
! Symbol !! #include !! Description
 +
|-
 +
| Actor  || wb_Models.h ||
|-
|-
| [[Wartbed:Framework/Camera|Camera]] || wb_Kernel.h || Versatile camera abstraction that is designed for automate movement, focusing, swiveling, circling and orbiting operations.  
| [[Wartbed:Framework/Camera|Camera]] || wb_Kernel.h || Versatile camera abstraction that is designed for automate movement, focusing, swiveling, circling and orbiting operations.  
|-
|-
 +
| Order || wb_Orders.h ||
 +
|-
 +
| Orderable || wb_Orders.h ||
 +
|-
 +
| Progressive  || wb_Models.h ||
 +
|-
 +
| Prop  || wb_Models.h ||
 +
|-
 +
| Target  || wb_Target.h ||
 +
|-
 +
| TargetOrder  || wb_Orders.h || (Abstract) Base class for all orders specifically targeting another Model
 +
|}
 +
<br>
 +
<div style="background:black; color:white;">namespace '''wb::order'''</div>
 +
{| class="prettytable" style="border:1px solid black; width:100%;"
 +
! Symbol !! #include !! Description
 +
|-
 +
| Defend || wb_Orders.h || (Abstract)
 +
|-
 +
| Escort || wb_Orders.h ||
 +
|-
 +
| Hold || wb_Orders.h ||
 +
|-
 +
| Move || wb_Orders.h ||
 +
|-
 +
| Queue || wb_Orders.h || Stack of Orders used by Actor
|}
|}
 +
[[category:WARTBED]]
[[category:WARTBED]]
[[category:API Reference]]
[[category:API Reference]]

Revision as of 16:43, 25 January 2010

Stub page the may be updated as I go along. Does not in anyway represent the current state of the WARTBED code base.

Reference for WARTBED development framework

See also the The WARTBED Manual

Namespaces

wb // main WARTBED namespace
{
WARTBED-common namespaces
camera { enums for controlling a WARTBED Camera object }
gui { all things CEGUI and GUI are encapsulated here }
input { all input-related aspects are collected here }
mvc { contains the base classes for the Model-View-Controller architecture }
ogre { all things OGRE are encapsulated here }
order { the order queue and all specific order classes are contained here }
Modules
darkomen { Code specific to handle Warhammer: Dark Omen }
}

Input Listeners

OGRE and WARTBED uses listener objects to capture and respond to user input. The raw input is then promulgated to event managers and/or the GUI system for handling. Gererally, WARTBED creates the appropriate or sufficient listener objects by default, replacing the old:

  • When OGRE is initialised through ogre::BootSystem() basic inert listeners are created. These are unresponsive and cause no events.
  • When CEGUI is initialised through ogre::InitialiseCEGUI() wb::gui::KeyListener and wb::gui::MouseListener objects are created. These objects forward raw input into the GUI system.
  • When the Wartbed object is created (first time Wartbed::getInstance() is called) basic wb::KeyListener and wb::MouseListener (which are aliases for wb::input::KeyListener and wb::input::MouseListener) are created. These listeners cause WARTBED input events but are unconcerned with the GUI.
  • When the GUI is initialised through Wartbed::initialiseGUI() (when the Wartbed::GUI singleton is first created) default listeners inheriting from both input::*Listener and gui::*Listener are created.

If further specialisation is required appropriate classes must be defined by the client application.

Classes

namespace ::
Symbol #include Description
Wartbed Wartbed.h Framework initialisation object. When created will boot OGRE and initialise all basic facilities.


namespace wb
Symbol #include Description
Actor wb_Models.h
Camera wb_Kernel.h Versatile camera abstraction that is designed for automate movement, focusing, swiveling, circling and orbiting operations.
Order wb_Orders.h
Orderable wb_Orders.h
Progressive wb_Models.h
Prop wb_Models.h
Target wb_Target.h
TargetOrder wb_Orders.h (Abstract) Base class for all orders specifically targeting another Model


namespace wb::order
Symbol #include Description
Defend wb_Orders.h (Abstract)
Escort wb_Orders.h
Hold wb_Orders.h
Move wb_Orders.h
Queue wb_Orders.h Stack of Orders used by Actor
Personal tools
communication