Class GlLinesModule

webgl线模块,用来绘制批量线(没有线宽)

Hierarchy (view full)

EntityModuleBase
- GlLinesModule

Implements

IEntityModuleBase

Constructors

constructor

new GlLinesModule(entity, options?): GlLinesModule
Parameters
- entity: Entity
- Optional options: GlLinesModuleOption
Returns GlLinesModule
Overrides EntityModuleBase.constructor

Properties

`Optional` _app

_app?: App

`Protected` _destroyed

_destroyed: boolean = false

appRenderIndex

appRenderIndex: number = 0

data

data: GlLineItemData[]

entity

entity: Entity

extData

extData: {
[key: string]: any;
} = {}

Type declaration

[key: string]: any

gllines

gllines: Line<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

highlightData

highlightData: GlLineItemData[]

highlightGlLines

highlightGlLines: Line<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

highlightIndexMap

highlightIndexMap: Map<string, number> = ...

highlightStyle

highlightStyle: LineBasicMaterialParameters | LineDashedMaterialParameters

`Readonly` instanceId

instanceId: number = ++AppObject._instanceIdCounter

onSetApp

onSetApp: Signal = ...

posIndex

posIndex: Map<number, {
lineIndex: number;
positionIndex: number;
}> = ...

Type declaration

lineIndex: number
positionIndex: number

showVertex

showVertex: boolean

style

style: LineBasicMaterialParameters | LineDashedMaterialParameters

vertexEntity

vertexEntity: SymbolEntity

`Optional` vertexStyle

vertexStyle?: SymbolMaterialProps & {
    pointBorderColor?: ColorRepresentation;
    pointColor?: ColorRepresentation;
    pointSize?: number;
}

Type declaration

Optional pointBorderColor?: ColorRepresentation
Optional pointColor?: ColorRepresentation
Optional pointSize?: number

`Static` moduleName

moduleName: string = "GlLinesModule"

Accessors

app

get app(): App
Returns App
Inherited from EntityModuleBase.app
set app(value): void
Parameters
- value: App
Returns void
Inherited from EntityModuleBase.app

destroyed

get destroyed(): boolean
Whether it has been destroyed.

Returns boolean
Inherited from EntityModuleBase.destroyed

enabled

get enabled(): boolean
Indicates whether the component is enabled.

Returns boolean
Inherited from EntityModuleBase.enabled
set enabled(value): void
Parameters
- value: boolean
Returns void
Inherited from EntityModuleBase.enabled

uiConfig

get uiConfig(): UiObjectConfig<any, string, any>
Returns UiObjectConfig<any, string, any>
Inherited from EntityModuleBase.uiConfig

Methods

_onAwake

_onAwake(): void
Internal
Returns void
Inherited from EntityModuleBase._onAwake

_onDestroy

_onDestroy(): void
Internal
Returns void
Inherited from EntityModuleBase._onDestroy

_onDisable

_onDisable(): void
Internal
Returns void
Inherited from EntityModuleBase._onDisable

_onEnable

_onEnable(): void
Internal
Returns void
Inherited from EntityModuleBase._onEnable

_setActive

_setActive(value): void
Internal
Parameters
- value: boolean
Returns void
Inherited from EntityModuleBase._setActive

addDispose

addDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from EntityModuleBase.addDispose

applyMixinsTo

applyMixinsTo(toClassInst, methodNames?, addMethods?, filterName?): void
Parameters
- toClassInst: any
- Optional methodNames: string[]
- Optional addMethods: string[]
- Optional filterName: string[]
Returns void
Inherited from EntityModuleBase.applyMixinsTo

clearHighlight

clearHighlight(): void
清除所有高亮

Returns void

destroy

destroy(): void
Destroy self.

Returns void
Inherited from EntityModuleBase.destroy

dispatch

dispatch(event, ...data): boolean
触发指定事件名称.
Parameters
- event: string
  Event name
- Rest ...data: any
  Data
Returns boolean
- Whether the dispatching is successful
Inherited from EntityModuleBase.dispatch

effectScope

effectScope(fn): void
Parameters
- fn: (() => any)
  - - (): any
    - Returns any
Returns void
Inherited from EntityModuleBase.effectScope

eventNames

eventNames(): string[]
返回注册的所有事件名.

Returns string[]
所有事件名

Inherited from EntityModuleBase.eventNames

getData

getData(): GlLineItemData[]
获取数据

Returns GlLineItemData[]

getGlLines

getGlLines(): Line<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>
获取线对象

Returns Line<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

getItemDataByIndex

getItemDataByIndex(index, isRefData?): {
    data: GlLineItemData;
    positionIndex: number;
} | {
    color?: ColorRepresentation | ColorRepresentation[];
    coordinates: [number, number, number][];
    data: undefined;
    id?: string;
    positionIndex: number;
    showVertex?: boolean;
}
通过Index获取
Parameters
- index: number
  索引
- Optional isRefData: boolean
  返回的是否是数据引用的对象,默认false,将克隆新的数据
Returns {
    data: GlLineItemData;
    positionIndex: number;
} | {
    color?: ColorRepresentation | ColorRepresentation[];
    coordinates: [number, number, number][];
    data: undefined;
    id?: string;
    positionIndex: number;
    showVertex?: boolean;
}

getVertexData

getVertexData(isGetAll?): SymbolItemData[]
获取顶点数据
Parameters
- Optional isGetAll: boolean
Returns SymbolItemData[]

getVertexSymbol

getVertexSymbol(): SymbolEntity
获取顶点对象

Returns SymbolEntity

hasEvent

hasEvent(event): boolean
确定是否存在事件侦听
Parameters
- event: string
  事件名
Returns boolean
返回是否存在相应的事件

Inherited from EntityModuleBase.hasEvent

isItemHighlight

isItemHighlight(id): boolean
获取某项高亮与否
Parameters
- id: string
  id
Returns boolean

isShowVertex

isShowVertex(): boolean
是否显示顶点

Returns boolean

listenerCount

listenerCount(event): number
返回具有指定事件名称的侦听总数.
Parameters
- event: string
  Event name
Returns number
The count of listeners

Inherited from EntityModuleBase.listenerCount

off

off(event, fn?): EventDispatcher
移除监听.
Parameters
- event: string
  Event name
- Optional fn: Function
  Function, If is undefined, delete all corresponding event listeners.
Returns EventDispatcher
Inherited from EntityModuleBase.off

on

on(event, fn): EventDispatcher
增加监听
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from EntityModuleBase.on

once

once(event, fn): EventDispatcher
只监听一次.
Parameters
- event: string
  Event name
- fn: Function
  Function
Returns EventDispatcher
This

Inherited from EntityModuleBase.once

refreshHighlight

refreshHighlight(): void
刷新高亮数据

Returns void

removeAllEventListeners

removeAllEventListeners(event?): void
通过事件名移除所有监听.
Parameters
- Optional event: string
  Event name, delete all events if not passed
Returns void
Inherited from EntityModuleBase.removeAllEventListeners

removeDispose

removeDispose(cb): void
Parameters
- cb: Function
Returns void
Inherited from EntityModuleBase.removeDispose

setData

setData(data): void
修改数据
Parameters
- data: GlLineItemData[]
Returns void

setItemHighlight

setItemHighlight(id, ishighlight?, disableAutoRefreshData?): void
设置某项高亮与否
Parameters
- id: string
  id
- Optional ishighlight: boolean
  是否
- Optional disableAutoRefreshData: boolean
  不自动刷新，需要调用 refreshHighlight 来刷新
Returns void

setShowVertex

setShowVertex(show, symbolStyleOptions?): void
设置是否显示顶点
Parameters
- show: boolean
- Optional symbolStyleOptions: {
      pixelRaycasting?: boolean;
      style?: SymbolMaterialProps;
      useBvh?: boolean;
  }
  - Optional pixelRaycasting?: boolean
    像素大小拾取
  - Optional style?: SymbolMaterialProps
    样式
  - Optional useBvh?: boolean
    是否使用bvh射线查询。默认是
Returns void

setupUiConfig

setupUiConfig(): {
    app: App;
    children: {
        getValue: (() => boolean);
        label: string;
        setValue: ((v) => void);
        type: string;
    }[];
    expanded: boolean;
    label: string;
    type: string;
}
Returns {
    app: App;
    children: {
        getValue: (() => boolean);
        label: string;
        setValue: ((v) => void);
        type: string;
    }[];
    expanded: boolean;
    label: string;
    type: string;
}
- app: App
- children: {
      getValue: (() => boolean);
      label: string;
      setValue: ((v) => void);
      type: string;
  }[]
- expanded: boolean
- label: string
- type: string
Implementation of IEntityModuleBase.setupUiConfig

updateHightStyle

updateHightStyle(style): void
更新高亮样式
Parameters
- style: LineBasicMaterialParameters | LineDashedMaterialParameters
Returns void

updateStyle

updateStyle(style): void
更新样式
Parameters
- style: LineBasicMaterialParameters | LineDashedMaterialParameters
Returns void

Class GlLinesModule

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

entity: Entity

Optional options: GlLinesModuleOption

Returns GlLinesModule

Properties

Optional _app

Protected _destroyed

appRenderIndex

data

entity

extData

Type declaration

[key: string]: any

gllines

highlightData

highlightGlLines

highlightIndexMap

highlightStyle

Readonly instanceId

onSetApp

posIndex

Type declaration

lineIndex: number

positionIndex: number

showVertex

style

vertexEntity

Optional vertexStyle

Type declaration

Optional pointBorderColor?: ColorRepresentation

Optional pointColor?: ColorRepresentation

Optional pointSize?: number

Static moduleName

Accessors

app

Returns App

Parameters

value: App

Returns void

destroyed

Returns boolean

enabled

Returns boolean

Parameters

value: boolean

Returns void

uiConfig

Returns UiObjectConfig<any, string, any>

Methods

_onAwake

Returns void

_onDestroy

Returns void

_onDisable

Returns void

_onEnable

Returns void

_setActive

Parameters

value: boolean

Returns void

addDispose

Parameters

cb: Function

Returns void

applyMixinsTo

Parameters

toClassInst: any

Optional methodNames: string[]

Optional addMethods: string[]

`Optional` options: GlLinesModuleOption

`Optional` _app

`Protected` _destroyed

`Readonly` instanceId

`Optional` vertexStyle

`Optional` pointBorderColor?: ColorRepresentation

`Optional` pointColor?: ColorRepresentation

`Optional` pointSize?: number

`Static` moduleName

`Optional` methodNames: string[]

`Optional` addMethods: string[]

`Optional` filterName: string[]

`Rest` ...data: any

`Optional` isRefData: boolean

Returns {
data: GlLineItemData;
positionIndex: number;
} | {
color?: ColorRepresentation | ColorRepresentation[];
coordinates: [number, number, number][];
data: undefined;
id?: string;
positionIndex: number;
showVertex?: boolean;
}

`Optional` isGetAll: boolean

`Optional` fn: Function

`Optional` event: string