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

com.meta.spatial.core

Package-level declarations

Types

NameSummary
data class AttributeInfo(val type: RegisteredAttributeType, val name: String, val componentId: Int, val enumClass: Class<out Enum<*>>? = null)
data class AttributeInfoMap(val map: Map<Int, AttributeInfo> = mapOf(), val version: Int = 0)
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) : TypedAbstractAttribute<Boolean>
data class BooleanAttributeData(val id: Int)
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.
class ByBooleanFilterOperation(val attrId: Int, val filterBuilder: FilterBuilder)
class ByEntityAttributeFilterNode(val attrId: Int, val filterBuilder: FilterBuilder) : FilterNode
class ByEntityFilterOperation(val attrId: Int, val filterBuilder: FilterBuilder)
class ByEnumFilterOperation(val attrId: Int, val filterBuilder: FilterBuilder)
class ByFloatFilterNode(attrId: Int, val filterBuilder: FilterBuilder) : FilterNode
class ByFloatFilterOperation(val attrId: Int, val filterBuilder: FilterBuilder)
class ByIntFilterNode(attrId: Int, val filterBuilder: FilterBuilder) : FilterNode
class ByIntFilterOperation(val attrId: Int, val filterBuilder: FilterBuilder)
class ByLongFilterNode(attrId: Int, val filterBuilder: FilterBuilder) : FilterNode
class ByLongFilterOperation(val attrId: Int, val filterBuilder: FilterBuilder)
class ByMapFilterNode<KeyType, ValueType>(val attrId: Int, val filterBuilder: FilterBuilder) : FilterNode
class ByMapFilterOperation<KeyType, ValueType>(val attrId: Int, val filterBuilder: FilterBuilder)
class ByPoseFilterNode(attrId: Int, propId: Int, filterNodeType: FilterNodeType = FilterNodeType.FILTER, val filterBuilder: FilterBuilder) : FilterNode
class ByPoseFilterOperation(val attrId: Int, var propId: Int = 0, val filterBuilder: FilterBuilder)
class ByStringFilterNode(attrId: Int, val filterBuilder: FilterBuilder) : FilterNode
class ByStringFilterOperation(val attrId: Int, val filterBuilder: FilterBuilder)
class ByTimeAttributeFilterNode(val attrId: Int, val filterBuilder: FilterBuilder) : FilterNode
class ByTimeFilterOperation(val attrId: Int, val filterBuilder: FilterBuilder)
class ByUUIDFilterNode(attrId: Int, filterNodeType: FilterNodeType = FilterNodeType.FILTER, val filterBuilder: FilterBuilder) : FilterNode
class ByUUIDFilterOperation(val attrId: Int, val filterBuilder: FilterBuilder)
class ByVector2FilterNode(attrId: Int, propId: Int, filterNodeType: FilterNodeType = FilterNodeType.FILTER, val filterBuilder: FilterBuilder) : FilterNode
class ByVector2FilterOperation(val attrId: Int, var propId: Int = 0, val filterBuilder: FilterBuilder)
class ByVector3FilterNode(attrId: Int, propId: Int, filterNodeType: FilterNodeType = FilterNodeType.FILTER, val filterBuilder: FilterBuilder) : FilterNode
class ByVector3FilterOperation(val attrId: Int, var propId: Int = 0, val filterBuilder: FilterBuilder)
class ByVector4FilterNode(attrId: Int, propId: Int, filterNodeType: FilterNodeType = FilterNodeType.FILTER, val filterBuilder: FilterBuilder) : FilterNode
class ByVector4FilterOperation(val attrId: Int, var propId: Int = 0, val filterBuilder: FilterBuilder)
class Color3
Color3 is a class that represents a color in RGB space. It has three properties: red, green, and blue. These properties are floats that range from 0 to 1.
open class Color4
Color4 is a class that represents a color in RGBA space. It has four properties: red, green, blue, and alpha. These properties are floats that range from 0 to 1.
class Color4Attribute(keyString: String, key: Int, component: ComponentBase, initialValue: Color4) : TypedAbstractAttribute<Color4>
data class Color4AttributeData(val id: Int)
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, name: String)
class ComponentRegistration(val clazz: KClass<out ComponentBase>, val companionObjectInstance: ComponentCompanion, val sendRate: SendRate = SendRate.DEFAULT)
class DataModel(val dataModel_: Long)
annotation class DoNotStrip
annotation class DoNotStripAny
annotation class DoNotStripNative
class Entity
Represents an entity in the spatial data model.
class EntityAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: Entity) : TypedAbstractAttribute<Entity>
data class EntityAttributeData(val id: Int)
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) : TypedAbstractAttribute<T>
data class EnumAttributeData(val id: Int)
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) : AbstractAttribute
data class ExperimentalMapAttributeData<K, V>(val id: Int)
class FeatureManager(val features: List<SpatialFeature>)
class Filter
class FilterBuilder
A class used to build a filter tree.
class FilterFunctionInfo(val attrType: Int, val attrId: Int, var propId: Int = 0, var contId: Int = -1, var contValueIndex: Int = -1)
open class FilterNode(val type: FilterNodeType, val filterFunctionInfo: FilterFunctionInfo? = null, val filterBuilder: FilterBuilder)
A class representing a node in a filter tree.
enum FilterNodeType : Enum<FilterNodeType>
An enumeration representing the node type of a filter.
data class FilterValues(val ints: MutableList<Int>, val longs: MutableList<Long>, val floats: MutableList<Float>, val strings: MutableList<String>)
class FloatAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: Float) : TypedAbstractAttribute<Float>
data class FloatAttributeData(val id: Int)
class FloatSortCriterion(val attrId: Int) : SortCriterion
enum Hand : Enum<Hand>
class IntAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: Int) : TypedAbstractAttribute<Int>
data class IntAttributeData(val id: Int)
class IntSortCriterion(val attrId: Int) : SortCriterion
class IsLocalFilterNode(val filterBuilder: FilterBuilder) : FilterNode
class LongAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: Long) : TypedAbstractAttribute<Long>
data class LongAttributeData(val id: Int)
class LongSortCriterion(val attrId: Int) : SortCriterion
class Lut(val dimension: Int = 16)
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
open 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) : TypedAbstractAttribute<Pose>
data class PoseAttributeData(val id: Int)
class PoseSortCriterion(val attrId: Int) : SortCriterion
class PoseVector3(value: Vector3) : Vector3
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>
open 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
class StringAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: String) : TypedAbstractAttribute<String>
data class StringAttributeData(val id: Int)
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) : TypedAbstractAttribute<Long>
data class TimeAttributeData(val id: Int)
class TimeSortCriterion(val attrId: Int) : SortCriterion
object TraceUtils
abstract class TypedAbstractAttribute<T>(keyString: String, key: Int, component: ComponentBase) : AbstractAttribute
class URIAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: <Error class: unknown class>) : TypedAbstractAttribute<<Error class: unknown class>>
data class URIAttributeData(val id: Int)
class UUIDAttribute(keyString: String, key: Int, component: ComponentBase, initialValue: UUID) : TypedAbstractAttribute<UUID>
data class UUIDAttributeData(val id: Int)
open 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) : TypedAbstractAttribute<Vector2>
data class Vector2AttributeData(val id: Int)
class Vector2SortCriterion(val attrId: Int) : SortCriterion
open 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) : TypedAbstractAttribute<Vector3>
data class Vector3AttributeData(val id: Int)
class Vector3SortCriterion(val attrId: Int) : SortCriterion
open 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) : TypedAbstractAttribute<Vector4>
data class Vector4AttributeData(val id: Int)
class Vector4SortCriterion(val attrId: Int) : SortCriterion
class WatchedColor4(attribute: Color4Attribute, value: Color4) : Color4
class WatchedPose(attribute: PoseAttribute, vt: Vector3, vq: Quaternion) : Pose
class WatchedVector2(attribute: Vector2Attribute, value: Vector2) : Vector2
class WatchedVector3(attribute: Vector3Attribute, value: Vector3) : Vector3
class WatchedVector4(attribute: Vector4Attribute, value: Vector4) : Vector4

Properties

NameSummary
CB_EnableCaching
var CB_EnableCaching: Boolean
CP_Stats_ComponentBorrowFailedDirty
var CP_Stats_ComponentBorrowFailedDirty: <Error class: unknown class>
CP_Stats_ComponentBorrowFailedNotCachable
var CP_Stats_ComponentBorrowFailedNotCachable: <Error class: unknown class>
CP_Stats_ComponentBorrowFailedRecycled
var CP_Stats_ComponentBorrowFailedRecycled: <Error class: unknown class>
CP_Stats_ComponentBorrows
var CP_Stats_ComponentBorrows: <Error class: unknown class>
CP_Stats_ComponentCreates
var CP_Stats_ComponentCreates: <Error class: unknown class>
DM_Stats_ComponentCacheChecks
var DM_Stats_ComponentCacheChecks: <Error class: unknown class>
DM_Stats_ComponentCacheSuccess
var DM_Stats_ComponentCacheSuccess: <Error class: unknown class>
DM_Stats_ComponentGets
var DM_Stats_ComponentGets: <Error class: unknown class>

Functions

NameSummary
getSortCriterionCode
fun getSortCriterionCode(criterion: SortCriterion): Int
recycler
fun <T> recycler(func: (ComponentRecyler) -> T): T
Did you find this page helpful?
Thumbs up icon
Thumbs down icon