Skip to content

.NET API

HuggieApi

Huggie earring (the ArtisanHuggie tool): closed hoop with hinge, or opened hoop with post.

from ArtisanPlugin.Scripting import HuggieApi

See also the Python package, ra.huggie.

Methods

Method
Createmode is “CLOSED” (hoop with hinge, default) or “OPENED” (partial hoop with post).

Create

Guid HuggieApi.Create(
    Plane? plane = null,
    double innerWidth = 0,
    double innerHeight = 0,
    string mode = null,
    double aperture = 0,
    double aperturePercentage = -1,
    string profile = null)

mode is “CLOSED” (hoop with hinge, default) or “OPENED” (partial hoop with post). aperture is the closed-mode opening in mm (default 6.5); aperturePercentage is the opened-mode opening as a 0..1 fraction (default 0.25, pass -1 to keep it). profile names a ring-profile asset applied to the three huggie profiles. Defaults: inner width 15, inner height 20.

ParameterTypeDefault
planePlane?null
innerWidthdouble0
innerHeightdouble0
modestringnull
aperturedouble0
aperturePercentagedouble-1
profilestringnull

Returns Guid.