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

Box

Box

class Box : ComponentBase
Defines the dimensions of a box shape by the relative offset of two opposite corners. A box of max=Vector3(1,1,1) and min=Vector3(-1,-1,-1) will result in a 2x2x2 box. This is to be used with the mesh://boxMesh URI.

Constructors

NameSummary
Box
constructor()constructor(edgeLength: Float)
Creates a cube with a given edge length.
constructor(size: Vector3)
Creates a box with a given size in each dimension.
constructor(min: Vector3, max: Vector3)
Creates a box with a given min and max.

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

NameSummary
cachable
val cachable: Boolean = false
creationTime
var creationTime: Long
isDirty
var isDirty: Boolean
max
var max: Vector3
The relative offset of the top corner (furthest in the +x, +y, +z direction) of the box from the center
min
var min: Vector3
The relative offset of the bottom corner (furthest in the -x, -y, -z direction) of the box from the center
recycled
var recycled: Boolean

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: () -> Box
id
open override val id: <Error class: unknown class>

Functions

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