Constructor
new Camera()
Create a camera.
Extends
Members
castShadow :boolean
Whether the object gets rendered into shadow map.
- boolean
- Overrides
- Default Value
- false
children :Array.<Object3D>
Object's parent in the scene graph. An object can have at most one parent.
- Array.<Object3D>
- Overrides
euler :Euler
Object's local rotation as an Euler, in radians.
- Overrides
- Default Value
- Euler(0, 0, 0)
frustum :Frustum
The frustum of the camera.
frustumCulled :boolean
When this is set, it checks every frame if objects are in the frustum of the camera before rendering objects. Otherwise objects gets rendered every frame even if it isn't visible.
- boolean
- Overrides
- Default Value
- true
gammaFactor :number
The factor of gamma.
- number
- Default Value
- 2.0
(readonly) id :number
Unique number for this object instance.
- number
- Overrides
(readonly) isCamera :boolean
- boolean
- Default Value
- true
matrix :Matrix4
The local transform matrix.
- Overrides
matrixAutoUpdate :boolean
When this is set, it calculates the matrix of position, (rotation or quaternion) and scale every frame and also recalculates the worldMatrix property.
- boolean
- Overrides
- Default Value
- true
matrixNeedsUpdate :boolean
When this is set, it calculates the matrix in that frame and resets this property to false.
- boolean
- Overrides
- Default Value
- true
name :string
Optional name of the object (doesn't need to be unique).
- string
- Overrides
- Default Value
- ""
outputEncoding :TEXEL_ENCODING_TYPE
Output pixel encoding.
- Default Value
- TEXEL_ENCODING_TYPE.LINEAR
parent :Object3D
Object's parent in the scene graph. An object can have at most one parent.
- Overrides
position :Vector3
A Vector3 representing the object's local position.
- Overrides
- Default Value
- Vector3(0, 0, 0)
projectionMatrix :Matrix4
This is the matrix which contains the projection.
projectionMatrixInverse :Matrix4
This is the matrix which contains the projection.
projectionViewMatrix :Matrix4
This is the matrix which contains the projection and view matrix. The matrix may be different from the value passed in the shader, scene.anchorMatrix is not considered here.
quaternion :Quaternion
Object's local rotation as a Quaternion.
- Overrides
- Default Value
- Quaternion(0, 0, 0, 1)
receiveShadow :boolean
Whether the material receives shadows.
- boolean
- Overrides
- Default Value
- false
rect :Vector4
Where on the screen is the camera rendered in normalized coordinates. The values in rect range from zero (left/bottom) to one (right/top).
- Default Value
- Vector4(0, 0, 1, 1)
renderLayer :number
Render layer of this object. RenderQueue will dispatch all renderable objects to the corresponding RenderQueueLayer according to object.renderLayer.
- number
- Overrides
- Default Value
- 0
renderOrder :number
This value allows the default rendering order of scene graph objects to be overridden although opaque and transparent objects remain sorted independently. Sorting is from lowest to highest renderOrder.
- number
- Overrides
- Default Value
- 0
renderable :boolean
Whether it can be collected into the Render Queue.
- boolean
- Overrides
- Default Value
- true
scale :Vector3
The object's local scale.
- Overrides
- Default Value
- Vector3(1, 1, 1)
shadowType :SHADOW_TYPE
Defines shadow map type. Note: In webgl1 or Scene#disableShadowSampler is true, soft shadow types will fallback to POISSON_SOFT without warning. Note: Point light only support POISSON_SOFT for now.
- Overrides
- Default Value
- SHADOW_TYPE.PCF3_SOFT
userData :object
An object that can be used to store custom data about the Object3D. It should not hold references to functions as these will not be cloned.
- object
- Overrides
- Default Value
- {}
uuid :string
UUID of this object instance. This gets automatically assigned, so this shouldn't be edited.
- string
- Overrides
viewMatrix :Matrix4
This is the inverse of worldMatrix. The matrix may be different from the value passed in the shader, scene.anchorMatrix is not considered here.
visible :boolean
Object gets rendered if true.
- boolean
- Overrides
- Default Value
- true
worldMatrix :Matrix4
The global transform of the object. If the Object3D has no parent, then it's identical to the local transform Object3D#matrix.
- Overrides
worldMatrixNeedsUpdate :boolean
When this is set, it calculates the world matrix in that frame and resets this property to false.
- boolean
- Overrides
- Default Value
- true
Methods
add(object)
Add object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D |
- Overrides
clone(recursiveopt) → {Object3D}
Returns a clone of this object and optionally all descendants.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
recursive | function | <optional> | true | if true, descendants of the object are also cloned. |
- Overrides
- Type:
- Object3D
copy(source, recursiveopt) → {Object3D}
Copy the given object into this object.
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
source | Object3D | The object to be copied. | ||
recursive | boolean | <optional> | true | if true, descendants of the object are also copied. |
- Overrides
- Type:
- Object3D
getObjectByName(name) → {Object3D}
Searches through the object's children and returns the first with a matching name. Note that for most objects the name is an empty string by default. You will have to set it manually to make use of this method.
| Name | Type | Description |
|---|---|---|
name | string | String to match to the children's Object3D#name property. |
- Overrides
- Type:
- Object3D
getObjectByProperty(name, value) → {Object3D}
Searches through the object's children and returns the first with a property that matches the value given.
| Name | Type | Description |
|---|---|---|
name | string | the property name to search for. |
value | number | value of the given property. |
- Overrides
- Type:
- Object3D
getWorldDirection(optionalTargetopt) → {Vector3}
Returns a vector representing the direction of object's positive z-axis in world space. This call must be after Object3D#updateMatrix.
| Name | Type | Attributes | Description |
|---|---|---|---|
optionalTarget | Vector3 | <optional> | — the result will be copied into this Vector3. |
- Overrides
- the result.
- Type:
- Vector3
lookAt(target, up)
Set view by look at, this func will set quaternion of this camera.
| Name | Type | Description |
|---|---|---|
target | Vector3 | The target that the camera look at. |
up | Vector3 | The up direction of the camera. |
- Overrides
onAfterRender()
An optional callback that is executed immediately after the Object3D is rendered.
- Overrides
onBeforeRender()
An optional callback that is executed immediately before the Object3D is rendered.
- Overrides
(abstract) raycast(ray, intersects)
Method to get intersections between a casted ray and this object.
- Overrides
remove(object)
Remove object as child of this object.
| Name | Type | Description |
|---|---|---|
object | Object3D |
- Overrides
setOrtho(left, right, bottom, top, near, far)
Set orthographic projection matrix.
| Name | Type | Description |
|---|---|---|
left | number | — Camera frustum left plane. |
right | number | — Camera frustum right plane. |
bottom | number | — Camera frustum bottom plane. |
top | number | — Camera frustum top plane. |
near | number | — Camera frustum near plane. |
far | number | — Camera frustum far plane. |
setPerspective(fov, aspect, near, far)
Set perspective projection matrix.
| Name | Type | Description |
|---|---|---|
fov | number | — Camera frustum vertical field of view. |
aspect | number | — Camera frustum aspect ratio. |
near | number | — Camera frustum near plane. |
far | number | — Camera frustum far plane. |
traverse(callback)
Executes the callback on this object and all descendants.
| Name | Type | Description |
|---|---|---|
callback | function | A function with as first argument an object3D object. |
- Overrides
updateMatrix(force)
Update the local transform.
| Name | Type | Description |
|---|---|---|
force | boolean |
- Overrides