Function sceneObjectAction

  • sceneObjectAction(displayName, requirePickData, onIsVisible?, shortcutModifier?, shortcutKey?, flags?, priority?, platform?): AttributeDecorator<Attribute>

  • An attribute that can be added to a static method to create a new SceneObject action. SceneObject actions allow developers to extend toolbars and context menus for scene object specific actions such as select or duplicate.

    Whenever the associated key combination is pressed in an scene object editing context, the associated method will be invoked.

    Parameters

    • displayName: string

      The name/path of the shortcut action. Use the {name} token to subsitute the token dynamically with the object name.

    • requirePickData: boolean

      True to only display this action if ScenePickingData is available.

    • OptionalonIsVisible: ((sceneObjects: SceneObject[], sceneInstance: SceneInstance, scenePickingData?: ScenePickInformation) => boolean)

      An optional callback invoked to determine if the action should be visible.

    • OptionalshortcutModifier: EnumValue<ButtonModifier, number>

      A modifier key to bind the action to by default.

    • OptionalshortcutKey: EnumValue<ButtonCode, number>

      A key code to bind the action to by default.

    • Optionalflags: EnumValue<ShortcutBindingFlag, number>

      A set of optional flags to be given to the default key binding.

    • Optionalpriority: number

      An optional priority value for the new action.

    • Optionalplatform: EnumValue<ShortcutPlatformID, number>

      The platform for which this shortcut is enabled.

    Returns AttributeDecorator<Attribute>

    Note

    The method must have the following signature

    The scenePickingData is optional and may not be available in all contexts.

Settings

Member Visibility