Class ModelHandle

Hierarchy

ModelHandle

Methods

addState

addState(state: State, args: number | number[]): void
Parameters
- state: State
- args: number | number[]
Returns void
- Defined in src/model-handle.ts:782

`Static` bufferTexture

bufferTexture(gl: WebGLRenderingContext | WebGL2RenderingContext, pointer: WebGLTexture, data: Float32Array | Uint8Array, numberOfComponents?: number): number
Parameters
- gl: WebGLRenderingContext | WebGL2RenderingContext
- pointer: WebGLTexture
- data: Float32Array | Uint8Array
- Optional numberOfComponents: number
Returns number
- Defined in src/model-handle.ts:623

clearHighlighting

clearHighlighting(): void
Returns void
- Defined in src/model-handle.ts:829

draw

draw(mode?: DrawMode, percent?: number): void
Parameters
- Optional mode: DrawMode
- Optional percent: number
Returns void
- Defined in src/model-handle.ts:355

getModelState

getModelState(): number[][]
Returns number[][]
- Defined in src/model-handle.ts:1009

getProductAnalysis

getProductAnalysis(results: ProductAnalyticalResult[]): ProductAnalyticalResult[]
Counts number of triangles for every product. This might be usefull to understand performance of certain models.

Returns
List of product analytical results
Parameters
- results: ProductAnalyticalResult[]
Returns ProductAnalyticalResult[]
- Defined in src/model-handle.ts:1069

getProductId

getProductId(renderId: number): number
Parameters
- renderId: number
Returns number
- Defined in src/model-handle.ts:468

getProductMap

getProductMap(id: number, wcs?: vec3): ProductMap
Parameters
- id: number
- Optional wcs: vec3
Returns ProductMap
- Defined in src/model-handle.ts:476

getProductMaps

getProductMaps(ids: number[]): ProductMap[]
Parameters
- ids: number[]
Returns ProductMap[]
- Defined in src/model-handle.ts:496

getProductsOfType

getProductsOfType(type: ProductType): ProductMap[]
Parameters
- type: ProductType
Returns ProductMap[]
- Defined in src/model-handle.ts:512

getProductsWithState

getProductsWithState(state: State): {
id: number;
model: number;
}[]
Parameters
- state: State
Returns {
id: number;
model: number;
}[]
- Defined in src/model-handle.ts:918

getRegion

getRegion(wcs: vec3): Region
Parameters
- wcs: vec3
Returns Region
- Defined in src/model-handle.ts:66

getState

getState(id: number): State
Parameters
- id: number
Returns State
- Defined in src/model-handle.ts:729

getStates

getStates(): {
id: number;
states: State[];
}[]
Returns {
id: number;
states: State[];
}[]
- Defined in src/model-handle.ts:737

getStyle

getStyle(id: number): number
Parameters
- id: number
Returns number
- Defined in src/model-handle.ts:753

removeState

removeState(state: State, args: number | number[]): void
Parameters
- state: State
- args: number | number[]
Returns void
- Defined in src/model-handle.ts:848

resetState

resetState(args?: number | number[]): void
Parameters
- Optional args: number | number[]
Returns void
- Defined in src/model-handle.ts:881

resetStyles

resetStyles(): void
Returns void
- Defined in src/model-handle.ts:996

restoreModelState

restoreModelState(states: number[][]): void
Parameters
- states: number[][]
Returns void
- Defined in src/model-handle.ts:1035

setActive

setActive(pointers: ModelPointers, wcs: vec3): void
Parameters
- pointers: ModelPointers
- wcs: vec3
Returns void
- Defined in src/model-handle.ts:261

setState

setState(state: State, args: number | number[]): void
Parameters
- state: State
- args: number | number[]
Returns void
- Defined in src/model-handle.ts:806

setStyle

setStyle(styleId: number, args: number | number[]): void
Parameters
- styleId: number
- args: number | number[]
Returns void
- Defined in src/model-handle.ts:943

unload

unload(): any
Returns any
- Defined in src/model-handle.ts:529

Accessors

changed

get changed(): boolean
Indicates if there are any changes to be drawn. This flag is checked by the viewer to see if redraw is necessary

Returns boolean
- Defined in src/model-handle.ts:111

clippingPlaneA

get clippingPlaneA(): number[]
Returns number[]
- Defined in src/model-handle.ts:163
set clippingPlaneA(plane: number[]): void
Parameters
- plane: number[]
Returns void
- Defined in src/model-handle.ts:157

clippingPlaneB

get clippingPlaneB(): number[]
Returns number[]
- Defined in src/model-handle.ts:173
set clippingPlaneB(plane: number[]): void
Parameters
- plane: number[]
Returns void
- Defined in src/model-handle.ts:167

empty

get empty(): boolean
Some models are empty - they don't contain any geometry

Returns boolean
- Defined in src/model-handle.ts:119

isolatedProducts

get isolatedProducts(): number[]
If drawProductId is defined, only this single product is drawn

Returns number[]
- Defined in src/model-handle.ts:63
set isolatedProducts(value: number[]): void
Parameters
- value: number[]
Returns void
- Defined in src/model-handle.ts:64

stopped

get stopped(): boolean
indicates if this model should be used in a rendering loop or not.

Returns boolean
- Defined in src/model-handle.ts:41
set stopped(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in src/model-handle.ts:42

Properties

clippable

clippable: boolean = true

participates in clipping operation only if true

id

id: number

Session unique ID used to manipulate this handle/model

meter

meter: number

Conversion factor to one meter from model units

pickable

pickable: boolean = true

participates in picking operation only if true

pinned

pinned: boolean = false

indicates this model should never have drop items from rendering when Adaptive Performance is enabled

tag

tag: any = null

Tag used to identify the model

wcs

wcs: vec3 = ...

local World Coordinate System origin

Constructors

constructor

new ModelHandle(_gl: WebGLRenderingContext | WebGL2RenderingContext, _model: ModelGeometry, progress: ((msg: Message) => void)): ModelHandle
Parameters
- _gl: WebGLRenderingContext | WebGL2RenderingContext
- _model: ModelGeometry
- progress: ((msg: Message) => void)
  - - (msg: Message): void
    - Parameters
      
      msg: Message
      
      Returns void
Returns ModelHandle
- Defined in src/model-handle.ts:177

Class ModelHandle

Hierarchy

Index

Methods

Accessors

Properties

Constructors

Methods

addState

Parameters

state: State

args: number | number[]

Returns void

Static bufferTexture

Parameters

gl: WebGLRenderingContext | WebGL2RenderingContext

pointer: WebGLTexture

data: Float32Array | Uint8Array

Optional numberOfComponents: number

Returns number

clearHighlighting

Returns void

draw

Parameters

Optional mode: DrawMode

Optional percent: number

Returns void

getModelState

Returns number[][]

getProductAnalysis

Returns

Parameters

results: ProductAnalyticalResult[]

Returns ProductAnalyticalResult[]

getProductId

Parameters

renderId: number

Returns number

getProductMap

Parameters

id: number

Optional wcs: vec3

Returns ProductMap

getProductMaps

Parameters

ids: number[]

Returns ProductMap[]

getProductsOfType

Parameters

type: ProductType

Returns ProductMap[]

getProductsWithState

Parameters

state: State

Returns { id: number; model: number; }[]

getRegion

Parameters

wcs: vec3

Returns Region

getState

Parameters

id: number

Returns State

getStates

Returns { id: number; states: State[]; }[]

getStyle

Parameters

id: number

Returns number

removeState

Parameters

state: State

args: number | number[]

Returns void

resetState

Parameters

Optional args: number | number[]

Returns void

resetStyles

Returns void

`Static` bufferTexture

`Optional` numberOfComponents: number

`Optional` mode: DrawMode

`Optional` percent: number

`Optional` wcs: vec3

Returns {
id: number;
model: number;
}[]

Returns {
id: number;
states: State[];
}[]

`Optional` args: number | number[]