Interface MarkerTrackingComponent

Used to track images in the camera. Moves the containing object's transform to match the detected image. For more information, see the Marker Tracking guide.

Example

//@input Component.MarkerTrackingComponent markerTrackingComponent

// Get whether or not the marker image is being tracked
var isMarkerTracking = script.markerTrackingComponent.isTracking();

// Print current status.
if (isMarkerTracking) {
	print("Image is in Camera feed.");
} else {
	print("Image is NOT in Camera feed.");
}
interface MarkerTrackingComponent {
    autoEnableWhenTracking: boolean;
    enabled: boolean;
    marker: MarkerAsset;
    onMarkerFound: (() => void);
    onMarkerLost: (() => void);
    sceneObject: SceneObject;
    uniqueIdentifier: string;
    destroy(): void;
    getSceneObject(): SceneObject;
    getTransform(): Transform;
    getTypeName(): string;
    isOfType(type: string): boolean;
    isSame(other: ScriptObject): boolean;
    isTracking(): boolean;
}

Hierarchy (view full)

Properties

autoEnableWhenTracking enabled marker onMarkerFound onMarkerLost sceneObject uniqueIdentifier

Methods

destroy getSceneObject getTransform getTypeName isOfType isSame isTracking

Properties

autoEnableWhenTracking

autoEnableWhenTracking: boolean

If true, child objects of this Component's SceneObject will be disabled when the marker image is not being tracked.

enabled

enabled: boolean

If disabled, the Component will stop enacting its behavior.

marker

marker: MarkerAsset

The marker asset describing the tracking target.

onMarkerFound

onMarkerFound: (() => void)

A function that gets called when marker tracking begins.

onMarkerLost

onMarkerLost: (() => void)

A function that gets called when marker tracking is lost.

ReadonlysceneObject

sceneObject: SceneObject

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

destroy

  • destroy(): void

  • Destroys the component.

    Returns void

getSceneObject

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

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

isTracking

  • isTracking(): boolean

  • Returns whether the marker image is currently being tracked in camera.

    Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods