Meta Developers

API reference

API reference

Select your platform

No SDKs available

No versions available

com.meta.spatial.castinputforward

CastInputForwardFeature

CastInputForwardSystem

SimpleInputForwardHandler

com.meta.spatial.core

AbstractAttribute

AttributeListener

BooleanAttribute

ComponentCompanion

ComponentListener

ComponentManager

ComponentRegistration

EntityAttribute

EntitySortCriterion

ExperimentalMapAttribute

FloatSortCriterion

IntSortCriterion

LongSortCriterion

MissingSystemInfo

MissingSystemsGraph

PoseSortCriterion

PriorityGroupMap

QueryEventListenerManager

SortCriteriaBuilder

ASC_CASE_INSENSITIVE

DESC_CASE_INSENSITIVE

SpatialInterface

StringAttribute

StringSortCriterion

SystemDependencies

SystemDependenciesExists

SystemDependencyConfig

TimeSortCriterion

Vector2Attribute

Vector2SortCriterion

Vector3Attribute

Vector3SortCriterion

Vector4Attribute

Vector4SortCriterion

com.meta.spatial.debugtools

AssetReloadSystem

HotReloadFeature

RecursiveFileObserver

com.meta.spatial.mruk

AnchorMeshScalingMode

UNIFORM_SCALING

UNIFORM_XZ_SCALING

AnchorMeshSelectionMode

AnchorMeshSpawner

AnchorMeshGroup

AnchorProcMeshInfo

AnchorProceduralMesh

MeshAndPhysicEntity

AnchorProceduralMeshConfig

AnchorSerializer

INVISIBLE_WALL_FACE

MRUKLoadDeviceResult

ERROR_INSUFFICIENT_RESOURCES

ERROR_INSUFFICIENT_VIEW

ERROR_NO_ROOMS_FOUND

ERROR_PERMISSION_INSUFFICIENT

ERROR_RATE_LIMITED

ERROR_STORAGE_AT_CAPACITY

ERROR_TOO_BRIGHT

MRUKSceneEventListener

CURRENT_ROOM_ONLY

MRUKWallTexCoordModeU

MAINTAIN_ASPECT_RATIO

MAINTAIN_ASPECT_RATIO_SEAMLESS

METRIC_SEAMLESS

MRUKWallTexCoordModeV

MAINTAIN_ASPECT_RATIO

PlaneBoundsData

Vector2Serializer

Vector3Serializer

VolumeBoundsData

com.meta.spatial.ovrmetrics

OVRMetricDefinition

OVRMetricsDataModel

OVRMetricsFeature

OVRMetricsGroup

OVRMetricsNetwork

OVRMetricsScene

OVRMetricsSystem

com.meta.spatial.physics

com.meta.spatial.runtime

MIRRORED_REPEAT

TRANSLUCENT_POST

SpaceComponentType

SpaceTriangleMesh

DESTINATION_ALPHA

ONE_MINUS_DESTINATION_ALPHA

ONE_MINUS_SOURCE_ALPHA

ButtonClickEventArgs

ButtonDownEventArgs

ButtonHoverEventArgs

ButtonHoverMoveEventArgs

ButtonReleaseEventArgs

ControllerButton

CylinderLayerConfig

GREATER_OR_EQUAL

EquirectLayerConfig

LayerAlphaBlend

LayerColorScaleBias

MaterialSidedness

Failure_DataIsInvalid

Failure_DeprecatedOperation

Failure_ErrorInitializationFailed

Failure_ErrorLimitReached

Failure_HandleInvalid

Failure_InsufficientSize

Failure_InvalidOperation

Failure_InvalidParameter

Failure_NotInitialized

Failure_NotYetImplemented

Failure_OperationFailed

Failure_RuntimeUnavailable

Failure_SpaceCloudStorageDisabled

Failure_SpaceComponentNotEnabled

Failure_SpaceComponentNotSupported

Failure_SpaceComponentStatusAlreadySet

Failure_SpaceComponentStatusPending

Failure_SpaceInsufficientResources

Failure_SpaceInsufficientView

Failure_SpaceLocalizationFailed

Failure_SpaceMappingInsufficient

Failure_SpaceNetworkRequestFailed

Failure_SpaceNetworkTimeout

Failure_SpacePermissionInsufficient

Failure_SpaceRateLimited

Failure_SpaceStorageAtCapacity

Failure_SpaceTooBright

Failure_SpaceTooDark

Failure_Unsupported

Success_EventUnavailable

Success_Pending

Warning_BoundaryVisibilitySuppressionNotAllowed

NativeResultException

NetworkedAssetLoader

PanelConfigOptions

PanelDimensionsOverrides

PanelSceneObject

PanelShapeConfig

PixelsPerDegree

PointerEventType

QuadLayerConfig

SceneAudioAsset

SceneAudioPlayer

SceneCylinderLayer

SceneEquirectLayer

SceneMaterialAttribute

SceneMaterialDataType

ScenePhysicsObject

com.meta.spatial.toolkit

AppSystemActivity

AppSystemCommon

AppSystemService

AvatarAttachment

AvatarBodyLoader

LEFT_HAND_INDEX_DISTAL

LEFT_HAND_INDEX_INTERMEDIATE

LEFT_HAND_INDEX_METACARPAL

LEFT_HAND_INDEX_PROXIMAL

LEFT_HAND_INDEX_TIP

LEFT_HAND_LITTLE_DISTAL

LEFT_HAND_LITTLE_INTERMEDIATE

LEFT_HAND_LITTLE_METACARPAL

LEFT_HAND_LITTLE_PROXIMAL

LEFT_HAND_LITTLE_TIP

LEFT_HAND_MIDDLE_DISTAL

LEFT_HAND_MIDDLE_INTERMEDIATE

LEFT_HAND_MIDDLE_METACARPAL

LEFT_HAND_MIDDLE_PROXIMAL

LEFT_HAND_MIDDLE_TIP

LEFT_HAND_RING_DISTAL

LEFT_HAND_RING_INTERMEDIATE

LEFT_HAND_RING_METACARPAL

LEFT_HAND_RING_PROXIMAL

LEFT_HAND_RING_TIP

LEFT_HAND_THUMB_DISTAL

LEFT_HAND_THUMB_METACARPAL

LEFT_HAND_THUMB_PROXIMAL

LEFT_HAND_THUMB_TIP

LEFT_HAND_WRIST

LEFT_HAND_WRIST_TWIST

RIGHT_ARM_LOWER

RIGHT_ARM_UPPER

RIGHT_HAND_INDEX_DISTAL

RIGHT_HAND_INDEX_INTERMEDIATE

RIGHT_HAND_INDEX_METACARPAL

RIGHT_HAND_INDEX_PROXIMAL

RIGHT_HAND_INDEX_TIP

RIGHT_HAND_LITTLE_DISTAL

RIGHT_HAND_LITTLE_INTERMEDIATE

RIGHT_HAND_LITTLE_METACARPAL

RIGHT_HAND_LITTLE_PROXIMAL

RIGHT_HAND_LITTLE_TIP

RIGHT_HAND_MIDDLE_DISTAL

RIGHT_HAND_MIDDLE_INTERMEDIATE

RIGHT_HAND_MIDDLE_METACARPAL

RIGHT_HAND_MIDDLE_PROXIMAL

RIGHT_HAND_MIDDLE_TIP

RIGHT_HAND_PALM

RIGHT_HAND_RING_DISTAL

RIGHT_HAND_RING_INTERMEDIATE

RIGHT_HAND_RING_METACARPAL

RIGHT_HAND_RING_PROXIMAL

RIGHT_HAND_RING_TIP

RIGHT_HAND_THUMB_DISTAL

RIGHT_HAND_THUMB_METACARPAL

RIGHT_HAND_THUMB_PROXIMAL

RIGHT_HAND_THUMB_TIP

RIGHT_HAND_WRIST

RIGHT_HAND_WRIST_TWIST

CreatorVisibility

CreatorVisibilityState

CREATOR_ONLY_INVISIBLE

CREATOR_ONLY_VISIBLE

CreatorVisibilitySystem

DeleteEntitiesSystem

FlatColorMaterials

FollowableSystem

GLTFTransformType

GLXFAttributeTypeReference

GLXFEntityDeletionSystem

GLXFInternalNode

GLXFManagerComponentUtils

GLXFNodeTransform

DELETE_AND_RECREATE_ENTITIES

KEEP_EXISTING_ENTITIES

GrabbableLoader

GrabbableSystem

LoadSceneLoader

LoadSceneSystem

LineTest_IgnoreVisible

MeshCreationSystem

MeshMaterialOverrides

MeshMaterialOverridesSystem

MineralMaterials

NetworkingTickSystem

OrganicMaterials

PanelClickState

PanelClickSystem

PanelCreationSystem

PanelDimensions

PanelDimensionsSystem

PanelRegistration

PlayerBodyAttachmentSystem

ProcessListenersSystem

ResetDataModelSystem

RunMainThreadWorkItemsSystem

SceneObjectSystem

ScenePlaneLoader

SceneUpdateTickTimeSystem

SceneVolumeLoader

SpatialActivityManager

SpatialJSONUtils

SpatialViewModel

SpatialViewModelOwner

SupportsLocomotion

SupportsLocomotionLoader

TickAnimationSystem

TickControllerSystem

TickDataModelSystem

TickTransformSystem

TransformBuilderRoot

TransformStepBuilder

TransformLoader

TransformParent

TransformParentLoader

com.meta.spatial.toolkit.inflate

com.meta.spatial.vr

DataModel

DataModel

class DataModel(val dataModel_: Long, val attributeCache_: AttributeCache)

Constructors

Name	Summary
DataModel	constructor(dataModel_: Long, attributeCache_: AttributeCache)

Types

Name	Summary
Companion	object Companion
KeyIterator	inner class KeyIterator(dm_: DataModel, it_: Long)

Properties

Name	Summary
attributeCache_	val attributeCache_: AttributeCache
dataModel_	val dataModel_: Long

Functions

Name	Summary
addToKeyValueMap	fun addToKeyValueMap(id: Long, attribute: Int, values: HashMap<, >)
allocateEntity	fun allocateEntity(): Long
attribute	fun attribute(attribute: Int): DataModel.KeyIterator
attributeChanged	fun attributeChanged(attribute: Int): DataModel.KeyIterator
createEntity	fun createEntity(): Entity Creates a new entity in the data model. fun createEntity(vararg components: ComponentBase): Entity fun createEntity(components: List<ComponentBase>): Entity Creates a new entity in the data model with components.
createUniqueEntity	fun createUniqueEntity(id: Long): Entity
deleted	fun deleted(): DataModel.KeyIterator
deleteEntity	fun deleteEntity(eid: Long)
destroy	fun destroy()
getAttributeValueAt	fun getAttributeValueAt(id: Long, attribute: Int, key: Any): Any?
getEventListenerForEvent	fun getEventListenerForEvent(eventType: String): Set<<Error class: unknown class><Entity, EventListener<EventArgs>>>
getHandle	fun getHandle(): Long
getKeyValueComponentData	fun getKeyValueComponentData(id: Long, componentData: MutableMap<Int, <Error class: unknown class><AttributeType, Any?>>, cachable: Boolean = false)
getKeyValueMap	inline fun <T, V> getKeyValueMap(id: Long, attribute: Int): HashMap<T, V>
hasKey	fun hasKey(id: Long, attribute: Int): Boolean
hasKeyDeprecated	fun hasKeyDeprecated(id: Long, attribute: Int): Boolean
isLocalEntity	fun isLocalEntity(ent: Long): Boolean
nativeGetKeyValueMap	external fun nativeGetKeyValueMap(dataModel: Long, id: Long, attribute: Int): Array<Any>
processListeners	fun processListeners()
queryAll	fun queryAll(any: IntArray, required: IntArray): LongArray
queryChanged	fun queryChanged(anyChanged: IntArray, required: IntArray): LongArray
queryDSL	fun queryDSL(code: IntArray): LongArray
registerAttributeListener	fun registerAttributeListener(attribute: Int, listener: AttributeListener)
registerComponentDependent	fun registerComponentDependent(changingComponent: Int, dependent: Int)
registerComponentListener	fun registerComponentListener(componentID: Int, componentClass: KClass<*>, listener: ComponentListener)
registerEventListener	fun registerEventListener(entity: Entity, eventType: String, listener: EventListener<EventArgs>)
removeComponentListener	fun removeComponentListener(componentID: Int)
removeKeyValue	fun removeKeyValue(id: Long, attribute: Int)
reset	fun reset()
sendEvent	fun sendEvent(entity: Entity, eventType: String, eventArgs: EventArgs)
setKeyValueComponentData	fun setKeyValueComponentData(id: Long, componentData: MutableMap<Int, <Error class: unknown class><AttributeType, Any?>>, componentID: Int)
setKeyValueMapValueAt	fun setKeyValueMapValueAt(id: Long, attribute: Int, key: Any, value: Any): Boolean
setKeyValueTuple	fun setKeyValueTuple(id: Long, attribute: Int, values: Array<Any>)
unflattenArrForJNI	inline fun <T, V> unflattenArrForJNI(arr: Array<Any>): HashMap<T, V>

Companion

object Companion

Functions

Name	Summary
create	fun create(): DataModel

Did you find this page helpful?