System that manages Splat logic for initializing the Splat Renderer, loading splat data and updating the splat data transform at the Splat Renderer level.

Signature

class SplatSystem(val context: SpatialContext) : SystemBase

Constructors

SplatSystem ( context )

Signature

constructor(context: SpatialContext)

Parameters

                                                    context:
SpatialContext

Returns

SplatSystem

Properties

context : SpatialContext [Get]	Signature val context: SpatialContext
executeCount : Long [Get]	The number of times the system has been executed. Signature var executeCount: Long
systemManager : SystemManager [Get][Set]	The system manager that this system is associated with. Signature lateinit var systemManager: SystemManager

Functions

associateSystemManager ( systemManager )	Associates this system with a system manager, used in the Spatial SDK. Signature fun associateSystemManager(systemManager: SystemManager) Parameters systemManager: SystemManager The system manager to associate with.
delete ( entity )	System should do any housekeeping based on SplatSystem.delete being removed from the scene Signature open override fun delete(entity: Entity) Parameters entity: Entity
destroy ()	System should clean up any and all resources for shutdown Signature open override fun destroy()
equals ( other )	Checks if this system is equal to another object. Signature open operator override fun equals(other: Any?): Boolean Parameters other: Any? The object to compare with. Returns Boolean True if this system is equal to the other object, false otherwise.
execute ()	System should perform all the operations based on relevant entities. Signature open override fun execute()
getDependencies ()	Returns the dependencies of this system. Signature open fun getDependencies(): SystemDependencies? Returns SystemDependencies? The dependencies of this system, or null if there are no dependencies.
getScene ()	Returns the scene that this system is associated with. Signature fun getScene(): Scene Returns Scene The scene that this system is associated with.
hashCode ()	Returns the hash code of this system. Signature open override fun hashCode(): Int Returns Int The hash code of this system.
isPlyFile ( file )	Signature fun isPlyFile(file: File): Boolean Parameters file: File Returns Boolean
isSplatRendererInitialized ()	Signature fun isSplatRendererInitialized(): Boolean Returns Boolean
isSpzFile ( file )	Signature fun isSpzFile(file: File): Boolean Parameters file: File Returns Boolean
loadFileFromUri ( context , uri )	Load file from any source (file://, apk://, http://, https://) Signature suspend fun loadFileFromUri(context: Context, uri: Uri): Result<Pair<ByteArray, SplatFormat>> Parameters context: Context uri: Uri Returns Result<Pair<ByteArray, SplatFormat>>
loadSplatAsync ( entity , context , uri )	Signature fun loadSplatAsync(entity: Entity, context: SpatialContext, uri: Uri) Parameters entity: Entity context: SpatialContext uri: Uri
setSplatVisibility ( entityID , visibility )	Signature fun setSplatVisibility(entityID: Long, visibility: Boolean) Parameters entityID: Long visibility: Boolean
shouldBeVisible ( entity )	Signature fun shouldBeVisible(entity: Entity): Boolean Parameters entity: Entity Returns Boolean
updateSplatTransform ( entityID , pose , scale )	Signature fun updateSplatTransform(entityID: Long, pose: Pose, scale: Vector3) Parameters entityID: Long pose: Pose scale: Vector3