Entries reference#

class blenderline.entries.BackgroundEntry#

Background entry.

__init__(filepath, relative_frequency)#

Create background entry.

Parameters:

  • filepath (pathlib.Path) – absolute filepath to image asset.

  • relative_frequency (float) – relative frequency with which to sample.

Return type:

None

set(background_object)#

Apply background image to background object.

Parameters:

background_object (bpy.types.Object) – object to apply background to.

Return type:

None

class blenderline.entries.HDREntry#

HDR entry.

__init__(filepath, relative_frequency)#

Create HDR background entry.

Parameters:

  • filepath (pathlib.Path) – absolute filepath to HDR asset.

  • relative_frequency (float) – relative frequency with which to sample.

Return type:

None

set(world)#

Set HDR as environment background.

Parameters:

world (bpy.types.World) – world object to apply background to.

Return type:

None

Sources:
class blenderline.entries.ItemEntry#

Item entry.

__init__(filepath, label, object_name, min_margin_distance, max_lateral_distance, relative_frequency)#

Create item entry.

Parameters:

  • filepath (pathlib.Path) – absolute filepath to item .blend asset.

  • label (int) – label index of object.

  • object_name (str) – name of object in item .blend file.

  • min_margin_distance (float) – minimum distance (in Blender units) other items need to be away from this item. Distance is computed between item center points.

  • max_lateral_distance (float) – maximum distance item can move from path.

  • relative_frequency (float) – relative frequency with which to sample.

Return type:

None

spawn(location)#

Instantiate item object in the scene at a given location.

Parameters:

location (tuple[float, float, float]) – location to spawn object at.

Returns:

reference to spawned item object.

Return type:

ItemReference