RoyInterface / Exports / resource/mesh/RoyMesh / RoyMesh

Class: RoyMesh

resource/mesh/RoyMesh.RoyMesh

Implements

• RoyTransDataObject

Table of contents

Constructors

• constructor

Properties

• cacheAABB
• cacheVec
• CLASS_NAME
• s_handleID
• m_handleID
• m_refComponentCount
• m_refComponentMap
• m_name
• m_attributeList
• m_elementTypeList
• m_strideList
• m_provider
• m_vtxCount
• m_indexCount
• m_indexBufferDataType
• m_axisAlignBoundBox
• m_vertexDataDirty
• m_vertexBuffer
• m_indexDataDirty
• m_indexBuffer
• m_userData
• m_transDataInfo
• m_canTransfer

Accessors

• handleID
• name
• attributeList
• elementTypeList
• strideList
• provider
• vtxCount
• indexCount
• indexBufferDataType
• axisAlignBoundBox
• vertexBuffer
• indexBuffer
• transDataInfo
• canTransfer

Methods

• createInstance
• destroyInstance
• setUserData
• getUserData
• deleteUserData
• markTransDataDirty
• markCanTransfer
• isInUse
• addRefComponent
• removeRefComponent
• isReady
• setVertexBufferAttribute
• getVertexBufferData
• getVertexBufferType
• getVertexBufferStride
• getIndexBufferData
• setAxisAlignBoundBox
• syncToBuffer
• isRaycastAvailable
• getAttributeIndex
• reset
• resetVertexBufferAttribute
• resetIndexBufferAttribute
• createAsWireframeMesh
• prepareWireframeMesh
• removeRelObjectFromMap
• collectTransData
• serializeTransData
• deserializeTransData

Constructors

constructor

• new RoyMesh(transDataInfo?): RoyMesh

Parameters

Name	Type
transDataInfo?	RoyTransDataInfo

Returns

RoyMesh

Properties

cacheAABB

▪ Static Protected cacheAABB: AABB

---

cacheVec

▪ Static Protected cacheVec: Vec3

---

CLASS_NAME

▪ Static CLASS_NAME: string = 'RoyMesh'

---

s_handleID

▪ Static Protected s_handleID: number = 0

---

m_handleID

• Protected m_handleID: number = 0

---

m_refComponentCount

• Protected m_refComponentCount: number = 0

---

m_refComponentMap

• Protected m_refComponentMap: Map<number, RoyComponent>

---

m_name

• Private m_name: string

---

m_attributeList

• Protected m_attributeList: VertexAttribute[]

---

m_elementTypeList

• Protected m_elementTypeList: VertexBuffer$AttributeType[]

---

m_strideList

• Protected m_strideList: number[]

---

m_provider

• Protected m_provider: RoyMeshProvider = null

---

m_vtxCount

• Protected m_vtxCount: number = 0

---

m_indexCount

• Protected m_indexCount: number = 0

---

m_indexBufferDataType

• Protected m_indexBufferDataType: IndexBuffer$IndexType = IndexBuffer$IndexType.UINT

---

m_axisAlignBoundBox

• Protected m_axisAlignBoundBox: AABB

---

m_vertexDataDirty

• Private m_vertexDataDirty: boolean = false

---

m_vertexBuffer

• Protected m_vertexBuffer: RoyVertexBuffer

---

m_indexDataDirty

• Private m_indexDataDirty: boolean = false

---

m_indexBuffer

• Protected m_indexBuffer: RoyIndexBuffer

---

m_userData

• Private m_userData: object = {}

---

m_transDataInfo

• Protected m_transDataInfo: RoyTransDataInfo

---

m_canTransfer

• Protected m_canTransfer: boolean = true

Accessors

handleID

• get handleID(): number

Returns

number

• set handleID(value): void

Parameters

Name	Type
value	number

Returns

void

---

name

• get name(): string

Returns

string

• set name(value): void

Parameters

Name	Type
value	string

Returns

void

---

attributeList

• get attributeList(): VertexAttribute[]

Returns

VertexAttribute[]

---

elementTypeList

• get elementTypeList(): VertexBuffer$AttributeType[]

Returns

VertexBuffer$AttributeType[]

---

strideList

• get strideList(): number[]

Returns

number[]

---

provider

• get provider(): RoyMeshProvider

Returns

RoyMeshProvider

• set provider(value): void

Parameters

Name	Type
value	RoyMeshProvider

Returns

void

---

vtxCount

• get vtxCount(): number

Returns

number

• set vtxCount(value): void

Parameters

Name	Type
value	number

Returns

void

---

indexCount

• get indexCount(): number

Returns

number

• set indexCount(value): void

Parameters

Name	Type
value	number

Returns

void

---

indexBufferDataType

• get indexBufferDataType(): IndexBuffer$IndexType

Returns

IndexBuffer$IndexType

• set indexBufferDataType(value): void

Parameters

Name	Type
value	IndexBuffer$IndexType

Returns

void

---

axisAlignBoundBox

• get axisAlignBoundBox(): AABB

Returns

AABB

---

vertexBuffer

• get vertexBuffer(): RoyVertexBuffer

Returns

RoyVertexBuffer

---

indexBuffer

• get indexBuffer(): RoyIndexBuffer

Returns

RoyIndexBuffer

---

transDataInfo

• get transDataInfo(): RoyTransDataInfo

Returns

RoyTransDataInfo

Implementation of

RoyTransDataObject.transDataInfo

---

canTransfer

• get canTransfer(): boolean

Returns

boolean

Implementation of

RoyTransDataObject.canTransfer

Methods

createInstance

▸ createInstance(transDataInfo?): RoyMesh

Parameters

Name	Type
transDataInfo?	RoyTransDataInfo

Returns

RoyMesh

---

destroyInstance

▸ destroyInstance(royMesh): boolean

Parameters

Name	Type
royMesh	RoyMesh

Returns

boolean

---

setUserData

▸ setUserData(key, value): void

Parameters

Name	Type
key	string
value	unknown

Returns

void

---

getUserData

▸ getUserData(key): unknown

Parameters

Name	Type
key	string

Returns

unknown

---

deleteUserData

▸ deleteUserData(key): void

Parameters

Name	Type
key	string

Returns

void

---

markTransDataDirty

▸ markTransDataDirty(): void

Returns

void

Implementation of

RoyTransDataObject.markTransDataDirty

---

markCanTransfer

▸ markCanTransfer(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

RoyTransDataObject.markCanTransfer

---

isInUse

▸ isInUse(): boolean

Returns

boolean

---

addRefComponent

▸ addRefComponent(component): void

Parameters

Name	Type
component	RoyComponent

Returns

void

---

removeRefComponent

▸ removeRefComponent(component): void

Parameters

Name	Type
component	RoyComponent

Returns

void

---

isReady

▸ isReady(): boolean

Returns

boolean

---

setVertexBufferAttribute

▸ setVertexBufferAttribute(attribute, elementType, stride?): void

Parameters

Name	Type	Default value
attribute	VertexAttribute	undefined
elementType	VertexBuffer$AttributeType	undefined
stride	number	0

Returns

void

---

getVertexBufferData

▸ getVertexBufferData(attribute): Float32Array

Parameters

Name	Type
attribute	VertexAttribute

Returns

Float32Array

---

getVertexBufferType

▸ getVertexBufferType(attribute): VertexBuffer$AttributeType

Parameters

Name	Type
attribute	VertexAttribute

Returns

VertexBuffer$AttributeType

---

getVertexBufferStride

▸ getVertexBufferStride(attribute): number

Parameters

Name	Type
attribute	VertexAttribute

Returns

number

---

getIndexBufferData

▸ getIndexBufferData(): Uint16Array | Uint32Array

Returns

Uint16Array | Uint32Array

---

setAxisAlignBoundBox

▸ setAxisAlignBoundBox(boundBox): void

Parameters

Name	Type
boundBox	AABB

Returns

void

---

syncToBuffer

▸ syncToBuffer(): void

Returns

void

---

isRaycastAvailable

▸ isRaycastAvailable(primitiveType): boolean

Parameters

Name	Type
primitiveType	RenderableManager$PrimitiveType

Returns

boolean

---

getAttributeIndex

▸ getAttributeIndex(attribute): number

Parameters

Name	Type
attribute	VertexAttribute

Returns

number

---

reset

▸ reset(): void

Returns

void

---

resetVertexBufferAttribute

▸ resetVertexBufferAttribute(): void

Returns

void

---

resetIndexBufferAttribute

▸ resetIndexBufferAttribute(): void

Returns

void

---

createAsWireframeMesh

▸ createAsWireframeMesh(baseMesh, offset, count): void

Parameters

Name	Type
baseMesh	RoyMesh
offset	number
count	number

Returns

void

---

prepareWireframeMesh

▸ prepareWireframeMesh(baseMesh, baseMeshVertexBufferDataList, baseMeshIndexBufferData, offset, count): void

Parameters

Name	Type
baseMesh	RoyMesh
baseMeshVertexBufferDataList	Float32Array[]
baseMeshIndexBufferData	Uint16Array | Uint32Array
offset	number
count	number

Returns

void

---

removeRelObjectFromMap

▸ removeRelObjectFromMap(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv

Returns

void

Implementation of

RoyTransDataObject.removeRelObjectFromMap

---

collectTransData

▸ collectTransData(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

void

Implementation of

RoyTransDataObject.collectTransData

---

serializeTransData

▸ serializeTransData(dataTransfer): RoyMeshData

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

RoyMeshData

Implementation of

RoyTransDataObject.serializeTransData

---

deserializeTransData

▸ deserializeTransData(dataTransfer, meshData): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv
meshData	RoyMeshData

Returns

void