BlockSceneRoot

Get Started

Create AR effects for Instagram and Meta.
Get Started

Scripting API

SceneModule

BlockSceneRoot

The BlockSceneRoot class describes the root scene object of a block.

Inherits From : SceneObjectBase

Example

Properties

Property	Description
`boundingBox`	(get) boundingBox: Box3DSignal (set) (Not Available) Returns a signal that contains a 3D Bounding Box of this object in it's parent coordinate system. Note: This bounding box contains and represents the entire contents of the Block, but doesn't include the children in the parent context.
`boundingBoxVisible`	(get) boundingBoxVisible: BoolSignal (set) (Not Available) Represents whether or not the bounding box for the object is visible. Note: Visibility is determined on the entire set of contents of the Block, but doesn't include the children in the parent context.
`inputs`	(get) inputs: BlockInstanceInputs (set) (Not Available) Returns an object encapsulating all input setters for the Block Instance.
`outputs`	(get) outputs: BlockInstanceOutputs (set) (Not Available) Returns an object encapsulating all outputs getters for the Block Instance.

Methods

Method Description

Method	Description
`getBoundingBox`	getBoundingBox(options?: {includeChildren?: false \| true, skipHidden?: false \| true}): Box3DSignal Returns a signal that contains a 3D Bounding Box of this object in it's local coordinate system. Optional parameters include: - `includeChildren`: whether to include all children (in the parent context) of this object when computing bounding box. Default: `false`. - `skipHidden`: whether to skip hidden children (or this object) when computing bounding box. Default: `false`.
`getBoundingBoxVisible`	getBoundingBoxVisible(options?: {includeChildren?: false \| true, skipHidden?: false \| true}): BoolSignal Returns a signal that contains value representing whether bounding box of a given object is visible or not in the viewport. Optional parameters include: - `includeChildren`: whether to include all children (in the parent context) of this object when computing bounding box. Default: `false`. - `skipHidden`: whether to skip hidden children (or this object) when computing bounding box. Default: `false`.

getBoundingBox

getBoundingBox(options?: {includeChildren?: false | true, skipHidden?: false | true}): Box3DSignal

Returns a signal that contains a 3D Bounding Box
of this object in it's local coordinate system.
Optional parameters include:
- includeChildren: whether to include all children (in the parent context)
of this object when computing bounding box.
Default: false.
- skipHidden: whether to skip hidden children (or this object) when computing bounding box.
Default: false.

getBoundingBoxVisible

getBoundingBoxVisible(options?: {includeChildren?: false | true, skipHidden?: false | true}): BoolSignal

Returns a signal that contains value representing
whether bounding box of a given object is visible or not in the viewport.
Optional parameters include:
- includeChildren: whether to include all children (in the parent context)
of this object when computing bounding box.
Default: false.
- skipHidden: whether to skip hidden children (or this object) when computing bounding box.
Default: false.

BlockSceneRoot

Contents

Contents

Example

Properties

Methods