Miscellaneous Inquiries and Events
- Inquiries:
-
sd-am-inq-curr-avu-colors
sd-am-inq-curr-catch-range
sd-am-inq-curr-catch-mode
sd-am-inq-curr-catch-extent
sd-am-inq-drawing-up-todate
sd-am-inq-drawing-modified
- Events:
- Standard Annotation
Events
![Top of Page Top of Page](../../SideNav02_Top.png)
SD-AM-INQ-CURR-AVU-COLORS [function]
(sd-am-inq-curr-avu-colors)
- Description:
- Returns a list containing the current color settings for the Automatic
View Update (AVU).
- Parameters:
- Return Value:
-
{key/value LIST of GPNT3Ds} - The inquired RGB color settings, with the
following keys:
- :EQUAL_3D
- :NEW_3D
- :UPDATED_3D
- :TRANSFERRED_2D
- :UPDATED_2D
- :RECREATED_2D
- nil - An error occured.
![Top of Page Top of Page](../../SideNav02_Top.png)
SD-AM-INQ-CURR-CATCH-RANGE [function]
(sd-am-inq-curr-catch-range)
- Description:
- Returns the current catch range in pixels.
- Parameters:
- Return Value:
- {FIXNUM} - The current catch range.
- nil - An error occured.
![Top of Page Top of Page](../../SideNav02_Top.png)
SD-AM-INQ-CURR-CATCH-MODE [function]
(sd-am-inq-curr-catch-mode)
- Description:
- Returns the current catch mode.
- Parameters:
- Return Value:
-
{KEYWORD} - The current catch mode, one of the following:
- :ALL
- :VERTEX
- :INTERSECTION
- :ON_ELEMENT
- :CENTER
- :OFF
- nil - An error occured.
![Top of Page Top of Page](../../SideNav02_Top.png)
SD-AM-INQ-CURR-CATCH-EXTENT [function]
(sd-am-inq-curr-catch-extent)
- Description:
- Returns the current catch extent.
- Parameters:
- Return Value:
- {KEYWORD} - The current catch extent, either :NEXT_CATCH or
:PERMANENT.
- nil - An error occured.
![Top of Page Top of Page](../../SideNav02_Top.png)
SD-AM-INQ-DRAWING-UP-TO-DATE [function]
(sd-am-inq-drawing-up-to-date)
- Description:
- Returns the up-to-date status of the loaded drawing.
- Parameters:
- Return Value:
- t - if all views of the drawing are up-to-date
- nil - if at least one view is not up-to-date or does not have a
connection to a 3D view
![Top of Page Top of Page](../../SideNav02_Top.png)
SD-AM-INQ-DRAWING-MODIFIED [function]
(sd-am-inq-drawing-modified)
- Description:
- Returns the modify status of the loaded drawing.
- Parameters:
- Return Value:
- t - if the drawing is marked as modified
- nil - if the drawing is not modified
![Top of Page Top of Page](../../SideNav02_Top.png)
Standard Annotation Events
The following constants identify standard Annotation events which are
available for use. These constants can be used as parameters for the
event functions.
- *DOCU-CHANGE-OBJECT-TREE-EVENT*
- Processed when objects in the drawing browser have changed.
- *DOCU-CHANGE-SHEET-DATA-EVENT*
- Processed when sheet specific data have changed.
- *DOCU-CHANGE-CURRENT-SHEET-EVENT*
- Processed when another sheet has become the current sheet.
- *DOCU-CREATE-NEW-SHEET-EVENT*
- Processed when a new sheet has been created.
- *DOCU-PRE-UPDATE-ALL-EVENT*
- Processed before a set of views is updated. For details see this
chart.
- Following KEYWORD/VALUE pairs are passed to the function called by the
event
- :MODE (list :keyword {SEL_ITEM}) - the selected update
mode
- Keyword can be :DRAWING, :SHEET, :VIEW-SET, :ONE-VIEW or
:VIEW-LIST.
- SEL_ITEM corresponds to the updated sheet / view-set / view(s).
- :REMOTE :keyword - :SEND, :LOCAL or :RECEIVE
- *DOCU-POST-UPDATE-ALL-EVENT*
- Processed after a set of views is updated. For details see this
chart.
- Following KEYWORD/VALUE pairs are passed to the function called by the
event
- :MODE (list :keyword {SEL_ITEM}) - the selected update
mode
- Keyword can be :DRAWING, :SHEET, :VIEW-SET, :ONE-VIEW or
:VIEW-LIST.
- SEL_ITEM corresponds to the updated sheet / view-set / view(s).
- :REMOTE :keyword - :SEND, :LOCAL or :RECEIVE
- *DOCU-PRE-UPDATE-VIEW-EVENT*
- Processed before a single view is updated. For details see this
chart.
- Following KEYWORD/VALUE pairs are passed to the function called by the
event
- :V3D this view-3d {SEL_ITEM} - the corresponding 3D view
in the view set
- :V2D this view-2d {SEL_ITEM} - the Annotation 2D
view
- :UPN this-view-upn {STRING} - unique part name
- :NEW first_update {BOOLEAN} - T if view was not
updated before
- An Example: is listed
here
- *DOCU-POST-UPDATE-VIEW-EVENT*
- Processed after a single view is updated. For details see this
chart.
- Following KEYWORD/VALUE pairs are passed to the function called by the
event
- :V3D this view-3d {SEL_ITEM} - the corresponding 3D view
in the view set
- :V2D this view-2d {SEL_ITEM} - the Annotation 2D
view
- :UPN this-view-upn {STRING} - unique part name
- :NEW first_update {BOOLEAN} - T if view was not
updated before
- An Example: is listed
here
© 2024 Parametric
Technology GmbH
(a subsidiary of PTC Inc.), All Rights Reserved |