The Viewer.
Plugin configuration.
ID for this Plugin, unique within its Viewer.
The Viewer that contains this Plugin.
Gets the custom data source through which the XKTLoaderPlugin can load models and metadata.
Default value is {@link XKTDefaultDataSource}, which loads via HTTP.
Sets a custom data source through which the XKTLoaderPlugin can load models and metadata.
Default value is {@link XKTDefaultDataSource}, which loads via HTTP.
Gets the blacklist of IFC types that are never loaded by this XKTLoaderPlugin.
When loading models with metadata, causes this XKTLoaderPlugin to not load objects whose types are in this list. An object's type is indicated by its MetaObject's MetaObject.type.
Default value is undefined.
Sets the blacklist of IFC types that are never loaded by this XKTLoaderPlugin.
When loading models with metadata, causes this XKTLoaderPlugin to not load objects whose types are in this list. An object's type is indicated by its MetaObject's MetaObject.type.
Default value is undefined.
Gets whether we load objects that don't have IFC types.
When loading models with metadata and this is true, XKTLoaderPlugin will not load objects
that don't have IFC types.
Default value is false.
Sets whether we load objects that don't have IFC types.
When loading models with metadata and this is true, XKTLoaderPlugin will not load objects
that don't have IFC types.
Default value is false.
Gets whether XKTLoaderPlugin globalizes each Entity.id and MetaObject.id as it loads a model.
Default value is false.
Sets whether XKTLoaderPlugin globalizes each Entity.id and MetaObject.id as it loads a model.
Set this true when you need to load multiple instances of the same model, to avoid ID clashes
between the objects in the different instances.
When we load a model with this set true, then each Entity.id and MetaObject.id will be
prefixed by the ID of the model, ie. <modelId>.<objectId>.
Entity.originalSystemId and MetaObject.originalSystemId will always hold the original, un-prefixed, ID values.
Default value is false.
See the main XKTLoaderPlugin class documentation for usage info.
Gets the whitelist of the IFC types loaded by this XKTLoaderPlugin.
When loading models with metadata, causes this XKTLoaderPlugin to only load objects whose types are in this list. An object's type is indicated by its MetaObject's MetaObject.type.
Default value is undefined.
Sets the whitelist of the IFC types loaded by this XKTLoaderPlugin.
When loading models with metadata, causes this XKTLoaderPlugin to only load objects whose types are in this list. An object's type is indicated by its MetaObject's MetaObject.type.
Default value is undefined.
Gets map of initial default states for each loaded Entity that represents an object.
Sets map of initial default states for each loaded Entity that represents an object.
Gets whether XKTLoaderPlugin enables geometry reuse when loading models.
Default value is true.
Sets whether XKTLoaderPlugin enables geometry reuse when loading models.
Default value is true.
Geometry reuse saves memory, but can impact Viewer performance when there are many reused geometries. For
this reason, we can set this false to disable geometry reuse for models loaded by this XKTLoaderPlugin
(which will then "expand" the geometry instances into batches instead).
The result will be be less WebGL draw calls (which are expensive), at the cost of increased memory footprint.
See .769 for more info.
Gets the .xkt format versions supported by this XKTLoaderPlugin/
Destroys this Plugin and removes it from its Viewer.
Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
Fires an event at this Plugin.
The event type name
The event parameters
Loads an .xkt model into this XKTLoaderPlugin's Viewer.
Since xeokit/xeokit-sdk 1.9.0, XKTLoaderPlugin has supported XKT 8, which bundles the metamodel data (eg. an IFC element hierarchy) in the XKT file itself. For XKT 8, we therefore no longer need to load the metamodel data from a separate accompanying JSON file, as we did with previous XKT versions. However, if we do choose to specify a separate metamodel JSON file to load (eg. for backward compatibility in data pipelines), then that metamodel will be loaded and the metamodel in the XKT 8 file will be ignored.
Loading parameters.
Entity representing the model, which will have Entity.isModel set true and will be registered by Entity.id in Scene.models.
Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
Subscribes to an event fired at this Plugin.
The event
Callback fired on the event
Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
Generated using TypeDoc
Viewer plugin that loads models from xeokit's optimized
.XKTformat.