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

Mesh

Mesh

class Mesh(meshInternal: String = "", hittable: MeshCollision = MeshCollision.LineTest, defaultShaderOverride: String = "", defaultSceneOverride: Int = 0) : ComponentBase
Mesh component, used to specify a mesh to be rendered. This component is used to specify the mesh uri, hittable, default shader override, and default scene override.
Parameters
JVM
NameSummary
mesh
: Uri of the mesh to be rendered
hittable
: MeshCollision type, used to determine how a mesh is hit tested
defaultShaderOverride
: String of the default shader to be used for the mesh
defaultSceneOverride
: Int of the default scene to be used for the mesh

Constructors

NameSummary
Mesh
constructor(meshInternal: String = "", hittable: MeshCollision = MeshCollision.LineTest, defaultShaderOverride: String = "", defaultSceneOverride: Int = 0)

Types

NameSummary
Companion
object Companion : ComponentCompanion

Properties

NameSummary
cachable
open val cachable: Boolean
defaultSceneOverride
var defaultSceneOverride: Int
Int of the default scene to be used for the mesh
defaultShaderOverride
var defaultShaderOverride: String
String of the default shader to be used for the mesh
entID
var entID: Long
hittable
var hittable: MeshCollision
The type of behavior the object can be hit using.
isDirty
var isDirty: Boolean
mesh
var mesh: <Error class: unknown class>
: Uri of the mesh to be rendered
meshInternal
var meshInternal: String
Uri of the mesh to be rendered
recycled
var recycled: Boolean
timeStamp
var timeStamp: Long

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: () -> Mesh
defaultSceneOverrideData
val defaultSceneOverrideData: IntAttributeData
defaultSceneOverrideId
val defaultSceneOverrideId: <Error class: unknown class>
defaultShaderOverrideData
val defaultShaderOverrideData: StringAttributeData
defaultShaderOverrideId
val defaultShaderOverrideId: <Error class: unknown class>
enumClassesMap_
val enumClassesMap_: Map<Int, Class<out Enum<*>>>
hittableData
val hittableData: EnumAttributeData
hittableId
val hittableId: <Error class: unknown class>
id
open override val id: <Error class: unknown class>
keyStringToKeyIntMap_
val keyStringToKeyIntMap_: Map<String, Int>
meshInternalData
val meshInternalData: StringAttributeData
meshInternalId
val meshInternalId: <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