M3D / M3D / Shapes / Image

Class: Image

M3D.Shapes.Image

Memberof

M3D.Shapes

Implements

Utility.Subscriber

Description

图片对象

Hierarchy

• RenderableShape

  ↳ Image

Implements

• Subscriber

Table of contents

Constructors

• constructor

Properties

• id
• count
• isProto
• pVertexHeader

Accessors

• isProto

Methods

• addEffect
• addImagePath
• allowRotate
• allowScale
• allowTran
• getAllowClip
• getAlpha
• getBillBoard
• getBoundingBox
• getColor
• getDrawables
• getEffect
• getEvents
• getFilpV
• getFixShowInScreen
• getFrontShow
• getHorizontal
• getId
• getImagePath
• getIsFrontShow
• getIsLocalPos
• getLocalPos
• getLocalTransform
• getMatrix
• getName
• getNeedClip
• getObjectId
• getOrigSize
• getParameters
• getPosition
• getProperties
• getProto
• getRenderColor
• getRenderShapes
• getRotation
• getScene
• getShaderProgramName
• getShapeType
• getState
• getStates
• getTextureObject
• getVertexHeader
• getVertexSet
• getVertical
• getWorldBoundingBox
• getWorldTransform
• isAllowRotate
• isAllowScale
• isAllowTran
• isDirty
• isNeedUpdate
• isPreSelected
• isSelected
• isVisible
• markDirty
• post
• registerEvent
• removeEffect
• removeEvent
• send
• sendClipMessage
• sendEffectMessage
• set
• setAchorType
• setAllowClip
• setAlpha
• setColor
• setEffect
• setFilpV
• setFixShowInScreen
• setFrontShow
• setHorizontal
• setId
• setIsLocalPos
• setLocalPos
• setName
• setNeedClip
• setNeedUpdate
• setObjectId
• setOrigSize
• setPosition
• setRenderColor
• setScene
• setSelected
• setShaderProgramName
• setShapeType
• setTextureObject
• setVertical
• setVisible
• setWorldTransform
• update

Constructors

constructor

• new Image(): Image

Returns

Image

Description

构造函数

Overrides

RenderableShape.constructor

• new Image(pos, size): Image

Parameters

Name	Type
pos	Vector3
size	Vector2

Returns

Image

Description

构造函数

Overrides

RenderableShape.constructor

Properties

id

• id: number

Inherited from

RenderableShape.id

---

count

▪ Static count: number

Inherited from

RenderableShape.count

---

isProto

▪ Static isProto: string

Inherited from

RenderableShape.isProto

---

pVertexHeader

▪ Static pVertexHeader: string

Inherited from

RenderableShape.pVertexHeader

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

---

addImagePath

▸ addImagePath(path): void

Parameters

Name	Type
path	string

Returns

void

Description

添加图片路径

---

allowRotate

▸ allowRotate(allow): void

Parameters

Name	Type
allow	boolean

Returns

void

Description

是否允许旋转

---

allowScale

▸ allowScale(allow): void

Parameters

Name	Type
allow	boolean

Returns

void

Description

是否允许缩放

---

allowTran

▸ allowTran(allow): void

Parameters

Name	Type	Description
allow	boolean	true允许 false 不允许

Returns

void

Description

是否允许平移

---

getAllowClip

▸ getAllowClip(): boolean

Returns

boolean

Description

返回是否允许剖切

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

RenderableShape.getAlpha

---

getBillBoard

▸ getBillBoard(): BillBoard

Returns

BillBoard

Description

获取BillBoard

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取包围盒

Inherited from

RenderableShape.getBoundingBox

---

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

---

getFilpV

▸ getFilpV(): boolean

Returns

boolean

Description

获取是否翻转

---

getFixShowInScreen

▸ getFixShowInScreen(): number

Returns

number

Description

返回图片是否固定在屏幕上面显示

---

getFrontShow

▸ getFrontShow(): boolean

Returns

boolean

Description

是否最前端显示

---

getHorizontal

▸ getHorizontal(): Vector3

Returns

Vector3

Description

获取水平

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

RenderableShape.getId

---

getImagePath

▸ getImagePath(): string

Returns

string

Description

获取图片路径

---

getIsFrontShow

▸ getIsFrontShow(): boolean

Returns

boolean

Description

获取是否前端显示

Inherited from

RenderableShape.getIsFrontShow

---

getIsLocalPos

▸ getIsLocalPos(): boolean

Returns

boolean

Description

获取是否有固定位置

---

getLocalPos

▸ getLocalPos(): Vector2

Returns

Vector2

Description

获取固定位置

---

getLocalTransform

▸ getLocalTransform(): Matrix4

Returns

Matrix4

Description

获取shape的局部矩阵

Inherited from

RenderableShape.getLocalTransform

---

getMatrix

▸ getMatrix(camera, axis?): Matrix4

Parameters

Name	Type
camera	Camera
axis?	boolean

Returns

Matrix4

Description

获取绘制矩阵

---

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

---

getOrigSize

▸ getOrigSize(): Vector2

Returns

Vector2

Description

获取原始大小

---

getParameters

▸ getParameters(): ShapeParameter[]

Returns

ShapeParameter[]

Description

取生成属性数据的参数

Overrides

RenderableShape.getParameters

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取位置

Overrides

RenderableShape.getPosition

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

RenderableShape.getProperties

---

getProto

▸ getProto(): Shape

Returns

Shape

Description

获取原型

Inherited from

RenderableShape.getProto

---

getRenderColor

▸ getRenderColor(): Color

Returns

Color

Description

获取渲染颜色

---

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

获取渲染用的着色器名称

Overrides

RenderableShape.getShaderProgramName

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

RenderableShape.getShapeType

---

getState

▸ getState(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取生成state数据的参数

---

getStates

▸ getStates(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取状态

Inherited from

RenderableShape.getStates

---

getTextureObject

▸ getTextureObject(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取纹理信息

Overrides

RenderableShape.getTextureObject

---

getVertexHeader

▸ getVertexHeader(): VertexHeader

Returns

VertexHeader

Description

获取顶点

Overrides

RenderableShape.getVertexHeader

---

getVertexSet

▸ getVertexSet(): VertexSet

Returns

VertexSet

Description

获取vertexSet

Inherited from

RenderableShape.getVertexSet

---

getVertical

▸ getVertical(): Vector3

Returns

Vector3

Description

获取垂直

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取世界包围盒

Inherited from

RenderableShape.getWorldBoundingBox

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取shape的世界矩阵

Inherited from

RenderableShape.getWorldTransform

---

isAllowRotate

▸ isAllowRotate(): boolean

Returns

boolean

Description

返回允许平移状态

---

isAllowScale

▸ isAllowScale(): boolean

Returns

boolean

Description

返回允许平移状态

---

isAllowTran

▸ isAllowTran(): boolean

Returns

boolean

Description

返回允许平移状态

---

isDirty

▸ isDirty(): boolean

Returns

boolean

Description

获取脏标记

---

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

---

markDirty

▸ markDirty(dirty?): void

Parameters

Name	Type
dirty?	boolean

Returns

void

Description

设置脏标记

---

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

---

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

---

set

▸ set(position, size): void

Parameters

Name	Type
position	Vector3
size	Vector2

Returns

void

Description

设置位置大小

---

setAchorType

▸ setAchorType(anchorType): void

Parameters

Name	Type
anchorType	IBAnchorType

Returns

void

Description

设置锚定方式

---

setAllowClip

▸ setAllowClip(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

是否允许剖切

---

setAlpha

▸ setAlpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Description

设置透明度

Inherited from

RenderableShape.setAlpha

---

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

---

setFilpV

▸ setFilpV(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否翻转

---

setFixShowInScreen

▸ setFixShowInScreen(val): void

Parameters

Name	Type
val	number

Returns

void

Description

设置图片固定在屏幕上面显示

---

setFrontShow

▸ setFrontShow(frontShow): void

Parameters

Name	Type
frontShow	boolean

Returns

void

Description

设置最前端显示

Overrides

RenderableShape.setFrontShow

---

setHorizontal

▸ setHorizontal(horizontal): void

Parameters

Name	Type
horizontal	Vector3

Returns

void

Description

设置水平

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

RenderableShape.setId

---

setIsLocalPos

▸ setIsLocalPos(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置是否固定位置

---

setLocalPos

▸ setLocalPos(localPos): void

Parameters

Name	Type
localPos	Vector2

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

---

setOrigSize

▸ setOrigSize(position, size): void

Parameters

Name	Type
position	Vector3
size	Vector2

Returns

void

Description

设置原始位置大小

---

setPosition

▸ setPosition(position): void

Parameters

Name	Type
position	Vector3

Returns

void

Description

设置位置

Overrides

RenderableShape.setPosition

---

setRenderColor

▸ setRenderColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置渲染颜色

---

setScene

▸ setScene(scene): void

Parameters

Name	Type
scene	Scene

Returns

void

Description

设置场景

Overrides

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

---

setTextureObject

▸ setTextureObject(object): void

Parameters

Name	Type
object	TextureObject

Returns

void

Description

设置纹理对象

---

setVertical

▸ setVertical(vertical): void

Parameters

Name	Type
vertical	Vector3

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

消息更新

Implementation of

Subscriber.update

Overrides

RenderableShape.update