DepthOfField Class
An DepthOfField is a Light that defines an ambient light source of fixed intensity and color that affects all attached Object equally.
Overview
- You only need one DepthOfField in your Viewer.
- Normally you would combine DepthOfFields with DirLights and/or PointLights.
Example
In the example below we're illuminating a TeapotObject with a single DepthOfField.
// Create a Viewer
var viewer = new BIMSURFER.Viewer({ element: "myDiv" });
// Create a Camera
var camera = new BIMSURFER.Camera(viewer, {
eye: [5, 5, -5]
});
// Create a camera orbit control
var control = new BIMSURFER.CameraControl(viewer, {
camera: camera
});
// Create a TeapotObject
var teapot = new BIMSURFER.TeapotObject(viewer);
// Create an DepthOfField
var DepthOfField = new BIMSURFER.DepthOfField(viewer, {
color: [0.4, 0.4, 0.4]
});
Constructor
DepthOfField
-
[viewer] -
[cfg]
Parameters:
-
[viewer]Viewer optional -
[cfg]optionalDepthOfField configuration
-
[id]String optionalOptional ID, unique among all components in the parent Viewer, generated automatically when omitted.
-
[meta]String:Object optionalOptional map of user-defined metadata to attach to this DepthOfField.
-
[ambient=[0.7, 0.7, 0.8]]Array(Number) optionalThe color of this DepthOfField.
-
Item Index
Methods
destroy
()
error
-
message
Logs an error for this component to the JavaScript console.
The console message will have this format: [ERROR] <component id>: <message>
Parameters:
-
messageStringThe message to log
fire
-
event -
value -
[forget=false]
Fires an event on this component.
Notifies existing subscribers to the event, retains the event to give to any subsequent notifications on that location as they are made.
Parameters:
-
eventStringThe event type name
-
valueObjectThe event
-
[forget=false]Boolean optionalWhen true, does not retain for subsequent subscribers
log
-
message
Logs a console debugging message for this component.
The console message will have this format: [LOG] <component id>: <message>
Parameters:
-
messageStringThe message to log
off
-
handle
Parameters:
-
handleStringSubscription handle
on
-
event -
callback -
[scope=this]
Subscribes to an event on this component.
The callback is be called with this component as scope.
Parameters:
-
eventStringPublication event
-
callbackFunctionCalled when fresh data is available at the event
-
[scope=this]Object optionalScope for the callback
Returns:
Handle to the subscription, which may be used to unsubscribe with {@link #off}.
once
-
event -
callback -
[scope=this]
Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is handled.
Parameters:
-
eventStringData event to listen to
-
callbackFunction(data)Called when fresh data is available at the event
-
[scope=this]Object optionalScope for the callback
warn
-
message
Logs a warning for this component to the JavaScript console.
The console message will have this format: [WARN] <component id>: <message>
Parameters:
-
messageStringThe message to log
Properties
active
Boolean
Flag which indicates whether this Light is active or not.
Fires an active event on change.
className
String
final
JavaScript class name for this Component.
color
Array(Number)
TODO
Default: [0.7, 0.7, 0.8]
destroyed
Boolean
True as soon as this Component has been destroyed
Items in this map
Unknown
metadata
Object
Metadata on this component.
Events
active
Fired whenever this Light's active property changes.
Event Payload:
-
valueObjectThe property's new value
destroyed
Fired when this Component is destroyed.