ra.pave

Automatic pave over surfaces: one size in a regular grid, with prongs and cutters.

import rhinoartisan as ra

Wraps ArtisanPlugin.Scripting.PaveApi.

Functions

Function
on_surface()	Paves the given objects.
on_surface_detailed()	Same as OnSurface, but returns every id it created — the gems, the prongs and the cutters — instead of only the gems.

ra.pave.on_surface()

ra.pave.on_surface(surface_ids: Sequence[IdLike], gem_diameter=None, prong_diameter=None, distance_to_border=None, prongs=None, cutters=None, variable_size=None, fill_mode=None, start_point=None, prong_over_girdle=None, prong_under_girdle=None, gap_mode=None, manual_gap=None, extra_gap=None, gem_inside=None, min_prongs_per_gem=None, prong_border_distance=None, border_from_prong=None, gem_diameter_min=None, prong_diameter_min=None, cutter_size_top=None, cutter_height_top=None, cutter_size_bottom=None, cutter_gem_inside=None) -> List[str]

Paves the given objects. Millimetres; omitting keeps the tool default: gem_diameter 1.3 (shrinking to gem_diameter_min 0.9 when variable_size), prong_diameter 0.8, distance_to_border 0.1. prongs/cutters toggle those outputs (tool defaults: prongs on, cutters off). fill_mode is FROM_BORDER (default) or FROM_CENTER; FROM_CENTER needs start_point on (or near) the surface. Returns the ids of the created gems.

Parameter	Type
surface_ids	Sequence[IdLike]	required
gem_diameter	float	optional — None = the tool default
prong_diameter	float	optional — None = the tool default
distance_to_border	float	optional — None = the tool default
prongs	bool	optional — None = the tool default
cutters	bool	optional — None = the tool default
variable_size	Optional[bool]	optional — None = the tool default
fill_mode	str	optional — None = the tool default
start_point	Optional[PointLike]	optional — None = the tool default
prong_over_girdle	float	optional — None = the tool default
prong_under_girdle	float	optional — None = the tool default
gap_mode	str	optional — None = the tool default
manual_gap	float	optional — None = the tool default
extra_gap	float	optional — None = the tool default
gem_inside	float	optional — None = the tool default
min_prongs_per_gem	int	optional — None = the tool default
prong_border_distance	float	optional — None = the tool default
border_from_prong	Optional[bool]	optional — None = the tool default
gem_diameter_min	float	optional — None = the tool default
prong_diameter_min	float	optional — None = the tool default
cutter_size_top	float	optional — None = the tool default
cutter_height_top	float	optional — None = the tool default
cutter_size_bottom	float	optional — None = the tool default
cutter_gem_inside	float	optional — None = the tool default

ra.pave.on_surface_detailed()

ra.pave.on_surface_detailed(surface_ids: Sequence[IdLike], gem_diameter=None, prong_diameter=None, distance_to_border=None, prongs=None, cutters=None, variable_size=None, fill_mode=None, start_point=None, prong_over_girdle=None, prong_under_girdle=None, gap_mode=None, manual_gap=None, extra_gap=None, gem_inside=None, min_prongs_per_gem=None, prong_border_distance=None, border_from_prong=None, gem_diameter_min=None, prong_diameter_min=None, cutter_size_top=None, cutter_height_top=None, cutter_size_bottom=None, cutter_gem_inside=None) -> PaveResult

Same as OnSurface, but returns every id it created — the gems, the prongs and the cutters — instead of only the gems. OnSurface threw the prong and cutter ids away, so a script could not select, re-layer or boolean what it had just built.

Parameter	Type
surface_ids	Sequence[IdLike]	required
gem_diameter	float	optional — None = the tool default
prong_diameter	float	optional — None = the tool default
distance_to_border	float	optional — None = the tool default
prongs	bool	optional — None = the tool default
cutters	bool	optional — None = the tool default
variable_size	Optional[bool]	optional — None = the tool default
fill_mode	str	optional — None = the tool default
start_point	Optional[PointLike]	optional — None = the tool default
prong_over_girdle	float	optional — None = the tool default
prong_under_girdle	float	optional — None = the tool default
gap_mode	str	optional — None = the tool default
manual_gap	float	optional — None = the tool default
extra_gap	float	optional — None = the tool default
gem_inside	float	optional — None = the tool default
min_prongs_per_gem	int	optional — None = the tool default
prong_border_distance	float	optional — None = the tool default
border_from_prong	Optional[bool]	optional — None = the tool default
gem_diameter_min	float	optional — None = the tool default
prong_diameter_min	float	optional — None = the tool default
cutter_size_top	float	optional — None = the tool default
cutter_height_top	float	optional — None = the tool default
cutter_size_bottom	float	optional — None = the tool default
cutter_gem_inside	float	optional — None = the tool default