Private _positionPrivate _rotationPrivate _uuidPrivate _uuidTrue if an anchor is persistent.
UUID string of a persistent anchor or null if not persisted.
Fire an event, all additional arguments are passed on to the event listener.
Name of event to fire.
Optional arg1: anyFirst argument that is passed to the event handler.
Optional arg2: anySecond argument that is passed to the event handler.
Optional arg3: anyThird argument that is passed to the event handler.
Optional arg4: anyFourth argument that is passed to the event handler.
Optional arg5: anyFifth argument that is passed to the event handler.
Optional arg6: anySixth argument that is passed to the event handler.
Optional arg7: anySeventh argument that is passed to the event handler.
Optional arg8: anyEighth argument that is passed to the event handler.
Self for chaining.
obj.fire('test', 'This is the message');
Remove persistent UUID of an anchor from an underlying system.
Optional callback: XrAnchorForgetCallbackCallback to fire when anchor has been forgotten or error if failed.
Test if there are any handlers bound to an event name.
The name of the event to test.
True if the object has handlers bound to the specified event name.
obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false
Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.
Optional name: stringName of the event to unbind.
Optional callback: HandleEventCallbackFunction to be unbound.
Optional scope: objectScope that was used as the this when the event is fired.
Self for chaining.
const handler = function () {
};
obj.on('test', handler);
obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this
Attach an event handler to an event.
Name of the event to bind the callback to.
Function that is called when event is fired. Note the callback is limited to 8 arguments.
Optional scope: object = ...Object to use as 'this' when the event is fired, defaults to current this.
Can be used for removing event in the future.
obj.on('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
const evt = obj.on('test', function (a, b) {
console.log(a + b);
});
// some time later
evt.off();
Attach an event handler to an event. This handler will be removed after being fired once.
Name of the event to bind the callback to.
Function that is called when event is fired. Note the callback is limited to 8 arguments.
Optional scope: object = ...Object to use as 'this' when the event is fired, defaults to current this.
obj.once('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled
This method provides a way to persist anchor between WebXR sessions by providing a unique UUID of an anchor, that can be used later for restoring an anchor from underlying system. Bear in mind that underlying systems might have a limit on number of anchors allowed to be persisted per origin.
Optional callback: XrAnchorPersistCallbackCallback to fire when anchor persistent UUID has been generated or error if failed.
Static EVENT_Fired when an anchor's position and/or rotation is changed.
anchor.on('change', () => {
// anchor has been updated
entity.setPosition(anchor.getPosition());
entity.setRotation(anchor.getRotation());
});
Static EVENT_Fired when an anchor is destroyed.
// once anchor is destroyed
anchor.once('destroy', () => {
// destroy its related entity
entity.destroy();
});
Static EVENT_Fired when an anchor has been forgotten.
anchor.on('forget', () => {
// anchor has been forgotten
});
Static EVENT_Fired when an anchor has has been persisted. The handler is passed the UUID string that can be used to restore this anchor.
anchor.on('persist', (uuid) => {
// anchor has been persisted
});
An anchor keeps track of a position and rotation that is fixed relative to the real world. This allows the application to adjust the location of the virtual objects placed in the scene in a way that helps with maintaining the illusion that the placed objects are really present in the user’s environment.