ra.ring_curve

Ring rail curves at the document finger size (closed, open, bypass, shaped).

import rhinoartisan as ra

Wraps ArtisanPlugin.Scripting.RingCurveApi.

Functions

Function
create_bypass()	A bypass ring curve (crossed ends).
create_closed()	A closed ring curve (full circle at the finger size).
create_open()	An open ring curve (circle with a gap).
create_shape()	shape_type is “ROUND” (uses diameter) or “ELLIPSE” (uses width x height).

ra.ring_curve.create_bypass()

ra.ring_curve.create_bypass(opening_length=None, angle=None, offset_x=None, offset_y=None, tangent=None, finger_diameter=None, plane=None, profile=None, element=None) -> str

A bypass ring curve (crossed ends). element = name of a saved RingCurve element (ra.elements.list(“RingCurve”)) to start from; explicit arguments override it — with an element, an argument left at its signature default keeps the element’s value (its finger size is always replaced, and the curve type is always BYPASS).

Parameter	Type
opening_length	float	optional — None = the tool default
angle	float	optional — None = the tool default
offset_x	float	optional — None = the tool default
offset_y	float	optional — None = the tool default
tangent	float	optional — None = the tool default
finger_diameter	float	optional — None = the tool default
plane	Optional[PlaneLike]	optional — None = the tool default
profile	str	optional — None = the tool default
element	str	optional — None = the tool default

ra.ring_curve.create_closed()

ra.ring_curve.create_closed(finger_diameter=None, plane=None, profile=None, element=None) -> str

A closed ring curve (full circle at the finger size). element = name of a saved RingCurve element (ra.elements.list(“RingCurve”)) to start from; explicit arguments override it (its finger size is always replaced, and the curve type is always CLOSE).

Parameter	Type
finger_diameter	float	optional — None = the tool default
plane	Optional[PlaneLike]	optional — None = the tool default
profile	str	optional — None = the tool default
element	str	optional — None = the tool default

ra.ring_curve.create_open()

ra.ring_curve.create_open(opening_length=None, finger_diameter=None, plane=None, profile=None, element=None) -> str

An open ring curve (circle with a gap). element = name of a saved RingCurve element (ra.elements.list(“RingCurve”)) to start from; explicit arguments override it — with an element, an argument left at its signature default keeps the element’s value (its finger size is always replaced, and the curve type is always OPEN).

Parameter	Type
opening_length	float	optional — None = the tool default
finger_diameter	float	optional — None = the tool default
plane	Optional[PlaneLike]	optional — None = the tool default
profile	str	optional — None = the tool default
element	str	optional — None = the tool default

ra.ring_curve.create_shape()

ra.ring_curve.create_shape(shape_type=None, diameter=None, width=None, height=None, offset=None, move_in_z=None, opening_length=None, finger_diameter=None, plane=None, profile=None, element=None) -> str

shape_type is “ROUND” (uses diameter) or “ELLIPSE” (uses width x height). element = name of a saved RingCurve element (ra.elements.list(“RingCurve”)) to start from; explicit arguments override it — with an element, an argument left at its signature default keeps the element’s value (its finger size is always replaced, and the curve type is always SHAPE).

Parameter	Type
shape_type	str	optional — None = the tool default
diameter	float	optional — None = the tool default
width	float	optional — None = the tool default
height	float	optional — None = the tool default
offset	float	optional — None = the tool default
move_in_z	float	optional — None = the tool default
opening_length	float	optional — None = the tool default
finger_diameter	float	optional — None = the tool default
plane	Optional[PlaneLike]	optional — None = the tool default
profile	str	optional — None = the tool default
element	str	optional — None = the tool default