Class Mesh

Primary class for holding geometry. Stores data in the form of vertex buffers and optionally an index buffer, which may be bound to the pipeline for drawing. May contain multiple sub-meshes.

Hierarchy (view full)

BuiltinResource
- Mesh

Constructors

constructor

new Mesh(options, isInternalConstructor?): Mesh
Creates a new mesh with enough space to hold the a number of primitives using the specified layout. All indices will be part of a single sub-mesh.
Parameters
- options:
      | {
          index?: EnumValue<IndexType, number>;
          indexCount: number;
          normalPacking?: EnumValue<NormalizedVectorPacking, number>;
          topology?: EnumValue<MeshTopology, number>;
          usage?: EnumValue<MeshUsage, number>;
          vertex?: EnumValue<VertexLayout, number>;
          vertexCount: number;
      }
      | {
          index?: EnumValue<IndexType, number>;
          indexCount: number;
          normalPacking?: EnumValue<NormalizedVectorPacking, number>;
          subMeshes: readonly Immutable<SubMesh>[];
          usage?: EnumValue<MeshUsage, number>;
          vertex?: EnumValue<VertexLayout, number>;
          vertexCount: number;
      }
      | {
          data: MeshData;
          topology?: EnumValue<MeshTopology, number>;
          usage?: EnumValue<MeshUsage, number>;
      }
      | {
          data: MeshData;
          subMeshes: readonly Immutable<SubMesh>[];
          usage?: EnumValue<MeshUsage, number>;
      }
  Options object for the function call.
- OptionalisInternalConstructor: boolean
Returns Mesh
Overrides BuiltinResource.constructor

Accessors

bounds

get bounds(): Immutable<Bounds>
Returns local bounds of the geometry contained in the vertex buffers for all sub-meshes.

Returns Immutable<Bounds>

cpuCachedData

get cpuCachedData(): MeshData
Accesses the vertex and index data of the mesh.

Returns MeshData
Note
The mesh must have been created with the MeshUsage::CPUCached flag. If the data is not CPU cached, use ReadDataAsync instead.

handle

get handle(): ResourceHandle<Mesh>
Returns a reference handle for this resource.

Returns ResourceHandle<Mesh>
Overrides BuiltinResource.handle

isCachedDataAvailable

get isCachedDataAvailable(): boolean
Determines if cached MeshData is available.

Returns boolean
Note
This required the MeshUsage::CPUCached flag to be set.

isDestroyed

get isDestroyed(): boolean
Determines if the resource is destroyed.

Returns boolean
Note
This can happen when the Resource was forcefully unloaded or reverted. For this reason, it is safer to hold on to a instead of directly referencing a resource pointer, as the current Resource can always be retrieved via .value.

Inherited from BuiltinResource.isDestroyed

isFullyStreamedIn

get isFullyStreamedIn(): boolean
Checks if all of the streaming data has been assigned.

Returns boolean
True if all the streaming data has been assigned via SetStreamingData.

isPreviewStreamedIn

get isPreviewStreamedIn(): boolean
Determines if the preview data has been streamed in.

Returns boolean

metaData

get metaData(): ResourceMetaData
Returns the meta data of this resource.

Returns ResourceMetaData
Inherited from BuiltinResource.metaData

morphShapes

get morphShapes(): MorphShapes
Returns an object containing all shapes used for morph animation, if any are available.

Returns MorphShapes

name

get name(): string
Name of the resource. Use primarily for easier identification and not important to the engine itself.

Returns string
Inherited from BuiltinResource.name

properties

get properties(): MeshProperties
Returns properties that contain information about the mesh.

Returns MeshProperties

skeleton

get skeleton(): Skeleton
Gets the skeleton required for animation of this mesh, if any is available.

Returns Skeleton

usage

get usage(): EnumValue<MeshUsage, number>
The usage flags of the mesh.

Returns EnumValue<MeshUsage, number>

uuid

get uuid(): UUID
Returns a universally unique identifier of this resource.

Returns UUID
Inherited from BuiltinResource.uuid

Methods

duplicate

duplicate(): Resource
Duplicates the resource and creates a unique UUID for the duplicated resource.

Returns Resource
The duplicated resource or null, if the duplication failed.

Inherited from BuiltinResource.duplicate

getSkeletonPhysicsData

getSkeletonPhysicsData(): SkeletonPhysicsData
Returns the SkeletonPhysicsData resource that is used by the skeleton of the mesh (if skeleton and the physics data exist)

Returns SkeletonPhysicsData
the SkeletonPhysicsData of the skeleton or null if it does not exist

onCreate

onCreate(): void
Virtual
Method called by RSX to perform actions required after the creation of the resource.

Returns void
Inherited from BuiltinResource.onCreate

onDeserializationEnded

onDeserializationEnded(): void
Virtual
Method called by RSX to perform any operations needed after deserialization.

Returns void
Note
Use this API to restore your serializable data into live objects.

Inherited from BuiltinResource.onDeserializationEnded

onDisable

onDisable(): void
Virtual
Method called by RSX to disable the resource.

Returns void
Note
Use this API to deactivate the resource before it is serialized.

Inherited from BuiltinResource.onDisable

onEnable

onEnable(): void
Virtual
Method called by RSX to enable the resource.

Returns void
Note
Use this API to activate the resource after it has been disabled by serialization.

Inherited from BuiltinResource.onEnable

onInitialize

onInitialize(): void
Virtual
Method called by RSX to perform initialization of the resource.

Returns void
Note
Use this API to initialize data and default construct all fields.

Inherited from BuiltinResource.onInitialize

onSerializationStart

onSerializationStart(): void
Virtual
Method called by RSX to perform any operations before serialization.

Returns void
Note
Use this API to bake your live data into serializable data.

Inherited from BuiltinResource.onSerializationStart

readDataAsync

readDataAsync(): AsyncOp<MeshData, void>
Reads internal mesh data into and immediately creates the MeshData. Performs the read asynchronously without blocking the GPU.

Returns AsyncOp<MeshData, void>
Async operation object that will contain the buffer with the data once the operation completes.

Note
This is an "asynchronous method".

revert

revert(): boolean
Reverts the resource to the on-disk representation.

Returns boolean
Note
This is a potentially expensive call, as it needs to deserialize and replace all existing in-memory resource handles.

Inherited from BuiltinResource.revert

setMeshData

setMeshData(value): UncertainAsyncOp<Any, string>
Sets the vertex and index data of the mesh.
Parameters
- value: MeshData
Returns UncertainAsyncOp<Any, string>
Note
The caller must ensure the data matches mesh's vertex/index counts, vertex layout and index format.

unload

unload(): void
Forcefully unloads the resource.

Returns void
Inherited from BuiltinResource.unload

Class Mesh

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Mesh

Accessors

bounds

Returns Immutable<Bounds>

cpuCachedData

Returns MeshData

Note

handle

Returns ResourceHandle<Mesh>

isCachedDataAvailable

Returns boolean

Note

isDestroyed

Returns boolean

Note

isFullyStreamedIn

Returns boolean

isPreviewStreamedIn

Returns boolean

metaData

Returns ResourceMetaData

morphShapes

Returns MorphShapes

name

Returns string

properties

Returns MeshProperties

skeleton

Returns Skeleton

usage

Returns EnumValue<MeshUsage, number>

uuid

Returns UUID

Methods

duplicate

Returns Resource

getSkeletonPhysicsData

Returns SkeletonPhysicsData

onCreate

Returns void

onDeserializationEnded

Returns void

Note

onDisable

Returns void

Note

onEnable

Returns void

Note

onInitialize

Returns void

Note

onSerializationStart

Returns void

Note

readDataAsync

Returns AsyncOp<MeshData, void>

Note

revert

Returns boolean

Note

setMeshData

Parameters

Returns UncertainAsyncOp<Any, string>

Note

unload

Returns void

Settings

On This Page