PatternApi

Rectangular array of an object, optionally flowed onto a surface (the ArtisanPattern tool).

from ArtisanPlugin.Scripting import PatternApi

See also the guide, Accessories › Pattern, and the Python package, ra.pattern.

Methods

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

Create

IReadOnlyList<Guid> PatternApi.Create(
    Guid objectId,
    Guid? surfaceId = null,
    int columns = 0,
    int rows = 0,
    double xPadding = 0,
    double yPadding = 0,
    double rotation = 0,
    double zMove = 0,
    double maxThickness = 0,
    int reverseMode = -1)

Repeats the source object in a columns x rows grid (defaults 2x3), then, when surfaceId is given, flows the whole grid onto that surface (Sporph). rotation (deg) accumulates per cell around Z; zMove lifts the source before arraying; maxThickness > 0 also rescales the source in Z to that thickness. reverseMode mirrors the flow surface: 0 none, 1 reverse U, 2 reverse V, 3 both (-1 keeps the default). Paddings, rotation and zMove 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	Default
objectId	Guid	required
surfaceId	Guid?	null
columns	int	0
rows	int	0
xPadding	double	0
yPadding	double	0
rotation	double	0
zMove	double	0
maxThickness	double	0
reverseMode	int	-1

Returns IReadOnlyList<Guid>.