Difference between revisions of "JavaScript Client GUI Objects"
From Virtual World Web Wiki
(Documentation for the JavaScript Client GUI Objects class) |
(Documentation for the JavaScript Client GUI Objects class) |
||
| Line 3: | Line 3: | ||
===<span id="GUI3DView"></span>GUI3DView <span class="SectionLink">([[GUI3DView|Full Article]])</span>=== | ===<span id="GUI3DView"></span>GUI3DView <span class="SectionLink">([[GUI3DView|Full Article]])</span>=== | ||
| + | A surface to display a MiniDOM camera | ||
| + | |||
===<span id="GUI3DWindow"></span>GUI3DWindow <span class="SectionLink">([[GUI3DWindow|Full Article]])</span>=== | ===<span id="GUI3DWindow"></span>GUI3DWindow <span class="SectionLink">([[GUI3DWindow|Full Article]])</span>=== | ||
===<span id="GUIBaseWindow"></span>GUIBaseWindow <span class="SectionLink">([[GUIBaseWindow|Full Article]])</span>=== | ===<span id="GUIBaseWindow"></span>GUIBaseWindow <span class="SectionLink">([[GUIBaseWindow|Full Article]])</span>=== | ||
| + | A basic panel that can hold components somewhere on the screen | ||
| + | |||
===<span id="GUIButton"></span>GUIButton <span class="SectionLink">([[GUIButton|Full Article]])</span>=== | ===<span id="GUIButton"></span>GUIButton <span class="SectionLink">([[GUIButton|Full Article]])</span>=== | ||
| + | A component representing a clickable button | ||
| + | |||
===<span id="GUIChatSurface"></span>GUIChatSurface <span class="SectionLink">([[GUIChatSurface|Full Article]])</span>=== | ===<span id="GUIChatSurface"></span>GUIChatSurface <span class="SectionLink">([[GUIChatSurface|Full Article]])</span>=== | ||
A GUI surface that can receive chat messages on particular channels | A GUI surface that can receive chat messages on particular channels | ||
| Line 11: | Line 17: | ||
===<span id="GUIChatWebView"></span>GUIChatWebView <span class="SectionLink">([[GUIChatWebView|Full Article]])</span>=== | ===<span id="GUIChatWebView"></span>GUIChatWebView <span class="SectionLink">([[GUIChatWebView|Full Article]])</span>=== | ||
===<span id="GUICollapsiblePanel"></span>GUICollapsiblePanel <span class="SectionLink">([[GUICollapsiblePanel|Full Article]])</span>=== | ===<span id="GUICollapsiblePanel"></span>GUICollapsiblePanel <span class="SectionLink">([[GUICollapsiblePanel|Full Article]])</span>=== | ||
| + | Component representing a panel that expands and collapses from a toggle | ||
| + | |||
===<span id="GUIColorPicker"></span>GUIColorPicker <span class="SectionLink">([[GUIColorPicker|Full Article]])</span>=== | ===<span id="GUIColorPicker"></span>GUIColorPicker <span class="SectionLink">([[GUIColorPicker|Full Article]])</span>=== | ||
| + | Component representing a small dropdown that configures its color through RGB sliders | ||
| + | |||
===<span id="GUIComboBox"></span>GUIComboBox <span class="SectionLink">([[GUIComboBox|Full Article]])</span>=== | ===<span id="GUIComboBox"></span>GUIComboBox <span class="SectionLink">([[GUIComboBox|Full Article]])</span>=== | ||
===<span id="GUIComponent"></span>GUIComponent <span class="SectionLink">([[GUIComponent|Full Article]])</span>=== | ===<span id="GUIComponent"></span>GUIComponent <span class="SectionLink">([[GUIComponent|Full Article]])</span>=== | ||
| Line 17: | Line 27: | ||
===<span id="GUIContainer"></span>GUIContainer <span class="SectionLink">([[GUIContainer|Full Article]])</span>=== | ===<span id="GUIContainer"></span>GUIContainer <span class="SectionLink">([[GUIContainer|Full Article]])</span>=== | ||
| + | A base class for all hierachical GUI windows and components | ||
| + | |||
===<span id="GUIContextMenu"></span>GUIContextMenu <span class="SectionLink">([[GUIContextMenu|Full Article]])</span>=== | ===<span id="GUIContextMenu"></span>GUIContextMenu <span class="SectionLink">([[GUIContextMenu|Full Article]])</span>=== | ||
| + | A specialized form of GUIMenu for when we open context menus | ||
| + | |||
===<span id="GUIDragItem"></span>GUIDragItem <span class="SectionLink">([[GUIDragItem|Full Article]])</span>=== | ===<span id="GUIDragItem"></span>GUIDragItem <span class="SectionLink">([[GUIDragItem|Full Article]])</span>=== | ||
| + | A UI component designed to be dragged and dropped | ||
| + | |||
===<span id="GUIDropdownComponent"></span>GUIDropdownComponent <span class="SectionLink">([[GUIDropdownComponent|Full Article]])</span>=== | ===<span id="GUIDropdownComponent"></span>GUIDropdownComponent <span class="SectionLink">([[GUIDropdownComponent|Full Article]])</span>=== | ||
| + | Abstract class representing components which open to have a panel of subobjects when clicked | ||
| + | |||
===<span id="GUIFilePicker"></span>GUIFilePicker <span class="SectionLink">([[GUIFilePicker|Full Article]])</span>=== | ===<span id="GUIFilePicker"></span>GUIFilePicker <span class="SectionLink">([[GUIFilePicker|Full Article]])</span>=== | ||
| + | Component representing a text field you can use to browse for files from | ||
| + | |||
===<span id="GUIFriendsSurface"></span>GUIFriendsSurface <span class="SectionLink">([[GUIFriendsSurface|Full Article]])</span>=== | ===<span id="GUIFriendsSurface"></span>GUIFriendsSurface <span class="SectionLink">([[GUIFriendsSurface|Full Article]])</span>=== | ||
| + | A surface | ||
| + | |||
===<span id="GUIGrid"></span>GUIGrid <span class="SectionLink">([[GUIGrid|Full Article]])</span>=== | ===<span id="GUIGrid"></span>GUIGrid <span class="SectionLink">([[GUIGrid|Full Article]])</span>=== | ||
| + | A component for gridded layouts where all elements have the same size | ||
| + | |||
===<span id="GUIImageBox"></span>GUIImageBox <span class="SectionLink">([[GUIImageBox|Full Article]])</span>=== | ===<span id="GUIImageBox"></span>GUIImageBox <span class="SectionLink">([[GUIImageBox|Full Article]])</span>=== | ||
| + | Simple component representing an image or icon | ||
| + | |||
===<span id="GUILabel"></span>GUILabel <span class="SectionLink">([[GUILabel|Full Article]])</span>=== | ===<span id="GUILabel"></span>GUILabel <span class="SectionLink">([[GUILabel|Full Article]])</span>=== | ||
| + | A component representing a written text label | ||
| + | |||
===<span id="GUILargeColorPicker"></span>GUILargeColorPicker <span class="SectionLink">([[GUILargeColorPicker|Full Article]])</span>=== | ===<span id="GUILargeColorPicker"></span>GUILargeColorPicker <span class="SectionLink">([[GUILargeColorPicker|Full Article]])</span>=== | ||
| + | A component allowing people to customize a color choice through HSV and RGB options | ||
| + | |||
===<span id="GUILayoutComponent"></span>GUILayoutComponent <span class="SectionLink">([[GUILayoutComponent|Full Article]])</span>=== | ===<span id="GUILayoutComponent"></span>GUILayoutComponent <span class="SectionLink">([[GUILayoutComponent|Full Article]])</span>=== | ||
===<span id="GUIMenu"></span>GUIMenu <span class="SectionLink">([[GUIMenu|Full Article]])</span>=== | ===<span id="GUIMenu"></span>GUIMenu <span class="SectionLink">([[GUIMenu|Full Article]])</span>=== | ||
| + | A component representing a menu of options to pick from | ||
| + | |||
===<span id="GUIPanel"></span>GUIPanel <span class="SectionLink">([[GUIPanel|Full Article]])</span>=== | ===<span id="GUIPanel"></span>GUIPanel <span class="SectionLink">([[GUIPanel|Full Article]])</span>=== | ||
| + | A component representing a panel with layout and subcomponents | ||
| + | |||
===<span id="GUIScrollBox"></span>GUIScrollBox <span class="SectionLink">([[GUIScrollBox|Full Article]])</span>=== | ===<span id="GUIScrollBox"></span>GUIScrollBox <span class="SectionLink">([[GUIScrollBox|Full Article]])</span>=== | ||
| + | A component representing a scrollable surface. | ||
| + | |||
===<span id="GUISearchField"></span>GUISearchField <span class="SectionLink">([[GUISearchField|Full Article]])</span>=== | ===<span id="GUISearchField"></span>GUISearchField <span class="SectionLink">([[GUISearchField|Full Article]])</span>=== | ||
| + | A text field with search functionality | ||
| + | |||
===<span id="GUISelectableComponent"></span>GUISelectableComponent <span class="SectionLink">([[GUISelectableComponent|Full Article]])</span>=== | ===<span id="GUISelectableComponent"></span>GUISelectableComponent <span class="SectionLink">([[GUISelectableComponent|Full Article]])</span>=== | ||
| + | An abstract class for Unity components deriving from Selectable | ||
| + | |||
===<span id="GUISlider"></span>GUISlider <span class="SectionLink">([[GUISlider|Full Article]])</span>=== | ===<span id="GUISlider"></span>GUISlider <span class="SectionLink">([[GUISlider|Full Article]])</span>=== | ||
| + | Component representing a handle we can slide back and forth to adjust a value | ||
| + | |||
===<span id="GUITabControl"></span>GUITabControl <span class="SectionLink">([[GUITabControl|Full Article]])</span>=== | ===<span id="GUITabControl"></span>GUITabControl <span class="SectionLink">([[GUITabControl|Full Article]])</span>=== | ||
| + | A component with two sections - tabs to choose from and a display area where the active tab's panel is shown | ||
| + | |||
===<span id="GUITabItem"></span>GUITabItem <span class="SectionLink">([[GUITabItem|Full Article]])</span>=== | ===<span id="GUITabItem"></span>GUITabItem <span class="SectionLink">([[GUITabItem|Full Article]])</span>=== | ||
| + | A tab item inside a TabControl with an associated panel | ||
| + | |||
===<span id="GUITextArea"></span>GUITextArea <span class="SectionLink">([[GUITextArea|Full Article]])</span>=== | ===<span id="GUITextArea"></span>GUITextArea <span class="SectionLink">([[GUITextArea|Full Article]])</span>=== | ||
| + | A multi-line scrollbox-enabled text area | ||
| + | |||
===<span id="GUITextField"></span>GUITextField <span class="SectionLink">([[GUITextField|Full Article]])</span>=== | ===<span id="GUITextField"></span>GUITextField <span class="SectionLink">([[GUITextField|Full Article]])</span>=== | ||
| + | A component representing a non-scrolling text field. | ||
| + | |||
===<span id="GUIToggle"></span>GUIToggle <span class="SectionLink">([[GUIToggle|Full Article]])</span>=== | ===<span id="GUIToggle"></span>GUIToggle <span class="SectionLink">([[GUIToggle|Full Article]])</span>=== | ||
| + | A component representing a control that can toggle between true and false states | ||
| + | |||
===<span id="GUITree"></span>GUITree <span class="SectionLink">([[GUITree|Full Article]])</span>=== | ===<span id="GUITree"></span>GUITree <span class="SectionLink">([[GUITree|Full Article]])</span>=== | ||
A UI component representing a hierarchical tree of nodes (like in File Explorers) | A UI component representing a hierarchical tree of nodes (like in File Explorers) | ||
===<span id="GUITreeNode"></span>GUITreeNode <span class="SectionLink">([[GUITreeNode|Full Article]])</span>=== | ===<span id="GUITreeNode"></span>GUITreeNode <span class="SectionLink">([[GUITreeNode|Full Article]])</span>=== | ||
| + | Component representing a node in a GUITree | ||
| + | |||
===<span id="GUIWebView"></span>GUIWebView <span class="SectionLink">([[GUIWebView|Full Article]])</span>=== | ===<span id="GUIWebView"></span>GUIWebView <span class="SectionLink">([[GUIWebView|Full Article]])</span>=== | ||
A UI component representing a web page | A UI component representing a web page | ||
===<span id="GUIWindow"></span>GUIWindow <span class="SectionLink">([[GUIWindow|Full Article]])</span>=== | ===<span id="GUIWindow"></span>GUIWindow <span class="SectionLink">([[GUIWindow|Full Article]])</span>=== | ||
| + | A "standard" window that includes a draggable area, resize features, and a close button | ||
| + | |||
===<span id="NetworkConfirmation"></span>NetworkConfirmation <span class="SectionLink">([[NetworkConfirmation|Full Article]])</span>=== | ===<span id="NetworkConfirmation"></span>NetworkConfirmation <span class="SectionLink">([[NetworkConfirmation|Full Article]])</span>=== | ||
| + | A component for showing network messages in the notification area in the bottom right | ||
| + | |||
===<span id="PopupWindow"></span>PopupWindow <span class="SectionLink">([[PopupWindow|Full Article]])</span>=== | ===<span id="PopupWindow"></span>PopupWindow <span class="SectionLink">([[PopupWindow|Full Article]])</span>=== | ||
| + | Popup windows of all types (Confirm, Error, Info, Text Input) | ||
| + | |||
===<span id="TooltipWindow"></span>TooltipWindow <span class="SectionLink">([[TooltipWindow|Full Article]])</span>=== | ===<span id="TooltipWindow"></span>TooltipWindow <span class="SectionLink">([[TooltipWindow|Full Article]])</span>=== | ||
| + | An instance of the window that appears when displaying tooltips over a UI element or World element. | ||
| + | |||
__NOTOC____NOEDITSECTION__ | __NOTOC____NOEDITSECTION__ | ||
Revision as of 17:58, 27 April 2017
Remarks [edit]
GUI3DView (Full Article)
A surface to display a MiniDOM camera
GUI3DWindow (Full Article)
GUIBaseWindow (Full Article)
A basic panel that can hold components somewhere on the screen
GUIButton (Full Article)
A component representing a clickable button
GUIChatSurface (Full Article)
A GUI surface that can receive chat messages on particular channels
GUIChatWebView (Full Article)
GUICollapsiblePanel (Full Article)
Component representing a panel that expands and collapses from a toggle
GUIColorPicker (Full Article)
Component representing a small dropdown that configures its color through RGB sliders
GUIComboBox (Full Article)
GUIComponent (Full Article)
This is the base class for all GUI components. More
GUIContainer (Full Article)
A base class for all hierachical GUI windows and components
GUIContextMenu (Full Article)
A specialized form of GUIMenu for when we open context menus
GUIDragItem (Full Article)
A UI component designed to be dragged and dropped
GUIDropdownComponent (Full Article)
Abstract class representing components which open to have a panel of subobjects when clicked
GUIFilePicker (Full Article)
Component representing a text field you can use to browse for files from
GUIFriendsSurface (Full Article)
A surface
GUIGrid (Full Article)
A component for gridded layouts where all elements have the same size
GUIImageBox (Full Article)
Simple component representing an image or icon
GUILabel (Full Article)
A component representing a written text label
GUILargeColorPicker (Full Article)
A component allowing people to customize a color choice through HSV and RGB options
GUILayoutComponent (Full Article)
GUIMenu (Full Article)
A component representing a menu of options to pick from
GUIPanel (Full Article)
A component representing a panel with layout and subcomponents
GUIScrollBox (Full Article)
A component representing a scrollable surface.
GUISearchField (Full Article)
A text field with search functionality
GUISelectableComponent (Full Article)
An abstract class for Unity components deriving from Selectable
GUISlider (Full Article)
Component representing a handle we can slide back and forth to adjust a value
GUITabControl (Full Article)
A component with two sections - tabs to choose from and a display area where the active tab's panel is shown
GUITabItem (Full Article)
A tab item inside a TabControl with an associated panel
GUITextArea (Full Article)
A multi-line scrollbox-enabled text area
GUITextField (Full Article)
A component representing a non-scrolling text field.
GUIToggle (Full Article)
A component representing a control that can toggle between true and false states
GUITree (Full Article)
A UI component representing a hierarchical tree of nodes (like in File Explorers)
GUITreeNode (Full Article)
Component representing a node in a GUITree
GUIWebView (Full Article)
A UI component representing a web page
GUIWindow (Full Article)
A "standard" window that includes a draggable area, resize features, and a close button
NetworkConfirmation (Full Article)
A component for showing network messages in the notification area in the bottom right
PopupWindow (Full Article)
Popup windows of all types (Confirm, Error, Info, Text Input)
TooltipWindow (Full Article)
An instance of the window that appears when displaying tooltips over a UI element or World element.
