Class SceneObject

A node in the scene hierarchy, holding components and child scene objects.

Hierarchy (View Summary)

Prefabable
- SceneObject

Constructors

`Protected`constructor

new SceneObject(): SceneObject
Snap Hidden
Returns SceneObject
Overrides Prefabable.constructor

Properties

children

children: SceneObject[]

A list of scene objects that is a child of this scene object.

components

components: Component[]

A list of components that is a child of this scene object.

enabled

enabled: boolean

Whether this scene object is enabled or disabled.

`Readonly`hasVisuals

hasVisuals: boolean

Whether this scene object contains any component which is of type Editor.Components.Visual.

`Readonly`id

id: Uuid

The unique id of the entity.

layers

layers: LayerSet

The layerSet this scene object is on.

localTransform

localTransform: TransformEntity

The transform of this scene object relative to its parent.

`Readonly`meta

meta: Meta

Metadata associated with this entity, providing access to its unique identifier and other descriptive properties.

name

name: string

The name of the scene object.

`Readonly`topOwner

topOwner: ObjectOwner

The root owner object at the top of this object's ownership chain.

`Readonly`type

type: string

The entity's type.

worldTransform

worldTransform: WorldTransformAccessor

The transform of this scene object relative to the scene its in.

Methods

addChildAt

addChildAt(value: SceneObject, pos?: number): void
Add a scene object as a child of this object at a specified pos.
Parameters
- value: SceneObject
- Optionalpos: number
Returns void

addComponent

addComponent<K extends keyof ComponentNameMap>(
componentType: K,
): ComponentNameMap[K]
Add a new Editor.Components.Component by componentType to this object.
Type Parameters
- K extends keyof ComponentNameMap
Parameters
- componentType: K
Returns ComponentNameMap[K]

addComponentAt

addComponentAt(value: Component, pos?: number): void
Add the component value at the specified pos.
Parameters
- value: Component
- Optionalpos: number
Returns void

clearChildren

clearChildren(): void
Remove all children from this object.

Returns void

clearComponents

clearComponents(): void
Remove all components from this scene object.

Returns void

`Static`commonParent

commonParent(sceneObjects: SceneObject[]): SceneObject
Returns the nearest common ancestor shared by a set of scene objects.
Parameters
- sceneObjects: SceneObject[]
Returns SceneObject

copy

copy(): SceneObject
Returns a deep copy of this scene object, including its children and components.

Returns SceneObject

destroy

destroy(): void
Destroy this scene object. All references to it becomes invalid.

Returns void

getChildAt

getChildAt(pos: number): SceneObject
Get a specific object at the specified pos.
Parameters
- pos: number
Returns SceneObject

getChildrenCount

getChildrenCount(): number
Get the number of children on this object.

Returns number

getComponent

getComponent<K extends keyof ComponentNameMap>(
componentType: K,
): ComponentNameMap[K]
Get the first component of componentType.
Type Parameters
- K extends keyof ComponentNameMap
Parameters
- componentType: K
Returns ComponentNameMap[K]

getComponentAt

getComponentAt(pos: number): Component
Get the component at the specified pos.
Parameters
- pos: number
Returns Component

getComponents

getComponents<K extends keyof ComponentNameMap>(
componentType: K,
): ComponentNameMap[K][]
Get all the components of componentType on this object.
Type Parameters
- K extends keyof ComponentNameMap
Parameters
- componentType: K
Returns ComponentNameMap[K][]

getComponentsCount

getComponentsCount(): number
Get the number of components on this object.

Returns number

getDirectlyReferencedEntities

getDirectlyReferencedEntities(): Entity[]
A list of entities which this entity has a reference to.

Returns Entity[]
Inherited from Prefabable.getDirectlyReferencedEntities

`Static`getMeta

getMeta(): Meta
Returns Meta
Inherited from Prefabable.getMeta

getOwnedEntities

getOwnedEntities(): Entity[]
A list of entities which has a reference to this entity.

Returns Entity[]
Inherited from Prefabable.getOwnedEntities

getParent

getParent(): SceneObject
Get the parent of this scene object.

Returns SceneObject

`Static`getTypeName

getTypeName(): string
Returns string
Inherited from Prefabable.getTypeName

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from Prefabable.getTypeName

indexOfChild

indexOfChild(value: SceneObject): number
Get the position of a specific object, if the object is a child of this object.
Parameters
- value: SceneObject
Returns number

indexOfComponent

indexOfComponent(value: Component): number
Get the position of a specific component value on this object.
Parameters
- value: Component
Returns number

isOfType

isOfType(type: string): boolean
Returns true if the object is of the specified type.
Parameters
- type: string
Returns boolean
Inherited from Prefabable.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object refers to the same instance as the given object.
Parameters
- other: ScriptObject
Returns boolean
Inherited from Prefabable.isSame

moveChild

moveChild(child: SceneObject, destination: number): void
Move child in the order of children on this object.
Parameters
- child: SceneObject
- destination: number
Returns void

moveComponent

moveComponent(origin: number, destination: number): void
Move the component value to a specified pos.
Parameters
- origin: number
- destination: number
Returns void

removeChild

removeChild(child: SceneObject): void
Remove a child from this from this scene object.
Parameters
- child: SceneObject
Returns void

removeChildAt

removeChildAt(pos: number): void
Remove a child at the specified pos.
Parameters
- pos: number
Returns void

removeComponent

removeComponent(componentType: string): boolean
Remove the first component of componentType from this object.
Parameters
- componentType: string
Returns boolean

removeComponentAt

removeComponentAt(pos: number): void
Remove the components at the specified pos.
Parameters
- pos: number
Returns void

setChildAt

setChildAt(pos: number, value: SceneObject): void
Set the child scene object value to be at the specified pos.
Parameters
- pos: number
- value: SceneObject
Returns void

setComponentAt

setComponentAt(pos: number, value: Component): void
Set the component value to be at the specified pos.
Parameters
- pos: number
- value: Component
Returns void

setParent

setParent(newParent: SceneObject, position?: number): void
Set the parent of this scene object.
Parameters
- newParent: SceneObject
- Optionalposition: number
Returns void

`Static`staticMeta

staticMeta(): Meta
Returns the static metadata descriptor for the SceneObject type.

Returns Meta

`Static`topLevel

topLevel(sceneObjects: SceneObject[]): SceneObject[]
Returns the topmost ancestor of this object in the scene hierarchy.
Parameters
- sceneObjects: SceneObject[]
Returns SceneObject[]

Class SceneObject

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Returns SceneObject

Properties

children

components

enabled

ReadonlyhasVisuals

Readonlyid

layers

localTransform

Readonlymeta

name

ReadonlytopOwner

Readonlytype

worldTransform

Methods

addChildAt

Parameters

Returns void

addComponent

Type Parameters

Parameters

Returns ComponentNameMap[K]

addComponentAt

Parameters

Returns void

clearChildren

Returns void

clearComponents

Returns void

StaticcommonParent

Parameters

Returns SceneObject

copy

Returns SceneObject

destroy

Returns void

getChildAt

Parameters

Returns SceneObject

getChildrenCount

Returns number

getComponent

Type Parameters

Parameters

Returns ComponentNameMap[K]

getComponentAt

Parameters

Returns Component

getComponents

Type Parameters

Parameters

Returns ComponentNameMap[K][]

getComponentsCount

Returns number

getDirectlyReferencedEntities

Returns Entity[]

StaticgetMeta

Returns Meta

getOwnedEntities

Returns Entity[]

getParent

Returns SceneObject

StaticgetTypeName

Returns string

getTypeName

Returns string

indexOfChild

Parameters

Returns number

indexOfComponent

Parameters

Returns number

`Protected`constructor

`Readonly`hasVisuals

`Readonly`id

`Readonly`meta

`Readonly`topOwner

`Readonly`type

`Static`commonParent

`Static`getMeta

`Static`getTypeName

`Static`staticMeta

`Static`topLevel