API reference
API reference
Select your platform
No SDKs available
No versions available

com.meta.spatial.core

Package-level declarations

Types

NameSummary
abstract class AbstractAttribute<T>(keyString: String, key: Int, component: ComponentBase, initialValue: T?)
class AttributeCache(backingByteBufferDONOTLEAK: ByteBuffer)
data class AttributeInfo(val type: RegisteredAttributeType, val name: String, val componentId: Int, val enumClass: Class<out Enum<*>>? = null)
typealias AttributeListener = (entity: Entity, dataModel: DataModel, attribute: Int, packet: Any?) -> Unit
enum AttributePrimitive : Enum<AttributePrimitive>
Enum class representing different types of attribute implementations in the native layer.
class BooleanAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: Boolean? = null) : AbstractAttribute<Boolean?>
data class Bound2D(var min: Vector2 = Vector2(0f, 0f), var max: Vector2 = Vector2(0f, 0f))
A data class representing a 2D bounding box.
data class Bound3D(var min: Vector3 = Vector3(0f, 0f, 0f), var max: Vector3 = Vector3(0f, 0f, 0f))
Represents a 3D bounding box with minimum and maximum coordinates.
abstract class ComponentBase
class ComponentInfo(val pool: ComponentPool<*>, val name: String, val typeID: Int)
typealias ComponentListener = (entity: Entity, dataModel: DataModel, componentID: Int, component: ComponentBase, packet: Any?) -> Unit
class ComponentPool<T : ComponentBase>(producer: () -> T)
class ComponentRegistration(val clazz: KClass<out ComponentBase>, val companionObjectInstance: ComponentCompanion, val sendRate: SendRate = SendRate.DEFAULT)
class DataModel(val dataModel_: Long, val attributeCache_: AttributeCache)
class Entity
Represents an entity in the spatial data model.
class EntityAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: Entity? = null) : AbstractAttribute<Entity?>
interface EntityIterator : Iterator<Entity> , Closeable
class EntitySortCriterion(val attrId: Int) : SortCriterion
class EnumAttribute<T : Enum<T>>(keyString: String, key: Int, component: ComponentBase, enumClass: Class<T>, initialValue: T) : AbstractAttribute<T>
open class EventArgs(val eventName: String, val dataModel: DataModel, var handled: Boolean = false, var throttleTime: Int? = null)
typealias EventListener<T> = (entity: Entity, args: T) -> Unit
class ExperimentalMapAttribute<KeyT, ValT>(keyString: String, key: Int, component: ComponentBase)
class FeatureManager(val features: List<SpatialFeature>)
class FloatAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: Float? = null) : AbstractAttribute<Float?>
class FloatSortCriterion(val attrId: Int) : SortCriterion
enum Hand : Enum<Hand>
class IntAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: Int? = null) : AbstractAttribute<Int?>
class IntSortCriterion(val attrId: Int) : SortCriterion
class LongAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: Long? = null) : AbstractAttribute<Long?>
class LongSortCriterion(val attrId: Int) : SortCriterion
class Lut(val dimension: Int = 16)
class MapDelegate<KeyT, ValT>(key: Int, component: ComponentBase)
data class Matrix44(var m00: Float, var m01: Float, var m02: Float, var m03: Float, var m10: Float, var m11: Float, var m12: Float, var m13: Float, var m20: Float, var m21: Float, var m22: Float, var m23: Float, var m30: Float, var m31: Float, var m32: Float, var m33: Float)
A 4x4 matrix class for representing transformations in 3D space.
data class MissingSystemInfo(var missingEdges: SystemSet, var isRequired: Boolean)
interface NetworkingBase
data class Pose(var t: Vector3 = Vector3(0f, 0f, 0f), var q: Quaternion = Quaternion(1.0f, 0f, 0f, 0f))
Represents a pose in 3D space, which includes a position and an orientation.
class PoseAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: Pose? = null) : AbstractAttribute<Pose?>
class PoseSortCriterion(val attrId: Int) : SortCriterion
enum PriorityGroup : Enum<PriorityGroup>
This enum represents the priority group a system belongs to. Systems will run in order of their priority groups, then within each group they will be sorted by their dependencies. Nothing runs between each priority group. mustRunBefore of a system must be run in either the same priority group or an earlier one mustRunAfter of a system must be run in either the same priority group or a later one
typealias PriorityGroupMap = MutableMap<SystemClass, PriorityGroup>
data class Quaternion(var w: Float = 1.0f, var x: Float = 0.0f, var y: Float = 0.0f, var z: Float = 0.0f)
Quaternion class for representing 3D rotations.
class Query
A class representing a query.
class QueryBuilder
A class used to build a query tree.
class QueryEventListenerManager<T : EventArgs>(val query: Query, val eventName: String, val listener: (entity: Entity, eventArgs: T) -> Unit)
class QueryNode(val type: QueryNodeType, val args: Array<Int>?, val queryBuilder: QueryBuilder)
A class representing a node in a query tree.
enum QueryNodeType : Enum<QueryNodeType>
An enumeration representing the node type of a query.
enum QueryType : Enum<QueryType>
enum RegisteredAttributeType : Enum<RegisteredAttributeType>
Enum class representing Attribute Types matching the registration functions found in ComponentBase.
enum SendRate : Enum<SendRate>
abstract class SortCriterion(val attrId: Int, var propCode: Int = 0, var sortOption: Int = 0)
enum SortOption : Enum<SortOption>
class SpatialContext(ctx: <Error class: unknown class>, val spatial: SpatialInterface)
interface SpatialFeature
Interface for a spatial feature.
open class SpatialInterface
annotation class SpatialSDKExperimentalAPI
class StringAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: String? = null) : AbstractAttribute<String?>
class StringSortCriterion(val attrId: Int) : SortCriterion
abstract class SystemBase
Base class for all systems in the spatial SDK.
typealias SystemClass = KClass<out SystemBase>
typealias SystemClassSet = MutableSet<SystemClass>
class SystemDAG
data class SystemDependencies(val mustRunBefore: MutableSet<SystemDependencyConfig>? = null, val mustRunAfter: MutableSet<SystemDependencyConfig>? = null)
Represents a collection of system dependencies.
typealias SystemDependenciesExists = Int
data class SystemDependencyConfig(val clazz: KClass<out SystemBase>, val isRequired: Boolean = true)
Represents a configuration for a system dependency.
typealias SystemGraph = MutableMap<SystemClass, SystemSet>
typealias SystemMap = MutableMap<SystemClass, SystemBase>
typealias SystemSet = MutableSet<SystemDependencyConfig>
class TimeAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: Long? = null) : AbstractAttribute<Long?>
class TimeSortCriterion(val attrId: Int) : SortCriterion
object TraceUtils
class UUIDAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: UUID? = null) : AbstractAttribute<UUID?>
data class Vector2(var x: Float = 0.0f, var y: Float = 0.0f)
Represents a 2D vector with x and y components.
class Vector2Attribute(keyString: String, key: Int, component: ComponentBase, initialValue: Vector2? = null) : AbstractAttribute<Vector2?>
class Vector2SortCriterion(val attrId: Int) : SortCriterion
data class Vector3(var x: Float, var y: Float, var z: Float)
A 3D vector class.
class Vector3Attribute(keyString: String, key: Int, component: ComponentBase, initialValue: Vector3? = null) : AbstractAttribute<Vector3?>
class Vector3SortCriterion(val attrId: Int) : SortCriterion
data class Vector4(var x: Float, var y: Float, var z: Float, var w: Float)
A 4D vector class with x, y, z, and w components.
class Vector4Attribute(keyString: String, key: Int, component: ComponentBase, initialValue: Vector4? = null) : AbstractAttribute<Vector4?>
class Vector4SortCriterion(val attrId: Int) : SortCriterion

Functions

NameSummary
getSortCriterionCode
fun getSortCriterionCode(criterion: SortCriterion): Int
Did you find this page helpful?
Thumbs up icon
Thumbs down icon