Class TCastleProgressBar

Unit

Declaration

type TCastleProgressBar = class(TUIControlFont)

Description

Progress bar user interface. This is usually used through the CastleWindowProgress and CastleProgress features. There is no need to directly create and access the TCastleProgressBar instance in this case.

Hierarchy

Overview

Methods

Public constructor Create(AOwner: TComponent); override;
Public destructor Destroy; override;
Public procedure Render; override;
Public procedure GLContextOpen; override;
Public procedure GLContextClose; override;
Public function Rect: TRectangle; override;

Properties

Public property Progress: TProgress read FProgress write FProgress;
Public property Background: TCastleImage read FBackground write SetBackground;
Public property YPosition: Single read FYPosition write FYPosition default TProgressUserInterface.DefaultBarYPosition;

Description

Methods

Public constructor Create(AOwner: TComponent); override;
 
Public destructor Destroy; override;
 
Public procedure Render; override;
 
Public procedure GLContextOpen; override;
 
Public procedure GLContextClose; override;
 
Public function Rect: TRectangle; override;
 

Properties

Public property Progress: TProgress read FProgress write FProgress;

Progress that rules the position and title displayed.

Public property Background: TCastleImage read FBackground write SetBackground;

Background drawn under the progress bar. May be left unassigned (Nil), in which case you're responsible for making sure some other control (like TCastleSimpleBackground or maybe 3D viewport) always covers the screen underneath.

When it's assigned, it's always drawn scaled to cover the whole screen (container). It's owner by this component (it will be automatically freed when necessary).

Public property YPosition: Single read FYPosition write FYPosition default TProgressUserInterface.DefaultBarYPosition;

Vertical positon of the progress bar. 0 means the middle of progress bar is at the bottom of the container, 1 means at the top. 0.5 indicates the middle, and it's the default.

Note that extreme values (0 or 1) mean that bottom or top half of the progress bar doesn't fit on the screen, as this property positions the middle of the progress bar.


Generated by PasDoc 0.15.0.