Product Documentation
Virtuoso Layout Suite SKILL Reference
Product Version IC23.1, November 2023

leGetSnapToSPTransform

leGetSnapToSPTransform(
figId
[ ?snapPatternDepth n_snapPatternDepth ]
[ ?movingItemDepth n_movingItemDepth ]
[ ?snapPatternLPP g_snapPatternLPP ]
)
=> x_InstTransform

Description

Returns the transform required to align the given figure with an underlying snap pattern or global grid. If a transform is not found, the function returns the identity transform.

Arguments

figId

The figure ID of the input figure. The valid figure types are instances, rectangles, polygons, vias, and figGroups.

?snapPatternDepth n_snapPatternDepth

The hierarchy depth to be used when looking for snap patterns in fixed instances. The default is 0.

?movingItemDepth n_movingItemDepth

The hierarchy depth to be used when looking for snap patterns or active shapes while moving instances. The default is 1.

?snapPatternLPP g_snapPatternLPP

The LPP of the snap pattern that is active for snapping. If a value is provided, then snap patterns on other LPPs are ignored for snapping. The default is nil, which implies that all snap patterns are active.

Value Returned

x_InstTransform

Returns the transform required to align the given figure ID with an underlying snap pattern or global grid. If a transform is not found, then the function returns the identity transform.

Example

leGetSnapToSPTransform(fig)
leGetSnapToSPTransform(fig ?snapPatternLPP "FinArea type3")
leGetSnapToSPTransform(fig ?snapPatternDepth 1)
leGetSnapToSPTransform(css() ?movingItemDepth 0)

Return to top
 ⠀
X