Editor.Assets.VectorComposite
ClassVector graphics asset created by importing an SVG file.
Index
Properties
Methods
Example
// Import SVG artwork into the project. Lens Studio stores an imported .svg file as a VectorComposite asset.
export async function importSvg(
assetManager: Editor.Model.AssetManager,
svgFile: Editor.Path,
): Promise<Editor.Assets.VectorComposite> {
if (!svgFile.toString().toLowerCase().endsWith('.svg')) {
throw new Error(`${svgFile.toString()} is not an SVG file`);
}
const destination = new Editor.Model.SourcePath(new Editor.Path(''), Editor.Model.SourceRootDirectory.Assets);
const result = await assetManager.importExternalFileAsync(svgFile, destination, Editor.Model.ResultType.Unpacked);
if (Editor.isNull(result.primary) || !result.primary.isOfType('VectorComposite')) {
throw new Error(`${svgFile.toString()} did not import as a VectorComposite`);
}
return result.primary as Editor.Assets.VectorComposite;
}
Extends
Properties
cacheFile
readonlycacheFile:Path
Path to the cached asset file.
Inherited from
fileMeta
readonlyfileMeta:AssetImportMetadata
Import metadata for the asset.
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
Asset.getDirectlyReferencedEntities
getMeta()
staticgetMeta():Meta
Returns metadata about this type.
Returns
Inherited from
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