EarthSDK Group

场景结构树组节点

new Group(earth)

Name Type Description
earth Earth earth实例

Extends

Members

readonlycheckStatus : string

当前叶子节点是否被选中的状态，注意此属性只读，属性值只有两个：'checked' / 'unchecked' / ‘indeterminate’ / ‘ignored’
'checked'表示所有子节点都可用，'unchecked'表示所有子节点都不可用，
‘indeterminate’表示部分节点可用，‘ignored’表示没有子节点，状态忽略

children : array

子节点数组
Default Value: []

disposers

用来收集资源销毁函数，并在析构时自动调用！
Inherited From:
Example:
// 示例1：
myObject.disposers.push(() => {
    // 此处执行需要销毁的资源
});

// 示例2：
// XE.MVVM.bind的返回值是一个函数，作用是用来解除双向绑定，
// 把它的返回值放到disposer中，那么对象销毁时就会执行解绑操作。
myObject.disposers.push(XE.MVVM.bind(xxx));

// 示例3：
// XE.MVVM.watch的返回值是一个函数，作用是用来取消监视，
// 把它的返回值放到disposer中，那么对象销毁时就会执行取消监视的操作。
myObject.disposers.push(XE.MVVM.watch(xxx));

enabled : boolean

是否启用(是否勾选)

expand : boolean

是否展开节点
Default Value: true

parent

获取父节点
Inherited From:

xbsjID

返回组节点的id
Inherited From:

Methods

canMoveTo(destinatonGroup) → boolean

当前节点是否可以移动到某个组节点下
Name Type Description
destinatonGroup * 目标组节点
Returns:
Inherited From:

cloneTo(destinatonGroup, destinationIndex)

将当前节点克隆到某个组节点下的某个位置之前
Name Type Description
destinatonGroup * 目标组节点
destinationIndex * 目标组节点中某个索引位置
Inherited From:

destroy() → undefined

销毁对象
警告：对象一旦销毁不可再次使用！
警告：挂在场景树上的对象禁止调用destroy方法，只要通过数组函数将其从场景树中移除，就会自动销毁！
Returns:
返回undefined
Inherited From:
Example:
// 使用范例
// 这样写的好处是，一旦对象销毁，会同时将引用该对象的变量同时置为undefined，防止再次使用。
this._myObject = this._myObject && this._myObject.destroy();

isDestroyed() → boolean

检查对象是否已被销毁
警告：对象一旦销毁不可再次使用！仅此函数可以调用！
Returns:
对象是否已销毁
Inherited From:

moveTo(destinatonGroup, destinationIndex)

将当前节点移动到某个组节点下的某个位置之前
Name Type Description
destinatonGroup * 目标组节点
destinationIndex * 目标组节点中某个索引位置
Inherited From:

setAllChildrenEnabled(enabled)

设置所有子节点启用或者关闭
Name Type Description
enabled boolean true表示全部启用，false表示全部关闭

toAllJSON() → object

数据整个JSOn对象，包括默认值
Returns:
创建的JSON数据对象
Inherited From:

toAllJSONStr() → string

转化成JSON字符串，输出全部元素
Returns:
JSON格式化好的字符串
Inherited From:

toJSON() → object

转化成一个JSON数据对象
注意：每次都会创建一个新对象！
Returns:
创建的JSON数据对象
Inherited From:

toJSONStr() → string

转化成JSON字符串，默认元素不输出
Returns:
JSON格式化好的字符串
Inherited From:

xbsjFromJSON(jsonObject)

通过JSON数据对象来设置属性
Name Type Description
jsonObject *
Inherited From:
Example:
// 创建一个pin对象
const objConfig = {
    "name": 'Pin1',
    "xbsjType": "Pin",
    "position": [1.9017005694855162, 0.5972477268978722, 488.7695178987821],
    "near": 300,
    "show": false,
    evalString,
};
const pin = new XE.Obj.Pin(earth);  
pin.xbsjFromJSON(objConfig);