gpeCreateAlignmentAndSpacing
gpeCreateAlignmentAndSpacing(
u_sandbox
[?hAlignType { left | right | custom_left | custom_right | center }]
[?hSpacing f_spacing]
[?hRefLayer t_layerName]
[?hRefPurpose t_purposeName]
[?vAlignType { bottom | top | custom_bottom | custom_top | center }]
[?vSpacing f_spacing]
[?vRefLayer t_layerName]
[?vRefPurpose t_purposeName]
[?useDefaultForUnspecifiedArgs { t | nil } ]
[ ?verbose { t | nil } ]
)
=> t / nil
Description
Specifies the alignment and spacing settings for all the grid entries in the given Modgen sandbox object.
Arguments
|
u_sandbox
|
|
|
Specifies the Modgen sandbox object.
|
|
?hAlignType { left | right | custom_left | custom_right | center }
|
|
|
Specifies the horizontal alignment. The default value is left.
If not specified, but a horizontal spacing is specified, custom_left is considered to be the default.
|
|
?hSpacing f_spacing
|
|
|
Specifies the horizontal spacing. If unspecified, the default value is 0.0.
|
|
?hRefLayer t_layerName
|
|
|
Specifies the name of the layer to be used as the reference to determine the horizontal spacing.
|
|
?hRefPurpose t_purposeName
|
|
|
Specifies the name of the purpose to be used as the reference to determine the horizontal spacing.
When a horizontal spacing value is specified and the reference layer and purpose are not specified, then the Modgen master bounding box is considered to be the reference.
|
|
?vAlignType { bottom | top | custom_bottom | custom_top | center }
|
|
|
Specifies the vertical alignment. The default value is bottom.
If the vertical alignment is not specified, but a vertical spacing is specified, custom_bottom is considered to be the default.
|
|
?vSpacing f_spacing
|
|
|
Specifies the vertical spacing. If unspecified, the default value is 0.0.
|
|
?vRefLayer t_layerName
|
|
|
Specifies the name of the layer to be used as the reference to determine the vertical spacing.
|
|
?vRefPurpose t_purposeName
|
|
|
Specifies the name of the purpose to be used as the reference to determine the vertical spacing.
When a vertical spacing value is specified and the reference layer and purpose are not specified, then the Modgen master bounding box is considered to be the reference.
|
|
?useDefaultForUnspecifiedArgs { t | nil }
|
|
|
Indicates that if any alignment is not defined, it should be set to its default value. The default value is nil. For example, if a new value is not provided for an alignment setting, the existing value is not overwritten.
|
|
?verbose { t | nil }
|
Controls the display of warning messages.
|
Value Returned
|
t
|
The specified alignment and spacing settings were set.
|
|
nil
|
The command was unsuccessful.
|
Examples
Sets the sbox horizontal alignment to right and vertical spacing to 10.0. The vertical alignment is not specified, and the default custom_bottom is used.
gpeCreateAlignmentAndSpacing(sbox ?hAlignType "right" ?vSpacing 10.0)
=> t
Sets the sbox horizontal alignment to custom_right and spacing to 5.0. The reference is Metal1 drawing. The vertical alignment is set to bottom.
gpeCreateAlignmentAndSpacing(sbox ?hAlignType "custom_right" hSpacing 5.0 ?hRefLayer "Metal1" ?hRefPurpose "drawing" ?useDefaultForUnspecifiedArgs t)
=> t
Sets the sbox alignment to left and bottom and spacing to 0.0, which are the default values.
gpeCreateAlignmentAndSpacing(sbox ?useDefaultForUnspecifiedArgs t)
=> t
Return to top
