CustomMesh.BuilderFromMeshData
class CustomMesh.BuilderFromMeshData
Builder for CustomMesh providing raw data directly.
This will implicitly create a MeshBuffer for you. You provide the VertexLayout along with the raw vertex and index data:
val builder = CustomMesh.BuilderFromMeshData(session, myLayout)
.addVertexData(myVertexData)
.setIndexData(myIndexData)
From here, you have two options for defining the mesh topology:
-
You can explicitly add one or more subsets:
builder.addSubset(MeshSubset(MeshSubsetTopology.TRIANGLES, 0, subset1Count))
builder.addSubset(MeshSubset(MeshSubsetTopology.TRIANGLES, subset1Count, subset2Count))
-
Or, if the entire mesh uses the same topology, you can define a single subset that spans all the provided index data:
builder.setTopology(MeshSubsetTopology.TRIANGLES)
Finally, build the mesh:
val mesh = builder.build()
Summary
Public constructors |
|---|
BuilderFromMeshData(session: Session, vertexLayout: VertexLayout) |
Public functions |
|
|---|---|
CustomMesh.BuilderFromMeshData |
addSubset(subset: MeshSubset)Adds a |
CustomMesh.BuilderFromMeshData |
addSubset(Adds a |
CustomMesh.BuilderFromMeshData |
addVertexData(vertexData: ByteBufferRegion)Adds vertex data for a single buffer. |
CustomMesh.BuilderFromMeshData |
addVertexData(Adds vertex data for a single buffer using the provided |
CustomMesh |
Builds a new |
CustomMesh.BuilderFromMeshData |
setBounds(bounds: BoundingBox)Sets an optional user-supplied bounding box for culling. |
CustomMesh.BuilderFromMeshData |
setIndexData(indexData: ByteBufferRegion)Sets the index data. |
CustomMesh.BuilderFromMeshData |
setIndexData(Sets the index data using the provided |
CustomMesh.BuilderFromMeshData |
setTopology(topology: MeshSubsetTopology)Sets the |
Public constructors
BuilderFromMeshData
BuilderFromMeshData(session: Session, vertexLayout: VertexLayout)
Public functions
addSubset
fun addSubset(subset: MeshSubset): CustomMesh.BuilderFromMeshData
Adds a MeshSubset defining a part of the mesh.
This cannot be used in combination with setTopology.
| Throws | |
|---|---|
IllegalStateException |
if a topology has already been set |
addSubset
fun addSubset(
topology: MeshSubsetTopology,
indexOffset: @IntRange(from = 0) Int,
indexCount: @IntRange(from = 0) Int
): CustomMesh.BuilderFromMeshData
Adds a MeshSubset defining a part of the mesh using the specified topology, index offset, and index count.
This cannot be used in combination with setTopology.
| Throws | |
|---|---|
IllegalStateException |
if a topology has already been set |
IllegalArgumentException |
if |
addVertexData
fun addVertexData(vertexData: ByteBufferRegion): CustomMesh.BuilderFromMeshData
Adds vertex data for a single buffer.
The order in which this method is called determines the buffer index. The first call provides data for buffer index 0, the second for buffer index 1, etc. The data is copied during build, so the original ByteBuffer can be modified or released after build without affecting the underlying MeshBuffer.
addVertexData
fun addVertexData(
buffer: ByteBuffer,
offset: @IntRange(from = 0) Int = 0,
size: @IntRange(from = 1) Int = buffer.capacity() - offset
): CustomMesh.BuilderFromMeshData
Adds vertex data for a single buffer using the provided ByteBuffer, offset, and size.
The order in which this method is called determines the buffer index. The first call provides data for buffer index 0, the second for buffer index 1, etc. The data is copied during build, so the original ByteBuffer can be modified or released after build without affecting the underlying MeshBuffer.
| Parameters | |
|---|---|
buffer: ByteBuffer |
containing the data |
offset: @IntRange(from = 0) Int = 0 |
absolute starting position within the buffer (ignoring its current position) in bytes (defaults to 0) |
size: @IntRange(from = 1) Int = buffer.capacity() - offset |
number of bytes in the region (defaults to the remaining capacity of the buffer after the given offset) |
| Throws | |
|---|---|
IllegalArgumentException |
if |
build
@MainThread
fun build(): CustomMesh
Builds a new CustomMesh.
| Throws | |
|---|---|
IllegalStateException |
if index data or vertex data are missing, or if both or neither of subsets and topology are provided. |
setBounds
fun setBounds(bounds: BoundingBox): CustomMesh.BuilderFromMeshData
Sets an optional user-supplied bounding box for culling.
If not provided, the auto-computed bounding box of the entire MeshBuffer will be used.
setIndexData
fun setIndexData(indexData: ByteBufferRegion): CustomMesh.BuilderFromMeshData
Sets the index data.
The data is copied during build, so the original ByteBuffer can be modified or released after build without affecting the underlying MeshBuffer.
setIndexData
fun setIndexData(
buffer: ByteBuffer,
offset: @IntRange(from = 0) Int = 0,
size: @IntRange(from = 1) Int = buffer.capacity() - offset
): CustomMesh.BuilderFromMeshData
Sets the index data using the provided ByteBuffer, offset, and size.
The data is copied during build, so the original ByteBuffer can be modified or released after build without affecting the underlying MeshBuffer.
| Parameters | |
|---|---|
buffer: ByteBuffer |
containing the data |
offset: @IntRange(from = 0) Int = 0 |
absolute starting position within the buffer (ignoring its current position) in bytes (defaults to 0) |
size: @IntRange(from = 1) Int = buffer.capacity() - offset |
number of bytes in the region (defaults to the remaining capacity of the buffer after the given offset) |
| Throws | |
|---|---|
IllegalArgumentException |
if |
setTopology
fun setTopology(topology: MeshSubsetTopology): CustomMesh.BuilderFromMeshData
Sets the MeshSubsetTopology to use for the entire mesh, defining a single subset that spans all provided index data.
This cannot be used in combination with addSubset.
| Throws | |
|---|---|
IllegalStateException |
if subsets have already been added |