Class MeshData

Contains mesh vertex and index data used for initializing, updating and reading mesh data from Mesh.

Index

Constructors

constructor

new MeshData(
    vertexCount: number,
    indexCount: number,
    layout: EnumValue<VertexLayout>,
    indexType?: EnumValue<IndexType>,
    isInternalConstructor?: boolean,
): MeshData
Parameters
- vertexCount: number
- indexCount: number
- layout: EnumValue<VertexLayout>
- OptionalindexType: EnumValue<IndexType>
- OptionalisInternalConstructor: boolean
Returns MeshData

Overrides FrameworkObject.constructor

Accessors

boneWeights

get boneWeights(): Iterable<BoneWeight>

An array of all vertex bone weights. Only valid if the vertex layout contains bone weights.

Returns Iterable<BoneWeight>
set boneWeights(
value: Iterable<BoneWeight> | readonly Immutable<BoneWeight>[],
): void
Parameters
- value: Iterable<BoneWeight> | readonly Immutable<BoneWeight>[]
Returns void

colors

get colors(): Iterable<Color>

An array of all vertex colors. Only valid if the vertex layout contains vertex colors.

Returns Iterable<Color>
set colors(value: readonly Immutable<Color>[] | Iterable<Color>): void
Parameters
- value: readonly Immutable<Color>[] | Iterable<Color>
Returns void

indexCount

get indexCount(): number

Returns the number of indices contained in the mesh.

Returns number

indices

get indices(): Iterable<number>

An array of all indices.

Returns Iterable<number>
set indices(value: readonly number[] | Iterable<number>): void
Parameters
- value: readonly number[] | Iterable<number>
Returns void

normals

get normals(): Iterable<Vector3>

An array of all vertex normals. Only valid if the vertex layout contains vertex normals.

Returns Iterable<Vector3>
set normals(value: Iterable<Vector3> | readonly Immutable<Vector3>[]): void
Parameters
- value: Iterable<Vector3> | readonly Immutable<Vector3>[]
Returns void

positions

get positions(): Iterable<Vector3>

An array of all vertex positions. Only valid if the vertex layout contains vertex positions.

Returns Iterable<Vector3>
set positions(value: Iterable<Vector3> | readonly Immutable<Vector3>[]): void
Parameters
- value: Iterable<Vector3> | readonly Immutable<Vector3>[]
Returns void

tangents

get tangents(): Iterable<Vector4>

An array of all vertex tangents. Only valid if the vertex layout contains vertex tangents.

Returns Iterable<Vector4>
set tangents(value: Iterable<Vector4> | readonly Immutable<Vector4>[]): void
Parameters
- value: Iterable<Vector4> | readonly Immutable<Vector4>[]
Returns void

uv0

get uv0(): Iterable<Vector2>

An array of all vertex texture coordinates in the UV0 channel. Only valid if the vertex layout contains UV0 coordinates.

Returns Iterable<Vector2>
set uv0(value: Iterable<Vector2> | readonly Immutable<Vector2>[]): void
Parameters
- value: Iterable<Vector2> | readonly Immutable<Vector2>[]
Returns void

uv1

get uv1(): Iterable<Vector2>

An array of all vertex texture coordinates in the UV1 channel. Only valid if the vertex layout contains UV1 coordinates.

Returns Iterable<Vector2>
set uv1(value: Iterable<Vector2> | readonly Immutable<Vector2>[]): void
Parameters
- value: Iterable<Vector2> | readonly Immutable<Vector2>[]
Returns void

vertexCount

get vertexCount(): number

Returns the number of vertices contained in the mesh.

Returns number

Methods

getIntersections

getIntersections(
lineOrigin: Immutable<Vector3>,
lineDirection: Immutable<Vector3>,
): Intersection[]
Get all intersections of the mesh with a line.

The function has the same limitations as EnumerateOverTrianglesForVertexPositions.
Parameters
- lineOrigin: Immutable<Vector3>
  A point on the line.
- lineDirection: Immutable<Vector3>
  A direction vector of the line.
Returns Intersection[]
All the intersection points.

intersects

intersects(
    ray: Immutable<Ray>,
    positiveSide?: boolean,
    negativeSide?: boolean,
): Intersection
Checks if any of the triangles intersects the ray.

The function has the same limitations as EnumerateOverTrianglesForVertexPositions.
Parameters
- ray: Immutable<Ray>
  Ray to test.
- OptionalpositiveSide: boolean
  (optional) Should intersections with the positive side (normal facing) count.
- OptionalnegativeSide: boolean
  (optional) Should intersections with the negative side (opposite of normal facing) count.
Returns Intersection
Pair representing if intersection was found. If that is the case second element is the distance to the nearest one.

supportPoint

supportPoint(direction: Immutable<Vector3>): Vector3
Finds vertex position that maximizes dot(vertexPosition, direction) The function has the same limitations as EnumerateOverTrianglesForVertexPositions.
Parameters
- direction: Immutable<Vector3>
  Direction in which to look.
Returns Vector3
Pair representing if point was found and it's position.

Class MeshData

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns MeshData

Accessors

boneWeights

Returns Iterable<BoneWeight>

Parameters

Returns void

colors

Returns Iterable<Color>

Parameters

Returns void

indexCount

Returns number

indices

Returns Iterable<number>

Parameters

Returns void

normals

Returns Iterable<Vector3>

Parameters

Returns void

positions

Returns Iterable<Vector3>

Parameters

Returns void

tangents

Returns Iterable<Vector4>

Parameters

Returns void

uv0

Returns Iterable<Vector2>

Parameters

Returns void

uv1

Returns Iterable<Vector2>

Parameters

Returns void

vertexCount

Returns number

Methods

getIntersections

Parameters

Returns Intersection[]

intersects

Parameters

Returns Intersection

supportPoint

Parameters

Returns Vector3

Settings

On This Page