Owner component. When destroyed, the owner will destroy this component as well.
ID of this Component, unique within the Scene.
Components are mapped by this ID in {@link Scene.components}.
Arbitrary, user-defined metadata on this component.
The parent Scene that contains this Component.
The viewer that contains this Scene.
Gets the Node's World-space 3D axis-aligned bounding box.
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 Node is clippable.
Clipping is done by the SectionPlanes in {@link Scene.clips}.
Child Nodes and Meshes may have different values for this property.
Sets if this Node and all child Nodes and Meshes are clippable.
Clipping is done by the SectionPlanes in {@link Scene.clips}.
Gets the RGB colorize color for this Node.
Each element of the color is in range [0..1].
Child Nodes and Meshes may have different values for this property.
Sets the RGB colorize color for this Node and all child Nodes and Meshes}.
Multiplies by rendered fragment colors.
Each element of the color is in range [0..1].
Gets if this Node is culled.
Sets if this Node and all child Nodes and Meshes are culled.
Gets if this Node is highlighted.
When Node.isObject and Node.highlighted are both true the Node will be
registered by Node.id in Scene.highlightedObjects.
Child Nodes and Meshes may have different values for this property.
Sets if this Node and all child Nodes and Meshes are highlighted.
When Node.isObject and Node.highlighted are both true the Node will be
registered by Node.id in Scene.highlightedObjects.
Returns true to indicate that this Component is an Entity.
Returns true if this Mesh represents a model.
When this returns true, the Mesh will be registered by Mesh.id in Scene.models and
may also have a corresponding MetaModel.
Returns true to indicate that this Component is a Node.
Returns true if this Node represents an object.
When true the Node will be registered by Node.id in
Scene.objects and may also have a MetaObject with matching MetaObject.id.
Gets the Node's local modeling transform matrix.
Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].
Sets the Node's local modeling transform matrix.
Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].
Number of child Nodes or Meshes.
The number of triangles in this Node.
Gets the Node's 3D World-space offset.
Default value is [0, 0, 0].
Child Nodes and Meshes may have different values for this property.
Sets the 3D World-space offset for this Node and all child Nodes and Meshes}.
The offset dynamically translates those components in World-space.
Default value is [0, 0, 0].
Note that child Nodes and Meshes may subsequently be given different values for this property.
Gets this Node's opacity factor.
This is a factor in range [0..1] which multiplies by the rendered fragment alphas.
Child Nodes and Meshes may have different values for this property.
Sets the opacity factor for this Node and all child Nodes and Meshes.
This is a factor in range [0..1] which multiplies by the rendered fragment alphas.
Gets the World-space origin for this Node.
Sets the World-space origin for this Node.
ID of the corresponding object within the originating system, if any.
The parent Node.
The parent Node may also be set by passing the Node to the parent's Node.addChild method.
The parent Node.
The parent Node may also be set by passing the Node to the parent's Node.addChild method.
Gets if to this Node is pickable.
Picking is done via calls to Scene.pick.
Child Nodes and Meshes may have different values for this property.
Sets if this Node and all child Nodes and Meshes are pickable.
Picking is done via calls to Scene.pick.
Gets the Node's local translation.
Default value is [0,0,0].
Sets the Node's local translation.
Default value is [0,0,0].
Gets the Node's local rotation quaternion.
Default value is [0,0,0,1].
Sets the Node's local rotation quaternion.
Default value is [0,0,0,1].
Gets the Node's local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
Default value is [0,0,0].
Sets the Node's local rotation, as Euler angles given in degrees, for each of the X, Y and Z axis.
Default value is [0,0,0].
Gets the World-space origin for this Node.
Deprecated and replaced by Node.origin.
Sets the World-space origin for this Node.
Deprecated and replaced by Node.origin.
Gets if this Node can have Scalable Ambient Obscurance (SAO) applied to it.
SAO is configured by {@link SAO}.
Gets the Node's local scale.
Default value is [1,1,1].
Sets the Node's local scale.
Default value is [1,1,1].
Gets if this Node is selected.
When Node.isObject and Node.selected are both true the Node will be
registered by Node.id in Scene.selectedObjects.
Child Nodes and Meshes may have different values for this property.
Sets if this Node and all child Nodes and Meshes are selected.
When Node.isObject and Node.selected are both true the Node will be
registered by Node.id in Scene.selectedObjects.
Gets if this Node is visible.
Child Nodes and Meshes may have different values for this property.
When Node.isObject and Node.visible are both true the Node will be
registered by Node.id in Scene.visibleObjects.
Sets if this Node and all child Nodes and Meshes are visible.
Only rendered both Node.visible is true and Node.culled is false.
When Node.isObject and Node.visible are both true the Node will be
registered by Node.id in Scene.visibleObjects.
Gets the Node's World matrix.
Gets if this Node is xrayed.
When Node.isObject and Node.xrayed are both true the Node will be
registered by Node.id in Scene.xrayedObjects.
Child Nodes and Meshes may have different values for this property.
Sets if this Node and all child Nodes and Meshes are xrayed.
When Node.isObject and Node.xrayed are both true the Node will be
registered by Node.id in Scene.xrayedObjects.
Destroys all Components that are owned by this. These are Components that were instantiated with this Component as their first constructor argument.
Destroys this component.
Logs an error for this component to the JavaScript console.
The console message will have this format: [ERROR] [<component type> =<component id>: <message>
Also fires the message as an "error" event on the parent Scene.
The message to log
Fires an event on this component.
Notifies existing subscribers to the event, optionally retains the event to give to any subsequent notifications on the event as they are made.
The event type name
The event parameters
Returns true if there are any subscribers to the given event on this component.
The event
True if there are any subscribers to the given event on this component.
Tests if this component is of the given type, or is a subclass of the given type.
Logs a console debugging message for this component.
The console message will have this format: [LOG] [<component type> <component id>: <message>
Also fires the message as a "log" event on the parent Scene.
The message to log
Cancels an event subscription that was previously made with Component.on or Component.once.
Subscription ID
Subscribes to an event on this component.
The callback is be called with this component as scope.
The event
Called fired on the event
Handle to the subscription, which may be used to unsubscribe with .off.
Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd.
This is equivalent to calling Component.on, and then calling Component.off inside the callback function.
Data event to listen to
Called when fresh data is available at the event
Removes all child Nodes and Meshes.
Rotates the Node about the given local axis by the given increment.
Local axis about which to rotate.
Angle increment in degrees.
Rotates the Node about the given World-space axis by the given increment.
Local axis about which to rotate.
Angle increment in degrees.
Rotates the Node about the local X-axis by the given increment.
Angle increment in degrees.
Rotates the Node about the local Y-axis by the given increment.
Angle increment in degrees.
Rotates the Node about the local Z-axis by the given increment.
Angle increment in degrees.
Translates the Node along local space vector by the given increment.
Normalized local space 3D vector along which to translate.
Distance to translate along the vector.
Translates the Node along the local X-axis by the given increment.
Distance to translate along the X-axis.
Translates the Node along the local Y-axis by the given increment.
Distance to translate along the Y-axis.
Translates the Node along the local Z-axis by the given increment.
Distance to translate along the Z-axis.
Logs a warning for this component to the JavaScript console.
The console message will have this format: [WARN] [<component type> =<component id>: <message>
Also fires the message as a "warn" event on the parent Scene.
The message to log
Generated using TypeDoc
An Entity that is a scene graph node that can have child Nodes and Meshes.