AdvancedSignetRingApi

Advanced signet rings — the same face plus a lateral profile and an optional wedge cut at the bottom of the band.

from ArtisanPlugin.Scripting import AdvancedSignetRingApi

See also the Python package, ra.advanced_signet_ring.

Methods

Method
All	IAdvancedSignetRing handles for every object of this kind in the active document (empty when there is no document).
ByLayer	IAdvancedSignetRing handles on the layer with the given full path (empty when the layer does not exist).
Count	Number of objects of this kind in the active document.
Find	The handle for id, or null when the id does not belong to an object of this kind.
Selected	IAdvancedSignetRing handles for the objects of this kind currently selected in the active document.

All

IReadOnlyList<IAdvancedSignetRing> AdvancedSignetRingApi.All()

IAdvancedSignetRing handles for every object of this kind in the active document (empty when there is no document).

Returns IReadOnlyList<IAdvancedSignetRing>.

ByLayer

IReadOnlyList<IAdvancedSignetRing> AdvancedSignetRingApi.ByLayer(string layerName)

IAdvancedSignetRing handles on the layer with the given full path (empty when the layer does not exist).

Parameter	Type	Default
layerName	string	required

Returns IReadOnlyList<IAdvancedSignetRing>.

Count

int AdvancedSignetRingApi.Count()

Number of objects of this kind in the active document.

Returns int.

Find

IAdvancedSignetRing AdvancedSignetRingApi.Find(Guid id)

The handle for id, or null when the id does not belong to an object of this kind.

Parameter	Type	Default
id	Guid	required

Returns IAdvancedSignetRing.

Selected

IReadOnlyList<IAdvancedSignetRing> AdvancedSignetRingApi.Selected()

IAdvancedSignetRing handles for the objects of this kind currently selected in the active document.

Returns IReadOnlyList<IAdvancedSignetRing>.

Handles and sections

What the methods above hand back. A handle’s setters regenerate the object; wrap changes in a Transaction so they land as one undo step.

IAdvancedSignetRing

Handle — extends IParametricObject.

Advanced signet ring: the same face, plus a lateral profile that shapes the sides and an optional wedge cut at the bottom of the band.

Property	Type
BottomCutAngle	double	get	total opening of the bottom wedge cut, degrees; 0 = no cut
Face	ISignetFace	get
Id	Guid	get	(from IParametricObject)
LateralProfileName	string	get	asset shaping the sides, "" when unset
LayerName	string	get	(from IParametricObject)
MotherGemId	Guid	get	(from IParametricObject)
ObjectType	string	get	(from IParametricObject)
Position	Point3d	get	(from IParametricObject)
RingDiameterMm	double	get
RingSizeLabel	string	get
RingSizeRegion	string	get

Method
void Delete()	(from IParametricObject)
void Move(Vector3d translation)	(from IParametricObject)
void SetBottomCutAngle(double degrees)	0 disables the cut
void SetElement(string element)	Applies a saved AdvancedSignetRing element (ElementsApi.List(“AdvancedSignetRing”)) to this ring: its parameters replace the current ones, the ring size stays, and the ring regenerates in place (same id).
void SetLateralProfile(string assetName)

ISignetFace

Section.

The signet face and the band under it — shared by the classic signet and the advanced one. A live view over the ring’s stored parameters: getters read the current values, setters regenerate the ring in place (same Guid) and are license-gated.

Property	Type
Height	double	get	face height, mm
HeightBottomProfile	double	get	mm
HeightMiddleProfile	double	get	mm
HeightPosition	double	get	how high the face sits over the finger, mm
InnerHeight	double	get	mm — used when Recess is on
ProfileName	string	get	RING_PROFILE asset name, "" when unset
Recess	bool	get	hollow the back of the face
Rotation	double	get	degrees
ShapeMode	string	get	”Circle” or “Custom”
Tangent	double	get
Thickness	double	get	mm — used when Recess is on
Width	double	get	face width, mm
WidthBottomProfile	double	get	band section at the bottom, mm
WidthMiddleProfile	double	get	band section at the middle, mm

Method
void SetBottomProfile(double width, double height)
void SetHeight(double height)
void SetHeightPosition(double position)
void SetInnerHeight(double height)
void SetMiddleProfile(double width, double height)
void SetProfile(string assetName)	RING_PROFILE asset by name — list them with AssetsApi.List(“RING_PROFILE”)
void SetRecess(bool recess)
void SetRotation(double degrees)
void SetShapeMode(string shapeMode)	”Circle” or “Custom”
void SetTangent(double tangent)
void SetThickness(double thickness)
void SetWidth(double width)