Interface MLComponent

Transforms inputs (Textures or Float32Array) into outputs (Textures or Float32Array) using a neural network. The neural network is represented by an MLAsset, which is set as the model property. For more information, see the MLComponent Overview.

Example

//@input Asset.MLAsset model
var mlComponent = script.sceneObject.createComponent('MLComponent');
mlComponent.model = script.model;
interface MLComponent {
    autoRun: boolean;
    enabled: boolean;
    inferenceMode: InferenceMode;
    model: MLAsset;
    onLoadingFinished: (() => void);
    onRunningFinished: (() => void);
    renderOrder: number;
    sceneObject: SceneObject;
    state: ModelState;
    uniqueIdentifier: string;
    build(placeholders: BasePlaceholder[]): void;
    cancel(): void;
    destroy(): void;
    getInput(name: string): InputPlaceholder;
    getInputs(): InputPlaceholder[];
    getOutput(name: string): OutputPlaceholder;
    getOutputs(): OutputPlaceholder[];
    getSceneObject(): SceneObject;
    getScheduledEnd(): FrameTiming;
    getScheduledStart(): FrameTiming;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isRecurring(): boolean;
    isSame(other: ScriptObject): boolean;
    runImmediate(sync: boolean): void;
    runScheduled(recurring: boolean, startTiming: FrameTiming, endTiming: FrameTiming): void;
    stop(): void;
    waitOnLoading(): void;
    waitOnRunning(): void;
}

Hierarchy (view full)

Properties

autoRun enabled inferenceMode model onLoadingFinished onRunningFinished renderOrder sceneObject state uniqueIdentifier

Methods

build cancel destroy getInput getInputs getOutput getOutputs getSceneObject getScheduledEnd getScheduledStart getTransform getTypeName isOfType isRecurring isSame runImmediate runScheduled stop waitOnLoading waitOnRunning

Properties

autoRun

autoRun: boolean

Runs the MLComponent automatically when the object or component it's on is enabled.

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

inferenceMode

inferenceMode: InferenceMode

Controls the inference mode that MLComponent will run in. For example, GPU, CPU, etc.

model

model: MLAsset

Binary ML model supplied by the user.

onLoadingFinished

onLoadingFinished: (() => void)

Function that gets called when model loading is finished.

onRunningFinished

onRunningFinished: (() => void)

Function that gets called when the model stops running.

renderOrder

renderOrder: number

Render order of the MLComponent.

ReadonlysceneObject

sceneObject: SceneObject

Readonlystate

state: ModelState

Returns the current status of the neural network model.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

build

  • build(placeholders): void

  • Builds the MLComponent model when all placeholders are determined. Config is an array of Input and Output placeholders.

    Parameters

    Returns void

cancel

  • cancel(): void

  • Stops running the MLComponent. The onRunningFinished callback will not be executed.

    Returns void

destroy

  • destroy(): void

  • Destroys the component.

    Returns void

getInput

getInputs

  • getInputs(): InputPlaceholder[]

  • Returns an array of InputPlaceholders of the MLComponent's model with default settings. Returns empty array if the model asset is not set.

    Returns InputPlaceholder[]

getOutput

getOutputs

  • getOutputs(): OutputPlaceholder[]

  • Returns an array of OutputPlaceholders of MLComponent's model with default settings. Returns empty array if the model is not set.

    Returns OutputPlaceholder[]

getSceneObject

getScheduledEnd

getScheduledStart

getTransform

getTypeName

  • getTypeName(): string

  • Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type): boolean

  • Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

isRecurring

  • isRecurring(): boolean

  • Returns true if running is requested on each frame.

    Returns boolean

isSame

  • isSame(other): boolean

  • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

    Parameters

    Returns boolean

runImmediate

  • runImmediate(sync): void

  • Runs the MLComponent once.

    Parameters

    • sync: boolean

    Returns void

runScheduled

  • runScheduled(recurring, startTiming, endTiming): void

  • Schedules the MLComponent to run at the start timing and terminate at the end timing. The scheduled running will recur if recurring is true.

    Parameters

    Returns void

stop

  • stop(): void

  • Stops running the MLComponent.

    Returns void

waitOnLoading

  • waitOnLoading(): void

  • If loading asynchronously, makes the entire system wait until loading is finished.

    Returns void

waitOnRunning

  • waitOnRunning(): void

  • If running asynchronously, makes the entire system wait until the last run is finished.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods