SceneObject

Lens Studio v1.0.0+

Scripting Name: SceneObject

Inherits from SerializableWithUID

Description

An object in the scene hierarchy, containing a Transform and possibly Components. A script can access the SceneObject holding it through the property script.getSceneObject().

Methods

---

copyComponent(Component component) : Component

Copies component and adds it to the SceneObject, then returns it.

---

copySceneObject(SceneObject sceneObject) : SceneObject

Creates a shallow copy of SceneObject sceneObject (not including its hierarchy), and parents it to the SceneObject.

---

copyWholeHierarchy(SceneObject sceneObject) : SceneObject

Creates a deep copy of SceneObject sceneObject (including its hierarchy), and parents it to the SceneObject.

---

createComponent(String typeName) : Component

Adds a new component of type typeName to the SceneObject.

---

destroy() : void

Destroys the SceneObject.

---

getChild(Number index) : SceneObject

Returns this SceneObject’s child at index index.

---

getChildrenCount() : Number

Returns the number of children the SceneObject has.

---

getComponentByIndex(String componentType, Number index) : Component

Returns the attached component of type componentType at index index. If componentType is an empty string, all component types are considered.

---

getComponentCount(String componentType) : Number

Returns the number of components of type componentType attached to the SceneObject. If componentType is an empty string, the total number of components attached is returned.

---

getFirstComponent(String componentType) : Component

Returns the first attached component of type componentType. If componentType is an empty string, the first component of any type is returned.

---

getParent() : SceneObject

Returns the SceneObject’s parent in the hierarchy, or null if there isn’t one.

---

getRenderLayer() : Number

Returns the current render layer of the SceneObject.

---

getTransform() : Transform

Returns the Transform attached to the SceneObject.

---

hasParent() : Boolean

Returns whether the SceneObject has a parent in the scene hierarchy.

---

removeParent() : void

Unparents the SceneObject in the hierarchy, making it an orphan.

---

setParent(SceneObject newParent) : void

Sets the SceneObject’s parent to newParent in the scene hierarchy.

---

setRenderLayer(Number id) : void

Sets the render layer of the SceneObject to id.

Properties

---

enabled : Boolean

Whether the SceneObject, including its components and children, is enabled or disabled.

---

name : String

The name of the SceneObject.

Inherited Methods

---

getTypeName() : String

Returns the name of this object’s type.

Examples

// Look for a MeshVisual on this SceneObject
var sceneObj = script.getSceneObject();
if(sceneObj.getComponentCount("Component.MeshVisual") > 0)
{
    var meshVisual = sceneObj.getFirstComponent("Component.MeshVisual");
    // ...
}

// Rename each child SceneObject
var sceneObj = script.getSceneObject();
for(var i=0; i<sceneObj.getChildrenCount(); i++)
{
    var child = sceneObj.getChild(i);
    var newName = i + "_" + child.name;
    child.name = newName;
    print(child.name);
}