M3D / M3D / Animation / Path

Class: Path

M3D.Animation.Path

Memberof

M3D.Animation

Author

YF

Description

动画路径类

Date

2022-1-12

Version

1.0

Copyright

All Rights Reserved. Copyright (C) 2022 HOTEAMSOFT, Ltd

Hierarchy

• PolyLine

  ↳ Path

Table of contents

Constructors

• constructor

Properties

• id
• count
• isProto
• pVertexHeader

Accessors

• isProto

Methods

• addEffect
• addIndex
• addPoint
• clear
• computeBox
• getAlpha
• getBoundingBox
• getColor
• getDrawables
• getEffect
• getEvents
• getId
• getIsFrontShow
• getLineWidth
• getLocalTransform
• getMatrix
• getName
• getNeedClip
• getObjectId
• getParameters
• getPoints
• getPosByIdx
• getPosition
• getProperties
• getProto
• getRenderShapes
• getRenderType
• getRotation
• getScene
• getShaderProgramName
• getShapeType
• getStates
• getTextureObject
• getVertexHeader
• getVertexSet
• getWorldBoundingBox
• getWorldTransform
• insertPoint
• isNeedUpdate
• isPreSelected
• isSelected
• isVisible
• post
• registerEvent
• removeEffect
• removeEvent
• removePoint
• removePoints
• send
• sendClipMessage
• sendEffectMessage
• setAlpha
• setBillboard
• setBuffer
• setColor
• setEffect
• setFrontShow
• setId
• setLineType
• setLineWidth
• setName
• setNeedClip
• setNeedUpdate
• setObjectId
• setPosition
• setScene
• setSelected
• setShaderProgramName
• setShapeType
• setVisible
• setWorldTransform
• update

Constructors

constructor

• new Path(): Path

Returns

Path

Memberof

Path

Description

动画路径类构造函数

Overrides

PolyLine.constructor

Properties

id

• id: number

Inherited from

PolyLine.id

---

count

▪ Static count: number

Inherited from

PolyLine.count

---

isProto

▪ Static isProto: string

Inherited from

PolyLine.isProto

---

pVertexHeader

▪ Static pVertexHeader: string

Inherited from

PolyLine.pVertexHeader

Accessors

isProto

• get isProto(): boolean

Returns

boolean

Description

获取是否为原型对象

Inherited from

M3D.Shapes.PolyLine.isProto

• set isProto(v): void

Parameters

Name	Type
v	boolean

Returns

void

Description

设置是否为原型对象

Inherited from

M3D.Shapes.PolyLine.isProto

Methods

addEffect

▸ addEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

添加特效效果

Inherited from

PolyLine.addEffect

---

addIndex

▸ addIndex(index): void

Parameters

Name	Type
index	number

Returns

void

Description

添加索引

Inherited from

PolyLine.addIndex

---

addPoint

▸ addPoint(point): void

Parameters

Name	Type
point	Vector3

Returns

void

Description

添加折线经过的点

Inherited from

PolyLine.addPoint

---

clear

▸ clear(): void

Returns

void

Description

清空折线上的点

Inherited from

PolyLine.clear

---

computeBox

▸ computeBox(): void

Returns

void

Inherited from

PolyLine.computeBox

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

PolyLine.getAlpha

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取包围盒

Inherited from

PolyLine.getBoundingBox

---

getColor

▸ getColor(): Color

Returns

Color

Description

获取路径颜色

Memberof

Path

Overrides

PolyLine.getColor

---

getDrawables

▸ getDrawables(): void

Returns

void

Description

获取渲染数据

Inherited from

PolyLine.getDrawables

---

getEffect

▸ getEffect(): number

Returns

number

Description

获取效果

Inherited from

PolyLine.getEffect

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

PolyLine.getEvents

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

PolyLine.getId

---

getIsFrontShow

▸ getIsFrontShow(): boolean

Returns

boolean

Description

是否最前端显示

Inherited from

PolyLine.getIsFrontShow

---

getLineWidth

▸ getLineWidth(): number

Returns

number

Description

获取线粗细

Inherited from

PolyLine.getLineWidth

---

getLocalTransform

▸ getLocalTransform(): Matrix4

Returns

Matrix4

Description

获取shape的局部矩阵

Inherited from

PolyLine.getLocalTransform

---

getMatrix

▸ getMatrix(camera): Matrix4

Parameters

Name	Type
camera	Camera

Returns

Matrix4

Description

获取绘制矩阵

Inherited from

PolyLine.getMatrix

---

getName

▸ getName(): string

Returns

string

Description

获取名称

Inherited from

PolyLine.getName

---

getNeedClip

▸ getNeedClip(): boolean

Returns

boolean

Description

获取是否需要剖切

Inherited from

PolyLine.getNeedClip

---

getObjectId

▸ getObjectId(): number

Returns

number

Description

获取ObjectId

Inherited from

PolyLine.getObjectId

---

getParameters

▸ getParameters(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取生成属性数据的参数

Inherited from

PolyLine.getParameters

---

getPoints

▸ getPoints(): number[]

Returns

number[]

Description

获取线上所有点

Inherited from

PolyLine.getPoints

---

getPosByIdx

▸ getPosByIdx(idx): Vector3

Parameters

Name	Type
idx	number

Returns

Vector3

Description

根据索引获取点的坐标

Memberof

Path

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取位置

Inherited from

PolyLine.getPosition

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

PolyLine.getProperties

---

getProto

▸ getProto(): Shape

Returns

Shape

Description

获取原型

Inherited from

PolyLine.getProto

---

getRenderShapes

▸ getRenderShapes(): RenderableShape[]

Returns

RenderableShape[]

Description

获取可绘制对象列表

Inherited from

PolyLine.getRenderShapes

---

getRenderType

▸ getRenderType(): PrimitiveType

Returns

PrimitiveType

Description

获取渲染类型

Inherited from

PolyLine.getRenderType

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取空间旋转信息

Inherited from

PolyLine.getRotation

---

getScene

▸ getScene(): Scene

Returns

Scene

场景对象

Description

获取场景对象

Inherited from

PolyLine.getScene

---

getShaderProgramName

▸ getShaderProgramName(): string

Returns

string

Description

获取渲染用着色器名称

Inherited from

PolyLine.getShaderProgramName

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

PolyLine.getShapeType

---

getStates

▸ getStates(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取生成state数据的参数

Inherited from

PolyLine.getStates

---

getTextureObject

▸ getTextureObject(): ShapeParameter[]

Returns

ShapeParameter[]

Description

获取纹理数据

Inherited from

PolyLine.getTextureObject

---

getVertexHeader

▸ getVertexHeader(): VertexHeader

Returns

VertexHeader

Description

获取顶点

Overrides

PolyLine.getVertexHeader

---

getVertexSet

▸ getVertexSet(): VertexSet

Returns

VertexSet

Description

获取vertexSet

Inherited from

PolyLine.getVertexSet

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取世界包围盒

Inherited from

PolyLine.getWorldBoundingBox

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取shape的世界矩阵

Inherited from

PolyLine.getWorldTransform

---

insertPoint

▸ insertPoint(index, pnt): void

Parameters

Name	Type
index	number
pnt	Vector3

Returns

void

Description

插入点

Inherited from

PolyLine.insertPoint

---

isNeedUpdate

▸ isNeedUpdate(): boolean

Returns

boolean

Description

获取是否需要更新Buffer数据

Inherited from

PolyLine.isNeedUpdate

---

isPreSelected

▸ isPreSelected(): boolean

Returns

boolean

Description

是否预选中

Inherited from

PolyLine.isPreSelected

---

isSelected

▸ isSelected(): boolean

Returns

boolean

Description

是否被选中

Inherited from

PolyLine.isSelected

---

isVisible

▸ isVisible(orginVisible?): boolean

Parameters

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

Returns

boolean

Description

获取可见性

Inherited from

PolyLine.isVisible

---

post

▸ post(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

PolyLine.post

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

PolyLine.registerEvent

---

removeEffect

▸ removeEffect(effectType): void

Parameters

Name	Type
effectType	EffectType

Returns

void

Description

移除效果

Inherited from

PolyLine.removeEffect

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

PolyLine.removeEvent

---

removePoint

▸ removePoint(index): void

Parameters

Name	Type
index	number

Returns

void

Description

删除点

Inherited from

PolyLine.removePoint

---

removePoints

▸ removePoints(): void

Returns

void

Description

清除所有点

Inherited from

PolyLine.removePoints

---

send

▸ send(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

PolyLine.send

---

sendClipMessage

▸ sendClipMessage(): void

Returns

void

Description

发送剖切更新消息

Inherited from

PolyLine.sendClipMessage

---

sendEffectMessage

▸ sendEffectMessage(): void

Returns

void

Description

发送特效更新消息

Inherited from

PolyLine.sendEffectMessage

---

setAlpha

▸ setAlpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Description

设置透明度

Inherited from

PolyLine.setAlpha

---

setBillboard

▸ setBillboard(billboard): void

Parameters

Name	Type
billboard	BillBoard

Returns

void

Description

设置面板

Inherited from

PolyLine.setBillboard

---

setBuffer

▸ setBuffer(vertexNum, vertexBuf, indexNum, indexBuf): void

Parameters

Name	Type
vertexNum	number
vertexBuf	number[]
indexNum	number
indexBuf	number[]

Returns

void

Description

设置buff

Inherited from

PolyLine.setBuffer

---

setColor

▸ setColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置路径颜色

Memberof

Path

Overrides

PolyLine.setColor

---

setEffect

▸ setEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

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

Inherited from

PolyLine.setEffect

---

setFrontShow

▸ setFrontShow(frontShow): void

Parameters

Name	Type
frontShow	boolean

Returns

void

Description

设置最前端显示

Inherited from

PolyLine.setFrontShow

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

PolyLine.setId

---

setLineType

▸ setLineType(lineType): void

Parameters

Name	Type
lineType	CurvePatternMode

Returns

void

Description

设置线的类型

Inherited from

PolyLine.setLineType

---

setLineWidth

▸ setLineWidth(width): void

Parameters

Name	Type
width	number

Returns

void

Description

设置线粗细

Inherited from

PolyLine.setLineWidth

---

setName

▸ setName(name): void

Parameters

Name	Type
name	string

Returns

void

Description

设置名称

Inherited from

PolyLine.setName

---

setNeedClip

▸ setNeedClip(isClip): void

Parameters

Name	Type
isClip	boolean

Returns

void

Description

设置是否需要剖切

Inherited from

PolyLine.setNeedClip

---

setNeedUpdate

▸ setNeedUpdate(update): void

Parameters

Name	Type
update	boolean

Returns

void

Description

设置是否需要更新Buffer数据

Inherited from

PolyLine.setNeedUpdate

---

setObjectId

▸ setObjectId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置ObjectId

Inherited from

PolyLine.setObjectId

---

setPosition

▸ setPosition(postion): void

Parameters

Name	Type	Description
postion	Vector3	位置

Returns

void

Description

设置位置

Inherited from

PolyLine.setPosition

---

setScene

▸ setScene(scene): void

Parameters

Name	Type	Description
scene	Scene	场景对象

Returns

void

Description

设置场景对象

Inherited from

PolyLine.setScene

---

setSelected

▸ setSelected(selected): void

Parameters

Name	Type
selected	boolean

Returns

void

Description

设置是否被选中

Inherited from

PolyLine.setSelected

---

setShaderProgramName

▸ setShaderProgramName(name): void

Parameters

Name	Type
name	string

Returns

void

Description

设置渲染用program名字

Inherited from

PolyLine.setShaderProgramName

---

setShapeType

▸ setShapeType(v): void

Parameters

Name	Type	Description
v	ShapeType	类型

Returns

void

Description

设置类型

Inherited from

PolyLine.setShapeType

---

setVisible

▸ setVisible(visible, originVisible?): void

Parameters

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

Returns

void

Description

设置是否可见

Inherited from

PolyLine.setVisible

---

setWorldTransform

▸ setWorldTransform(matrix): void

Parameters

Name	Type
matrix	Matrix4

Returns

void

Description

设置世界矩阵

Inherited from

PolyLine.setWorldTransform

---

update

▸ update(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息接收者必须实现方法

Inherited from

PolyLine.update