Wartbed:Framework

From Dark Omen Wiki

(Difference between revisions)
Jump to: navigation, search
m (2 revisions)
(→Classes: Added ''mvc'' namespace)
 
(8 intermediate revisions not shown)
Line 1: Line 1:
{{stub}}
{{stub}}
-
''Stub page the may be updated as I go along. Does not in anyway represent the current state of the WARTBED code base''.
+
:''Stub page the may be updated as I go along. Does not in anyway represent the current state of the WARTBED code base. This page will be replaced by an auto-generated JavaDoc (or similar) reference later.''
Reference for WARTBED development framework
Reference for WARTBED development framework
 +
 +
:''See also the [[Wartbed:Manual|The WARTBED Manual]]''
==Namespaces==
==Namespaces==
-
<tt>
+
<tt style="white-space:pre;">
-
:'''wb''' { <span style="color:green">main WARTBED namespace</span> }
+
:'''wb''' <span style="color:green">// main WARTBED namespace</span>
:{
:{
-
:''WARTBED-common namespaces''
+
:<span style="color:purple;">''WARTBED-common namespaces''</span>
-
::'''ogre'''    { <span style="color:green">all things OGRE are encapsulated here</span> }
+
-
::'''input'''  { <span style="color:green">all input-related aspects are collected here</span> }
+
::'''camera'''  { <span style="color:green">enums for controlling a WARTBED Camera object</span> }
::'''camera'''  { <span style="color:green">enums for controlling a WARTBED Camera object</span> }
 +
::'''gui'''    { <span style="color:green">all things CEGUI and GUI are encapsulated here</span> }
 +
::'''input'''  { <span style="color:green">all input-related aspects are collected here</span> }
 +
::'''mvc'''    { <span style="color:green">contains the base classes for the Model-View-Controller architecture</span> }
 +
::'''ogre'''    { <span style="color:green">all things OGRE are encapsulated here</span> }
 +
::'''order'''  { <span style="color:green">the order queue and all specific order classes are contained here</span> }
:
:
-
:''Modules''
+
:<span style="color:purple;">''Modules''</span>
-
::'''darkomen''' {} { <span style="color:green">Code specific to handle Warhammer: Dark Omen</span> }
+
:<span style="color:gray;">''It is quite likely that all module-specific namespaces will not be part of the WARTBED''</span>
 +
:<span style="color:gray;">''proper, but rather be used in separate Game-to-WARTBED conversion utilities''</span>
 +
::'''sothr'''    { <span style="color:green">Code specific to handle Warhammer: Shadow of the Horned Rat</span> }
 +
::'''darkomen''' { <span style="color:green">Code specific to handle Warhammer: Dark Omen</span> }
:}
:}
</tt>
</tt>
Line 21: Line 29:
==Classes==
==Classes==
 +
<div style="background:black; color:white;">namespace '''::'''</div>
 +
{| class="prettytable" style="border:1px solid black; width:100%;"
 +
! Symbol !! #include !! Description
 +
|-
 +
| [[Wartbed:Framework/Wartbed|Wartbed]] || Wartbed.h || Framework initialisation object. When created will boot OGRE and initialise all basic facilities.
 +
|-
 +
|}
 +
<br>
<div style="background:black; color:white;">namespace '''wb'''</div>
<div style="background:black; color:white;">namespace '''wb'''</div>
{| 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::mvc'''</div>
 +
{| class="prettytable" style="border:1px solid black; width:100%;"
 +
! Symbol !! #include !! Description
 +
|-
 +
| Controller || wb_MVC.h || Abstract base for classes facilitating interaction between users and views and the underlying simulation.
 +
|-
 +
| Model || wb_MVC.h || Game entities that constitutes the simulation
 +
|-
 +
| View || wb_MVC.h || Representations of the simulated universe
 +
|-
 +
|}
 +
<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) Base class for all orders designating a target to be defended
 +
|-
 +
| 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:API Reference]]

Current revision as of 13:53, 29 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. This page will be replaced by an auto-generated JavaDoc (or similar) reference later.

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
It is quite likely that all module-specific namespaces will not be part of the WARTBED
proper, but rather be used in separate Game-to-WARTBED conversion utilities
sothr { Code specific to handle Warhammer: Shadow of the Horned Rat }
darkomen { Code specific to handle Warhammer: Dark Omen }
}

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::mvc
Symbol #include Description
Controller wb_MVC.h Abstract base for classes facilitating interaction between users and views and the underlying simulation.
Model wb_MVC.h Game entities that constitutes the simulation
View wb_MVC.h Representations of the simulated universe


namespace wb::order
Symbol #include Description
Defend wb_Orders.h (Abstract) Base class for all orders designating a target to be defended
Escort wb_Orders.h
Hold wb_Orders.h
Move wb_Orders.h
Queue wb_Orders.h Stack of Orders used by Actor
Retrieved from "http://wiki.dark-omen.org/do/Wartbed:Framework"
Personal tools
communication