The Viewer.
-ID for this Plugin, unique within its Viewer.
-The Viewer that contains this Plugin.
-Gets the {@link AngleMeasurementsControl}, which creates {@link AngleMeasurement}s from user input.
-Gets the existing {@link AngleMeasurement}s, each mapped to its {@link AngleMeasurement.id}.
-Destroys all {@link AngleMeasurement}s.
-Creates an {@link AngleMeasurement}.
The AngleMeasurement is then registered by {@link AngleMeasurement.id} in AngleMeasurementsPlugin.measurements.
Unique ID to assign to {@link AngleMeasurement.id}. The AngleMeasurement will be registered by this in AngleMeasurementsPlugin.measurements and {@link Scene.components}. Must be unique among all components in the Viewer.
The new {@link AngleMeasurement}.
-Destroys this Plugin and removes it from its Viewer.
-Destroys a {@link AngleMeasurement}.
ID of AngleMeasurement to destroy.
-Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
-Fires an event at this Plugin.
The event type name
The event parameters
-Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
-Fires when a measurement is created.
The measurementCreated event
Callback fired on the event
-Fires when a measurement is destroyed.
The measurementDestroyed event
Callback fired on the event
-Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
diff --git a/typedocs/classes/Annotation.html b/typedocs/classes/Annotation.html index 9b7b22d561..aeb851f5d6 100644 --- a/typedocs/classes/Annotation.html +++ b/typedocs/classes/Annotation.html @@ -1,68 +1,68 @@A Marker with an HTML label attached to it, managed by an AnnotationsPlugin.
-Optional World-space position for Camera.eye, used when this Annotation is associated with a Camera position.
Undefined by default.
-ID of this Component, unique within the Scene.
Components are mapped by this ID in {@link Scene.components}.
Optional World-space position for Camera.look, used when this Annotation is associated with a Camera position.
Undefined by default.
-Arbitrary, user-defined metadata on this component.
The AnnotationsPlugin this Annotation was created by.
-Optional projection type for Camera.projection, used when this Annotation is associated with a Camera position.
Undefined by default.
-The parent Scene that contains this Component.
The viewer that contains this Scene.
Canvas-space 2D coordinates of this Marker.
This property is read-only and is automatically calculated from Marker.worldPos and the current Camera position and projection.
The Marker fires a "canvasPos" event whenever this property changes.
-Gets the Entity this Marker is associated with.
An Entity is optional. When the Marker has an Entity, then Marker.visible will always be false
if Entity.visible is false.
Sets the Entity this Marker is associated with.
An Entity is optional. When the Marker has an Entity, then Marker.visible will always be false
if Entity.visible is false.
Gets whether occlusion testing is performed for this Marker.
When this is true, then Marker.visible will be false whenever the Marker is occluded by an Entity in the 3D view.
Sets whether occlusion testing is performed for this Marker.
When this is true, then Marker.visible will be false whenever the Marker is occluded by an Entity in the 3D view.
The Scene periodically occlusion-tests all Markers on every 20th "tick" (which represents a rendered frame). We can adjust that frequency via property Scene.ticksPerOcclusionTest.
-Gets the RTC center of this Marker.
This is automatically calculated from Marker.worldPos.
-Gets the RTC position of this Marker.
This is automatically calculated from Marker.worldPos.
-View-space 3D coordinates of this Marker.
This property is read-only and is automatically calculated from Marker.worldPos and the current Camera position.
The Marker fires a "viewPos" event whenever this property changes.
-Indicates if this Marker is currently visible.
This is read-only and is automatically calculated.
The Marker is invisible whenever:
@@ -72,24 +72,24 @@true and the Marker is currently occluded by an Entity in the 3D view.The Marker fires a "visible" event whenever this property changes.
-Gets the World-space 3D position of this Marker.
Fires a "worldPos" event with new World position.
-Sets the World-space 3D position of this Marker.
Fires a "worldPos" event with new World position.
-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.
@@ -97,45 +97,45 @@The event type name
The event parameters
-Gets the value of a field within the HTML templates for either the Annotation's marker or label.
See AnnotationsPlugin for more info.
Identifies the field.
The field's value.
-Gets whether or not to show this Annotation's label.
The label is only visible when both this property and Annotation.visible are true.
See AnnotationsPlugin for more info.
Whether to show the label.
-Gets whether or not to show this Annotation's marker.
The marker shows the Annotation's position.
The marker is only visible when both this property and Annotation.visible are true.
See AnnotationsPlugin for more info.
Whether to show the marker.
-Gets the values that were set for the placeholders within this Annotation's HTML marker and label templates.
See AnnotationsPlugin for more info.
Map of field values.
-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.
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
-Sets the value of a field within the HTML templates for either the Annotation's marker or label.
See AnnotationsPlugin for more info.
Identifies the field.
The field's value.
-Sets whether or not to show this Annotation's label.
The label is only visible when both this property and Annotation.visible are true.
See AnnotationsPlugin for more info.
Whether to show the label.
-Sets whether or not to show this Annotation's marker.
The marker shows the Annotation's position.
The marker is only visible when both this property and Annotation.visible are true.
See AnnotationsPlugin for more info.
Whether to show the marker.
-Sets values for multiple placeholders within the Annotation's HTML templates for marker and label.
See AnnotationsPlugin for more info.
Map of field values.
-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.
diff --git a/typedocs/classes/AnnotationsPlugin.html b/typedocs/classes/AnnotationsPlugin.html index 54c1ad6447..4be09786ac 100644 --- a/typedocs/classes/AnnotationsPlugin.html +++ b/typedocs/classes/AnnotationsPlugin.html @@ -1,29 +1,29 @@Viewer plugin that creates Annotations.
-The Viewer.
Plugin configuration.
-The Annotations created by AnnotationsPlugin.createAnnotation, each mapped to its Annotation.id.
-ID for this Plugin, unique within its Viewer.
-The Viewer that contains this Plugin.
-Gets the amount by which an Annotation is offset from the surface of its Entity when created by AnnotationsPlugin.createAnnotation, when we create the Annotation by supplying a PickResult to AnnotationsPlugin.createAnnotation.
This is 0.3 by default.
The surface offset.
-Sets 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.
See the class comments for more info.
This is 0.3 by default.
Destroys all Annotations.
-Creates an Annotation.
The Annotation is then registered by Annotation.id in AnnotationsPlugin.annotations.
Unique ID to assign to Annotation.id. The Annotation will be registered by this in AnnotationsPlugin.annotations and {@link Scene.components}. Must be unique among all components in the Viewer.
The new Annotation.
-Destroys this Plugin and removes it from its Viewer.
-Destroys an Annotation.
ID of Annotation to destroy.
-Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
-Fires an event at this Plugin.
The event type name
The event parameters
-Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
-Fires when a annotation is created.
The annotationCreated event
Callback fired on the event
-Fires when a annotation is destroyed.
The annotationDestroyed event
Callback fired on the event
-Fires when a mouse enters a annotation.
The markerMouseEnter event
Callback fired on the event
-Fires when a mouse leave an annotation.
The markerMouseLeave event
Callback fired on the event
-Fires when a mouse leave an annotation.
The markerClicked event
Callback fired on the event
-Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
diff --git a/typedocs/classes/AxisGizmoPlugin.html b/typedocs/classes/AxisGizmoPlugin.html index 5266e54b6c..2877f44d5e 100644 --- a/typedocs/classes/AxisGizmoPlugin.html +++ b/typedocs/classes/AxisGizmoPlugin.html @@ -1,39 +1,39 @@Viewer plugin that shows the axii of the World-space coordinate system.
-The Viewer.
Plugin configuration.
-ID for this Plugin, unique within its Viewer.
-The Viewer that contains this Plugin.
-Destroys this Plugin and removes it from its Viewer.
-Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
-Fires an event at this Plugin.
The event type name
The event parameters
-Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
-Subscribes to an event fired at this Plugin.
The event
Callback fired on the event
-Shows or hides this AxisGizmoPlugin.
Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
diff --git a/typedocs/classes/BCFViewpointsPlugin.html b/typedocs/classes/BCFViewpointsPlugin.html index 63fe34e6e7..8ecb4ca81b 100644 --- a/typedocs/classes/BCFViewpointsPlugin.html +++ b/typedocs/classes/BCFViewpointsPlugin.html @@ -1,30 +1,30 @@Viewer plugin that saves and loads BCF viewpoints as JSON objects.
-The Viewer.
Plugin configuration.
-Identifies the authoring tool to include in BCF viewpoints saved by this plugin.
-ID for this Plugin, unique within its Viewer.
-Identifies the originating system to include in BCF viewpoints saved by this plugin.
-The Viewer that contains this Plugin.
-Destroys this Plugin and removes it from its Viewer.
-Logs an error message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
-Fires an event at this Plugin.
The event type name
The event parameters
-Saves viewer state to a BCF viewpoint.
Note that xeokit's Camera.look is the point-of-interest, whereas the BCF camera_direction is a
direction vector. Therefore, we save camera_direction as the vector from Camera.eye to Camera.look.
BCF JSON viewpoint object
-Logs a message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
-Subscribes to an event fired at this Plugin.
The event
Callback fired on the event
-Sets viewer state to the given BCF viewpoint.
Note that xeokit's Camera.look is the point-of-interest, whereas the BCF camera_direction is a
direction vector. Therefore, when loading a BCF viewpoint, we set Camera.look to the absolute position
@@ -111,7 +111,7 @@
BCF JSON viewpoint object, shows default visible entities and restores camera to initial default position.
-Logs a warning message to the JavaScript developer console, prefixed with the ID of this Plugin.
The error message
diff --git a/typedocs/classes/Camera.html b/typedocs/classes/Camera.html index 18f6fb08e9..5c62e07748 100644 --- a/typedocs/classes/Camera.html +++ b/typedocs/classes/Camera.html @@ -1,172 +1,172 @@Manages viewing and projection transforms for its Scene.
-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 whether to prevent camera from being pitched upside down.
The camera is upside down when the angle between Camera.up and Camera.worldUp is less than one degree.
Default value is false.
true if pitch rotation is currently constrained.
Sets whether to prevent camera from being pitched upside down.
The camera is upside down when the angle between Camera.up and Camera.worldUp is less than one degree.
Fires a {@link Camera.constrainPitch:event} event on change.
Default value is false.
true if pitch rotation is currently constrained.
Gets the Camera's custom projection.
This is used while Camera.projection equals "customProjection".
The custom projection.
-Gets an optional matrix to premultiply into Camera.matrix matrix.
This is intended to be used for stereo rendering with WebVR etc.
The matrix.
-Sets an optional matrix to premultiply into Camera.matrix matrix.
This is intended to be used for stereo rendering with WebVR etc.
-Gets the position of the Camera's eye.
Default vale is [0,0,10].
Sets the position of the Camera's eye.
Default value is [0,0,10].
Gets distance from Camera.look to Camera.eye.
The distance.
-Gets the Camera's frustum projection.
The Camera uses this while Camera.projection equals frustum.
The Ortho component.
-Gets whether to lock yaw rotation to pivot about the World-space "up" axis.
Fires a {@link Camera.gimbalLock:event} event on change.
Returns true if gimbal is locked.
Sets whether to lock yaw rotation to pivot about the World-space "up" axis.
Fires a {@link Camera.gimbalLock:event} event on change.
Gets the inverse of the Camera's viewing transform matrix.
This has the same value as Camera.normalMatrix.
The inverse viewing transform matrix.
-Gets the position of this Camera's point-of-interest.
Default value is [0,0,0].
Camera look position.
-Sets the position of this Camera's point-of-interest.
Default value is [0,0,0].
Gets the Camera's viewing transformation matrix.
Fires a {@link Camera.matrix:event} event on change.
The viewing transform matrix.
-The Camera's viewing normal transformation matrix.
Fires a {@link Camera.matrix:event} event on change.
The viewing normal transform matrix.
-Gets the Camera's orthographic projection.
The Camera uses this while Camera.projection equals ortho.
The Ortho component.
-Gets the Camera's perspective projection.
The Camera uses this while Camera.projection equals perspective.
The Perspective component.
-Gets the Camera's projection transformation projMatrix.
Fires a {@link Camera.projMatrix:event} event on change.
The projection matrix.
-Gets the currently active projection for this Camera.
The currently active project is selected with Camera.projection.
The currently active projection is active.
-Gets the active projection type.
Possible values are "perspective", "ortho", "frustum" and "customProjection".
Default value is "perspective".
Identifies the active projection type.
-Sets the active projection type.
Accepted values are "perspective", "ortho", "frustum" and "customProjection".
Default value is "perspective".
Gets the direction of this Camera's Camera.up vector.
Direction of "up".
-Sets the direction of this Camera's Camera.up vector.
Gets the Camera's viewing transformation matrix.
Fires a {@link Camera.matrix:event} event on change.
The viewing transform matrix.
-The Camera's viewing normal transformation matrix.
Fires a {@link Camera.matrix:event} event on change.
The viewing normal transform matrix.
-Gets the up, right and forward axis of the World coordinate system.
Has format: [rightX, rightY, rightZ, upX, upY, upZ, forwardX, forwardY, forwardZ]
Default axis is [1, 0, 0, 0, 1, 0, 0, 0, 1]
The current World coordinate axis.
-Sets the up, right and forward axis of the World coordinate system.
Has format: [rightX, rightY, rightZ, upX, upY, upZ, forwardX, forwardY, forwardZ]
Default axis is [1, 0, 0, 0, 1, 0, 0, 0, 1]
Gets the direction of World-space "forwards".
This is set by Camera.worldAxis.
Default value is [0,0,1].
The "up" vector.
-Gets the direction of World-space "right".
This is set by Camera.worldAxis.
Default value is [1,0,0].
The "up" vector.
-
Viewer plugin for measuring angles.
-