|
@@ -12,12 +12,16 @@
|
|
|
|
|
|
<h1>[name]</h1>
|
|
|
|
|
|
- <div class="desc">Base class for Mesh objects, such as [page:MorphAnimMesh] and [page:SkinnedMesh].</div>
|
|
|
+ <div class="desc">
|
|
|
+ Class representing triangular [link:https://en.wikipedia.org/wiki/Polygon_mesh polygon mesh] based objects.
|
|
|
+ Also serves as a base for other classes such as [page:MorphAnimMesh] and [page:SkinnedMesh].
|
|
|
+ </div>
|
|
|
|
|
|
|
|
|
<h2>Example</h2>
|
|
|
|
|
|
- <code>var geometry = new THREE.BoxGeometry( 1, 1, 1 );
|
|
|
+ <code>
|
|
|
+ var geometry = new THREE.BoxBufferGeometry( 1, 1, 1 );
|
|
|
var material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
|
|
|
var mesh = new THREE.Mesh( geometry, material );
|
|
|
scene.add( mesh );
|
|
@@ -27,67 +31,82 @@
|
|
|
<h2>Constructor</h2>
|
|
|
|
|
|
<h3>[name]( [page:Geometry geometry], [page:Material material] )</h3>
|
|
|
-
|
|
|
<div>
|
|
|
- geometry — An instance of [page:Geometry].<br />
|
|
|
- material — An instance of [page:Material] (optional).
|
|
|
+ [page:Geometry geometry] — (optional) an instance of [page:Geometry] or [page:BufferGeometry].
|
|
|
+ Default is a new [page:BufferGeometry].<br />
|
|
|
+ [page:Material material] — (optional) a [page:Material]. Default is a new [page:new MeshBasicMaterial]
|
|
|
+ with a random color.
|
|
|
</div>
|
|
|
|
|
|
|
|
|
<h2>Properties</h2>
|
|
|
<div>See the base [page:Object3D] class for common properties.</div>
|
|
|
|
|
|
+ <h3>[property:Integer drawMode]</h3>
|
|
|
+ <div>
|
|
|
+ Determines how the mesh triangles are constructed from the vertices.
|
|
|
+ See the draw mode [page:DrawModes constants] for all possible values.
|
|
|
+ Default is [page:DrawModes TrianglesDrawMode].
|
|
|
+ </div>
|
|
|
+
|
|
|
+
|
|
|
+ <h3>[property:Boolean isMesh]</h3>
|
|
|
+ <div>
|
|
|
+ Used to check whether this or derived classes are meshes. Default is *true*.<br /><br />
|
|
|
+
|
|
|
+ You should not change this, as it used internally for optimisation.
|
|
|
+ </div>
|
|
|
+
|
|
|
<h3>[property:Geometry geometry]</h3>
|
|
|
+ <div>
|
|
|
+ An instance of [page:Geometry] or [page:BufferGeometry] (or derived classes),
|
|
|
+ defining the object's structure.<br /><br />
|
|
|
|
|
|
- <div>An instance of [page:Geometry], defining the object's structure.</div>
|
|
|
+ Its reccomended to always use a [page:BufferGeometry] if possible for best poerformance.
|
|
|
+ </div>
|
|
|
|
|
|
<h3>[property:Material material]</h3>
|
|
|
-
|
|
|
- <div>An instance of [page:Material], defining the object's appearance. Default is a [page:MeshBasicMaterial] with wireframe mode enabled and randomised colour.</div>
|
|
|
+ <div>
|
|
|
+ An instance of material derived from the [page:Material] base class, defining the
|
|
|
+ object's appearance. Default is a [page:MeshBasicMaterial] with a random colour.
|
|
|
+ </div>
|
|
|
|
|
|
<h3>[property:Array morphTargetInfluences]</h3>
|
|
|
-
|
|
|
<div>
|
|
|
An array of weights typically from 0-1 that specify how much of the morph is applied.
|
|
|
Undefined by default, but reset to a blank array by [page:Mesh.updateMorphTargets updateMorphTargets].
|
|
|
</div>
|
|
|
|
|
|
<h3>[property:Array morphTargetDictionary]</h3>
|
|
|
-
|
|
|
<div>
|
|
|
A dictionary of morphTargets based on the morphTarget.name property.
|
|
|
Undefined by default, but rebuilt [page:Mesh.updateMorphTargets updateMorphTargets].
|
|
|
</div>
|
|
|
|
|
|
- <h3>[property:Integer drawMode]</h3>
|
|
|
-
|
|
|
- <div>
|
|
|
- Determines how the mesh triangles are constructed from the vertices. See the draw mode [page:DrawModes constants] for all possible values. Default is [page:DrawModes TrianglesDrawMode].
|
|
|
- </div>
|
|
|
|
|
|
<h2>Methods</h2>
|
|
|
<div>See the base [page:Object3D] class for common methods.</div>
|
|
|
|
|
|
- <h3>[method:null updateMorphTargets]()</h3>
|
|
|
- <div>
|
|
|
- Updates the morphtargets to have no influence on the object. Resets the
|
|
|
- [page:Mesh.morphTargetInfluences morphTargetInfluences],
|
|
|
- [page:Mesh.morphTargetDictionary morphTargetDictionary], and
|
|
|
- [page:Mesh.morphTargetBase morphTargetBase] properties.
|
|
|
- </div>
|
|
|
+ <h3>[method:null setDrawMode]()</h3>
|
|
|
+ <div>Set the value of [page:.drawMode drawMode].</div>
|
|
|
+
|
|
|
+ <h3>[method:Mesh clone]()</h3>
|
|
|
+ <div>Returns a clone of this [name] object and its descendants.</div>
|
|
|
|
|
|
<h3>[method:Array raycast]( [page:Raycaster raycaster], [page:Array intersects] )</h3>
|
|
|
<div>
|
|
|
- Get intersections between a casted ray and this mesh. [page:Raycaster.intersectObject] will call this method.
|
|
|
+ Get intersections between a casted ray and this mesh.
|
|
|
+ [page:Raycaster.intersectObject] will call this method.
|
|
|
</div>
|
|
|
|
|
|
- <h3>[method:Mesh clone]()</h3>
|
|
|
+ <h3>[method:null updateMorphTargets]()</h3>
|
|
|
<div>
|
|
|
- Returns a clone of this Mesh object and its descendants.
|
|
|
+ Updates the morphtargets to have no influence on the object. Resets the
|
|
|
+ [page:Mesh.morphTargetInfluences morphTargetInfluences] and
|
|
|
+ [page:Mesh.morphTargetDictionary morphTargetDictionary] properties.
|
|
|
</div>
|
|
|
|
|
|
|
|
|
-
|
|
|
<h2>Source</h2>
|
|
|
|
|
|
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
|