|
|
@@ -1,4 +1,7 @@
|
|
|
module BABYLON {
|
|
|
+ /**
|
|
|
+ * Define an interface for all classes that will get and set the data on vertices
|
|
|
+ */
|
|
|
export interface IGetSetVerticesData {
|
|
|
isVerticesDataPresent(kind: string): boolean;
|
|
|
getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
|
|
|
@@ -8,23 +11,91 @@
|
|
|
setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
|
|
|
}
|
|
|
|
|
|
+ /**
|
|
|
+ * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
|
|
|
+ */
|
|
|
export class VertexData {
|
|
|
+
|
|
|
+ /**
|
|
|
+ * An array of the x, y, z position of each vertex [...., x, y, z, .....]
|
|
|
+ */
|
|
|
public positions: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
|
|
|
+ */
|
|
|
public normals: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
|
|
|
+ */
|
|
|
public tangents: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
|
|
|
+ */
|
|
|
public uvs: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
|
|
|
+ */
|
|
|
public uvs2: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
|
|
|
+ */
|
|
|
public uvs3: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
|
|
|
+ */
|
|
|
public uvs4: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
|
|
|
+ */
|
|
|
public uvs5: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
|
|
|
+ */
|
|
|
public uvs6: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
|
|
|
+ */
|
|
|
public colors: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * An array containing the list of indices to the array of matrices produced by bones, each vertex have up to 4 indices (8 if the matricesIndicesExtra is set).
|
|
|
+ */
|
|
|
public matricesIndices: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * An array containing the list of weights defining the weight of each indexed matrix in the final computation
|
|
|
+ */
|
|
|
public matricesWeights: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * An array extending the number of possible indices
|
|
|
+ */
|
|
|
public matricesIndicesExtra: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * An array extending the number of possible weights when the number of indices is extended
|
|
|
+ */
|
|
|
public matricesWeightsExtra: Nullable<FloatArray>;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
|
|
|
+ */
|
|
|
public indices: Nullable<IndicesArray>;
|
|
|
|
|
|
+ /**
|
|
|
+ * Uses the passed data array to set the set the values for the specified kind of data
|
|
|
+ * @param data a linear array of floating numbers
|
|
|
+ * @param kind the type of data that is being set, eg positions, colors etc
|
|
|
+ */
|
|
|
public set(data: FloatArray, kind: string) {
|
|
|
switch (kind) {
|
|
|
case VertexBuffer.PositionKind:
|
|
|
@@ -73,9 +144,11 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Associates the vertexData to the passed Mesh.
|
|
|
- * Sets it as updatable or not (default `false`).
|
|
|
- * Returns the VertexData.
|
|
|
+ * Associates the vertexData to the passed Mesh.
|
|
|
+ * Sets it as updatable or not (default `false`)
|
|
|
+ * @param mesh the mesh the vertexData is applied to
|
|
|
+ * @param updatable when used and having the value true allows new data to update the vertexData
|
|
|
+ * @returns the VertexData
|
|
|
*/
|
|
|
public applyToMesh(mesh: Mesh, updatable?: boolean): VertexData {
|
|
|
this._applyTo(mesh, updatable);
|
|
|
@@ -83,9 +156,11 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Associates the vertexData to the passed Geometry.
|
|
|
- * Sets it as updatable or not (default `false`).
|
|
|
- * Returns the VertexData.
|
|
|
+ * Associates the vertexData to the passed Geometry.
|
|
|
+ * Sets it as updatable or not (default `false`)
|
|
|
+ * @param geometry the geometry the vertexData is applied to
|
|
|
+ * @param updatable when used and having the value true allows new data to update the vertexData
|
|
|
+ * @returns VertexData
|
|
|
*/
|
|
|
public applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData {
|
|
|
this._applyTo(geometry, updatable);
|
|
|
@@ -93,8 +168,11 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Updates the associated mesh.
|
|
|
- * Returns the VertexData.
|
|
|
+ * Updates the associated mesh
|
|
|
+ * @param mesh the mesh to be updated
|
|
|
+ * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
|
|
|
+ * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
|
|
|
+ * @returns VertexData
|
|
|
*/
|
|
|
public updateMesh(mesh: Mesh, updateExtends?: boolean, makeItUnique?: boolean): VertexData {
|
|
|
this._update(mesh);
|
|
|
@@ -102,8 +180,11 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Updates the associated geometry.
|
|
|
- * Returns the VertexData.
|
|
|
+ * Updates the associated geometry
|
|
|
+ * @param geometry the geometry to be updated
|
|
|
+ * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
|
|
|
+ * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
|
|
|
+ * @returns VertexData.
|
|
|
*/
|
|
|
public updateGeometry(geometry: Geometry, updateExtends?: boolean, makeItUnique?: boolean): VertexData {
|
|
|
this._update(geometry);
|
|
|
@@ -237,8 +318,9 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Transforms each position and each normal of the vertexData according to the passed Matrix.
|
|
|
- * Returns the VertexData.
|
|
|
+ * Transforms each position and each normal of the vertexData according to the passed Matrix
|
|
|
+ * @param matrix the transforming matrix
|
|
|
+ * @returns the VertexData
|
|
|
*/
|
|
|
public transform(matrix: Matrix): VertexData {
|
|
|
var transformed = Vector3.Zero();
|
|
|
@@ -288,8 +370,9 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Merges the passed VertexData into the current one.
|
|
|
- * Returns the modified VertexData.
|
|
|
+ * Merges the passed VertexData into the current one
|
|
|
+ * @param other the VertexData to be merged into the current one
|
|
|
+ * @returns the modified VertexData
|
|
|
*/
|
|
|
public merge(other: VertexData): VertexData {
|
|
|
this._validate();
|
|
|
@@ -414,8 +497,8 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Serializes the VertexData.
|
|
|
- * Returns a serialized object.
|
|
|
+ * Serializes the VertexData
|
|
|
+ * @returns a serialized object
|
|
|
*/
|
|
|
public serialize(): any {
|
|
|
var serializationObject = this.serialize();
|
|
|
@@ -485,14 +568,22 @@
|
|
|
|
|
|
// Statics
|
|
|
/**
|
|
|
- * Returns the object VertexData associated to the passed mesh.
|
|
|
+ * Extracts the vertexData from a mesh
|
|
|
+ * @param mesh the mesh from which to extract the VertexData
|
|
|
+ * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
|
|
|
+ * @param forceCopy indicating that the VertexData must be cloned, optional, default false
|
|
|
+ * @returns the object VertexData associated to the passed mesh
|
|
|
*/
|
|
|
public static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData {
|
|
|
return VertexData._ExtractFrom(mesh, copyWhenShared, forceCopy);
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Returns the object VertexData associated to the passed geometry.
|
|
|
+ * Extracts the vertexData from the geometry
|
|
|
+ * @param geometry the geometry from which to extract the VertexData
|
|
|
+ * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
|
|
|
+ * @param forceCopy indicating that the VertexData must be cloned, optional, default false
|
|
|
+ * @returns the object VertexData associated to the passed mesh
|
|
|
*/
|
|
|
public static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData {
|
|
|
return VertexData._ExtractFrom(geometry, copyWhenShared, forceCopy);
|
|
|
@@ -563,7 +654,19 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates the vertexData of the Ribbon.
|
|
|
+ * Creates the VertexData for a Ribbon
|
|
|
+ * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
|
|
|
+ * * pathArray array of paths, each of which an array of successive Vector3
|
|
|
+ * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
|
|
|
+ * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
|
|
|
+ * * offset a positive integer, only used when pathArray contains a single path (offset = 10 means the point 1 is joined to the point 11), default rounded half size of the pathArray length
|
|
|
+ * * sideOrientation optional and takes the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
|
|
|
+ * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
|
|
|
+ * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
|
|
|
+ * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
|
|
|
+ * @returns the VertexData of the ribbon
|
|
|
*/
|
|
|
public static CreateRibbon(options: { pathArray: Vector3[][], closeArray?: boolean, closePath?: boolean, offset?: number, sideOrientation?: number, frontUVs?: Vector4, backUVs?: Vector4, invertUV?: boolean, uvs?: Vector2[], colors?: Color4[] }): VertexData {
|
|
|
var pathArray: Vector3[][] = options.pathArray;
|
|
|
@@ -797,8 +900,19 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates the VertexData of the Box.
|
|
|
- */
|
|
|
+ * Creates the VertexData for a box
|
|
|
+ * @param options an object used to set the following optional parameters for the box, required but can be empty
|
|
|
+ * * size sets the width, height and depth of the box to the value of size, optional default 1
|
|
|
+ * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
|
|
|
+ * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
|
|
|
+ * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
|
|
|
+ * * faceUV an array of 6 Vector4 elements used to set different images to each box side
|
|
|
+ * * faceColors an array of 6 Color3 elements used to set different colors to each box side
|
|
|
+ * * sideOrientation optional and takes the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
|
|
|
+ * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * @returns the VertexData of the box
|
|
|
+ */
|
|
|
public static CreateBox(options: { size?: number, width?: number, height?: number, depth?: number, faceUV?: Vector4[], faceColors?: Color4[], sideOrientation?: number, frontUVs?: Vector4, backUVs?: Vector4 }): VertexData {
|
|
|
var normalsSource = [
|
|
|
new Vector3(0, 0, 1),
|
|
|
@@ -906,8 +1020,20 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates the VertexData of the Sphere.
|
|
|
- */
|
|
|
+ * Creates the VertexData for an ellipsoid, defaults to a sphere
|
|
|
+ * @param options an object used to set the following optional parameters for the box, required but can be empty
|
|
|
+ * * segments sets the number of horizontal strips optional, default 32
|
|
|
+ * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
|
|
|
+ * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
|
|
|
+ * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
|
|
|
+ * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
|
|
|
+ * * arc a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the circumference (latitude) given by the arc value, optional, default 1
|
|
|
+ * * slice a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the height (latitude) given by the arc value, optional, default 1
|
|
|
+ * * sideOrientation optional and takes the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
|
|
|
+ * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * @returns the VertexData of the ellipsoid
|
|
|
+ */
|
|
|
public static CreateSphere(options: { segments?: number, diameter?: number, diameterX?: number, diameterY?: number, diameterZ?: number, arc?: number, slice?: number, sideOrientation?: number, frontUVs?: Vector4, backUVs?: Vector4 }): VertexData {
|
|
|
var segments: number = options.segments || 32;
|
|
|
var diameterX: number = options.diameterX || options.diameter || 1;
|
|
|
@@ -978,8 +1104,24 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates the VertexData of the Cylinder or Cone.
|
|
|
- */
|
|
|
+ * Creates the VertexData for a cylinder, cone or prism
|
|
|
+ * @param options an object used to set the following optional parameters for the box, required but can be empty
|
|
|
+ * * height sets the height (y direction) of the cylinder, optional, default 2
|
|
|
+ * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
|
|
|
+ * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
|
|
|
+ * * diameter sets the diameter of the top and bottom of the cone, optional default 1
|
|
|
+ * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
|
|
|
+ * * subdivisions` the number of rings along the cylinder height, optional, default 1
|
|
|
+ * * arc a number from 0 to 1, to create an unclosed cylinder based on the fraction of the circumference given by the arc value, optional, default 1
|
|
|
+ * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
|
|
|
+ * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
|
|
|
+ * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
|
|
|
+ * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
|
|
|
+ * * sideOrientation optional and takes the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
|
|
|
+ * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * @returns the VertexData of the cylinder, cone or prism
|
|
|
+ */
|
|
|
public static CreateCylinder(options: { height?: number, diameterTop?: number, diameterBottom?: number, diameter?: number, tessellation?: number, subdivisions?: number, arc?: number, faceColors?: Color4[], faceUV?: Vector4[], hasRings?: boolean, enclose?: boolean, sideOrientation?: number, frontUVs?: Vector4, backUVs?: Vector4 }): VertexData {
|
|
|
var height: number = options.height || 2;
|
|
|
var diameterTop: number = (options.diameterTop === 0) ? 0 : options.diameterTop || options.diameter || 1;
|
|
|
@@ -1232,8 +1374,16 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates the VertexData of the Torus.
|
|
|
- */
|
|
|
+ * Creates the VertexData for a torus
|
|
|
+ * @param options an object used to set the following optional parameters for the box, required but can be empty
|
|
|
+ * * diameter the diameter of the torus, optional default 1
|
|
|
+ * * thickness the diameter of the tube forming the torus, optional default 0.5
|
|
|
+ * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
|
|
|
+ * * sideOrientation optional and takes the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
|
|
|
+ * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * @returns the VertexData of the torus
|
|
|
+ */
|
|
|
public static CreateTorus(options: { diameter?: number, thickness?: number, tessellation?: number, sideOrientation?: number, frontUVs?: Vector4, backUVs?: Vector4 }) {
|
|
|
var indices = [];
|
|
|
var positions = [];
|
|
|
@@ -1303,7 +1453,11 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates the VertexData of the LineSystem.
|
|
|
+ * Creates the VertexData of the LineSystem
|
|
|
+ * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
|
|
|
+ * - lines an array of lines, each line being an array of successive Vector3
|
|
|
+ * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
|
|
|
+ * @returns the VertexData of the LineSystem
|
|
|
*/
|
|
|
public static CreateLineSystem(options: { lines: Vector3[][], colors?: Nullable<Color4[][]> }): VertexData {
|
|
|
var indices = [];
|
|
|
@@ -1338,7 +1492,13 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Create the VertexData of the DashedLines.
|
|
|
+ * Create the VertexData for a DashedLines
|
|
|
+ * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
|
|
|
+ * - points an array successive Vector3
|
|
|
+ * - dashSize the size of the dashes relative to the dash number, optional, default 3
|
|
|
+ * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
|
|
|
+ * - dashNb the intended total number of dashes, optional, default 200
|
|
|
+ * @returns the VertexData for the DashedLines
|
|
|
*/
|
|
|
public static CreateDashedLines(options: { points: Vector3[], dashSize?: number, gapSize?: number, dashNb?: number }): VertexData {
|
|
|
var dashSize = options.dashSize || 3;
|
|
|
@@ -1385,7 +1545,12 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates the VertexData of the Ground.
|
|
|
+ * Creates the VertexData for a Ground
|
|
|
+ * @param options an object used to set the following optional parameters for the Ground, required but can be empty
|
|
|
+ * - width the width (x direction) of the ground, optional, default 1
|
|
|
+ * - height the height (z direction) of the ground, optional, default 1
|
|
|
+ * - subdivisions the number of subdivisions per side, optional, default 1
|
|
|
+ * @returns the VertexData of the Ground
|
|
|
*/
|
|
|
public static CreateGround(options: { width?: number, height?: number, subdivisions?: number, subdivisionsX?: number, subdivisionsY?: number }): VertexData {
|
|
|
var indices = [];
|
|
|
@@ -1434,7 +1599,15 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates the VertexData of the TiledGround.
|
|
|
+ * Creates the VertexData for a TiledGround by subdividing the ground into tiles
|
|
|
+ * @param options an object used to set the following optional parameters for the Ground, required but can be empty
|
|
|
+ * * xmin the ground minimum X coordinate, optional, default -1
|
|
|
+ * * zmin the ground minimum Z coordinate, optional, default -1
|
|
|
+ * * xmax the ground maximum X coordinate, optional, default 1
|
|
|
+ * * zmax the ground maximum Z coordinate, optional, default 1
|
|
|
+ * * subdivisions a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the ground width and height creating 'tiles', default {w: 6, h: 6}
|
|
|
+ * * precision a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the tile width and height, default {w: 2, h: 2}
|
|
|
+ * @returns the VertexData of the TiledGround
|
|
|
*/
|
|
|
public static CreateTiledGround(options: { xmin: number, zmin: number, xmax: number, zmax: number, subdivisions?: { w: number; h: number; }, precision?: { w: number; h: number; } }): VertexData {
|
|
|
var xmin = (options.xmin !== undefined && options.xmin !== null) ? options.xmin : -1.0;
|
|
|
@@ -1521,7 +1694,18 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates the VertexData of the Ground designed from a heightmap.
|
|
|
+ * Creates the VertexData of the Ground designed from a heightmap
|
|
|
+ * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
|
|
|
+ * * width the width (x direction) of the ground
|
|
|
+ * * height the height (z direction) of the ground
|
|
|
+ * * subdivisions the number of subdivisions per side
|
|
|
+ * * minHeight the minimum altitude on the ground, optional, default 0
|
|
|
+ * * maxHeight the maximum altitude on the ground, optional default 1
|
|
|
+ * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
|
|
|
+ * * buffer the array holding the image color data
|
|
|
+ * * bufferWidth the width of image
|
|
|
+ * * bufferHeight the height of image
|
|
|
+ * @returns the VertexData of the Ground designed from a heightmap
|
|
|
*/
|
|
|
public static CreateGroundFromHeightMap(options: { width: number, height: number, subdivisions: number, minHeight: number, maxHeight: number, colorFilter: Color3, buffer: Uint8Array, bufferWidth: number, bufferHeight: number }): VertexData {
|
|
|
var indices = [];
|
|
|
@@ -1584,8 +1768,16 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates the VertexData of the Plane.
|
|
|
- */
|
|
|
+ * Creates the VertexData for a Plane
|
|
|
+ * @param options an object used to set the following optional parameters for the plane, required but can be empty
|
|
|
+ * * size sets the width and height of the plane to the value of size, optional default 1
|
|
|
+ * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
|
|
|
+ * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
|
|
|
+ * * sideOrientation optional and takes the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
|
|
|
+ * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * @returns the VertexData of the box
|
|
|
+ */
|
|
|
public static CreatePlane(options: { size?: number, width?: number, height?: number, sideOrientation?: number, frontUVs?: Vector4, backUVs?: Vector4 }): VertexData {
|
|
|
var indices = [];
|
|
|
var positions = [];
|
|
|
@@ -1640,8 +1832,16 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates the VertexData of the Disc or regular Polygon.
|
|
|
- */
|
|
|
+ * Creates the VertexData of the Disc or regular Polygon
|
|
|
+ * @param options an object used to set the following optional parameters for the disc, required but can be empty
|
|
|
+ * * radius the radius of the disc, optional default 0.5
|
|
|
+ * * tessellation the number of polygon sides, optional, default 64
|
|
|
+ * * arc a number from 0 to 1, to create an unclosed polygon based on the fraction of the circumference given by the arc value, optional, default 1
|
|
|
+ * * sideOrientation optional and takes the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
|
|
|
+ * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * @returns the VertexData of the box
|
|
|
+ */
|
|
|
public static CreateDisc(options: { radius?: number, tessellation?: number, arc?: number, sideOrientation?: number, frontUVs?: Vector4, backUVs?: Vector4 }): VertexData {
|
|
|
var positions = new Array<number>();
|
|
|
var indices = new Array<number>();
|
|
|
@@ -1693,7 +1893,15 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Re-creates the VertexData of the Polygon for sideOrientation.
|
|
|
+ * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
|
|
|
+ * All parameters are provided by MeshBuilder.CreatePolygon as needed
|
|
|
+ * @param polygon a mesh built from polygonTriangulation.build()
|
|
|
+ * @param sideOrientation takes the values BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
|
|
|
+ * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
|
|
|
+ * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
|
|
|
+ * @param frontUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * @param backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * @returns the VertexData of the Polygon
|
|
|
*/
|
|
|
public static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4) {
|
|
|
var faceUV: Vector4[] = fUV || new Array<Vector4>(3);
|
|
|
@@ -1759,8 +1967,19 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates the VertexData of the IcoSphere.
|
|
|
- */
|
|
|
+ * Creates the VertexData of the IcoSphere
|
|
|
+ * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
|
|
|
+ * * radius the radius of the IcoSphere, optional default 1
|
|
|
+ * * radiusX allows stretching in the x direction, optional, default radius
|
|
|
+ * * radiusY allows stretching in the y direction, optional, default radius
|
|
|
+ * * radiusZ allows stretching in the z direction, optional, default radius
|
|
|
+ * * flat when true creates a flat shaded mesh, optional, default true
|
|
|
+ * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
|
|
|
+ * * sideOrientation optional and takes the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
|
|
|
+ * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * @returns the VertexData of the IcoSphere
|
|
|
+ */
|
|
|
public static CreateIcoSphere(options: { radius?: number, radiusX?: number, radiusY?: number, radiusZ?: number, flat?: boolean, subdivisions?: number, sideOrientation?: number, frontUVs?: Vector4, backUVs?: Vector4 }): VertexData {
|
|
|
var sideOrientation = options.sideOrientation || Mesh.DEFAULTSIDE;
|
|
|
var radius = options.radius || 1;
|
|
|
@@ -2023,7 +2242,24 @@
|
|
|
|
|
|
// inspired from // http://stemkoski.github.io/Three.js/Polyhedra.html
|
|
|
/**
|
|
|
- * Creates the VertexData of the Polyhedron.
|
|
|
+ * Creates the VertexData for a Polyhedron
|
|
|
+ * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
|
|
|
+ * * type provided types are:
|
|
|
+ * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
|
|
|
+ * * 9 : Pentagonal Pyramid (J2), 10 : Triangular Dipyramid (J12), 11 : Pentagonal Dipyramid (J13), 12 : Elongated Square Dipyramid (J15), 13 : Elongated Pentagonal Dipyramid (J16), 14 : Elongated Pentagonal Cupola (J20)
|
|
|
+ * * size the size of the IcoSphere, optional default 1
|
|
|
+ * * sizeX allows stretching in the x direction, optional, default size
|
|
|
+ * * sizeY allows stretching in the y direction, optional, default size
|
|
|
+ * * sizeZ allows stretching in the z direction, optional, default size
|
|
|
+ * * custom a number that overwrites the type to create from an extended set of polyhedron from https://www.babylonjs-playground.com/#21QRSK#15 with minimised editor
|
|
|
+ * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
|
|
|
+ * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
|
|
|
+ * * flat when true creates a flat shaded mesh, optional, default true
|
|
|
+ * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
|
|
|
+ * * sideOrientation optional and takes the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
|
|
|
+ * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * @returns the VertexData of the Polyhedron
|
|
|
*/
|
|
|
public static CreatePolyhedron(options: { type?: number, size?: number, sizeX?: number, sizeY?: number, sizeZ?: number, custom?: any, faceUV?: Vector4[], faceColors?: Color4[], flat?: boolean, sideOrientation?: number, frontUVs?: Vector4, backUVs?: Vector4 }): VertexData {
|
|
|
// provided polyhedron types :
|
|
|
@@ -2158,7 +2394,18 @@
|
|
|
|
|
|
// based on http://code.google.com/p/away3d/source/browse/trunk/fp10/Away3D/src/away3d/primitives/TorusKnot.as?spec=svn2473&r=2473
|
|
|
/**
|
|
|
- * Creates the VertexData of the Torus Knot.
|
|
|
+ * Creates the VertexData for a TorusKnot
|
|
|
+ * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
|
|
|
+ * * radius the radius of the torus knot, optional, default 2
|
|
|
+ * * tube the thickness of the tube, optional, default 0.5
|
|
|
+ * * radialSegments the number of sides on each tube segments, optional, default 32
|
|
|
+ * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
|
|
|
+ * * p the number of windings around the z axis, optional, default 2
|
|
|
+ * * q the number of windings around the x axis, optional, default 3
|
|
|
+ * * sideOrientation optional and takes the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
|
|
|
+ * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
|
|
|
+ * @returns the VertexData of the Torus Knot
|
|
|
*/
|
|
|
public static CreateTorusKnot(options: { radius?: number, tube?: number, radialSegments?: number, tubularSegments?: number, p?: number, q?: number, sideOrientation?: number, frontUVs?: Vector4, backUVs?: Vector4 }): VertexData {
|
|
|
var indices = new Array<number>();
|
|
|
@@ -2252,22 +2499,24 @@
|
|
|
}
|
|
|
|
|
|
// Tools
|
|
|
+
|
|
|
/**
|
|
|
- * @param {any} - positions (number[] or Float32Array)
|
|
|
- * @param {any} - indices (number[] or Uint16Array)
|
|
|
- * @param {any} - normals (number[] or Float32Array)
|
|
|
- * options (optional) :
|
|
|
- * facetPositions : optional array of facet positions (vector3)
|
|
|
- * facetNormals : optional array of facet normals (vector3)
|
|
|
- * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
|
|
|
- * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
|
|
|
- * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
|
|
|
- * bbSize : optional bounding box size data, required for facetPartitioning computation
|
|
|
- * bInfo : optional bounding info, required for facetPartitioning computation
|
|
|
- * useRightHandedSystem: optional boolean to for right handed system computation
|
|
|
- * depthSort : optional boolean to enable the facet depth sort computation
|
|
|
- * distanceTo : optional Vector3 to compute the facet depth from this location
|
|
|
- * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
|
|
|
+ * Compute normals for given positions and indices
|
|
|
+ * @param positions an array of vertex positions, [...., x, y, z, ......]
|
|
|
+ * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
|
|
|
+ * @param normals an array of vertex normals, [...., x, y, z, ......]
|
|
|
+ * @param options an object used to set the following optional parameters for the TorusKnot, optional
|
|
|
+ * * facetNormals : optional array of facet normals (vector3)
|
|
|
+ * * facetPositions : optional array of facet positions (vector3)
|
|
|
+ * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
|
|
|
+ * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
|
|
|
+ * * bInfo : optional bounding info, required for facetPartitioning computation
|
|
|
+ * * bbSize : optional bounding box size data, required for facetPartitioning computation
|
|
|
+ * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
|
|
|
+ * * useRightHandedSystem: optional boolean to for right handed system computation
|
|
|
+ * * depthSort : optional boolean to enable the facet depth sort computation
|
|
|
+ * * distanceTo : optional Vector3 to compute the facet depth from this location
|
|
|
+ * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
|
|
|
*/
|
|
|
public static ComputeNormals(positions: any, indices: any, normals: any,
|
|
|
options?: {
|
|
|
@@ -2543,7 +2792,9 @@
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
- * Creates a new VertexData from the imported parameters.
|
|
|
+ * Applies VertexData created from the imported parameters to the geometry
|
|
|
+ * @param parsedVertexData the parsed data from an imported file
|
|
|
+ * @param geometry the geometry to apply the VertexData to
|
|
|
*/
|
|
|
public static ImportVertexData(parsedVertexData: any, geometry: Geometry) {
|
|
|
var vertexData = new VertexData();
|
Gary Hsu
