World-space 3D axis-aligned bounding box (AABB) of this Entity.
Represented by a six-element Float64Array containing the min/max extents of the
axis-aligned volume, ie. [xmin, ymin,zmin,xmax,ymax, zmax].
Gets if this Entity casts shadows.
Sets if this Entity casts shadows.
Gets if this Entity is clippable.
Clipping is done by the SectionPlanes in {@link Scene.sectionPlanes}.
Sets if this Entity is clippable.
Clipping is done by the SectionPlanes in {@link Scene.sectionPlanes}.
Gets if this Entity is included in boundary calculations.
Sets if this Entity is included in boundary calculations.
Gets the Entity's RGB colorize color, multiplies by the Entity's rendered fragment colors.
Each element of the color is in range [0..1].
Sets the Entity's RGB colorize color, multiplies by the Entity's rendered fragment colors.
Each element of the color is in range [0..1].
Gets if this Entity is culled.
Only rendered when Entity.visible is true and Entity.culled is false.
Sets if this Entity is culled.
Only rendered when Entity.visible is true and Entity.culled is false.
Gets if this Entity's edges are enhanced.
Sets if this Entity's edges are enhanced.
Gets if this Entity is highlighted.
When Entity.isObject and Entity.highlighted are both true the Entity will be
registered by Entity.id in Scene.highlightedObjects.
Sets if this Entity is highlighted.
When Entity.isObject and Entity.highlighted are both true the Entity will be
registered by Entity.id in Scene.highlightedObjects.
Component ID, unique within the Scene.
Returns true to indicate that this is an Entity.
Returns true if this Entity represents a model.
When this is true, the Entity will be registered by Entity.id in Scene.models and
may also have a corresponding MetaModel.
Returns true if this Entity represents an object.
When this is true, the Entity will be registered by Entity.id in Scene.objects and
may also have a corresponding MetaObject.
The approximate number of triangles in this Entity.
Gets the Entity's 3D World-space offset.
Default value is [0,0,0].
Sets the Entity's 3D World-space offset.
Since offsetting Entities comes with memory and rendering overhead on some systems, this feature
only works when Viewer is configured with entityOffsetsEnabled: true.
The offset dynamically translates the Entity in World-space, which is useful for creating effects like exploding parts assemblies etc.
Default value is [0,0,0].
Provide a null or undefined value to reset to the default value.
Gets the Entity's opacity factor.
This is a factor in range [0..1] which multiplies by the rendered fragment alphas.
Sets the Entity's opacity factor, multiplies by the Entity's rendered fragment alphas.
This is a factor in range [0..1].
Gets the 3D World-space origin for this Entity.
Sets the 3D World-space origin for this Entity.
ID of the corresponding object within the originating system, if any.
By default, this has the same value as Entity.id. When we load a model using XKTLoaderPlugin.load,
with XKTLoaderPlugin.globalizeObjectIds set true, then that plugin will prefix Entity.id
with the model ID, while leaving this property holding the original value of Entity.id. When loading an
IFC model, this property will hold the IFC product ID of the corresponding IFC element.
Returns the parent Entity, if any.
Gets if this Entity is pickable.
Picking is done via calls to Scene.pick.
Sets if this Entity is pickable.
Picking is done via calls to Scene.pick.
Gets if this Entity can have shadows cast upon it
Sets if to this Entity can have shadows cast upon it
Gets if this Entity can have Scalable Ambient Obscurance (SAO) applied to it.
SAO is configured by {@link SAO}.
Gets if this Entity is selected.
When Entity.isObject and Entity.selected are both ````true``` the Entity will be registered by Entity.id in Scene.selectedObjects.
Sets if this Entity is selected.
When Entity.isObject and Entity.selected are both ````true``` the Entity will be registered by Entity.id in Scene.selectedObjects.
Gets if this Entity is visible.
Only rendered when Entity.visible is true and Entity.culled is false.
When Entity.isObject and Entity.visible are both true the Entity will be
registered by Entity.id in Scene.visibleObjects.
Sets if this Entity is visible.
Only rendered when Entity.visible is true and Entity.culled is false.
When Entity.isObject and Entity.visible are both true the Entity will be
registered by Entity.id in Scene.visibleObjects.
Gets if this Entity is xrayed.
When Entity.isObject and Entity.xrayed are both ````true``` the Entity will be registered by Entity.id in Scene.xrayedObjects.
Sets if this Entity is xrayed.
When Entity.isObject and Entity.xrayed are both ````true``` the Entity will be registered by Entity.id in Scene.xrayedObjects.
Destroys this Entity.
Generated using TypeDoc
An abstract 3D scene element that can be individually shown, hidden, selected, highlighted, xrayed, culled, picked, clipped and bounded.