ScoopRingApi

Scoop rings.

from ArtisanPlugin.Scripting import ScoopRingApi

See also the Python package, ra.scoop_ring.

Methods

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

Apply

IReadOnlyList<Guid> ScoopRingApi.Apply(
    Guid objectId,
    IEnumerable<int> faceIndices,
    double thickness = 0,
    double centralAngle = 0,
    double transitionAngle = 0,
    double transitionInset = 0,
    int? smoothing = null,
    bool? liner = null,
    double linerThickness = 0,
    bool? linerSwap = null)

Scoops (hollows out) a ring shank from the inside — the ArtisanScoopRing tool, headless. objectId is the closed ring solid (brep or extrusion, modelled at the origin with the finger axis along world Y) and faceIndices the brep faces to scoop away (the faces the user would click: typically the inner/side faces). The scoop is symmetric: centralAngle degrees fully hollowed at the bottom of the ring plus transitionAngle degrees of fade-out on each side. Only the symmetric mode of the panel is exposed. Millimetres; 0 keeps the tool default (or the user’s saved defaults): thickness 1 (wall left), centralAngle 108, transitionAngle 15, transitionInset 3.5. smoothing = loft rebuild points 30 (smooth) | 60 (medium) | 120 (fine) | 0 (precise, exact sections); null = default. liner true adds an inner liner of linerThickness (0.8); linerSwap 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	Default
objectId	Guid	required
faceIndices	IEnumerable<int>	required
thickness	double	0
centralAngle	double	0
transitionAngle	double	0
transitionInset	double	0
smoothing	int?	null
liner	bool?	null
linerThickness	double	0
linerSwap	bool?	null

Returns IReadOnlyList<Guid>.