Class Asset

constructor

• new Asset(): Bit.Asset

  Returns Bit.Asset

assetManager

toArrayBuffer

• toArrayBuffer(inputs: FileDto): Promise<ArrayBuffer>

  Reads all the bytes of a File or Blob into an ArrayBuffer, the form binary loaders and the STEP converters take.

  Parameters

  • inputs: FileDto

    The File or Blob to read

  Returns Promise<ArrayBuffer>

  The bytes as an ArrayBuffer

  Example

  const buffer = await bitbybit.asset.toArrayBuffer({ file });
  Copy

toUint8Array

• toUint8Array(inputs: FileDto): Promise<Uint8Array<ArrayBufferLike>>

  Reads all the bytes of a File or Blob into a Uint8Array, a byte array that can be indexed and sliced.

  Parameters

  • inputs: FileDto

    The File or Blob to read

  Returns Promise<Uint8Array<ArrayBufferLike>>

  The bytes as a Uint8Array

  Example

  const bytes = await bitbybit.asset.toUint8Array({ file });
  Copy

blobToFile

• blobToFile(inputs: BlobToFileDto): File

  Wraps a Blob in a File with a name and a MIME type, which loaders that want a file name need; the Blob's own type is kept when mimeType is left out.

  Parameters

  • inputs: BlobToFileDto

    The Blob, the file name and the optional MIME type

  Returns File

  The File

  Example

  const file = bitbybit.asset.blobToFile({ blob, fileName: "part.step", mimeType: "application/step" });
  Copy

fileToBlob

• fileToBlob(inputs: FileDto): Blob

  Copies the bytes of a File into a plain Blob of the same type, dropping the name; a Blob given in comes back as a copy.

  Parameters

  • inputs: FileDto

    The File or Blob to copy

  Returns Blob

  The Blob

  Example

  const blob = bitbybit.asset.fileToBlob({ file });
  Copy

arrayBufferToUint8Array

• arrayBufferToUint8Array(inputs: ArrayBufferToUint8ArrayDto): Uint8Array

  Views the bytes of an ArrayBuffer as a Uint8Array; no bytes are copied, both share the same memory.

  Parameters

  • inputs: ArrayBufferToUint8ArrayDto

    The ArrayBuffer to view

  Returns Uint8Array

  The Uint8Array over the same bytes

  Example

  const bytes = bitbybit.asset.arrayBufferToUint8Array({ arrayBuffer });
  Copy

uint8ArrayToArrayBuffer

• uint8ArrayToArrayBuffer(inputs: Uint8ArrayToArrayBufferDto): ArrayBuffer

  Copies exactly the bytes a Uint8Array covers into a new ArrayBuffer, so a view over part of a larger buffer gives only its own part.

  Parameters

  • inputs: Uint8ArrayToArrayBufferDto

    The Uint8Array to copy

  Returns ArrayBuffer

  The new ArrayBuffer

  Example

  const buffer = bitbybit.asset.uint8ArrayToArrayBuffer({ uint8Array: bytes });
  Copy

createObjectURL

• createObjectURL(inputs: FileDto): string

  Makes a temporary URL for a File or Blob held in memory, so it can be handed to anything that loads from a URL, such as a texture or a model loader.

  The URL lives as long as the page does.

  Parameters

  • inputs: FileDto

    The File or Blob

  Returns string

  The temporary URL

  Example

  const url = bitbybit.asset.createObjectURL({ file });
  Copy

createObjectURLs

• createObjectURLs(inputs: FilesDto): string[]

  Makes a temporary URL for each File or Blob in a list, in the same order, as createObjectURL does for one.

  Parameters

  • inputs: FilesDto

    The Files or Blobs

  Returns string[]

  One temporary URL per file, in the same order

  Example

  const urls = bitbybit.asset.createObjectURLs({ files: [fileA, fileB] });
  Copy

download

• download(inputs: DownloadDto): void

  Starts a browser download of the given content as a file named fileName plus the extension.

  Text content is wrapped in a Blob of the contentType; a Blob is downloaded as it is.

  Parameters

  • inputs: DownloadDto

    The file name, the content, the extension and the content type

  Returns void

  Example

  bitbybit.asset.download({ fileName: "points", content: "x,y,z\n1,2,3", extension: "csv", contentType: "text/csv" });
  Copy

fetchBlob

• fetchBlob(inputs: FetchDto): Promise<Blob>

  Downloads the content at a URL as a Blob, raw bytes without a file name; the server must allow cross-origin requests.

  Parameters

  • inputs: FetchDto

    The URL to fetch

  Returns Promise<Blob>

  The response body as a Blob

  Example

  const blob = await bitbybit.asset.fetchBlob({ url: "https://example.com/models/part.glb" });
  Copy

fetchFile

• fetchFile(inputs: FetchDto): Promise<File>

  Downloads the content at a URL as a File named after the last part of the URL, without its query string; the server must allow cross-origin requests.

  Parameters

  • inputs: FetchDto

    The URL to fetch

  Returns Promise<File>

  The response body as a File

  Example

  const file = await bitbybit.asset.fetchFile({ url: "https://example.com/models/part.step" });
  const shape = await bitbybit.occt.io.loadSTEPorIGES({ assetFile: file, adjustZtoY: true });
  Copy

fetchJSON

• fetchJSON(inputs: FetchDto): Promise<any>

  Downloads the content at a URL and parses it as JSON; the server must allow cross-origin requests and the body must be valid JSON.

  Parameters

  • inputs: FetchDto

    The URL to fetch

  Returns Promise<any>

  The parsed JSON value

  Example

  const settings = await bitbybit.asset.fetchJSON({ url: "https://example.com/data/settings.json" });
  Copy

fetchText

• fetchText(inputs: FetchDto): Promise<string>

  Downloads the content at a URL as plain text; the server must allow cross-origin requests.

  Parameters

  • inputs: FetchDto

    The URL to fetch

  Returns Promise<string>

  The response body as text

  Example

  const csv = await bitbybit.asset.fetchText({ url: "https://example.com/data/points.csv" });
  Copy

getFile

• getFile(inputs: GetAssetDto): Promise<File>

  Loads a named asset of the running application as a File, through the lookup the application supplies in assetManager.getAsset.

  Which store the name is looked up in depends on the application; a missing asset rejects the promise.

  Parameters

  • inputs: GetAssetDto

    The asset's file name

  Returns Promise<File>

  The asset as a File

  Example

  const file = await bitbybit.asset.getFile({ fileName: "part.step" });
  const shape = await bitbybit.occt.io.loadSTEPorIGES({ assetFile: file, adjustZtoY: true });
  Copy

getTextFile

• getTextFile(inputs: GetAssetDto): Promise<string>

  Loads a named asset of the running application and reads it as text, for JSON, CSV or other text files stored as assets.

  Parameters

  • inputs: GetAssetDto

    The asset's file name

  Returns Promise<string>

  The asset's content as text

  Example

  const csv = await bitbybit.asset.getTextFile({ fileName: "points.csv" });
  const rows = bitbybit.csv.parseToArray({ csv, rowSeparator: "\n", columnSeparator: "," });
  Copy

getLocalFile

• getLocalFile(inputs: GetAssetDto): Promise<File | File[]>

  Loads a named local asset, one kept in the browser rather than on a server, through the lookup the application supplies in assetManager.getLocalAsset.

  A name that resolves to several files gives a list.

  Parameters

  • inputs: GetAssetDto

    The asset's file name

  Returns Promise<File | File[]>

  The asset as a File, or a list of Files when the name holds several

  Example

  const file = await bitbybit.asset.getLocalFile({ fileName: "part.step" });
  Copy

getLocalTextFile

• getLocalTextFile(inputs: GetAssetDto): Promise<string | string[]>

  Loads a named local asset, one kept in the browser rather than on a server, and reads it as text; a name that resolves to several files gives a list of texts.

  Parameters

  • inputs: GetAssetDto

    The asset's file name

  Returns Promise<string | string[]>

  The content as text, or a list of texts when the name holds several files

  Example

  const text = await bitbybit.asset.getLocalTextFile({ fileName: "settings.json" });
  Copy