M3D / M3D / Shapes / Background

Class: Background

M3D.Shapes.Background

Memberof

M3D.Shapes

Description

背景类

Author

ss

Hierarchy

• RenderableShape

  ↳ Background

Table of contents

Constructors

• constructor

Properties

• id
• blueSky
• count
• isProto
• pVertexHeader
• street

Accessors

• isProto

Methods

• addEffect
• addSkyBoxImage
• clearSkyBoxImage
• getAlpha
• getBackColor
• getBackImagePosition
• getBackPnt
• getBottomColor
• getBoundingBox
• getCamera
• getColor
• getDrawables
• getEffect
• getEvents
• getId
• getIsFrontShow
• getIsUseColor
• getIsUseImage
• getIsUseSkyBox
• getLocalTransform
• getName
• getNeedClip
• getObjectId
• getParameters
• getPosition
• getProjectionArr
• getProperties
• getProto
• getRenderShapes
• getRotation
• getScene
• getShaderProgramName
• getShapeType
• getStates
• getTextCoords
• getTextureObject
• getTopColor
• getType
• getVertexHeader
• getVertexSet
• getWorldBoundingBox
• getWorldTransform
• isNeedUpdate
• isPreSelected
• isSelected
• isVisible
• post
• registerEvent
• removeEffect
• removeEvent
• reset
• send
• sendClipMessage
• sendEffectMessage
• setAlpha
• setBottomColor
• setColor
• setEffect
• setFrontShow
• setId
• setImage
• setName
• setNeedClip
• setNeedUpdate
• setObjectId
• setPosition
• setScene
• setSelected
• setShaderProgramName
• setShapeType
• setTopColor
• setType
• setUseColor
• setUseImage
• setUseSkyBox
• setVisible
• setWorldTransform
• update

Constructors

constructor

• new Background(scene?): Background

Parameters

Name	Type
scene?	Scene

Returns

Background

Description

构造函数

Overrides

RenderableShape.constructor

Properties

id

• id: number

Inherited from

RenderableShape.id

---

blueSky

▪ Static blueSky: string

---

count

▪ Static count: number

Inherited from

RenderableShape.count

---

isProto

▪ Static isProto: string

Inherited from

RenderableShape.isProto

---

pVertexHeader

▪ Static pVertexHeader: string

Inherited from

RenderableShape.pVertexHeader

---

street

▪ Static street: string

Accessors

isProto

• get isProto(): boolean

Returns

boolean

Description

获取是否为原型对象

Inherited from

RenderableShape.isProto

• set isProto(v): void

Parameters

Name	Type
v	boolean

Returns

void

Description

设置是否为原型对象

Inherited from

RenderableShape.isProto

Methods

addEffect

▸ addEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

添加特效效果

Inherited from

RenderableShape.addEffect

---

addSkyBoxImage

▸ addSkyBoxImage(path): void

Parameters

Name	Type	Description
path	string	图片路径

Returns

void

Description

添加天空盒图片

---

clearSkyBoxImage

▸ clearSkyBoxImage(): void

Returns

void

Description

清空天空盒图片

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

RenderableShape.getAlpha

---

getBackColor

▸ getBackColor(): Float32Array

Returns

Float32Array

Description

获取背景颜色

---

getBackImagePosition

▸ getBackImagePosition(): Float32Array

Returns

Float32Array

Description

获取背景图片位置

---

getBackPnt

▸ getBackPnt(): Float32Array

Returns

Float32Array

Description

获取背景位置

---

getBottomColor

▸ getBottomColor(): Color

Returns

Color

底部颜色

Description

获取背景底部颜色

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取包围盒

Inherited from

RenderableShape.getBoundingBox

---

getCamera

▸ getCamera(): Camera

Returns

Camera

天空盒所需相机

Description

获取天空盒所需相机

---

getColor

▸ getColor(): Color

Returns

Color

Description

获取颜色

Inherited from

RenderableShape.getColor

---

getDrawables

▸ getDrawables(): void

Returns

void

Description

获取渲染数据

Inherited from

RenderableShape.getDrawables

---

getEffect

▸ getEffect(): number

Returns

number

Description

获取效果

Inherited from

RenderableShape.getEffect

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

RenderableShape.getEvents

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

RenderableShape.getId

---

getIsFrontShow

▸ getIsFrontShow(): boolean

Returns

boolean

Description

获取是否前端显示

Inherited from

RenderableShape.getIsFrontShow

---

getIsUseColor

▸ getIsUseColor(): boolean

Returns

boolean

true使用颜色背景 false不使用颜色背景

Description

获取是否使用颜色

---

getIsUseImage

▸ getIsUseImage(): boolean

Returns

boolean

true使用图片 false不使用图片

Description

获取是否使用图片

---

getIsUseSkyBox

▸ getIsUseSkyBox(): boolean

Returns

boolean

true使用天空盒 false不使用天空盒

Description

获取是否使用天空盒

---

getLocalTransform

▸ getLocalTransform(): Matrix4

Returns

Matrix4

Description

获取shape的局部矩阵

Inherited from

RenderableShape.getLocalTransform

---

getName

▸ getName(): string

Returns

string

Description

获取实例名称

Inherited from

RenderableShape.getName

---

getNeedClip

▸ getNeedClip(): boolean

Returns

boolean

Description

获取是否需要剖切

Inherited from

RenderableShape.getNeedClip

---

getObjectId

▸ getObjectId(): number

Returns

number

Description

获取ObjectId

Inherited from

RenderableShape.getObjectId

---

getParameters

▸ getParameters(): ShapeParameter[]

Returns

ShapeParameter[]

绘制参数

Description

获取参数

Overrides

RenderableShape.getParameters

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取位置

Inherited from

RenderableShape.getPosition

---

getProjectionArr

▸ getProjectionArr(): Float32Array

Returns

Float32Array

Description

获取投影数据

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

RenderableShape.getProperties

---

getProto

▸ getProto(): Shape

Returns

Shape

Description

获取原型

Inherited from

RenderableShape.getProto

---

getRenderShapes

▸ getRenderShapes(): RenderableShape[]

Returns

RenderableShape[]

Description

获取可绘制对象列表

Inherited from

RenderableShape.getRenderShapes

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取空间旋转信息

Inherited from

RenderableShape.getRotation

---

getScene

▸ getScene(): Scene

Returns

Scene

场景对象

Description

获取场景对象

Inherited from

RenderableShape.getScene

---

getShaderProgramName

▸ getShaderProgramName(): string

Returns

string

着色器名称

Description

获取渲染用的shaderProgramName

Overrides

RenderableShape.getShaderProgramName

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

RenderableShape.getShapeType

---

getStates

▸ getStates(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取状态

Inherited from

RenderableShape.getStates

---

getTextCoords

▸ getTextCoords(): Float32Array

Returns

Float32Array

Description

获取背景图片纹理

---

getTextureObject

▸ getTextureObject(): ShapeParameter[]

Returns

ShapeParameter[]

纹理信息

Description

获取纹理信息

Overrides

RenderableShape.getTextureObject

---

getTopColor

▸ getTopColor(): Color

Returns

Color

顶部颜色

Description

获取背景顶部颜色

---

getType

▸ getType(): BackgroundType

Returns

BackgroundType

背景类型

Description

获取背景类型

---

getVertexHeader

▸ getVertexHeader(): VertexHeader

Returns

VertexHeader

Description

获取VertexHeader

Overrides

RenderableShape.getVertexHeader

---

getVertexSet

▸ getVertexSet(): VertexSet

Returns

VertexSet

Description

获取vertexSet

Inherited from

RenderableShape.getVertexSet

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取世界包围盒

Inherited from

RenderableShape.getWorldBoundingBox

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取shape的世界矩阵

Inherited from

RenderableShape.getWorldTransform

---

isNeedUpdate

▸ isNeedUpdate(): boolean

Returns

boolean

Description

获取是否需要更新Buffer数据

Inherited from

RenderableShape.isNeedUpdate

---

isPreSelected

▸ isPreSelected(): boolean

Returns

boolean

Description

是否预选中

Inherited from

RenderableShape.isPreSelected

---

isSelected

▸ isSelected(): boolean

Returns

boolean

Description

是否被选中

Inherited from

RenderableShape.isSelected

---

isVisible

▸ isVisible(orginVisible?): boolean

Parameters

Name	Type	Description
orginVisible?	boolean	是否获取原始可见性

Returns

boolean

Description

获取可见性

Inherited from

RenderableShape.isVisible

---

post

▸ post(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

RenderableShape.post

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

RenderableShape.registerEvent

---

removeEffect

▸ removeEffect(effectType): void

Parameters

Name	Type
effectType	EffectType

Returns

void

Description

移除效果

Inherited from

RenderableShape.removeEffect

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

RenderableShape.removeEvent

---

reset

▸ reset(): void

Returns

void

Description

背景重置

---

send

▸ send(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

RenderableShape.send

---

sendClipMessage

▸ sendClipMessage(): void

Returns

void

Description

发送剖切更新消息

Inherited from

RenderableShape.sendClipMessage

---

sendEffectMessage

▸ sendEffectMessage(): void

Returns

void

Description

发送特效更新消息

Inherited from

RenderableShape.sendEffectMessage

---

setAlpha

▸ setAlpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Description

设置透明度

Inherited from

RenderableShape.setAlpha

---

setBottomColor

▸ setBottomColor(color): void

Parameters

Name	Type	Description
color	Color	底部颜色

Returns

void

Description

设置背景底部颜色

---

setColor

▸ setColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置颜色

Inherited from

RenderableShape.setColor

---

setEffect

▸ setEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

设置效果，包括高亮、轮廓等

Inherited from

RenderableShape.setEffect

---

setFrontShow

▸ setFrontShow(frontShow): void

Parameters

Name	Type
frontShow	boolean

Returns

void

Description

设置是否前端显示

Inherited from

RenderableShape.setFrontShow

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

RenderableShape.setId

---

setImage

▸ setImage(filePath): void

Parameters

Name	Type	Description
filePath	string	图片路径

Returns

void

Description

设置路径

---

setName

▸ setName(name): void

Parameters

Name	Type	Description
name	string	名称

Returns

void

Description

设置实例名称

Inherited from

RenderableShape.setName

---

setNeedClip

▸ setNeedClip(isClip): void

Parameters

Name	Type
isClip	boolean

Returns

void

Description

设置是否需要剖切

Inherited from

RenderableShape.setNeedClip

---

setNeedUpdate

▸ setNeedUpdate(update): void

Parameters

Name	Type
update	boolean

Returns

void

Description

设置是否需要更新Buffer数据

Inherited from

RenderableShape.setNeedUpdate

---

setObjectId

▸ setObjectId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置ObjectId

Inherited from

RenderableShape.setObjectId

---

setPosition

▸ setPosition(postion): void

Parameters

Name	Type	Description
postion	Vector3	位置

Returns

void

Description

设置位置

Inherited from

RenderableShape.setPosition

---

setScene

▸ setScene(scene): void

Parameters

Name	Type	Description
scene	Scene	场景对象

Returns

void

Description

设置场景对象

Inherited from

RenderableShape.setScene

---

setSelected

▸ setSelected(selected): void

Parameters

Name	Type
selected	boolean

Returns

void

Description

设置是否被选中

Inherited from

RenderableShape.setSelected

---

setShaderProgramName

▸ setShaderProgramName(name): void

Parameters

Name	Type
name	string

Returns

void

Description

设置渲染用program名字

Inherited from

RenderableShape.setShaderProgramName

---

setShapeType

▸ setShapeType(v): void

Parameters

Name	Type	Description
v	ShapeType	类型

Returns

void

Description

设置类型

Inherited from

RenderableShape.setShapeType

---

setTopColor

▸ setTopColor(color): void

Parameters

Name	Type	Description
color	Color	顶部颜色

Returns

void

Description

设置背景顶部颜色

---

setType

▸ setType(type): void

Parameters

Name	Type	Description
type	BackgroundType	背景类型

Returns

void

Description

设置背景类型

---

setUseColor

▸ setUseColor(useColor): void

Parameters

Name	Type	Description
useColor	boolean	是否使用颜色背景

Returns

void

Description

设置是否使用颜色背景

---

setUseImage

▸ setUseImage(useImage): void

Parameters

Name	Type	Description
useImage	boolean	是否使用图片

Returns

void

Description

设置是否使用图片

---

setUseSkyBox

▸ setUseSkyBox(useSkyBox): void

Parameters

Name	Type	Description
useSkyBox	boolean	是否使用天空盒

Returns

void

Description

设置是否使用天空盒

---

setVisible

▸ setVisible(visible, originVisible?): void

Parameters

Name	Type	Description
visible	boolean	是否可见 boolean类型
originVisible?	boolean	-

Returns

void

Description

设置是否可见

Inherited from

RenderableShape.setVisible

---

setWorldTransform

▸ setWorldTransform(matrix): void

Parameters

Name	Type
matrix	Matrix4

Returns

void

Description

设置世界矩阵

Inherited from

RenderableShape.setWorldTransform

---

update

▸ update(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息接收者必须实现方法

Inherited from

RenderableShape.update