datagen.api.catalog.eyes#
- class datagen.api.catalog.eyes#
This class gives you access to the catalog of eye assets. When you get a 3D asset from this catalog, it comes in the form of a
datagen.api.assets.Eyes
object.You can query the eyes catalog using these functions:
- get(self, id: str = None, limit: int = None, **attributes) Union[Eyes, List[Eyes]]: #
Gets eyes assets from the asset catalog.
- Parameters:
id (str) – Optional. Searches for a specific eyes asset matching the chosen UUID.
limit (int) –
Optional. Caps the number of
datagen.api.assets.Eyes
objects that will be included in the response.If limit=1, returns a single
datagen.api.assets.Eyes
object.If limit>1, returns an object of type List[
datagen.api.assets.Eyes
] (even if there turns out to be only one matching eyes asset in that list).
attributes (Any) – Optional. A dictionary of attributes matching one or more of the properties in
datagen.api.catalog.attributes.EyesAttributes
.
- Returns:
The eyes asset or assets that match your search query
- Return type:
List[
datagen.api.assets.Eyes
] in the form of a lazy listdatagen.api.assets.Eyes
when limit=1 or when an id is provided
- count(self, **attributes) int: #
Queries the catalog for the number of eyes assets matching a request
- Parameters:
attributes (Any) – Optional. A dictionary of attributes matching one or more of the properties in
datagen.api.catalog.attributes.EyesAttributes
.- Returns:
The number of eyes assets in the catalog matching your query.
- Return type:
int