ClassPath

A path in the filesystem, or Asset Manager. Useful for things like importing files into Lens Studio through the Editor.Model.AssetManager.

Example

// Get access to the project's assetManager
const model = this.pluginSystem.findInterface(Editor.Model.IModel);
const assetManager = model.project.assetManager;

// Locate the shader pass we want to import
const resourceLoc = import.meta.resolve('Resources/myMesh.ss_graph');
const absGraphPath = new Editor.Path(resourceLoc);

// Import the shader pass
const pathInAssetManager = new Editor.Path('');
const meta = await assetManager.importExternalFileAsync(absolutePath, pathInAssetManager, Editor.Model.ResultType.Packed);

Constructors

constructor

Properties

extension fileName fileNameBase isEmpty parent

Methods

appended hasExtension isInside relative replaceExtension replaceFileNameBase toString

Constructors

constructor

  • new Path(str): Path

  • Construct a new path object.

    Parameters

    • str: string

    Returns Path

Properties

Readonlyextension

extension: string

The extension of the file of the current path object.

ReadonlyfileName

fileName: Path

The name of the file, including its extension, in the current path object.

ReadonlyfileNameBase

fileNameBase: string

The name of the file, without its extension, in the current path object.

ReadonlyisEmpty

isEmpty: boolean

Readonlyparent

parent: Path

A path to the parent folder of the current path object.

Methods

appended

  • appended(path): Path

  • Returns a new path object relative to the rootPath.

    Parameters

    Returns Path

hasExtension

  • hasExtension(extension): boolean

  • Whether the path object has a file extension in the end.

    Parameters

    • extension: string

    Returns boolean

isInside

  • isInside(directory): boolean

  • Whether the current path is inside directory.

    Parameters

    Returns boolean

relative

  • relative(rootPath): Path

  • Returns a new path object relative to the rootPath.

    Parameters

    Returns Path

replaceExtension

  • replaceExtension(newExtension): Path

  • Rename the extension of the file.

    Parameters

    • newExtension: string

    Returns Path

replaceFileNameBase

  • replaceFileNameBase(name): Path

  • Parameters

    • name: string

    Returns Path

toString

  • toString(): string

  • Returns the current path as a string.

    Returns string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods