TwoPoint5DPlate

A 2.5D plate, which forms part of a 2.5D asset.

Contains a layer stack which renders the content to the plate. Can also be added to a mapping like a regular display.
A flat rectangle by default, but can be shaped by a mesh or depth map.

Category: Stage

Base class: Display

Properties

alwaysShowInStage : bool

Whether the plate is always rendered in the stage, or only when the module/asset/plate editor is open

depthMapMean : float

The mean value of the depth map. In inverse normalised coordinates, between 0 and 1.

depthMapSrc : VideoClip

The video clip providing the depth map for this plate, if applicable

layerStack : LayerStack

Layer stack containing the media to display on the plate

UserName: Layer stack

offsetRatios : Vec

Ratios between the X/Y/Z offset and depth of the plate.

scaleRatios : Vec

Ratios between the X/Y/Z scale and depth of the plate.

scaleWithDepth : bool

Scale the plate as depth is changed to maintain the view from the origin

UserName: Scale with depth

Methods

decrementEditorRefCount(self)

Decrements the editor reference count.

Called when a relevant editor (e.g. 2.5D module, asset or plate) is closed. If the reference count reaches zero, the plate becomes invisible in the stage.

incrementEditorRefCount(self)

Increments the editor reference count.

Called when a relevant editor (e.g. 2.5D module, asset or plate) is open. The plate becomes visible in the stage when the reference count is > 0.

matchScaleToResolutionAspect(self)

Adjusts the physical scale of the plate to match the aspect ratio of the plate’s resolution.

renderPreview(self) -> DxTexture

Render a preview of the plate.

Returns A texture containing the rendered preview.