---
title: "TwoPoint5DAsset"
description: "API documentation for TwoPoint5DAsset"
url: https://developer.disguise.one/python-api/docs/twopoint5dasset/
---

# TwoPoint5DAsset

A 2.5D asset, which contains multiple 2.5D plates.

The 2.5D asset can be loaded from or exported to a .2p5d file for reuse across different projects.  
See [https://developer.disguise.one/formats/2p5d/](https://developer.disguise.one/formats/2p5d/) for the .2p5d format specification for 2.5D assets.

See also: [Stage Guide](/plugins/guides/stage)

Base class (inherits properties and methods): _[Object](/python-api/docs/object#object)_

## Properties

#### **alwaysShowInStage** : _bool_

Show the asset in the stage, even when the editor is not open

#### **depthMapMax** : _float_

Maximum depth represented in the depth map (far plane), in metres.

#### **depthMapMaxOriginal** : _float_

Maximum depth represented in the depth map (near plane) when the asset was extracted, in metres.

#### **depthMapMinOriginal** : _float_

Minimum depth represented in the depth map (near plane) when the asset was extracted, in metres.

#### **depthMapMinOverride** : _float_

The minimum depth in metres used when interpreting depth maps from imported assets  
Set to -1 to reload default value from file

_UserName: Depth map minimum override_

#### **file** : _[TwoPoint5DFile](/python-api/docs/twopoint5dfile#twopoint5dfile)_

The file path for the asset, when it has been loaded from a .2p5d file.

#### **fovH** : _float_

Horizontal field of view covered by the asset, in degrees

#### **fovV** : _float_

Vertical field of view covered by the asset, in degrees

#### **isExtracted** : _bool_

Whether the asset has been extracted from its .2p5d file.

#### **maxDepth** : _float_

Maximum depth of the plates in the asset, in metres

#### **plates** : _List\[[TwoPoint5DPlate](/python-api/docs/twopoint5dplate#twopoint5dplate)\]_

Array of plates which make up the 2.5D scene

_UserName: Plates_

## Methods

#### **decrementEditorRefCount**(self)

Decrements the editor reference count.

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

#### **depthMapMinHasChanged**(self) -> _bool_

Whether the depth map minimum specified in depthMapMinOverride is valid and different to the original depth specified in depthMapMinOriginal.

#### **exportToFile**(self)

Exports the asset to a .2p5d file.  
The file is saved as \[asset name\].2p5d within the project’s objects/2p5DFile folder.

#### **extractFromFile**(self, isPrimaryMachine: _bool_)

Extracts the asset from its corresponding 2.5D file.

**Parameters**:

-   isPrimaryMachine: Whether the current machine is the primary machine in the session.

#### **hasFile**(self) -> _bool_

Whether the asset has a .2p5d file within the project associated with it.

#### **incrementEditorRefCount**(self)

Increments the editor reference count.

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

#### **onPlatesMoved**(self, movedPlateIndices: _List\[int\]_)

Called when the order of plates in the list has changed.

This function updates the depth of each plate based on its new position within the list to ensure that the plates are sorted in ascending order by depth.

**Parameters**:

-   movedPlateIndices: Indices of the plates which have moved in the list.

#### **renderPreview**(self, resolution: _[Vec2](/python-api/docs/vec2#vec2) | [Int2](/python-api/docs/int2#int2) | [Vec](/python-api/docs/vec#vec)_, renderInGuiSpace: _bool_) -> _[DxTexture](/python-api/docs/dxtexture#dxtexture)_

Renders a preview of the asset from the eye point

**Parameters**:

-   resolution: The resolution at which to render the preview.
-   renderInGuiSpace: Whether to render the preview in the GUI’s colour space.

**Returns** A texture containing the rendered preview.

#### **sceneAspect**(self) -> _float_

The aspect ratio (X/Y) of the scene, based on the vertical and horizontal extents of the 2.5D plates within the asset.