WeddingApi

Wedding sets — his-and-hers pairs baked as one group. Query-only for now: run ArtisanWeddingRing in the UI once, then script every variant from the handle it leaves behind.

from ArtisanPlugin.Scripting import WeddingApi

See also the guide, Shanks › Wedding, and the Python package, ra.wedding.

Methods

Method
All	IWedding handles for every object of this kind in the active document (empty when there is no document).
ByLayer	IWedding 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	IWedding handles for the objects of this kind currently selected in the active document.

All

IReadOnlyList<IWedding> WeddingApi.All()

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

Returns IReadOnlyList<IWedding>.

ByLayer

IReadOnlyList<IWedding> WeddingApi.ByLayer(string layerName)

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

Parameter	Type	Default
layerName	string	required

Returns IReadOnlyList<IWedding>.

Count

int WeddingApi.Count()

Number of objects of this kind in the active document.

Returns int.

Find

IWedding WeddingApi.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 IWedding.

Selected

IReadOnlyList<IWedding> WeddingApi.Selected()

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

Returns IReadOnlyList<IWedding>.

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.

IWedding

Handle — extends IParametricObject.

A wedding set: the two rings baked together as one group.

Property	Type
FirstRing	IWeddingRing	get
Id	Guid	get	(from IParametricObject)
LayerName	string	get	(from IParametricObject)
MotherGemId	Guid	get	(from IParametricObject)
ObjectType	string	get	(from IParametricObject)
Position	Point3d	get	(from IParametricObject)
Region	string	get	sizing region of the set, "" when unset
SecondRing	IWeddingRing	get

Method
void Delete()	(from IParametricObject)
void Move(Vector3d translation)	(from IParametricObject)

IWeddingRing

Section.

One ring of a wedding set, or the single band of a wedding band.

Property	Type
Gems	IWeddingGems	get
Metal	string	get	e.g. “GOLD_YELLOW_18”
Profile	IWeddingProfile	get
RingDiameterMm	double	get
RingSizeLabel	string	get
RingSizeRegion	string	get

Method
void SetMetal(string metal)

IWeddingProfile

Section.

The band section of a wedding ring: its section and profile asset.

Property	Type
Height	double	get	mm
ProfileName	string	get	RING_PROFILE asset name, "" when unset
Width	double	get	mm

Method
void SetHeight(double height)
void SetProfile(string assetName)	list them with AssetsApi.List(“RING_PROFILE”)
void SetWidth(double width)

IWeddingGems

Section.

The stones a wedding ring can carry around its band.

Property	Type
AutomaticProngDiameter	bool	get
CustomDistance	string	get	”Continuous” or “Equidistant”
Distribution	string	get	”Full”, “Half”, “Onequarter” or “Custom”
DrillHeight	double	get	mm
DrillType	string	get	”NONE”, “ROUND” or “QUAD”
DrillWidth	double	get	mm
Enabled	bool	get
ExtensionManufacturing	double	get	mm
GemInside	double	get	mm
GemSize	double	get	mm
InnerHeight	double	get	inner channel height, mm
InnerWidth	double	get	inner channel width, mm
MinDistance	double	get	mm
NumberOfGems	int	get	used when Distribution is “Custom”
ProngDiameter	double	get	mm
ProngHeight	double	get	mm
ProngMoveInZ	double	get	mm
ProngType	string	get	”None”, “Shared” or “Channel”
Shape	string	get	”Round” or “Princess”
Vertical	double	get	mm

Method
void SetAutomaticProngDiameter(bool automatic)
void SetCustomDistance(string customDistance)	”Continuous” or “Equidistant”
void SetDistribution(string distribution)	”Full”, “Half”, “Onequarter” or “Custom”
void SetDrillHeight(double height)
void SetDrillType(string drillType)	”NONE”, “ROUND” or “QUAD”
void SetDrillWidth(double width)
void SetEnabled(bool enabled)
void SetExtensionManufacturing(double extension)
void SetGemInside(double gemInside)
void SetGemSize(double size)
void SetInnerHeight(double height)
void SetInnerWidth(double width)
void SetMinDistance(double distance)
void SetNumberOfGems(int count)
void SetProngDiameter(double diameter)
void SetProngHeight(double height)
void SetProngMoveInZ(double move)
void SetProngType(string prongType)	”None”, “Shared” or “Channel”
void SetShape(string shape)	”Round” or “Princess”
void SetVertical(double vertical)