Part Inquiries
sd-inq-part-render-appearance
sd-inq-part-render-material
sd-inq-default-part-color
sd-inq-part-color
sd-inq-default-face-part-color
sd-inq-default-active-part-color
sd-inq-default-part-reflectance-color
sd-inq-part-reflectance-color
sd-inq-default-part-reflectance-power
sd-inq-part-reflectance-power
sd-inq-default-part-reflectance-specularity
sd-inq-part-reflectance-specularity
sd-inq-default-part-transparency
sd-inq-part-transparency
sd-inq-default-part-density
sd-inq-part-density
sd-inq-default-facet-refinement
sd-inq-part-facet-tolerance
sd-inq-face-facet-tolerance
sd-inq-default-geo-resolution
sd-inq-part-geo-resolution
sd-inq-default-mixed-display
sd-inq-face-render-appearance
sd-inq-face-render-material
sd-inq-face-color
sd-inq-face-reflectance-color
sd-inq-face-reflectance-power
sd-inq-face-transparency
SD-INQ-PART-RENDER-APPEARANCE [function]
(sd-inq-part-render-appearance part &optional (kind :realized))
- Description:
-
Returns the render appearance, i.e. :material or :color, of the
specified part. Kind determines the kind of appearance you want to
inquire (attached to contents, attached to instance or the one
realized).
- Parameters:
-
- part {SEL_ITEM}
- kind (optional) one of
- :contents - inquire the base appearance (attached to
contents)
- :instance - inquire the part appearance (attached to
instance)
- :realized - inquire the realized appearance (i.e. the one
used when realizing the part)
- Return Value:
- :material - if the Rendering module is active and a render
material is used during the rendering process.
-
:color - if the Rendering module is not active or if no render
material is used during the rendering process.
- The part render appearance can be modified by means of the command
PART_PROP:
- PART_PROP :APPEARANCE {:MATERIAL or :COLOR} [terminate
action]
- PART_PROP :BASE_APPEARANCE {:MATERIAL or :COLOR} [terminate
action]
- The Rendering module must be active while executing the above
sequences.
SD-INQ-PART-RENDER-MATERIAL [function]
(sd-inq-part-render-material part &optional (kind :realized))
- Description:
-
If the Rendering module is active, this function returns the render
material of the specified part. If the Rendering module is not active or
if no render material has been assigned to the part, this function
returns nil. Kind determines the kind of render material you want
to inquire (attached to contents, attached to instance or the one
realized).
- Parameters:
-
- part {SEL_ITEM}
- kind (optional) one of
- :contents - inquire the base color (attached to
contents)
- :instance - inquire the part color (attached to
instance)
- :realized - inquire the realized color (i.e. the one used
when realizing the part)
- Return Value:
- render-material {STRING} - Name of render material. A render
material can only be returned if the Rendering module is active.
-
nil - if the Rendering module is not active or if the the
inquired kind of render material isn't specified.
- The render material can be modified by means of the command
PART_PROP:
- PART_PROP :RENDER_MATERIAL a-string [terminate
action]
- PART_PROP :BASE_RENDER_MATERIAL a-string [terminate
action]
-
The Rendering module must be active while executing the above sequences.
- A render material can be removed by setting a-string to
"NONE".
- The command PART_PROP also supports the copying of render materials.
The options are listed in the online reference, see the subdialogs
COPY_TO_PART_PROPS_SUB and COPY_FROM_PART_PROPS.
SD-INQ-DEFAULT-PART-COLOR [function]
(sd-inq-default-part-color)
- Description:
-
Returns the default color used for all newly created parts.
- Return Value:
-
color {GPNT3D} - R,G,B color vector.
- See Also:
- SET_DEFAULT_PART_COLOR [interrupt action]
SD-INQ-PART-COLOR [function]
(sd-inq-part-color part &optional (kind :realized))
- Description:
-
Returns the color of the specified part. Kind determines the kind of
color you want to inquire (attached to contents, attached to instance or
the one realized).
- Parameters:
-
- part {SEL_ITEM}
- kind (optional) one of
- :contents - inquire the base color (attached to contents;
may be nil)
- :instance - inquire the part color (attached to instance;
may be nil)
- :realized - inquire the realized color (i.e. the one used
when realizing the part)
- Return Value:
- color {GPNT3D} - R,G,B color vector.
-
nil - if the inquired kind of color isn't specified
(:contents / :instance only)
- See Also:
- SET_PART_BASE_COLOR [terminate action]
-
SET_PART_INST_COLOR [terminate action]
- (Note: SET_PART_COLOR [terminate action] is going to be
obsolete)
SD-INQ-DEFAULT-FACE-PART-COLOR [function]
(sd-inq-default-face-part-color)
- Description:
-
Returns the default color used for all newly created face parts.
- Return Value:
-
color {GPNT3D} - R,G,B color vector.
- See Also:
- SET_DEFAULT_FACE_PART_COLOR [interrupt action]
SD-INQ-DEFAULT-ACTIVE-PART-COLOR [function]
(sd-inq-default-active-part-color)
- Description:
-
Returns the color used for the edges of the active part.
- Return Value:
-
color {GPNT3D} - R,G,B color vector.
- See Also:
- SET_CURRENT_PART_COLOR [interrupt action]
SD-INQ-DEFAULT-PART-REFLECTANCE-COLOR [function]
(sd-inq-default-part-reflectance-color)
- Description:
-
Returns the default reflectance color used for new parts.
- Return Value:
-
color {GPNT3D} - R,G,B color vector.
- See Also:
- SET_DEFAULT_PART_REFLECTANCE_COLOR [interrupt action]
SD-INQ-PART-REFLECTANCE-COLOR [function]
(sd-inq-part-reflectance-color part &optional (kind :realized))
- Description:
-
Returns the reflectance color of the specified part. Kind determines the
kind of reflectance color you want to inquire (attached to contents,
attached to instance or the one realized).
- Parameters:
-
- part {SEL_ITEM}
- kind (optional) one of
- :contents - inquire the base reflectance color (attached to
contents; may be nil)
- :instance - inquire the part reflectance color (attached to
instance; may be nil)
- :realized - inquire the realized reflectance color (i.e.
the one used when realizing the part)
- Return Value:
- color {GPNT3D} - R,G,B color vector.
-
nil - if the inquired kind of reflectance color isn't specified
(:contents / :instance only)
- See Also:
- SET_PART_BASE_REFLECTANCE [terminate action]
-
SET_PART_INST_REFLECTANCE [terminate action]
- (Note: SET_PART_REFLECTANCE [terminate action] is going to be
obsolete)
SD-INQ-DEFAULT-PART-REFLECTANCE-POWER [function]
(sd-inq-default-part-reflectance-power)
- Description:
-
Returns the default reflectance power used for new parts.
- Return Value:
-
power {LONG-FLOAT}
- See Also:
- SET_DEFAULT_PART_REFLECTANCE_POWER [interrupt action]
SD-INQ-PART-REFLECTANCE-POWER [function]
(sd-inq-part-reflectance-power part &optional (kind :realized))
- Description:
-
Returns the reflectance power of the specified part. Kind determines the
kind of reflectance power you want to inquire (attached to contents,
attached to instance or the one realized).
- Parameters:
-
- part {SEL_ITEM}
- kind (optional) one of
- :contents - inquire the base reflectance power (attached to
contents; may be nil)
- :instance - inquire the part reflectance power (attached to
instance; may be nil)
- :realized - inquire the realized reflectance power (i.e.
the one used when realizing the part)
- Return Value:
- power {LONG-FLOAT}
-
nil - if the inquired kind of reflectance power isn't specified
(:contents / :instance only)
- See Also:
- SET_PART_BASE_REFLECTANCE [terminate action]
-
SET_PART_INST_REFLECTANCE [terminate action]
- (Note: SET_PART_REFLECTANCE [terminate action] is going to be
obsolete)
SD-INQ-DEFAULT-PART-REFLECTANCE-SPECULARITY [function]
(sd-inq-default-part-reflectance-specularity)
- Description:
-
Returns the default mirror power used for new parts.
- Return Value:
-
power {LONG-FLOAT}
- See Also:
- SET_DEFAULT_PART_REFLECTANCE_SPECULARITY [interrupt
action]
SD-INQ-PART-REFLECTANCE-SPECULARITY [function]
(sd-inq-part-reflectance-specularity part &optional (kind :realized))
- Description:
-
Returns the mirror power of the specified part. Kind determines the kind
of mirror power you want to inquire (attached to contents, attached to
instance or the one realized).
- Parameters:
-
- part {SEL_ITEM}
- kind (optional) one of
- :contents - inquire the base mirror power (attached to
contents; may be nil)
- :instance - inquire the part mirror power (attached to
instance; may be nil)
- :realized - inquire the realized mirror power (i.e. the one
used when realizing the part)
- Return Value:
- power {LONG-FLOAT}
-
nil - if the inquired kind of mirror power isn't specified
(:contents / :instance only)
- See Also:
- SET_PART_BASE_REFLECTANCE [terminate action]
-
SET_PART_INST_REFLECTANCE [terminate action]
- (Note: SET_PART_REFLECTANCE [terminate action] is going to be
obsolete)
SD-INQ-DEFAULT-PART-TRANSPARENCY [function]
(sd-inq-default-part-transparency)
- Description:
-
Returns the default part transparency used for new parts.
- Return Value:
-
transparency {LONG-FLOAT from 0.0 to 1.0}
- See Also:
- SET_DEFAULT_PART_TRANSPARENCY [interrupt action]
SD-INQ-PART-TRANSPARENCY [function]
(sd-inq-part-transparency part &optional (kind :realized))
- Description:
-
Returns the transparency of the specified part. Kind determines the kind
of transparency you want to inquire (attached to contents, attached to
instance or the one realized).
- Parameters:
-
- part {SEL_ITEM}
- kind (optional) one of
- :contents - inquire the base transparency (attached to
contents; may be nil)
- :instance - inquire the part transparency (attached to
instance; may be nil)
- :realized - inquire the realized transparency (i.e. the one
used when realizing the part)
- Return Value:
- transparency {LONG-FLOAT from 0.0 to 1.0}
-
nil - if the inquired kind of transparency isn't specified
(:contents / :instance only)
- See Also:
- SET_PART_BASE_TRANSPARENCY [terminate action]
-
SET_PART_INST_TRANSPARENCY [terminate action]
- (Note: SET_PART_TRANSPARENCY [terminate action] is going to be
obsolete)
SD-INQ-DEFAULT-PART-DENSITY [function]
(sd-inq-default-part-density)
- Description:
-
Returns the default density used for new parts.
- Return Value:
-
density {LONG-FLOAT}
- See Also:
- SET_DEFAULT_PART_DENSITY [interrupt action]
SD-INQ-PART-DENSITY [function]
(sd-inq-part-density part &optional (kind :realized))
- Description:
-
Returns density of the specified part. Kind determines the kind of
density you want to inquire (attached to contents, attached to instance
or the one realized).
- Parameters:
-
- part {SEL_ITEM}
- kind (optional) one of
- :contents - inquire the base density (attached to contents;
may be nil)
- :instance - inquire the part density (attached to instance;
may be nil)
- :realized - inquire the realized density (i.e. the one used
when realizing the part)
- Return Value:
- density {LONG-FLOAT}
-
nil - if the inquired kind of density isn't specified
(:contents / :instance only)
- See Also:
- SET_PART_BASE_DENSITY [terminate action]
-
SET_PART_INST_DENSITY [terminate action]
- (Note: SET_PART_DENSITY [terminate action] is going to be
obsolete)
SD-INQ-DEFAULT-FACET-REFINEMENT [function]
(sd-inq-default-facet-refinement)
- Description:
- Returns the default facet refinement factor used for new parts.
-
- Return Value:
-
factor {FIXNUM}
- See Also:
- SET_FACET_RESOLUTION [interrupt action]
SD-INQ-PART-FACET-TOLERANCE [function]
(sd-inq-part-facet-tolerance part type)
- Description:
- Returns the facet tolerance values of a part.
- Parameters:
-
part {SEL_ITEM}
type {KEYWORD} - One of:
- :deviation - Distance tolerance of part
- :ang_err - Angular tolerance of part
- Return Value:
-
tolerance {LONG-FLOAT}
- See Also:
- SET_PART_ACCURACY [terminate action]
SD-INQ-FACE-FACET-TOLERANCE [function]
(sd-inq-face-facet-tolerance face type)
- Description:
- Returns the facet tolerance values of a face.
- Parameters:
-
face {SEL_ITEM}
type {KEYWORD} - One of:
- :deviation - Distance tolerance of face
- :ang_err - Angular tolerance of face
- Return Value:
-
tolerance {LONG-FLOAT}
- See Also:
- SET_FACE_ACCURACY [terminate action]
SD-INQ-DEFAULT-GEO-RESOLUTION [function]
(sd-inq-default-geo-resolution)
- Description:
-
Returns the default geometric resolution (in internal units of
millimeters) for newly created parts.
- Return Value:
-
resolution {LONG-FLOAT}
- See Also:
- SET_DEFAULT_PART_RESOLUTION [terminate action]
SD-INQ-PART-GEO-RESOLUTION [function]
(sd-inq-part-geo-resolution part)
- Description:
-
Returns the geometric resolution (in internal units of millimeters) of
the specified part.
- Parameters:
-
part {SEL_ITEM}
- Return Value:
-
resolution {LONG-FLOAT}
- See Also:
- SET_PART_RESOLUTION [terminate action]
SD-INQ-DEFAULT-MIXED-DISPLAY [function]
(sd-inq-default-mixed-display mode)
- Description:
-
Returns :on or :off to indicate the status of the default
mixed display mode indicated by mode.
- Parameters:
-
mode {KEYWORD} - must be one of the following:
- :shaded
- :hidden
- :edged
- :wire
- Return Value:
- :on - if the default mode status is "on"
-
:off - if the default mode status is "off"
- See Also:
- SET_DEFAULT_MIXED_DISPLAY [interrupt action]
SD-INQ-FACE-RENDER-APPEARANCE [function]
(sd-inq-face-render-appearance face)
- Description:
-
Returns the render appearance, i.e. :material or :color, of the
specified face.
- Parameters:
-
- face {SEL_ITEM}
- Return Value:
- :material - if the Rendering module is active and a render
material is used during the rendering process.
-
:color - if the Rendering module is not active or if no render
material is used during the rendering process.
- The face render appearance can be modified by means of the command
FACE_PROP:
- FACE_PROP :APPEARANCE {:MATERIAL or :COLOR} [terminate
action]
- The Rendering module must be active while executing the above
sequence.
SD-INQ-FACE-RENDER-MATERIAL [function]
(sd-inq-face-render-material face)
- Description:
-
If the Rendering module is active, this function returns the render
material of the specified face. If the Rendering module is not active or
if no render material has been assigned to the face, this function
returns nil.
- Parameters:
-
face {SEL_ITEM}
- Return Value:
- name {STRING} - Name of render material. A render material can
only be returned if the Rendering module is active.
-
nil - if the Rendering module is not active or if no render
material is defined for the face.
- The render material can be modified by means of the command
FACE_PROP:
- FACE_PROP :RENDER_MATERIAL a-string [terminate
action]
-
The Rendering module must be active while executing the above sequence.
- A render material can be removed by setting a-string to
"NONE".
- The command FACE_PROP also supports the copying of render materials.
The options are listed in the online reference, see the subdialogs
COPY_TO_FACE_PROPS_SUB and COPY_FROM_FACE_PROPS.
SD-INQ-FACE-COLOR [function]
(sd-inq-face-color face)
- Description:
-
Returns the color of the specified face, or nil if no color has
been assigned to the face.
- Parameters:
-
face {SEL_ITEM}
- Return Value:
- color {GPNT3D} - R,G,B color vector.
-
nil - if no color is defined for the face.
- See Also:
- SET_FACE_COLOR [terminate action]
- CLEAR_FACE_COLOR [terminate action]
- COPY_FACE_COLOR [terminate action]
SD-INQ-FACE-REFLECTANCE-COLOR [function]
(sd-inq-face-reflectance-color face)
- Description:
-
Returns the reflectance color of the specified face, or nil if no
reflectance is defined for the face.
- Parameters:
-
face {SEL_ITEM}
- Return Value:
- color {GPNT3D} - R,G,B color vector.
-
nil - if no reflectance is defined for the face
- See Also:
- SET_FACE_REFLECTANCE [terminate action]
- CLEAR_FACE_REFLECTANCE [terminate action]
- COPY_FACE_REFLECTANCE [terminate action]
SD-INQ-FACE-REFLECTANCE-POWER [function]
(sd-inq-face-reflectance-power face)
- Description:
-
Returns the reflectance power of the specified face, or nil if no
reflectance is defined for the face.
- Parameters:
-
face {SEL_ITEM}
- Return Value:
- power {LONG-FLOAT}
-
nil - if no reflectance is defined for the face
- See Also:
- SET_FACE_REFLECTANCE [terminate action]
- CLEAR_FACE_REFLECTANCE [terminate action]
- COPY_FACE_REFLECTANCE [terminate action]
SD-INQ-FACE-TRANSPARENCY [function]
(sd-inq-face-transparency face)
- Description:
-
Returns the transparency factor of the specified face, which is a number
ranging from 0.0 to 1.0 (although it is effectively rounded off to
either 0.0, 0.5, or 1.0).
- Parameters:
-
face {SEL_ITEM}
- Return Value:
-
transparency {LONG-FLOAT from 0.0 to 1.0}
- See Also:
- SET_FACE_TRANSPARENCY [terminate action]
- CLEAR_FACE_TRANSPARENCY [terminate action]
- COPY_FACE_TRANSPARENCY [terminate action]
© 2024 Parametric
Technology GmbH
(a subsidiary of PTC Inc.), All Rights Reserved |
![[Integration Kit Contents]](../../icons/Nav01_Home.png "Integration Kit Contents"){kind=icon}
![[Integration Kit What's New]](../Nav02_WhatsNew.png "Integration Kit What's New")
![[Integration Kit Function Index]](../../icons/Nav03_Index.png "Integration Kit Function Index"){kind=icon}
![[More Documentation]](../../icons/Nav04_Advanced.png "More Documentation"){kind=icon}
![[PTC]](../../icons/logo.png "Visit PTC.Com"){kind=icon}