Visual3D Game EngineAPI Documentation for XNA, C#, VB, and .NET
Assembly: Standard Assets (in Standard Assets.dll) Version: 1.0.0.0 (1.0.0.0)
Standard progress bar for the Gui Scheme.
Namespace: Visual3D.UI.Controls.FantasyAssembly: Standard Assets (in Standard Assets.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
| C# | Visual Basic |
public class FantasyProgressBar : ProgressBar
Public Class FantasyProgressBar _ Inherits ProgressBar
Members
| All Members | Constructors | Fields | Properties | Methods | Events |
| Member | Description | |
|---|---|---|
| FantasyProgressBar(ProgressBarConfig) |
Constructor.
| |
| AbsoluteToRelative(ScreenPoint) | ||
| AbsoluteToRelative(ScreenRectangle) | ||
| AbsoluteToRelative(ScreenSize) | ||
| AbsoluteToRelativeX(Single) | ||
| AbsoluteToRelativeY(Single) | ||
| ActionIsActive(NameID) | (Inherited from Entity.) | |
| Activate()()()() | Enables an entity and its scripted or diagrammed interactivity. (Inherited from Entity.) | |
| Activate(IComponentOwner) | Sets activity Owner and then Activates this activity. (Inherited from Entity.) | |
| ActivateAction(ActionBase) | (Inherited from Entity.) | |
| ActivateAction(NameID) | (Inherited from Entity.) | |
| Activated | (Inherited from Entity.) | |
| ActivationFrameNumber | (Inherited from Entity.) | |
| Activities | (Inherited from Entity.) | |
| Add(Object) | (Inherited from Entity.) | |
| Add(Type, Object) | (Inherited from Entity.) | |
| Add(NameID, Object) | (Inherited from Entity.) | |
| AddAction(ActionBase) | (Inherited from Entity.) | |
| AddAction(NameID, ActionBase) | (Inherited from Entity.) | |
| AddChild(String) |
Add the named Control as a child of this Control. If the Control \a name is already attached to a Control, it is detached before
being added to this Control.
| |
| AddChild(Control) |
Add the specified Control as a child of this Control. If the Control is already attached to a Control, it is detached before
being added to this Control.
| |
| AdjustProgress(Single) |
Modify the progress level by a specified delta.
(Inherited from ProgressBar.) | |
| Alpha | Get/Set the current alpha value for this Control. | |
| AlphaChanged | ||
| AlphaScalar | Scales Alpha by an additional amount. | |
| AlwaysOnTop | Gets/Sets whether this Control is 'always on top' or not. If not, it follows normal Z-order behavior. | |
| AlwaysOnTopChanged | ||
| AnchorInfo | Gets/Sets Gui Anchor information. | |
| AnchorRelativeOffset | Gets/Sets Gui Relative ScreenPoint Offset to Anchor to. | |
| AssetID | (Inherited from Registered.) | |
| AssetInfo | (Inherited from Registered.) | |
| AssetOwner | Gets or sets the owner to which this asset belongs and is a member of. (Inherited from Asset.) | |
| Attach(Object) | (Inherited from Entity.) | |
| AttachedToOwner(IComponentOwner) | (Inherited from EntityComponent.) | |
| BarColor | (Inherited from ProgressBar.) | |
| BarMessage | (Inherited from ProgressBar.) | |
| BaseAsset | (Inherited from Registered.) | |
| CanAttach(Object) | (Inherited from Entity.) | |
| CanDetach(Object) | (Inherited from Entity.) | |
| CaptureGained | ||
| CaptureInput()()()() | Capture input to this control. | |
| CaptureLost | ||
| Character | ||
| ChildAdded | ||
| ChildControlCount | Gets the number of child Controls attached to this Control. | |
| ChildControls | ||
| ChildOwner | (Inherited from Entity.) | |
| ChildRemoved | ||
| ClippingChanged | ||
| ComponentOwner | Owner of this component (contained in it's ".Components" container). (Inherited from EntityComponent.) | |
| Components | Components that are attached to this Entity. (Inherited from ComponentBase.) | |
| ComponentsForGlobalSceneFolders | (Inherited from ComponentBase.) | |
| ContainsAction(NameID) | (Inherited from Entity.) | |
| Context | Defines the Owner of this component as well as the role (i.e. 'slot') that this component fulfills. (Inherited from ComponentBase.) | |
| ControlToScreenArea(ScreenRectangle) | Convert a control Area, to a Screen-based Area. | |
| ControlToScreenPoint(ScreenPoint) | Convert a control Point to a Screen Point. | |
| ControlToScreenX(Single) | Convert a control X coordinate value to a screen X coordinate. | |
| ControlToScreenY(Single) | Convert a control Y coordinate to Screen Y coordinate. | |
| Create(ProgressBarConfig) | ||
| CreateIdentity()()()() | (Inherited from Registered.) | |
| CreateIdentityList()()()() | (Inherited from Registered.) | |
| CreateInstance(Boolean) | ||
| CreateService<(Of <<'(TService>)>>)()()()() | (Inherited from ComponentBase.) | |
| CurrentProgress | (Inherited from ProgressBar.) | |
| Deactivate()()()() | Disables an entity and its scripted or diagrammed interactivity, if it is currently enabled. (Inherited from Entity.) | |
| DeactivateAction(NameID) | (Inherited from Entity.) | |
| Deactivated | (Inherited from Entity.) | |
| Designer | ||
| DesignLocationChanged | ||
| DestroyedByParent | Get/Set whether or not this Control will automatically be destroyed when its parent Control is destroyed. | |
| DestructionStarted | ||
| Detach(Object) | (Inherited from Entity.) | |
| DetachedFromOwner(IComponentOwner) | (Inherited from EntityComponent.) | |
| Dispose()()()() | (Inherited from ComponentBase.) | |
| Disposed | Triggered anytime SceneObject Visibility is changed. (Inherited from Entity.) | |
| Do(ActionBase) | (Inherited from Entity.) | |
| EffectiveAlpha | Gets the effective alpha value that will be used when rendering this Control, taking into account inheritance of parent
Control(s) alpha. Range 0-1F | |
| EntityBase | (Inherited from Entity.) | |
| FindAllChildren(ControlList) | Returns a list of all controls which are descendants of this control. | |
| Focus()()()() | Set focus on this control and bring to top of all non always-on-top Controls. | |
| FocusedChild | Gets a reference to the bottom-most active child Control starting at 'this', else
null if Focus is not contained by this control or it's children. | |
| Font | Returns reference to the active Font for this Control, else returns
Default Font is not specifically assigned. | |
| FontChanged | ||
| FontName | ||
| ForEachComponent<(Of <<'(TComponent>)>>)(Action<(Of <<'(TComponent>)>>)) | (Inherited from Entity.) | |
| FullName | The unique name of this Control. | |
| Get<(Of <<'(T>)>>)()()()() | (Inherited from Entity.) | |
| Get<(Of <<'(T>)>>)(T%) | (Inherited from Entity.) | |
| Get<(Of <<'(TKey, TDerived>)>>)(TDerived%) | (Inherited from Entity.) | |
| Get<(Of <<'(T>)>>)(NameID) | (Inherited from Entity.) | |
| Get(NameID, Object%) | (Inherited from Entity.) | |
| Get<(Of <<'(T>)>>)(NameID, T%) | (Inherited from Entity.) | |
| GetAction(NameID) | (Inherited from Entity.) | |
| GetActions()()()() | (Inherited from Entity.) | |
| GetAll<(Of <<'(TComponent>)>>)()()()() | (Inherited from Entity.) | |
| GetAssetInstance()()()() | ||
| GetChild(String) | Return a reference to the child Control with the specified name. | |
| GetChildAtIndex(Int32) | Gets a reference to the child Control at the specified index. | |
| GetChildAtPosition(ScreenPoint) | Returns the child Control that is 'hit' by the given position | |
| GetContainerAtPosition(Control, ScreenPoint) | Returns the child container Control that is 'hit' by the given position | |
| GetDesignerControlAtPosition(ScreenPoint) | ||
| GetDesignerSheetAtPosition(ScreenPoint) | ||
| GetOrCreate<(Of <<'(K, T>)>>)()()()() | (Inherited from Entity.) | |
| GetOrCreate<(Of <<'(K, T>)>>)(T%) | (Inherited from Entity.) | |
| GetOrCreate<(Of <<'(T>)>>)(T%) | (Inherited from Entity.) | |
| GetOrCreate<(Of <<'(T>)>>)(NameID, T%) | (Inherited from Entity.) | |
| GetService<(Of <<'(TService>)>>)()()()() | (Inherited from ComponentBase.) | |
| GetService<(Of <<'(TService>)>>)(TService%) | (Inherited from ComponentBase.) | |
| GetTextExtent()()()() | Gets the width in pixels of the current control text. | |
| GotFocus | ||
| GuiElementType | (Inherited from ProgressBar.) | |
| GuiElementTypeName | ||
| Handle | (Inherited from Registered.) | |
| HandleDragDrop(IAssetDragDropEventArgs) | ||
| HasComponents | (Inherited from ComponentBase.) | |
| HasHandle | (Inherited from Registered.) | |
| HasName | (Inherited from EntityComponent.) | |
| HasPrototype | Gets if a prototype has been specified to inherit instance data from. (Inherited from Asset.) | |
| HasScope | (Inherited from Registered.) | |
| HasUniqueName | Gets if a UniqueName is specified to identify this asset with respect to its owner's other members. (Inherited from Registered.) | |
| Height | Gets/Sets the height of the Control (in unspecified units). | |
| Hide()()()() | Hide this control. | |
| Hide(Boolean) | (Inherited from ProgressBar.) | |
| ID | (Inherited from Registered.) | |
| IDChanged | (Inherited from Registered.) | |
| IDChanged | ||
| InheritsAlpha | Get/Set whether this Control will inherit alpha from its parent Controls. | |
| InheritsAlphaChanged | ||
| Initialize()()()() | Initializes the asset so that it might be prepared for use.
By default, PrepareForUse() is called from this method as well. (Inherited from Asset.) | |
| Initialize(IComponentOwner) | (Inherited from Entity.) | |
| Initialized | (Inherited from Entity.) | |
| InnerRect | Gets a Rect describing the clipped inner area for this Control. | |
| IsActive | (Inherited from Entity.) | |
| IsActiveNonDisposed | (Inherited from Entity.) | |
| IsCapturedByChild | Returns true if input is captured by a child of 'this'. | |
| IsCapturedByThis | Returns true if input is captured by 'this'. | |
| IsClippedByParent | Returns true if this Control is to be clipped by it's parent. | |
| IsContainer | Does this Control serve as a container for other controls. | |
| IsDeserialized | Indicates if Instance was created by Deserialization. (Inherited from ComponentBase.) | |
| IsDisposed | Indicates if resource has been disposed. (Inherited from Asset.) | |
| IsDisposing | Indicates if resource is in process of Disposing but not fully disposed. (Inherited from Asset.) | |
| IsDragging | Indicates if control is currently being dragged. | |
| IsDraggingChanged | ||
| IsDraggingEnabled | Get/Set whether this Control will respond to dragging. | |
| IsEditable | Indicates if Control is Editable via the GuiDesigner mode. | |
| IsFocused | Returns true if this Control is Focused. | |
| IsHit(ScreenPoint) | Check if the given Screen position would hit this Control. | |
| IsInitialized | Gets if this entity is currently in an initialized (and non-disposed) state. (Inherited from Asset.) | |
| IsInputEnabled | Returns true if this Control is currently processing Input. | |
| IsInputEnabledChanged | ||
| IsPointOverControl(ScreenPoint) | ||
| IsPrototype | (Inherited from Asset.) | |
| IsReadyForUse | Gets/sets if asset is ready to be used.
Can be set to 'true' in class constructor in order to skip Preparation logic. (Inherited from Asset.) | |
| IsSaved | Indicates if the component is to be Saved when the owning context is saved
(e.g. for components in your scene, this controls whether or not they are saved to the scene file when the scene is saved).
Typically objects are 'Saved', unless they are transient to be programmatically created each time. (Inherited from ComponentBase.) | |
| IsSavedOnCreatingInstance | (Inherited from Asset.) | |
| IsToolTipActive | ||
| IsVisible | Returns true if this Control is visible (not hidden). | |
| IsVisibleChanged | ||
| KeyDown | ||
| KeyUp | ||
| Location |
Value is only valid when gui is in design mode
| |
| LostFocus | ||
| MaximumSize | Get/Set the maximum size for this Control. | |
| MaxRange | (Inherited from ProgressBar.) | |
| MinimumSize | Set the minimum size for this Control. | |
| MinRange | (Inherited from ProgressBar.) | |
| MouseButtonDown | ||
| MouseButtonUp | ||
| MouseClicked | ||
| MouseCursorImage | Get a reference to the mouse cursor image to use when the mouse is within this Control. | |
| MouseDoubleClicked | ||
| MouseEnters | ||
| MouseLeaves | ||
| MouseMove | ||
| MouseTripleClicked | ||
| MouseWheel | ||
| Moved | ||
| MoveToBack()()()() | Move the Control to the bottom of the Z order. | |
| MoveToFront()()()() | Move the Control to the top of the z order. | |
| Name | (Inherited from EntityComponent.) | |
| NameID | (Inherited from EntityComponent.) | |
| NotifyComponentsOfEvent<(Of <<'(TEvent>)>>)(TEvent) | (Inherited from Entity.) | |
| OffsetPixelPosition(ScreenPoint) |
Move the window by the pixel offsets specified in offset.
| |
| OnMemberwiseClone()()()() | (Inherited from ComponentBase.) | |
| Owner | (Inherited from Entity.) | |
| OwnerActivated(IComponentOwner) | (Inherited from EntityComponent.) | |
| OwnerDeactivated(IComponentOwner) | (Inherited from EntityComponent.) | |
| OwnerEntity | (Inherited from Entity.) | |
| OwnerOf<(Of <<'(TOwner>)>>)()()()() | (Inherited from Registered.) | |
| ParentControl | Gets/Sets a reference to this Control's parent Control. | |
| ParentDestroyChanged | ||
| ParentForm | ||
| ParentSized | ||
| PercentComplete | (Inherited from ProgressBar.) | |
| PerformClick()()()() | ||
| PixelRect | Gets a Rect describing the Control area in pixel screen space. | |
| Position | Get/Set the pixel position of the Control. | |
| Prefix | (Inherited from ProgressBar.) | |
| PrepareForUse()()()() | Attempts to prepare asset for use. To be sure, check "IsReadyForUse"
after calling this method to ensure it's really ready for use before using it. (Inherited from Asset.) | |
| Progress |
Get/Set the current level of progress.
(Inherited from ProgressBar.) | |
| ProgressChanged |
Triggered when the progress changes.
(Inherited from ProgressBar.) | |
| ProgressDone |
Triggered when the progress reaches 100%.
(Inherited from ProgressBar.) | |
| Prototype | Gets the prototype this instance or prototype was created from and inherits components and settings from. (Inherited from Entity.) | |
| Rectangle | Gets a Rect object that describes the Control area. | |
| RelativeToAbsolute(ScreenPoint) | ||
| RelativeToAbsolute(ScreenRectangle) | ||
| RelativeToAbsolute(ScreenSize) | ||
| RelativeToAbsoluteX(Single) | ||
| RelativeToAbsoluteY(Single) | ||
| ReleaseInput()()()() | Releases the capture of input from this control. | |
| Remove<(Of <<'(T>)>>)()()()() | (Inherited from Entity.) | |
| Remove(Object) | (Inherited from Entity.) | |
| Remove(NameID) | (Inherited from Entity.) | |
| RemoveAction<(Of <<'(T>)>>)()()()() | (Inherited from Entity.) | |
| RemoveAction(NameID) | (Inherited from Entity.) | |
| RemoveChild(String) | Removes the child Control with the specified name. | |
| RemoveChild(Control) | Removes 'Control' from this Control's child list. | |
| RenameKey(NameID, NameID) | (Inherited from Entity.) | |
| Render()()()() | Renders Control and all of it's attached children. | |
| RenderingEnded | ||
| RenderingStarted | ||
| ReplaceAction(ActionBase) | (Inherited from Entity.) | |
| ReplaceAction(NameID, ActionBase) | (Inherited from Entity.) | |
| RequestRedraw()()()() | Signal the System object to redraw (at least) this Control on the next render cycle. | |
| Reset()()()() | Called from 'Activate()' method, or can be called manually. Should initialize custom state of the Activity.
Note, that if the Activity is currently executing, this should have no effect upon the current Activity state. (Inherited from Entity.) | |
| ResolutionChanged | ||
| RotationAngle | Get/Set the rotation of the Control between 0 and 360 degrees. | |
| RotationAngleChanged | ||
| Scheduler | (Inherited from Entity.) | |
| SchedulerID | (Inherited from Entity.) | |
| Scope | (Inherited from Registered.) | |
| ScreenToControlArea(ScreenRectangle) | Convert a screen area to a control area, specified in whichever metrics mode is active. | |
| ScreenToControlPoint(ScreenPoint) | Convert Screen Point to Control-based Point. | |
| ScreenToControlX(Single) | Convert Screen X coordinate to a control-based X coordinate. | |
| ScreenToControlY(Single) | Convert Screen Y coordinate to a control-based Y coordinate. | |
| Set<(Of <<'(T>)>>)(T) | (Inherited from Entity.) | |
| Set(Type, Object) | (Inherited from Entity.) | |
| Set(NameID, Object) | (Inherited from Entity.) | |
| SetAreaRect(ScreenRectangle) |
Set the current area for the Control, this allows for setting of position and size at the same time.
Interpretation of the input value area is dependant upon the current metrics system set for the Control.
| |
| SetFont(String) | Set the font used by this Control to the font associated with the font name (or Default Font, if null name). | |
| SetFont(Font) | Set the font used by this Control, will use Default if font is null. | |
| SetMouseCursor(Image) | Sets the mouse cursor to use when the mouse is hovering over this control. | |
| SetMouseCursor(String, String) | Set the mouse cursor image to be used when the mouse enters this control. | |
| SetRange(Single, Single) |
Set the movement range of the thumb for the horizontal axis.
(Inherited from ProgressBar.) | |
| SetRestoreCapture(Boolean) | Sets the 'restore old capture' mode to on / off. | |
| SetToolTip(ToolTipBox) | ||
| Show()()()() | Show this control (make visible). | |
| Show(Single, Single, Single, String) | (Inherited from ProgressBar.) | |
| Size | Get/Set the pixel size of this Control. | |
| SizeChanged | ||
| SourceFile | Gets/Sets the source file for this program. (Inherited from Asset.) | |
| Step()()()() |
Cause the progress to step.
(Inherited from ProgressBar.) | |
| StepSize |
Get/Set the size of the 'step' (in percentage points).
(Inherited from ProgressBar.) | |
| StopDragging()()()() | ||
| StorageModule | (Inherited from Registered.) | |
| Tag | Gets or sets the object that contains data about the control. | |
| Text | Gets/Sets the Control's text string. | |
| TextChanged | ||
| TextColor | Gets/Sets the Control's text color. | |
| TextColorChanged | ||
| ToggleVisibility()()()() | Toggle the controls visibility. | |
| ToolTip | ||
| ToString()()()() | (Overrides Entity..::..ToString()()()().) | |
| TriggerAIEvent(BaseEvent) | (Inherited from Entity.) | |
| TriggerEvent(BaseEvent) | (Inherited from Entity.) | |
| UnclippedInnerRect |
Return a Rect that describes, unclipped, the inner rectangle for this Control. The inner rectangle is
typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering.
| |
| UnclippedPixelRect | Gets a Rect describing the Control area unclipped, in screen space. | |
| UniqueName | (Inherited from Registered.) | |
| Update()()()() | (Inherited from ProgressBar.) | |
| Update(Single) | (Inherited from ProgressBar.) | |
| Update(Single, String) | (Inherited from ProgressBar.) | |
| UpdateMethod | (Inherited from ProgressBar.) | |
| UpdateTimeInterval | Time interval at which the 'Update()' will be called by the scheduler upon Activation of this Entity. (Inherited from Entity.) | |
| VisualEntity(Entity) | (Inherited from EntityExtensions.) | |
| Width | Gets/Sets the width of the Control (in unspecified units). | |
| X | Get/Set the x position of the Control relative to it's parent. | |
| Y | Get/Set the y position of the Control relative to it's parent. | |
| ZChanged |
Inheritance Hierarchy
System..::..Object
Visual3D.EntityModel..::..ComponentBase
Visual3D.EntityModel..::..EntityComponent
Visual3D..::..Registered
Visual3D..::..Asset
AssetOwner
Visual3D..::..Entity
Visual3D.UI..::..Control
Visual3D.UI.Controls..::..ProgressBar
Visual3D.UI.Controls.Fantasy..::..FantasyProgressBar
Visual3D.EntityModel..::..ComponentBase
Visual3D.EntityModel..::..EntityComponent
Visual3D..::..Registered
Visual3D..::..Asset
AssetOwner
Visual3D..::..Entity
Visual3D.UI..::..Control
Visual3D.UI.Controls..::..ProgressBar
Visual3D.UI.Controls.Fantasy..::..FantasyProgressBar