filament-utils/io.github.erkko68.filament.utils/TangentSpaceMesh

TangentSpaceMesh

class TangentSpaceMesh(nativeHandle: NativePointer) : AutoCloseable

Builds Filament-style TANGENTS buffers (tangent-space quaternions) from an input mesh, with a choice of algorithms. Supersedes SurfaceOrientation.

If the chosen algorithm didn't remesh the input (remeshed), use the data you provided instead of querying it back. Getting positions or UVs that weren't provided as input aborts.

Constructors

TangentSpaceMesh

constructor(nativeHandle: NativePointer)

Types

Algorithm

enum Algorithm : Enum<TangentSpaceMesh.Algorithm>

The tangent-space algorithm.

AuxAttribute

enum AuxAttribute : Enum<TangentSpaceMesh.AuxAttribute>

Auxiliary vertex attributes: they don't affect the tangent space, but are mapped when the mesh is remeshed.

Builder

class Builder

Collects the input mesh. Strides are in bytes; 0 means tightly packed.

Properties

nativeObject

val nativeObject: NativePointer

The native object, for interop with code calling the Fila* C API directly. Read-only: this wrapper owns it.

remeshed

val remeshed: Boolean

Whether the algorithm remeshed the input: then read positions, UVs and triangles back.

triangleCount

val triangleCount: Int

The number of output triangles.

vertexCount

val vertexCount: Int

The number of output vertices, which differs from the input's if the mesh was remeshed.

Functions

open override fun close()

Same as destroy; lets this be used with use { } and try-with-resources.

destroy

fun destroy()

Frees the mesh.

getAux

fun getAux(attribute: TangentSpaceMesh.AuxAttribute, out: FloatArray, components: Int, stride: Int = 0)

Copies out an auxiliary attribute given to Builder.aux as floats, components (2–4) per vertex.

fun getAux(attribute: TangentSpaceMesh.AuxAttribute, out: ShortArray, components: Int, stride: Int = 0)

Copies out an auxiliary attribute given to Builder.aux as unsigned shorts, components (3–4) per vertex.

getHalfQuats

fun getHalfQuats(out: ShortArray, stride: Int = 0)

Copies out the tangent-space quaternions as 4 half floats per vertex (quath).

getPositions

fun getPositions(out: FloatArray, stride: Int = 0)

Copies out the output positions, 3 floats per vertex.

getQuats

fun getQuats(out: FloatArray, stride: Int = 0)

Copies out the tangent-space quaternions, 4 floats per vertex.

fun getQuats(out: ShortArray, stride: Int = 0)

Copies out the tangent-space quaternions as 4 normalized shorts per vertex (short4).

getTriangles

fun getTriangles(out: IntArray)

Copies out the output triangles in 32-bit indices, 3 per triangle.

fun getTriangles(out: ShortArray)

Copies out the output triangles in 16-bit indices, 3 per triangle.

getUVs

fun getUVs(out: FloatArray, stride: Int = 0)

Copies out the output UVs, 2 floats per vertex.