Collections reference#
- class blenderline.collections.BackgroundCollection#
Collection of registered background entries.
- __init__()#
Initialize empty collection.
- Return type:
None
- register(entry)#
Register new entry to collection.
- Parameters:
entry (EntryType) – entry to register to the collection.
- Return type:
None
- sample()#
Sample from registered entries according to computed probabilities.
- Returns:
sampled entry.
- Return type:
EntryType
- property total_frequency: float#
Total frequency of all entries in the collection.
- Returns:
total frequency.
- Return type:
float
- class blenderline.collections.HDRCollection#
Collection of registered HDR background entries.
- __init__()#
Initialize empty collection.
- Return type:
None
- register(entry)#
Register new entry to collection.
- Parameters:
entry (EntryType) – entry to register to the collection.
- Return type:
None
- sample()#
Sample from registered entries according to computed probabilities.
- Returns:
sampled entry.
- Return type:
EntryType
- property total_frequency: float#
Total frequency of all entries in the collection.
- Returns:
total frequency.
- Return type:
float
- class blenderline.collections.ItemCollection#
Collection of registered item entries.
- __init__()#
Initialize empty collection.
- Return type:
None
- register(entry)#
Register new entry to collection.
- Parameters:
entry (EntryType) – entry to register to the collection.
- Return type:
None
- sample()#
Sample from registered entries according to computed probabilities.
- Returns:
sampled entry.
- Return type:
EntryType
- property total_frequency: float#
Total frequency of all entries in the collection.
- Returns:
total frequency.
- Return type:
float