ProtoTwin API
    Preparing search index...

    Class RemoteMaterialLibrary

    Remote material library.

    A remote material library is loaded from a definition file. The definition file contains the material definitions for the library. A standard library of materials is included by default, but users can create and host their own remote material libraries.

    Hierarchy (View Summary)

    Index

    Accessors

    Methods

    Accessors

    • get materials(): readonly RemoteMaterial[]

      The materials defined in the library.

      Returns readonly RemoteMaterial[]

    • get name(): string

      The library name.

      Returns string

    • get path(): string

      The path to the definition file.

      Returns string

    • set path(path: string): void

      The unique library path.

      Parameters

      • path: string

      Returns void

    Methods