RoyInterface / Exports / component/RoyWireframeComponent / RoyWireframeComponent

Class: RoyWireframeComponent

component/RoyWireframeComponent.RoyWireframeComponent

Hierarchy

• RoyComponent

  ↳ RoyWireframeComponent

Table of contents

Constructors

• constructor

Properties

• s_handleID
• m_handleID
• m_sceneNode
• m_name
• m_compTypeName
• m_compClassifyType
• m_requireDirtyBox
• m_requireUpdatePriority
• m_requireUpdate
• m_visibleLayer
• m_mouseEnabled
• m_mouseEnabledOnInvisible
• m_occlusionEnabled
• m_boundBoxValid
• m_boundBox
• m_userData
• m_gizmoItem
• m_transDataInfo
• m_canTransfer
• cacheBoxCenter
• cacheInvertWorldMatrix
• cacheLocalRay
• cacheRayPos
• cacheVec4
• cacheLocalFrustum
• LINE_SOLID
• LINE_DASH
• CLASS_NAME
• m_lineList
• m_lineStyle
• m_renderPriority
• m_depthTestEnabled
• m_blendMode
• m_drawPriority
• m_depthOffset
• m_nextPage
• m_excludeDraftColor
• m_excludeDraftNormal
• m_postDraftColor
• m_gradientEnabled
• m_gradientDistanceNear
• m_gradientDistanceFar
• m_batchEnable
• m_wireframeBatch
• m_mouseThickness
• m_mousePriority
• m_isBoundBoxDirty
• m_boundSphereDirty
• m_boundSphere
• m_currentPoint
• m_currentLineLength
• m_linePrecision
• m_vStart
• m_vEnd
• m_interSegment
• m_interRay

Accessors

• handleID
• sceneNode
• name
• compTypeName
• compClassifyType
• requireDirtyBox
• requireUpdatePriority
• requireUpdate
• enabled
• mouseEnabled
• mouseEnabledOnInvisible
• occlusionEnabled
• boundBoxValid
• boundBox
• gizmoItem
• transDataInfo
• lineList
• lineStyle
• visibleLayer
• renderPriority
• depthTestEnabled
• blendMode
• drawPriority
• depthOffset
• nextPage
• excludeDraftColor
• excludeDraftNormal
• postDraftColor
• gradientEnabled
• gradientDistanceNear
• gradientDistanceFar
• batchEnabled
• wireframeBatch
• mouseThickness
• mousePriority
• boundSphere
• canTransfer

Methods

• setUserData
• getUserData
• deleteUserData
• markTransDataDirty
• markCanTransfer
• markCullDirty
• updateOcclusion
• removeRelObjectFromMap
• collectTransData
• serializeTransData
• deserializeTransData
• destroy
• onEnable
• onDisable
• update
• onAddToScene
• onRemoveFromScene
• markDirtyByLineStyle
• setLineStyleOnIndex
• moveTo
• lineTo
• addLine
• addLines
• setLines
• getLineStyle
• clear
• getBoundBox
• computeBoundSphere
• raycast
• frustumQuery
• markWireframeBatchDirty

Constructors

constructor

• new RoyWireframeComponent(node, transDataInfo?): RoyWireframeComponent

Parameters

Name	Type
node	RoySceneNode
transDataInfo?	RoyTransDataInfo

Returns

RoyWireframeComponent

Overrides

RoyComponent.constructor

Properties

s_handleID

▪ Static Protected s_handleID: number = 0

Inherited from

RoyComponent.s_handleID

---

m_handleID

• Protected m_handleID: number = 0

Inherited from

RoyComponent.m_handleID

---

m_sceneNode

• Protected m_sceneNode: RoySceneNode

Inherited from

RoyComponent.m_sceneNode

---

m_name

• Protected m_name: string = ''

Inherited from

RoyComponent.m_name

---

m_compTypeName

• Protected m_compTypeName: string = ''

Inherited from

RoyComponent.m_compTypeName

---

m_compClassifyType

• Protected m_compClassifyType: RoyComponentClassifyType = RoyComponentClassifyType.CCT_LOGIC

Inherited from

RoyComponent.m_compClassifyType

---

m_requireDirtyBox

• Protected m_requireDirtyBox: boolean = false

Inherited from

RoyComponent.m_requireDirtyBox

---

m_requireUpdatePriority

• Protected m_requireUpdatePriority: number = 0

Inherited from

RoyComponent.m_requireUpdatePriority

---

m_requireUpdate

• Protected m_requireUpdate: boolean = false

Inherited from

RoyComponent.m_requireUpdate

---

m_visibleLayer

• Protected m_visibleLayer: number = RoyLayer.Base

Inherited from

RoyComponent.m_visibleLayer

---

m_mouseEnabled

• Protected m_mouseEnabled: boolean = false

Inherited from

RoyComponent.m_mouseEnabled

---

m_mouseEnabledOnInvisible

• Protected m_mouseEnabledOnInvisible: boolean = false

Inherited from

RoyComponent.m_mouseEnabledOnInvisible

---

m_occlusionEnabled

• Protected m_occlusionEnabled: boolean = false

Inherited from

RoyComponent.m_occlusionEnabled

---

m_boundBoxValid

• Protected m_boundBoxValid: boolean = true

Inherited from

RoyComponent.m_boundBoxValid

---

m_boundBox

• Protected m_boundBox: AABB

Inherited from

RoyComponent.m_boundBox

---

m_userData

• Protected m_userData: object = {}

Inherited from

RoyComponent.m_userData

---

m_gizmoItem

• Protected m_gizmoItem: RoyGizmoItem

Inherited from

RoyComponent.m_gizmoItem

---

m_transDataInfo

• Protected m_transDataInfo: RoyTransDataInfo

Inherited from

RoyComponent.m_transDataInfo

---

m_canTransfer

• Protected m_canTransfer: boolean = true

Inherited from

RoyComponent.m_canTransfer

---

cacheBoxCenter

▪ Static Protected cacheBoxCenter: Vec3

---

cacheInvertWorldMatrix

▪ Static Protected cacheInvertWorldMatrix: Mat4

---

cacheLocalRay

▪ Static Protected cacheLocalRay: RadialLine

---

cacheRayPos

▪ Static Protected cacheRayPos: Vec3

---

cacheVec4

▪ Static Protected cacheVec4: Vec4

---

cacheLocalFrustum

▪ Static Protected cacheLocalFrustum: Frustum

---

LINE_SOLID

▪ Static LINE_SOLID: number = 0

---

LINE_DASH

▪ Static LINE_DASH: number = 1

---

CLASS_NAME

▪ Static CLASS_NAME: string = 'RoyWireframeComponent'

---

m_lineList

• Private m_lineList: Line[]

---

m_lineStyle

• Private m_lineStyle: LineStyle

---

m_renderPriority

• Private m_renderPriority: RoyPriorityDef = RoyPriorityDef.RENDER_WIRE_FRAME

---

m_depthTestEnabled

• Private m_depthTestEnabled: boolean = true

---

m_blendMode

• Private m_blendMode: RoyBlendMode = RoyBlendMode.TRANSPARENT

---

m_drawPriority

• Private m_drawPriority: number = 4

---

m_depthOffset

• Private m_depthOffset: number = 0.001

---

m_nextPage

• Private m_nextPage: boolean = false

---

m_excludeDraftColor

• Private m_excludeDraftColor: boolean = false

---

m_excludeDraftNormal

• Private m_excludeDraftNormal: boolean = false

---

m_postDraftColor

• Private m_postDraftColor: boolean = false

---

m_gradientEnabled

• Private m_gradientEnabled: boolean = false

---

m_gradientDistanceNear

• Private m_gradientDistanceNear: number = 0.0

---

m_gradientDistanceFar

• Private m_gradientDistanceFar: number = 0.0

---

m_batchEnable

• Private m_batchEnable: boolean = true

---

m_wireframeBatch

• Private m_wireframeBatch: RoyWireframeBatch

---

m_mouseThickness

• Private m_mouseThickness: number = 3.0

---

m_mousePriority

• Private m_mousePriority: number = 0

---

m_isBoundBoxDirty

• Private m_isBoundBoxDirty: boolean = false

---

m_boundSphereDirty

• Private m_boundSphereDirty: boolean = true

---

m_boundSphere

• Private m_boundSphere: Sphere

---

m_currentPoint

• Private m_currentPoint: Vec3

---

m_currentLineLength

• Private m_currentLineLength: number = 0

---

m_linePrecision

• Private m_linePrecision: number = 3

---

m_vStart

• Private m_vStart: Vec3

---

m_vEnd

• Private m_vEnd: Vec3

---

m_interSegment

• Private m_interSegment: Vec3

---

m_interRay

• Private m_interRay: Vec3

Accessors

handleID

• get handleID(): number

Returns

number

Inherited from

RoyComponent.handleID

---

sceneNode

• get sceneNode(): RoySceneNode

Returns

RoySceneNode

Inherited from

RoyComponent.sceneNode

---

name

• get name(): string

Returns

string

Inherited from

RoyComponent.name

• set name(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

RoyComponent.name

---

compTypeName

• get compTypeName(): string

Returns

string

Inherited from

RoyComponent.compTypeName

---

compClassifyType

• get compClassifyType(): RoyComponentClassifyType

Returns

RoyComponentClassifyType

Inherited from

RoyComponent.compClassifyType

---

requireDirtyBox

• get requireDirtyBox(): boolean

Returns

boolean

Inherited from

RoyComponent.requireDirtyBox

---

requireUpdatePriority

• get requireUpdatePriority(): number

Returns

number

Inherited from

RoyComponent.requireUpdatePriority

---

requireUpdate

• get requireUpdate(): boolean

Returns

boolean

Inherited from

RoyComponent.requireUpdate

---

enabled

• get enabled(): boolean

Returns

boolean

Inherited from

RoyComponent.enabled

• set enabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyComponent.enabled

---

mouseEnabled

• get mouseEnabled(): boolean

Returns

boolean

Inherited from

RoyComponent.mouseEnabled

• set mouseEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyComponent.mouseEnabled

---

mouseEnabledOnInvisible

• get mouseEnabledOnInvisible(): boolean

Returns

boolean

Inherited from

RoyComponent.mouseEnabledOnInvisible

• set mouseEnabledOnInvisible(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyComponent.mouseEnabledOnInvisible

---

occlusionEnabled

• get occlusionEnabled(): boolean

Returns

boolean

Inherited from

RoyComponent.occlusionEnabled

• set occlusionEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyComponent.occlusionEnabled

---

boundBoxValid

• get boundBoxValid(): boolean

Returns

boolean

Inherited from

RoyComponent.boundBoxValid

• set boundBoxValid(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyComponent.boundBoxValid

---

boundBox

• get boundBox(): AABB

Returns

AABB

Inherited from

RoyComponent.boundBox

---

gizmoItem

• get gizmoItem(): RoyGizmoItem

Returns

RoyGizmoItem

Inherited from

RoyComponent.gizmoItem

---

transDataInfo

• get transDataInfo(): RoyTransDataInfo

Returns

RoyTransDataInfo

Inherited from

RoyComponent.transDataInfo

---

lineList

• get lineList(): Line[]

Returns

Line[]

---

lineStyle

• get lineStyle(): LineStyle

Returns

LineStyle

• set lineStyle(lineStyle): void

Parameters

Name	Type
lineStyle	LineStyle

Returns

void

---

visibleLayer

• get visibleLayer(): number

Returns

number

Overrides

RoyComponent.visibleLayer

• set visibleLayer(value): void

Parameters

Name	Type
value	number

Returns

void

Overrides

RoyComponent.visibleLayer

---

renderPriority

• get renderPriority(): RoyPriorityDef

Returns

RoyPriorityDef

• set renderPriority(value): void

Parameters

Name	Type
value	RoyPriorityDef

Returns

void

---

depthTestEnabled

• get depthTestEnabled(): boolean

Returns

boolean

• set depthTestEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

blendMode

• get blendMode(): RoyBlendMode

Returns

RoyBlendMode

---

drawPriority

• get drawPriority(): number

Returns

number

• set drawPriority(value): void

Parameters

Name	Type
value	number

Returns

void

---

depthOffset

• get depthOffset(): number

Returns

number

• set depthOffset(value): void

Parameters

Name	Type
value	number

Returns

void

---

nextPage

• get nextPage(): boolean

Returns

boolean

• set nextPage(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

excludeDraftColor

• get excludeDraftColor(): boolean

Returns

boolean

• set excludeDraftColor(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

excludeDraftNormal

• get excludeDraftNormal(): boolean

Returns

boolean

• set excludeDraftNormal(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

postDraftColor

• get postDraftColor(): boolean

Returns

boolean

• set postDraftColor(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

gradientEnabled

• get gradientEnabled(): boolean

Returns

boolean

• set gradientEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

gradientDistanceNear

• get gradientDistanceNear(): number

Returns

number

• set gradientDistanceNear(value): void

Parameters

Name	Type
value	number

Returns

void

---

gradientDistanceFar

• get gradientDistanceFar(): number

Returns

number

• set gradientDistanceFar(value): void

Parameters

Name	Type
value	number

Returns

void

---

batchEnabled

• get batchEnabled(): boolean

Returns

boolean

• set batchEnabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

---

wireframeBatch

• get wireframeBatch(): RoyWireframeBatch

Returns

RoyWireframeBatch

• set wireframeBatch(value): void

Parameters

Name	Type
value	RoyWireframeBatch

Returns

void

---

mouseThickness

• get mouseThickness(): number

Returns

number

• set mouseThickness(value): void

Parameters

Name	Type
value	number

Returns

void

---

mousePriority

• get mousePriority(): number

Returns

number

• set mousePriority(value): void

Parameters

Name	Type
value	number

Returns

void

---

boundSphere

• get boundSphere(): Sphere

Returns

Sphere

---

canTransfer

• get canTransfer(): boolean

Returns

boolean

Overrides

RoyComponent.canTransfer

Methods

setUserData

▸ setUserData(key, value): void

Parameters

Name	Type
key	string
value	unknown

Returns

void

Inherited from

RoyComponent.setUserData

---

getUserData

▸ getUserData(key): unknown

Parameters

Name	Type
key	string

Returns

unknown

Inherited from

RoyComponent.getUserData

---

deleteUserData

▸ deleteUserData(key): void

Parameters

Name	Type
key	string

Returns

void

Inherited from

RoyComponent.deleteUserData

---

markTransDataDirty

▸ markTransDataDirty(): void

Returns

void

Inherited from

RoyComponent.markTransDataDirty

---

markCanTransfer

▸ markCanTransfer(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

RoyComponent.markCanTransfer

---

markCullDirty

▸ markCullDirty(): void

Returns

void

Inherited from

RoyComponent.markCullDirty

---

updateOcclusion

▸ updateOcclusion(): void

Returns

void

Inherited from

RoyComponent.updateOcclusion

---

removeRelObjectFromMap

▸ removeRelObjectFromMap(dataTransfer): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv

Returns

void

Inherited from

RoyComponent.removeRelObjectFromMap

---

collectTransData

▸ collectTransData(dataTransfer): boolean

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

boolean

Inherited from

RoyComponent.collectTransData

---

serializeTransData

▸ serializeTransData(dataTransfer): Object

Parameters

Name	Type
dataTransfer	RoyDataTransferSend

Returns

Object

Name	Type
ptlType	string
ptlName	string

Inherited from

RoyComponent.serializeTransData

---

deserializeTransData

▸ deserializeTransData(dataTransfer, compData): void

Parameters

Name	Type
dataTransfer	RoyDataTransferRecv
compData	RoyComponentData

Returns

void

Inherited from

RoyComponent.deserializeTransData

---

destroy

▸ destroy(): void

Returns

void

Overrides

RoyComponent.destroy

---

onEnable

▸ onEnable(): void

Returns

void

Overrides

RoyComponent.onEnable

---

onDisable

▸ onDisable(): void

Returns

void

Overrides

RoyComponent.onDisable

---

update

▸ update(royCamera): void

Parameters

Name	Type
royCamera	RoyCamera3D

Returns

void

Overrides

RoyComponent.update

---

onAddToScene

▸ onAddToScene(): void

Returns

void

Overrides

RoyComponent.onAddToScene

---

onRemoveFromScene

▸ onRemoveFromScene(): void

Returns

void

Overrides

RoyComponent.onRemoveFromScene

---

markDirtyByLineStyle

▸ markDirtyByLineStyle(): void

Returns

void

---

setLineStyleOnIndex

▸ setLineStyleOnIndex(index, lineStyle): void

Parameters

Name	Type
index	number
lineStyle	LineStyle

Returns

void

---

moveTo

▸ moveTo(vx, vy, vz): void

Parameters

Name	Type
vx	number
vy	number
vz	number

Returns

void

---

lineTo

▸ lineTo(vx, vy, vz): void

Parameters

Name	Type
vx	number
vy	number
vz	number

Returns

void

---

addLine

▸ addLine(v1x, v1y, v1z, v2x, v2y, v2z, lineStyle?): Line

Parameters

Name	Type
v1x	number
v1y	number
v1z	number
v2x	number
v2y	number
v2z	number
lineStyle?	LineStyle

Returns

Line

---

addLines

▸ addLines(pointList, lineStyle?): void

Parameters

Name	Type
pointList	Vec3[]
lineStyle?	LineStyle

Returns

void

---

setLines

▸ setLines(lines): void

Parameters

Name	Type
lines	Line[]

Returns

void

---

getLineStyle

▸ getLineStyle(lineIndex): LineStyle

Parameters

Name	Type
lineIndex	number

Returns

LineStyle

---

clear

▸ clear(): void

Returns

void

---

getBoundBox

▸ getBoundBox(): AABB

Returns

AABB

Overrides

RoyComponent.getBoundBox

---

computeBoundSphere

▸ computeBoundSphere(): void

Returns

void

---

raycast

▸ raycast(ray): RoyQueryResultRay[]

Parameters

Name	Type
ray	RadialLine

Returns

RoyQueryResultRay[]

Overrides

RoyComponent.raycast

---

frustumQuery

▸ frustumQuery(frustum, intersection): RoyQueryResultFrustum[]

Parameters

Name	Type
frustum	Frustum
intersection	Intersection

Returns

RoyQueryResultFrustum[]

Overrides

RoyComponent.frustumQuery

---

markWireframeBatchDirty

▸ markWireframeBatchDirty(type): void

Parameters

Name	Type
type	RoyWireframeBatchDirtyType

Returns

void