Skip to main content

Editor.Assets.ImageMarker

Class

A LensScripting.MarkerAsset for use with Editor.Components.MarkerTrackingComponent

Index

Example

// Create the asset
const imageMarker = assetManager.createNativeAsset('ImageMarker', 'Image Marker [EDIT_ME]', destination);

// Ask user for the file they want to use as image marker
import * as Ui from 'LensStudio:Ui';
const gui = pluginSystem.findInterface(Ui.IGui);
const filename = gui.dialogs.selectFileToOpen({ 'caption': 'Select image for the marker', 'filter': '*.png *.jpeg *.jpg' }, '')

// Import the image, and use it as the marker's texture
const importedTextureMeta = await assetManager.importExternalFileAsync(filename, destination, Editor.Model.ResultType.Auto);
imageMarker.texture = importedTextureMeta.primary;

Extends

Properties

cacheFile

readonly cacheFile: Path

Path to the cached asset file.

Inherited from

MarkerAsset.cacheFile


fileMeta

readonly fileMeta: AssetImportMetadata

Import metadata for the asset.

Inherited from

MarkerAsset.fileMeta


height

height: number

Height of the marker in units.

Inherited from

MarkerAsset.height


id

readonly id: Uuid

The unique id of the entity.

Inherited from

MarkerAsset.id


meta

readonly meta: Meta

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

Inherited from

MarkerAsset.meta


name

readonly name: string

The name of the asset.

Inherited from

MarkerAsset.name


texture

texture: FileTexture

The texture used as the image marker.


type

readonly type: string

The entity's type.

Inherited from

MarkerAsset.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

A list of entities which this entity has a reference to.

Returns

Entity[]

Inherited from

MarkerAsset.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Overrides

MarkerAsset.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

A list of entities which has a reference to this entity.

Returns

Entity[]

Inherited from

MarkerAsset.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

MarkerAsset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

MarkerAsset.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

MarkerAsset.isOfType


isSame()

isSame(other): boolean

Returns true if this object refers to the same instance as the given object.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

MarkerAsset.isSame