CAST II Game Engine

   DESCRIPTION       FEATURES       SCREENSHOTS       FORUMS       DOCUMENTATION       DOWNLOADS       CONTACTS   
Units
Class Hierarchy
Classes, Interfaces and Objects
Types
Enumerations
Variables
Constants
Functions and Procedures
Identifiers

Unit BaseClasses

Description

Basic classes unit

(C) 2006-2007 George "Mirage" Bakhtadze. www.casteng.com
The source code may be used under either MPL 1.1 or LGPL 2.1 license. See included license.txt file
Unit contains basic item-related classes

Classes, Interfaces and Objects

NameDescription
Class TAbstractCompilerAbstract compiler class
Class TBaseProcessingBase class of all items which periodically updates their state
Class TClassesList 
Class TDummyItemUsed to group items within a hierarchy
Class TItemBase item class
Class TItemsManagerContains and manages a hierarchy of items starting with Root
Class TRootItemProvides some item extraction methods
Class TSceneLoadError 

Functions and Procedures

Overview

function GetClassList(AClasses: array of TClass): TClassArray;
procedure MergeClassLists(var BaseList: TClassArray; AddOnList: array of TClass);

Description

function GetClassList(AClasses: array of TClass): TClassArray;

Retuns a list of the specified classes

procedure MergeClassLists(var BaseList: TClassArray; AddOnList: array of TClass);

Merges the two given class lists

Types

Overview

CItem = of TItem;
Float = Single;
TClassArray = array of TClass;
TClassRec = record ItemClass: TClass; ModuleName: TShortName; end;
TExtractCondition = set of TExtractConditionItems;
TExtractConditionFunc = function(Item: TItem): TExtractCondition of object;
TItemFlags = TSet32;
TItems = array of TItem;
TProcessingClass = record Interval: Float; Flags: TProcessingFlags; end;
TProcessingFlags = set of TProcessingFlag;

Description

CItem = of TItem;

Item class type

Float = Single;

Main floating point type

TClassArray = array of TClass;

Used for classes registration

TClassRec = record ItemClass: TClass; ModuleName: TShortName; end;

 

TExtractCondition = set of TExtractConditionItems;

Extract condition function result type

TExtractConditionFunc = function(Item: TItem): TExtractCondition of object;

Condition function for conditional extraction

TItemFlags = TSet32;

Item flag set

TItems = array of TItem;

Simple items collection

TProcessingClass = record Interval: Float; Flags: TProcessingFlags; end;

Processing options for processing classes (see TItemsManager). Interval - process interval in seconds. Flags - see TProcessingFlag

TProcessingFlags = set of TProcessingFlag;

Set of item processing flags

Enumerations

TExtractConditionItems
Extract condition function result flags
 ecPassedcondition passed
 ecBreakHierarchydo not follow current hierarchy
 ecBreakcompletely stop traverse
TIMState
Items manager state
 imsLoadingthe manager is currently loading items
 imsShuttingDownthe manager is currently shutting down
TItemMoveMode
Item move modes
 mmInsertBeforeinsert before
 mmInsertAfterinsert after
 mmAddChildFirstadd as first child
 mmAddChildLastadd as last child
 mmMoveUpmove up within the current level
 mmMoveDownmove down within the current level
 mmMoveLeftmove up one level
 mmMoveRightmove down one level
TProcessingFlag
Item processing flags
 pfIgnorePauseforce processing even when pause mode is on
 pfDeltaTimeBasedprocess as frequent as possible ignoring Interval

Constants

Overview

ChildsCapacityStep = 8;
CollectionsCapacityStep = 16;
HiddenStates = 4;
HierarchyDelimiter = '\';
isDrawVolumes = 6;
isNeedInit = 2;
isPicked = 3;
isProcessing = 5;
isReleased = 1;
isRemoved = 0;
isVisible = 4;
ItemsCapacityStep = 16;
MaxStates = 32;
ParentAdressName = '.';

Description

ChildsCapacityStep = 8;

Childs collection capacity increment step

CollectionsCapacityStep = 16;

Collections capacity increment step

HiddenStates = 4;

First HiddenStates states will not be visible in editor

HierarchyDelimiter = '\';

Hierarchy delimiter

isDrawVolumes = 6;

Visualize item's debug information (bounding boxes, etc)

isNeedInit = 2;

An item hasn't been initialized yet

isPicked = 3;

Visualize item's selection information with a color defined by Globals.PickedBoxColor

isProcessing = 5;

Process method of an item should be called according to its ProcessingClass field

isReleased = 1;

An item was marked to release

isRemoved = 0;

An item was removed from manager or marked to remove

isVisible = 4;

An item should be visualised

ItemsCapacityStep = 16;

Items collection capacity increment step

MaxStates = 32;

Maximum possible item state flags

ParentAdressName = '.';

A simbol to address upper level of hierarchy in relative item names

Variables

Overview

GlobalClassList: TClassesList;

Description

GlobalClassList: TClassesList;

 

Last modified: 4 Jul, 2008
Copyright (C) 2006-2008, casteng.com