InstanceMesh
A special version of Mesh with instanced rendering supported. Use InstancedMesh if you have to render a large number of objects with the same geometry and material but with different world transformations. The usage of InstancedMesh will help you to reduce the number of draw calls and thus improve the overall rendering performance in your application.
Hierarchy
- Mesh<Material, InstancedBufferGeometry>
- InstanceMesh
Constructors
constructor
Parameters
- meshes: Mesh<Material, BufferGeometry<TriangleList>>[]
Returns InstanceMesh
Properties
StaticDefaultVector3(0, 1, 0)
Every objects in 3D space must have a default up direction.
id
Unique number for each object3D instance.
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.
render0
This value allows the default rendering order of scene graph objects to be overridden although opaque and transparent objects remain sorted independently. When this property is set for an instance of Group| Group, all descendants objects will be sorted and rendered together. Sorting is from lowest to highest renderOrder.
drawMesh.
This is a decisive attribute for drawing method.
overlay
cast
Mark this drawable can cast shadow
cast
Mark this drawable can cast shadow
is
Used to check type of this or extended instance. This value should not be changed by user.
materialtrue
Mark the material reference changed.
geometrytrue
Mark the geometry reference changed.
frontfalse
Specify the winding orientation of mesh as counter-clock-wise, only meaningful on mesh.
model
Store the Model-View matrix for this object. It is not suggested to change the matrix because it will be update automatically when camera move.
normal
This matrix is used to calculate the normal in eye-space.
worldtrue
Mark bounding need to be recalculated.
world
Calculate the bounding as box.
world
Calculate the bounding as sphere.
z
The distance from object to camera in the direction of camera. Use this value to simply estimate the depth in 3D scene.
on
This method allow user manually process data before the engine drawing object.
view
This is used to scale a drawable object by specified number when enableViewIndependentScale| enableViewIndependentScale is true.
category
Reserved attribute
source
Record the object rendered as instance or other type.
should
instance
is
Check the type whether it belongs to Mesh. This value should not be changed by user.
use
Mark this mesh use origin material in transparent mode
type
The type of this Object3D.
edges
Bind edges to a mesh. Since the material is same, so all the groups will be combined together here.
_
Readonlyuser
_
uuid
_
Accessors
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
outline
- get outlineMode(): OutlineMode
Mark this drawable should be rendered in outline style if you set outlinePipelineMode & outlineShadingMode, get this value maybe error
Returns OutlineMode
- set outlineMode(v: OutlineMode): void
Parameters
- v: OutlineMode
Returns void
outline
- get outlineShadingMode(): OutlineShadingMode
Returns OutlineShadingMode
- set outlineShadingMode(value: OutlineShadingMode): void
Parameters
- value: OutlineShadingMode
Returns void
outline
- get outlineRenderMode(): OutlineRenderMode
Returns OutlineRenderMode
- set outlineRenderMode(value: OutlineRenderMode): void
OutlineRenderMode.Overlay is deprecated. use renderMode replaced
Parameters
- value: OutlineRenderMode
Returns void
render
Returns DrawableRenderMode
Parameters
- value: DrawableRenderMode
Returns void
is
- get isAlwaysDynamic(): boolean
Returns boolean
- set isAlwaysDynamic(v: boolean): void
Parameters
- v: boolean
Returns void
enable
- get enableViewIndependentScale(): boolean
Let this object can be scale independently.
Returns boolean
- set enableViewIndependentScale(v: boolean): void
Parameters
- v: boolean
Returns void
geometryBoxBufferGeometry| BoxBufferGeometry
- get geometry(): G
This attribute stores Geometry| Geometry or BufferGeometry| BufferGeometry (or derived classes), defining the object's shape.
Returns G
- set geometry(newGeo: G): void
Parameters
- newGeo: G
Returns void
render
- get renderGeometry(): BufferGeometryBase
Get the geometry which is really rendered by gpu.
Returns BufferGeometryBase
render
Get the material which is really rendered by gpu.
Returns Material[]
__
- set __material(v: M[]): void
Parameters
- v: M[]
Returns void
instance
- get instanceKey(): Nullable<string>
Returns Nullable<string>
- set instanceKey(value: Nullable<string>): void
merge
- get mergeKey(): Nullable<string>
Returns Nullable<string>
- set mergeKey(value: Nullable<string>): void
This key is used to merge different meshes which have same key into one WebGL Draw Call.
Parameters
- value: Nullable<string>
Returns void
business
- get businessTag(): string
Returns string
- set businessTag(v: string): void
Parameters
- v: string
Returns void
Methods
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
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
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 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
update
Update the object's and its descendants' matrix of global transform with. will update parent or children according to the parameters
Parameters
- updateParents: boolean
update parents.
- updateChildren: boolean
update children.
- force: boolean
Whether or not force to updates the matrix.
Returns void
- updateParents: boolean
get
get
Get UUID of this object instance. This value is automatically assigned, so this shouldn't be edited.
Returns string
get
Returns readonly Material[]
get
Returns number
set
Add a new material into this object. If use this method, please make sure that the material| material has set to Array.
Parameters
- material: Material
a new material which is set.
- index: number
the target position in the Array.
Returns this
- material: Material
set
set
Parameters
- material: Material
Returns this
expect
Expect this drawable only has one material, and return it.
Returns Material
check
Parameters
- innerChecker: (m: Material) => boolean
Returns boolean
for
Do something for every material| material whatever it is an instance or array.
Parameters
- v: (m: Material) => any
Returns void
update
update the data of bounding box and bounding sphere, set dirty mark to false.
Returns void
_
Parameters
- camera: Camera3D
- viewHeight: number
Returns void
update
Update the matrix local transform. Override
Returns void
_
Returns void
clear
Set all changing mark, such as geometryChanged| geometryChanged, materialChanged| materialChanged and extended mark .
Returns void
raycast
This method need override in derived classes to give a special calculation for picking feature.
Parameters
- raycaster: Raycaster
- intersects: Intersection[]
Returns void
Remarks
See Raycaster for more detail.
reset
Clean render data for optimization.
Returns void
refresh
set
If user changes material| material for drawable, use this method to refresh corresponding states.
Returns void
use
Returns this
destroy
Returns void
free
Returns void
class
The name of instance's class.
Returns string
update
Update the data which needs be changed according to the camera's state and attributes of Drawable.updateRenderInfo| Drawable before drawing this object.
Parameters
- camera: Camera3D
the camera which is used in current frame.
- viewHeight: number
the height of canvas.
Returns void
- camera: Camera3D
update
Parameters
- meshes: Mesh<Material, BufferGeometry<TriangleList>>[]
Returns void
update
Update the rendering date from this instance.
Returns void
update
Clear the rendering data of engine.
Returns void
raycast
Get intersections between a casted Ray| ray and this Mesh. The method intersectObject() will call this method, but the results are not ordered.
Parameters
- raycaster: Raycaster
the instance of Raycaster is used to get the data for calculation.
- intersects: Intersection[]
the result will be stored here.
Returns void
- raycaster: Raycaster
destroy
Returns void
clone
set
If user change the data of geometry, use this method to refresh the data.
Returns void
on
copy
Copy the data to this object from source. This method need override in derived classes to copy extended data.
Parameters
- source: Mesh<Material, InstancedBufferGeometry>
the data source.
- recursive: boolean
Returns this
- source: Mesh<Material, InstancedBufferGeometry>
mark
Parameters
- v: string
Returns this
is
Returns boolean
validate
Returns void
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
A special version of Mesh with instanced rendering supported. Use InstancedMesh if you have to render a large number of objects with the same geometry and material but with different world transformations. The usage of InstancedMesh will help you to reduce the number of draw calls and thus improve the overall rendering performance in your application.