M3D / M3D / Shapes / AreaHotSpot

Class: AreaHotSpot

M3D.Shapes.AreaHotSpot

Memberof

M3D.Shapes

Description

场景热点

Author

nhy

Date

2023-1-13

Version

1.0

Copyright

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

Hierarchy

• HotSpot

  ↳ AreaHotSpot

Table of contents

Constructors

• constructor

Properties

• id
• count
• isProto
• pVertexHeader

Accessors

• isProto

Methods

• addComText
• addEffect
• addImage
• addLine
• addOutFrame
• addPoint
• addPolyLine
• addText
• clear
• clearComText
• clearImage
• clearOutFrames
• clearPolyLines
• getAlpha
• getAreaId
• getAuthor
• getBoundingBox
• getCameraPosition
• getCameraProjectionType
• getCameraRotation
• getCameraZoom
• getColor
• getComTexts
• getCreateId
• getCreateTime
• getDescription
• getDrawables
• getEffect
• getEvents
• getFirstParentPath
• getFirstPosition
• getFrameLineList
• getGuid
• getId
• getImage
• getImageList
• getIsFrontShow
• getLineList
• getLocalTransform
• getName
• getNeedClip
• getObjectId
• getPoint
• getPointList
• getPolyLineList
• getPosition
• getProperties
• getProto
• getRenderShapes
• getRotation
• getScene
• getSecondParentPath
• getSecondPosition
• getShapeType
• getTextValue
• getWorldBoundingBox
• getWorldTransform
• initAttributes
• isDirty
• isPreSelected
• isSelected
• isVisible
• markDirty
• post
• registerEvent
• removeEffect
• removeEvent
• removeLine
• removePoint
• send
• sendClipMessage
• sendEffectMessage
• setAlpha
• setAreaId
• setAuthor
• setCameraPosition
• setCameraProjectionType
• setCameraRotation
• setCameraZoom
• setColor
• setCreateId
• setCreateTime
• setDescription
• setEffect
• setFirstParentPath
• setFirstPosition
• setFrontShow
• setGuid
• setId
• setImage
• setImagePosition
• setName
• setNeedClip
• setObjectId
• setPosition
• setScene
• setSecondParentPath
• setSecondPosition
• setSelected
• setShapeType
• setVisible
• setWorldTransform
• update

Constructors

constructor

• new AreaHotSpot(): AreaHotSpot

Returns

AreaHotSpot

Description

构造函数

Overrides

HotSpot.constructor

• new AreaHotSpot(scene, id, name, description, position, cameraPosition, cameraRotation, cameraZoom, cameraProjectionType, areaId): AreaHotSpot

Parameters

Name	Type
scene	Scene
id	number
name	string
description	string
position	Vector3
cameraPosition	Vector3
cameraRotation	Vector4
cameraZoom	Vector3
cameraProjectionType	number
areaId	number

Returns

AreaHotSpot

Description

构造函数

Overrides

HotSpot.constructor

Properties

id

• id: number

Inherited from

HotSpot.id

---

count

▪ Static count: number

Inherited from

HotSpot.count

---

isProto

▪ Static isProto: string

Inherited from

HotSpot.isProto

---

pVertexHeader

▪ Static pVertexHeader: string

Inherited from

HotSpot.pVertexHeader

Accessors

isProto

• get isProto(): boolean

Returns

boolean

Description

获取是否为原型对象

Inherited from

HotSpot.isProto

• set isProto(v): void

Parameters

Name	Type
v	boolean

Returns

void

Description

设置是否为原型对象

Inherited from

HotSpot.isProto

Methods

addComText

▸ addComText(comText): void

Parameters

Name	Type
comText	ComText

Returns

void

Description

添加多文本对象

Inherited from

HotSpot.addComText

---

addEffect

▸ addEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

添加特效效果

Inherited from

HotSpot.addEffect

---

addImage

▸ addImage(image): void

Parameters

Name	Type
image	Image

Returns

void

Description

添加图片对象

Inherited from

HotSpot.addImage

---

addLine

▸ addLine(line): void

Parameters

Name	Type
line	Line

Returns

void

Description

添加线对象

Inherited from

HotSpot.addLine

---

addOutFrame

▸ addOutFrame(polyLine): void

Parameters

Name	Type
polyLine	PolyLine

Returns

void

Description

添加外框

Inherited from

HotSpot.addOutFrame

---

addPoint

▸ addPoint(point): void

Parameters

Name	Type
point	Point

Returns

void

Description

添加点对象

Inherited from

HotSpot.addPoint

---

addPolyLine

▸ addPolyLine(polyLine): void

Parameters

Name	Type
polyLine	PolyLine

Returns

void

Description

添加折线对象

Inherited from

HotSpot.addPolyLine

---

addText

▸ addText(ct): void

Parameters

Name	Type
ct	ComText

Returns

void

Description

添加文字

Inherited from

HotSpot.addText

---

clear

▸ clear(): void

Returns

void

Description

数据清空

Inherited from

HotSpot.clear

---

clearComText

▸ clearComText(): void

Returns

void

Description

清空ComText

Inherited from

HotSpot.clearComText

---

clearImage

▸ clearImage(): void

Returns

void

Description

清空图片

Inherited from

HotSpot.clearImage

---

clearOutFrames

▸ clearOutFrames(): void

Returns

void

Description

清空外框

Inherited from

HotSpot.clearOutFrames

---

clearPolyLines

▸ clearPolyLines(): void

Returns

void

Description

清空所有折线

Inherited from

HotSpot.clearPolyLines

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

HotSpot.getAlpha

---

getAreaId

▸ getAreaId(): number

Returns

number

Description

获取场景id

---

getAuthor

▸ getAuthor(): string

Returns

string

Description

获取创建者

Inherited from

HotSpot.getAuthor

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取包围盒

Inherited from

HotSpot.getBoundingBox

---

getCameraPosition

▸ getCameraPosition(): Vector4

Returns

Vector4

Description

获取相机位置

Inherited from

HotSpot.getCameraPosition

---

getCameraProjectionType

▸ getCameraProjectionType(): number

Returns

number

Description

获取相机投影类型

Inherited from

HotSpot.getCameraProjectionType

---

getCameraRotation

▸ getCameraRotation(): Vector3

Returns

Vector3

Description

获取相机旋转参数

Inherited from

HotSpot.getCameraRotation

---

getCameraZoom

▸ getCameraZoom(): Vector3

Returns

Vector3

Description

获取相机缩放参数

Inherited from

HotSpot.getCameraZoom

---

getColor

▸ getColor(): Color

Returns

Color

Description

获取颜色

Inherited from

HotSpot.getColor

---

getComTexts

▸ getComTexts(): ComText[]

Returns

ComText[]

Description

获取文字对象列表

Inherited from

HotSpot.getComTexts

---

getCreateId

▸ getCreateId(): number

Returns

number

Description

获取createId

Inherited from

HotSpot.getCreateId

---

getCreateTime

▸ getCreateTime(): string

Returns

string

Description

获取创建时间

Inherited from

HotSpot.getCreateTime

---

getDescription

▸ getDescription(): string

Returns

string

Description

获取热点描述

Inherited from

HotSpot.getDescription

---

getDrawables

▸ getDrawables(): void

Returns

void

Description

获取渲染数据

Inherited from

HotSpot.getDrawables

---

getEffect

▸ getEffect(): number

Returns

number

Description

获取效果

Inherited from

HotSpot.getEffect

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

HotSpot.getEvents

---

getFirstParentPath

▸ getFirstParentPath(): string

Returns

string

Description

获取FirstParent路径

Inherited from

HotSpot.getFirstParentPath

---

getFirstPosition

▸ getFirstPosition(): Vector3

Returns

Vector3

Description

获取第一个点位置

Inherited from

HotSpot.getFirstPosition

---

getFrameLineList

▸ getFrameLineList(): PolyLine[]

Returns

PolyLine[]

Description

获取边框线对象

Inherited from

HotSpot.getFrameLineList

---

getGuid

▸ getGuid(): string

Returns

string

Description

获取guid

Inherited from

HotSpot.getGuid

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

HotSpot.getId

---

getImage

▸ getImage(): any

Returns

any

Description

获取热点图片

Inherited from

HotSpot.getImage

---

getImageList

▸ getImageList(): Image[]

Returns

Image[]

Description

获取显示图片列表

Inherited from

HotSpot.getImageList

---

getIsFrontShow

▸ getIsFrontShow(): boolean

Returns

boolean

Description

获取是否前端显示

Inherited from

HotSpot.getIsFrontShow

---

getLineList

▸ getLineList(): Line[]

Returns

Line[]

Description

获取线对象

Inherited from

HotSpot.getLineList

---

getLocalTransform

▸ getLocalTransform(): Matrix4

Returns

Matrix4

Description

获取shape的局部矩阵

Inherited from

HotSpot.getLocalTransform

---

getName

▸ getName(): string

Returns

string

Description

获取实例名称

Inherited from

HotSpot.getName

---

getNeedClip

▸ getNeedClip(): boolean

Returns

boolean

Description

获取是否需要剖切

Inherited from

HotSpot.getNeedClip

---

getObjectId

▸ getObjectId(): number

Returns

number

Description

获取ObjectId

Inherited from

HotSpot.getObjectId

---

getPoint

▸ getPoint(index): Point

Parameters

Name	Type
index	number

Returns

Point

Description

获取特定位置点

Inherited from

HotSpot.getPoint

---

getPointList

▸ getPointList(): Point[]

Returns

Point[]

Description

获取点对象

Inherited from

HotSpot.getPointList

---

getPolyLineList

▸ getPolyLineList(): PolyLine[]

Returns

PolyLine[]

Description

获取折线对象

Inherited from

HotSpot.getPolyLineList

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取热点位置

Inherited from

HotSpot.getPosition

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

HotSpot.getProperties

---

getProto

▸ getProto(): Shape

Returns

Shape

Description

获取原型

Inherited from

HotSpot.getProto

---

getRenderShapes

▸ getRenderShapes(): RenderableShape[]

Returns

RenderableShape[]

Description

获取可绘制对象

Inherited from

HotSpot.getRenderShapes

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取空间旋转信息

Inherited from

HotSpot.getRotation

---

getScene

▸ getScene(): Scene

Returns

Scene

场景对象

Description

获取场景对象

Inherited from

HotSpot.getScene

---

getSecondParentPath

▸ getSecondParentPath(): string

Returns

string

Description

获取SecondParent路径

Inherited from

HotSpot.getSecondParentPath

---

getSecondPosition

▸ getSecondPosition(): Vector3

Returns

Vector3

Description

获取第二个点位置

Inherited from

HotSpot.getSecondPosition

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

HotSpot.getShapeType

---

getTextValue

▸ getTextValue(): string

Returns

string

Description

获取文本string类型数据

Inherited from

HotSpot.getTextValue

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取世界包围盒

Inherited from

HotSpot.getWorldBoundingBox

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取shape的世界矩阵

Inherited from

HotSpot.getWorldTransform

---

initAttributes

▸ initAttributes(): void

Returns

void

Description

添加创建时间创建人信息

Inherited from

HotSpot.initAttributes

---

isDirty

▸ isDirty(): boolean

Returns

boolean

Description

获取脏标记

Inherited from

HotSpot.isDirty

---

isPreSelected

▸ isPreSelected(): boolean

Returns

boolean

Description

是否预选中

Inherited from

HotSpot.isPreSelected

---

isSelected

▸ isSelected(): boolean

Returns

boolean

Description

是否被选中

Inherited from

HotSpot.isSelected

---

isVisible

▸ isVisible(orginVisible?): boolean

Parameters

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

Returns

boolean

Description

获取可见性

Inherited from

HotSpot.isVisible

---

markDirty

▸ markDirty(): void

Returns

void

Description

设置脏标记

Inherited from

HotSpot.markDirty

---

post

▸ post(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

HotSpot.post

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

HotSpot.registerEvent

---

removeEffect

▸ removeEffect(effectType): void

Parameters

Name	Type
effectType	EffectType

Returns

void

Description

移除效果

Inherited from

HotSpot.removeEffect

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

HotSpot.removeEvent

---

removeLine

▸ removeLine(line): void

Parameters

Name	Type
line	Line

Returns

void

Description

清除指定线

Inherited from

HotSpot.removeLine

---

removePoint

▸ removePoint(point): void

Parameters

Name	Type
point	Point

Returns

void

Description

清除指定点

Inherited from

HotSpot.removePoint

---

send

▸ send(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

HotSpot.send

---

sendClipMessage

▸ sendClipMessage(): void

Returns

void

Description

发送剖切更新消息

Inherited from

HotSpot.sendClipMessage

---

sendEffectMessage

▸ sendEffectMessage(): void

Returns

void

Description

发送特效更新消息

Inherited from

HotSpot.sendEffectMessage

---

setAlpha

▸ setAlpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Description

设置透明度

Inherited from

HotSpot.setAlpha

---

setAreaId

▸ setAreaId(value): void

Parameters

Name	Type
value	number

Returns

void

Description

设置场景id

---

setAuthor

▸ setAuthor(author): void

Parameters

Name	Type
author	string

Returns

void

Description

设置创建者

Inherited from

HotSpot.setAuthor

---

setCameraPosition

▸ setCameraPosition(value): void

Parameters

Name	Type
value	Vector4

Returns

void

Description

设置相机位置

Inherited from

HotSpot.setCameraPosition

---

setCameraProjectionType

▸ setCameraProjectionType(value): void

Parameters

Name	Type
value	number

Returns

void

Description

设置相机投影类型

Inherited from

HotSpot.setCameraProjectionType

---

setCameraRotation

▸ setCameraRotation(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Description

设置相机旋转参数

Inherited from

HotSpot.setCameraRotation

---

setCameraZoom

▸ setCameraZoom(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Description

设置相机缩放参数

Inherited from

HotSpot.setCameraZoom

---

setColor

▸ setColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置颜色

Inherited from

HotSpot.setColor

---

setCreateId

▸ setCreateId(createId): void

Parameters

Name	Type
createId	number

Returns

void

Description

设置createId

Inherited from

HotSpot.setCreateId

---

setCreateTime

▸ setCreateTime(createtime): void

Parameters

Name	Type
createtime	string

Returns

void

Description

设置创建时间

Inherited from

HotSpot.setCreateTime

---

setDescription

▸ setDescription(value): void

Parameters

Name	Type
value	string

Returns

void

Description

设置热点描述

Inherited from

HotSpot.setDescription

---

setEffect

▸ setEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

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

Inherited from

HotSpot.setEffect

---

setFirstParentPath

▸ setFirstParentPath(path): void

Parameters

Name	Type
path	string

Returns

void

Description

设置FirstParent路径

Inherited from

HotSpot.setFirstParentPath

---

setFirstPosition

▸ setFirstPosition(position): void

Parameters

Name	Type
position	Vector3

Returns

void

Description

设置第一个点位置

Inherited from

HotSpot.setFirstPosition

---

setFrontShow

▸ setFrontShow(frontShow): void

Parameters

Name	Type
frontShow	boolean

Returns

void

Description

设置是否前端显示

Inherited from

HotSpot.setFrontShow

---

setGuid

▸ setGuid(guid): void

Parameters

Name	Type
guid	string

Returns

void

Description

设置guid

Inherited from

HotSpot.setGuid

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

HotSpot.setId

---

setImage

▸ setImage(hotspotImagePath?): void

Parameters

Name	Type
hotspotImagePath?	string

Returns

void

Description

设置热点图片

Inherited from

HotSpot.setImage

---

setImagePosition

▸ setImagePosition(position): void

Parameters

Name	Type
position	Vector3

Returns

void

Description

设置图片位置

Inherited from

HotSpot.setImagePosition

---

setName

▸ setName(name): void

Parameters

Name	Type	Description
name	string	名称

Returns

void

Description

设置实例名称

Inherited from

HotSpot.setName

---

setNeedClip

▸ setNeedClip(isClip): void

Parameters

Name	Type
isClip	boolean

Returns

void

Description

设置是否需要剖切

Inherited from

HotSpot.setNeedClip

---

setObjectId

▸ setObjectId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置ObjectId

Inherited from

HotSpot.setObjectId

---

setPosition

▸ setPosition(value): void

Parameters

Name	Type
value	Vector3

Returns

void

Description

设置热点位置

Inherited from

HotSpot.setPosition

---

setScene

▸ setScene(scene): void

Parameters

Name	Type
scene	Scene

Returns

void

Description

设置场景

Inherited from

HotSpot.setScene

---

setSecondParentPath

▸ setSecondParentPath(path): void

Parameters

Name	Type
path	string

Returns

void

Description

设置SecondParent路径

Inherited from

HotSpot.setSecondParentPath

---

setSecondPosition

▸ setSecondPosition(position): void

Parameters

Name	Type
position	Vector3

Returns

void

Description

设置第二个点位置

Inherited from

HotSpot.setSecondPosition

---

setSelected

▸ setSelected(selected): void

Parameters

Name	Type
selected	boolean

Returns

void

Description

设置是否被选中

Inherited from

HotSpot.setSelected

---

setShapeType

▸ setShapeType(v): void

Parameters

Name	Type	Description
v	ShapeType	类型

Returns

void

Description

设置类型

Inherited from

HotSpot.setShapeType

---

setVisible

▸ setVisible(visible, originVisible?): void

Parameters

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

Returns

void

Description

设置是否可见

Inherited from

HotSpot.setVisible

---

setWorldTransform

▸ setWorldTransform(matrix): void

Parameters

Name	Type
matrix	Matrix4

Returns

void

Description

设置世界矩阵

Inherited from

HotSpot.setWorldTransform

---

update

▸ update(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息接收者必须实现方法

Inherited from

HotSpot.update