CAST II Game Engine

Class TCASTRootItem

Unit

Cast2

Declaration

type TCASTRootItem = class(TRootItem)

Description

An item of this class should be the root of items hierarchy

Hierarchy

TRootItem > TItem > TBaseItem

Fields

	Name	Description
	`StageSettings`	Clear settings for all render stages

Methods

Overview

	`constructor Create(AManager: TItemsManager); override;`
	`destructor Destroy; override;`
	`function AddCollection(Mask: TTraverseMask): Integer;`
	`procedure AddColliding(AItem: TProcessing);`
	`procedure AddProperties(const Result: Props.TProperties); override;`
	`procedure Collide;`
	`procedure DeleteCollection(Index: Integer);`
	`function ExtractByMaskClassInCamera(Mask: TItemFlags; AClass: CProcessing; out Items: TItems; ACamera: TCamera): Integer;`
	`function ExtractByMaskClassInRadius(Mask: TItemFlags; AClass: CProcessing; out Items: TItems; Origin: TLocation; Range: Single): Integer;`
	`procedure FreeChilds; override;`
	`function GetItemSize(CountChilds: Boolean): Integer; override;`
	`procedure HandleMessage(const Msg: TMessage); override;`
	`procedure RemoveColliding(AItem: TProcessing);`
	`procedure SetProperties(Properties: Props.TProperties); override;`
	`procedure TraverseTree(Callback: TTraverseCallback);`

Description

constructor Create(AManager: TItemsManager); override;

destructor Destroy; override;

function AddCollection(Mask: TTraverseMask): Integer;

Adds a collection of items with the specified state

procedure AddColliding(AItem: TProcessing);

Adds item's collision info to a collision manager

procedure AddProperties(const Result: Props.TProperties); override;

This procedure is called (by editor for example) to retrieve a list of item's properties and their values. Any TItem descendant class should override this method in order to add its own properties.

procedure Collide;

Performs a collision test. ToDo: move to core

procedure DeleteCollection(Index: Integer);

Removes collection specified by the index

function ExtractByMaskClassInCamera(Mask: TItemFlags; AClass: CProcessing; out Items: TItems; ACamera: TCamera): Integer;

Traverses through the items hierarchy and adds to Items all items matching the following:
the item is an instance of the given class or a descendant, its State field has matches Mask and the item is within visibility frustum of the given camera. Childs of items with non-matching State are not considered. Returns number of items in Items.

function ExtractByMaskClassInRadius(Mask: TItemFlags; AClass: CProcessing; out Items: TItems; Origin: TLocation; Range: Single): Integer;

Traverses through the items hierarchy and adds to Items all items matching the following:
the item is an instance of the given class or a descendant, its State field has matches Mask and the item is within the given range from the given origin. Childs of items with non-matching State are not considered. Returns number of items in Items.

procedure FreeChilds; override;

Frees all childs

function GetItemSize(CountChilds: Boolean): Integer; override;

procedure HandleMessage(const Msg: TMessage); override;

procedure RemoveColliding(AItem: TProcessing);

Removes item's collision info from a collision manager

procedure SetProperties(Properties: Props.TProperties); override;

This procedure is called (by editor for example) to set values of item's properties. Any TItem descendant class should override this method to allow its own properties to be set.

procedure TraverseTree(Callback: TTraverseCallback);

Traverses through the items hierarchy and calls Callback for all items