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

AttributePrimitive

BooleanAttribute

ComponentCompanion

ComponentListener

ComponentManager

ComponentRegistration

EntityAttribute

EntitySortCriterion

ExperimentalMapAttribute

FloatSortCriterion

IntSortCriterion

LongSortCriterion

MissingSystemInfo

MissingSystemsGraph

PoseSortCriterion

PriorityGroupMap

QueryEventListenerManager

RegisteredAttributeType

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

MRUKAnchorTexCoordMode

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

MRUKNativeResult

ErrorDiscoveryOngoing

ErrorInvalidArgs

ErrorInvalidJson

ErrorNoRoomsFound

ErrorSpaceInsufficientResources

ErrorSpaceInsufficientView

ErrorSpacePermissionInsufficient

ErrorSpaceRateLimited

ErrorSpaceStorageAtCapacity

ErrorSpaceTooBright

ErrorSpaceTooDark

MRUKNativeResultException

MRUKSceneEventListener

CURRENT_ROOM_ONLY

MRUKWallTexCoordModeU

MAINTAIN_ASPECT_RATIO

MAINTAIN_ASPECT_RATIO_SEAMLESS

METRIC_SEAMLESS

STRETCH_SECTION

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

Grabbable

Grabbable

class Grabbable(enabled: Boolean = true, type: GrabbableType = GrabbableType.FACE, isGrabbed: Boolean = false, minHeight: Float = -Float.MAX_VALUE, maxHeight: Float = Float.MAX_VALUE) : ComponentBase

Grabbable is a component that allows an object to be grabbed by a controller. It requires the Mesh Component to be present.

Parameters

JVM

Name	Summary
enabled	Defines whether the object can be grabbed or not.
type	The type of behavior an object has when grabbed (faces user, pivots on y axis, etc.)
isGrabbed	Whether the object is currently grabbed or not
minHeight	the minimum height an object can be held when grabbed
maxHeight	the maximum height an object can be held when grabbed

Constructors

Name	Summary
Grabbable	constructor(enabled: Boolean = true, type: GrabbableType = GrabbableType.FACE, isGrabbed: Boolean = false, minHeight: Float = -Float.MAX_VALUE, maxHeight: Float = Float.MAX_VALUE)

Types

Name	Summary
Companion	object Companion : ComponentCompanion

Properties

Name	Summary
cachable	open val cachable: Boolean = false
creationTime	var creationTime: Long
enabled	var enabled: Boolean Defines whether the object can be grabbed or not.
isDirty	var isDirty: Boolean
isGrabbed	var isGrabbed: Boolean Whether the object is currently grabbed or not
maxHeight	var maxHeight: Float the maximum height an object can be held when grabbed
minHeight	var minHeight: Float the minimum height an object can be held when grabbed
recycled	var recycled: Boolean
type	var type: GrabbableType The type of behavior an object has when grabbed (faces user, pivots on y axis, etc.)

Functions

Name	Summary
getComponentDataAttributeType	fun getComponentDataAttributeType(key: Int): AttributePrimitive? fun getComponentDataAttributeType(keyString: String): AttributePrimitive?
getComponentDataKey	fun getComponentDataKey(key: String): Int?
getComponentDataValue	fun getComponentDataValue(key: Int): Any? fun getComponentDataValue(keyString: String): Any?
getEnumClass	fun getEnumClass(key: String): Class<out Enum<*>>?
hasComponentData	fun hasComponentData(key: Int): Boolean fun hasComponentData(keyString: String): Boolean
read	fun read(e: Entity, cachable: Boolean)
recycle	fun recycle()
reset	open fun reset()
setComponentDataValue	fun setComponentDataValue(key: Int, value: Any?): Boolean fun setComponentDataValue(keyString: String, value: Any?): Boolean
setPool	fun setPool(pool: ComponentPool<*>)
toString	open override fun toString(): String
typeID	open override fun typeID(): Int
write	fun write(e: Entity)

Companion

object Companion : ComponentCompanion

Properties

Name	Summary
createDefaultInstance	open override val createDefaultInstance: () -> Grabbable
id	open override val id: <Error class: unknown class>

Functions

Name	Summary
dependents	open fun dependents(): IntArray

Did you find this page helpful?