create_tube_selection_rule#
- Model.create_tube_selection_rule(*, name='TubeSelectionrule', edge_set=None, outer_radius=1.0, inner_radius=0.0, include_rule=True, extend_endings=False, symmetrical_extension=True, head=(0.0, 0.0, 0.0), head_extension=0.0, tail_extension=0.0)#
Instantiate a Tube Selection Rule.
- Parameters:
name (str) – Name of the Tube Selection Rule.
edge_set (EdgeSet | None) – Edge Set defining the path of the tube.
outer_radius (float) – Outer radius of the tube.
inner_radius (float) – Inner radius of the tube.
include_rule (bool) – Include or exclude area in rule. Setting this to
Falseinverts the selection.extend_endings (bool) – Enable this option to extend the endings of the tube.
symmetrical_extension (bool) – Whether the extensions have equal length on both sides or not.
head (tuple[float, float, float]) – Defines the head of the tube. Select a point nearby one of the free ends of the tube. Only needed if the extensions are asymmetric.
head_extension (float) – Defines the length of the extension at the head of the tube. In case of symmetry, this value is used for both sides.
tail_extension (float) – Defines the length of the extension at the tail of the tube. Only needed if the extensions are asymmetric.
- Return type:
Added in ACP server version 24.2.
