SoftARef

class ipkiss3.all.SoftARef

An array reference that automatically breaks down the array into individual single references (SREF)

Parameters:

n_o_periods: Tuple of <class ‘int’> and length == 2, required

Number of periods (Nx, Ny)

period: Coord2, required

Period of the array (period_x, period_y)

reference: _LayoutView, required

origin: Coord2, optional

Origin of the array

flatten: ( bool, bool_ or int ), optional

if True, it will insert the references elements on export, rather than the reference itself

name: ( String that contains only alphanumeric characters from the ASCII set or contains _$<>. ASCII set is extended on PY3. ), optional, *None allowed*

Unique name of the instance within the scope of the View/Cell

owner: ( _View ), optional, *None allowed*

link to the owner of the instance.In most cases this is automatically added by the _generate_instances method

transformation: GenericNoDistortTransform, optional

Other Parameters:

positions: locked

positions where the reference needs to be placed, with transformation applied.

See also

ARef

Notes

The original transformation will be applied to the positions of the SRefs returned, with the rotation performed around the origin of the SoftARef. The plain rotation (with the default rotation center, thus no translation incurred), the mirror, and the magnification will also be stored on the SRefs returned.