Editor.Assets.ImageMarker
ClassA LensScripting.MarkerAsset for use with Editor.Components.MarkerTrackingComponent
Index
Properties
Methods
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
readonlycacheFile:Path
Path to the cached asset file.
Inherited from
fileMeta
readonlyfileMeta:AssetImportMetadata
Import metadata for the asset.
Inherited from
height
height:
number
Height of the marker in units.
Inherited from
id
readonlyid:Uuid
The unique id of the entity.
Inherited from
meta
readonlymeta:Meta
Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.
Inherited from
name
readonlyname:string
The name of the asset.
Inherited from
texture
texture:
FileTexture
The texture used as the image marker.
type
readonlytype:string
The entity's type.
Inherited from
Methods
getDirectlyReferencedEntities()
getDirectlyReferencedEntities():
Entity[]
A list of entities which this entity has a reference to.
Returns
Entity[]
Inherited from
MarkerAsset.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Overrides
getOwnedEntities()
getOwnedEntities():
Entity[]
A list of entities which has a reference to this entity.
Returns
Entity[]
Inherited from
getTypeName()
staticgetTypeName():string
Returns the type name of this class.
Returns
string
Overrides
getTypeName()
getTypeName():
string
Returns the name of this object's type.
Returns
string
Inherited from
isOfType()
isOfType(
type):boolean
Returns true if the object is of the specified type.
Parameters
| Parameter | Type |
|---|---|
type | string |
Returns
boolean
Inherited from
isSame()
isSame(
other):boolean
Returns true if this object refers to the same instance as the given object.
Parameters
| Parameter | Type |
|---|---|
other | ScriptObject |
Returns
boolean