Editor Scripting API
    Preparing search index...

    Class SurfaceOptions

    Configuration for surface rendering options.

        const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
        const scene = model.project.scene;

        const obj = scene.createSceneObject('SurfaceTracker');
        const tracking = obj.addComponent('DeviceTracking');
        tracking.deviceTrackingMode = Editor.Components.DeviceTrackingMode.Surface;

        const options = tracking.surfaceOptions;
        options.enhanceWithNativeAR = true;
        console.log(`SurfaceOptions.enhanceWithNativeAR = ${options.enhanceWithNativeAR}`);

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    enhanceWithNativeAR id meta type

    Methods

    getDirectlyReferencedEntities getMeta getOwnedEntities getTypeName getTypeName isOfType isSame

    Constructors

    Properties

    enhanceWithNativeAR: boolean

    Enable native AR enhancement for the surface.

    id: Uuid

    The unique id of the entity.

    meta: Meta

    Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

    type: string

    The entity's type.

    Methods

    • Returns true if the object is of the specified type.

      Parameters

      • type: string

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods