Reference Source

References

summary
public	F convert2xkt(params: Object, stats: Object): Promise<number> Converts model files into xeokit's native XKT format. Supported source formats are: IFC, CityJSON, glTF, LAZ and LAS. Only bundled in xeokit-convert.cjs.js. Usage `const convert2xkt = require("@xeokit/xeokit-convert/dist/convert2xkt.cjs.js"); const fs = require('fs'); convert2xkt({ sourceData: fs.readFileSync("rme_advanced_sample_project.ifc"), outputXKT: (xtkArrayBuffer) => { fs.writeFileSync("rme_advanced_sample_project.ifc.xkt", xtkArrayBuffer); } }).then(() => { console.log("Converted."); }, (errMsg) => { console.error("Conversion failed: " + errMsg) });`
public	V XKT_INFO: {"xktVersion": number} Provides info on the XKT generated by xeokit-convert.
public	V ClampToEdgeWrapping: number Texture wrapping mode in which the last pixel of the texture stretches to the edge of the mesh.
public	V GIFMediaType: number Media type for GIF images.
public	V JPEGMediaType: number Media type for JPEG images.
public	V LinearFilter: number Texture magnification and minification filter that returns the weighted average of the four nearest texels to the given sample coordinates.
public	V LinearMipMapLinearFilter: number Texture minification filter that chooses two mipmaps that most closely match the size of the pixel being textured, finds within each mipmap the weighted average of the nearest texel to the center of the pixel, then returns the weighted average of those two values.
public	V LinearMipMapNearestFilter: number Texture minification filter that chooses the mipmap that most closely matches the size of the pixel being textured and returns the weighted average of the four nearest texels to the given sample coordinates.
public	V LinearMipmapLinearFilter: number Texture minification filter that chooses two mipmaps that most closely match the size of the pixel being textured, finds within each mipmap the weighted average of the nearest texel to the center of the pixel, then returns the weighted average of those two values.
public	V LinearMipmapNearestFilter: number Texture minification filter that chooses the mipmap that most closely matches the size of the pixel being textured and returns the weighted average of the four nearest texels to the given sample coordinates.
public	V MirroredRepeatWrapping: number Texture wrapping mode in which the texture repeats to infinity, mirroring on each repeat.
public	V NearestFilter: number Texture magnification and minification filter that returns the nearest texel to the given sample coordinates.
public	V NearestMipMapLinearFilter: number Texture minification filter that chooses two mipmaps that most closely match the size of the pixel being textured and returns the nearest texel to the center of the pixel at the given sample coordinates.
public	V NearestMipMapNearestFilter: number Texture minification filter that chooses the mipmap that most closely matches the size of the pixel being textured and returns the nearest texel to the given sample coordinates.
public	V NearestMipmapLinearFilter: number Texture minification filter that chooses two mipmaps that most closely match the size of the pixel being textured and returns the nearest texel to the center of the pixel at the given sample coordinates.
public	V NearestMipmapNearestFilter: number Texture minification filter that chooses the mipmap that most closely matches the size of the pixel being textured and returns the nearest texel to the given sample coordinates.
public	V PNGMediaType: number Media type for PNG images.
public	V RepeatWrapping: number Texture wrapping mode in which the texture repeats to infinity.

XKTModel

summary
public	C XKTEntity An object within an XKTModel.
public	C XKTGeometry An element of reusable geometry within an XKTModel.
public	C XKTMesh Represents the usage of a XKTGeometry by an XKTEntity.
public	C XKTMetaObject A meta object within an XKTModel.
public	C XKTModel A document model that represents the contents of an .XKT file.
public	C XKTPropertySet A property set within an XKTModel.
public	C XKTTexture
public	C XKTTextureSet A set of textures shared by XKTMeshes.
public	C XKTTile A box-shaped 3D region within an XKTModel that contains XKTEntitys.
public	F writeXKTModelToArrayBuffer(xktModel: XKTModel, metaModelJSON: String, stats: Object, options: Object): ArrayBuffer Writes an XKTModel to an ArrayBuffer.

geometryBuilders

summary
public	F buildBoxGeometry(cfg: *): Object Creates box-shaped triangle mesh geometry arrays.
public	F buildBoxLinesGeometry(cfg: *): Object Creates box-shaped line segment geometry arrays.
public	F buildCylinderGeometry(cfg: *): Object Creates cylinder-shaped geometry arrays.
public	F buildGridGeometry(cfg: *): Object Creates grid-shaped geometry arrays..
public	F buildPlaneGeometry(cfg: *): Object Creates plane-shaped geometry arrays.
public	F buildSphereGeometry(cfg: *): Object Creates sphere-shaped geometry arrays.
public	F buildTorusGeometry(cfg: *): Object Creates torus-shaped geometry arrays.
public	F buildVectorTextGeometry(cfg: *): Object Creates wireframe text-shaped geometry arrays.

parsers

summary
public	F parseCityJSONIntoXKTModel(params: Object): Promise Parses a CityJSON model into an XKTModel.
public	F parseGLTFIntoXKTModel(params: Object): Promise Parses glTF into an XKTModel, supporting `.glb` and textures.
public	F parseGLTFIntoXKTModel(params: Object): Promise Parses glTF into an XKTModel, supporting `.glb` and textures.
public	F parseGLTFIntoXKTModel(params: Object): Promise Parses glTF into an XKTModel, supporting `.glb` and textures.
public	F parseGLTFJSONIntoXKTModel(params: Object): Promise Parses glTF JSON into an XKTModel, without `.glb` and textures.
public	F parseIFCIntoXKTModel(params: Object): Promise Parses IFC STEP file data into an XKTModel.
public	F parseLASIntoXKTModel(params: Object): Promise Parses LAS and LAZ point cloud data into an XKTModel.
public	F parseMetaModelIntoXKTModel(params: Object): Promise Parses JSON metamodel into an XKTModel.
public	F parsePCDIntoXKTModel(params: Object): Promise Parses PCD point cloud data into an XKTModel.
public	F async parsePLYIntoXKTModel(params: Object): Promise Parses PLY file data into an XKTModel.
public	F async parseSTLIntoXKTModel(params: Object): Promise Parses STL file data into an XKTModel.

Directories

geometryBuilders