Object
The base class for all 3D objects which have a position and rotation in the stage
Category: Stage
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)
The first child of this object, or NULL if the object has no children.
externalUpdate : bool
Whether the object position and rotation are being updated by an external source, such as certain types of tracking source.
hasTrackingSource : bool (Read-Only)
Whether the object has a tracking source or not.
isReceivingFromTrackingSource : bool (Read-Only)
Whether the object is receiving position and rotation data from a tracking source.
local : Mat (Read-Only)
The local matrix that represents the transform from the local space of this object to its parent’s space.
mesh : Mesh
The mesh that is associated with this object.
needsMesh : bool (Read-Only)
Whether the object is a physical thing visible in the stage.
offset : Vec
Position in the scene, in meters; relative to parent object in hierarchy, and mesh position.
UserName: Offset
parent : Object (Read-Only)
The parent of this object, or NULL if the object has no parent.
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
The scale of the object.
sortOverride : int
Manually override depth sorting.
Objects with lower values are rendered before objects with higher values
UserName: Depth sort override
trackingSource : ObjectTrackingSource
The tracking source attached to this object.
UserName: Tracking source
world : Mat (Read-Only)
Variables
Backplate : Final[int] = 3
Frontplate : Final[int] = 2
OffStage : Final[int] = 0
OnStage : Final[int] = 1
SetExtensionAddition : Final[int] = 5
SetExtensionMask : Final[int] = 4
Methods
add(self, child: Object)
Add a child object to the current object.
This method attaches a child object to the current object, making it a part of its hierarchy.
Parameters:
- child: The child object to add.
centroid(self) -> Vec
The mesh centroid in local space.
findAllObjectsOfType(self, type: Type) -> List[Object]
Finds all objects of a given type in the object hierarchy.
This method traverses the object hierarchy below the current object, and returns an array of all objects that match the specified type.
Parameters:
- type: The type to search for.
Returns An array of objects that match the specified type.
findObjectOfType(self, node: Type) -> Object
Finds the first object of a given type in the hierarchy.
This method traverses the object hierarchy below the current object, and returns the first object that matches the specified type.
Parameters:
- type: The type to search for.
Returns The found object, or NULL if no matching object is found.
isAncestorOf(self, obj: Object) -> bool
Checks whether the object is an ancestor of another object.
Parameters:
- obj: The other object to check against.
Returns True if the current object is an ancestor of obj (i.e. above obj in the hierarchy), False otherwise.
isInActiveStage(self) -> bool
Checks if the object is in the active stage.
Returns True if the object is in the active stage, false otherwise.
remove(self)
Remove the object from its parent.
This method detaches this object from its parent, leaving it unparented in the stage hierarchy.
This will also remove the object from the stage.
updateTracking(self)
Ensure the object tracking data is up to date for the current frame.