Object

Base class: Resource

Subclasses: CameraObject, DbgObject, Display, FixtureInstance, FixtureTargetObject, Label, Light, LookAtManipulable, MeasurementSet, OpticalCalibratorObject, ProjectionObject, Prop, Puck, ReferencePoint, SceneOrigin, Skeleton, Stage, TwoPoint5DAsset, VRUser, Venue, Viewer

Properties

children : List[Object] (Read-Only)

externalUpdate : bool

hasTrackingSource : bool (Read-Only)

isReceivingFromTrackingSource : bool (Read-Only)

local : Mat (Read-Only)

mesh : Mesh

needsMesh : bool (Read-Only)

offset : Vec

Position in the scene, in meters; relative to parent object in hierarchy, and mesh position.

UserName: Offset

parent : Object (Read-Only)

renderLayer : int

Where the screen appears.
On stage, the screen is physically present.
Off stage: the screen is temporarily removed from the scene.
Frontplate: Cameras view the screen content as AR content overlaying the stage. Invisible to Projectors.
Backplate: If MR is enabled, the camera projects the content onto the MR set.
Set Extension mask: If MR is enabled, the object cuts away at any set extension, leaving only live video and AR effects.
Set Extension addition: If MR is enabled, the object masks any live video and AR effects, rendering the set extension instead
Live action volume: If MR is enabled, the object defines a volume outside of which set extension is always rendered

Options: {0: ‘Off stage’, 1: ‘On stage’, 2: ‘Frontplate (AR)’, 3: ‘Backplate (MR)’, 4: ‘Set Extension mask’, 5: ‘Set Extension addition’, 6: ‘Live action volume’, 7: ‘2.5D’}
Category: Output
UserName: Render layer

rotation : Vec

Rotation around x, y, z axes, in degrees; relative to parent object in hierarchy, and mesh orientation.

UserName: Rotation

scale : Vec

sortOverride : int

Manually override depth sorting.
Objects with lower values are rendered before objects with higher values

UserName: Depth sort override

trackingSource : ObjectTrackingSource

UserName: Tracking source

world : Mat (Read-Only)

Variables

Backplate : Final = 3

Frontplate : Final = 2

OffStage : Final = 0

OnStage : Final = 1

SetExtensionAddition : Final = 5

SetExtensionMask : Final = 4

getPufferSphereMesh : Callable

getSphereMesh : Callable

Methods

add(self, child: Object)

centroid(self) -> Vec

findAllObjectsOfType(self, type: Type) -> List[Object]

findObjectOfType(self, node: Type) -> Object

isAncestorOf(self, obj: Object) -> bool

isInActiveStage(self) -> bool

remove(self)