ra.scoop_ring

Scoop rings.

import rhinoartisan as ra

Wraps ArtisanPlugin.Scripting.ScoopRingApi.

Functions

Function
apply()	Scoops (hollows out) a ring shank from the inside — the ArtisanScoopRing tool, headless.

ra.scoop_ring.apply()

ra.scoop_ring.apply(object_id: IdLike, face_indices: Sequence[int], thickness=None, central_angle=None, transition_angle=None, transition_inset=None, smoothing=None, liner=None, liner_thickness=None, liner_swap=None) -> List[str]

Scoops (hollows out) a ring shank from the inside — the ArtisanScoopRing tool, headless. object_id is the closed ring solid (brep or extrusion, modelled at the origin with the finger axis along world Y) and face_indices the brep faces to scoop away (the faces the user would click: typically the inner/side faces). The scoop is symmetric: central_angle degrees fully hollowed at the bottom of the ring plus transition_angle degrees of fade-out on each side. Only the symmetric mode of the panel is exposed. Millimetres; omitting keeps the tool default (or the user’s saved defaults): thickness 1 (wall left), central_angle 108, transition_angle 15, transition_inset 3.5. smoothing = loft rebuild points 30 (smooth) | 60 (medium) | 120 (fine) | 0 (precise, exact sections); None = default. liner True adds an inner liner of liner_thickness (0.8); liner_swap flips which side the liner keeps. Replaces the original object (same attributes/layer) and returns the ids of the scooped shank followed by the liner pieces, if any.

Parameter	Type
object_id	IdLike	required
face_indices	Sequence[int]	required
thickness	float	optional — None = the tool default
central_angle	float	optional — None = the tool default
transition_angle	float	optional — None = the tool default
transition_inset	float	optional — None = the tool default
smoothing	Optional[int]	optional — None = the tool default
liner	Optional[bool]	optional — None = the tool default
liner_thickness	float	optional — None = the tool default
liner_swap	Optional[bool]	optional — None = the tool default