Geometry is a user-friendly alternative to BufferGeometry. Geometries store attributes (vertex positions, faces, colors, etc.) using objects like Vector3 or Color that are easier to read and edit, but less efficient than typed arrays.
Prefer BufferGeometry for large or serious projects.
var geometry = new v3d.Geometry();
geometry.vertices.push(
new v3d.Vector3(-10, 10, 0),
new v3d.Vector3(-10, -10, 0),
new v3d.Vector3( 10, -10, 0)
);
geometry.faces.push(new v3d.Face3(0, 1, 2));
geometry.computeBoundingSphere();
The constructor takes no arguments.
Bounding box for the Geometry, which can be calculated with .computeBoundingBox(). Default is null.
Bounding sphere for the Geometry, which can be calculated with .computeBoundingSphere(). Default is null.
Array of vertex colors, matching number and order of vertices.
This is used by Points and Line and any classes derived from those such as LineSegments and various helpers.
Meshes use Face3.vertexColors instead of this.
To signal an update in this array, Geometry.colorsNeedUpdate needs to be set to true.
Array of faces.
The array of faces describe how each vertex in the model is connected to form faces.
Additionally it holds information about face and vertex normals and colors.
To signal an update in this array, Geometry.elementsNeedUpdate needs to be set to true.
Array of face UV layers, used for mapping textures onto the geometry.
Each UV layer is an array of UVs matching the order and number of vertices in faces.
To signal an update in this array, Geometry.uvsNeedUpdate needs to be set to true.
Unique number for this geometry instance.
Used to check whether this or derived classes are Geometries. Default is true.
You should not change this, as it used internally for optimisation.
An array containing distances between vertices for Line geometries. This is required for LineDashedMaterial to render correctly.
Array of morph targets. Each morph target is a Javascript object:
{ name: "targetName", vertices: [new v3d.Vector3(), ...] }
Morph vertices match number and order of primary vertices.
Array of morph normals. Morph normals have similar structure as morph targets, each normal set is a Javascript object:
morphNormal = { name: "NormalName", normals: [new v3d.Vector3(), ...] }
Optional name for this geometry. Default is an empty string.
When working with a SkinnedMesh, each vertex can have up to 4 bones affecting it. The skinWeights property is an array of weight values that correspond to the order of the vertices in the geometry. So for instance, the first skinWeight would correspond to the first vertex in the geometry. Since each vertex can be modified by 4 bones, a Vector4 is used to represent the skin weights for that vertex.
The values of the vector should typically be between 0 and 1. For instance when set to 0 the bone transformation will have no affect. When set to 0.5 it will have 50% affect. When set to 100%, it will have 100% affect. If there is only 1 bone associated with the vertex then you only need to worry about the first component of the vector, the rest can be ignored and set to 0.
Just like the skinWeights property, the skinIndices' values correspond to the geometry's vertices. Each vertex can have up to 4 bones associated with it. So if you look at the first vertex, and the first skinIndex, this will tell you the bones associated with that vertex. For example the first vertex could have a value of (10.05, 30.10, 12.12). Then the first skin index could have the value of (10, 2, 0, 0). The first skin weight could have the value of (0.8, 0.2, 0, 0). In affect this would take the first vertex, and then the bone mesh.bones[10] and apply it 80% of the way. Then it would take the bone skeleton.bones[2] and apply it 20% of the way. The next two values have a weight of 0, so they would have no affect.
In code another example could look like this:
// e.g.
geometry.skinIndices[15] = new v3d.Vector4( 0, 5, 9, 10);
geometry.skinWeights[15] = new v3d.Vector4(0.2, 0.5, 0.3, 0);
// corresponds with the following vertex
geometry.vertices[15];
// these bones will be used like so:
skeleton.bones[0]; // weight of 0.2
skeleton.bones[5]; // weight of 0.5
skeleton.bones[9]; // weight of 0.3
skeleton.bones[10]; // weight of 0
UUID of this object instance. This gets automatically assigned and shouldn't be edited.
Array of vertices.
The array of vertices holds the position of every vertex in the model.
To signal an update in this array, .verticesNeedUpdate needs to be set to true.
Set to true if the vertices array has been updated.
Set to true if the faces array has been updated.
Set to true if the uvs array has been updated.
Set to true if the normals array has been updated.
Set to true if the colors array or a face3 color has been updated.
Set to true if a face3 materialIndex has been updated.
Set to true if the linedistances array has been updated.
Bakes matrix transform directly into vertex coordinates.
Center the geometry based on the bounding box.
Creates a new clone of the Geometry.
This method copies only vertices, faces and uvs. It does not copy any other properties of the geometry.
Computes bounding box of the geometry, updating Geometry.boundingBox attribute.
Computes bounding sphere of the geometry, updating Geometry.boundingSphere attribute.
Neither bounding boxes or bounding spheres are computed by default. They need to be explicitly computed, otherwise they are null.
Computes face normals.
Computes flat vertex normals. Sets the vertex normal of each vertex of each face to be the same as the face's normal.
Computes .morphNormals.
areaWeighted - If true the contribution of each face normal to the vertex normal is
weighted by the area of the face. Default is true.
Computes vertex normals by averaging face normals.
Copies vertices, faces and uvs into this geometry. It does not copy any other properties of the geometry.
Removes The object from memory.
Don't forget to call this method when you remove a geometry because it can cause memory leaks.
Convert a BufferGeometry to a Geometry.
When converting from BufferGeometry to Geometry, all vertices are preserved, so duplicated vertices may appear.
Use Geometry.mergeVertices to remove them.
vector - A world vector to look at.
Rotates the geometry to face point in space. This is typically done as a one time operation but not during the render loop.
Use Object3D.lookAt for typical real-time mesh usage.
Merge two geometries or geometry and geometry from object (using object's transform)
Merge the mesh's geometry with this, also applying the mesh's transform.
Checks for duplicate vertices using hashmap.
Duplicated vertices are removed and faces' vertices are updated.
Normalize the geometry.
Make the geometry centered and have a bounding sphere of radius 1.0.
Rotate the geometry about the X axis. This is typically done as a one time operation but not during the render loop.
Use Object3D.rotation for typical real-time mesh rotation.
Rotate the geometry about the Y axis. This is typically done as a one time operation but not during the render loop.
Use Object3D.rotation for typical real-time mesh rotation.
Rotate the geometry about the Z axis. This is typically done as a one time operation but not during the render loop.
Use Object3D.rotation for typical real-time mesh rotation.
Sets the vertices for this Geometry from an array of points.
Sorts the faces array according to material index. For complex geometries with several materials, this can result in reduced draw calls and improved performance.
Scale the geometry data. This is typically done as a one time operation but not during the render loop.
Use Object3D.scale for typical real-time mesh scaling.
Convert the geometry to JSON format.
Translate the geometry. This is typically done as a one time operation but not during the render loop.
Use Object3D.position for typical real-time mesh translation.
For more info on how to obtain the source code of this module see this page.