txGetFigSetBBox
txGetFigSetBBox(
T_figSet @key
(onlyTheseLayers l_onlyTheseLayers)
(onlyTheseLPPs l_onlyTheseLPPs)
(notTheseLayers l_notTheseLayers)
(notTheseLPPs l_notTheseLPPs)
(onlyTheseTypes l_onlyTheseTypes)
(notTheseTypes l_notTheseTypes)
)
=> l_bBox / nil
Description
Calculates the bounding box for the objects in the specified FigSet. The caller can optionally specify included and excluded layers, included and excluded layer-purpose pairs (LPPs), and included and excluded object types. The bounding box values are returned in user units.
Arguments
|
T_figSet
|
ID of the FigSet.
|
|
l_onlyTheseLayers
|
list([t_layerName | n_layerNum] ...)
A list of layer names or layer numbers. If specified, only the layers specified in the list are considered during the bounding box calculation.
|
|
l_onlyTheseLPPs
|
list([l_LPP] ...)
A list of layer-purpose pairs. If specified, only the layer-purpose pairs specified in the list are considered during the bounding box calculation.
where,
l_LPP: list([t_layerName | n_layerNum] t_purposeName)
A layer-purpose pair.
|
|
l_notTheseLayers
|
list([t_layerName | n_layerNum] ...)
A list of layer names or layer numbers. If specified, the layers specified in the list are excluded from the bounding box calculation.
|
|
l_notTheseLPPs
|
list([l_LPP] ...)
A list of layer-purpose pairs. If specified, the layer-purpose pairs specified in the list are excluded from the bounding box calculation.
|
|
l_onlyTheseTypes
|
list(t_typeName ...)
A list of CDB type names. If specified, only the objects of the types specified in the list are considered during the bounding box calculation.
|
|
l_notTheseTypes
|
list(t_typeName ...)
A list of CDB type names. If specified, the objects of the types specified in the list are excluded from the bounding box calculation.
|
Value Returned
|
l_bBox
|
Bounding box for the specified objects.
|
|
nil
|
Returned in case of failure.
|
Examples
Calculates the bounding box for the objects in the FigSet fs0.
rect0 = dbCreateRect(top '(0 "drawing") '((0 0) (100 100)))
> db:0x2e39ec9e
ellipse0 = dbCreateEllipse(top '(0 "drawing") '((0 0) (500 200)))
> db:0x2e39ec9f
fs0 = txCreateFigSet(top "fs0")
> tx@0x318ce1a0
txAppendObjectToFigSet(fs0 rect0)
> t
txAppendObjectToFigSet(fs0 ellipse0)
> t
txGetFigSetBBox(fs0)
> ((0.0 0.0)
> (500.0 200.0)
> )
Calculates the bounding box for the objects of type rect in the FigSet fs0.
txGetFigSetBBox(fs0 ?onlyTheseTypes '("rect"))
> ((0.0 0.0)
> (100.0 100.0)
> )
Related Topics
FigSet Functions
Return to top
