[Integration Kit Contents] [Integration Kit What's New] [Integration Kit Function Index] [More Documentation] [PTC]

3D Documentation - Annotation Inquiries

Annotation Properties
sd-inq-3d-annotation-props
sd-inq-3d-annotation-settings
sd-inq-3d-annotation-type
sd-inq-3d-annotation-value
sd-inq-3d-annotation-open-ref
sd-inq-3d-annotation-tolerance
sd-inq-3d-annotation-fixtext
sd-inq-3d-annotation-reference
sd-inq-3d-annotation-reference-position
sd-inq-3d-annotation-secondary-reference
sd-inq-3d-annotation-docuplane
sd-inq-3d-annotation-position
sd-inq-3d-annotation-refline-intermediate-points
sd-inq-3d-annotation-symbol-parameter

Annotation Default Settings
sd-inq-3d-annotation-default-settings
sd-inq-3d-annotation-attachment
sd-inq-3d-annotation-cust-feat
sd-inq-cust-feat-3d-annotation
sd-inq-feature-point-vertex

Working with Annotations
sd-inq-obj-3d-annotations
sd-inq-3d-annotation-owner
sd-3d-annotation-p
sd-dimension-p
sd-gdt-p
sd-feature-point-p
sd-surface-symbol-p
sd-welding-symbol-p
sd-user-defined-symbol-p
sd-inq-assigned-general-tolerances

Function Index Top of Page

SD-INQ-3D-ANNOTATION-PROPS  [function]

(sd-inq-3d-annotation-props 3d-annotation :values values)
Description:
Returns all properties of a 3D Annotation:

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire
values - Either
:all to get all possible return values
one specific keyword of the return list
a list of keywords of the return list

Return value:
property-list {LIST} - A property list containing key/value pairs for the requested properties
:type {KEYWORD} - one of the following:
:distance - Distance Annotation
:angle - Angle Annotation
:radius - Radius Annotation
:diameter - Diameter Annotation
:coordinate - Coordinate Annotation
:baseline_short - Baseline Annotation (Type: Short)
:baseline_long - Baseline Annotation (Type: Long)
:slot - GD&T Slot Annotation
:gdt_symbol - GD&T Datum or Tolerance Annotation
:symbol - Any other symbol like welding or surfacing
:text - 3D Note and generic Text Annotation (also labels of custom features)
:open_ref {BOOLEAN}
t if at least one of the reference elements is currently not available
nil if all references are satisfied
:first_ref {SEL_ITEM} - the first reference element.
:second_ref {SEL_ITEM} - the second reference element.
:refs {LIST} - list of SEL_ITEMs of the corresponding reference elements (including first_ref and second_ref)
:centerline {BOOLEAN} - t if centerline is on; nil if centerline is off
:minor {BOOLEAN} - t if minor option is on; nil if minor option is off
:major {BOOLEAN} - t if major option is on; nil if major option is off
:measure_dir {GPNT3D} - unit vector for the measure direction of dimensions; for GD&T symbols this equals to the zone_dir
:text_pos {GPNT3D} - position of the dimension-label text
:display_normal {GPNT3D} - unit vector for the normal of the plane the label lies in
:text_string {NUMBER} - text of a 3D Note or a generic text
:dim_value {NUMBER} - measured value of the 3D Dimension
:edited {BOOLEAN} - t if dimension is edited; nil if dimension is not edited
:edited_value {NUMBER} - edited value of the 3D Dimension
:tolerance_value1 {NUMBER} - limit1, plus/minus, upper tolerance value, upper value of general tolerance or zone_size1
:tolerance_value2 {NUMBER} - limit2, plus/minus, lower tolerance value, lower value of general tolerance or zone_size2
:tolerance_type {KEYWORD} - one of the following:
:none
:limit for 3D Dimensions
:upper_lower for 3D Dimensions
:plus_minus for 3D Dimensions
:general for 3D Dimensions
:basic for 3D Dimensions
:gdt_zone for GD&T symbols
:prefix {STRING} - prefix string of 3D Annotation
:postfix {STRING} - postfix string of 3D Annotation
:superfix {STRING} - superfix string of 3D Annotation
:subfix {STRING} - subfix string of 3D Annotation
nil - An error occurred.

Depending on the type of the 3D Annotation, one of the following property lists will be returned:

Note: For 3D Annotations with open references to elements or objects, only the following property list will be returned regardless of the type of the annotation:
(:type type :open_ref boolean )

Note: To extract values from the return list, use getf.

Example:
(sd-inq-3d-annotation-props  some-3d-annotation)
 => (:TYPE :DISTANCE
     :FIRST_REF #S(SEL_ITEM PATH
            (#S(NPARCEL SIMPLE-ENTITY-PTR 311786688)
             #S(NPARCEL SIMPLE-ENTITY-PTR 316253056))
            TYPE 311750096 ITEM #S(FACE SIMPLE-ENTITY-PTR 316800560))
     :SECOND_REF #S(SEL_ITEM PATH
            (#S(NPARCEL SIMPLE-ENTITY-PTR 311786688)
             #S(NPARCEL SIMPLE-ENTITY-PTR 316253056))
            TYPE 311750096 ITEM #S(FACE SIMPLE-ENTITY-PTR 316806464))
     :MEASURE_DIR 1.0,0.0,0.0
     :TEXT_POS 13.5,94.3,0.0
     :DISPLAY_NORMAL 0.0,0.0,1.0
     :DIM_VALUE 100.0
     :EDITED NIL
     :TOLERANCE_VALUE1 0.5
     :TOLERANCE_VALUE2 -0.5
     :TOLERANCE_TYPE :UPPER_LOWER
     :PREFIX ""
     :POSTFIX ""
     :SUPERFIX ""
     :SUBFIX ""
     :OPEN_REF NIL)

    (getf (sd-inq-3d-annotation-props some-3d-annotation) :tolerance_type)
    => :upper_lower

Function Index Top of Page

SD-INQ-3D-ANNOTATION-SETTINGS  [function]

(sd-inq-3d-annotation-settings 3d-annotation :values values)
Description:
Returns the settings for a 3D Annotation.

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire
values - Either
:all to get all possible return values
one specific keyword of the return list
a list of keywords of the return list

Return value:
property-list {LIST} - A property list containing key/value pairs for the settings
:color {NUMBER} - base color
:text_color {NUMBER} - text color, if different than base color
:geometry_color {NUMBER} - geometry color, if different than base color
:frame_type {KEYWORD} - one of the following:
:off - no frame
:box - frame is a box
:balloon - frame is a balloon
:location {KEYWORD} - one of the following:
:on_line - dim-text is on dim-line
:below_line - dim-text is below dim-line
:above_line - dim-text is above dim-line
:display_mode {KEYWORD} - one of the following:
:in_view - dim-text considers the current viewport direction
:in_plane - dim-text is in a fixed plane
:space {NUMBER} - distance between dim-text and dim-line
:arrow_size {NUMBER} - arrow size
:arrow_mode {KEYWORD} - one of the following:
:auto - arrows are inside, if there is enough space, otherwise they are outside
:inside - arrows are inside of the dim-line
:outside - arrows are outside of the dim-line
:orientation {KEYWORD} - one of the following:
:parallel - dim-text is parallel to the dim-line
:perpend - dim-text is perpend to the dim-line
:anchor_pnt {KEYWORD} - one of the following:
:upper - begin point of the reference line of a 3D text is on the upper corner of the text
:lower - begin point of the reference line of a 3D text is in the middle of the text
:lower - begin point of the reference line of a 3D text is on the lower corner of the text
:fixed - begin point of the reference line has a fixed position (i.e. within surface or welding symbols)
:first_arrow_type {KEYWORD} - arrow at first reference - one of the following:
:arrow
:slash
:dot
:jis
:triangle
:none
:second_arrow_type {KEYWORD} - arrow at second reference - one of the following:
:arrow
:slash
:dot
:jis
:triangle
:none
:arrow_filled {BOOLEAN} - t if arrow is solid; nil if arrow is outlined
:extension_line {NUMBER} - length of extension line that goes beyond the dimension line
:gap {NUMBER} - gap length between dimension line and dimension text (box) for location :on_line
:text_size {NUMBER} - text size
:text_font {STRING} - text font
:text_format_dec_pnt {KEYWORD} - one of the following:
:punct - decimal point is a dot
:comma - decimal point is a comma
:text_format_right_zero_suppr {BOOLEAN} - t if decimal zero suppressed on right side; nil if no zero suppression
:text_format_left_zero_suppr {BOOLEAN} - t if decimal zero suppressed on left side; nil if no zero suppression
:text_format_decimals {NUMBER} - number of decimal places
:tol_size {NUMBER} - tolerance size
:tol_font {STRING} - tolerance font
:tol_format_dec_pnt {KEYWORD} - one of the following:
:punct - decimal point is a dot
:comma - decimal point is a comma
:tol_format_right_zero_suppr {BOOLEAN} - t if decimal zero suppressed on right side; nil if no zero suppression
:tol_format_left_zero_suppr {BOOLEAN} - t if decimal zero suppressed on left side; nil if no zero suppression
:tol_format_decimals {NUMBER} - number of decimal places
:prefix_size {NUMBER} - prefix size
:prefix_font {STRING} - prefix font
:postfix_size {NUMBER} - postfix size
:postfix_font {STRING} - postfix font
:superfix_size {NUMBER} - superfix size
:superfix_font {STRING} - superfix font
:subfix_size {NUMBER} - subfix size
:subfix_font {STRING} - subfix font
nil - An error occurred.

Note: To extract values from the return list, use getf.

Example:
(sd-inq-3d-annotation-settings some-3d-annotation)
=> (:COLOR 65535 
    :TEXT_COLOR nil
    :GEOMETRY_COLOR nil
    :FRAME_TYPE :BALLOON 
    :LOCATION :ON_LINE 
    :SPACE 2.0 
    :ARROW_SIZE 3.5 
    :FIRST_ARROW_TYPE :DOT 
    :SECOND_ARROW_TYPE :JIS 
    :ARROW_FILLED NIL
    :EXTENSION_LINE 2
    :GAP 2
    :TEXT_SIZE 3.5 
    :TEXT_FONT "hp_block_v" 
    :TEXT_FORMAT_DEC_PNT PUNCT
    :TEXT_FORMAT_RIGHT_ZERO_SUPPR T
    :TEXT_FORMAT_LEFT_ZERO_SUPPR NIL
    :TEXT_FORMAT_DECIMALS 2 
    :TOL_SIZE 2.45
    :TOL_FONT "hp_i3098_v" 
    :TOL_FORMAT_DEC_PNT :PUNCT 
    :TOL_FORMAT_RIGHT_ZERO_SUPPR T 
    :TOL_FORMAT_LEFT_ZERO_SUPPR NIL 
    :TOL_FORMAT_DECIMALS 2
    :PREFIX_SIZE 3.5 
    :PREFIX_FONT "hp_i3098_v" 
    :POSTFIX_SIZE 3.5
    :POSTFIX_FONT "hp_i3098_v")

     (getf (sd-inq-3d-annotation-settings some-3d-annotation) :first_arrow_type)
    => :DOT
     

Function Index Top of Page

SD-INQ-3D-ANNOTATION-TYPE  [function]

(sd-inq-3d-annotation-type 3d-annotation)
Description:
Returns a keyword containing the type of a 3D Annotation.

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
type {KEYWORD} - one of the following:
:distance - Distance Annotation
:angle - Angle Annotation
:radius - Radius Annotation
:diameter - Diameter Annotation
:coordinate - Coordinate Annotation
:baseline_short - Baseline Annotation (Type: Short)
:baseline_long - Baseline Annotation (Type: Long)
:slot - GD&T Slot Annotation
:gdt_symbol - GD&T Datum or Tolerance Annotation
:surface_symbol - Surfacing symbol
:welding_symbol - Welding symbol
:custom_symbol - Any other symbol, like user-defined
:text - 3D Note and generic Text Annotation (also labels of custom features)
nil - An error occurred.

Example:
(sd-inq-3d-annotation-type some-3d-annotation)
 => ":angle"

Function Index Top of Page

SD-INQ-3D-ANNOTATION-VALUE  [function]

(sd-inq-3d-annotation-value 3d-annotation)
Description:
Returns the value of a 3D Annotation.
For dimensions: The function returns the nominal value. In case the dimenion was edited it returns the edited value.
For text: The function returns the label string
For any symbols: - The function returns nil

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
For non-edited dimensions - {NUMBER}
For edited dimensions - {STRING}
For texts - {STRING}
For GD&T symbols - nil
nil - when 3D Annotation has open references

Example:
(sd-inq-3d-annotation-value some-3d-annotation)
 => 42

Function Index Top of Page

SD-INQ-3D-ANNOTATION-OPEN-REF  [function]

(sd-inq-3d-annotation-open-ref 3d-annotation)
Description:
Returns t if the 3D Annotation has open references.
References to objects or elements can be open when their owner is currently not or only partially loaded.

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
t - At least one of the reference elements is currently not available.
nil - All references are satisfied.

Example:
(sd-inq-3d-annotation-open-ref some-3d-annotation)
 => t

Function Index Top of Page

SD-INQ-3D-ANNOTATION-TOLERANCE  [function]

(sd-inq-3d-annotation-tolerance 3d-annotation :values values)
Description:
Returns the tolerance type and the tolerance values of a 3D Annotation:

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire
values - Either
:all to get all possible return values
one specific keyword of the return list
a list of keywords of the return list

Return value:
For dimensions:
property-list {LIST} - A property list containing key/value pairs for
:tol_type {KEYWORD} - one of the following:
:none
:limit for 3D Dimensions
:upper_lower for 3D Dimensions
:plus_minus for 3D Dimensions
:general for 3D Dimensions
:basic for 3D Dimensions
:upper {NUMBER} - upper tolerance value
:lower {NUMBER} - lower tolerance value

For GD&T symbols:
:tol_type {KEYWORD} - i.e. :surface_profile
:gdt_zone_size1 {NUMBER} - First tolerance of the GD&T symbol
:gdt_zone_size2 {NUMBER} - Second tolerance of the GD&T symbol
:gdt_zone_shape1 {NUMBER} - First zone shape of the GD&T symbol
:gdt_zone_shape2 {NUMBER} - First zone shape of the GD&T symbol

For other annotations this function returns nil

Example:
(sd-inq-3d-annotation-tolerance some-3d-annotation :all)
 => (:LOWER -0.1 :UPPER 0.25 :TOL_TYPE :UPPER_LOWER)

Function Index Top of Page

SD-INQ-3D-ANNOTATION-FIXTEXT  [function]

(sd-inq-3d-annotation-fixtext 3d-annotation :values values)
Description:
Returns the fixtexts of a 3D Annotation:

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire
values - Either
:all to get all possible return values
one specific keyword of the return list
a list of keywords of the return list

Return value:
property-list {LIST} - A property list containing the fixtexts
:prefix {KEYWORD} - the prefix string or nil if not defined
:postfix {KEYWORD} - the postfix string or nil if not defined
:superfix {KEYWORD} - the superfix string or nil if not defined
:subfix {KEYWORD} - the subfix string or nil if not defined

Example:
(sd-inq-3d-annotation-fixtext some-3d-annotation :all)
 => (:PREFIX "A" :POSTFIX "B" :SUPERFIX nil :SUBFIX nil)

Function Index Top of Page

SD-INQ-3D-ANNOTATION-REFERENCE  [function]

(sd-inq-3d-annotation-reference 3d-annotation mode )
Description:
Returns the references of a 3D Annotation. References can be:
Vertices
Edges
Faces
Functional features
GD&T Datums

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire
mode - Either
[:refs] to get the references face / edge /ertex
:func_feat to get the referenced functional feature
:gdt_datums to get the referenced GD&T datum symbols

Return value:
For :refs: {LIST} - list of SEL_ITEMs of the corresponding face / edge / vertex
For :func_feat: {LIST} - list of SEL_ITEMs of the corresponding functional features
For :gdt_datums: {SEL_ITEM} or {LIST} - Either a sel_item (if there is only one datum) or a property list containing the GD&T datums:
:primary {KEYWORD} - the primary reference datum
:secondary {KEYWORD} - the secondary reference datum
:tertiary {KEYWORD} - the tertiary reference datum
nil - when 3D Annotation has open references

Example:
(sd-inq-3d-annotation-reference some-3d-annotation :refs)
 => (list face_sel_item1 face_sel_item2)

Function Index Top of Page

SD-INQ-3D-ANNOTATION-REFERENCE-POSITION  [function]

(sd-inq-3d-annotation-reference-position 3d-annotation)
Description:
Returns the position of all reference elements of a 3D Annotation.

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
{LIST} - list of gpnt3ds representing the reference positions
nil - when 3D Annotation has open references

Example:
(sd-inq-3d-annotation-reference-position some-3d-annotation)
 => (12.68,56.25,98.45 52.903,73.008,29.4204)

Function Index Top of Page

SD-INQ-3D-ANNOTATION-SECONDARY-REFERENCE  [function]

(sd-inq-3d-annotation-secondary-reference 3d-annotation )
Description:
Returns the secondary references of
a 3D generic text
a 3D surface symbol
a 3D welding symbol
a 3D user defined symbol

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation (of a type specified above) to inquire

Return value:
A list containing pairs with
SEL_ITEM - the secondary reference element
STRING - the textual identification or NIL
nil - when 3D Annotation has no secondary references

Example:
(sd-inq-3d-annotation-secondary-reference some-3d-annotation)
 => (list (list ref_sel_item NIL))
 => (list (list face_sel_item "Type1") (list (edge_sel_item "Type2"))

Function Index Top of Page

SD-INQ-3D-ANNOTATION-DOCUPLANE  [function]

(sd-inq-3d-annotation-docuplane 3d-annotation)
Description:
Returns the corresponding docuplane of a 3D Annotation.

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
{SEL_ITEM} - the sel_item of a docuplane
nil - for free annotations or annotations with open references

Example:
(sd-inq-3d-annotation-docuplane some-3d-annotation)
 => NIL

Function Index Top of Page

SD-INQ-3D-ANNOTATION-POSITION  [function]

(sd-inq-3d-annotation-position 3d-annotation)
Description:
Returns the position of the text of a 3D Annotation.

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
{GPNT3D} - The position of the nominal value of a dimension, the center of a text of a 3D spider text or the end of the stubline of a 3D Notes or a GD&T symbol.

Example:
(sd-inq-3d-annotation-position some-3d-annotation)
 => 52.903,73.008,29.4204

Function Index Top of Page

SD-INQ-3D-ANNOTATION-REFLINE-INTERMEDIATE-POINTS  [function]

(sd-inq-3d-annotation-refline-intermediate-points 3d-annotation)
Description:
The 3D Documentation command 'REFLINE' allows to modify the
reference line of a 3D Annotation in order to create intermediate points.
This function returns the position of these intermediate points (if there are any).

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
{List of Lists of GPNT3D} - representing the intermediate points of the reference line or NIL if there are no intermediate points

Examples:
(sd-inq-3d-annotation-refline-intermediate-points 3d-annotation-1) 
;;where 3d-annotation-1 has 1 reference line with two intermediate points.
 => ((52.903,73.008,29.4204 20.452,65.233,33.743))

(sd-inq-3d-annotation-refline-intermediate-points 3d-annotation-2) 
;;where 3d-annotation-2 has 2 reference lines.
;;one reference line has one intermediate point, 
;;the other reference line has two intermediate points.
 => ((45.782,77.352,12.523) (52.903,73.008,29.4204 20.452,65.233,33.743))

(sd-inq-3d-annotation-refline-intermediate-points 3d-annotation-3) 
;;where 3d-annotation-3 has 3 reference lines.
;;reference line 1 has one, reference line 2 has zero and reference line 3 has two intermediate points
 => ((45.782,77.352,12.523) nil (52.903,73.008,29.4204 20.452,65.233,33.743))

Function Index Top of Page

SD-INQ-3D-ANNOTATION-SYMBOL-PARAMETER  [function]

(sd-inq-3d-annotation-symbol-parameter 3d-annotation)
Description:
This function inquires all symbol parameters necessary to create and modify surface, welding or user defined symbols.

Parameters:
3d-annotation {SEL_ITEM} - the 3D symbol to inquire

Return value:
{PROPERTY LIST} - representing the symbol parameter

Examples:
(sd-inq-3d-annotation-symbol-parameter 3d-surface-symbol)
 => (list :A1 "2" :A2 "" :B "chromed" :C "" :D "" :E ""  :F ""
          :FORM 2 :SYMBOL-NAME "DOC3D_CREATE_SYMBOL_SURFACE")

(sd-inq-3d-annotation-symbol-parameter 3d-welding-symbol)
 => (list :G1 0 :G2 310 :G3 0 :G4 0 :G5 0 :G6 901 :G7 102 
          :POSITION :TO_LEFT :SHAPE 804 :SYMBOL-NAME "DOC3D_CREATE_SYMBOL_WELDING" 
          :T1 "2.5" :T2 "" :T3 "250" :T4 "" :T5 "10" :T6 "5" :T7 "Process")

(sd-inq-3d-annotation-symbol-parameter 3d-user-defined-symbol) 
 => (list :NUM 5 :SQUARE NIL :STR "S" :SYMBOL-NAME "DOC3D_CREATE_SYMBOL_SIMPLE")

Function Index Top of Page

SD-INQ-3D-ANNOTATION-DEFAULT-SETTINGS  [function]

(sd-inq-3d-annotation-default-settings type :values values)
Description:
Returns the default settings for 3D Annotations of the specified type

Parameters:
type {keyword} - One of
[:dimension]
:text
:gdt_symbol
:surface_symbol
:welding_symbol
:3d_symbol
values - Either
:all to get all possible return values
one specific keyword of the return list
a list of keywords of the return list

Return value:
property-list {LIST} - A property list containing key/value pairs for the default settings of the specified type
:color {NUMBER} - default color
:text_color {NUMBER} - default color for texts of symbols (if nil the default color is used)
:geometry_color {NUMBER} - default color for geometry of symbols (if nil the default color is used)
:frame_type {KEYWORD} - one of the following:
:off - no frame
:box - frame is a box
:balloon - frame is a balloon
:location {KEYWORD} - one of the following:
:on_line - dim-text is on dim-line
:below_line - dim-text is below dim-line
:above_line - dim-text is above dim-line
:display_mode {KEYWORD} - one of the following:
:in_view - dim-text considers the current viewport direction
:in_plane - dim-text is in a fixed plane
:space {NUMBER} - default distance between dim-text and dim-line
:arrow_size {NUMBER} - default arrow size
:arrow_mode {KEYWORD} - one of the following:
:auto - arrows are inside, if there is enough space, otherwise they are outside
:inside - arrows are inside of the dim-line
:outside - arrows are outside of the dim-line
:orientation {KEYWORD} - one of the following:
:parallel - dim-text is parallel to the dim-line
:perpend - dim-text is perpend to the dim-line
:anchor_pnt {KEYWORD} - one of the following:
:upper - begin point of the reference line of a 3D text is on the upper corner of the text
:lower - begin point of the reference line of a 3D text is in the middle of the text
:lower - begin point of the reference line of a 3D text is on the lower corner of the text
:fixed - begin point of the reference line of a 3D Symbol is fixed
:first_arrow_type {KEYWORD} - arrow at first reference - one of the following:
:arrow
:slash
:dot
:jis
:triangle
:none
:second_arrow_type {KEYWORD} - arrow at second reference - one of the following:
:arrow
:slash
:dot
:jis
:triangle
:none
:arrow_filled {BOOLEAN} - t if arrow is solid; nil if arrow is outlined
:extension_line {NUMBER} - default length of extension line that goes beyond the dimension line
:gap {NUMBER} - default gap length between dimension line and dimension text (box) for location :on_line
:text_size {NUMBER} - default text size
:text_font {STRING} - default text font
:text_format_dec_pnt {KEYWORD} - one of the following:
:punct - decimal point is a dot
:comma - decimal point is a comma
:text_format_right_zero_suppr {BOOLEAN} - t if decimal zero suppressed on right side; nil if no zero suppression
:text_format_left_zero_suppr {BOOLEAN} - t if decimal zero suppressed on left side; nil if no zero suppression
:text_format_decimals {NUMBER} - default number of decimal places
:tol_size {NUMBER} - default tolerance size
:tol_font {STRING} - default tolerance font
:tol_format_dec_pnt {KEYWORD} - one of the following:
:punct - decimal point is a dot
:comma - decimal point is a comma
:tol_format_right_zero_suppr {BOOLEAN} - t if decimal zero suppressed on right side; nil if no zero suppression
:tol_format_left_zero_suppr {BOOLEAN} - t if decimal zero suppressed on left side; nil if no zero suppression
:tol_format_decimals {NUMBER} - default number of decimal places
:prefix_size {NUMBER} - default prefix size
:prefix_font {STRING} - default prefix font
:postfix_size {NUMBER} - default postfix size
:postfix_font {STRING} - default postfix font
:superfix_size {NUMBER} - default superfix size
:superfix_font {STRING} - default superfix font
:subfix_size {NUMBER} - default subfix size
:subfix_font {STRING} - default subfix font
nil - An error occurred.

Note: To extract values from the return list, use getf.

Example:
(sd-inq-3d-annotation-default-settings :dimension :all)
=> (:COLOR 65280 
    :FRAME_TYPE :OFF 
    :LOCATION :ABOVE_LINE 
    :DISPLAY_MODE :IN_PLANE
    :SPACE 2.0 
    :ARROW_SIZE 3.5 
    :ARROW_MODE :AUTO
    :ORIENTATION :PARALLEL
    :FIRST_ARROW_TYPE :ARROW 
    :SECOND_ARROW_TYPE :ARROW 
    :ARROW_FILLED NIL 
    :EXTENSION_LINE 2
    :GAP 2
    :TEXT_SIZE 3.5 
    :TEXT_FONT "hp_i3098_v" 
    :TEXT_FORMAT_DEC_PNT :PUNCT
    :TEXT_FORMAT_RIGHT_ZERO_SUPPR T 
    :TEXT_FORMAT_LEFT_ZERO_SUPPR NIL
    :TEXT_FORMAT_DECIMALS 2 
    :TOL_SIZE 2.45 
    :TOL_FONT "hp_i3098_v" 
    :TOL_FORMAT_DEC_PNT :PUNCT 
    :TOL_FORMAT_RIGHT_ZERO_SUPPR T 
    :TOL_FORMAT_LEFT_ZERO_SUPPR NIL 
    :TOL_FORMAT_DECIMALS 2
    :PREFIX_SIZE 3.5 
    :PREFIX_FONT "hp_i3098_v" 
    :POSTFIX_SIZE 3.5
    :POSTFIX_FONT "hp_i3098_v"
    :SUPERFIX_SIZE 3.5 
    :SUPERFIX_FONT "hp_i3098_v" 
    :SUBFIX_SIZE 3.5 
    :SUBFIX_FONT "hp_i3098_v")

(getf (sd-inq-3d-annotation-default-settings) :location)
=> :ABOVE_LINE

Function Index Top of Page

SD-INQ-3D-ANNOTATION-ATTACHMENT  [function]

(sd-inq-3d-annotation-attachment)
Description:
Returns the attachment mode used for new 3D Annotations.

Return value:
attachment {KEYWORD} - one of the following:
:instance - new annotations are attached to the instance
:contents - new annotations are attached to the contents

Function Index Top of Page

SD-INQ-3D-ANNOTATION-CUST-FEAT  [function]

(sd-inq-3d-annotation-cust-feat 3d-annotation)
Description:
Returns the custom feature of a 3D Annotation.

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
{SEL_ITEM} - the sel_item of the custom_feature belonging to this label or NIL for generic 3D Annotations

Example:
(sd-inq-3d-annotation-cust-feat some-3d-annotation)
 => NIL

Function Index Top of Page

SD-INQ-CUST-FEAT-3D-ANNOTATION  [function]

(sd-inq-cust-feat-3d-annotation custom-feature)
Description:
Returns the 3D Annotation of a custom feature.

Parameters:
custom-feature {SEL_ITEM} - the custom feature

Return value:
{SEL_ITEM} - the 3D Annotation, if the custom feature has a label; otherwise NIL

Example:
(sd-inq-cust-feat-3d-annotation some-cust-feat)
 => SEL_ITEM

Function Index Top of Page

SD-INQ-FEATURE-POINT-VERTEX  [function]

(sd-inq-feature-point-vertex custom-feature or 3d-annotation)
Description:
Returns the vertex of the feature point

Parameters:
Either:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire
cust-feat {SEL_ITEM} - the custom feature to inquire

Return value:
{SEL_ITEM} - the sel_item of the corresponding vertex

Example:
(sd-inq-feature-point-vertex cust-feat)
 => SEL_ITEM

Function Index Top of Page

SD-INQ-OBJ-3D-ANNOTATIONS  [function]

(sd-inq-obj-3d-annotations object)
Description:
Returns all 3D Annotations being attached to an object.

Parameters:
object {SEL_ITEM} - the object (part, assembly, workplane)

Return value:
{LIST of SEL_ITEMS} - A list of 3D Annotations.
nil - An error occurred or none found.

Function Index Top of Page

SD-INQ-3D-ANNOTATION-OWNER  [function]

(sd-inq-3d-annotation-owner 3d-annotation)
Description:
Returns owner and attachment type of a 3D Annotation.

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
property-list {LIST} - A property list containing key/value pairs for the requested properties
:owner {SEL_ITEM} - owner of Annotation
:attachment {KEYWORD} - one of the following:
:instance - Annotation is attached to instance of owner
:contents - Annotation is attached to contents of owner
nil - An error occurred.

Note: To extract values from the return list, use getf.

Function Index Top of Page

SD-3D-ANNOTATION-P  [function]

(sd-3d-annotation-p sel-item)
Description:
Returns 'true' if the sel_item is a 3D annotation of any type

Parameters:
sel-item {SEL_ITEM} - the sel-item to inquire

Return value:
t - if the sel_item is a 3D annotation
nil - otherwise

Example:
(sd-3d-annotation-p some-3d-annotation)
 => t

Function Index Top of Page

SD-DIMENSION-P  [function]

(sd-dimension-p 3d-annotation)
Description:
Returns 'true' if the 3D Annotation is a dimension

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
t - if the 3D Annotation is a dimension
nil - otherwise

Example:
(sd-dimension-p some-3d-annotation)
 => t

Function Index Top of Page

SD-GDT-P  [function]

(sd-gdt-p 3d-annotation)
Description:
Returns 'true' if the 3D Annotation is of type GD&T

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
t - if the 3D Annotation is a GD&T dimension, tolerance or datum
nil - otherwise

Example:
(sd-gdt-p some-3d-annotation)
 => t

Function Index Top of Page

SD-FEATURE-POINT-P  [function]

(sd-feature-point-p 3d-annotation / cust_feat )
Description:
Returns 'true' if the specified item is a feature point

Parameters:
3d-annotation / cust_feat Either:
{SEL_ITEM} - the 3D Annotation to inquire
{SEL_ITEM} - the custom feature to inquire

Return value:
t - if the specified item is a feature point
nil - otherwise

Example:
(sd-feature-point-p some-3d-annotation)
 => nil

Function Index Top of Page

SD-SURFACE-SYMBOL-P  [function]

(sd-surface-symbol-p 3d-annotation)
Description:
Returns 'true' if the 3D Annotation is a surface symbol

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
t - if the 3D Annotation is a surface symbol
nil - otherwise

Example:
(sd-surface-symbol-p some-3d-annotation)
 => t

Function Index Top of Page

SD-WELDING-SYMBOL-P  [function]

(sd-welding-symbol-p 3d-annotation)
Description:
Returns 'true' if the 3D Annotation is a welding symbol

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
t - if the 3D Annotation is a welding symbol
nil - otherwise

Example:
(sd-welding-symbol-p some-3d-annotation)
 => t

Function Index Top of Page

SD-USER-DEFINED-SYMBOL-P  [function]

(sd-user-defined-symbol-p 3d-annotation)
Description:
Returns 'true' if the 3D Annotation is a user defined symbol (either created via a LISP program or a symbol registered from Annotation)

Parameters:
3d-annotation {SEL_ITEM} - the 3D Annotation to inquire

Return value:
t - if the 3D Annotation is a user define symbol
nil - otherwise

Example:
(sd-user-defined-symbol-p some-3d-annotation)
 => t

Function Index Top of Page

SD-INQ-ASSIGNED-GENERAL-TOLERANCES  [function]

(sd-inq-assigned-general-tolerances owner)
Description:
Returns the assigned general tolerances of a part / assembly / container

Parameters:
owner {SEL_ITEM} - the owner (part / assembly / container) to inquire

Return value:
property-list {LIST} - A property list containing the general tolerance values for
:length {LIST} - value pairs with general tolerances used for linear dimensions, i.e. ( (1.0 0.01) (50.0 0.5) (100.0 1.0))
:radius {LIST} - value pairs with general tolerances used for circular dimensions
nil - An error occurred.

[Integration Kit Contents] [Integration Kit What's New] [Integration Kit Function Index] [More Documentation] [PTC]
© 2019 Parametric Technology GmbH
(a subsidiary of PTC Inc.), All Rights Reserved