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

Features and Named Elements Inquiries


sd-inq-part-named-features
sd-inq-part-named-faces
sd-inq-part-named-edges
sd-inq-part-named-vertices

sd-inq-feature-components
sd-inq-feature-highlight-color

sd-inq-rec-feature

sd-inq-elem-name
sd-face-name-to-elem
sd-edge-name-to-elem
sd-vertex-name-to-elem

Function Index Top of Page

SD-INQ-PART-NAMED-FEATURES  [function]

(sd-inq-part-named-features part)
Description:
Returns a list of the names of all named features belonging to a part.

Parameters:
part {SEL_ITEM} - the part to examine

Return Value:
names {LIST of STRINGs} - names of the features belonging to a part
nil
if no named features are defined for the part or the specified part is not valid

See Also:
DEFINE_FEATURE   [terminate action]
REMOVE_FEATURE   [terminate action]
RENAME_FEATURE   [terminate action]
HIGHLIGHT_FEATURE   [interrupt action]
EDIT_FEATURE   [terminate action]

Function Index Top of Page

SD-INQ-PART-NAMED-FACES  [function]

(sd-inq-part-named-faces par)
Description:
Returns a list of the names of all named faces belonging to a part.

Parameters:
part {SEL_ITEM} - the part to examine

Return Value:
names {LIST of STRINGs} - names of the faces belonging to a part
nil
if no named faces are defined for the part or the specified part is not valid

See Also:
DEFINE_ELEMENT_NAME   [terminate action]
REMOVE_ELEMENT_NAME   [terminate action]
RENAME_ELEMENT   [terminate action]
HIGHLIGHT_ELEMENT   [interrupt action]

Function Index Top of Page

SD-INQ-PART-NAMED-EDGES  [function]

(sd-inq-part-named-edges part)
Description:
Returns a list of the names of all named edges belonging to a part.

Parameters:
part {SEL_ITEM} - the part to examine

Return Value:
names {LIST of STRINGs} - names of the edges belonging to a part
nil
if no named edges are defined for the part or the specified part is not valid

See Also:
DEFINE_ELEMENT_NAME   [terminate action]
REMOVE_ELEMENT_NAME   [terminate action]
RENAME_ELEMENT   [terminate action]
HIGHLIGHT_ELEMENT   [interrupt action]

Function Index Top of Page

SD-INQ-PART-NAMED-VERTICES  [function]

(sd-inq-part-named-vertices part)
Description:
Returns a list of the names of all named vertices belonging to a part.

Parameters:
part {SEL_ITEM} - the part to examine

Return Value:
names {LIST of STRINGs} - names of the vertices belonging to a part
nil
if no named vertice are defined for the part or the specified part is not valid

See Also:
DEFINE_ELEMENT_NAME   [terminate action]
REMOVE_ELEMENT_NAME   [terminate action]
RENAME_ELEMENT   [terminate action]
HIGHLIGHT_ELEMENT   [interrupt action]

Function Index Top of Page

SD-INQ-FEATURE-COMPONENTS  [function]

(sd-inq-feature-components :feature feature :part part)
                           :feat-sel-item feat-sel-item
                           :recursive-geo-elements flag
Description:
Returns a list of the items belonging to a named or selected feature.

Parameters:
:feature {STRING} - The name of the feature
:part {SEL_ITEM} - The part that the feature belongs to
:feat-sel-item {SEL_ITEM} - Sel_item to a feature. Alternative method to supplying a feature name and part.
:recursive-geo-elements {BOOLEAN [nil]} - Specifies whether to recursively include the geometric elements of nested features, or only the top-level components of the feature.

Return Value:
items {LIST of SEL_ITEMs} - The items that comprise the feature

See Also:
DEFINE_FEATURE   [terminate action]
REMOVE_FEATURE   [terminate action]
RENAME_FEATURE   [terminate action]
HIGHLIGHT_FEATURE   [interrupt action]
EDIT_FEATURE   [terminate action]

Function Index Top of Page

SD-INQ-FEATURE-HIGHLIGHT-COLOR  [function]

(sd-inq-feature-highlight-color)
Description:
Returns the color used to highlight named features and named elements.

Return Value:
color {GPNT3D} - The R,G,B color vector

See Also:
SET_FEATURE_HIGHLIGHT_COLOR   [terminate action]

Function Index Top of Page

SD-INQ-REC-FEATURE  [function]

(sd-inq-rec-feature face :type flag)
Description:
Returns all faces belonging to the recognized feature identified by face. If face is not part of a recognized feature, the function returns all faces of the part.
If the flag :type is set, the return value contains the type of the recognized feature as well.

Parameters:
face {SEL_ITEM} - the face to identify the recognized feature
:type {BOOLEAN [nil]} - include feature type in result or not

Return Value:
Depending on how the flag :type was set:
faces {LIST of SEL_ITEMs} - all faces belonging to the recognized feature (:type = nil) or
facelist and type {LIST} (in case of :type = t)
The first element in the result list is the list of all faces belonging to the recognized feature. The second item is a keyword describing the type of the recognized feature. This keyword can be one of the following:
  • :boss
  • :pocket
  • :hole
  • :complex

Function Index Top of Page

SD-INQ-ELEM-NAME  [function]

(sd-inq-elem-name elem)
Description:
Returns the name of a named element, or nil if the element does not have a name.

Parameters:
elem {SEL_ITEM} - The element to inquire the name of

Return Value:
name {STRING} - The element name
nil - if the specified element is not valid

See Also:
DEFINE_ELEMENT_NAME   [terminate action]
REMOVE_ELEMENT_NAME   [terminate action]
RENAME_ELEMENT   [terminate action]
HIGHLIGHT_ELEMENT   [interrupt action]

Function Index Top of Page

SD-FACE-NAME-TO-ELEM  [function]

(sd-face-name-to-elem :name name :part name)
Description:
Converts a face name (plus a reference to the part that owns the face) into a SEL_ITEM representation of the face element. The part that owns the face is required because face names are only unique for a given part.

Parameters:
:name {STRING} - The face name
:part {SEL_ITEM} - The part that owns the face

Return Value:
elem {SEL_ITEM} - The face item
nil - the specified face does not exist or the specified part

See Also:
DEFINE_ELEMENT_NAME   [terminate action]
REMOVE_ELEMENT_NAME   [terminate action]
RENAME_ELEMENT   [terminate action]
HIGHLIGHT_ELEMENT   [interrupt action]

Function Index Top of Page

SD-EDGE-NAME-TO-ELEM  [function]

(sd-edge-name-to-elem :name name :part part)
Description:
Converts an edge name (plus a reference to the part that owns the edge) into a SEL_ITEM representation of the edge element. The part that owns the edge is required because edge names are only unique for a given part.

Parameters:
:name {STRING} - The edge name
:part {SEL_ITEM} - The part that owns the edge

Return Value:
elem {SEL_ITEM} - The edge item
nil - the specified edge does not exist or the specified part is not valid

See Also:
DEFINE_ELEMENT_NAME   [terminate action]
REMOVE_ELEMENT_NAME   [terminate action]
RENAME_ELEMENT   [terminate action]
HIGHLIGHT_ELEMENT   [interrupt action]

Function Index Top of Page

SD-VERTEX-NAME-TO-ELEM  [function]

(sd-vertex-name-to-elem :name name :part part)
Description:
Converts a vertex name (plus a reference to the part that owns the vertex) into a SEL_ITEM representation of the vertex element. The part that owns the vertex is required because vertex names are only unique for a given part.

Parameters:
:name {STRING} - The vertex name
:part {SEL_ITEM} - The part that owns the vertex

Return Value:
elem {SEL_ITEM} - The vertex item
nil - the specified vertex does not exist or the specified part is not valid

See Also:
DEFINE_ELEMENT_NAME   [terminate action]
REMOVE_ELEMENT_NAME   [terminate action]
RENAME_ELEMENT   [terminate action]
HIGHLIGHT_ELEMENT   [interrupt action]
[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