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 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.

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.