IsolateEffect Class
A IsolateEffect is an Effect that exclusively shows the Object within an ObjectSet.
Overview
TODO
Example
Isolating an ObjectSet
Isolate objects that match given IDs, using an ObjectSet and an IsolateEffect
// Create a Viewer
var viewer = new BIMSURFER.Viewer({ element: "myDiv" });
// Create a Camera
var camera = new BIMSURFER.Camera(viewer, {
eye: [0, 0, -10]
});
// Create a CameraControl to interact with the Camera
var cameraControl = new BIMSURFER.CameraControl(viewer, {
camera: camera
});
// Create some BoxObjects
new BIMSURFER.BoxObject(viewer, {
id: "foo",
type: "IfcWall",
matrix: BIMSURFER.math.translationMat4v([-4, 0, -4])
});
new BIMSURFER.BoxObject(viewer, {
id: "bar",
type: "IfcWall",
matrix: BIMSURFER.math.translationMat4v([4, 0, -4])
});
new BIMSURFER.BoxObject(viewer, {
id: "baz",
type: "IfcBeam",
matrix: BIMSURFER.math.translationMat4v([-4, 0, 4])
});
// Create an ObjectSet
var objectSet = new BIMSURFER.ObjectSet(viewer);
// Apply an Isolate effect to the ObjectSet
var isolateEffect = new BIMSURFER.IsolateEffect(viewer, {
objectSet: objectSet
});
// Add Objects to the ObjectSet by ID
// These Objects become visible
objectSet.addObjectIds(["foo", "bar", "baz"]);
// Remove an Object from the ObjectSet by ID
// That Object becomes invisible again
objectSet.removeObjectIds(["baz"]);
Constructor
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 Effect is active or not.
Fires an active event on change.
className
String
final
JavaScript class name for this Component.
destroyed
Boolean
True as soon as this Component has been destroyed
invert
Boolean
Items in this map
Unknown
metadata
Object
Metadata on this component.