The default color of the dots, wire and label.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
If set, the wires, dots and labels will have this zIndex (+1 for dots and +2 for labels).
Container DOM element for markers and labels. Defaults to document.body.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
HTML text template for Annotation labels. Defaults to <div></div>. Ignored on Annotations configured with a labelElementId.
HTML text template for Annotation markers. Defaults to <div></div>. Ignored on Annotations configured with a markerElementId.
The amount by which each Annotation is offset from the surface of its Entity when we create the Annotation by supplying a PickResult to AnnotationsPlugin.createAnnotation.
Map of default values to insert into the HTML templates for the marker and label.
Reference of an existing HTML canvas to display the AxisGizmo - either this or canvasId is mandatory. When both values are given, the element reference is always preferred to the ID.
ID of an existing HTML canvas to display the AxisGizmo - either this or canvasElement is mandatory. When both values are given, the element reference is always preferred to the ID.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
Identifies the authoring tool for BCF records.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
Identifies the originating system for BCF records.
A CameraPath that defines the path of a Camera
A custom data source through which the CityJSONLoaderPlugin can load model and metadata files. Defaults to an instance of {@link CityJSONDefaultDataSource}, which loads over HTTP.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
The context, which is passed into the item callbacks. This can also be dynamically set on ContextMenu.context. This must be set before calling ContextMenu.show.
Whether this ContextMenu is initially enabled. ContextMenu.show does nothing while this is false.
Whether this ContextMenu automatically hides whenever we mouse-down or tap anywhere in the page.
The context menu items. These can also be dynamically set on ContextMenu.items. See the class documentation for an example.
Container DOM element for markers and labels. Defaults to document.body.
The default value of the DistanceMeasurements axisVisible property.
The default color of the length dots, wire and label.
The default value of the DistanceMeasurements originVisible property.
The default value of the DistanceMeasurements targetVisible property.
The default value of the DistanceMeasurements visible property.
The default value of the DistanceMeasurements wireVisible property.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
The minimum length, in pixels, of an axis wire beyond which its label is shown.
If set, the wires, dots and labels will have this zIndex (+1 for dots and +2 for labels).
Edge transparency.
RGB edge color.
Edge width in pixels.
Optional ID, unique among all components in the parent Scene, generated automatically when omitted.
Selects a preset EdgeMaterial configuration
Whether to render geometry backfaces when emphasising.
Transparency of xray edges. A value of 0.0 indicates fully transparent, 1.0 is fully opaque.
RGB color of xray edges.
Width of xray edges, in pixels.
Indicates if xray edges are visible.
Indicates if xray surfaces are filled with color.
Transparency of filled xray faces. A value of 0.0 indicates fully transparent, 1.0 is fully opaque.
EmphasisMaterial fill color.
Whether to make the emphasized object appear to float on top of other objects, as if it were "glowing through" them.
Optional ID, unique among all components in the parent Scene, generated automatically when omitted.
Selects a preset EmphasisMaterial configuration - see EmphasisMaterial.presets.
Whether to temporarily have a delay before restoring normal rendering after we stop interacting with the Viewer.
Delay in seconds before restoring normal rendering after we stop interacting with the Viewer.
Whether to temporarily hide edges whenever we interact with the Viewer.
Whether to temporarily hide physically-based rendering (PBR) whenever we interact with the Viewer.
Whether to temporarily hide scalable ambient occlusion (SAO) whenever we interact with the Viewer.
Whether to temporarily hide transparent objects whenever we interact with the Viewer.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
Whether to temporarily down-scale the canvas resolution whenever we interact with the Viewer.
The factor by which we downscale the canvas resolution whenever we interact with the Viewer.
A custom data source through which the GLTFLoaderPlugin can load metadata, glTF and binary attachments. Defaults to an instance of {@link GLTFDefaultDataSource}, which loads over HTTP.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
Map of initial default states for each loaded Entity that represents an object. Default value is IFCObjectDefaults.
Configures whether LASLoaderPlugin assumes that LAS colors are encoded using 8 or 16 bits. Accepted values are 8, 16 an "auto".
A custom data source through which the LASLoaderPlugin can load model and metadata files. Defaults to an instance of {@link LASDefaultDataSource}, which loads over HTTP.
Configures if LASLoaderPlugin assumes that LAS positions are stored in 64-bit floats instead of 32-bit.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
Configures LASLoaderPlugin to load every n points.
Optional ID, unique among all components in the parent Scene, generated automatically when omitted.
Line width in pixels.
Selects a preset LinesMaterial configuration - see LinesMaterial.presets.
The CityJSON file data, as an alternative to the src parameter.
Whether to load metadata on CityJSON objects.
The model's world transform matrix. Overrides the position, scale and rotation parameters. Relative to origin.
The model's World-space double-precision 3D origin. Use this to position the model within xeokit's World coordinate system, using double-precision coordinates.
The model single-precision 3D position, relative to the origin parameter.
The model's orientation, given as Euler angles in degrees, for each of the X, Y and Z axis.
The model's scale.
Path to a CityJSON file, as an alternative to the cityJSON parameter.
Collects model statistics.
When true, allows visible backfaces, wherever specified in the glTF. When false, ignores backfaces.
When xraying, highlighting, selecting or edging, this is the threshold angle between normals of adjacent triangles, below which their shared wireframe edge is not drawn.
Whether or not xeokit renders the model with edges emphasized.
When loading metadata, never loads objects that have MetaObjects with MetaObject.type values in this list.
glTF JSON, as an alternative to the src parameter.
When loading metadata, only loads objects that have MetaObjects with MetaObject.type values in this list.
The model's world transform matrix. Overrides the position, scale and rotation parameters. Relative to origin.
JSON model metadata, as an alternative to the metaModelSrc parameter.
Path to an optional metadata file, as an alternative to the metaModelData parameter.
Map of initial default states for each loaded Entity that represents an object. Default value is IFCObjectDefaults.
The double-precision World-space origin of the model's coordinates.
Set false to load all the materials and textures provided by the glTF file, otherwise leave true to load the default high-performance representation optimized for low memory usage and efficient rendering.
The single-precision position, relative to origin.
The model's orientation, as Euler angles given in degrees, for each of the X, Y and Z axis.
The model's scale.
Path to a glTF file, as an alternative to the gltf parameter.
The LAS file data, as an alternative to the src parameter.
Whether to load metadata for the LAS model.
The model's world transform matrix. Overrides the position, scale and rotation parameters. Relative to origin.
The model's World-space double-precision 3D origin. Use this to position the model within xeokit's World coordinate system, using double-precision coordinates.
The model single-precision 3D position, relative to the origin parameter.
The model's orientation, given as Euler angles in degrees, for each of the X, Y and Z axis.
The model's scale.
Path to a LAS file, as an alternative to the las parameter.
Collects model statistics.
When xraying, highlighting, selecting or edging, this is the threshold angle between normals of adjacent triangles, below which their shared wireframe edge is not drawn.
The model's world transform matrix. Overrides the position, scale and rotation parameters.
Path to an optional metadata file.
The model World-space 3D position.
The model's World-space rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
The model's World-space scale.
Path to an OBJ file.
When true, allows visible backfaces, wherever specified in the 3DXML. When false, ignores backfaces.
When xraying, highlighting, selecting or edging, this is the threshold angle between normals of adjacent triangles, below which their shared wireframe edge is not drawn.
Whether or not to renders the model with edges emphasized.
The model's world transform matrix. Overrides the position, scale and rotation parameters.
The model's World-space double-precision 3D origin. Use this to position the model within xeokit's World coordinate system, using double-precision coordinates.
The model single-precision 3D position, relative to the origin parameter.
The model's orientation, given as Euler angles in degrees, for each of the X, Y and Z axis.
The model's scale.
When true, automatically converts face-oriented normals to vertex normals for a smooth appearance.
When xraying, highlighting, selecting or edging, this is the threshold angle between normals of adjacent triangles, below which their shared wireframe edge is not drawn.
When true, creates a separate Mesh for each group of faces that share the same vertex colors. Only works with binary STL.
Path to an STL file. Overrides the stl parameter.
Contents of an STL file, either binary of ASCII. Overridden by the src parameter.
When we set this true, then we force rendering of backfaces for the model. When we leave this false, then we allow the Viewer to decide when to render backfaces. In that case, the Viewer will hide backfaces on watertight meshes, show backfaces on open meshes, and always show backfaces on meshes when we slice them open with SectionPlanes.
Whether or not xeokit renders the model with edges emphasized.
When loading metadata, never loads objects that have MetaObjects with MetaObject.type values in this list.
When loading metadata and this is true, will only load Entitys that have MetaObjects (that are not excluded). This is useful when we don't want Entitys in the Scene that are not represented within IFC navigation components, such as TreeViewPlugin.
Indicates whether to globalize each Entity.id and MetaObject.id, in case you need to prevent ID clashes with other models.
The IFC file data, as an alternative to the src parameter.
When loading metadata, only loads objects that have MetaObjects with MetaObject.type values in this list.
Whether to load IFC metadata (metaobjects and property sets).
The model's world transform matrix. Overrides the position, scale and rotation parameters. Relative to origin.
Map of initial default states for each loaded Entity that represents an object. Default value is IFCObjectDefaults.
The model's World-space double-precision 3D origin. Use this to position the model within xeokit's World coordinate system, using double-precision coordinates.
Indicates if physically-based rendering (PBR) will apply to the model. Only works when Scene.pbrEnabled is also true.
The model single-precision 3D position, relative to the origin parameter.
The model's orientation, given as Euler angles in degrees, for each of the X, Y and Z axis.
Indicates if Scalable Ambient Obscurance (SAO) will apply to the model. SAO is configured by the Scene's {@link SAO} component. Only works when {@link SAO.enabled} is also true
The model's scale.
Path to a IFC file, as an alternative to the ifc parameter.
Collects model statistics.
When we set this true, then we force rendering of backfaces for the model.
Whether or not xeokit renders the model with edges emphasized.
When loading metadata, never loads objects that have MetaObjects with MetaObject.type values in this list.
When loading metadata and this is true, will only load Entitys that have MetaObjects (that are not excluded).
Indicates whether to globalize each Entity.id and MetaObject.id, in case you need to prevent ID clashes with other models.
When loading metadata, only loads objects that have MetaObjects with MetaObject.type values in this list.
The model's world transform matrix. Overrides the position, scale and rotation parameters. Relative to origin.
JSON model metadata, as an alternative to the metaModelSrc parameter.
Path to an optional metadata file, as an alternative to the metaModelData parameter.
Map of initial default states for each loaded Entity that represents an object. Default value is IFCObjectDefaults.
The model's World-space double-precision 3D origin. Use this to position the model within xeokit's World coordinate system, using double-precision coordinates.
Indicates if physically-based rendering (PBR) will apply to the model. Only works when Scene.pbrEnabled is also true.
The model single-precision 3D position, relative to the origin parameter.
Indicates whether to enable geometry reuse
The model's orientation, given as Euler angles in degrees, for each of the X, Y and Z axis.
Indicates if Scalable Ambient Obscurance (SAO) will apply to the model. SAO is configured by the Scene's {@link SAO} component. Only works when {@link SAO.enabled} is also true
The model's scale.
Path to a .xkt file, as an alternative to the xkt parameter.
The .xkt file data, as an alternative to the src parameter.
When true, allows visible backfaces, wherever specified in the 3DXML. When false, ignores backfaces.
When true, will create a MetaModel for the model in MetaScene.metaModels.
When xraying, highlighting, selecting or edging, this is the threshold angle between normals of adjacent triangles, below which their shared wireframe edge is not drawn.
Whether or not xeokit renders the Entity with edges emphasized.
What type of materials to create while loading: "MetallicMaterial" to create {@link MetallicMaterial}s, "SpecularMaterial" to create {@link SpecularMaterial}s or "PhongMaterial" to create PhongMaterials. As it loads XML3D's Phong materials, the XMLLoaderPlugin will do its best approximate conversion of those to the specified workflow.
The model's world transform matrix. Overrides the position, scale and rotation parameters.
The model's World-space 3D position.
The model's World-space rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
The model's World-space scale.
Path to a 3DXML file.
Entity to associate this Marker with. When the Marker has an Entity, then Marker.visible will always be false if Entity.visible is false.
Optional ID, unique among all components in the parent Scene, generated automatically when omitted.
Indicates whether or not this Marker is hidden (ie. Marker.visible is false whenever occluded by Entitys in the Scene.
World-space 3D Marker position.
Indicates if the Mesh should act as background, e.g., it can be used for a skybox.
Mesh's billboarding behaviour.
Indicates if the Mesh initially casts shadows.
Indicates if the Mesh is initially clippable.
Indicates if the Mesh is initially included in boundary calculations.
Mesh's initial RGB colorize color, multiplies by the rendered fragment colors.
Indicates if the Mesh is initially culled from view.
EdgeMaterial to define the appearance of enhanced edges for this Mesh. Inherits Scene.edgeMaterial by default.
Indicates if the Mesh's edges are initially emphasized.
{@link Geometry} to define the shape of this Mesh. Inherits Scene.geometry by default.
EmphasisMaterial to define the xrayed appearance for this Mesh. Inherits Scene.highlightMaterial by default.
Indicates if the Mesh is initially highlighted.
Optional ID, unique among all components in the parent scene, generated automatically when omitted.
Specify true if this Mesh represents a model, in which case the Mesh will be registered by Mesh.id in Scene.models and may also have a corresponding MetaModel with matching MetaModel.id, registered by that ID in MetaScene.metaModels.
Specify true if this Mesh represents an object, in which case the Mesh will be registered by Mesh.id in Scene.objects and may also have a corresponding MetaObject with matching MetaObject.id, registered by that ID in MetaScene.metaObjects.
Material to define the normal rendered appearance for this Mesh. Inherits Scene.material by default.
Local modelling transform matrix. Overrides the position, scale and rotation parameters.
Indicates if the Mesh is able to occlude Markers.
World-space 3D translation offset. Translates the Mesh in World space, after modelling transforms.
Mesh's initial opacity factor, multiplies by the rendered fragment alpha.
World-space origin for this Mesh. When this is given, then matrix, position and geometry are all assumed to be relative to this center.
ID of the corresponding object within the originating system, if any.
The parent Node.
Indicates if the Mesh is initially pickable.
3D position of this Mesh, relative to origin.
Indicates if the Mesh initially receives shadows.
Local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
Local scale.
Indicates if the Mesh is initially selected.
EmphasisMaterial to define the selected appearance for this Mesh. Inherits Scene.selectedMaterial by default.
Indicates if the Mesh is initially visible.
EmphasisMaterial to define the xrayed appearance for this Mesh. Inherits Scene.xrayMaterial by default.
Indicates if the Mesh is initially xrayed.
Custom color for the back face of the NavCube. Overrides color.
Custom color for the bottom face of the NavCube. Overrides color.
How much of the field-of-view, in degrees, that the 3D scene should fill the {@link Canvas} when the Camera moves to an axis or diagonal.
Whether the Camera flies or jumps to each selected axis or diagonal.
When flying the Camera to each new axis or diagonal, how long, in seconds, that the Camera takes to get there.
Reference of an existing HTML canvas to display the NavCube - either this or canvasId is mandatory. When both values are given, the element reference is always preferred to the ID.
ID of an existing HTML canvas to display the NavCube - either this or canvasElement is mandatory. When both values are given, the element reference is always preferred to the ID.
Custom uniform color for the faces of the NavCube.
Sets whether the axis, corner and edge-aligned views will fit the view to the entire Scene or just to visible object-Entitys. Entitys are visible objects when Entity.isObject and Entity.visible are both true.
Custom color for the front face of the NavCube. Overrides color.
Custom color for highlighting regions on the NavCube as we hover the pointer over them.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
Custom color for the left face of the NavCube. Overrides color.
Custom color for the right face of the NavCube. Overrides color.
Whether the shadow of the cube is visible.
Sets whether the NavCube switches between perspective and orthographic projections in synchrony with the Camera. When false, the NavCube will always be rendered with perspective projection.
Custom color for the top face of the NavCube. Overrides color.
Initial visibility.
Indicates if the Node initially casts shadows.
Child Nodes or Meshes to add initially.
Indicates if the Node is initially clippable.
Indicates if the Node is initially included in boundary calculations.
Node's initial RGB colorize color, multiplies by the rendered fragment colors.
Indicates if the Node is initially culled from view.
Indicates if the Node's edges are initially emphasized.
Indicates if the Node is initially highlighted.
Optional ID, unique among all components in the parent scene, generated automatically when omitted.
Indicates if children given to this constructor should inherit rendering state from this parent as they are added.
Specify true if this Mesh represents a model, in which case the Mesh will be registered by Mesh.id in Scene.models and may also have a corresponding MetaModel with matching MetaModel.id, registered by that ID in MetaScene.metaModels.
Specify true if this Mesh represents an object, in which case the Mesh will be registered by Mesh.id in Scene.objects and may also have a corresponding MetaObject with matching MetaObject.id, registered by that ID in MetaScene.metaObjects.
Local modelling transform matrix. Overrides the position, scale and rotation parameters.
World-space 3D translation offset. Translates the Node in World space, after modelling transforms.
Node's initial opacity factor, multiplies by the rendered fragment alpha.
World-space origin for this Node.
The parent Node.
Indicates if the Node is initially pickable.
Local 3D position.
Indicates if the Node initially receives shadows.
Local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
Local scale.
Indicates if the Mesh is initially selected.
Indicates if the Node is initially visible.
Indicates if the Node is initially xrayed.
Scalar in range 0-1 that controls alpha, where 0 is completely transparent and 1 is completely opaque.
The alpha cutoff value. See the PhongMaterial.alphaCutoff property for more info.
An alpha {@link Fresnel"}}Fresnel{{/crossLink}}. Must be within the same Scene as this PhongMaterial.
An alpha map {@link Texture}, which will override the effect of the alpha property. Must be within the same Scene as this PhongMaterial.
The alpha blend mode - accepted values are "opaque", "blend" and "mask". See the PhongMaterial.alphaMode property for more info.
PhongMaterial ambient color.
A ambient map {@link Texture}, which will multiply by the diffuse property. Must be within the same Scene as this PhongMaterial.
Whether to render geometry backfaces.
PhongMaterial diffuse color.
A diffuse {@link Fresnel"}}Fresnel{{/crossLink}}. Must be within the same Scene as this PhongMaterial.
A diffuse map {@link Texture}, which will override the effect of the diffuse property. Must be within the same Scene as this PhongMaterial.
PhongMaterial emissive color.
An emissive {@link Fresnel"}}Fresnel{{/crossLink}}. Must be within the same Scene as this PhongMaterial.
An emissive map {@link Texture}, which will override the effect of the emissive property. Must be within the same Scene as this PhongMaterial.
The winding order for geometry front faces - "cw" for clockwise, or "ccw" for counter-clockwise.
Optional ID, unique among all components in the parent Scene, generated automatically when omitted.
Scalar that controls the width of lines.
A normal map {@link Texture}. Must be within the same Scene as this PhongMaterial.
An occlusion map {@link Texture}. Must be within the same Scene as this PhongMaterial.
Scalar that controls the size of points.
Scalar in range 0-1 that controls how much {@link ReflectionMap} is reflected.
A reflectivity {@link Fresnel"}}Fresnel{{/crossLink}}. Must be within the same Scene as this PhongMaterial.
A reflectivity control map {@link Texture}, which will override the effect of the reflectivity property. Must be within the same Scene as this PhongMaterial.
Scalar in range 0-128 that determines the size and sharpness of specular highlights.
PhongMaterial specular color.
A specular {@link Fresnel"}}Fresnel{{/crossLink}}. Must be within the same Scene as this PhongMaterial.
A specular map {@link Texture}, which will override the effect of the specular property. Must be within the same Scene as this PhongMaterial.
When this is true, points are only rendered when their intensity value falls within the range given in {@link }
Optional ID, unique among all components in the parent Scene, generated automatically when omitted.
When filterIntensity is true, points with intensity above this value will not be rendered.
When perspectivePoints is true, this is the maximum rendered size of each point in pixels.
When filterIntensity is true, points with intensity below this value will not be rendered.
When perspectivePoints is true, this is the minimum rendered size of each point in pixels.
Whether apparent point size reduces with distance when Camera.projection is set to "perspective".
Point size in pixels.
Selects a preset PointsMaterial configuration - see PointsMaterial.presets.
Whether points are round (true) or square (false).
Set true to automatically generate normal vectors from the positions and indices, if those are supplied.
Vertex colors.
Stores positions, colors, normals and UVs in compressGeometry and oct-encoded formats for reduced memory footprint and GPU bus usage.
When a Mesh renders this Geometry as wireframe, this indicates the threshold angle (in degrees) between the face normals of adjacent triangles below which the edge is discarded.
Optional ID, unique among all components in the parent Scene,
Indices array.
Optional map of user-defined metadata to attach to this Geometry.
Vertex normal vectors array.
Positions array.
The primitive type.
UVs array.
A custom data source through which the STLLoaderPlugin can load STL files. Defaults to an instance of {@link STLDefaultDataSource}, which loads over HTTP.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
Indicates whether or not this SectionPlane is active.
Vector perpendicular to the plane surface, indicating the SectionPlane plane orientation.
Optional ID, unique among all components in the parent Scene, generated automatically when omitted.
World-space position of the SectionPlane.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
ID of a canvas element to display the overview.
Initial visibility of the overview canvas.
Texture encoding format. See the {@link Texture#encoding} property for more info.
Entity to associate this SpriteMarker with. When the SpriteMarker has an Entity, then SpriteMarker.visible will always be false if Entity.visible is false.
Flips this SpriteMarker's texture image along its vertical axis when true.
Optional ID, unique among all components in the parent Scene, generated automatically when omitted.
HTML Image object to load into this SpriteMarker. See the {@link SpriteMarker#image} property for more info.
Indicates whether or not this SpriteMarker is hidden (ie. SpriteMarker.visible is false whenever occluded by Entitys in the Scene.
Path to image file to load into this SpriteMarker.
World-space 3D SpriteMarker position.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
Map of visual states for the Entitys as rendered within each {@link Storey}. Default value is IFCStoreyPlanObjectStates.
The time in seconds since the previous "tick" event from this Scene.
The time of the previous "tick" event from this Scene..
The ID of this Scene.
The time in seconds since 1970 that this Scene was instantiated.
The time in seconds since 1970 of this "tick" event.
When true (default), will automatically add each model as it's created. Set this false if you want to manually add models using TreeViewPlugin.addModel instead.
Optional depth to which to initially expand the tree.
DOM element to contain the TreeViewPlugin.
How to organize the tree nodes: "containment", "storeys" or "types". See the class documentation for details.
When true, will not contain nodes that don't have content in the Scene. These are nodes whose MetaObjects don't have Entitys.
When true, will sort the children of each node.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
Maximum depth of the kd-tree.
Whether writing into the depth buffer is enabled or disabled when rendering transparent objects.
Whether to enable anti-aliasing.
Sets the canvas background color to use when transparent is false.
When transparent is false, set this true to derive the canvas background color from {@link AmbientLight.color}, or false to set the canvas background to backgroundColor.
Reference of an existing HTML canvas for the Viewer.scene - either this or canvasId is mandatory. When both values are given, the element reference is always preferred to the ID.
ID of an existing HTML canvas for the Viewer.scene - either this or canvasElement is mandatory. When both values are given, the element reference is always preferred to the ID.
When doing multiple passes per frame, specifies if to clear the canvas before each pass (true) or just before the first pass (false).
Whether to enable Entity.offset. For best performance, only set this true when you need to use Entity.offset.
The gamma factor to use when rendering with pre-multiplied gamma.
When true, expects that all textures and colors are premultiplied gamma.
Whether or not to render with pre-multiplied gama.
Optional ID for this Viewer, defaults to the ID of Viewer.scene, which xeokit automatically generates.
Optional reference to HTML element on which key events should be handled. Defaults to the HTML Document.
Optional locale-based translation service.
Whether to enable logarithmic depth buffer.
The Real-space 3D origin, in current measurement units, at which the World-space coordinate origin [0,0,0] sits.
The number of times the Viewer.scene renders per frame.
Whether to enable physically-based rendering.
Whether to enable full-precision accuracy when surface picking with Scene.pick.
Whether or not you want alpha composition with premultiplied alpha. Highlighting and selection works best when this is false.
Whether or not to preserve the WebGL drawing buffer. This needs to be true for Viewer.getSnapshot to work.
Whether to enable Scalable Ambient Obscurance (SAO) effect. See {@link SAO} for more info.
The number of Real-space units in each World-space coordinate system unit.
ID of existing HTML element to show the {@link Spinner} - internally creates a default element automatically if this is omitted.
Whether or not the canvas is transparent.
The measurement unit type.
A custom data source through which the XKTLoaderPlugin can load model and metadata files. Defaults to an instance of {@link XKTDefaultDataSource}, which loads uover HTTP.
When loading metadata, never loads objects that have MetaObjects with MetaObject.type values in this list.
When loading metadata and this is true, will only load Entitys that have MetaObjects (that are not excluded). This is useful when we don't want Entitys in the Scene that are not represented within IFC navigation components, such as TreeViewPlugin.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
When loading metadata, only loads objects that have MetaObjects with MetaObject.type values in this list.
Maximum geometry batch size, as number of vertices.
Map of initial default states for each loaded Entity that represents an object. Default value is IFCObjectDefaults.
Indicates whether to enable geometry reuse
When true, will create a MetaModel for the model in MetaScene.metaModels.
Optional ID for this plugin, so that we can find it within {@link Viewer.plugins}.
What type of materials to create while loading
Path to the directory that contains the bundled zip.js archive
The number of radiians in a degree (0.0174532925).
The number of degrees in a radian.
Gets the center of a 2D AABB.
Gets the center of an AABB.
Gets the diagonal size of an AABB3 given as minima and maxima.
Normalizes a three-element vector
Returns a new, uninitialized two-element vector.
Returns a new, uninitialized three-element vector.
Returns a new, uninitialized four-element vector.
Generated using TypeDoc
Container DOM element for markers and labels. Defaults to
document.body.