CustomMesh
public final class CustomMesh implements AutoCloseable
A resource that defines the structure of a renderable mesh.
A CustomMesh is composed of a MeshBuffer and a list of MeshSubsets. Each MeshSubset defines a part of the mesh that can be rendered with a single Material.
Summary
Nested types |
|---|
public final class CustomMesh.BuilderFromMeshBufferBuilder for |
public final class CustomMesh.BuilderFromMeshDataBuilder for |
Public methods |
|
|---|---|
void |
Closes the given |
final @NonNull BoundingBox |
Bounding box of the mesh, used for culling. |
final @NonNull MeshBuffer |
The |
final @NonNull List<@NonNull MeshSubset> |
The list of |
final void |
@MainThreadBounding box of the mesh, used for culling. |
Public methods
close
@MainThread
public void close()
Closes the given CustomMesh.
The CustomMesh can be explicitly closed at anytime or garbage collected. An exception will be thrown if the CustomMesh is used after being closed.
| Throws | |
|---|---|
IllegalStateException |
if the resource has already been closed. |
getBounds
public final @NonNull BoundingBox getBounds()
Bounding box of the mesh, used for culling.
It is an axis-aligned bounding box in the mesh's local coordinate space. It does not need to be tightly fit to the mesh, but tighter bounds will result in more efficient culling.
When the vertex positions are dynamically updated in the underlying MeshBuffer, this culling volume is not automatically recalculated on the CPU to avoid expensive synchronization or active memory copies. Instead, the application can manually set this property to specify the updated bounds.
The setter for this property must be called on the main thread.
| Throws | |
|---|---|
IllegalStateException |
if the property is set after this mesh has been closed. |
getMeshBuffer
public final @NonNull MeshBuffer getMeshBuffer()
The MeshBuffer containing the vertex and index data for this mesh.
getSubsets
public final @NonNull List<@NonNull MeshSubset> getSubsets()
The list of MeshSubsets defining the parts of the mesh.
setBounds
@MainThread
public final void setBounds(@NonNull BoundingBox value)
Bounding box of the mesh, used for culling.
It is an axis-aligned bounding box in the mesh's local coordinate space. It does not need to be tightly fit to the mesh, but tighter bounds will result in more efficient culling.
When the vertex positions are dynamically updated in the underlying MeshBuffer, this culling volume is not automatically recalculated on the CPU to avoid expensive synchronization or active memory copies. Instead, the application can manually set this property to specify the updated bounds.
The setter for this property must be called on the main thread.
| Throws | |
|---|---|
IllegalStateException |
if the property is set after this mesh has been closed. |