RSX Code Reference
    Preparing search index...
    • rsx
    • EditorStyles

    Class EditorStyles

    THe EditorStyles contains values and styles used throughout the editor.

    Index
    constructor
    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
    createDarkBackgroundPanel createInfoBox getIcon getSVGIcon getToolbarIcon initializeFromSkin
    accentColor: SRGBColor
    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.

    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 }
    • labelBadge: string
    • labelBadgeBlue: string
    • large: { danger: string; default: string; success: string }
      • danger: string

        A larger danger button style.

        Used for actions such as a Discard or Destroy button on a sheet.

      • default: string

        A larger button style.

        Used for actions such as the OK button on a message box.

      • success: string

        A larger success button style.

        Used for actions such as a Save or Accept button on a sheet.

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

    Different colors used throughout the editor.

    Type Declaration

    • control: { background: SRGBColor }
    • danger: SRGBColor

      A color used for UI elements that indicate a risk.

    • documentationHint: SRGBColor
    • element: { focusBorder: SRGBColor }
    • home: { darkSlateGray: SRGBColor; lightSlateGray: SRGBColor }
    • keyWindow: { background: SRGBColor }
    • panel: {
          background: {
              border: Immutable<SRGBColor>;
              darkSlateGray: SRGBColor;
              lightSlateGray: 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.

    darkBackgroundColor: SRGBColor
    defaultGizmoIconColor: SRGBColor
    defaultGizmoIconSizeInPixels: 72
    directoryBarTagButton: string
    errorFlashColor: Immutable<SRGBColor>

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

    focusOutlineColor: SRGBColor
    foldout: string
    foldoutCompact: string
    foldoutCompactDismiss: string
    foldoutDismiss: string
    hoverBorderColor: SRGBColor
    inspector: {
        accessoryButton: string;
        accessoryButtonWidth: number;
        windowPadding: RectOffset;
    }

    Styles for UIElements used in the context of a UIObjectInspector.

    inspectorTitleLabel: string
    kBigSpacing: number
    kBorderWidthLarge: number

    A large border width.

    kBorderWidthMedium: number

    A medium-sized border width.

    kBorderWidthThin: number

    A very thin border width.

    kCurveEditorHeader: string
    kDefaultFontSize: number
    kExpand: string
    kLabelWindowStatus: string

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

    kMediumSpacing: number
    kResetButton: string
    kSmallSpacing: number
    kTitleLabel: string
    kToggleButton: string
    kToggleButtonNoPadding: string
    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.

    materialSectionResourceControl: string
    materialSectionTitle: string
    pingBackgroundColor: SRGBColor
    pingColor: SRGBColor
    primaryDarkGray: SRGBColor
    primaryMidGray: SRGBColor
    radiusBig: number
    radiusMedium: number
    radiusSmall: number
    sceneOverlayLabel: string
    segmentedButton: { dark: string }

    Styles for UIElements used in the context of a UISegmentedButton.

    selectionAreaColor: SRGBColor

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

    selectionAreaOutlineColor: SRGBColor

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

    selectionColor: SRGBColor
    selectionColorLight: SRGBColor
    settingsWindowTabBar: "PreferencesWindowTabBar"
    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.

    srgbAccentColor: SRGBColor
    srgbFocusOutlineColor: SRGBColor
    tabBar: string
    tabBarLarge: string
    toolbarButtonSize: number

    A constant that determines the size of a toolbar button.

    toolbarIconSize: number

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

    toolbarSizeWithHighlight: number

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

    verticallyCenteredLabel: string
    viewportMessage: string

    • Creates a dark background panel.

      Returns UIPanel

    • 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.

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

    • Initializes skin-derived properties from the given UISkin's variables.

      Parameters

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    accentColoranimationsbuttoncolordarkBackgroundColordefaultGizmoIconColordefaultGizmoIconSizeInPixelsdirectoryBarTagButtonerrorFlashColorfocusOutlineColorfoldoutfoldoutCompactfoldoutCompactDismissfoldoutDismisshoverBorderColorinspectorinspectorTitleLabelkBigSpacingkBorderWidthLargekBorderWidthMediumkBorderWidthThinkCurveEditorHeaderkDefaultFontSizekExpandkLabelWindowStatuskMediumSpacingkResetButtonkSmallSpacingkTitleLabelkToggleButtonkToggleButtonNoPaddinglabelmaterialSectionResourceControlmaterialSectionTitlepingBackgroundColorpingColorprimaryDarkGrayprimaryMidGrayradiusBigradiusMediumradiusSmallsceneOverlayLabelsegmentedButtonselectionAreaColorselectionAreaOutlineColorselectionColorselectionColorLightsettingsWindowTabBarshapessrgbAccentColorsrgbFocusOutlineColortabBartabBarLargetoolbarButtonSizetoolbarIconSizetoolbarSizeWithHighlightverticallyCenteredLabelviewportMessage
    Methods