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

ScenePlane

ScenePlane

class ScenePlane(name: String = "", type: String = "", offset: Vector3 = Vector3(0.0f, 0.0f, 0.0f), extents: Vector3 = Vector3(0.0f, 0.0f, 0.0f)) : ComponentBase
A ScenePlane is a 2D plane in the scene. It has a name, type, offset, and extents.
Parameters
JVM
NameSummary
name
The name of the plane.
type
The type of the plane.
offset
The offset of the plane.
extents
The extents of the plane.

Constructors

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

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

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

Functions

NameSummary
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

NameSummary
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: () -> ScenePlane
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

NameSummary
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?
Did you find this page helpful?
Thumbs up icon
Thumbs down icon