Tools

7 components in Shanks › Tools.

Cut By Ring Size

Subtracts a cylinder of the ring diameter, along the Y axis, from breps, surfaces, SubDs and meshes

Nickname: Cut Ring Size · Tab: Shanks › Tools

Inputs

Name	Nickname	Type	Access	Default	Description
Objects	Objects	Geometry	list	—	Breps, surfaces, extrusions, SubDs or meshes to cut
Ring Diameter	Diameter	Number	item	16.92	Finger size diameter

Outputs

Name	Nickname	Type	Access	Description
Result	Result	Geometry	list	Cut objects (breps and meshes)
Cylinder	Cylinder	Brep	item	The cutting cylinder

Estimate Ring Size

Estimates the finger diameter of a ring (finger axis on Y, centred on the origin) from its inner gap

Nickname: Estimate Size · Tab: Shanks › Tools

Inputs

Name	Nickname	Type	Access	Description
Ring	Ring	Geometry	list	Ring geometry: breps, surfaces or meshes

Outputs

Name	Nickname	Type	Access	Description
Diameter	Diameter	Number	item	Estimated finger diameter (inner gap across X)
Height Gap	HeightGap	Number	item	Inner gap across Z (equals the diameter on a round hole)
Circumference	Circ	Number	item	Finger circumference, diameter x pi
Points	Pts	Point	list	Inner contact points: X-, X+, Z-, Z+
Is Ring	IsRing	Boolean	item	True when a plausible finger hole was found

Ring Curve

Create a base curve for shanks using FingerSize, Parameters, and Profile

Nickname: RingCurve · Tab: Shanks › Tools

Inputs

Name	Nickname	Type	Access	Description
Ring Diameter (optional)	Diameter	Number	item	Finger size diameter
Parameters (optional)	Params	Generic	item	RingCurve parameters
JSON (optional)	JSON	Text	item	JSON definition of RingCurve

Outputs

Name	Nickname	Type	Access	Description
Ring Curve	Curve	Curve	item	Resulting shank curve
RingCurve	RingCurve	RingCurve	item	RingCurve object
Dictionary	Dict	Generic	item	Dictionary with key/value pairs

Ring Cylinder

Creates a cylinder from a ring diameter and extrusion height

Nickname: RingCyl · Tab: Shanks › Tools

Inputs

Name	Nickname	Type	Access	Default	Description
Ring Diameter (optional)	Diameter	Number	item	17	Ring inner diameter in mm
Extrusion (optional)	Extrusion	Number	item	20	Total extrusion height in mm (split equally above and below)

Outputs

Name	Nickname	Type	Access	Description
Cylinder	Cyl	Brep	item	Ring cylinder Brep
Base Circle	Circle	Curve	item	Base circle at ring plane

Ring Extrude

Ring extruded from a frontal profile, shaped by a lateral profile: top, side and bottom lengths and thicknesses

Nickname: Ring Extrude · Tab: Shanks › Tools

Inputs

Name	Nickname	Type	Access	Default	Description
Ring Diameter	Diameter	Number	item	16.92	Finger size diameter
Frontal Profile (optional)	Frontal	Generic	item	—	External ring profile Asset (Ring External Profile by Name / Asset Selector). Default: the default external profile
Lateral Profile (optional)	Lateral	Generic	item	—	Ring side curve Asset. Default: the default side curve
Top Length	TopL	Number	item	d.TopLength	Length of the top segment
Side Length	SideL	Number	item	d.SideLength	Length of the side segments
Bottom Length	BottomL	Number	item	d.BottomLength	Length of the bottom segment
Top Thickness	TopT	Number	item	d.TopThickness	Thickness at the top
Bottom Thickness	BottomT	Number	item	d.BottomThickness	Thickness at the bottom
Hollow	Hollow	Boolean	item	d.IsHollow	Hollow the ring
Symmetry	Sym	Text	item	d.Symmetry.ToString()	SYMMETRIC or ASYMMETRIC
Linear Thickness	LinearT	Number	item	d.LinearThickness	Linear thickness (asymmetric mode)
Angle	Angle	Number	item	d.Angle	Angle (asymmetric mode, degrees)
Advanced Top Thickness	AdvTopT	Number	item	d.AdvancedTopThickness	Top thickness (asymmetric mode)
Advanced Lateral Thickness	AdvLatT	Number	item	d.AdvancedLateralThickness	Lateral thickness (asymmetric mode)
Plane	Plane	Plane	item	Plane.WorldXY	Ring plane

Outputs

Name	Nickname	Type	Access	Description
Brep	Brep	Brep	item	Ring Brep
Curves	Curves	Curve	list	Construction curves
Magnet Top	Magnet Top	Point	item	Top center of the bounding box
Magnet Bottom	Magnet Bot.	Point	item	Bottom center of the bounding box

Scoop Ring

Hollows the selected faces of a ring brep over a central angle, leaving a wall and an optional liner

Nickname: Scoop Ring · Tab: Shanks › Tools

Inputs

Name	Nickname	Type	Access	Default	Description
Ring	Ring	Brep	item	—	Ring brep to scoop
Faces	Faces	Integer	list	—	Indices of the faces to scoop away (the inner faces)
Thickness	T	Number	item	d.Thickness	Wall thickness left after scooping
Central Angle	Angle	Number	item	d.CentralAngle	Scooped angle at the bottom of the ring (degrees)
Transition Angle	Transition	Number	item	d.TransitionAngle	Transition angle at each end (degrees)
Transition Inset	Inset	Number	item	d.TransitionInset	Inset of the transition
Smoothing	Smooth	Integer	item	d.Smoothing	Smoothing of the scoop edge
Liner	Liner	Boolean	item	d.LinerEnabled	Add a liner inside the scoop
Liner Thickness	LinerT	Number	item	d.LinearThickness	Liner thickness
Liner Swap	Swap	Boolean	item	d.LinerSwap	Swap the liner side
Plane	Plane	Plane	item	Plane.WorldXY	Ring plane (the finger axis is its Y axis, like a ring built on World XY)

Outputs

Name	Nickname	Type	Access	Description
Ring	Ring	Brep	item	Scooped ring
Liner	Liner	Brep	list	Liner breps (when enabled)
Removed	Removed	Brep	item	The scooped-away volume
Inner Curves	Inner	Curve	list	Inner scoop curves
Outer Curves	Outer	Curve	list	Outer scoop curves

Ring Curve - Parameters

Parameters for RingCurve (Type, Bypass, Shape, etc.)

Nickname: Ring Curve Params · Tab: Shanks › Tools · In the tab’s dropdown, not on the ribbon face

Inputs

Name	Nickname	Type	Access	Default	Description
Type	Type	Text	item	CLOSE	Curve type (CLOSE, OPEN, BYPASS, SHAPE)
Opening Length	OpenLen	Number	item	5	Opening length
Bypass Opening Length	BypLen	Number	item	14	Bypass opening length
Bypass Angle	BypAng	Number	item	0	Bypass angle
Bypass Offset X	BypX	Number	item	2	Bypass offset in X
Bypass Offset Y	BypY	Number	item	2	Bypass offset in Y
Bypass Tangent	BypTan	Number	item	1	Bypass tangent
Shape Opening Length	ShpLen	Number	item	14	Shape opening length
Shape Type	ShpType	Text	item	ROUND	Shape type (ROUND, SQUARE, etc.)
Shape Width	ShpW	Number	item	6	Shape width
Shape Height	ShpH	Number	item	4	Shape height
Shape Diameter	ShpD	Number	item	5	Shape diameter
Shape Offset	ShpOff	Number	item	1	Shape offset
Shape Move Z	ShpZ	Number	item	2	Shape move in Z
Shape Start Circle	ShpStart	Number	item	0.3	Shape start position on circle
Shape End Circle	ShpEnd	Number	item	Math.PI - 0.3	Shape end position on circle

Outputs

Name	Nickname	Type	Access	Description
RingCurve Params	Params	Generic	item	Dictionary of RingCurve parameters