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

SceneVolume

SceneVolume

class SceneVolume(name: String = "", type: String = "", offset: Vector3 = Vector3(0.0f), extents: Vector3 = Vector3(0.0f)) : ComponentBase
A SceneVolume is a 3D volume that can be used to represent a physical object in the scene.
Parameters
JVM
NameSummary
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

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

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

NameSummary
cachable
val cachable: Boolean = false
creationTime
var creationTime: Long
extents
var extents: Vector3
isDirty
var isDirty: Boolean
name
var name: String
offset
var offset: Vector3
recycled
var recycled: Boolean
type
var type: String

Functions

NameSummary
getComponentDataAttributeType
fun getComponentDataAttributeType(key: Int): AttributeType?
fun getComponentDataAttributeType(keyString: String): AttributeType?
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

NameSummary
createDefaultInstance
open override val createDefaultInstance: () -> SceneVolume
id
open override val id: <Error class: unknown class>

Functions

NameSummary
dependents
open fun dependents(): IntArray
Did you find this page helpful?
Thumbs up icon
Thumbs down icon