class SceneVolume(name: String = "", type: String = "", offset: Vector3 = Vector3(0.0f, 0.0f, 0.0f), extents: Vector3 = Vector3(0.0f, 0.0f, 0.0f)) : ComponentBase

A SceneVolume is a 3D volume that can be used to represent a physical object in the scene.

Parameters

JVM

Name	Summary
name	The name of the volume, identifier for the volume.
type	The type of the volume, it will be used to determine a Anchor is belong to the volume or not.
offset	The offset of the volume, all the Entity belongs to the volume will be offset by this value.
extents	The extents of the volume

Constructors

Name	Summary
SceneVolume	constructor(name: String = "", type: String = "", offset: Vector3 = Vector3(0.0f, 0.0f, 0.0f), extents: Vector3 = Vector3(0.0f, 0.0f, 0.0f))

Types

Name	Summary
Companion	object Companion : ComponentCompanion

Properties

Name	Summary
cachable	open val cachable: Boolean
entID	var entID: Long
extents	var extents: Vector3 The extents of the volume.
isDirty	var isDirty: Boolean
name	var name: String The name of the volume
offset	var offset: Vector3 The offset of the volume.
recycled	var recycled: Boolean
timeStamp	var timeStamp: Long
type	var type: String The type of the volume

Functions

Name	Summary
companion	open override fun companion(): ComponentCompanion
companionUnsafe	open override fun companionUnsafe(): ComponentCompanion?
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<*>, entID: Long)
toString	open override fun toString(): String
typeID	open override fun typeID(): Int
write	fun write(e: 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: () -> SceneVolume
enumClassesMap_	val enumClassesMap_: Map<Int, Class<out Enum<*>>>
extentsData	val extentsData: Vector3AttributeData
extentsId	val extentsId: <Error class: unknown class>
id	open override val id: <Error class: unknown class>
keyStringToKeyIntMap_	val keyStringToKeyIntMap_: Map<String, Int>
nameData	val nameData: StringAttributeData
nameId	val nameId: <Error class: unknown class>
offsetData	val offsetData: Vector3AttributeData
offsetId	val offsetId: <Error class: unknown class>
typeData	val typeData: StringAttributeData
typeId	val typeId: <Error class: unknown class>

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?