ra.pattern

Repeated patterns over surfaces.

import rhinoartisan as ra

Wraps ArtisanPlugin.Scripting.PatternApi.

Functions

Function
create()	Repeats the source object in a columns x rows grid (defaults 2x3), then, when surface_id is given, flows the whole grid onto that surface (Sporph).

ra.pattern.create()

ra.pattern.create(object_id: IdLike, surface_id=None, columns=None, rows=None, x_padding=None, y_padding=None, rotation=None, z_move=None, max_thickness=None, reverse_mode=None) -> List[str]

Repeats the source object in a columns x rows grid (defaults 2x3), then, when surface_id is given, flows the whole grid onto that surface (Sporph). rotation (deg) accumulates per cell around Z; z_move lifts the source before arraying; max_thickness > 0 also rescales the source in Z to that thickness. reverse_mode mirrors the flow surface: 0 none, 1 reverse U, 2 reverse V, 3 both (-1 keeps the default). Paddings, rotation and z_move of 0 keep the saved/tool defaults (which are 0). Returns the created object ids; the source object is left untouched, exactly like the panel.

Parameter	Type
object_id	IdLike	required
surface_id	Optional[IdLike]	optional — None = the tool default
columns	int	optional — None = the tool default
rows	int	optional — None = the tool default
x_padding	float	optional — None = the tool default
y_padding	float	optional — None = the tool default
rotation	float	optional — None = the tool default
z_move	float	optional — None = the tool default
max_thickness	float	optional — None = the tool default
reverse_mode	int	optional — None = the tool default