new UiStyle()
MEMBERS
-
addUiOutlineCallbackName :string
-
The name of the callback function responsible for returning a UiOutline, which is a customizable rectangular outline. UiOutlines are used throughout the various gui objects, like UiButton, UiTextField, DropdownMenu, PopupMenu etc., and generally contribute to the look of the gui. The provided callback must return an instance of this UiOutline, which is a SceneObject that has 2 additional properties (probably built with getter/setters) 'width' and 'height'. Also, the object produced from this callback will need to have EffectNodes that respond to the 'colorMultiply' EffectController, as that EffectController is used to set the color for the UiPanel for its different uses throughout the ui. This callback is defaults to an internal function that returns a UiOutline that is essentially a rectangle made of 4 WhiteBoxes, but can be changed to customize the look of the gui.
-
addUiOutlineCallbackOwner :object
-
The owner of the callback function responsible for returning a UiOutline, which is a customizable rectangular outline. UiOutlines are used throughout the various gui objects, like UiButton, UiTextField, DropdownMenu, PopupMenu etc., and generally contribute to the look of the gui. The provided callback must return an instance of this UiOutline, which is a SceneObject that has 2 additional properties (probably built with getter/setters) 'width' and 'height'. Also, the object produced from this callback will need to have EffectNodes that respond to the 'colorMultiply' EffectController, as that EffectController is used to set the color for the UiPanel for its different uses throughout the ui. This callback is defaults to an internal function that returns a UiOutline that is essentially a rectangle made of 4 WhiteBoxes, but can be changed to customize the look of the gui.
-
addUiPanelCallbackName :string
-
The name of the callback function responsible for returning a UiPanel, which is a customizable rectangle of color. UiPanels are used throughout the various gui objects, like UiButton, UiTextField, DropdownMenu, PopupMenu etc., and generally contribute to the look of the gui. The provided callback must return an instance of this UiPanel, which is a SceneObject that has 2 additional properties (probably built with getter/setters) 'width' and 'height'. Also, the object produced from this callback will need to have EffectNodes that respond to the 'colorMultiply' EffectController, as that EffectController is used to set the color for the UiPanel for its different uses throughout the ui. This callback is defaults to an internal function that returns a UiPanel that is essentially a WhiteBox, but can be changed to customize the look of the gui.
-
addUiPanelCallbackOwner :object
-
The owner of the callback function responsible for returning a UiPanel, which is a customizable rectangle of color. UiPanels are used throughout the various gui objects, like UiButton, UiTextField, DropdownMenu, PopupMenu etc., and generally contribute to the look of the gui. The provided callback must return an instance of this UiPanel, which is a SceneObject that has 2 additional properties (probably built with getter/setters) 'width' and 'height'. Also, the object produced from this callback will need to have EffectNodes that respond to the 'colorMultiply' EffectController, as that EffectController is used to set the color for the UiPanel for its different uses throughout the ui. This callback is defaults to an internal function that returns a UiPanel that is essentially a WhiteBox, but can be changed to customize the look of the gui.
-
color_brightHighlightedButtonPanel :Color
-
The default color for bright highlighted button panels.
-
color_buttonPanel :Color
-
The default color for button panels.
-
color_darkPanelBackground :Color
-
The default color for dark background panels.
-
color_editorBackgroundDark :Color
-
The default color for the dark parts of editor backgrounds.
-
color_editorBackgroundLight :Color
-
The default color for the light parts of editor backgrounds.
-
color_highlightedButtonPanel :Color
-
The default color for highlighted button panels.
-
color_highlightedInteractiveText :Color
-
The default color for highlighted interactive text.
-
color_inactiveText :Color
-
The default color for text that is not active.
-
color_interactiveText :Color
-
The default color for interactive text.
-
color_lightPanelBackground :Color
-
The default color for light background panels.
-
color_mainPanelBackground :Color
-
The default color for background panels.
-
color_mainText :Color
-
The default color for text.
-
color_navigationOutline :Color
-
The default color for navigation outlining and highlighting.
-
color_panelHeader :Color
-
The default color for header panels.
-
color_panelHeaderHighlight :Color
-
The default color for highlighted header panels.
-
color_selection :Color
-
The default color for selected UI objects.
-
color_selectionOutlineBase :Color
-
A deeper, more saturated version of 'color_selection'.
-
color_semiInteractiveText :Color
-
The default color for semi-interactive text.
-
graphicAssetName_caret :string
-
The name of the GraphicAsset to use wherever a caret icon (basically an arrow) is needed in UI components.
-
graphicAssetName_checkmark :string
-
The name of the GraphicAsset to use wherever a checkmark icon is needed in UI components.
-
graphicAssetName_ex :string
-
The name of the GraphicAsset to use wherever an 'X' icon is needed in UI components.
-
graphicAssetName_magnifyingglass :string
-
The name of the GraphicAsset to use wherever a magnifying glass icon (like next to a search bar) is needed in UI components.
-
graphicAssetName_minus :string
-
The name of the GraphicAsset to use wherever an '-' icon is needed in UI components.
-
inheritedTypes :object
-
Dictionary object listing all of the types this object is compatible with.
-
spacer_large :number
-
The standard 'large' spacer for the gui.
-
spacer_medium :number
-
The standard 'medium' spacer for the gui.
-
spacer_small :number
-
The standard 'small' spacer for the gui.
-
spacer_tiny :number
-
The standard 'tiny' spacer for the gui.
-
textFormat_body :TextFormat
-
The default TextFormat for body text in the Gui.
-
textFormat_heading :TextFormat
-
The default TextFormat for heading text in the Gui.
-
textFormat_subHeading :TextFormat
-
The default TextFormat for sub-heading text in the Gui.
-
textFormat_technical :TextFormat
-
The default TextFormat for technical text in the Gui.
-
textFormat_tiny :TextFormat
-
The default TextFormat for tiny text in the Gui.
-
type :string
-
Type identifier.
METHODS
-
addUiOutline(parent (opt), name (opt)) returns {UiOutline}
-
Adds a new UiOutline to the given parent SceneObject.
Parameters:
Name Type Attributes Default Description parentSceneObject <optional>
The parent SceneObject that the new UiOutline will become a child of. [DEFAULT: nc.mainScene]
namestring <optional>
The name of the new UiOutline. [DEFAULT: 'UiOutline']
Returns:
UiOutline -
addUiPanel(parent (opt), name (opt)) returns {UiPanel}
-
Adds a new UiPanel to the given parent SceneObject.
Parameters:
Name Type Attributes Default Description parentSceneObject <optional>
The parent SceneObject that the new UiPanel will become a child of. [DEFAULT: nc.mainScene]
namestring <optional>
The name of the new UiPanel. [DEFAULT: 'UiPanel']
Returns:
UiPanel -
standardVisualFeedback(sceneObject)
-
Provides a standardized visual feeback consiting of a fast burst of brightness. This feedback is used for most standardized trigger events such as Button presses and keynavigation triggers.
Parameters:
Name Type Attributes Default Description sceneObjectSceneObject The SceneObject that the visual feeback will be applied to.