create_spherical_selection_rule#

Model.create_spherical_selection_rule(*, name='SphericalSelectionrule', use_global_coordinate_system=True, rosette=None, origin=(0.0, 0.0, 0.0), radius=0.0, relative_rule=False, include_rule=True)#

Instantiate a Spherical Selection Rule.

Parameters:

  • name (str) – Name of the Spherical Selection Rule.

  • use_global_coordinate_system (bool) – Use global coordinate system for origin and direction.

  • rosette (Rosette | None) – Rosette used for origin and direction. Only applies if use_global_coordinate_system is False.

  • origin (tuple[float, ...]) – Origin of the sphere.

  • radius (float) – Radius of the sphere.

  • relative_rule (bool) – If True, parameters are evaluated relative to size of the object.

  • include_rule (bool) – Include or exclude area in rule. Setting this to False inverts the selection.

Return type:

SphericalSelectionRule

Added in ACP server version 24.2.

Examples using Model.create_spherical_selection_rule#

Basic selection rules example

Basic selection rules example