PlainBandApi

Single plain bands.

from ArtisanPlugin.Scripting import PlainBandApi

See also the Python package, ra.plain_band.

Methods

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

All

IReadOnlyList<IPlainBand> PlainBandApi.All()

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

Returns IReadOnlyList<IPlainBand>.

ByLayer

IReadOnlyList<IPlainBand> PlainBandApi.ByLayer(string layerName)

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

Parameter	Type	Default
layerName	string	required

Returns IReadOnlyList<IPlainBand>.

Count

int PlainBandApi.Count()

Number of objects of this kind in the active document.

Returns int.

Find

IPlainBand PlainBandApi.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 IPlainBand.

Selected

IReadOnlyList<IPlainBand> PlainBandApi.Selected()

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

Returns IReadOnlyList<IPlainBand>.

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.

IPlainBand

Handle — extends IParametricObject.

A single plain band.

Property	Type
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, "" when unset
RemoveChannel	bool	get	Shared and Scalloped: true leaves out the channel under the stones
Ring	IWeddingRing	get
ScallopBoolean	bool	get	Ring.Gems.ProngType Scalloped: true subtracts the cutters, false keeps them as objects
ScallopCutters	IScallopCutters	get	Scalloped: the cutters under each stone
ScallopVCutters	IScallopCutters	get	Scalloped: the V-cutters between the stones (Enabled turns them on)

Method
void Delete()	(from IParametricObject)
void Move(Vector3d translation)	(from IParametricObject)
void SetElement(string element)	Applies a saved PlainBand element (ElementsApi.List(“PlainBand”)) to this band: its profile, gems and metal replace the current ones, the ring size stays, and the band regenerates in place (same id).
void SetRemoveChannel(bool remove)
void SetScallopBoolean(bool boolean)

IScallopCutters

Section.

The scalloped cutters (under each stone) or V-cutters (between the stones) of a shank, editable. The members marked “cutters only” read as empty/0 on the V-cutters and refuse a set there. Each setter regenerates the owner in place.

Property	Type
Enabled	bool	get	V-cutters: whether they are built; the cutters are always on
EndHeight	double	get	mm
EndWidth	double	get	mm
Keep	bool	get	true = start and end move together (the panel’s Both Sides)
Length	double	get	mm
OverGirdle	double	get	mm, signed
OverGirdleMiddle	double	get	cutters only: mm, signed
Shape	string	get	cutters only: U_SHAPE or V_SHAPE
ShapeFactor	double	get	cutters only: 0-2
StartHeight	double	get	mm
StartWidth	double	get	mm

Method
void SetEnabled(bool enabled)
void SetEndHeight(double height)	mm, 0 or more (with Keep on, the start too)
void SetEndWidth(double width)	mm, 0 or more (with Keep on, the start too)
void SetKeep(bool keep)
void SetLength(double length)	mm, 0 or more
void SetOverGirdle(double overGirdle)	mm, signed
void SetOverGirdleMiddle(double overGirdle)	cutters only: mm, signed
void SetShape(string shape)	cutters only: U_SHAPE or V_SHAPE
void SetShapeFactor(double factor)	cutters only: 0-2
void SetStartHeight(double height)	mm, 0 or more (with Keep on, the end too)
void SetStartWidth(double width)	mm, 0 or more (with Keep on, the end too)

IWeddingRing

Section.

One ring of a wedding set, or the single band of a plain 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”; a plain band also “Scalloped”
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”; a plain band also “Scalloped” (its cutters: IPlainBand)
void SetShape(string shape)	”Round” or “Princess”
void SetVertical(double vertical)