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 DefaultImageBarYPosition = 0.5;`
### Methods
| `constructor Create;`
| `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 FImage;`
| `property ImageBarYPosition: Single read FImageBarYPosition write FImageBarYPosition default DefaultImageBarYPosition;`
## Description ### Fields
| `internal const DefaultImageBarYPosition = 0.5;`
### Methods
| `constructor Create;`
| `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 FImage;`
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. The image assigned here does not become owned by the TProgressUserInterface instance. We don't modify it (if we need to resize it to fit the screen size, we do it on a temporary copy). And we don't free it.
| `property ImageBarYPosition: Single read FImageBarYPosition write FImageBarYPosition default DefaultImageBarYPosition;`
Vertical position of the displayed progress bar on the Image. 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. Always ignored if Image is `Nil`. 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.
Generated by PasDoc 0.13.0 on 2013-08-17 21:27:13