Castle Game Engine

Class TStructList

Description
Hierarchy
Nested Types
Fields
Methods
Properties

Unit

CastleUtils

Declaration

type TStructList<T> = class(TList<T>)

Description

List of structures. This is just TList class from Generics.Collections, with some useful helpers.

Hierarchy

Overview

Nested Types

Public PtrT = ˆT;
Public PTypeList = ˆTTypeList;
Public TTypeList = array [0 .. MaxInt div SizeOf(T) - 1 ] of T;

Methods

Public function List: PTypeList;
Public function L: PtrT;
Public function Add: PtrT; overload;
Public function Ptr(I: Integer): PtrT;
Public procedure Assign(const Source: TStructList <T>); overload;
Public procedure Assign(const A: array of T); overload;
Public function ItemSize: SizeInt;
Public procedure AddArray(const A: array of T); deprecated 'use AddRange';
Public procedure AddList(const Source: TStructList <T>); deprecated 'use AddRange';
Public procedure AssignArray(const A: array of T); deprecated 'use Assign';

Description

Nested Types

Public PtrT = ˆT;
 
Public PTypeList = ˆTTypeList;
 
Public TTypeList = array [0 .. MaxInt div SizeOf(T) - 1 ] of T;
 

Methods

Public function List: PTypeList;

Access the list contents directly through a pointer.

This is useful if you have a list of records and you would like to set their fields. This will not work correctly: 

type
  TMyRecord = record MyField: Integer; end;
  TMyRecordList = specialize TGenericStructList<TMyRecord>;
var
  MyList: TMyRecordList;
begin
  // ...
  MyList[I].MyField := 123;

(It will not work OK because you would modify only a temporary record returned by the MyList[I] getter.) Instead, setting by 

MyList.Listˆ[I].MyField := 123;

will work OK. Or you can use (only in FPC ObjFpc mode) even shorter this: 

MyList.L[I].MyField := 123;

See also
L
Access the list contents directly through a pointer to T structure.
Public function L: PtrT;

Access the list contents directly through a pointer to T structure.

This is exactly the same pointer as List, but the type is different: this points to a single item. This is useful if you have a list of records and you would like to set their fields. This allows to use L[I] instead of Listˆ[I] (only in FPC ObjFpc mode).

See the List description for a more detailed explanation and example.

See also
List
Access the list contents directly through a pointer.
Public function Add: PtrT; overload;

Increase Count and return pointer to new item. Comfortable and efficient way to add a new item that you want to immediately initialize.

Public function Ptr(I: Integer): PtrT;

Pointer to ith item.

Public procedure Assign(const Source: TStructList <T>); overload;
 
Public procedure Assign(const A: array of T); overload;
 
Public function ItemSize: SizeInt;
 
Public procedure AddArray(const A: array of T); deprecated 'use AddRange';

Warning: this symbol is deprecated: use AddRange

 
Public procedure AddList(const Source: TStructList <T>); deprecated 'use AddRange';

Warning: this symbol is deprecated: use AddRange

 
Public procedure AssignArray(const A: array of T); deprecated 'use Assign';

Warning: this symbol is deprecated: use Assign

 
Generated by PasDoc 0.16.0.