跳到主要内容

IParamModelLite interface

对定制参数化模型进行精简处理后的结果 CustomModel @vm-type CustomModel

Signature:

interface IParamModelLite 

Properties

Property

Modifiers

Type

Description

category

readonly

number

当前模型所处的真分类信息

id

readonly

string

模型的唯一标识ID 如果模型是从方案当中获取至的,则为模型在方案中的ID,非方案模型,将会随机生成ID

string

isHidden?

readonly

boolean

(Optional) 此字段只有当模型从工具场景中获取,才具有意义 当前模型在工具当中的显示与隐藏状态;如果为true,则表示为隐藏状态

isRoot?

readonly

boolean

(Optional) 当前模型是否为root节点,如果是,则为true

legal?

readonly

boolean

(Optional) 当前模型是否是合法(隐藏)模型

boolean

modelType?

readonly

EParamModelType

(Optional) 模型类型,仅为从方案中获取模型才具备意义

EParamModelType

productId?

readonly

string

(Optional) 商品ID,即商品后台的商品ID

size

readonly

Number3

当前尺寸信息

Number3

toolType?

readonly

EToolType

(Optional) 当前模型所处的定制行业线

type

readonly

ECustomModelType

定制模型类型,在 基础上进行了细分

ECustomModelType

version

readonly

number

模型版本信息

number

Methods

Method

Description

appendAccessory(accessory)

向当前模型中,添加一个非原生模型;一般会使用在添加五金

appendChild(child)

向当前模型中,添加一个子模型;一般会向包裹层当中,添加子模型;另外,五金配件,也必须使用此方法添加

clone()

模型的复制,返回一个新的ParamModel对象

deserialize(model)

将一个序列化之后的模型,进行反序列化操作

dispose()

将当前模型与父级模型断开联系 可以更直接的理解为:删除当前模型 > 针对clone()后的对象,作dispose()操作,将不会产生任何作用

forceUpdate(update)

刷新某个模型,此API仅适用于反向对接的模型: 当前某个模型在后台更新了,但用户方案中,存储的仍然是之前的版本,调用此方法后,会自动将当前模型更新成后台最新的版本。 > 需要注意的是,此方法会导致更新后,模型ID存在变化 > 模型中,添加的appendChild或addAccessory等参数,可能会失效不起作用

getAccessory()

获取当前模型下的所有非原生模型 说明一下:非原生模型可以大致理解为:在方案当中,手动生成一个模型,添加到其他模型上;与之对应子模型可以理解为原生模型,即参数 化编辑中自带的模型

getBzProperty(name, namespace)

获取用户自定义属性

getChild()

获取当前模型的所有子模型

getElementId()

获取设计对象id

getFloorplanRelation()

获取户型关系

getName()

获取当前模型名称

getParam(name)

获取当前模型中的参数信息(参数即在参数化编辑中的信息)

getParent()

查找当前模型的父节点

getPlankPathAsync()

获取当前模型中的板件轮廓信息

getPosition()

获取当前模型的坐标信息 Number3 相对父模型坐标,如果为顶层模型,则为世界坐标

getProductCode()

获取当前模型的产品编码 此字段相当于json输出中『modelBrandGoodCode』字段

getRemark()

获取模型备注信息

getRoot(recursion)

获取root节点,如果当前模型为root节点,则返回自身

getRotation()

获取当前模型相对父级的旋转信息

getToolType()

获取当前模型所处的工具线

hasBzProperty(name, namespace)

判断当前模型是否包含某个属性

hasParam(name)

判断当前模型是否包含某个参数

removeBzProperty(name, namespace)

删除自定义属性、当删除成功时,将返回true,否则返回false

serialize()

对当前模型数据进行序列化操作

setFloorplanRelation(floorplanRelation)

设置户型关系

setName(name)

更改当前模型名称

setPosition(position)

更新当前模型的位置信息

setRemark(remark)

更改模型备注信息

setRotation(rotation)

更新当前模型的旋转信息 特别说明,定制模型,使用的是右手坐标系,rotation字段中

setToolType(toolType)

设置当前模型工具线

toJSON()

将当前数据转换成一个纯对象