AspectLayer

class AspectLayer
property id

The id of the aspect layer.

Type

str, read-only

property name

The name of the aspect layer.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property group

The group of this aspect layer or None if the aspect layer is at the root of the hierarchy.

Type

AspectLayerGroup or None

Raises

ReadOnlyError -- If Database is in read only mode.

property visibility

The aspect layer visibility.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property active

The active status of the aspect layer.

Type

bool, read-only

duplicate()

Duplicate this aspect layer.

Returns

The duplicated aspect layer.

Return type

AspectLayer

Raises

ReadOnlyError -- If Database is in read only mode.

remove()

Delete this aspect layer.

Raises

ReadOnlyError -- If Database is in read only mode.

assign_material(surface, material, uvset = 0)

Assign a Material to the given Surface into the current AspectLayer.

Parameters
  • surface (Surface) -- Surface on which to assign the material.

  • material (Material) -- Material to assign.

  • uvset (int) -- UV set to use for this material assignment.

Raises

ReadOnlyError -- If Database is in read only mode.

remove_material_assignment(surface)

Remove the material assignment on the given Surface.

Parameters

surface (Surface) -- Surface from which to remove the material.

Raises

ReadOnlyError -- If Database is in read only mode.

get_material_assignment(surface)

Get the material assignment on the given Surface if it exists. Return None if not.

Parameters

surface (Surface) -- Surface on which to get the material assignment.

Returns

The Material assigned to the given Surface. Returns None if no material is assigned.

Return type

Material or None

Raises

ReadOnlyError -- If Database is in read only mode.