M3D / M3D / Config / SParameters

Class: SParameters

M3D.Config.SParameters

Hierarchy

• SParameters

  ↳ LoaderParameters

  ↳ Parameters

  ↳ SceneParameters

  ↳ ViewPortParameters

  ↳ ShaderParameters

  ↳ ShaderTextureParameters

Table of contents

Constructors

• constructor

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 SParameters(): SParameters

Returns

SParameters

Description

构造函数，各自实现并指定属于父，并向父添加自己

Methods

add

▸ add(para): void

添加所属子配置项

Parameters

Name	Type
para	SParameters

Returns

void

---

getBoolParameter

▸ getBoolParameter(key): boolean

Parameters

Name	Type	Description
key	string	key关键词

Returns

boolean

Description

获取boolean类型参数

---

getColorParameter

▸ getColorParameter(key): Color

Parameters

Name	Type	Description
key	string	key关键词

Returns

Color

Description

获取Color类型参数

---

getMapParameter

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

Parameters

Name	Type	Description
key	string	key关键词

Returns

Map<any, any>

Description

获取map类型参数

---

getNumberParameter

▸ getNumberParameter(key): number

Parameters

Name	Type	Description
key	string	key关键词

Returns

number

Description

获取number类型参数

---

getParameter

▸ getParameter(key): any

Parameters

Name	Type	Description
key	string	key关键词

Returns

any

Description

获取string类型参数

---

getParameters

▸ getParameters(para): SParameters

获取指定的 Parameters对象

Parameters

Name	Type
para	SParameters

Returns

SParameters

---

getParentParameters

▸ getParentParameters(): SParameters

Returns

SParameters

---

getStringParameter

▸ getStringParameter(key): string

Parameters

Name	Type	Description
key	string	key关键词

Returns

string

Description

获取string类型参数

---

getVector2Parameter

▸ getVector2Parameter(key): Vector2

Parameters

Name	Type	Description
key	string	key关键词

Returns

Vector2

Description

获取Vector2类型参数

---

remove

▸ remove(para): boolean

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

Parameters

Name	Type
para	SParameters

Returns

boolean

---

setBoolParameter

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

Parameters

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

Returns

boolean

Description

设置boolean类型参数

---

setColorParameter

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

Parameters

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

Returns

boolean

Description

设置Color类型参数

---

setCookieParameter

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

将配置项存到cookie中

Parameters

Name	Type
key	string
value	any
all?	boolean

Returns

boolean

---

setDefault

▸ setDefault(): void

Returns

void

Description

恢复默认设置,各自重置所属的参数

---

setMapParameter

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

Parameters

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

Returns

boolean

Description

设置map类型参数

---

setNumberParameter

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

Parameters

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

Returns

boolean

Description

设置number类型参数

---

setParameter

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

Parameters

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

Returns

boolean

Description

设置配置项

---

setParameterByCookie

▸ setParameterByCookie(key, defaultValue): void

从cookie中取值

Parameters

Name	Type
key	string
defaultValue	any

Returns

void

---

setParentParameters

▸ setParentParameters(parentPara): void

Parameters

Name	Type
parentPara	SParameters

Returns

void

---

setStringParameter

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

Parameters

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

Returns

boolean

Description

设置string类型参数

---

setVector2Parameter

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

Parameters

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

Returns

boolean

Description

设置Vector2类型参数

---

getInstance

▸ getInstance(): SParameters

Returns

SParameters