If true user input interrupts the camera from animating to a target
When enabled the scene will be automatically fitted into the camera view in onEnable
When enabled OrbitControls will automatically raycast find a look at target in start
the object this component is attached to. Note that this is a threejs Object3D with some additional features
the unique identifier for this component
Optional sourceholds the source identifier this object was created with/from (e.g. if it was part of a glTF file the sourceId holds the url to the glTF)
The duration in seconds it takes for the camera look ad and position lerp to reach their destination (when set via setCameraTargetPosition and setLookTargetPosition)
true if the object is enabled and active in the hierarchy
True while the camera position is being lerped
The object being controlled by the OrbitControls (usually the camera)
The underlying three.js OrbitControls
true if this component was destroyed (this.destroy()) or the whole object this component was part of
Forward (0,0,-1) vector in world space
True while the camera look target is being lerped
Right (1,0,0) vector in world space
shorthand for this.context.scene
use targetLerpDuration insteadThe speed at which the camera target and the camera will be lerping to their destinations (if set via script or user input)
Up (0,1,0) vector in world space
Optional earlyOptional lateOptional onOptional onOptional onOptional onOptional onOptional onCallback when this component joins a xr session (or becomes active in a running XR session)
Optional onCallback when this component exists a xr session (or when it becomes inactive in a running XR session)
Optional onOptional onOptional onOptional onOptional onOptional onOptional onRegister callback when user starts interacting with the orbit controls
Optional onOptional onOptional onOptional onCallback when a xr session updates (while it is still active in XR session)
Optional onOptional onXRControllerCallback when a controller is connected/added while in a XR session
OR when the component joins a running XR session that has already connected controllers
OR when the component becomes active during a running XR session that has already connected controllers
Optional onXRControllerOptional resolveMoves the camera to position smoothly.
Optional position: anyThe position in local space of the controllerObject to move the camera to. If null the camera will stop lerping to the target.
starts a coroutine (javascript generator function)yield will wait for the next frame:
yield WaitForSeconds(1) to wait for 1 second.yield WaitForFrames(10) to wait for 10 frames.yield new Promise(...) to wait for a promise to resolve.generator function to start
event to register the coroutine for (default: FrameEvent.Update). Note that all coroutine FrameEvent callbacks are invoked after the matching regular component callbacks. For example FrameEvent.Update will be called after regular component update() methods)
the generator function (use it to stop the coroutine with stopCoroutine)
onEnable() { this.startCoroutine(this.myCoroutine()); }
private *myCoroutine() {
while(this.activeAndEnabled) {
console.log("Hello World", this.context.time.frame);
// wait for 5 frames
for(let i = 0; i < 5; i++) yield;
}
}
Stop a coroutine that was previously started with startCoroutine
the routine to be stopped
the frame event to unregister the routine from (default: FrameEvent.Update)
Optional supportsXROptional callback, you can implement this to only get callbacks for VR or AR sessions if necessary.
true if the mode is supported (if false the mode is not supported by this component and it will not receive XR callbacks for this mode)
Optional updateGenerated using TypeDoc
Needle Engine component base class. Derive from this component to implement your own using the provided lifecycle methods. Components can be added to threejs objects using
GameObject.addComponent.The most common lifecycle methods are
awake,start,onEanble,onDisableupdateandonDestroy.XR specific callbacks include
onEnterXR,onLeaveXR,onUpdateXR,onControllerAddedandonControllerRemoved.To receive pointer events implement
onPointerDown,onPointerUp,onPointerEnter,onPointerExitandonPointerMove.