PixelCrushers.DialogueSystem.UnityGUI.GUIProgressBar Class Reference

A GUI control that implements a flexible progress bar. More...

Inheritance diagram for PixelCrushers.DialogueSystem.UnityGUI.GUIProgressBar:
Collaboration diagram for PixelCrushers.DialogueSystem.UnityGUI.GUIProgressBar:

Public Types

enum  Origin {
  Origin.Top, Origin.Bottom, Origin.Left, Origin.Right,
  Origin.HorizontalCenter, Origin.VerticalCenter
}
 

Public Member Functions

override void DrawSelf (Vector2 relativeMousePosition)
 Draws the control, but not its children. More...
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl
override void Awake ()
 
virtual void Start ()
 
void UseLocalizedText (LocalizedTextTable localizedText)
 
void ApplyAlphaToGUIColor ()
 
void RestoreGUIColor ()
 
virtual void SetFormattedText (FormattedText formattedText)
 Sets the control's text and formatting. More...
 
void SetUnformattedText (string text)
 Sets the control's text and formatting using just raw text. More...
 
override void UpdateLayoutSelf ()
 Updates the control's layout but not its children. More...
 
override void AutoSizeSelf ()
 Auto-sizes the control according to the autoSize settings. More...
 
void PlaySound (AudioClip audioClip)
 Plays an audio clip. More...
 
- Public Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl
virtual void OnEnable ()
 Checks if the control needs to enable the first child for key/controller navigation. More...
 
void Draw (Vector2 relativeMousePosition)
 Draw the control and its children. More...
 
virtual void DrawChildren (Vector2 relativeMousePosition)
 Draws the children, taking into account key/controller navigation if enabled. More...
 
virtual void Update ()
 If navigation is enabled, check if the selection button was pressed. More...
 
virtual void Refresh (Vector2 windowSize)
 Marks a control as needing to update its layout. More...
 
virtual void Refresh ()
 
virtual void UpdateLayout ()
 Updates the layout (size, position, formatting, etc.) of the control and its children. More...
 

Public Attributes

Origin origin
 The direction from which the progress bar fills. More...
 
Texture2D emptyImage
 The empty image (e.g., empty frame of progress bar). More...
 
Texture2D fullImage
 The full image that gradually covers the empty image as progress increases. More...
 
float progress = 0
 The current progress of the bar. More...
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl
LocalizedTextTable localizedText
 The (optional) localized text table to use. More...
 
string text
 The text content, or the name of the field in the localized text table. More...
 
string guiStyleName
 The name of the GUI style to use to draw the text. More...
 
- Public Attributes inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl
int depth = 0
 The drawing order depth. More...
 
bool depthSortChildren = false
 If true, children are drawn in depth order; otherwise no specific order. More...
 
ScaledRect scaledRect = new ScaledRect(ScaledRect.wholeScreen)
 The scaled rect defining the position of the control. More...
 
AutoSize autoSize
 Auto-size settings. More...
 
Fit fit
 Fit settings. More...
 
Navigation navigation
 Keyboard/controller navigation settings. More...
 
bool visible = true
 If true, this control and its children are visible. More...
 
bool clipChildren = true
 Clip children to the control's bounds? More...
 

Additional Inherited Members

- Protected Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl
void SetGUIStyle ()
 Makes sure the guiStyle property is up-to-date. More...
 
void ApplyFormatting ()
 Applies the formatting recorded in formattingToApply by SetFormattedText(). More...
 
- Protected Member Functions inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl
virtual void FitSelf ()
 Fits the control according to the fit settings. More...
 
- Properties inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIVisibleControl
float Alpha [get, set]
 Gets or sets the alpha (transparency) value. More...
 
bool HasAlpha [get]
 Gets a value indicating whether this instance has an alpha that isn't fully opaque. More...
 
virtual GUIStyle DefaultGUIStyle [get]
 Gets the default GUI style to use for this type of control. More...
 
GUIStyle GuiStyle [get, set]
 The current GUI style. More...
 
- Properties inherited from PixelCrushers.DialogueSystem.UnityGUI.GUIControl
Rect rect [get, set]
 The pixel rect represented by scaledRect. More...
 
Vector2 Offset [get, set]
 Gets or sets the offset to apply to the screen rect for this control; useful for manual repositioning outside the normal GUI control system. More...
 
List< GUIControlChildren [get]
 The child controls. More...
 
bool NeedToUpdateLayout [get, set]
 When true, the control needs to update its style, size, position, etc. More...
 
Vector2 WindowSize [get, set]
 The size of the window most recently passed to Refresh(). More...
 
bool IsNavigationEnabled [get]
 Gets a value indicating whether keyboard/controller navigation is enabled. More...
 
string FullName [get]
 Gets the full name of the GameObject, used to focus the control when using keyboard/controller navigation. More...
 
Vector2 dRect [get, set]
 Gets or sets dRect, which offsets the rect when the parent window isn't clipping. More...
 

Detailed Description

A GUI control that implements a flexible progress bar.

It can fill from any direction (left, right, top, bottom, center).

Member Enumeration Documentation

◆ Origin

Enumerator
Top 
Bottom 
Left 
Right 
HorizontalCenter 
VerticalCenter 

Member Function Documentation

◆ DrawSelf()

override void PixelCrushers.DialogueSystem.UnityGUI.GUIProgressBar.DrawSelf ( Vector2  relativeMousePosition)
virtual

Draws the control, but not its children.

Parameters
relativeMousePositionRelative mouse position within the window containing this control.

Reimplemented from PixelCrushers.DialogueSystem.UnityGUI.GUIControl.

Member Data Documentation

◆ emptyImage

Texture2D PixelCrushers.DialogueSystem.UnityGUI.GUIProgressBar.emptyImage

The empty image (e.g., empty frame of progress bar).

◆ fullImage

Texture2D PixelCrushers.DialogueSystem.UnityGUI.GUIProgressBar.fullImage

The full image that gradually covers the empty image as progress increases.

◆ origin

Origin PixelCrushers.DialogueSystem.UnityGUI.GUIProgressBar.origin

The direction from which the progress bar fills.

◆ progress

float PixelCrushers.DialogueSystem.UnityGUI.GUIProgressBar.progress = 0

The current progress of the bar.


The documentation for this class was generated from the following file: