InterfaceMetaInfo

Metadata of the current project's Lens.

interface MetaInfo {
    activationCamera: LensActivationCamera;
    iconPath: Path;
    isIconSet: boolean;
    lensApplicability: LensApplicability[];
    lensName: string;
    setIcon(externalPath: Path): void;
}

Index

Properties

activationCamera iconPath isIconSet lensApplicability lensName

Methods

Properties

activationCamera

activationCamera: LensActivationCamera

The camera which will be activated when this Lens is turned on.

`Readonly`iconPath

iconPath: Path

The absolute path to the Lens Icon.

`Readonly`isIconSet

isIconSet: boolean

Whether an Lens icon has been set.

lensApplicability

lensApplicability: LensApplicability[]

Where the Lens can be used.

lensName

lensName: string

The publicly visible name of the Lens.

Methods

setIcon

setIcon(externalPath): void
Sets the icon as the Lens' icon.
Parameters
- externalPath: Path
Returns void