Camera3D
Abstract base class for cameras. This class should always be inherited when you build a new camera, such as perspective and orthographic camera. The abstracted function need to respectively implement for different types of cameras.
Hierarchy
- Object3D
- Camera3D
Properties
Readonlyuser
enable
enable
is
Check the type whether it belongs to Camera3D. This value should not be changed by user.
type
The type of this Object3D.
matrix
This is the inverse of matrixWorld. MatrixWorld contains the Matrix which has the world transform of the Camera3D.
world
world
projection
This matrix decides the method of projection such as perspective and orthographic.
projection
The inverse matrix of projectionMatrix .
bounds
This is used to adapt the bounds of camera to canvas.
_
uuid
_
StaticDefaultVector3(0, 1, 0)
Every objects in 3D space must have a default up direction.
id
Unique number for each object3D instance.
category
Reserved attribute
source
Record the object rendered as instance or other type.
scene
The scene which this object belong to.
update-1
The number is the frame id which this object is changed or participates change of scene graph. If this value equals to frame id - 1,
name
The name of this object, it is empty if useless.
is
Used to check type of this or extended instance. This value should not be changed by user.
parent
Object's parent node in the scene graph. An object can have at most one parent.
children
Array with object's children.
up
This is used by the lookAt method, for example, to determine the orientation of the result. Default is DefaultUp .
world
Record when this object's world matrix last updated.
transform
Record whether the object's any attribute| attribute is updated.
visible
matrix
The global transform of the object. If the Object3D has no parent, then it's identical to the local transform matrix.
matrixfalse
When this is set, it calculates the matrixWorld in that frame and resets this property to false.
net
Record if the object is really visible in rendering process. If the Object3D has no parent, it would be set by visible ;
localfalse
When this is set, it calculates the model matrix in that frame and resets this property to false.
Accessors
business
-
get businessTag(): string
Returns string
-
set businessTag(v: string): void
Parameters
- v: string
Returns void
layers
interaction
group
position
-
Returns Vector3
rotation
-
Returns Euler
quaternion
-
Returns Quaternion
-
Object's local rotation as a Quaternion.
Parameters
- _quaternion: Quaternion
Returns void
Remarks
See Quaternion for more details.
scaleVector3( 1, 1, 1 )
-
Returns Vector3
matrix
-
Parameters
- value: Matrix4
Returns void
visibletrue
-
get visible(): boolean
Object gets rendered if true.
Returns boolean
-
set visible(value: boolean): void
Parameters
- value: boolean
Returns void
Methods
mark
-
Parameters
- v: string
Returns this
is
-
Returns boolean
validate
-
Returns void
destroy
-
Returns void
free
-
Returns void
class
-
The name of instance's class.
Returns string
notify
-
Make the engine to render the scene again.
Returns void
copy
-
Copy the data to this camera instance from source. This method need override in derived classes to copy extended data.
Parameters
- source: Camera3D
the data source.
- recursive: boolean
if true, descendants of the object are also cloned. Default is true.
Returns this
- source: Camera3D
get
update
-
Update the camera's matrixWorld and matrixWorldInverse .
Parameters
- updateParents: boolean
if true, it also updates all the parents.
- updateChildren: boolean
if true, it also updates all the children.
- force: boolean
Whether or not force to updates the matrix.
Returns void
- updateParents: boolean
serialize
-
Store the attributes of this class into string as serializing format.
Parameters
- ctx: Serializer
an instance used to store the data of scene objects.
Returns void
- ctx: Serializer
deserialize
-
Parse the data for this class from string according to serializing format.
Parameters
- ctx: Deserializer
an instance give the method to take the data for attribute.
Returns void
- ctx: Deserializer
Abstractupdate
update
-
Parameters
- jitter: ReadonlyVector2
Returns void
get
-
getJitter(): Readonly<
Pick<
ReadonlyMarked<Vector2>,
| "_readonly_mark"
| "cloneReadonly"
| "clone"
| "equals"
| "x"
| "y"
| "getNumberCount"
| "toArray"
| "length"
| "dot"
| "lengthSq"
| "manhattanLength"
| "width"
| "height"
| "isVector2"
| "cross"
| "angle"
| "distanceTo"
| "distanceToSquared"
| "manhattanDistanceTo"
| "intoSize",
>,
>Returns Readonly<
Pick<
ReadonlyMarked<Vector2>,
| "_readonly_mark"
| "cloneReadonly"
| "clone"
| "equals"
| "x"
| "y"
| "getNumberCount"
| "toArray"
| "length"
| "dot"
| "lengthSq"
| "manhattanLength"
| "width"
| "height"
| "isVector2"
| "cross"
| "angle"
| "distanceTo"
| "distanceToSquared"
| "manhattanDistanceTo"
| "intoSize",
>,
>
update
-
Returns void
Abstractget
-
how many screen pixels rendered in 1 distance from camera
Returns number
Abstractpixels
-
Calculate how many screen pixel match one world unit at given distance.
Parameters
- distance: number
the distance from camera to object.
- viewHeight: number
the hight of view window.
Returns number
- distance: number
pixels
-
return a function that compute pixelsPerUnit
Parameters
- viewHeight: number
Returns (distance: number) => number
get
-
Calculate a scale value that keep one object's screen unit size match it's world unit size
Parameters
- distance: number
the distance from camera to object.
- viewHeight: number
the hight of view window.
Returns number
- distance: number
Abstractcast
on
once
has
off
emit
-
Active the event and call the registered listener.
Parameters
- type: EventType<never>
Returns void
clear
-
Removes all listeners from listening list.
Returns void
destroy
-
Returns void
free
-
Returns void
sync
-
Returns void
update
-
Scene will check the object's visibility in each render and make change netVisibility based on its and parent's visible .
Returns boolean
clear
set
-
If the local matrix is changed, use this method to manually refresh data in scene graph.
Returns void
Tips
It's better to use notifySceneChange() as an alternative.
notify
-
Use this method to manually refresh data in scene graph and draw again. The engine may not notify every change of the scene. If any effect is not changed with the parameters, use this may solve.
Returns void
set
-
If the local matrix or world matrix is changed, use this method to make engine refresh data in scene graph automatically. This method will set matrixWorldNeedsUpdate and localMatrixNeedUpdate to true.
Returns void
update
-
Change matrixWorldNeedsUpdate and worldMatrixUpdateTimestamp state. This method will refresh data of world matrix by updateMatrixWorld
Parameters
- updateID: number
This number is used to identify the render.
Returns boolean
- updateID: number
is
-
If there are zero or two negative numbers in xyz, return false, otherwise return true.
Returns boolean
local
world
apply
-
Applies the matrix transform to the object and updates the object's position, rotation and scale.
Parameters
- matrix: Matrix4
A matrix represents the information of transform.
Returns void
- matrix: Matrix4
apply
-
Applies the rotation represented by the quaternion to the object.
Parameters
- q: Quaternion
A Quaternion represents the information of rotation.
Returns this
- q: Quaternion
set
-
Calls setFromAxisAngle ( axis, angle ) on the Quaternion.
Parameters
- axis: Vector3
A normalized vector in object space.
- angle: number
Angle in radians.
Returns void
- axis: Vector3
set
-
Calls Quaternion.setRotationFromEuler| setRotationFromEuler(euler, true) on the Quaternion.
Parameters
- euler: Euler
Euler angle specifying rotation amount.
Returns void
- euler: Euler
set
-
Calls setFromRotationMatrix (m) on the Quaternion.
Parameters
- m: Matrix4
Euler angle specifying rotation amount.
Returns void
- m: Matrix4
set
-
Copy the given quaternion to object's quaternion .
Parameters
- q: Quaternion
Euler angle specifying rotation amount.
Returns void
- q: Quaternion
rotate
-
Rotate an object along an axis in object space. The axis is assumed to be normalized.
Parameters
- axis: Vector3
A normalized vector in object space.
- angle: number
Angle in radians.
Returns this
- axis: Vector3
rotate
-
Rotate an object along an axis in world space. The axis is assumed to be normalized. Method Assumes no rotated parent.
Parameters
- axis: Vector3
A normalized vector in object space.
- angle: number
Angle in radians.
Returns this
- axis: Vector3
rotate
-
Rotates the object around x axis in local space.
Parameters
- angle: number
The angle to rotate in radians.
Returns this
- angle: number
rotate
-
Rotates the object around x axis in local space.
Parameters
- angle: number
The angle to rotate in radians.
Returns this
- angle: number
rotate
-
Rotates the object around x axis in local space.
Parameters
- angle: number
The angle to rotate in radians.
Returns this
- angle: number
translate
-
Translate an object by distance along an axis in object space. The axis is assumed to be normalized.
Parameters
- axis: Vector3
A normalized vector in object space.
- distance: number
The distance to translate.
Returns this
- axis: Vector3
translate
-
Translates object along x axis in object space by distance units.
Parameters
- distance: number
The distance to translate.
Returns this
- distance: number
translate
-
Translates object along y axis in object space by distance units.
Parameters
- distance: number
The distance to translate.
Returns this
- distance: number
translate
-
Translates object along z axis in object space by distance units.
Parameters
- distance: number
The distance to translate.
Returns this
- distance: number
look
-
Rotates the object to face to a point in world space. This method does not support objects having non-uniformly-scaled parent(s)
Parameters
- _x: Vector3
A vector representing position of target in world space.
Returns void
- _x: Vector3
look
-
Rotates the object to face a point in local space.
Parameters
- _x: Vector3
A vector representing position of target in local space.
Returns void
- _x: Vector3
add
-
Adds object as child of this object. An arbitrary number of objects may be added. Any current parent on an object passed in here will be removed, since an object can have at most one parent. The scene graph change will be immediately notify by engine after adding nodes.
Parameters
Returns this
remove
-
Remove the specified object form children.
Parameters
- object: Object3D
The object which needs to be removed.
Returns this
- object: Object3D
remove
-
Returns void
remove
-
Remove all children of this object.
Returns Object3D[]
remove
-
Remove all children in specified objects from this objects. Migrate from tools common
Parameters
- objects: Object3D[]
An array of objects which need to be removed.
Returns this
- objects: Object3D[]
get
-
Searches through an object and its children, starting with the object itself, and returns the first with a matching id. Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.
Parameters
- id: number
Unique number of the object instance.
Returns Object3D
- id: number
get
-
Searches through an object and its children, starting with the object itself, 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.
Parameters
- name: string
String to match to the children's Object3D.name property.
Returns Object3D
- name: string
get
-
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
Parameters
- name: string
The property name to search for.
- value: any
Value of the given property.
Returns Object3D
- name: string
get
get
-
Return a quaternion representing the rotation of the object in world space.
Parameters
- target: Quaternion
the result will be copied into this Quaternion.
Returns Quaternion
- target: Quaternion
get
traverse
-
Execute the callback on this object and all descendants.
Parameters
- callback: (object: Object3D) => any
A function with as first argument an object3D object.
Returns void
- callback: (object: Object3D) => any
traverse
-
Execute the callback when return is false, stop traverse the object's descendants.
Parameters
- callback: (object: Object3D) => boolean
A function with as first argument an object3D object, return boolean.
Returns void
- callback: (object: Object3D) => boolean
traverse
-
Execute the callback on this object and all descendants which is visible.
Parameters
- callback: (object: Object3D) => any
A function with as first argument an object3D object.
Returns void
- callback: (object: Object3D) => any
traverse
-
Execute the callback on this object and all ancestors.
Parameters
- callback: (object: Object3D) => any
A function with as first argument an object3D object.
Returns void
- callback: (object: Object3D) => any
update
-
Update the matrix local transform.
Returns void
update
-
Update the object's and its descendants' matrix of global transform with. If the parameter or matrixWorldNeedsUpdate is true, matrix will not skip updates.
Parameters
- force: boolean
Whether or not force to updates the matrix.
Returns void
- force: boolean
get
get
-
Get UUID of this object instance. This value is automatically assigned, so this shouldn't be edited.
Returns string
clone
-
Return a cloned instance of this class and optionally all descendants.
Parameters
- recursive: boolean
if true, descendants of the object are also cloned. Default is true.
Returns Object3D
- recursive: boolean
Abstract base class for cameras. This class should always be inherited when you build a new camera, such as perspective and orthographic camera. The abstracted function need to respectively implement for different types of cameras.