M3D / M3D / Shapes / Dragger

Class: Dragger

M3D.Shapes.Dragger

Memberof

M3D.Shapes

Description

拖拽器

Author

zyc

Date

2023-10-18

Version

1.0

Copyright

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

Hierarchy

• ComplexShape

  ↳ Dragger

  ↳↳ Translate1DDragger

Table of contents

Constructors

• constructor

Properties

• id
• count
• isProto
• pVertexHeader

Accessors

• isProto

Methods

• addDraggerCallback
• addDraggerTip
• addEffect
• clearDraggerCallbacks
• dispatch
• getAllModels
• getAlpha
• getBoundingBox
• getColor
• getDraggerActive
• getDraggerCallbacks
• getDraggerName
• getDraggerTip
• getDraggerType
• getDrawModel
• getDrawables
• getEffect
• getEvents
• getId
• getIsFrontShow
• getIsXMax
• getIsXMin
• getIsYMax
• getIsYMin
• getIsZMax
• getIsZMin
• getLocalTransform
• getMatrix
• getMoveShapeStatus
• getName
• getNeedClip
• getNeedScale
• getObjectId
• getParentDragger
• getPickColor
• getPosition
• getPreSelectColor
• getPreSelected
• getProperties
• getProto
• getRenderShapes
• getRotation
• getScale
• getScene
• getShapeType
• getShapes
• getWorldBoundingBox
• getWorldTransform
• getXMax
• getXMin
• getYMax
• getYMin
• getZMax
• getZMin
• handle
• initialize
• isDraggerModel
• isPreSelected
• isSelected
• isVisible
• post
• receive
• registerEvent
• removeDraggerCallback
• removeDraggerTip
• removeEffect
• removeEvent
• resetPointer
• restoreDragger
• send
• sendClipMessage
• sendEffectMessage
• setAlpha
• setColor
• setDraggerActive
• setDraggerName
• setDrawModel
• setEffect
• setFrontShow
• setId
• setIsXMax
• setIsXMin
• setIsYMax
• setIsYMin
• setIsZMax
• setIsZMin
• setMoveShapeStatus
• setName
• setNeedClip
• setNeedScale
• setObjectId
• setParentDragger
• setPickColor
• setPointer
• setPosition
• setPreSelectColor
• setPreSelected
• setRotation
• setScale
• setScene
• setSelected
• setShapeType
• setVisible
• setWorldTransform
• setXMax
• setXMin
• setYMax
• setYMin
• setZMax
• setZMin
• update
• updateMatrix

Constructors

constructor

• new Dragger(): Dragger

Returns

Dragger

Description

构造函数

Overrides

ComplexShape.constructor

Properties

id

• id: number

Inherited from

ComplexShape.id

---

count

▪ Static count: number

Inherited from

ComplexShape.count

---

isProto

▪ Static isProto: string

Inherited from

ComplexShape.isProto

---

pVertexHeader

▪ Static pVertexHeader: string

Inherited from

ComplexShape.pVertexHeader

Accessors

isProto

• get isProto(): boolean

Returns

boolean

Description

获取是否为原型对象

Inherited from

ComplexShape.isProto

• set isProto(v): void

Parameters

Name	Type
v	boolean

Returns

void

Description

设置是否为原型对象

Inherited from

ComplexShape.isProto

Methods

addDraggerCallback

▸ addDraggerCallback(callback): void

Parameters

Name	Type
callback	DraggerCallback

Returns

void

Description

添加回调

---

addDraggerTip

▸ addDraggerTip(note, toolsKey): boolean

Parameters

Name	Type
note	Note
toolsKey	string

Returns

boolean

Description

添加对应Note

---

addEffect

▸ addEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

添加特效效果

Inherited from

ComplexShape.addEffect

---

clearDraggerCallbacks

▸ clearDraggerCallbacks(): void

Returns

void

Description

清空回调

---

dispatch

▸ dispatch(command): void

Parameters

Name	Type
command	MotionCommand

Returns

void

Description

拖拽命令分发

---

getAllModels

▸ getAllModels(): Model[]

Returns

Model[]

Description

获取拖拽器所有模型

---

getAlpha

▸ getAlpha(): number

Returns

number

Description

获取透明度

Inherited from

ComplexShape.getAlpha

---

getBoundingBox

▸ getBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取包围盒

Inherited from

ComplexShape.getBoundingBox

---

getColor

▸ getColor(): Color

Returns

Color

Description

获取颜色

Overrides

ComplexShape.getColor

---

getDraggerActive

▸ getDraggerActive(): boolean

Returns

boolean

Description

获取激活状态

---

getDraggerCallbacks

▸ getDraggerCallbacks(): DraggerCallback[]

Returns

DraggerCallback[]

Description

获取所有回调

---

getDraggerName

▸ getDraggerName(): string

Returns

string

Description

获取拖拽器的名称

---

getDraggerTip

▸ getDraggerTip(toolsKey): Note

Parameters

Name	Type
toolsKey	string

Returns

Note

Description

获取对应Note

---

getDraggerType

▸ getDraggerType(): DraggerType

Returns

DraggerType

Description

获取拖拽器类型

---

getDrawModel

▸ getDrawModel(): Model

Returns

Model

Description

获取拖拽器模型

---

getDrawables

▸ getDrawables(): void

Returns

void

Description

获取渲染数据

Inherited from

ComplexShape.getDrawables

---

getEffect

▸ getEffect(): number

Returns

number

Description

获取效果

Inherited from

ComplexShape.getEffect

---

getEvents

▸ getEvents(): M3DEvent[]

Returns

M3DEvent[]

Description

获得事件列表

Inherited from

ComplexShape.getEvents

---

getId

▸ getId(): number

Returns

number

Description

获取id

Inherited from

ComplexShape.getId

---

getIsFrontShow

▸ getIsFrontShow(): boolean

Returns

boolean

Description

获取是否前端显示

Inherited from

ComplexShape.getIsFrontShow

---

getIsXMax

▸ getIsXMax(): boolean

Returns

boolean

Description

获取X轴是否存在最大值限制

---

getIsXMin

▸ getIsXMin(): boolean

Returns

boolean

Description

获取X轴是否存在最小值限制

---

getIsYMax

▸ getIsYMax(): boolean

Returns

boolean

Description

获取Y轴是否存在最大值限制

---

getIsYMin

▸ getIsYMin(): boolean

Returns

boolean

Description

获取Y轴是否存在最小值限制

---

getIsZMax

▸ getIsZMax(): boolean

Returns

boolean

Description

获取Z轴是否存在最大值限制

---

getIsZMin

▸ getIsZMin(): boolean

Returns

boolean

Description

获取Z轴是否存在最小值限制

---

getLocalTransform

▸ getLocalTransform(): Matrix4

Returns

Matrix4

Description

获取shape的局部矩阵

Inherited from

ComplexShape.getLocalTransform

---

getMatrix

▸ getMatrix(): Matrix3x4

Returns

Matrix3x4

Description

获取Matrix

---

getMoveShapeStatus

▸ getMoveShapeStatus(): boolean

Returns

boolean

Description

获得绑定的模型是否与拖拽器同时移动

---

getName

▸ getName(): string

Returns

string

Description

获取实例名称

Inherited from

ComplexShape.getName

---

getNeedClip

▸ getNeedClip(): boolean

Returns

boolean

Description

获取是否需要剖切

Inherited from

ComplexShape.getNeedClip

---

getNeedScale

▸ getNeedScale(): boolean

Returns

boolean

Description

获取是否需要缩放状态

---

getObjectId

▸ getObjectId(): number

Returns

number

Description

获取ObjectId

Inherited from

ComplexShape.getObjectId

---

getParentDragger

▸ getParentDragger(): Dragger

Returns

Dragger

Description

获取父拖拽器

---

getPickColor

▸ getPickColor(): Color

Returns

Color

Description

获取拾取颜色

---

getPosition

▸ getPosition(): Vector3

Returns

Vector3

Description

获取空间位置

Overrides

ComplexShape.getPosition

---

getPreSelectColor

▸ getPreSelectColor(): Color

Returns

Color

Description

获取预选颜色

---

getPreSelected

▸ getPreSelected(): boolean

Returns

boolean

Description

获取预选状态

---

getProperties

▸ getProperties(): PropertySet

Returns

PropertySet

Description

获取属性管理器

Inherited from

ComplexShape.getProperties

---

getProto

▸ getProto(): Shape

Returns

Shape

Description

获取原型

Inherited from

ComplexShape.getProto

---

getRenderShapes

▸ getRenderShapes(): RenderableShape[]

Returns

RenderableShape[]

Description

获取绘制对象

Inherited from

ComplexShape.getRenderShapes

---

getRotation

▸ getRotation(): Quaternion

Returns

Quaternion

Description

获取拖拽器旋转四元数

Overrides

ComplexShape.getRotation

---

getScale

▸ getScale(): Vector3

Returns

Vector3

Description

获取缩放值

---

getScene

▸ getScene(): Scene

Returns

Scene

场景对象

Description

获取场景对象

Inherited from

ComplexShape.getScene

---

getShapeType

▸ getShapeType(): ShapeType

Returns

ShapeType

Description

获取Shape类型

Inherited from

ComplexShape.getShapeType

---

getShapes

▸ getShapes(): Shape[]

Returns

Shape[]

Description

获取普通对象

Inherited from

ComplexShape.getShapes

---

getWorldBoundingBox

▸ getWorldBoundingBox(): BoundingBox

Returns

BoundingBox

Description

获取世界包围盒

Inherited from

ComplexShape.getWorldBoundingBox

---

getWorldTransform

▸ getWorldTransform(): Matrix4

Returns

Matrix4

Description

获取shape的世界矩阵

Inherited from

ComplexShape.getWorldTransform

---

getXMax

▸ getXMax(): number

Returns

number

Description

获取X轴最大值

---

getXMin

▸ getXMin(): number

Returns

number

Description

获取X轴最小值

---

getYMax

▸ getYMax(): number

Returns

number

Description

获取Y轴最大值

---

getYMin

▸ getYMin(): number

Returns

number

Description

获取Y轴最小值

---

getZMax

▸ getZMax(): number

Returns

number

Description

获取Z轴最大值

---

getZMin

▸ getZMin(): number

Returns

number

Description

获取Z轴最小值

---

handle

▸ handle(e): boolean

Parameters

Name	Type
e	InputEventArgs

Returns

boolean

Description

设置鼠标位置

▸ handle(pointer, e): boolean

Parameters

Name	Type
pointer	PointerInfo
e	InputEventArgs

Returns

boolean

---

initialize

▸ initialize(): void

Returns

void

Description

初始化

---

isDraggerModel

▸ isDraggerModel(model): boolean

Parameters

Name	Type
model	Model

Returns

boolean

Description

是否拖拽器模型

---

isPreSelected

▸ isPreSelected(): boolean

Returns

boolean

Description

是否预选中

Inherited from

ComplexShape.isPreSelected

---

isSelected

▸ isSelected(): boolean

Returns

boolean

Description

是否被选中

Inherited from

ComplexShape.isSelected

---

isVisible

▸ isVisible(orginVisible?): boolean

Parameters

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

Returns

boolean

Description

获取可见性

Inherited from

ComplexShape.isVisible

---

post

▸ post(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

ComplexShape.post

---

receive

▸ receive(command): boolean

Parameters

Name	Type
command	MotionCommand

Returns

boolean

Description

Receive motion commands. Returns true on success.

---

registerEvent

▸ registerEvent(event): void

Parameters

Name	Type	Description
event	M3DEvent	M3D事件

Returns

void

Description

注册事件

Inherited from

ComplexShape.registerEvent

---

removeDraggerCallback

▸ removeDraggerCallback(callback): void

Parameters

Name	Type
callback	DraggerCallback

Returns

void

Description

移除回调

---

removeDraggerTip

▸ removeDraggerTip(toolsKey): void

Parameters

Name	Type
toolsKey	string

Returns

void

Description

移除对应Note

---

removeEffect

▸ removeEffect(effectType): void

Parameters

Name	Type
effectType	EffectType

Returns

void

Description

移除效果

Inherited from

ComplexShape.removeEffect

---

removeEvent

▸ removeEvent(): void

Returns

void

Description

删除事件

Inherited from

ComplexShape.removeEvent

---

resetPointer

▸ resetPointer(): void

Returns

void

Description

重置PointerInfo

---

restoreDragger

▸ restoreDragger(): void

Returns

void

Description

重置拖拽器平移、旋转参数

---

send

▸ send(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息发送者必须实现方法

Inherited from

ComplexShape.send

---

sendClipMessage

▸ sendClipMessage(): void

Returns

void

Description

发送剖切更新消息

Inherited from

ComplexShape.sendClipMessage

---

sendEffectMessage

▸ sendEffectMessage(): void

Returns

void

Description

发送特效更新消息

Inherited from

ComplexShape.sendEffectMessage

---

setAlpha

▸ setAlpha(alpha): void

Parameters

Name	Type
alpha	number

Returns

void

Description

设置透明度

Inherited from

ComplexShape.setAlpha

---

setColor

▸ setColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置颜色

Overrides

ComplexShape.setColor

---

setDraggerActive

▸ setDraggerActive(active): void

Parameters

Name	Type
active	boolean

Returns

void

Description

设置激活状态

---

setDraggerName

▸ setDraggerName(name): void

Parameters

Name	Type	Description
name	string	拖拽器名称

Returns

void

Description

设置拖拽器的名称

---

setDrawModel

▸ setDrawModel(val): void

Parameters

Name	Type
val	Model

Returns

void

Description

设置拖拽器模型

---

setEffect

▸ setEffect(effectType): void

Parameters

Name	Type
effectType	number

Returns

void

Description

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

Inherited from

ComplexShape.setEffect

---

setFrontShow

▸ setFrontShow(frontShow): void

Parameters

Name	Type
frontShow	boolean

Returns

void

Description

设置是否前端显示

Inherited from

ComplexShape.setFrontShow

---

setId

▸ setId(v): void

Parameters

Name	Type	Description
v	number	ShapeId

Returns

void

Description

设置id

Inherited from

ComplexShape.setId

---

setIsXMax

▸ setIsXMax(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置X轴是否存在最大值限制

---

setIsXMin

▸ setIsXMin(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置X轴是否存在最小值限制

---

setIsYMax

▸ setIsYMax(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置Y轴是否存在最大值限制

---

setIsYMin

▸ setIsYMin(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置Y轴是否存在最小值限制

---

setIsZMax

▸ setIsZMax(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置Z轴是否存在最大值限制

---

setIsZMin

▸ setIsZMin(value): void

Parameters

Name	Type
value	boolean

Returns

void

Description

设置Z轴是否存在最小值限制

---

setMoveShapeStatus

▸ setMoveShapeStatus(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置绑定的模型是否与拖拽器同时移动

---

setName

▸ setName(name): void

Parameters

Name	Type	Description
name	string	名称

Returns

void

Description

设置实例名称

Inherited from

ComplexShape.setName

---

setNeedClip

▸ setNeedClip(isClip): void

Parameters

Name	Type
isClip	boolean

Returns

void

Description

设置是否需要剖切

Inherited from

ComplexShape.setNeedClip

---

setNeedScale

▸ setNeedScale(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置是否需要缩放状态

---

setObjectId

▸ setObjectId(id): void

Parameters

Name	Type
id	number

Returns

void

Description

设置ObjectId

Inherited from

ComplexShape.setObjectId

---

setParentDragger

▸ setParentDragger(parent): void

Parameters

Name	Type	Description
parent	Dragger	父拖拽器

Returns

void

Description

设置父拖拽器

---

setPickColor

▸ setPickColor(color): void

Parameters

Name	Type
color	Color

Returns

void

Description

设置拾取颜色

---

setPointer

▸ setPointer(camera, intersectionPoint): void

Parameters

Name	Type
camera	Camera
intersectionPoint	Vector3

Returns

void

Description

设置PointerInfo

---

setPosition

▸ setPosition(position): void

Parameters

Name	Type
position	Vector3

Returns

void

Description

设置空间位置

Overrides

ComplexShape.setPosition

---

setPreSelectColor

▸ setPreSelectColor(val): void

Parameters

Name	Type
val	Color

Returns

void

Description

设置预选颜色

---

setPreSelected

▸ setPreSelected(val): void

Parameters

Name	Type
val	boolean

Returns

void

Description

设置预选状态

---

setRotation

▸ setRotation(quat): void

Parameters

Name	Type
quat	Quaternion

Returns

void

Description

设置空间旋转信息

---

setScale

▸ setScale(val): void

Parameters

Name	Type
val	Vector3

Returns

void

Description

设置缩放值

---

setScene

▸ setScene(scene): void

Parameters

Name	Type	Description
scene	Scene	场景对象

Returns

void

Description

设置场景对象

Inherited from

ComplexShape.setScene

---

setSelected

▸ setSelected(selected): void

Parameters

Name	Type
selected	boolean

Returns

void

Description

设置是否被选中

Inherited from

ComplexShape.setSelected

---

setShapeType

▸ setShapeType(v): void

Parameters

Name	Type	Description
v	ShapeType	类型

Returns

void

Description

设置类型

Inherited from

ComplexShape.setShapeType

---

setVisible

▸ setVisible(isVisible): void

Parameters

Name	Type
isVisible	boolean

Returns

void

Description

设置隐藏状态

Overrides

ComplexShape.setVisible

---

setWorldTransform

▸ setWorldTransform(matrix): void

Parameters

Name	Type
matrix	Matrix4

Returns

void

Description

设置世界矩阵

Inherited from

ComplexShape.setWorldTransform

---

setXMax

▸ setXMax(value): void

Parameters

Name	Type
value	number

Returns

void

Description

设置X轴最大值

---

setXMin

▸ setXMin(value): void

Parameters

Name	Type
value	number

Returns

void

Description

设置X轴最小值

---

setYMax

▸ setYMax(value): void

Parameters

Name	Type
value	number

Returns

void

Description

设置Y轴最大值

---

setYMin

▸ setYMin(value): void

Parameters

Name	Type
value	number

Returns

void

Description

设置Y轴最小值

---

setZMax

▸ setZMax(value): void

Parameters

Name	Type
value	number

Returns

void

Description

设置Z轴最大值

---

setZMin

▸ setZMin(value): void

Parameters

Name	Type
value	number

Returns

void

Description

设置Z轴最小值

---

update

▸ update(msg): void

Parameters

Name	Type
msg	M3DMessage

Returns

void

Description

消息接收者必须实现方法

Inherited from

ComplexShape.update

---

updateMatrix

▸ updateMatrix(): void

Returns

void

Description

更新矩阵