Class TCastleControlBase

Description
Hierarchy
Fields
Methods
Properties

Unit

CastleControl

Declaration

type TCastleControlBase = class(TCastleControl)

Description

Warning: this symbol is deprecated: use TCastleControl

Note: we need this deprecated class to be a separate class, not just an alias for TCastleControl, to be able to register it using RegisterNoIcon, to support in old projects.

Source: lcl/castlecontrol.pas (line 487).

Hierarchy

  • TObject
  • TPersistent
  • TComponent
  • TLCLComponent
  • TControl
  • TWinControl
  • TCustomOpenGLControl
  • TCastleControl
  • TCastleControlBase
Show Additional Members:

Overview

Fields

Public class var MainControl: TCastleControl deprecated 'this should no longer be useful, if you change views using MyControl.Container.View := .. or MyControl.Container.PushView(...)';

Methods

Protected procedure DestroyHandle; override;
Protected procedure DoExit; override;
Protected procedure Resize; override;
Protected procedure KeyDown(var Key: Word; Shift: TShiftState); override;
Protected procedure UTF8KeyPress(var UTF8Key: TUTF8Char); override;
Protected procedure KeyUp(var Key: Word; Shift: TShiftState); override;
Protected procedure MouseDown(Button: Controls.TMouseButton; Shift:TShiftState; X,Y:Integer); override;
Protected procedure MouseUp(Button: Controls.TMouseButton; Shift:TShiftState; X,Y:Integer); override;
Protected procedure MouseMove(Shift: TShiftState; NewX, NewY: Integer); override;
Protected function DoMouseWheel(Shift: TShiftState; WheelDelta: Integer; MousePos: TPoint): Boolean; override;
Protected procedure DoUpdate; virtual;
Public constructor Create(AOwner: TComponent); override;
Public destructor Destroy; override;
Public function Controls: TInternalChildrenControls;
Public function MakeCurrent(SaveOldToStack: boolean = false): boolean; override;
Public procedure Invalidate; override;
Public procedure Paint; override;
Public function Pressed: TKeysPressed; deprecated 'use Container.Pressed';
Public function MousePressed: TCastleMouseButtons; deprecated 'use Container.MousePressed';
Public procedure ReleaseAllKeysAndMouse;
Public function Fps: TFramesPerSecond; deprecated 'use Container.Fps';
Public procedure SaveScreen(const Url: String); overload; deprecated 'use Container.SaveScreen';
Public function SaveScreen: TRGBImage; overload; deprecated 'use Container.SaveScreen';
Public function SaveScreen(const SaveRect: TRectangle): TRGBImage; overload; deprecated 'use Container.SaveScreen';
Public function SaveScreenBuffer: TColorBuffer;
Public function Rect: TRectangle;
Public function DesignedComponent(const ComponentName: String): TComponent; deprecated 'use Container.DesignedComponent';

Properties

Protected property GLInitialized: boolean read FGLInitialized;
Public property MousePosition: TVector2 read GetMousePosition write SetMousePosition; deprecated 'use Container.MousePosition';
Published property Align;
Published property Anchors;
Published property BorderSpacing;
Published property Enabled;
Published property OpenGLMajorVersion;
Published property OpenGLMinorVersion;
Published property MultiSampling;
Published property AlphaBits;
Published property DepthBits;
Published property StencilBits default DefaultStencilBits;
Published property AUXBuffers;
Published property Options;
Published property OnChangeBounds;
Published property OnConstrainedResize;
Published property OnDblClick;
Published property OnDragDrop;
Published property OnDragOver;
Published property OnEnter;
Published property OnExit;
Published property OnMouseEnter;
Published property OnMouseLeave;
Published property OnShowHint;
Published property PopupMenu;
Published property ShowHint;
Published property Visible;
Published property TabOrder;
Published property TabStop default true;
Published property AutoFocus: Boolean read FAutoFocus write FAutoFocus default false;
Published property Container: TCastleControlContainer read FContainer;
Published property AutoRedisplay: boolean read FAutoRedisplay write SetAutoRedisplay default true;
Published property DesignUrl: String read GetDesignUrl write SetDesignUrl stored false; deprecated 'use Container.DesignUrl';

Description

Fields

Public class var MainControl: TCastleControl deprecated 'this should no longer be useful, if you change views using MyControl.Container.View := .. or MyControl.Container.PushView(...)';

This item is declared in ancestor TCastleControl.

Warning: this symbol is deprecated: this should no longer be useful, if you change views using MyControl.Container.View := .. or MyControl.Container.PushView(...)

Central control.

This is only important now if you use deprecated way of setting TCastleView, using class properties/methods TCastleView.Current, TCastleView.Push. If instead you use new way of setting TCastleView, using container properties/methods TCastleContainer.Current, TCastleContainer.Push, then this value isn't useful.

This means that in new applications, you probably have no need to set this value.

Source: lcl/castlecontrol.pas (line 318).

Methods

Protected procedure DestroyHandle; override;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 291).

Protected procedure DoExit; override;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 292).

Protected procedure Resize; override;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 293).

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

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 294).

Protected procedure UTF8KeyPress(var UTF8Key: TUTF8Char); override;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 295).

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

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 296).

Protected procedure MouseDown(Button: Controls.TMouseButton; Shift:TShiftState; X,Y:Integer); override;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 297).

Protected procedure MouseUp(Button: Controls.TMouseButton; Shift:TShiftState; X,Y:Integer); override;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 299).

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

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 301).

Protected function DoMouseWheel(Shift: TShiftState; WheelDelta: Integer; MousePos: TPoint): Boolean; override;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 302).

Protected procedure DoUpdate; virtual;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 304).

Public constructor Create(AOwner: TComponent); override;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 320).

Public destructor Destroy; override;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 321).

Public function Controls: TInternalChildrenControls;

This item is declared in ancestor TCastleControl.

List of user-interface controls currently active. You can add your TCastleUserInterface instances (like TCastleViewport, TCastleButton and much more) to this list. We will pass events to these controls, draw them etc. See TCastleContainer.Controls for details.

Source: lcl/castlecontrol.pas (line 328).

Public function MakeCurrent(SaveOldToStack: boolean = false): boolean; override;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 330).

Public procedure Invalidate; override;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 331).

Public procedure Paint; override;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 332).

Public function Pressed: TKeysPressed; deprecated 'use Container.Pressed';

This item is declared in ancestor TCastleControl.

Warning: this symbol is deprecated: use Container.Pressed

Keys currently pressed.

Source: lcl/castlecontrol.pas (line 335).

Public function MousePressed: TCastleMouseButtons; deprecated 'use Container.MousePressed';

This item is declared in ancestor TCastleControl.

Warning: this symbol is deprecated: use Container.MousePressed

This item has no description.

Source: lcl/castlecontrol.pas (line 336).

Public procedure ReleaseAllKeysAndMouse;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 337).

Public function Fps: TFramesPerSecond; deprecated 'use Container.Fps';

This item is declared in ancestor TCastleControl.

Warning: this symbol is deprecated: use Container.Fps

Application speed.

Source: lcl/castlecontrol.pas (line 346).

Public procedure SaveScreen(const Url: String); overload; deprecated 'use Container.SaveScreen';

This item is declared in ancestor TCastleControl.

Warning: this symbol is deprecated: use Container.SaveScreen

Capture the current control contents to an image.

Source: lcl/castlecontrol.pas (line 350).

Public function SaveScreen: TRGBImage; overload; deprecated 'use Container.SaveScreen';

This item is declared in ancestor TCastleControl.

Warning: this symbol is deprecated: use Container.SaveScreen

This item has no description.

Source: lcl/castlecontrol.pas (line 351).

Public function SaveScreen(const SaveRect: TRectangle): TRGBImage; overload; deprecated 'use Container.SaveScreen';

This item is declared in ancestor TCastleControl.

Warning: this symbol is deprecated: use Container.SaveScreen

This item has no description.

Source: lcl/castlecontrol.pas (line 352).

Public function SaveScreenBuffer: TColorBuffer;

This item is declared in ancestor TCastleControl.

Color buffer where we draw, and from which it makes sense to grab pixels. Use only if you save the screen using low-level SaveScreen_NoFlush function. Usually, you should save the screen using the simpler SaveScreen method, and then the SaveScreenBuffer is not useful.

Source: lcl/castlecontrol.pas (line 359).

Public function Rect: TRectangle;

This item is declared in ancestor TCastleControl.

Rectangle representing the inside of this container. Always (Left,Bottom) are zero, and (Width,Height) correspond to container sizes.

Source: lcl/castlecontrol.pas (line 364).

Public function DesignedComponent(const ComponentName: String): TComponent; deprecated 'use Container.DesignedComponent';

This item is declared in ancestor TCastleControl.

Warning: this symbol is deprecated: use Container.DesignedComponent

This item has no description.

Source: lcl/castlecontrol.pas (line 366).

Properties

Protected property GLInitialized: boolean read FGLInitialized;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 306).

Public property MousePosition: TVector2 read GetMousePosition write SetMousePosition; deprecated 'use Container.MousePosition';

This item is declared in ancestor TCastleControl.

Warning: this symbol is deprecated: use Container.MousePosition

Current mouse position. See TTouch.Position for a documentation how this is expressed. Get and set Container.MousePosition instead.

Source: lcl/castlecontrol.pas (line 342).

Published property Align;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 402).

Published property Anchors;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 403).

Published property BorderSpacing;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 404).

Published property Enabled;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 405).

Published property OpenGLMajorVersion;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 406).

Published property OpenGLMinorVersion;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 407).

Published property MultiSampling;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 408).

Published property AlphaBits;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 409).

Published property DepthBits;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 410).

Published property StencilBits default DefaultStencilBits;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 411).

Published property AUXBuffers;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 412).

Published property Options;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 414).

Published property OnChangeBounds;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 416).

Published property OnConstrainedResize;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 417).

Published property OnDblClick;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 418).

Published property OnDragDrop;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 419).

Published property OnDragOver;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 420).

Published property OnEnter;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 421).

Published property OnExit;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 422).

Published property OnMouseEnter;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 424).

Published property OnMouseLeave;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 425).

Published property OnShowHint;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 426).

Published property PopupMenu;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 427).

Published property ShowHint;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 428).

Published property Visible;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 429).

Published property TabOrder;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 430).

Published property TabStop default true;

This item is declared in ancestor TCastleControl.

This item has no description.

Source: lcl/castlecontrol.pas (line 431).

Published property AutoFocus: Boolean read FAutoFocus write FAutoFocus default false;

This item is declared in ancestor TCastleControl.

Automatically make this control focused (receiving key input) when user clicks on it.

If this is True, consider showing it in some way to the user, e.g. show some rectangle frame when this control is focused. You can check "Focused" property ( https://lazarus-ccr.sourceforge.io/docs/lcl/controls/twincontrol.focused.html ) or FormXxx.ActiveControl or register OnEnter / OnExit LCL events.

Source: lcl/castlecontrol.pas (line 441).

Published property Container: TCastleControlContainer read FContainer;

This item is declared in ancestor TCastleControl.

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

Source: lcl/castlecontrol.pas (line 445).

Published property AutoRedisplay: boolean read FAutoRedisplay write SetAutoRedisplay default true;

This item is declared in ancestor TCastleControl.

Should we automatically redraw the window all the time, without the need for an Invalidate call. If True (the default), render events will be called as often as reasonable on this system, usually 60 times per second.

If your game may have a still screen (nothing animates), then this approach is a little unoptimal, as we use CPU and GPU for drawing, when it's not needed. In such case, you can set this property to False, and make sure that you call Invalidate always when you need to redraw the screen. Note that the engine components always call Invalidate when necessary, so you really only need to call Invalidate yourself if you make custom rendering in some TCastleUserInterface.Render.

Source: lcl/castlecontrol.pas (line 460).

Published property DesignUrl: String read GetDesignUrl write SetDesignUrl stored false; deprecated 'use Container.DesignUrl';

This item is declared in ancestor TCastleControl.

Warning: this symbol is deprecated: use Container.DesignUrl

Load and show the design (.castle-user-interface file). You can reference the loaded components by name using DesignedComponent.

If you have more complicated control flow, we recommend to leave this property empty, and split your management into a number of views (TCastleView) instead. In this case, load design using TCastleView.DesignUrl. This property makes it however easy to use .castle-user-interface in simple cases, when TCastleControl just shows one UI.

The design loaded here is visible also at design-time, when editing the form in Lazarus/Delphi. Though we have to way to edit it now in Lazarus/Delphi (you have to use CGE editor to edit the design), so it is just a preview in this case.

Source: lcl/castlecontrol.pas (line 477).

Generated by PasDoc 0.17.0.snapshot.

Copyright Michalis Kamburelis and Castle Game Engine Contributors.

This webpage is also open-source and we welcome pull requests to improve it.

We use cookies for analytics. See our privacy policy.