Documentation

boolean2d component

Draws the node as its 2D children combined by operation, holes and all. The children stay in the tree, hidden and editable; fill_rule and the cleanup…

In questa pagina

Properties

2d · render · 17 properties · 2D

Draws the node as its 2D children combined by operation, holes and all. The children stay in the tree, hidden and editable; fill_rule and the cleanup keys tune the combination, and color, texture and material dress the result.

In a scene, boolean2d is the node key that applies it. A script reaches each property below as a field on node.boolean2d: reading one asks the running component, and assigning one leaves the rest alone. The whole table is node.boolean2d.get() and node.boolean2d.set(table).

Properties

property	type	default	description
`blend_mode`	enum	`auto`	How the surface lands on what is under it: straight alpha, a colour that already carries its alpha, added light, multiplied shade, screen, or opaque. `auto` is premultiplied for a texture uploaded with `premultiply`, else alpha One of `auto`, `alpha`, `premultiplied`, `add`, `multiply`, `screen`, `opaque`.
`clean_result`	bool	`true`	Clear the result of the near-duplicate points rounding leaves
`color`	color	`[1,1,1,1]`	Tint of the result, as channel floats or #rrggbb / #rrggbbaa
`cull_back_faces`	bool	`false`	Skip a triangle whose back faces the viewer, as a negative scale turns one
`dot_color`	color	`[1,1,1,1]`	The dots' colour. Not drawn on a skinned polygon, which a rig poses in Balaur's own vertex stage
`dot_size`	float	`0`	Size of a dot drawn on every vertex; zero draws none. Not drawn on a skinned polygon, which a rig poses in Balaur's own vertex stage At least 0.
`dot_sizing`	enum	`world`	What `dot_size` counts: `world` is world units, which the camera's zoom scales, `screen` is pixels One of `world`, `screen`.
`draw_surface`	bool	`true`	Whether the surface draws; off leaves the wireframe and the dots alone
`fill_rule`	enum	`even_odd`	Which parts of crossing or nested outlines count as inside: an odd number of them, any winding, or only counter-clockwise or clockwise winding One of `even_odd`, `non_zero`, `positive`, `negative`.
`keep_collinear`	bool	`false`	Keep a point that sits on the straight line between its neighbours, in the children and in the result
`material`	asset · `material`	—	The material the result draws with; empty takes an inherited `material` component, else the built-in one
`min_area`	float	`0`	A result outline or hole enclosing less than this area, in square units of the node's own space, is dropped At least 0.
`operation`	enum	`union`	How the children are combined, in the order they are declared One of `union`, `difference`, `intersection`, `symmetric_difference`, `reverse_difference`.
`texture`	asset · `texture`	—	Image file, project-relative, or a `texture` asset the result is drawn with, centred on the node at 100 texture pixels per unit, as a `polygon`'s default UVs are; empty draws the colour alone
`wireframe_color`	color	`[1,1,1,1]`	The wireframe's colour. Not drawn on a skinned polygon, which a rig poses in Balaur's own vertex stage
`wireframe_sizing`	enum	`world`	What `wireframe_width` counts: `world` is world units, which the camera's zoom scales, `screen` is pixels One of `world`, `screen`.
`wireframe_width`	float	`0`	Width of a line drawn along every triangle edge, not the outline; zero draws none. Not drawn on a skinned polygon, which a rig poses in Balaur's own vertex stage At least 0.

Asset types this component references: material, texture.