EnvironmentLayer

class EnvironmentLayer

property id

The id of the environment layer.

Type

str, read-only

property name

The name of the environment layer.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property visibility

The environment layer visibility.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property active

The active status of the environment layer.

Type

bool, read-only

duplicate()

Duplicate this environment layer.

Returns

The duplicated environment layer.

Return type

EnvironmentLayer

Raises

ReadOnlyError -- If Database is in read only mode.

remove()

Delete this environment layer.

Raises

• ReadOnlyError -- If Database is in read only mode.

• ValueError -- Cannot be removed if the environment layer is the only one remaining.

assign_environment(surface, env)

Assign an Environment to the given Surface into the current EnvironmentLayer.

Parameters

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

• env (Environment) -- Environment to assign.

Raises

ReadOnlyError -- If Database is in read only mode.

assign_global_environment(env)

Define the global Environment into the current EnvironmentLayer.

Parameters

env (Environment) -- New global Environment.

Raises

ReadOnlyError -- If Database is in read only mode.

remove_environment_assignment(surface)

Remove the environment assignment on the given Surface.

Parameters

surface (Surface) -- Surface on which to remove the environment.

Raises

ReadOnlyError -- If Database is in read only mode.

remove_global_environment()

Remove the global environment into the current EnvironmentLayer.

Raises

ReadOnlyError -- If Database is in read only mode.

environment_assignment(surface)

Get the environment 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 Environment assigned to the given Surface. Returns nullptr if no environment is assigned.

Return type

Environment or None

global_environment()

Get the global Environment asigned into the current EnvironmentLayer.

Returns

The global Environment assigned into the current EnvironmentLayer. Return None if no global Environment if assigned.

Return type

Environment or None