Skip to main content

Editor.Assets.VectorComposite

Class

Vector graphics asset created by importing an SVG file.

Index

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

readonly cacheFile: Path

Path to the cached asset file.

Inherited from

Asset.cacheFile


fileMeta

readonly fileMeta: AssetImportMetadata

Import metadata for the asset.

Inherited from

Asset.fileMeta


id

readonly id: Uuid

The unique id of the entity.

Inherited from

Asset.id


meta

readonly meta: Meta

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

Inherited from

Asset.meta


name

readonly name: string

The name of the asset.

Inherited from

Asset.name


type

readonly type: string

The entity's type.

Inherited from

Asset.type

Methods

getDirectlyReferencedEntities()

getDirectlyReferencedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Asset.getDirectlyReferencedEntities


getMeta()

static getMeta(): Meta

Returns metadata about this type.

Returns

Meta

Inherited from

Asset.getMeta


getOwnedEntities()

getOwnedEntities(): Entity[]

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

Returns

Entity[]

Inherited from

Asset.getOwnedEntities


getTypeName()

static getTypeName(): string

Returns the type name of this class.

Returns

string

Overrides

Asset.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

Asset.getTypeName


isOfType()

isOfType(type): boolean

Returns true if the object is of the specified type.

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

Asset.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

Asset.isSame