M3D / M3D / Config / ViewPortParameters

Class: ViewPortParameters

M3D.Config.ViewPortParameters

Hierarchy

• SParameters

  ↳ ViewPortParameters

Table of contents

Constructors

• constructor

Properties

• alpha
• axisPos
• backBottomColor
• backGroundImageUrl
• backTopColor
• backTransparent
• blockOut
• camera3dMode
• clipPlaneMode
• currentFPS
• defaultShowMode
• defaultViewType
• defaultZoomFactor
• displayOptimization
• doubleLight
• fieldSize
• iLodDefMethod
• iLodLevel
• instanceRender
• isConRotate
• isContinuousRender
• isFullScreenExpand
• isHighPerformanceView
• isMeshLevel
• isModelLevel
• isModelView
• isMulSelect
• isOnlyShowEdgeLine
• isOnlyShowTrilateralEdge
• isOpenLog
• isProgressiveRender
• isRender
• isShowAniTrochoid
• isShowAnnotation
• isShowAxis
• isShowAxisImage
• isShowBox
• isShowEdgeLine
• isShowFPS
• isShowPMIs
• isShowRotateCenter
• isShowSHotSpot
• isShowSceneBoxNote
• isShowSection
• isShowSubModelView
• isShowTransparent
• isShowTrilateralEdge
• isSpecifiedRotation
• isTechnicalView
• isTouchRotation
• isUseBoxMoving
• isUseIndexMode
• isUseLOD
• logLevel
• m_outlineWidth
• maxFPS
• modelSelectedColor
• mouseSensitivity
• multiInstanceRender
• neverSeeScreenPixelSize
• observeMode
• openFirstPersionCamera
• outlineColor
• outlineTransparency
• removeMode
• removeSize
• renderClassification
• selectedBoxColor
• selectedStyle
• simplityMode
• technicalViewDepthThreshold
• useBackGroundImage
• useCubeMapping
• useCubeMode
• useCullFace
• useLoadLowestLOD
• useModelBackgrund
• useWaterMark
• vecLodRate
• visualBodyRemoval
• waterMarkDrawRect
• waterMarkFontSize
• waterMarkResolution
• waterMarkRotation
• waterMarkStr

Methods

• add
• getBoolParameter
• getColorParameter
• getMapParameter
• getNumberParameter
• getParameter
• getParameters
• getParentParameters
• getStringParameter
• getVector2Parameter
• remove
• setBoolParameter
• setColorParameter
• setCookieParameter
• setDefault
• setMapParameter
• setNumberParameter
• setParameter
• setParameterByCookie
• setParentParameters
• setStringParameter
• setVector2Parameter
• getInstance

Constructors

constructor

• new ViewPortParameters(): ViewPortParameters

Returns

ViewPortParameters

Overrides

SParameters.constructor

Properties

alpha

• alpha: number

---

axisPos

• axisPos: any

---

backBottomColor

• backBottomColor: Color

---

backGroundImageUrl

• backGroundImageUrl: string

---

backTopColor

• backTopColor: Color

---

backTransparent

• backTransparent: boolean

---

blockOut

• blockOut: boolean

---

camera3dMode

• camera3dMode: any

---

clipPlaneMode

• clipPlaneMode: number

---

currentFPS

• currentFPS: number

---

defaultShowMode

• defaultShowMode: number

---

defaultViewType

• defaultViewType: number

---

defaultZoomFactor

• defaultZoomFactor: any

---

displayOptimization

• displayOptimization: boolean

---

doubleLight

• doubleLight: boolean

---

fieldSize

• fieldSize: number

---

iLodDefMethod

• iLodDefMethod: number

---

iLodLevel

• iLodLevel: number

---

instanceRender

• instanceRender: boolean

---

isConRotate

• isConRotate: boolean

---

isContinuousRender

• isContinuousRender: boolean

---

isFullScreenExpand

• isFullScreenExpand: boolean

---

isHighPerformanceView

• isHighPerformanceView: boolean

---

isMeshLevel

• isMeshLevel: any

---

isModelLevel

• isModelLevel: any

---

isModelView

• isModelView: any

---

isMulSelect

• isMulSelect: boolean

---

isOnlyShowEdgeLine

• isOnlyShowEdgeLine: boolean

---

isOnlyShowTrilateralEdge

• isOnlyShowTrilateralEdge: boolean

---

isOpenLog

• isOpenLog: boolean

---

isProgressiveRender

• isProgressiveRender: boolean

---

isRender

• isRender: boolean

---

isShowAniTrochoid

• isShowAniTrochoid: boolean

---

isShowAnnotation

• isShowAnnotation: boolean

---

isShowAxis

• isShowAxis: boolean

---

isShowAxisImage

• isShowAxisImage: boolean

---

isShowBox

• isShowBox: boolean

---

isShowEdgeLine

• isShowEdgeLine: boolean

---

isShowFPS

• isShowFPS: boolean

---

isShowPMIs

• isShowPMIs: boolean

---

isShowRotateCenter

• isShowRotateCenter: boolean

---

isShowSHotSpot

• isShowSHotSpot: boolean

---

isShowSceneBoxNote

• isShowSceneBoxNote: boolean

---

isShowSection

• isShowSection: boolean

---

isShowSubModelView

• isShowSubModelView: boolean

---

isShowTransparent

• isShowTransparent: boolean

---

isShowTrilateralEdge

• isShowTrilateralEdge: boolean

---

isSpecifiedRotation

• isSpecifiedRotation: boolean

---

isTechnicalView

• isTechnicalView: boolean

---

isTouchRotation

• isTouchRotation: boolean

---

isUseBoxMoving

• isUseBoxMoving: boolean

---

isUseIndexMode

• isUseIndexMode: boolean

---

isUseLOD

• isUseLOD: boolean

---

logLevel

• logLevel: number

---

m_outlineWidth

• m_outlineWidth: number

---

maxFPS

• maxFPS: number

---

modelSelectedColor

• modelSelectedColor: Color

---

mouseSensitivity

• mouseSensitivity: number

---

multiInstanceRender

• multiInstanceRender: boolean

---

neverSeeScreenPixelSize

• neverSeeScreenPixelSize: number

---

observeMode

• observeMode: number

---

openFirstPersionCamera

• openFirstPersionCamera: any

---

outlineColor

• outlineColor: Color

---

outlineTransparency

• outlineTransparency: number

---

removeMode

• removeMode: number

---

removeSize

• removeSize: number

---

renderClassification

• renderClassification: number

---

selectedBoxColor

• selectedBoxColor: Color

---

selectedStyle

• selectedStyle: number

---

simplityMode

• simplityMode: boolean

---

technicalViewDepthThreshold

• technicalViewDepthThreshold: number

---

useBackGroundImage

• useBackGroundImage: boolean

---

useCubeMapping

• useCubeMapping: boolean

---

useCubeMode

• useCubeMode: boolean

---

useCullFace

• useCullFace: boolean

---

useLoadLowestLOD

• useLoadLowestLOD: boolean

---

useModelBackgrund

• useModelBackgrund: boolean

---

useWaterMark

• useWaterMark: boolean

---

vecLodRate

• vecLodRate: number[]

---

visualBodyRemoval

• visualBodyRemoval: boolean

---

waterMarkDrawRect

• waterMarkDrawRect: Vector2

---

waterMarkFontSize

• waterMarkFontSize: number

---

waterMarkResolution

• waterMarkResolution: Vector2

---

waterMarkRotation

• waterMarkRotation: number

---

waterMarkStr

• waterMarkStr: string

Methods

add

▸ add(para): void

添加所属子配置项

Parameters

Name	Type
para	SParameters

Returns

void

Inherited from

SParameters.add

---

getBoolParameter

▸ getBoolParameter(key): boolean

Parameters

Name	Type	Description
key	string	key关键词

Returns

boolean

Description

获取boolean类型参数

Inherited from

SParameters.getBoolParameter

---

getColorParameter

▸ getColorParameter(key): Color

Parameters

Name	Type	Description
key	string	key关键词

Returns

Color

Description

获取Color类型参数

Inherited from

SParameters.getColorParameter

---

getMapParameter

▸ getMapParameter(key): Map<any, any>

Parameters

Name	Type	Description
key	string	key关键词

Returns

Map<any, any>

Description

获取map类型参数

Inherited from

SParameters.getMapParameter

---

getNumberParameter

▸ getNumberParameter(key): number

Parameters

Name	Type	Description
key	string	key关键词

Returns

number

Description

获取number类型参数

Inherited from

SParameters.getNumberParameter

---

getParameter

▸ getParameter(key): any

Parameters

Name	Type	Description
key	string	key关键词

Returns

any

Description

获取string类型参数

Inherited from

SParameters.getParameter

---

getParameters

▸ getParameters(para): SParameters

获取指定的 Parameters对象

Parameters

Name	Type
para	SParameters

Returns

SParameters

Inherited from

SParameters.getParameters

---

getParentParameters

▸ getParentParameters(): SParameters

Returns

SParameters

Inherited from

SParameters.getParentParameters

---

getStringParameter

▸ getStringParameter(key): string

Parameters

Name	Type	Description
key	string	key关键词

Returns

string

Description

获取string类型参数

Inherited from

SParameters.getStringParameter

---

getVector2Parameter

▸ getVector2Parameter(key): Vector2

Parameters

Name	Type	Description
key	string	key关键词

Returns

Vector2

Description

获取Vector2类型参数

Inherited from

SParameters.getVector2Parameter

---

remove

▸ remove(para): boolean

移除配置类，一般用不到该方法

Parameters

Name	Type
para	SParameters

Returns

boolean

Inherited from

SParameters.remove

---

setBoolParameter

▸ setBoolParameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	boolean	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置boolean类型参数

Overrides

SParameters.setBoolParameter

---

setColorParameter

▸ setColorParameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	string | Color	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置Color类型参数

Overrides

SParameters.setColorParameter

---

setCookieParameter

▸ setCookieParameter(key, value, all?): boolean

将配置项存到cookie中

Parameters

Name	Type
key	string
value	any
all?	boolean

Returns

boolean

Inherited from

SParameters.setCookieParameter

---

setDefault

▸ setDefault(): void

Returns

void

Description

恢复本层的设置

Overrides

SParameters.setDefault

---

setMapParameter

▸ setMapParameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	Map<any, any>	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置map类型参数

Inherited from

SParameters.setMapParameter

---

setNumberParameter

▸ setNumberParameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	number	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置number类型参数

Overrides

SParameters.setNumberParameter

---

setParameter

▸ setParameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	any	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置配置项

Overrides

SParameters.setParameter

---

setParameterByCookie

▸ setParameterByCookie(key, defaultValue): void

从cookie中取值

Parameters

Name	Type
key	string
defaultValue	any

Returns

void

Inherited from

SParameters.setParameterByCookie

---

setParentParameters

▸ setParentParameters(parentPara): void

Parameters

Name	Type
parentPara	SParameters

Returns

void

Inherited from

SParameters.setParentParameters

---

setStringParameter

▸ setStringParameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	string	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置string类型参数

Overrides

SParameters.setStringParameter

---

setVector2Parameter

▸ setVector2Parameter(key, value, all?): boolean

Parameters

Name	Type	Description
key	string	key关键词
value	string | Vector2	内容值
all?	boolean	是否设置所有层的该项配置 ，不止该层有的配置对象就要往下层继续设置

Returns

boolean

Description

设置Vector2类型参数

Overrides

SParameters.setVector2Parameter

---

getInstance

▸ getInstance(): ViewPortParameters

Returns

ViewPortParameters

Description

获得配置项（如果存在则返回现有配置项，如果没有则创建一个新的）

Overrides

SParameters.getInstance