Class EditorStyles

THe EditorStyles contains values and styles used throughout the editor.

Index

Constructors

Properties

accentColor animations button color darkBackgroundColor defaultGizmoIconColor defaultGizmoIconSizeInPixels directoryBarTagButton errorFlashColor focusOutlineColor foldout foldoutCompact foldoutCompactDismiss foldoutDismiss hoverBorderColor inspector inspectorTitleLabel kBigSpacing kBorderWidthLarge kBorderWidthMedium kBorderWidthThin kCurveEditorHeader kDefaultFontSize kExpand kLabelWindowStatus kMediumSpacing kResetButton kSmallSpacing kTitleLabel kToggleButton kToggleButtonNoPadding label materialSectionResourceControl materialSectionTitle pingBackgroundColor pingColor primaryDarkGray primaryMidGray radiusBig radiusMedium radiusSmall sceneOverlayLabel segmentedButton selectionAreaColor selectionAreaOutlineColor selectionColor selectionColorLight settingsWindowTabBar shapes srgbAccentColor srgbFocusOutlineColor tabBar tabBarLarge toolbarButtonSize toolbarIconSize toolbarSizeWithHighlight verticallyCenteredLabel viewportMessage

Methods

createDarkBackgroundPanel createInfoBox getIcon getSVGIcon getToolbarIcon

Constructors

constructor

new EditorStyles(): EditorStyles
Returns EditorStyles

Properties

`Static` `Readonly`accentColor

accentColor: SRGBColor

`Static` `Readonly`animations

animations: {
onPing: ((element: UIElement, onPingRequested: (() => void)) => void);
}

Different animations used for UIElement objects in the editor.

Type declaration

onPing: ((element: UIElement, onPingRequested: (() => void)) => void)
Applied on objects that are the source for a library resource ping. The ping should be executed in onPingRequested.
- - (element, onPingRequested): void
  - Parameters
    - element: UIElement
    - onPingRequested: (() => void)
      (): void
      Returns void
    Returns void

`Static` `Readonly`button

button: {
    borderless: string;
    borderlessDark: string;
    default: string;
    header: {
        accessory: string;
        accessoryHelp: string;
    };
    keyWindow: {
        containerLabelButton: string;
    };
    labelBadge: string;
    labelBadgeBlue: string;
    large: {
        danger: string;
        default: string;
        success: string;
    };
    toolbar: {
        default: string;
        defaultVertical: string;
        segmentedButton: string;
    };
}

Style for UIElements in the context of a UIButton

Type declaration

borderless: string
borderlessDark: string
default: string
The default button style.
header: {
accessory: string;
accessoryHelp: string;
}
- accessory: string
  A button style, when used as accessory for a UIHeaderLabel.
- accessoryHelp: string
  A button style, when used as 'Help' accessory for a UIHeaderLabel.
keyWindow: {
containerLabelButton: string;
}
- containerLabelButton: string
labelBadge: string
labelBadgeBlue: string
large: {
    danger: string;
    default: string;
    success: string;
}
- danger: string
  A larger danger button style.
  
  Note
  Used for actions such as a Discard or Destroy button on a sheet.
- default: string
  A larger button style.
  
  Note
  Used for actions such as the OK button on a message box.
- success: string
  A larger success button style.
  
  Note
  Used for actions such as a Save or Accept button on a sheet.
toolbar: {
    default: string;
    defaultVertical: string;
    segmentedButton: string;
}
- default: string
- defaultVertical: string
- segmentedButton: string

`Static` `Readonly`color

color: {
    control: {
        background: SRGBColor;
    };
    danger: SRGBColor;
    documentationHint: SRGBColor;
    element: {
        focusBorder: SRGBColor;
    };
    home: {
        darkSlateGray: Immutable<SRGBColor>;
        lightSlateGray: Immutable<SRGBColor>;
    };
    keyWindow: {
        background: Immutable<SRGBColor>;
    };
    panel: {
        background: {
            border: Immutable<SRGBColor>;
            darkSlateGray: Immutable<SRGBColor>;
            lightSlateGray: Immutable<SRGBColor>;
        };
    };
    success: SRGBColor;
    text: SRGBColor;
    warning: SRGBColor;
}

Different colors used throughout the editor.

Type declaration

control: {
background: SRGBColor;
}
- background: SRGBColor
danger: SRGBColor
A color used for UI elements that indicate a risk.
documentationHint: SRGBColor
element: {
focusBorder: SRGBColor;
}
- focusBorder: SRGBColor
home: {
darkSlateGray: Immutable<SRGBColor>;
lightSlateGray: Immutable<SRGBColor>;
}
- darkSlateGray: Immutable<SRGBColor>
- lightSlateGray: Immutable<SRGBColor>
keyWindow: {
background: Immutable<SRGBColor>;
}
- background: Immutable<SRGBColor>
panel: {
    background: {
        border: Immutable<SRGBColor>;
        darkSlateGray: Immutable<SRGBColor>;
        lightSlateGray: Immutable<SRGBColor>;
    };
}
- background: {
      border: Immutable<SRGBColor>;
      darkSlateGray: Immutable<SRGBColor>;
      lightSlateGray: Immutable<SRGBColor>;
  }
  - border: Immutable<SRGBColor>
  - darkSlateGray: Immutable<SRGBColor>
  - lightSlateGray: Immutable<SRGBColor>
success: SRGBColor
A color used for UI elements that indicate a success or completion event.
text: SRGBColor
The default text color.
warning: SRGBColor
A color used for UI elements that indicate a warning.

`Static` `Readonly`darkBackgroundColor

darkBackgroundColor: SRGBColor

`Static` `Readonly`defaultGizmoIconColor

defaultGizmoIconColor: SRGBColor

`Static` `Readonly`defaultGizmoIconSizeInPixels

defaultGizmoIconSizeInPixels = 72

`Static` `Readonly`directoryBarTagButton

directoryBarTagButton: string

`Static` `Readonly`errorFlashColor

errorFlashColor: Immutable<SRGBColor>

The color to be used when flashing errors on input fields.

`Static` `Readonly`focusOutlineColor

focusOutlineColor: SRGBColor

`Static` `Readonly`foldout

foldout: string

`Static` `Readonly`foldoutCompact

foldoutCompact: string

`Static` `Readonly`foldoutCompactDismiss

foldoutCompactDismiss: string

`Static` `Readonly`foldoutDismiss

foldoutDismiss: string

`Static` `Readonly`hoverBorderColor

hoverBorderColor: Immutable<SRGBColor>

`Static` `Readonly`inspector

inspector: {
    accessoryButton: string;
    accessoryButtonWidth: number;
    windowPadding: RectOffset;
}

Styles for UIElements used in the context of a UIObjectInspector.

`Static` `Readonly`inspectorTitleLabel

inspectorTitleLabel: string

`Static` `Readonly`kBigSpacing

kBigSpacing: number

`Static` `Readonly`kBorderWidthLarge

kBorderWidthLarge: number

A large border width.

`Static` `Readonly`kBorderWidthMedium

kBorderWidthMedium: number

A medium-sized border width.

`Static` `Readonly`kBorderWidthThin

kBorderWidthThin: number

A very thin border width.

`Static` `Readonly`kCurveEditorHeader

kCurveEditorHeader: string

`Static` `Readonly`kDefaultFontSize

kDefaultFontSize: number

`Static` `Readonly`kExpand

kExpand: string

`Static` `Readonly`kLabelWindowStatus

kLabelWindowStatus: string

A label used to display the key state of a window, such as 'Loading...', or 'No object selected'.

`Static` `Readonly`kMediumSpacing

kMediumSpacing: number

`Static` `Readonly`kResetButton

kResetButton: string

`Static` `Readonly`kSmallSpacing

kSmallSpacing: number

`Static` `Readonly`kTitleLabel

kTitleLabel: string

`Static` `Readonly`kToggleButton

kToggleButton: string

`Static` `Readonly`kToggleButtonNoPadding

kToggleButtonNoPadding: string

`Static` `Readonly`label

label: {
    bold: string;
    box: {
        danger: string;
        info: string;
        secondary: string;
        warning: string;
    };
    centered: string;
    default: string;
    header: {
        description: string;
        subtitle: string;
        title: string;
        title1: string;
        title2: string;
    };
    multiline: {
        bold: string;
        centered: string;
        default: string;
    };
}

Styles for UIElements used in the context of a UILabel.

Type declaration

bold: string
box: {
    danger: string;
    info: string;
    secondary: string;
    warning: string;
}
- danger: string
  An danger box label with a background and border. The content is inset. Useful for both single and multi-line content.
- info: string
  An info box label with a background and border. The content is inset. Useful for both single and multi-line content.
- secondary: string
  An secondary box label with a background and border. The content is inset. Useful for both single and multi-line content.
- warning: string
  An warning box label with a background and border. The content is inset. Useful for both single and multi-line content.
centered: string
default: string
header: {
    description: string;
    subtitle: string;
    title: string;
    title1: string;
    title2: string;
}
- description: string
- subtitle: string
- title: string
- title1: string
- title2: string
multiline: {
    bold: string;
    centered: string;
    default: string;
}
- bold: string
- centered: string
- default: string

`Static` `Readonly`materialSectionResourceControl

materialSectionResourceControl: string

`Static` `Readonly`materialSectionTitle

materialSectionTitle: string

`Static` `Readonly`pingBackgroundColor

pingBackgroundColor: Immutable<SRGBColor>

`Static` `Readonly`pingColor

pingColor: Immutable<SRGBColor>

`Static` `Readonly`primaryDarkGray

primaryDarkGray: SRGBColor

`Static` `Readonly`primaryMidGray

primaryMidGray: SRGBColor

`Static` `Readonly`radiusBig

radiusBig: number

`Static` `Readonly`radiusMedium

radiusMedium: number

`Static` `Readonly`radiusSmall

radiusSmall: number

`Static` `Readonly`sceneOverlayLabel

sceneOverlayLabel: string

`Static` `Readonly`segmentedButton

segmentedButton: {
dark: string;
}

Styles for UIElements used in the context of a UISegmentedButton.

`Static` `Readonly`selectionAreaColor

selectionAreaColor: SRGBColor

The fill color used when drawing a selection area over the screen.

`Static` `Readonly`selectionAreaOutlineColor

selectionAreaOutlineColor: SRGBColor

The stroke color used when drawing a selection area over the screen.

`Static` `Readonly`selectionColor

selectionColor: SRGBColor

`Static` `Readonly`selectionColorLight

selectionColorLight: SRGBColor

`Static` `Readonly`settingsWindowTabBar

settingsWindowTabBar = "PreferencesWindowTabBar"

`Static` `Readonly`shapes

shapes: {
    brandIcons: {
        Abstract: string;
        InstaLOD: string;
        InstaMAT: string;
        Polyverse: string;
        RSX: string;
    };
}

Built in shapes.

Type declaration

brandIcons: {
    Abstract: string;
    InstaLOD: string;
    InstaMAT: string;
    Polyverse: string;
    RSX: string;
}
Brand icons for Abstract products.
- Abstract: string
- InstaLOD: string
- InstaMAT: string
- Polyverse: string
- RSX: string

`Static` `Readonly`srgbAccentColor

srgbAccentColor: SRGBColor

`Static` `Readonly`srgbFocusOutlineColor

srgbFocusOutlineColor: SRGBColor

`Static` `Readonly`tabBar

tabBar: string

`Static` `Readonly`tabBarLarge

tabBarLarge: string

`Static` `Readonly`toolbarButtonSize

toolbarButtonSize: number

A constant that determines the size of a toolbar button.

`Static` `Readonly`toolbarIconSize

toolbarIconSize: number

A constant that determines the size of icons on toolbar buttons.

`Static` `Readonly`toolbarSizeWithHighlight

toolbarSizeWithHighlight: number

A constant that determines the size of a toolbar button with the highlight.

`Static` `Readonly`verticallyCenteredLabel

verticallyCenteredLabel: string

`Static` `Readonly`viewportMessage

viewportMessage: string

Methods

`Static`createDarkBackgroundPanel

createDarkBackgroundPanel(): UIPanel
Creates a dark background panel.

Returns UIPanel

`Static`createInfoBox

createInfoBox(message): UILabel
Creates an info box label with the given message.
Parameters
- message: string | I18N
  The message to display in the info box.
Returns UILabel
The info box label.

Note
This should typically convey helpful "Did you know?" style information to the user.

`Static`getIcon

getIcon(icon, size): ResourceHandle<Image>
Gets an image for the given icon with the proper default style.
Parameters
- icon: EnumValue<StockIcon, number>
- size: number
Returns ResourceHandle<Image>

`Static`getSVGIcon

getSVGIcon(type, size?): Image
Gets the editor SVG icon for the given icon.
Parameters
- type: EnumValue<EditorSVGIcon, number>
- Optionalsize: number
Returns Image

`Static`getToolbarIcon

getToolbarIcon(icon): ResourceHandle<Image>
Gets an image for the given icon that is suitable and properly sized for use on a toolbar.
Parameters
- icon: EnumValue<StockIcon, number>
Returns ResourceHandle<Image>

Class EditorStyles

Index

Constructors

Properties

Methods

Constructors

constructor

Returns EditorStyles

Properties

Static ReadonlyaccentColor

Static Readonlyanimations

Type declaration

onPing: ((element: UIElement, onPingRequested: (() => void)) => void)

Parameters

Returns void

Returns void

Static Readonlybutton

Type declaration

borderless: string

borderlessDark: string

default: string

header: { accessory: string; accessoryHelp: string; }

accessory: string

accessoryHelp: string

keyWindow: { containerLabelButton: string; }

containerLabelButton: string

labelBadge: string

labelBadgeBlue: string

large: { danger: string; default: string; success: string; }

danger: string

Note

default: string

Note

success: string

Note

toolbar: { default: string; defaultVertical: string; segmentedButton: string; }

default: string

defaultVertical: string

segmentedButton: string

Static Readonlycolor

Type declaration

control: { background: SRGBColor; }

background: SRGBColor

danger: SRGBColor

documentationHint: SRGBColor

element: { focusBorder: SRGBColor; }

focusBorder: SRGBColor

home: { darkSlateGray: Immutable<SRGBColor>; lightSlateGray: Immutable<SRGBColor>; }

darkSlateGray: Immutable<SRGBColor>

lightSlateGray: Immutable<SRGBColor>

keyWindow: { background: Immutable<SRGBColor>; }

background: Immutable<SRGBColor>

panel: { background: { border: Immutable<SRGBColor>; darkSlateGray: Immutable<SRGBColor>; lightSlateGray: Immutable<SRGBColor>; }; }

background: { border: Immutable<SRGBColor>; darkSlateGray: Immutable<SRGBColor>; lightSlateGray: Immutable<SRGBColor>; }

border: Immutable<SRGBColor>

darkSlateGray: Immutable<SRGBColor>

lightSlateGray: Immutable<SRGBColor>

success: SRGBColor

text: SRGBColor

warning: SRGBColor

Static ReadonlydarkBackgroundColor

Static ReadonlydefaultGizmoIconColor

Static ReadonlydefaultGizmoIconSizeInPixels

Static ReadonlydirectoryBarTagButton

Static ReadonlyerrorFlashColor

Static ReadonlyfocusOutlineColor

Static Readonlyfoldout

Static ReadonlyfoldoutCompact

Static ReadonlyfoldoutCompactDismiss

Static ReadonlyfoldoutDismiss

Static ReadonlyhoverBorderColor

Static Readonlyinspector

Static ReadonlyinspectorTitleLabel

Static ReadonlykBigSpacing

Static ReadonlykBorderWidthLarge

Static ReadonlykBorderWidthMedium

Static ReadonlykBorderWidthThin

Static ReadonlykCurveEditorHeader

Static ReadonlykDefaultFontSize

Static ReadonlykExpand

`Static` `Readonly`accentColor

`Static` `Readonly`animations

`Static` `Readonly`button

header: {
accessory: string;
accessoryHelp: string;
}

keyWindow: {
containerLabelButton: string;
}

large: {
danger: string;
default: string;
success: string;
}

toolbar: {
default: string;
defaultVertical: string;
segmentedButton: string;
}

`Static` `Readonly`color

control: {
background: SRGBColor;
}

element: {
focusBorder: SRGBColor;
}

home: {
darkSlateGray: Immutable<SRGBColor>;
lightSlateGray: Immutable<SRGBColor>;
}

keyWindow: {
background: Immutable<SRGBColor>;
}

panel: {
background: {
border: Immutable<SRGBColor>;
darkSlateGray: Immutable<SRGBColor>;
lightSlateGray: Immutable<SRGBColor>;
};
}

background: {
border: Immutable<SRGBColor>;
darkSlateGray: Immutable<SRGBColor>;
lightSlateGray: Immutable<SRGBColor>;
}

`Static` `Readonly`darkBackgroundColor

`Static` `Readonly`defaultGizmoIconColor

`Static` `Readonly`defaultGizmoIconSizeInPixels

`Static` `Readonly`directoryBarTagButton

`Static` `Readonly`errorFlashColor

`Static` `Readonly`focusOutlineColor

`Static` `Readonly`foldout

`Static` `Readonly`foldoutCompact

`Static` `Readonly`foldoutCompactDismiss

`Static` `Readonly`foldoutDismiss

`Static` `Readonly`hoverBorderColor

`Static` `Readonly`inspector

`Static` `Readonly`inspectorTitleLabel

`Static` `Readonly`kBigSpacing

`Static` `Readonly`kBorderWidthLarge

`Static` `Readonly`kBorderWidthMedium

`Static` `Readonly`kBorderWidthThin

`Static` `Readonly`kCurveEditorHeader

`Static` `Readonly`kDefaultFontSize

`Static` `Readonly`kExpand

`Static` `Readonly`kLabelWindowStatus

`Static` `Readonly`kMediumSpacing

`Static` `Readonly`kResetButton

`Static` `Readonly`kSmallSpacing

`Static` `Readonly`kTitleLabel

`Static` `Readonly`kToggleButton

`Static` `Readonly`kToggleButtonNoPadding

`Static` `Readonly`label

box: {
danger: string;
info: string;
secondary: string;
warning: string;
}

header: {
description: string;
subtitle: string;
title: string;
title1: string;
title2: string;
}

multiline: {
bold: string;
centered: string;
default: string;
}

`Static` `Readonly`materialSectionResourceControl

`Static` `Readonly`materialSectionTitle

`Static` `Readonly`pingBackgroundColor

`Static` `Readonly`pingColor

`Static` `Readonly`primaryDarkGray

`Static` `Readonly`primaryMidGray

`Static` `Readonly`radiusBig

`Static` `Readonly`radiusMedium

`Static` `Readonly`radiusSmall

`Static` `Readonly`sceneOverlayLabel

`Static` `Readonly`segmentedButton

`Static` `Readonly`selectionAreaColor

`Static` `Readonly`selectionAreaOutlineColor

`Static` `Readonly`selectionColor

`Static` `Readonly`selectionColorLight

`Static` `Readonly`settingsWindowTabBar

`Static` `Readonly`shapes

brandIcons: {
Abstract: string;
InstaLOD: string;
InstaMAT: string;
Polyverse: string;
RSX: string;
}

`Static` `Readonly`srgbAccentColor

`Static` `Readonly`srgbFocusOutlineColor

`Static` `Readonly`tabBar

`Static` `Readonly`tabBarLarge

`Static` `Readonly`toolbarButtonSize

`Static` `Readonly`toolbarIconSize

`Static` `Readonly`toolbarSizeWithHighlight

`Static` `Readonly`verticallyCenteredLabel

`Static` `Readonly`viewportMessage

`Static`createDarkBackgroundPanel

`Static`createInfoBox

`Static`getIcon