Rule

class Rule(application_type: RuleApplicationType | Evaluatable[RuleApplicationType])

A Rule is any operation that can be applied to a Shape.

Parameters:

application_type – The RuleApplicationType to use when selecting a match to apply the rule to.

Attributes

application_type

The RuleApplicationType to use when selecting a match to apply the rule to.

Methods

apply_to

Apply this Rule to a Shape.
abstract apply_to(shape: Shape, communication_layer: CommunicationLayer, in_automation: bool = False, _to_design: ndarray = array([0., 0., 0.])) → Tuple[Rule, List[Tuple[Shape, Shape]], Shape, Shape, Shape, Shape]

Apply this Rule to a Shape.

Parameters:

  • shape – The shape to apply this rule to.

  • communication_layer – The CommunicationLayer to use during rule application.

  • in_automation – Whether this rule is being applied as part of an automation (e.g.: as part of a RuleSequence or Program).

  • _to_design – Vector used to relocate the matches to the design in application previews and enumerations. This is needed because the ShapeMachine engine internally shifts its initial_design to the origin to reduce floating-point error.

Returns:

The shape created as a result of rule application.

application_type

The RuleApplicationType to use when selecting a match to apply the rule to.