Explore platform

datagen.api.catalog.masks

class datagen.api.catalog.masks

This class gives you access to the catalog of masks assets. When you get a 3D asset from this catalog, it comes in the form of a datagen.api.assets.Mask object.

You can query the masks catalog using these functions:

get(self, id: str = None, limit: int = None, **attributes) → Union[Masks, List[Masks]]:

Gets masks assets from the asset catalog.

Parameters:

• id (str) – Optional. Searches for a specific masks asset matching the chosen UUID.

• limit (int) –

  Optional. Caps the number of datagen.api.assets.Mask objects that will be included in the response.

  • If limit=1, returns a single datagen.api.assets.Mask object.

  • If limit>1, returns an object of type List[datagen.api.assets.Mask] (even if there turns out to be only one matching masks asset in that list).

• attributes (Any) – Optional. A dictionary of attributes matching one or more of the properties in datagen.api.catalog.attributes.MaskAttributes.

Returns:

The masks asset or assets that match your search query

Return type:

• List[datagen.api.assets.Mask] in the form of a lazy list

• datagen.api.assets.Mask when limit=1 or when an id is provided

count(self, **attributes) → int:

Queries the catalog for the number of masks assets matching a request

Parameters:

attributes (Any) – Optional. A dictionary of attributes matching one or more of the properties in datagen.api.catalog.attributes.MaskAttributes.

Returns:

The number of masks assets in the catalog matching your query.

Return type:

int