References
extras/ContextMenu
summary | ||
public |
A customizable HTML context menu. |
plugins/AngleMeasurementsPlugin
summary | ||
public |
Measures the angle indicated by three 3D points. |
|
public |
Creates AngleMeasurements from mouse and touch input. |
|
public |
Viewer plugin for measuring angles. |
plugins/AnnotationsPlugin
summary | ||
public |
A Marker with an HTML label attached to it, managed by an AnnotationsPlugin. |
|
public |
Viewer plugin that creates Annotations. |
plugins/AxisGizmoPlugin
summary | ||
public |
Viewer plugin that shows the axii of the World-space coordinate system. |
plugins/BCFViewpointsPlugin
summary | ||
public |
Viewer plugin that saves and loads BCF viewpoints as JSON objects. |
plugins/CityJSONLoaderPlugin
summary | ||
public |
Default data access strategy for CityJSONLoaderPlugin. |
|
public |
Viewer plugin that loads models from CityJSON files. |
since 2.0.13 |
plugins/DistanceMeasurementsPlugin
summary | ||
public |
Measures the distance between two 3D points. |
|
public |
Creates DistanceMeasurements from mouse and touch input. |
|
public |
Viewer plugin for measuring point-to-point distances. |
plugins/FastNavPlugin
summary | ||
public |
Viewer plugin that makes interaction smoother with large models, by temporarily switching the Viewer to faster, lower-quality rendering modes whenever we interact. |
plugins/GLTFLoaderPlugin
summary | ||
public |
Default data access strategy for GLTFLoaderPlugin. |
|
public |
plugins/LASLoaderPlugin
summary | ||
public |
Default data access strategy for LASLoaderPlugin. |
|
public |
Viewer plugin that loads lidar point cloud geometry from LAS files. |
since 2.0.17 |
plugins/NavCubePlugin
summary | ||
public |
plugins/OBJLoaderPlugin
summary | ||
public |
plugins/STLLoaderPlugin
summary | ||
public |
Default data access strategy for STLLoaderPlugin. |
|
public |
plugins/SectionPlanesPlugin
summary | ||
public |
SectionPlanesPlugin is a Viewer plugin that manages SectionPlanes. |
plugins/SkyboxesPlugin
summary | ||
public |
Viewer plugin that manages skyboxes |
plugins/StoreyViewsPlugin
summary | ||
public |
C Storey Information about an |
|
public |
A 2D plan view image of an |
|
public |
A Viewer plugin that provides methods for visualizing IfcBuildingStoreys. |
|
public |
V IFCStoreyPlanObjectStates: {String: Object} Property states for Entitys in Storeys capture by a StoreyViewsPlugin. |
plugins/TreeViewPlugin
summary | ||
public |
Represents a model tree view within a TreeViewPlugin. |
|
public |
A Viewer plugin that provides an HTML tree view to navigate the IFC elements in models. |
|
public abstract |
A node within a TreeViewPlugin. |
|
public |
F validateMetaModelForTreeViewContainmentHierarchy(metaModel: MetaModel, errors: String[]): boolean Tests if TreeViewPlugin would be able to create a "containment" hierarchy for the given MetaModel. |
|
public |
F validateMetaModelForTreeViewStoreysHierarchy(metaModel: MetaModel, errors: String[]): boolean Tests if TreeViewPlugin would be able to create a "storeys" hierarchy for the given MetaModel. |
|
public |
F validateMetaModelForTreeViewTypesHierarchy(metaModel: MetaModel, errors: String[]): boolean Tests if TreeViewPlugin would be able to create a "types" hierarchy for the given MetaModel. |
plugins/ViewCullPlugin
summary | ||
public |
Viewer plugin that performs view frustum culling to accelerate rendering performance. |
plugins/WebIFCLoaderPlugin
summary | ||
public |
Default data access strategy for WebIFCLoaderPlugin. |
|
public | since 2.0.13 |
plugins/XKTLoaderPlugin
summary | ||
public |
Default data access strategy for XKTLoaderPlugin. |
|
public |
Viewer plugin that loads models from xeokit's optimized Overview
Creating |
plugins/XML3DLoaderPlugin
summary | ||
public |
viewer
viewer/localization
summary | ||
public |
Localization service for a Viewer. |
since 2.0 |
viewer/metadata
summary | ||
public |
Metadata corresponding to an Entity that represents a model. |
|
public |
Metadata corresponding to an Entity that represents an object. |
|
public |
Metadata corresponding to a Scene. |
|
public |
C Property A property within a PropertySet. |
|
public |
A set of properties associated with one or more MetaObjects. |
|
public |
V IFCObjectDefaultColors: {String: Object} Initial properties for Entitys loaded from IFC models accompanied by metadata. |
|
public |
V IFCObjectDefaults: {String: Object} Default initial properties for Entitys loaded from models accompanied by metadata. |
viewer/scene
summary | ||
public |
Base class for all xeokit components. |
|
public abstract |
I Entity An abstract 3D scene element that can be individually shown, hidden, selected, highlighted, xrayed, culled, picked, clipped and bounded. |
|
public |
V stats: {components: {models: number, objects: number, scenes: number, meshes: number}, memory: {indices: number, uvs: number, textures: number, materials: number, transforms: number, positions: number, programs: number, normals: number, meshes: number, colors: number}, build: {version: string}, client: {browser: string}, frame: {frameCount: number, useProgram: number, bindTexture: number, drawElements: number, bindArray: number, tasksRun: number, fps: number, drawArrays: number, tasksScheduled: number}} xeokit runtime statistics. |
viewer/scene/CameraControl
summary | ||
public |
viewer/scene/ImagePlane
summary | ||
public |
A plane-shaped 3D object containing a bitmap image. |
viewer/scene/PerformanceModel
summary | ||
public |
A high-performance model representation for efficient rendering and low memory usage. |
viewer/scene/camera
summary | ||
public |
C Camera Manages viewing and projection transforms for its Scene. |
|
public |
Jumps or flies the Scene's Camera to a given target.
A CameraFlightAnimation's target can be: |
|
public |
Defines a sequence of frames along which a CameraPathAnimation can animate a Camera. |
|
public |
Animates the Scene's's Camera along a CameraPath. |
|
public |
Defines a custom projection for a Camera as a custom 4x4 matrix.. |
|
public |
C Frustum Defines its Camera's perspective projection as a frustum-shaped view volume.
|
|
public |
C Ortho Defines its Camera's orthographic projection as a box-shaped view volume.
|
|
public |
Defines its Camera's perspective projection using a field-of-view angle.
|
viewer/scene/canvas
summary | ||
public |
C Canvas Manages its Scene's HTML canvas.
|
|
public |
C Spinner Displays a progress animation at the center of its Canvas while things are loading or otherwise busy. |
viewer/scene/geometry
viewer/scene/geometry/builders
summary | ||
public |
F buildBoxGeometry(cfg: *): Object Creates box-shaped Geometry. |
|
public |
F buildBoxLinesGeometry(cfg: *): Object Creates a box-shaped lines Geometry. |
|
public |
F buildCylinderGeometry(cfg: *): Object Creates a cylinder-shaped Geometry. |
|
public |
F buildGridGeometry(cfg: *): Object Creates a grid-shaped Geometry. |
|
public |
F buildPlaneGeometry(cfg: *): Object Creates a plane-shaped Geometry. |
|
public |
F buildSphereGeometry(cfg: *): Object Creates a sphere-shaped Geometry. |
|
public |
F buildTorusGeometry(cfg: *): Object Creates a torus-shaped Geometry. |
|
public |
F buildVectorTextGeometry(cfg: *): Object Creates wireframe vector text Geometry. |
viewer/scene/geometry/loaders
summary | ||
public |
F load3DSGeometry(scene: Scene, cfg: *): Object Loads Geometry from 3DS. |
|
public |
F loadOBJGeometry(scene: Scene, cfg: *): Object Loads Geometry from OBJ. |
viewer/scene/input
summary | ||
public |
C Input Meditates mouse, touch and keyboard events for various interaction controls. |
viewer/scene/lights
summary | ||
public |
An ambient light source of fixed color and intensity that illuminates all Meshes equally. |
|
public |
A cube texture map. |
|
public |
C DirLight A directional light source that illuminates all Meshes equally from a given direction. |
|
public |
C Light A dynamic light source within a Scene. |
|
public |
C LightMap A LightMap specifies a cube texture light map. |
|
public |
A positional light source that originates from a single point and spreads outward in all directions, with optional attenuation over distance. |
|
public |
A reflection cube map. |
|
public |
C Shadow |
viewer/scene/marker
viewer/scene/materials
summary | ||
public |
Configures the appearance of Entitys when their edges are emphasised. |
|
public |
Configures the appearance of Entitys when they are xrayed, highlighted or selected. |
|
public |
C Fresnel Configures Fresnel effects for PhongMaterials. |
|
public |
Configures the normal rendered appearance of Meshes using the non-realistic but GPU-efficient Lambertian flat shading model for calculating reflectance. |
|
public |
Configures the shape of "lines" geometry primitives. |
|
public |
C Material |
|
public |
Configures the normal rendered appearance of Meshes using the physically-accurate metallic-roughness shading model. |
|
public |
Configures the normal rendered appearance of Meshes using the non-physically-correct Blinn-Phong shading model. |
|
public |
Configures the size and shape of "points" geometry primitives. |
|
public |
Configures the normal rendered appearance of Meshes using the physically-accurate specular-glossiness shading model. |
|
public |
C Texture A 2D texture map. |
viewer/scene/mementos
summary | ||
public |
Saves and restores the state of a Scene's Camera. See Also
|
|
public |
Saves and restores a snapshot of the visual state of the Entity's of a model within a Scene. UsageIn the example below, we'll create a Viewer and use an XKTLoaderPlugin to load an |
|
public |
Saves and restores a snapshot of the visual state of the Entity's that represent objects within a Scene.
See Also
|
viewer/scene/mesh
viewer/scene/mesh/draw
summary | ||
public |
F DrawShaderSource(mesh: *) |
viewer/scene/mesh/pick
summary | ||
public |
|
viewer/scene/metriqs
summary | ||
public |
C Metrics Configures its Scene's measurement unit and mapping between the Real-space and World-space 3D Cartesian coordinate systems. Overview
|
viewer/scene/nodes
viewer/scene/paths
summary | ||
public |
A Curve along which a 3D position can be animated. |
|
public |
C Curve Abstract base class for curve classes. |
|
public |
C Path A complex curved path constructed from various Curve subtypes. |
|
public |
A QuadraticBezierCurve is a Curve along which a 3D position can be animated. |
|
public |
A Curve along which a 3D position can be animated. |
viewer/scene/scene
summary | ||
public |
C Scene Contains the components that comprise a 3D scene. |
viewer/scene/sectionPlane
summary | ||
public |
An arbitrarily-aligned World-space clipping plane. |
viewer/scene/skybox
summary | ||
public |
C Skybox A Skybox. |
viewer/scene/viewport
summary | ||
public |
C Viewport |
viewer/scene/webgl
summary | ||
public |
Pick result returned by Scene#pick. |
viewer/scene/webgl/occlusion
summary | ||
public |
|
|
public |
Manages occlusion testing. |