PreviewCollectionContent | Human Generator docs

Baseclass for classes that set and modify content stored in preview collections.

These are all the content types where you select them based on a thumbnail. Internal methods used by the UI start with an underscore and will work with lists of tuples (BpyEnums), while the public methods work with lists of strings.

Methods
set()		—
set_random()		Set this content type to a random content item.
get_options()	List[str]	Get a list of options you can use for the set() method of this content.
get_categories()	list[str]	Get a list of categoris this content type is organized in.
refresh_pcoll()		Refresh the items of this preview collection.

Methods

set()

—

set_random()

Set this content type to a random content item.

get_options()

List[str]

Get a list of options you can use for the set() method of this content.

get_categories()

list[str]

Get a list of categoris this content type is organized in.

refresh_pcoll()

Refresh the items of this preview collection.

Methods

PreviewCollectionContent.set(preset: str, context: C = None)

source

No description yet.

Parameter	Type	Description
preset	str	—
context	C default None	—

PreviewCollectionContent.set_random(context: C = None, update_ui: bool = False)

source

Set this content type to a random content item.

This will use random.choice to select a random item from the output of get_options().

Parameter	Type	Description
context	C default None	Blender context. bpy.context if not provided.
update_ui	bool default False	Will also show the chosen item as the active thumbnail in the template_icon_view. Defaults to False.

PreviewCollectionContent.get_options(context: C = None, category: str = 'All') → List[str]

source

Get a list of options you can use for the set() method of this content.

These represent the choises the user sees in the UI. The output is a list of relative paths to the content files, starting from the Human Generator folder.

Parameter	Type	Description
context	C default None	Blender context. bpy.context if not provided.
category	str default 'All'	Category to filter the content by. Defaults to "All". You can get a list of categories from the get_categories() method.

Returns List[str] — List[str]: List of relative paths to content files. You can pick one of these and pass it to the set() method.

Raises ValueError — If the passed category is not present in the list of categories.

Raises HumGenException — If no options can be found, this can be caused by the content pack for this type of content not being installed.

PreviewCollectionContent.get_categories() → list[str]

source

Get a list of categoris this content type is organized in.

You can choose one of these categories to filter the content retreived from get_options().

Returns list[str] — list[str]: List of categories. These are the names of the folders the content is saved in.

PreviewCollectionContent.refresh_pcoll(context: C = None, override_category: Optional[str] = None, ignore_searchterm: bool = False)

source

Refresh the items of this preview collection.

This is low level functionality, you should not need to use this. It is used to refresh the list of possible content for this human. If you use get_options() this is automatically done for you.

Parameter	Type	Description
context	C default None	Blender context. bpy.context if not provided.
override_category	Optional[str] default None	Override the category to use, if not provided all items regardless of category will be shown.
ignore_searchterm	bool default False	If True, the searchterm set by the user will be ignored. Defaults to False.