VertexData

This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance

Hierarchy

  • VertexData

Index

Properties

colors

Find examples in Playground

An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]

indices

Find examples in Playground

An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]

matricesIndices

Find examples in Playground
matricesIndices: 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).

matricesIndicesExtra

Find examples in Playground
matricesIndicesExtra: Nullable<FloatArray>

An array extending the number of possible indices

matricesWeights

Find examples in Playground
matricesWeights: Nullable<FloatArray>

An array containing the list of weights defining the weight of each indexed matrix in the final computation

matricesWeightsExtra

Find examples in Playground
matricesWeightsExtra: Nullable<FloatArray>

An array extending the number of possible weights when the number of indices is extended

normals

Find examples in Playground

An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]

positions

Find examples in Playground
positions: Nullable<FloatArray>

An array of the x, y, z position of each vertex [...., x, y, z, .....]

tangents

Find examples in Playground
tangents: Nullable<FloatArray>

An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]

uvs

Find examples in Playground

An array of u,v which maps a texture image onto each vertex [...., u, v, .....]

uvs2

Find examples in Playground

A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]

uvs3

Find examples in Playground

A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]

uvs4

Find examples in Playground

A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]

uvs5

Find examples in Playground

A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]

uvs6

Find examples in Playground

A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]

Methods

applyToGeometry

Find examples in Playground
  • Associates the vertexData to the passed Geometry. Sets it as updatable or not (default false)

    Parameters

    • geometry: Geometry

      the geometry the vertexData is applied to

    • Optional updatable: boolean

      when used and having the value true allows new data to update the vertexData

    Returns VertexData

    VertexData

applyToMesh

Find examples in Playground
  • Associates the vertexData to the passed Mesh. Sets it as updatable or not (default false)

    Parameters

    • mesh: Mesh

      the mesh the vertexData is applied to

    • Optional updatable: boolean

      when used and having the value true allows new data to update the vertexData

    Returns VertexData

    the VertexData

merge

Find examples in Playground
  • Merges the passed VertexData into the current one

    Parameters

    • other: VertexData

      the VertexData to be merged into the current one

    • Optional use32BitsIndices: boolean

      defines a boolean indicating if indices must be store in a 32 bits array

    Returns VertexData

    the modified VertexData

serialize

Find examples in Playground
  • serialize(): any
  • Serializes the VertexData

    Returns any

    a serialized object

set

Find examples in Playground
  • Uses the passed data array to set the set the values for the specified kind of data

    Parameters

    • data: FloatArray

      a linear array of floating numbers

    • kind: string

      the type of data that is being set, eg positions, colors etc

    Returns void

transform

Find examples in Playground
  • Transforms each position and each normal of the vertexData according to the passed Matrix

    Parameters

    • matrix: Matrix

      the transforming matrix

    Returns VertexData

    the VertexData

updateGeometry

Find examples in Playground
  • updateGeometry(geometry: Geometry, updateExtends?: boolean, makeItUnique?: boolean): VertexData
  • Updates the associated geometry

    Parameters

    • geometry: Geometry

      the geometry to be updated

    • Optional updateExtends: boolean

      when true BoundingInfo will be renewed when and if position kind is updated, optional with default false

    • Optional makeItUnique: boolean

      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

    VertexData.

updateMesh

Find examples in Playground
  • updateMesh(mesh: Mesh, updateExtends?: boolean, makeItUnique?: boolean): VertexData
  • Updates the associated mesh

    Parameters

    • mesh: Mesh

      the mesh to be updated

    • Optional updateExtends: boolean

      when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false

    • Optional makeItUnique: boolean

      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

    VertexData

Static ComputeNormals

Find examples in Playground
  • ComputeNormals(positions: any, indices: any, normals: any, options?: object): void
  • Compute normals for given positions and indices

    Parameters

    • positions: any

      an array of vertex positions, [...., x, y, z, ......]

    • indices: any

      an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]

    • normals: any

      an array of vertex normals, [...., x, y, z, ......]

    • Optional options: object

      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
      • Optional bInfo?: any
      • Optional bbSize?: Vector3
      • Optional depthSort?: boolean
      • Optional depthSortedFacets?: any
      • Optional distanceTo?: Vector3
      • Optional facetNormals?: any
      • Optional facetPartitioning?: any
      • Optional facetPositions?: any
      • Optional ratio?: number
      • Optional subDiv?: any
      • Optional useRightHandedSystem?: boolean

    Returns void

Static CreateBox

Find examples in Playground
  • Creates the VertexData for a box

    Parameters

    • options: object

      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)
      • Optional backUVs?: Vector4
      • Optional depth?: number
      • Optional faceColors?: Color4[]
      • Optional faceUV?: Vector4[]
      • Optional frontUVs?: Vector4
      • Optional height?: number
      • Optional sideOrientation?: number
      • Optional size?: number
      • Optional width?: number

    Returns VertexData

    the VertexData of the box

Static CreateCylinder

Find examples in Playground
  • Creates the VertexData for a cylinder, cone or prism

    Parameters

    • options: object

      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)
      • Optional arc?: number
      • Optional backUVs?: Vector4
      • Optional diameter?: number
      • Optional diameterBottom?: number
      • Optional diameterTop?: number
      • Optional enclose?: boolean
      • Optional faceColors?: Color4[]
      • Optional faceUV?: Vector4[]
      • Optional frontUVs?: Vector4
      • Optional hasRings?: boolean
      • Optional height?: number
      • Optional sideOrientation?: number
      • Optional subdivisions?: number
      • Optional tessellation?: number

    Returns VertexData

    the VertexData of the cylinder, cone or prism

Static CreateDashedLines

Find examples in Playground
  • Create the VertexData for a DashedLines

    Parameters

    • options: object

      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
      • Optional dashNb?: number
      • Optional dashSize?: number
      • Optional gapSize?: number
      • points: Vector3[]

    Returns VertexData

    the VertexData for the DashedLines

Static CreateDisc

Find examples in Playground
  • Creates the VertexData of the Disc or regular Polygon

    Parameters

    • options: object

      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)
      • Optional arc?: number
      • Optional backUVs?: Vector4
      • Optional frontUVs?: Vector4
      • Optional radius?: number
      • Optional sideOrientation?: number
      • Optional tessellation?: number

    Returns VertexData

    the VertexData of the box

Static CreateGround

Find examples in Playground
  • Creates the VertexData for a Ground

    Parameters

    • options: object

      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
      • Optional height?: number
      • Optional subdivisions?: number
      • Optional subdivisionsX?: number
      • Optional subdivisionsY?: number
      • Optional width?: number

    Returns VertexData

    the VertexData of the Ground

Static CreateGroundFromHeightMap

Find examples in Playground
  • CreateGroundFromHeightMap(options: object): VertexData
  • Creates the VertexData of the Ground designed from a heightmap

    Parameters

    • options: object

      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
      • alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
      • alphaFilter: number
      • buffer: Uint8Array
      • bufferHeight: number
      • bufferWidth: number
      • colorFilter: Color3
      • height: number
      • maxHeight: number
      • minHeight: number
      • subdivisions: number
      • width: number

    Returns VertexData

    the VertexData of the Ground designed from a heightmap

Static CreateIcoSphere

Find examples in Playground
  • Creates the VertexData of the IcoSphere

    Parameters

    • options: object

      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)
      • Optional backUVs?: Vector4
      • Optional flat?: boolean
      • Optional frontUVs?: Vector4
      • Optional radius?: number
      • Optional radiusX?: number
      • Optional radiusY?: number
      • Optional radiusZ?: number
      • Optional sideOrientation?: number
      • Optional subdivisions?: number

    Returns VertexData

    the VertexData of the IcoSphere

Static CreateLineSystem

Find examples in Playground
  • Creates the VertexData of the LineSystem

    Parameters

    • options: object

      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 VertexData

    the VertexData of the LineSystem

Static CreatePlane

Find examples in Playground
  • Creates the VertexData for a Plane

    Parameters

    • options: object

      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)
      • Optional backUVs?: Vector4
      • Optional frontUVs?: Vector4
      • Optional height?: number
      • Optional sideOrientation?: number
      • Optional size?: number
      • Optional width?: number

    Returns VertexData

    the VertexData of the box

Static CreatePolygon

Find examples in Playground
  • 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

    Parameters

    • polygon: Mesh

      a mesh built from polygonTriangulation.build()

    • sideOrientation: number

      takes the values BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE

    • Optional fUV: Vector4[]

      an array of Vector4 elements used to set different images to the top, rings and bottom respectively

    • Optional fColors: Color4[]

      an array of Color3 elements used to set different colors to the top, rings and bottom respectively

    • Optional frontUVs: Vector4

      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)

    • Optional backUVs: Vector4

      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 VertexData

    the VertexData of the Polygon

Static CreatePolyhedron

Find examples in Playground
  • Creates the VertexData for a Polyhedron

    Parameters

    • options: object

      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)
      • Optional backUVs?: Vector4
      • Optional custom?: any
      • Optional faceColors?: Color4[]
      • Optional faceUV?: Vector4[]
      • Optional flat?: boolean
      • Optional frontUVs?: Vector4
      • Optional sideOrientation?: number
      • Optional size?: number
      • Optional sizeX?: number
      • Optional sizeY?: number
      • Optional sizeZ?: number
      • Optional type?: number

    Returns VertexData

    the VertexData of the Polyhedron

Static CreateRibbon

Find examples in Playground
  • Creates the VertexData for a Ribbon

    Parameters

    • options: object

      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
      • Optional backUVs?: Vector4
      • Optional closeArray?: boolean
      • Optional closePath?: boolean
      • Optional colors?: Color4[]
      • Optional frontUVs?: Vector4
      • Optional invertUV?: boolean
      • Optional offset?: number
      • pathArray: Vector3[][]
      • Optional sideOrientation?: number
      • Optional uvs?: Vector2[]

    Returns VertexData

    the VertexData of the ribbon

Static CreateSphere

Find examples in Playground
  • Creates the VertexData for an ellipsoid, defaults to a sphere

    Parameters

    • options: object

      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)
      • Optional arc?: number
      • Optional backUVs?: Vector4
      • Optional diameter?: number
      • Optional diameterX?: number
      • Optional diameterY?: number
      • Optional diameterZ?: number
      • Optional frontUVs?: Vector4
      • Optional segments?: number
      • Optional sideOrientation?: number
      • Optional slice?: number

    Returns VertexData

    the VertexData of the ellipsoid

Static CreateTiledGround

Find examples in Playground
  • Creates the VertexData for a TiledGround by subdividing the ground into tiles

    Parameters

    • options: object

      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}
      • Optional precision?: object
        • h: number
        • w: number
      • Optional subdivisions?: object
        • h: number
        • w: number
      • xmax: number
      • xmin: number
      • zmax: number
      • zmin: number

    Returns VertexData

    the VertexData of the TiledGround

Static CreateTorus

Find examples in Playground
  • Creates the VertexData for a torus

    Parameters

    • options: object

      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)
      • Optional backUVs?: Vector4
      • Optional diameter?: number
      • Optional frontUVs?: Vector4
      • Optional sideOrientation?: number
      • Optional tessellation?: number
      • Optional thickness?: number

    Returns VertexData

    the VertexData of the torus

Static CreateTorusKnot

Find examples in Playground
  • Creates the VertexData for a TorusKnot

    Parameters

    • options: object

      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)
      • Optional backUVs?: Vector4
      • Optional frontUVs?: Vector4
      • Optional p?: number
      • Optional q?: number
      • Optional radialSegments?: number
      • Optional radius?: number
      • Optional sideOrientation?: number
      • Optional tube?: number
      • Optional tubularSegments?: number

    Returns VertexData

    the VertexData of the Torus Knot

Static ExtractFromGeometry

Find examples in Playground
  • ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData
  • Extracts the vertexData from the geometry

    Parameters

    • geometry: Geometry

      the geometry from which to extract the VertexData

    • Optional copyWhenShared: boolean

      defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false

    • Optional forceCopy: boolean

      indicating that the VertexData must be cloned, optional, default false

    Returns VertexData

    the object VertexData associated to the passed mesh

Static ExtractFromMesh

Find examples in Playground
  • ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData
  • Extracts the vertexData from a mesh

    Parameters

    • mesh: Mesh

      the mesh from which to extract the VertexData

    • Optional copyWhenShared: boolean

      defines if the VertexData must be cloned when shared between multiple meshes, optional, default false

    • Optional forceCopy: boolean

      indicating that the VertexData must be cloned, optional, default false

    Returns VertexData

    the object VertexData associated to the passed mesh

Static ImportVertexData

Find examples in Playground
  • ImportVertexData(parsedVertexData: any, geometry: Geometry): void
  • Applies VertexData created from the imported parameters to the geometry

    Parameters

    • parsedVertexData: any

      the parsed data from an imported file

    • geometry: Geometry

      the geometry to apply the VertexData to

    Returns void

Generated using TypeDoc