Surface¶

class Surface¶

property id¶

The id of the surface.

Type: str, read-only

property name¶

The name of the surface.

Type: str
Raises: ReadOnlyError -- If Database is in read only mode.

property layer¶

The visibility layer containing this surface.

Type: VisibilityLayer
Raises: ReadOnlyError -- If Database is in read only mode.

property visible¶

The surface visibility.

Type: bool
Raises: ReadOnlyError -- If Database is in read only mode.

property locked¶

The surface lock state.

Type: bool
Raises: ReadOnlyError -- If Database is in read only mode.

property color¶

The shaper color of the surface.

Type: ColorRgb
Raises: ReadOnlyError -- If Database is in read only mode.

property translation¶

The global translation of the surface from the pivot point, in meters.

Type: Vector3
Raises: ReadOnlyError -- If Database is in read only mode.

property rotation¶

The global rotation of the surface from the pivot point, in degrees.

Type: Vector3
Raises: ReadOnlyError -- If Database is in read only mode.

property scale¶

The global scale of the surface from the pivot point.

Type

Vector3

Raises

ReadOnlyError -- If Database is in read only mode.
ValueError -- If trying to set a negative scale.

property pivot_global_position¶

The pivot point global position, in meters.

Type: Vector3
Raises: ReadOnlyError -- If Database is in read only mode.

property pivot_global_orientation¶

The pivot point global orientation, in degrees.

Type: Vector3
Raises: ReadOnlyError -- If Database is in read only mode.

property pivot_local_position¶

The pivot point local position, in meters.

Type: Vector3
Raises: ReadOnlyError -- If Database is in read only mode.

property pivot_local_orientation¶

The pivot point local orientation, in degrees.

Type: Vector3
Raises: ReadOnlyError -- If Database is in read only mode.

property symmetry¶

Whether symmetry is enabled for this layer.

Type: bool
Raises: ReadOnlyError -- If Database is in read only mode.

property symmetry_plane_normal¶

The normal vector of the symmetry plane.

Type: Vector3
Raises: ReadOnlyError -- If Database is in read only mode.

property symmetry_plane_distance¶

The distance in meters of the symmetry plane from the origin.

Type: float
Raises: ReadOnlyError -- If Database is in read only mode.

property triangle_mesh_indices¶

Indices of vertices to make triangles in counter-clockwise order.

Type: list(int), read-only

property triangle_mesh_positions¶

Indexed triangle mesh vertices position (x, y, z) as floats. Units are meters.

Type: list(float), read-only

property triangle_mesh_normals¶

Indexed triangle mesh vertices normals (x, y, z) as floats or None if the mesh has no normals.

Type: list(float) or None, read-only

property triangle_mesh_uvs¶

The 32 UV layers of the indexed triangle mesh mesh. Each layer contains UVs (u, v) as floats or None if the mesh has no UV at this layer.

Type: list(list(float) or None), read-only

duplicate()¶

Duplicate this surface.

Returns: The duplicated surface.
Return type: Surface
Raises: ReadOnlyError -- If Database is in read only mode.

remove()¶

Delete this surface.

Raises: ReadOnlyError -- If Database is in read only mode.