Castle Game Engine: CastleProgress: Class TProgressUserInterface

# Class TProgressUserInterface
Description | Hierarchy | Fields | Methods | Properties
## Unit CastleProgress ## Declaration `type TProgressUserInterface = class(TObject)` ## Description Abstract user interface of the progress bar. See TProgress for information how to use progress bars. ## Hierarchy TObject TProgressUserInterface ## Overview ### Fields
| `internal const DefaultBarYPosition = 0.5;`
### Methods
| `constructor Create;`
| `destructor Destroy; override;`
| `procedure Init(Progress: TProgress); virtual; abstract;`
| `procedure Update(Progress: TProgress); virtual; abstract;`
| `procedure Fini(Progress: TProgress); virtual; abstract;`
### Properties
| `property Image: TRGBImage read FImage write SetImage;`
| `property OwnsImage: boolean read FOwnsImage write FOwnsImage default false;`
| `property BarYPosition: Single read FBarYPosition write FBarYPosition default DefaultBarYPosition;`
| `property ImageBarYPosition: Single read FBarYPosition write FBarYPosition default DefaultBarYPosition; deprecated;`
## Description ### Fields
| `internal const DefaultBarYPosition = 0.5;`
### Methods
| `constructor Create;`
| `destructor Destroy; override;`
| `procedure Init(Progress: TProgress); virtual; abstract;`
Show progress bar.
| `procedure Update(Progress: TProgress); virtual; abstract;`
Update progress bar (because Progress.Position changed).
| `procedure Fini(Progress: TProgress); virtual; abstract;`
Hide progress bar.
### Properties
| `property Image: TRGBImage read FImage write SetImage;`
Image displayed as a background of the progress bar. Not all progress bar interfaces support it, some simply ignore it. You can leave it `Nil`, then we will simply capture screen contents each time the progress bar starts. Whether the image assigned here is "owned" (that is, "automatically freed") by TProgressUserInterface instance depends on OwnsImage. In any case, we don't modify the image (if we need to resize it to fit the screen size, we do it on a temporary copy).
| `property OwnsImage: boolean read FOwnsImage write FOwnsImage default false;`
| `property BarYPosition: Single read FBarYPosition write FBarYPosition default DefaultBarYPosition;`
Vertical position of the displayed progress bar. This feature is supposed to indicate a suitable free space on the background Image where we can nicely fit the progress bar UI. Not all progress bar interfaces support it, some simply ignore it. 0 means the middle of progress bar is at the bottom of the image, 1 means at the top. 0.5 indicates the middle, and it's the default.
| `property ImageBarYPosition: Single read FBarYPosition write FBarYPosition default DefaultBarYPosition; deprecated;`
Warning: this symbol is deprecated. Deprecated name for BarYPosition.
Generated by PasDoc 0.13.0 on 2015-06-15 04:43:11