@parametricos/bcf-js
Version:
BCF.js is a BIM Collaboration Format (BCF) reader & parser.
42 lines • 1.52 kB
TypeScript
import { IViewPoint, ITopic, VisualizationInfo, IHeader } from "./schema";
import { IHelpers } from "./IHelpers";
import { Reader, TypedArray, ZipEntry, ZipInfo } from 'unzipit';
import { IProject } from "./schema/project";
export default class BcfReader {
version: string;
bcf_archive: ZipInfo | undefined;
project: IProject | undefined;
markups: Markup[];
helpers: IHelpers;
constructor(version: string, helpers: IHelpers);
read: (src: string | ArrayBuffer | TypedArray | Blob | Reader) => Promise<void>;
getEntry: (name: string) => ZipEntry | undefined;
}
export declare class Markup {
readonly reader: BcfReader;
readonly markup_file: ZipEntry;
header: IHeader | undefined;
topic: ITopic | undefined;
viewpoints: VisualizationInfo[];
constructor(reader: BcfReader, markup: ZipEntry);
read: () => Promise<void>;
private parseMarkup;
private parseViewpoints;
/**
* Parses the png snapshot.
*
* @returns {string} The image in base64String format.
*
* @deprecated This function is deprecated and will be removed in the next version.<br>
* Please use viewpoint.getSnapshot() instead.<br>
*
*/
getViewpointSnapshot: (viewpoint: VisualizationInfo | IViewPoint) => Promise<string | undefined>;
/**
* Parses the png snapshot.
*
* @returns {string} The image in base64String format.
*/
getSnapshot: (guid: string) => Promise<string | undefined>;
}
//# sourceMappingURL=BcfReader.d.ts.map