Product

class Product
property id

The id of the product.

Type

str, read-only

property name

The name of the product.

Type

str

Raises

ReadOnlyError -- If Database is in read only mode.

property active_aspect_layer

The active AspectLayer of this product.

Type

AspectLayer

Raises

ReadOnlyError -- If Database is in read only mode.

property active_environment_layer

The active EnvironmentLayer of this product.

Type

EnvironmentLayer

Raises

ReadOnlyError -- If Database is in read only mode.

property ssao_enabled

Whether the SSAO is enabled.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property ssao_intensity

The SSAO intensity.

Type

float

Raises
property ssao_lightmaps_enabled

Whether the lightmaps are enabled when SSAO is enabled.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property ssao_apply_transparent_surfaces

Whether the SSAO is applied to transparent surfaces.

Type

bool

Raises

ReadOnlyError -- If Database is in read only mode.

property ssao_radius

The SSAO radius when searching for occluders.

Type

float

Raises
property ssao_steps

The number of steps to use when computing SSAO.

Type

int

Raises
property ssao_bias

The SSAO bias.

Type

float

Raises
duplicate()

Duplicate this product.

Returns

The duplicated product.

Return type

Product

Raises

ReadOnlyError -- If Database is in read only mode.

remove()

Delete this product.

Raises

ReadOnlyError -- If Database is in read only mode.

find_aspect_layer(id)

Find an AspectLayer by id.

Parameters

id (str) -- Aspect layer id to find.

Returns

The AspectLayer found or None if not found.

Return type

AspectLayer or None

list_aspect_layers(recursive=True)

List all the AspectLayer.

Parameters

recursive (bool) -- If True, list all aspect layers in the hierarchy, otherwise only aspect layers at the root are returned.

Returns

The list of AspectLayer in this product.

Return type

list(AspectLayer)

find_aspect_layer_group(id)

Find an AspectLayerGroup by id.

Parameters

id (str) -- AspectLayerGroup id to find.

Returns

The AspectLayerGroup found or None if not found.

Return type

AspectLayerGroup or None

list_aspect_layer_groups(recursive=True)

List all the AspectLayerGroup.

Parameters

recursive (bool) -- If True, list all aspect layer groups in the hierarchy, otherwise only aspect layer groups at the root are returned.

Returns

The list of AspectLayerGroup in this product.

Return type

list(AspectLayerGroup)

create_aspect_layer_group(name)

Create a new AspectLayerGrup in this product.

Parameters

name (str) -- Name of the AspectLayerGroup.

Returns

The newly created AspectLayerGroup.

Return type

AspectLayerGroup

Raises

ReadOnlyError -- If Database is in read only mode.

create_aspect_layer(name)

Create a new AspectLayer in this product.

Parameters

name (str) -- Name of the AspectLayer.

Returns

The newly created AspectLayer.

Return type

AspectLayer

Raises

ReadOnlyError -- If Database is in read only mode.

list_environment_layers()

List all the EnvironmentLayer.

Returns

The list of EnvironmentLayer in this product.

Return type

list(EnvironmentLayer)

create_environment_layer(name)

Create a new EnvironmentLayer in this product.

Parameters

name (str) -- Name of the EnvironmentLayer.

Returns

The newly created EnvironmentLayer.

Return type

EnvironmentLayer

Raises

ReadOnlyError -- If Database is in read only mode.

list_configuration_parameters()

List all the ConfigurationParameter.

Returns

The list of ConfigurationParameter in this product.

Return type

list(ConfigurationParameter)

list_configuration_presets()

List all the ConfigurationPreset.

Returns

The list of Configuration in this product.

Return type

list(ConfigurationPreset)

create_configuration_preset(name)

Create a new ConfigurationPreset in this product.

Parameters

name (str) -- Name of the ConfigurationPreset.

Returns

The newly created ConfigurationPreset.

Return type

ConfigurationPreset

Raises

ReadOnlyError -- If Database is in read only mode.