.NET API

RingExtrudeApi

Rings extruded from a frontal profile.

from ArtisanPlugin.Scripting import RingExtrudeApi

See also the Python package, ra.ring_extrude.

Methods

Method
`All`	Ids of every RingExtrude body in the active document.
`Create`	Builds a ring body by extruding silhouettes (the ArtisanRingExtrude tool, headless): a frontal silhouette (an EXTERNAL_RING_PROFILE asset) and a lateral silhouette (a RING_SIDE_CURVE asset) are grown around the finger circle by the lengths below and intersected — the quick way to get a wide, sculpted band.

All

IReadOnlyList<Guid> RingExtrudeApi.All()

Ids of every RingExtrude body in the active document.

Returns IReadOnlyList<Guid>.

Create

Guid RingExtrudeApi.Create(
    double topLength = 0,
    double sideLength = 0,
    double bottomLength = 0,
    double topThickness = 0,
    double bottomThickness = 0,
    bool? hollow = null,
    double linearThickness = 0,
    double angle = double.NaN,
    string symmetry = null,
    double advancedTopThickness = 0,
    double advancedLateralThickness = 0,
    string frontalProfile = null,
    string lateralProfile = null,
    double fingerDiameter = 0,
    Plane? plane = null)

Builds a ring body by extruding silhouettes (the ArtisanRingExtrude tool, headless): a frontal silhouette (an EXTERNAL_RING_PROFILE asset) and a lateral silhouette (a RING_SIDE_CURVE asset) are grown around the finger circle by the lengths below and intersected — the quick way to get a wide, sculpted band. Millimetres; 0 keeps the tool default (or the user’s saved defaults): topLength 2, sideLength 2, bottomLength 2 (metal over the finger at top / sides / bottom), topThickness 2, bottomThickness 2 (band width, frontal view). hollow true carves the inside with linearThickness (2), angle (degrees, NaN = 0), symmetry SYMMETRIC (default) | ASYMMETRIC with advancedTopThickness / advancedLateralThickness (2). frontalProfile / lateralProfile pick assets by name (see AssetsApi). fingerDiameter 0 = document ring size. plane omitted = world XY. Returns the Guid of the new ring body (a RingExtrude custom object).

Parameter	Type	Default
`topLength`	`double`	`0`
`sideLength`	`double`	`0`
`bottomLength`	`double`	`0`
`topThickness`	`double`	`0`
`bottomThickness`	`double`	`0`
`hollow`	`bool?`	`null`
`linearThickness`	`double`	`0`
`angle`	`double`	`double.NaN`
`symmetry`	`string`	`null`
`advancedTopThickness`	`double`	`0`
`advancedLateralThickness`	`double`	`0`
`frontalProfile`	`string`	`null`
`lateralProfile`	`string`	`null`
`fingerDiameter`	`double`	`0`
`plane`	`Plane?`	`null`

Returns Guid.