Class TCastleControl

Description

Hierarchy

Fields

Methods

Properties

Unit

Fmx.CastleControl

Declaration

type TCastleControl = class(TPresentedControl)

Description

Control rendering "Castle Game Engine" on FMX form.

Source: src/delphi/fmx.castlecontrol.pas (line 64).

Hierarchy

TObject
TPresentedControl
TCastleControl

Overview

Methods

	`procedure MouseDown(Button: TMouseButton; Shift: TShiftState; X, Y: Single); override;`
	`procedure MouseMove(Shift: TShiftState; NewX, NewY: Single); override;`
	`procedure MouseUp(Button: TMouseButton; Shift: TShiftState; X, Y: Single); override;`
	`procedure MouseWheel(Shift: TShiftState; WheelDelta: Integer; var Handled: Boolean); override;`
	`procedure KeyDown(var Key: Word; var KeyChar: WideChar; Shift: TShiftState); override;`
	`procedure KeyUp(var Key: Word; var KeyChar: WideChar; Shift: TShiftState); override;`
	`function DefinePresentationName: String; override;`
	`procedure Resize; override;`
	`procedure DoRootChanging(const NewRoot: IRoot); override;`
	`procedure SetVisible(const AValue: Boolean); override;`
	`constructor Create(AOwner: TComponent); override;`
	`destructor Destroy; override;`
	`procedure Paint; override;`
	`procedure InternalHandleNeeded;`
	`class procedure ProcessTasks;`
	`class procedure ApplicationRun;`

Properties

	`property ControlType default TControlType.Platform;`
	`property Container: TCastleControlContainer read GetContainer;`
	`property Align;`
	`property Anchors;`
	`property OnClick;`
	`property OnDblClick;`
	`property Height;`
	`property Width;`
	`property Size;`
	`property Position;`
	`property Margins;`
	`property TabStop default true;`
	`property TabOrder;`
	`property CanFocus default True;`

Description

Methods

procedure MouseDown(Button: TMouseButton; Shift: TShiftState; X, Y: Single); override;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 118).

procedure MouseMove(Shift: TShiftState; NewX, NewY: Single); override;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 120).

procedure MouseUp(Button: TMouseButton; Shift: TShiftState; X, Y: Single); override;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 121).

procedure MouseWheel(Shift: TShiftState; WheelDelta: Integer; var Handled: Boolean); override;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 123).

procedure KeyDown(var Key: Word; var KeyChar: WideChar; Shift: TShiftState); override;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 124).

procedure KeyUp(var Key: Word; var KeyChar: WideChar; Shift: TShiftState); override;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 125).

function DefinePresentationName: String; override;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 126).

procedure Resize; override;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 127).

procedure DoRootChanging(const NewRoot: IRoot); override;

Not needed in the end // procedure DoRootChanged; override;

Source: src/delphi/fmx.castlecontrol.pas (line 129).

procedure SetVisible(const AValue: Boolean); override;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 130).

constructor Create(AOwner: TComponent); override;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 132).

destructor Destroy; override;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 133).

procedure Paint; override;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 134).

procedure InternalHandleNeeded;

If Handle not allocated yet, allocate it now. This makes sure we have OpenGL context created. Our OpenBackend must guarantee it, we want to initialize GLVersion afterwards etc.

Source: src/delphi/fmx.castlecontrol.pas (line 140).

class procedure ProcessTasks;

On some platforms (Linux now) if you call Application.ProcessMessages, make sure to also call this method. E.g.

while SomeCondition do
begin
  Application.ProcessMessages;
  TCastleControl.ProcessTasks;
end;

This does nothing on some other platforms (Windows) when it is not necessary and Application.ProcessMessages does all CGE job.

Source: src/delphi/fmx.castlecontrol.pas (line 161).

class procedure ApplicationRun;

On some platforms (Linux now) you cannot just call Application.Run, as we need to call CGE processing regularly. So instead call this method. This ensures that engine updates / renders regularly.

On some other platforms (Windows) this just calls Application.Run, which already makes engine processing correct.

Source: src/delphi/fmx.castlecontrol.pas (line 171).

Properties

property ControlType default TControlType.Platform;

This control must always have "native style", which means it has ControlType = Platform. See FMX docs about native controls: https://docwiki.embarcadero.com/RADStudio/Sydney/en/FireMonkey_Native_Windows_Controls Native controls are always on top of non-native controls.

Source: src/delphi/fmx.castlecontrol.pas (line 146).

property Container: TCastleControlContainer read GetContainer;

Access Castle Game Engine container properties and events, not specific to FMX.

Source: src/delphi/fmx.castlecontrol.pas (line 175).

property Align;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 177).

property Anchors;

This item has no description.

Source: src/delphi/fmx.castlecontrol.pas (line 178).

property OnClick;

This item has no description.