Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

ogs::core::Size Class Reference

A size category. More...

#include <Size.h>

Collaboration diagram for ogs::core::Size:

Collaboration graph
[legend]
List of all members.

Public Types

enum  Type {
  FINE = 'F', DIMINUITIVE = 'D', TINY = 'T', SMALL = 'S',
  MEDIUM = 'M', LARGE = 'L', HUGE = 'H', GARGANTUAN = 'G',
  COLLOSAL = 'C'
}
 An integer type that represents a category of sizes. More...


Public Member Functions

 Size (Type type=MEDIUM)
 Create a new size.

Type getType () const
 Determine the category of this size.

Modifier & getDefenseModifier ()
 Access the defense modifier for this size.


Detailed Description

The overall size of an entity falls into one of nine categories.


Member Enumeration Documentation

enum ogs::core::Size::Type
 

Enumeration values:
FINE  Small enough to hold dozens in one hand.
DIMINUITIVE  Small enough to hold in one hand.
TINY  Small enough to hold in both hands.
SMALL  Roughly the size of a human child.
MEDIUM  Roughly the size of an average human.
LARGE  Slightly larger than an average human.
HUGE  As big as a tree.
GARGANTUAN  As big as a house.
COLLOSAL  As big as a castle.


Constructor & Destructor Documentation

ogs::core::Size::Size (  Type  type = MEDIUM  )  [inline]
 

Parameters:
type Type of size (FINE, DIMINUITIVE, TINY, ...)


Member Function Documentation

Modifier & ogs::core::Size::getDefenseModifier (   )  [inline]
 

Returns:
Defnese modifier.

Size::Type ogs::core::Size::getType (   )  const [inline]
 

Returns:
Type of size (FINE, DIMINUITIVE, TINY, ...)


The documentation for this class was generated from the following file:
Generated on Sun Apr 20 03:38:22 2003 for Open Gaming System (OGS) by doxygen1.3