Variable

Static Public Summary
public	AlphaFormat: number Texture sampling mode that discards the `RGBA` components and just reads the `A` component.
public	ByteType: number Signed 8-bit integer type.
public	Cache: {"enabled": , "files": , "add": , "get": , "remove": , "clear": }
public	ClampToEdgeWrapping: number Texture wrapping mode in which the last pixel of the texture stretches to the edge of the mesh.
public	CompressedMediaType: number Media type for compressed texture data.
public	DefaultLoadingManager: LoadingManager
public	DepthFormat: number Texture sampling mode that reads each element as a single depth value, converts it to a float and clamps to `[0,1]`.
public	DepthStencilFormat: number Texture sampling mode that
public	FloatType: number Signed 32-bit floating-point type.
public	GIFMediaType: number Media type for GIF images.
public	HalfFloatType: number Signed 16-bit half-precision floating-point type.
public	IFCObjectDefaultColors: {String: Object} Initial properties for Entitys loaded from IFC models accompanied by metadata.
public	IFCObjectDefaults: {String: Object} Default initial properties for Entitys loaded from models accompanied by metadata.
public	IntType: number Signed 32-bit integer type.
public	JPEGMediaType: number Media type for JPEG images.
public	LinearEncoding: number Texture encoding mode in which the texture image is in linear color space.
public	LinearFilter: number Texture magnification and minification filter that returns the weighted average of the four nearest texels to the given sample coordinates.
public	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	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	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	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	LuminanceAlphaFormat: number Texture sampling mode that reads each of the `RGBA` texture components as a luminance/alpha value, converted to a float and clamped to `[0,1]`.
public	LuminanceFormat: number Texture sampling mode that reads each `RGB` texture component as a luminance value, converted to a float and clamped to `[0,1]`, while always reading the `A` channel as `1.0`.
public	MirroredRepeatWrapping: number Texture wrapping mode in which the texture repeats to infinity, mirroring on each repeat.
public	NearestFilter: number Texture magnification and minification filter that returns the nearest texel to the given sample coordinates.
public	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	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	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	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	PNGMediaType: number Media type for PNG images.
public	RGBAFormat: number Texture sampling mode that reads the `RGBA` components.
public	RGBAIntegerFormat: number Texture sampling mode that reads the `RGBA` components as integers instead of floats.
public	RGBA_ASTC_10x10_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_10x5_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_10x6_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_10x8_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_12x10_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_12x12_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_4x4_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_5x4_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_5x5_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_6x5_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_6x6_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_8x5_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_8x6_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_ASTC_8x8_Format: number Texture format mode in which the texture is formatted as an ATSC compressed `RGBA` image.
public	RGBA_BPTC_Format: number Texture format mode in which the texture is formatted as an BPTC compressed `RGBA` image.
public	RGBA_ETC2_EAC_Format: number Texture format mode in which the texture is formatted as an ETC2 compressed `RGBA` image.
public	RGBA_PVRTC_2BPPV1_Format: number Texture format mode in which the texture is formatted as a PVRTC compressed image, with `RGBA` compression in 2-bit mode and one block for each 8×4 pixels.
public	RGBA_PVRTC_4BPPV1_Format: number Texture format mode in which the texture is formatted as a PVRTC compressed image, with `RGBA` compression in 4-bit mode and one block for each 4×4 pixels.
public	RGBA_S3TC_DXT1_Format: number Texture format mode in which the texture is formatted as a DXT1 compressed `RGBA` image.
public	RGBA_S3TC_DXT3_Format: number Texture format mode in which the texture is formatted as a DXT3 compressed `RGBA` image.
public	RGBA_S3TC_DXT5_Format: number Texture format mode in which the texture is formatted as a DXT5 compressed `RGBA` image.
public	RGBFormat: number Texture sampling mode that discards the `A` component and reads the `RGB` components.
public	RGB_ETC1_Format: number Texture format mode in which the texture is formatted as an ETC1 compressed `RGB` image.
public	RGB_ETC2_Format: number Texture format mode in which the texture is formatted as an ETC2 compressed `RGB` image.
public	RGB_PVRTC_2BPPV1_Format: number Texture format mode in which the texture is formatted as a PVRTC compressed image, with `RGB` compression in 2-bit mode and one block for each 8×4 pixels.
public	RGB_PVRTC_4BPPV1_Format: number Texture format mode in which the texture is formatted as a PVRTC compressed image, with `RGB` compression in 4-bit mode and one block for each 4×4 pixels.
public	RGB_S3TC_DXT1_Format: number Texture format mode in which the texture is formatted as a DXT1 compressed `RGB` image.
public	RGFormat: number Texture sampling mode that discards the `A` and `B` components and just reads the `R` and `G` components.
public	RGIntegerFormat: number Texture sampling mode that discards the `A` and `B` components and just reads the `R` and `G` components, as integers instead of floats.
public	RedFormat: number Texture sampling mode that discards the `GBA` components and just reads the `R` component.
public	RedIntegerFormat: number Texture sampling mode that discards the `GBA` components and just reads the `R` component, as an integer instead of as a float.
public	RepeatWrapping: number Texture wrapping mode in which the texture repeats to infinity.
public	ShortType: number Signed 16-bit integer type.
public	UnsignedByteType: number Unsigned 8-bit integer type.
public	UnsignedInt248Type: number Unsigned integer type for 24-bit depth texture data.
public	UnsignedIntType: number Unsigned 32-bit integer type.
public	UnsignedShort4444Type: number Texture packing mode in which each `RGBA` channel is packed into 4 bits, for a combined total of 16 bits.
public	UnsignedShort5551Type: number Texture packing mode in which the `RGB` channels are each packed into 5 bits, and the `A` channel is packed into 1 bit, for a combined total of 16 bits.
public	UnsignedShortType: number Unsigned 16-bit integer type.
public	dataTextureRamStats: {"sizeDataColorsAndFlags": , "sizeDataPositionDecodeMatrices": , "sizeDataTextureOffsets": , "sizeDataTexturePositions": , "sizeDataTextureIndices": , "sizeDataTexturePortionIds": , "numberOfGeometries": , "numberOfPortions": , "numberOfLayers": , "numberOfTextures": , "totalLines": , "totalLines8Bits": , "totalLines16Bits": , "totalLines32Bits": , "cannotCreatePortion": , "overheadSizeAlignementIndices": , "overheadSizeAlignementEdgeIndices": *}
public	dataTextureRamStats: {"sizeDataColorsAndFlags": , "sizeDataPositionDecodeMatrices": , "sizeDataTextureOffsets": , "sizeDataTexturePositions": , "sizeDataTextureIndices": , "sizeDataTextureEdgeIndices": , "sizeDataTexturePortionIds": , "numberOfGeometries": , "numberOfPortions": , "numberOfLayers": , "numberOfTextures": , "totalPolygons": , "totalPolygons8Bits": , "totalPolygons16Bits": , "totalPolygons32Bits": , "totalEdges": , "totalEdges8Bits": , "totalEdges16Bits": , "totalEdges32Bits": , "cannotCreatePortion": , "overheadSizeAlignementIndices": , "overheadSizeAlignementEdgeIndices": }
public	meshSurfaceArea: MeshSurfaceArea Singleton instance of MeshSurfaceArea.
public	meshVolume: MeshVolume Singleton instance of MeshVolume.
public	os: {"isIphoneSafari": function}
public	sRGBEncoding: number Texture encoding mode in which the texture image is in sRGB color space.
public	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.

Static Public

public AlphaFormat: number source

import {AlphaFormat} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Texture sampling mode that discards the RGBA components and just reads the A component.

public ByteType: number source

import {ByteType} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Signed 8-bit integer type.

public Cache: {"enabled": , "files": , "add": , "get": , "remove": , "clear": } source

import {Cache} from '@xeokit/xeokit-sdk/src/viewer/scene/utils/Cache.js'

public ClampToEdgeWrapping: number source

import {ClampToEdgeWrapping} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Texture wrapping mode in which the last pixel of the texture stretches to the edge of the mesh.

public CompressedMediaType: number source

import {CompressedMediaType} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Media type for compressed texture data.

public DefaultLoadingManager: LoadingManager source

import {DefaultLoadingManager} from '@xeokit/xeokit-sdk/src/viewer/scene/utils/LoadingManager.js'

public DepthFormat: number source

import {DepthFormat} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Texture sampling mode that reads each element as a single depth value, converts it to a float and clamps to [0,1].

public DepthStencilFormat: number source

import {DepthStencilFormat} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Texture sampling mode that

public FloatType: number source

import {FloatType} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Signed 32-bit floating-point type.

public GIFMediaType: number source

import {GIFMediaType} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Media type for GIF images.

public HalfFloatType: number source

import {HalfFloatType} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Signed 16-bit half-precision floating-point type.

public IFCObjectDefaultColors: {String: Object} source

import {IFCObjectDefaultColors} from '@xeokit/xeokit-sdk/src/viewer/metadata/IFCObjectDefaultColors.js'

Initial properties for Entitys loaded from IFC models accompanied by metadata.

When loading a model, plugins such as XKTLoaderPlugin create a tree of Entitys that represent the model. These loaders can optionally load metadata, to create a MetaModel corresponding to the root Entity, with a MetaObject corresponding to each object Entity within the tree.

public IFCObjectDefaults: {String: Object} source

import {IFCObjectDefaults} from '@xeokit/xeokit-sdk/src/viewer/metadata/IFCObjectDefaults.js'

Default initial properties for Entitys loaded from models accompanied by metadata.

public IntType: number source

import {IntType} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Signed 32-bit integer type.

public JPEGMediaType: number source

import {JPEGMediaType} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Media type for JPEG images.

public LinearEncoding: number source

import {LinearEncoding} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Texture encoding mode in which the texture image is in linear color space.

public LinearFilter: number source

import {LinearFilter} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Texture magnification and minification filter that returns the weighted average of the four nearest texels to the given sample coordinates.

public LinearMipMapLinearFilter: number source

import {LinearMipMapLinearFilter} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

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 LinearMipMapNearestFilter: number source

import {LinearMipMapNearestFilter} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

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 LinearMipmapLinearFilter: number source

import {LinearMipmapLinearFilter} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

public LinearMipmapNearestFilter: number source

import {LinearMipmapNearestFilter} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

public LuminanceAlphaFormat: number source

import {LuminanceAlphaFormat} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Texture sampling mode that reads each of the RGBA texture components as a luminance/alpha value, converted to a float and clamped to [0,1].

public LuminanceFormat: number source

import {LuminanceFormat} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Texture sampling mode that reads each RGB texture component as a luminance value, converted to a float and clamped to [0,1], while always reading the A channel as 1.0.

public MirroredRepeatWrapping: number source

import {MirroredRepeatWrapping} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Texture wrapping mode in which the texture repeats to infinity, mirroring on each repeat.

public NearestFilter: number source

import {NearestFilter} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Texture magnification and minification filter that returns the nearest texel to the given sample coordinates.

public NearestMipMapLinearFilter: number source

import {NearestMipMapLinearFilter} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

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 NearestMipMapNearestFilter: number source

import {NearestMipMapNearestFilter} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

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 NearestMipmapLinearFilter: number source

import {NearestMipmapLinearFilter} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

public NearestMipmapNearestFilter: number source

import {NearestMipmapNearestFilter} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

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 PNGMediaType: number source

import {PNGMediaType} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Media type for PNG images.

public RGBAFormat: number source

import {RGBAFormat} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Texture sampling mode that reads the RGBA components.

public RGBAIntegerFormat: number source

import {RGBAIntegerFormat} from '@xeokit/xeokit-sdk/src/viewer/scene/constants/constants.js'

Texture sampling mode that reads the RGBA components as integers instead of floats.