Class InspectorContext

The InspectorContext class provides information used by a InspectorFormLayoutSection to pass context data to its InspectableField instances.

Constructors

constructor

Properties

fields inspectedObject inspector isAlwaysExpandingChildren persistent undoRedo window

Constructors

constructor

  • new InspectorContext(options?): InspectorContext

  • Creates a new context with user-provided persistent property storage.

    Parameters

    • Optionaloptions: {
          customInspector?: CustomInspector<any>;
          object?: object;
          persistent?: SerializableProperties;
          undoRedo?: UndoRedo;
          window?: EditorWindowBase;
      }
      • OptionalcustomInspector?: CustomInspector<any>

        The inspector that owns the field inspector.

      • Optionalobject?: object

        Object that inspector fields are editing.

        Note

        This is also the object that we use to create undo operations for.

      • Optionalpersistent?: SerializableProperties

        Existing object into which to inspectable fields can store persistent data.

      • OptionalundoRedo?: UndoRedo

        The UndoRedo stack of the inspector.

      • Optionalwindow?: EditorWindowBase

        The parent window that owns the inspector fields.

    Returns InspectorContext

Properties

fields

fields: InspectorFieldContainer

The owning InspectorFieldContainer.

ReadonlyinspectedObject

inspectedObject: any

Object that inspector fields are editing.

Readonlyinspector

inspector: CustomInspector<any>

The inspector that owns the InspectorFieldContainer.

isAlwaysExpandingChildren

isAlwaysExpandingChildren: boolean

True to always expand children.

Readonlypersistent

persistent: SerializableProperties

A set of properties that the inspector can read/write. They will be persisted even after the inspector is closed and restored when it is re-opened.

ReadonlyundoRedo

undoRedo: UndoRedo

The undoRedo stack to which commands should be recorded to. If null, no undo/redo commands are recorded.

Readonlywindow

window: EditorWindowBase

The window that owns the inspector fields.

Settings

Member Visibility

On This Page

Constructors
Properties