Explore platform

datagen.api.catalog.humans

class datagen.api.catalog.humans

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

Each human asset comes with a default set of hair, eyes, eyebrows, and facial hair - all of which you can edit or replace if you like.

You can query the humans catalog using these functions:

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

Gets human assets from the asset catalog.

Parameters:

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

• limit (int) –

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

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

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

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

Returns:

The human asset or assets that match your search query

Return type:

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

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

count(self, **attributes) → int:

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

Parameters:

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

Returns:

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

Return type:

int