CAST II Game Engine

Class TProcessing

Unit

Cast2

Declaration

type TProcessing = class(TBaseProcessing)

Description

Base class of all processing (updateable) objects

Hierarchy

TBaseProcessing > TItem > TBaseItem

Fields

	Name	Description
	`BoundingBox`	Returns bounding box of the item
	`Colliding`	Contains information about bounding volumes of the item which will be used for collision tests
	`FLocation`	Current location of the item
	`FOrientation`	Current orientation of the item
	`FScale`	Current scale of the item
	`FTransform`	Transformation matrix of the item
	`TransformValid`

Methods

Overview

	`constructor Create(AManager: TItemsManager); override;`
	`destructor Destroy; override;`
	`procedure AddProperties(const Result: Props.TProperties); override;`
	`procedure ComputeTransform; virtual;`
	`function GetAbsLocation: TVector3s;`
	`function GetAbsOrientation: TQuaternion;`
	`function GetBoundingSphereRadius: Single;`
	`function GetDimensions: TVector3s;`
	`function GetForwardVector: TVector3s;`
	`function GetLocation: TLocation;`
	`function GetOrientation: TQuaternion;`
	`function GetPosition: TVector3s;`
	`function GetRightVector: TVector3s;`
	`function GetScale: TVector3s;`
	`function GetTransform: TMatrix4s;`
	`function GetUpVector: TVector3s;`
	`procedure InvalidateTransform; virtual;`
	`procedure OnCollision(Item: TProcessing; const ColRes: Collisions.TCollisionResult); virtual;`
	`function SetChild(Index: Integer; AItem: BaseClasses.TItem): BaseClasses.TItem; override;`
	`procedure SetLocation(ALocation: TLocation);`
	`procedure SetOrientation(AOrientation: TQuaternion);`
	`procedure SetPosition(const Value: TVector3s);`
	`procedure SetProperties(Properties: Props.TProperties); override;`
	`procedure SetScale(const Value: TVector3s);`
	`procedure SetTransform(const ATransform: TMatrix4s);`

Description

constructor Create(AManager: TItemsManager); override;

FullBoundingBox: Base3D.TBoundingBox;

destructor Destroy; override;

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 ComputeTransform; virtual;

In CAST II engine a lazy evaluation scheme used for transformation computations. This method will compute current transformation matrix when and only when it is necessary.

function GetAbsLocation: TVector3s;

Returns position of the item in world's coordinate space

function GetAbsOrientation: TQuaternion;

Returns orientation of the item in world's coordinate space

function GetBoundingSphereRadius: Single;

function GetDimensions: TVector3s;

function GetForwardVector: TVector3s;

function GetLocation: TLocation;

function GetOrientation: TQuaternion;

function GetPosition: TVector3s;

function GetRightVector: TVector3s;

function GetScale: TVector3s;

function GetTransform: TMatrix4s;

function GetUpVector: TVector3s;

procedure InvalidateTransform; virtual;

Calling this method will tell the engine that FTransform became invalid and should be recomputed before next use

procedure OnCollision(Item: TProcessing; const ColRes: Collisions.TCollisionResult); virtual;

Called when a collision of the item with another items was detected

function SetChild(Index: Integer; AItem: BaseClasses.TItem): BaseClasses.TItem; override;

Returns AItem if OK or nil if index is invalid or impossible to set a child

procedure SetLocation(ALocation: TLocation);

procedure SetOrientation(AOrientation: TQuaternion);

procedure SetPosition(const Value: TVector3s);

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 SetScale(const Value: TVector3s);

procedure SetTransform(const ATransform: TMatrix4s);

Properties

Overview

	`property BoundingSphereRadius: Single;`
	`property Dimensions: TVector3s;`
	`property ForwardVector: TVector3s;`
	`property Location: TLocation;`
	`property Orientation: TQuaternion;`
	`property Position: TVector3s;`
	`property RightVector: TVector3s;`
	`property Scale: TVector3s;`
	`property Transform: TMatrix4s;`
	`property UpVector: TVector3s;`

Description

property BoundingSphereRadius: Single;

The item's bounding sphere radius based on Dimensions

property Dimensions: TVector3s;

Dimensions of the item based on its bounding box (see BoundingBox)

property ForwardVector: TVector3s;

Forward direction for the item

property Location: TLocation;

4-component position of the item within parent's coordinate space

property Orientation: TQuaternion;

Orientation of the item within parent's coordinate space

property Position: TVector3s;

Position of the item within parent's coordinate space

property RightVector: TVector3s;

Right direction for the item

property Scale: TVector3s;

Scale of the item within parent's coordinate space

property Transform: TMatrix4s;

Transformation matrix of the item

property UpVector: TVector3s;

Up direction for the item