Class Parameter

Hierarchy

Readonly<Partial<ParameterValue>>
- Parameter

Index

Constructors

constructor

Methods

copy reset resetAll resolveValue set createDefault resolveValue resolveValueTo

Constructors

constructor

new Parameter(initialValue?: Partial<ParameterValue>): Parameter
Parameters
- OptionalinitialValue: Partial<ParameterValue>
Returns Parameter
Inherited from Readonly<Partial<ParameterValue>>.constructor
- Defined in lib/five/model/parameter.ts:447

Properties

`Optional` `Readonly`boundingBox

boundingBox?: Box3

包围盒

`Optional` `Readonly`brightness

brightness?: number

亮度

`Optional` `Readonly`cacheCameras

cacheCameras?: readonly (Camera | PerspectiveCamera)[]

缓存相机

`Optional` `Readonly`cameraCulling

cameraCulling?: boolean

模型不加载在不在视野中的节点

`Optional` `Readonly`castShadow

castShadow?: boolean

是否产生阴影

`Optional` `Readonly`clippers

clippers?: readonly PBMClipperParameter[]

模型裁切参数（工程侧调用）

`Optional` `Readonly`colorBrightness

colorBrightness?: number

亮度调整值

`Optional` `Readonly`colorSaturation

colorSaturation?: number

饱和度调整值

`Optional` `Readonly`colorStyle

colorStyle?: PBMColorStyle

颜色样式

`Optional` `Readonly`constantColor

constantColor?: Vector3

模型颜色

`Optional` `Readonly`customShaders

customShaders?: readonly PBMCustomShader[]

自定义材质

`Optional` `Readonly`distanceGain

distanceGain?: number

distance增益

`Optional` `Readonly`floorStyle

floorStyle?: PBMFloorStyle

楼层样式

`Optional` `Readonly`gaussianSplattingSHDegree

gaussianSplattingSHDegree?: number

3dgs球谐阶数

`Optional` `Readonly`gradientTexture

gradientTexture?: Texture | null

高程着色材质

id

id: string = ...

`Optional` `Readonly`loadSiblings

loadSiblings?: boolean

模型加载不在视野中的兄弟节点

`Optional` `Readonly`maxGeometricError

maxGeometricError?: number

模型显示最大细化误差

`Optional` `Readonly`maxLevelOfDetail

maxLevelOfDetail?: number

模型显示最大细化层级

`Optional` `Readonly`maxMemoryUsage

maxMemoryUsage?: number

模型最大内存缓存

`Optional` `Readonly`maxRequests

maxRequests?: number

模型网络最大请求并发数

`Optional` `Readonly`maxScreenSpaceError

maxScreenSpaceError?: number

模型屏幕空间误差计算最大值

`Optional` `Readonly`memoryAdjustedScreenSpaceError

memoryAdjustedScreenSpaceError?: boolean

`Optional` `Readonly`minGeometricError

minGeometricError?: number

模型显示最小细化误差

`Optional` `Readonly`minLevelOfDetail

minLevelOfDetail?: number

模型显示最小细化层级

`Optional` `Readonly`modelAlpha

modelAlpha?: number

模型贴图和全景图的混合程度 [0-1]

`Optional` `Readonly`mostDetail

mostDetail?: boolean

模型是否最密

`Optional` `Readonly`opacity

opacity?: number

模型透明度

`Optional` `Readonly`outlineGain

outlineGain?: number

outline增益

`Optional` `Readonly`pano0

pano0?: PBMPanoPicture | null

起始点

`Optional` `Readonly`pano0Depth

pano0Depth?: PBMPanoDepth | null

起始点深度

`Optional` `Readonly`pano1

pano1?: PBMPanoPicture | null

结束点

`Optional` `Readonly`pano1Depth

pano1Depth?: PBMPanoDepth | null

结束点深度

`Optional` `Readonly`panoFilter

panoFilter?: PBMPanoFilter | null

全景图滤镜

`Optional` `Readonly`panoramaMinGeometricError

panoramaMinGeometricError?: number

全景态下模型显示最小细化误差

`Optional` `Readonly`pointAppearAnimation

pointAppearAnimation?: boolean

点云出现动画

`Optional` `Readonly`pointBack

pointBack?: PBMPointBack

点云背面绘制方式

`Optional` `Readonly`pointMaxPixel

pointMaxPixel?: number

点云最大尺寸

`Optional` `Readonly`pointMinPixel

pointMinPixel?: number

点云最小尺寸

`Optional` `Readonly`pointScale

pointScale?: number

点云基础大小

`Optional` `Readonly`pointShape

pointShape?: PBMPointShape

点云形状

`Optional` `Readonly`pointSize

pointSize?: PBMPointSize

点云大小绘制方式

`Optional` `Readonly`progress

progress?: number

全景图混合程度 [0-1]

`Optional` `Readonly`receiveShadow

receiveShadow?: boolean

是否接受阴影

`Optional` `Readonly`refinedScreen

refinedScreen?: PBMRefinedScreen | null

细化瓦片的屏幕渲染

`Optional` `Readonly`requestOrder

requestOrder?: TileRequestOrder

模型网络请求顺序

`Optional` `Readonly`shownFloorIndex

shownFloorIndex?: number

楼层参数

`Optional` `Readonly`skipLevelOfDetail

skipLevelOfDetail?: boolean

模型越层级加载

`Optional` `Readonly`transition

transition?: PBMTransition

全景图过度混合

`Optional` `Readonly`useAddBlend

useAddBlend?: boolean

半透明叠加渲染

`Optional` `Readonly`useHQDepth

useHQDepth?: boolean

是否使用HQ_DEPTH_MASK

`Optional` `Readonly`useHQWeight

useHQWeight?: boolean

是否使用HQ

versionNumber

versionNumber: number = ++parameterVersionSequence

`Optional` `Readonly`vertexMarks

vertexMarks?: boolean

是否生效标注开启后，模型顶点上会预置 _feature_id_rsmask 标记。 _feature_id_rsmask=1，在俯视等特定视角下，引擎会自动隐藏被标记的顶点对应的 Mesh，从而实现“开盖”效果，让室内布局观测更加清晰、观感更好。

Methods

copy

copy(value: Partial<ParameterValue>): this
Parameters
- value: Partial<ParameterValue>
Returns this
- Defined in lib/five/model/parameter.ts:534

reset

reset(...names: (keyof ParameterValue)[]): this
Parameters
- ...names: (keyof ParameterValue)[]
Returns this
- Defined in lib/five/model/parameter.ts:516

resetAll

resetAll(): this
Returns this
- Defined in lib/five/model/parameter.ts:530

resolveValue

resolveValue<T extends keyof ParameterValue>(
name: T,
...values: Partial<ParameterValue>[],
): ParameterValue[T]
Type Parameters
- T extends keyof ParameterValue
Parameters
- name: T
- ...values: Partial<ParameterValue>[]
Returns ParameterValue[T]
- Defined in lib/five/model/parameter.ts:465
resolveValue(...baseValues: Partial<ParameterValue>[]): ResolvedParameterValue
Parameters
- ...baseValues: Partial<ParameterValue>[]
Returns ResolvedParameterValue
- Defined in lib/five/model/parameter.ts:466

set

set<T extends keyof ParameterValue>(name: T, value: ParameterValue[T]): this
Type Parameters
- T extends keyof ParameterValue
Parameters
- name: T
- value: ParameterValue[T]
Returns this
- Defined in lib/five/model/parameter.ts:488
set(values: Partial<ParameterValue>): this
Parameters
- values: Partial<ParameterValue>
Returns this
- Defined in lib/five/model/parameter.ts:489

`Static`createDefault

createDefault(): Required<ParameterValue>
Returns Required<ParameterValue>
- Defined in lib/five/model/parameter.ts:405

`Static`resolveValue

resolveValue<T extends keyof ParameterValue>(
name: T,
...parameterValues: Partial<ParameterValue>[],
): ParameterValue[T]
Type Parameters
- T extends keyof ParameterValue
Parameters
- name: T
- ...parameterValues: Partial<ParameterValue>[]
Returns ParameterValue[T]
- Defined in lib/five/model/parameter.ts:423
resolveValue(
...parameterValues: Partial<ParameterValue>[],
): ResolvedParameterValue
Parameters
- ...parameterValues: Partial<ParameterValue>[]
Returns ResolvedParameterValue
- Defined in lib/five/model/parameter.ts:424

`Static`resolveValueTo

resolveValueTo(
target: Partial<ResolvedParameterValue>,
...parameterValues: Partial<ParameterValue>[],
): ResolvedParameterValue
Parameters
- target: Partial<ResolvedParameterValue>
- ...parameterValues: Partial<ParameterValue>[]
Returns ResolvedParameterValue
- Defined in lib/five/model/parameter.ts:409

Class Parameter

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Parameter

Properties

Optional ReadonlyboundingBox

Optional Readonlybrightness

Optional ReadonlycacheCameras

Optional ReadonlycameraCulling

Optional ReadonlycastShadow

Optional Readonlyclippers

Optional ReadonlycolorBrightness

Optional ReadonlycolorSaturation

Optional ReadonlycolorStyle

Optional ReadonlyconstantColor

Optional ReadonlycustomShaders

Optional ReadonlydistanceGain

Optional ReadonlyfloorStyle

Optional ReadonlygaussianSplattingSHDegree

Optional ReadonlygradientTexture

id

Optional ReadonlyloadSiblings

Optional ReadonlymaxGeometricError

Optional ReadonlymaxLevelOfDetail

Optional ReadonlymaxMemoryUsage

Optional ReadonlymaxRequests

Optional ReadonlymaxScreenSpaceError

Optional ReadonlymemoryAdjustedScreenSpaceError

Optional ReadonlyminGeometricError

Optional ReadonlyminLevelOfDetail

Optional ReadonlymodelAlpha

Optional ReadonlymostDetail

Optional Readonlyopacity

Optional ReadonlyoutlineGain

Optional Readonlypano0

Optional Readonlypano0Depth

Optional Readonlypano1

Optional Readonlypano1Depth

Optional ReadonlypanoFilter

Optional ReadonlypanoramaMinGeometricError

Optional ReadonlypointAppearAnimation

Optional ReadonlypointBack

Optional ReadonlypointMaxPixel

Optional ReadonlypointMinPixel

Optional ReadonlypointScale

Optional ReadonlypointShape

Optional ReadonlypointSize

Optional Readonlyprogress

Optional ReadonlyreceiveShadow

Optional ReadonlyrefinedScreen

Optional ReadonlyrequestOrder

Optional ReadonlyshownFloorIndex

Optional ReadonlyskipLevelOfDetail

Optional Readonlytransition

Optional ReadonlyuseAddBlend

Optional ReadonlyuseHQDepth

Optional ReadonlyuseHQWeight

versionNumber

Optional ReadonlyvertexMarks

Methods

copy

Parameters

Returns this

reset

Parameters

Returns this

resetAll

Returns this

resolveValue

Type Parameters

Parameters

Returns ParameterValue[T]

Parameters

Returns ResolvedParameterValue

`Optional` `Readonly`boundingBox

`Optional` `Readonly`brightness

`Optional` `Readonly`cacheCameras

`Optional` `Readonly`cameraCulling

`Optional` `Readonly`castShadow

`Optional` `Readonly`clippers

`Optional` `Readonly`colorBrightness

`Optional` `Readonly`colorSaturation

`Optional` `Readonly`colorStyle

`Optional` `Readonly`constantColor

`Optional` `Readonly`customShaders

`Optional` `Readonly`distanceGain

`Optional` `Readonly`floorStyle

`Optional` `Readonly`gaussianSplattingSHDegree

`Optional` `Readonly`gradientTexture

`Optional` `Readonly`loadSiblings

`Optional` `Readonly`maxGeometricError

`Optional` `Readonly`maxLevelOfDetail

`Optional` `Readonly`maxMemoryUsage

`Optional` `Readonly`maxRequests

`Optional` `Readonly`maxScreenSpaceError

`Optional` `Readonly`memoryAdjustedScreenSpaceError

`Optional` `Readonly`minGeometricError

`Optional` `Readonly`minLevelOfDetail

`Optional` `Readonly`modelAlpha

`Optional` `Readonly`mostDetail

`Optional` `Readonly`opacity

`Optional` `Readonly`outlineGain

`Optional` `Readonly`pano0

`Optional` `Readonly`pano0Depth

`Optional` `Readonly`pano1

`Optional` `Readonly`pano1Depth

`Optional` `Readonly`panoFilter

`Optional` `Readonly`panoramaMinGeometricError

`Optional` `Readonly`pointAppearAnimation

`Optional` `Readonly`pointBack

`Optional` `Readonly`pointMaxPixel

`Optional` `Readonly`pointMinPixel

`Optional` `Readonly`pointScale

`Optional` `Readonly`pointShape

`Optional` `Readonly`pointSize

`Optional` `Readonly`progress

`Optional` `Readonly`receiveShadow

`Optional` `Readonly`refinedScreen

`Optional` `Readonly`requestOrder

`Optional` `Readonly`shownFloorIndex

`Optional` `Readonly`skipLevelOfDetail

`Optional` `Readonly`transition

`Optional` `Readonly`useAddBlend

`Optional` `Readonly`useHQDepth

`Optional` `Readonly`useHQWeight

`Optional` `Readonly`vertexMarks

`Static`createDefault

`Static`resolveValue

`Static`resolveValueTo