Editor.Assets.SnapcodeMarker
ClassA native asset that can be used with LensScripting.MarkerTrackingComponent Learn more at LensScripting.SnapcodeMarkerProvider.
A native asset that can be used with LensScripting.MarkerTrackingComponent Learn more at LensScripting.SnapcodeMarkerProvider. Import with Editor.Model.AssetManager#createNativeAsset.
Index
Properties
Methods
Example
const model = this.pluginSystem.findInterface(Editor.Model.IModel) as Editor.Model.IModel;
const dest = new Editor.Model.SourcePath(new Editor.Path(''), Editor.Model.SourceRootDirectory.Assets);
// Create a SnapcodeMarker via createNativeAsset and set its height.
// height is in centimeters and must match the printed Snapcode's real-world
// size — tracking accuracy depends on this matching the physical object.
const marker = model.project.assetManager.createNativeAsset(
'SnapcodeMarker', 'MySnapcode', dest
) as Editor.Assets.SnapcodeMarker;
marker.height = 15; // cm
console.log(`SnapcodeMarker: ${marker.name}, height: ${marker.height}`);
// Assign to a MarkerTrackingComponent
const scene = model.project.scene;
const obj = scene.createSceneObject('SnapcodeTracker');
const tracking = obj.addComponent('MarkerTrackingComponent');
tracking.marker = marker;
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
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