Optional
__Optional
Internal
_Optional
_Optional
Internal
_Optional
Internal
_Optional
Internal
_Optional
Internal
_Optional
_A promise can be set by the object to indicate that the object is loading. This can be used by the scene, viewer, plugins to defer actions until the object is loaded.
Optional
Internal
_Internal
_world position cache for shader updates and other purposes
Optional
Internal
_Optional
Internal
_Optional
Internal
_Optional
acceptSet to false
to disable propagation of any events from its children.
Camera frustum aspect ratio, window width divided by window height. It can be managed internally if autoAspect is true.
Automatically manage aspect ratio based on window/canvas size.
Optional
autoSet to false
to disable automatic call of upgradeObject3D
when a child is added.
Optional
boundingFor InstancedMesh, SkinnedMesh etc
Optional
boundingFor InstancedMesh, SkinnedMesh etc
Readonly
canCheck whether user can interact with this camera. Interactions can be enabled/disabled in a variety of ways, like setInteractions, controlsMode, isMainCamera property
Array with object's children.
Readonly
controlsOptional
controlsOptional
currentOptional
customRequired for plugins like GBufferPlugin
Optional
customRequired for plugins like NormalBufferPlugin
Automatically managed when autoNearFar is true
. See also maxFarPlane
Optional
forcedIf this is set, it will be returned when accessing material
property.
see GBufferRenderPass for sample usage
Optional
fovOptional
geometryReadonly
interactionsIf interactions are enabled for this camera. It can be disabled by some code or plugin. see also setInteractions
use canUserInteract to check if the user can interact with this camera
use isMainCamera instead
Readonly
isRead-only flag to check if a given object is of type Camera.
Optional
isOptional
isOptional
isOptional
isOptional
isReadonly
isOptional
isOptional
isOptional
Readonly
isOptional
Readonly
isOptional
isOptional
isOptional
isOptional
materialOptional
Readonly
materialsSame as material but always returns an array.
To set, just set material
property
Optional
morphOptional
morphAutomatically managed when autoNearFar is true
. See also minNearPlane
Optional
objectOptional
objectObject's parent in the scene graph.
Optional
parentParent/Ancestor of this object to bubble events to. This is set internally by setupObject3D.
Local position of camera.
Target of camera, in world(global) coordinates.
Optional
uiAn object that can be used to store custom data about the Object3D.
Optional
options: Omit<Optional
_internal: booleanOptional
_refresh: booleanOptional
autoMoves the bounding box center of the object to the center of the world
Optional
setDirty: booleancalls setDirty
Optional
undo: booleanundo any previous autoCenter operation
Optional
autoScales the object to fit the given radius.
Optional
autoScaleRadius: numberoptional (taken from userData.autoScaleRadius by default)
Optional
isCentered: booleanoptional (taken from userData.isCentered by default)
Optional
setDirty: booleantrue by default
Optional
undo: booleanundo any previous autoScale operation
Returns a clone of this
object and optionally all descendants.
Optional
recursive: booleanIf true, descendants of the object are also cloned. Default true
Optional
computeFor InstancedMesh, SkinnedMesh etc Computes bounding box, updating .boundingBox attribute.
Optional
computeFor InstancedMesh, SkinnedMesh etc Computes bounding sphere, updating .boundingSphere attribute.
Optional
computeFor LineSegments, Line2 etc
Copy the given object into this object
Optional
recursive: booleanIf true, descendants of the object are also copied. Default true
Optional
distanceFromTarget: numberOptional
worldSpace: booleanNote: event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.
Optional
options: Omit<Optional
_internal: booleanOptional
_refresh: booleanOptional
removeFromParent: booleanremove from parent. Default true
Searches through an object and its children, starting with the object itself, and returns the first with a matching id.
Unique number of the object instance. Expects a Integer
Searches through an object and its children, starting with the object itself, and returns the first with a matching name.
String to match to the children's Object3D.name property.
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
the property name to search for.
value of the given property.
Optional
worldSpace: booleanOptional
cameraView: TOptional
pivotMoves the object pivot to the center of the bounding box.
The object will rotate around the new pivot.
Optional
setDirty: booleancalls setDirty
undo function
Optional
pivotOptional
setDirty: booleanOptional
setDirty: booleanOptional
refreshRefresh the camera frustum planes from frustumSize. Only for orthographic cameras.
Optional
setDirty: booleanGroup for info on manually grouping objects.
Set the canvas which is used as dom element in controls, etc. This is done by the viewer/scene when main camera is changed
Optional
refresh: booleanOptional
replace: booleanDispatches 'objectUpdate' event on object.
Optional
options: IObjectSetDirtyOptionsOptional
setDirty: booleanSet camera view from another camera.
Optional
distanceFromTarget: numberdefault = 4
Optional
worldSpace: booleandefault = true
Dispatches the setView
event which triggers the main camera to set its view to this camera's view.
Optional
traverseTraverse only upgraded objects with extra options
Optional
update
reference to the canvas element used for rendering. (for aspect ratio, etc.)