API reference

Select your platform

No SDKs available

No versions available

Overview

com.meta.spatial.animation

Overview

PanelAnimationFeature

PanelAnimationSystem

PanelQuadCylinderAnimationStatus

PanelQuadCylinderAnimator

PanelQuadCylinderLocalState

PanelScaleInAnimator

PanelScaleInLocalState

PanelScaleOutAnimator

PanelScaleOutLocalState

com.meta.spatial.castinputforward

Overview

CastInputForwardFeature

CastInputForwardSystem

SimpleInputForwardHandler

com.meta.spatial.compose

Overview

ComposeFeature

PanelViewLifecycleOwner

com.meta.spatial.core

ByBooleanFilterOperation

ByEntityAttributeFilterNode

ByEntityFilterOperation

ByEnumFilterOperation

ByFloatFilterNode

ByFloatFilterOperation

ByIntFilterNode

ByIntFilterOperation

ByLongFilterNode

ByLongFilterOperation

ByMapFilterNode

ByMapFilterOperation

ByPoseFilterNode

ByPoseFilterOperation

ByStringFilterNode

ByStringFilterOperation

ByTimeAttributeFilterNode

ByTimeFilterOperation

ByUUIDFilterNode

ByUUIDFilterOperation

ByVector2FilterNode

ByVector2FilterOperation

ByVector3FilterNode

ByVector3FilterOperation

ByVector4FilterNode

ByVector4FilterOperation

ComponentRegistration

ExperimentalMapAttribute

ExperimentalMapAttributeData

DESC_CASE_INSENSITIVE

SystemDependencyConfig

TypedAbstractAttribute

com.meta.spatial.datamodelinspector

Overview

DataModelInspectorFeature

TickDataModelInspectorSystem

com.meta.spatial.debugtools

Overview

AssetReloadSystem

HotReloadFeature

RecursiveFileObserver

com.meta.spatial.isdk

com.meta.spatial.mruk

Overview

AnchorData

AnchorMeshScalingMode

AnchorMeshSelectionMode

AnchorProceduralMeshConfig

AnchorSerializer

GlobalMeshData

MRUKAnchorTexCoordMode

ERROR_INSUFFICIENT_RESOURCES

ERROR_INSUFFICIENT_VIEW

ERROR_NO_ROOMS_FOUND

ERROR_PERMISSION_INSUFFICIENT

ERROR_RATE_LIMITED

ERROR_STORAGE_AT_CAPACITY

ErrorDiscoveryOngoing

ErrorSpaceInsufficientResources

ErrorSpaceInsufficientView

ErrorSpacePermissionInsufficient

ErrorSpaceRateLimited

ErrorSpaceStorageAtCapacity

MRUKNativeResultException

MRUKPlaneUV

MRUKRoom

MRUKSceneEventListener

MRUKStartTrackerResult

MRUKWallTexCoordModeU

Overview

MAINTAIN_ASPECT_RATIO

MAINTAIN_ASPECT_RATIO_SEAMLESS

MRUKWallTexCoordModeV

Overview

MAINTAIN_ASPECT_RATIO

com.meta.spatial.ovrmetrics

com.meta.spatial.physics

com.meta.spatial.runtime

ONE_MINUS_DESTINATION_ALPHA

ONE_MINUS_SOURCE_ALPHA

ButtonHoverMoveEventArgs

ButtonReleaseEventArgs

SceneMaterialAttribute

SceneMaterialDataType

com.meta.spatial.runtime.panel

com.meta.spatial.toolkit

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_PALM

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_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

CreatorVisibilityState

Overview

CREATOR_ONLY_INVISIBLE

GLXFEntityDeletionSystem

DELETE_AND_RECREATE_ENTITIES

KEEP_EXISTING_ENTITIES

LineTest_IgnoreVisible

PanelDimensionsSystem

PlayerBodyAttachmentSystem

ProcessListenersSystem

SceneUpdateTickTimeSystem

SpatialActivityManager

com.meta.spatial.toolkit.inflate

Hittable

class Hittable(hittable: MeshCollision = MeshCollision.LineTest) : ComponentBase

Defines whether an Entity is hittable. If an Entity is hittable then raycasts from controllers/hands will intersect with the com.meta.spatial.runtime.SceneObject and trigger com.meta.spatial.runtime.InputListeners. If Entity is using the Mesh or Panel components the Mesh.hittable or Panel.hittable attribute should be used instead. This component is used for the advanced case when a com.meta.spatial.runtime.SceneObject is manually assigned to an Entity.

Constructors

Name	Summary
Hittable	constructor(hittable: MeshCollision = MeshCollision.LineTest)

Types

Name	Summary
Companion	object Companion : ComponentCompanion

Properties

Name	Summary
cachable	open override var cachable: <Error class: unknown class>
entID	var entID: Long
hittable	var hittable: MeshCollision The type of behavior the object can be hit using.
isDirty	var isDirty: Boolean
recycled	var recycled: Boolean
timeStamp	var timeStamp: Long

Functions

Name	Summary
companion	open override fun companion(): ComponentCompanion Gets the companion object for this component.
getComponentDataAttributeType	fun getComponentDataAttributeType(key: Int): AttributePrimitive? Gets the attribute type for the specified key. fun getComponentDataAttributeType(keyString: String): AttributePrimitive? Gets the attribute type for the specified string key.
getComponentDataKey	fun getComponentDataKey(key: String): Int? Gets the integer key associated with the specified string key.
getComponentDataValue	fun getComponentDataValue(key: Int): Any? Gets the value for the specified key. fun getComponentDataValue(keyString: String): Any? Gets the value for the specified string key.
getEnumClass	fun getEnumClass(key: String): Class<out Enum<*>>? Gets the enum class associated with the specified string key.
hasComponentData	fun hasComponentData(key: Int): Boolean Checks if this component has data for the specified key. fun hasComponentData(keyString: String): Boolean Checks if this component has data for the specified string key.
read	fun read(e: Entity, cachable: Boolean) Reads component data from the specified entity.
recycle	fun recycle() Recycles this component by returning it to its pool.
reset	open fun reset() Resets the component to its default state.
setComponentDataValue	fun setComponentDataValue(key: Int, value: Any): Boolean Sets the value for the specified key. fun setComponentDataValue(keyString: String, value: Any): Boolean Sets the value for the specified string key.
setPool	fun setPool(pool: ComponentPool<*>, entID: Long) Sets the component pool and entity ID for this component.
toString	open override fun toString(): String
typeID	open override fun typeID(): Int Returns the unique type ID of this component.
write	fun write(e: Entity) Writes this component’s data to the specified entity.

Companion

object Companion : ComponentCompanion

Properties

Name	Summary
attributeKeys_	val attributeKeys_: IntArray
attributeTypeCounts_	val attributeTypeCounts_: IntArray
attributeTypes_	val attributeTypes_: IntArray
attrMetaData_	val attrMetaData_: Map<Int, <Error class: unknown class><RegisteredAttributeType, String>>
createDefaultInstance	open override val createDefaultInstance: () -> Hittable
enumClassesMap_	val enumClassesMap_: Map<Int, Class<out Enum<*>>>
hittableData	val hittableData: EnumAttributeData
hittableId	val hittableId: <Error class: unknown class>
id	open override val id: <Error class: unknown class>
keyStringToKeyIntMap_	val keyStringToKeyIntMap_: Map<String, Int>

Functions

Name	Summary
attributeKeys	open override fun attributeKeys(): IntArray
attributeMetaData	open override fun attributeMetaData(): Map<Int, <Error class: unknown class><RegisteredAttributeType, String>>
attributeTypeCountAvailable	open override fun attributeTypeCountAvailable(): Boolean
attributeTypeCounts	open override fun attributeTypeCounts(): IntArray
attributeTypes	open override fun attributeTypes(): IntArray
dependents	open fun dependents(): IntArray
enumClassesMap	open override fun enumClassesMap(): Map<Int, Class<out Enum<*>>>
keyStringToKeyIntMap	open override fun keyStringToKeyIntMap(keyString: String): Int?