Skip to main content

Copy

Extends SceneObject

Inherited from SceneObject

name()​

name(value: string): this

Sets a custom display name for this object, overriding the default type-based name.

ParameterTypeDescription
valuestringThe display name to assign.

Methods​

instance()​

instance(index: number): ICopyInstance

Selects one grid slot of a 2D (in-sketch) copy as a whole geometry — every edge at that position, usable wherever a whole geometry operand is accepted (e.g. offset(2, cp.instance(1))). The copy owns only the duplicates it stamps; the original keeps its own statement, and its slot resolves through that source geometry. Linear copies linearize the grid in axis order (the first axis varies slowest), with the original at its own slot — 0 when not centered, the center slot when centered. Circular copies count rotation steps with the original at 0, the same numbering the skip option uses. 3D copies do not support this accessor.

When the slot holds exactly one solver-backed edge (a copied line/arc/circle/point statement) the instance is also a constraint target: parallel(cp.instance(1), l) constrains the slot's duplicate entity, which is rigidly tied to its source — the source (and every other duplicate) moves with it. The ORIGINAL's slot resolves to the source statement's own entity, so constraining it is constraining the source. Slots with several edges, skipped slots, and slots whose source carries no solver identity (offset results, nested copies) error as constraint targets while remaining valid whole-geometry operands.

Returns: ICopyInstance

ParameterTypeDescription
indexnumberThe grid-slot index.