nodes.geometry.zone
zone
Classes
| Name | Description |
|---|---|
| BaseRepeatZone | |
| BaseSimulationZone | |
| BaseZone | |
| BaseZoneInput | Base class for zone input nodes |
| BaseZoneOutput | Base class for zone output nodes |
| ClosureInput | Closure Input node |
| ClosureOutput | Closure Output node |
| ClosureZone | |
| ForEachGeometryElementInput | For Each Geometry Element Input node |
| ForEachGeometryElementOutput | For Each Geometry Element Output node |
| ForEachGeometryElementZone | |
| RepeatInput | Repeat Input node |
| RepeatOutput | Repeat Output node |
| RepeatZone | |
| SimulationInput | Simulation Input node |
| SimulationOutput | Simulation Output node |
| SimulationZone | |
| ZoneItem | Handle for a simulation/repeat state item (four sockets per item). |
BaseRepeatZone
BaseRepeatZone(node=None)Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
items |
The node’s items; subclasses return their typed collection. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
tree |
Methods
| Name | Description |
|---|---|
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| capture | Deprecated: use items.new(value, name).output. |
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
BaseSimulationZone
BaseSimulationZone(node=None)Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
items |
The node’s items; subclasses return their typed collection. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
tree |
Methods
| Name | Description |
|---|---|
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| capture | Deprecated: use items.new(value, name).output. |
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
BaseZone
BaseZone(node=None)Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
items |
The node’s items; subclasses return their typed collection. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
tree |
Methods
| Name | Description |
|---|---|
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| capture | Deprecated: use items.new(value, name).output. |
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
BaseZoneInput
BaseZoneInput(node=None)Base class for zone input nodes
Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
items |
The node’s items; subclasses return their typed collection. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
output |
|
tree |
Methods
| Name | Description |
|---|---|
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| capture | Deprecated: use items.new(value, name).output. |
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
BaseZoneOutput
BaseZoneOutput(node=None)Base class for zone output nodes
Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
items |
The node’s items; subclasses return their typed collection. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
tree |
Methods
| Name | Description |
|---|---|
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| capture | Deprecated: use items.new(value, name).output. |
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
ClosureInput
ClosureInput()Closure Input node
Attributes
| Name | Description |
|---|---|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| link |
link
link(target)ClosureOutput
ClosureOutput(define_signature=False)Closure Output node
Attributes
| Name | Description |
|---|---|
define_signature |
|
i |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
The TreeBuilder instance this node belongs to and is being built within. |
Methods
| Name | Description |
|---|---|
| link | |
| sync_signature |
link
link(source)sync_signature
sync_signature(node)Outputs
| Attribute | Type | Description |
|---|---|---|
o.closure |
ClosureSocket |
Closure |
ClosureZone
ClosureZone()Attributes
| Name | Description |
|---|---|
closure |
The closure produced by the zone. |
input |
|
inputs |
The closure’s input items. |
output |
|
outputs |
The closure’s output items. |
Methods
| Name | Description |
|---|---|
| input_item | Deprecated: use zone.inputs.new(name, type=type).output. |
| output_item | Deprecated: use zone.outputs.new(name, type=type).input. |
input_item
input_item(name, type='GEOMETRY')Deprecated: use zone.inputs.new(name, type=type).output.
output_item
output_item(name, type='GEOMETRY')Deprecated: use zone.outputs.new(name, type=type).input.
ForEachGeometryElementInput
ForEachGeometryElementInput(geometry=None, selection=True)For Each Geometry Element Input node
Attributes
| Name | Description |
|---|---|
i |
|
items |
The node’s items; subclasses return their typed collection. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
output |
|
tree |
Methods
| Name | Description |
|---|---|
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| capture | Deprecated: use items.new(value, name).output. |
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
ForEachGeometryElementOutput
ForEachGeometryElementOutput(domain='POINT', **kwargs)For Each Geometry Element Output node
Attributes
| Name | Description |
|---|---|
domain |
|
i |
|
items |
The node’s items; subclasses return their typed collection. |
items_generated |
|
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
tree |
Methods
| Name | Description |
|---|---|
| add_generated_item | Deprecated: use zone.generated_items.<type>(value, name). |
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| capture | Deprecated: use items.new(value, name).output. |
| capture_generated | Deprecated: use zone.generated_items.<type>(value, name).output. |
add_generated_item
add_generated_item(name, value=None, *, type=None, domain='POINT')Deprecated: use zone.generated_items.<type>(value, name).
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
capture_generated
capture_generated(value, *, name=None, domain='POINT')Deprecated: use zone.generated_items.<type>(value, name).output.
ForEachGeometryElementZone
ForEachGeometryElementZone(geometry=None, selection=True, *, domain='POINT')Attributes
| Name | Description |
|---|---|
corner |
|
curve |
|
edge |
|
element |
The current element as geometry, read inside the zone body. |
face |
|
generated |
|
generated_items |
Generation items: values stored on the generated geometry. |
generation |
Handle for the default generation item (the generated geometry). |
index |
|
input |
|
inputs |
|
instance |
|
items |
Per-element input items, read inside the body. |
layer |
|
main |
|
main_items |
Main items: per-element results written back onto the geometry. |
output |
|
point |
Methods
| Name | Description |
|---|---|
| generated_item | |
| item | |
| main_item |
generated_item
generated_item(name, value=None, *, type=None, domain='POINT')item
item(name, value=None, *, type=None)main_item
main_item(name, value=None, *, type=None)RepeatInput
RepeatInput(iterations=1)Repeat Input node
Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
items |
The node’s items; subclasses return their typed collection. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
output |
|
tree |
Methods
| Name | Description |
|---|---|
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| capture | Deprecated: use items.new(value, name).output. |
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
RepeatOutput
RepeatOutput(node=None)Repeat Output node
Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
items |
The node’s items; subclasses return their typed collection. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
tree |
Methods
| Name | Description |
|---|---|
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| capture | Deprecated: use items.new(value, name).output. |
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
RepeatZone
RepeatZone(iterations=1, items=None)Attributes
| Name | Description |
|---|---|
input |
|
items |
The zone’s state items. |
iteration |
The current iteration index. |
output |
Methods
| Name | Description |
|---|---|
| item | Deprecated: use zone.items.new(initial, name, type=). |
item
item(name, initial=None, *, type=None)Deprecated: use zone.items.new(initial, name, type=).
SimulationInput
SimulationInput(node=None)Simulation Input node
Attributes
| Name | Description |
|---|---|
i |
Input socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
items |
The node’s items; subclasses return their typed collection. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
|
output |
|
tree |
Methods
| Name | Description |
|---|---|
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| capture | Deprecated: use items.new(value, name).output. |
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
SimulationOutput
SimulationOutput(node=None)Simulation Output node
Attributes
| Name | Description |
|---|---|
i |
|
items |
The node’s items; subclasses return their typed collection. |
name |
The name of the node being wrapped by this instance. |
node |
|
o |
Output socket accessor. Subclasses narrow the return type via TYPE_CHECKING. |
tree |
Methods
| Name | Description |
|---|---|
| add_item | Deprecated: use items.new(value, name, type=). |
| add_items | Deprecated: use items.new(value, name) per item. |
| capture | Deprecated: use items.new(value, name).output. |
add_item
add_item(name, value=None, *, type=None)Deprecated: use items.new(value, name, type=).
add_items
add_items(items)Deprecated: use items.new(value, name) per item.
capture
capture(value, *, name=None)Deprecated: use items.new(value, name).output.
SimulationZone
SimulationZone(items=None)Attributes
| Name | Description |
|---|---|
delta_time |
|
input |
|
items |
The zone’s state items. |
output |
Methods
| Name | Description |
|---|---|
| item | Deprecated: use zone.items.new(initial, name, type=). |
item
item(name, initial=None, *, type=None)Deprecated: use zone.items.new(initial, name, type=).
ZoneItem
ZoneItem(items, item)Handle for a simulation/repeat state item (four sockets per item).
initial and next are the link targets; >> item.initial continues the chain from current and >> item.next from result, so a zone body can be written as one chain::
g.Cube() >> geo.initial >> g.SetShadeSmooth() >> geo.next >> outThe type parameter is the socket class every role returns; the typed methods on zone.items produce parameterised handles such as ZoneItem[GeometrySocket].
Attributes
| Name | Description |
|---|---|
current |
Input-node output socket — read the item inside the zone body. |
initial |
Input-node input socket — set the item’s starting value. |
input |
The socket the item is fed through. |
name |
|
next |
Output-node input socket — write the item’s per-iteration result. |
output |
The socket the item is read from. |
result |
Output-node output socket — read the item after the zone. |
socket_type |