blenderproc.python.modules.constructor.RockEssentialsGroundConstructor module

class blenderproc.python.modules.constructor.RockEssentialsGroundConstructor.RockEssentialsGroundConstructor(config)

Bases: blenderproc.python.modules.loader.LoaderInterface.LoaderInterface

Constructs a ground plane with a material using RE PBR Rock Shader.

Example 1: Construct a scaled ground plane with 30 subdivision cuts, custom name and subdiv level value for rendering using PBR Rock Shader from the specified .blend file.

{
  "module": "constructor.RockEssentialsGroundConstructor",
  "config": {
    "tiles": [
    {
      "shader_path": "<args:0>/Rock Essentials/Individual Rocks/Volcanic/Rocks_Volcanic_Small.blend",
      "plane_scale": [50, 50, 1],
      "subdivision_cuts": 30,
      "subdivision_render_levels": 2,
      "tile_name": "Gr_Plane_1"
    }
    ]
  }
}

Configuration:

Parameter	Description	Type
tiles	Ground tiles to create, each cell contains a separate tile configuration.	list

Ground plane properties:

Parameter	Description	Type
shader_path	Path to a .blend file that containing PBR Rock Shader in //NodeTree// section.	string
plane_scale	Scale of a ground plane. Default: [10, 10, 1].	mathutils.Vector/list
subdivision_cuts	Amount of cuts along each plane axis. Default: 50.	int
subdivision_render_levels	Render level for a plane’s subdivision modifier. Default: 3.	int
tile_name	Name of the ground tile. Set one if you plan to use this module multiple times in one config. Default: ‘RE_ground_plane’.	string

_construct_ground_plane(ground_config)

Constructs a ground plane.

Parameters:ground_config – Config object that contains user-defined settings for ground plane. Type: Config.

_create_node(mat_obj, map_type, in_point)

Handles the creation a ShaderNodeTexImage node, setting maps and creating links.

Parameters:

• mat_obj (Material) – The material object.
• map_type (str) – Type of image/map that will be assigned to this node.
• in_point (str) – Name of an input point in PBR Rock Shader node to use.

_load_shader(ground_config)

Loads PBR Rock Shader

Parameters:ground_config – Config object that contains user-defined settings for ground plane. Type: Config.

run()

Constructs a ground plane. 1. Get configuration parameters. 2. Load shader. 3. Construct ground plane and it’s material node tree.