3D Documentation - Docuplane Inquiries
- Docuplane Sets
-
sd-docuplane-set-p
sd-inq-docuplane-set
- Docuplanes
- sd-docuplane-p
sd-inq-docuplane-settings
sd-inq-docuplane-type
sd-inq-docuplane-props
sd-inq-docuplane-default-settings
sd-inq-docuplane-annotations
sd-inq-curr-docuplane
sd-partial-docuplane-p
sd-inq-detail-docuplane-parent
sd-inq-section-docuplane-parent
sd-inq-docuplane-section-line
sd-docuplane-section-line-p
sd-inq-docuplane-components
sd-set-docuplane-resolution
SD-DOCUPLANE-SET-P [function]
(sd-docuplane-set-p object)
- Description:
-
Predicate to determine whether the passed object is a docuplane set
- Parameters:
-
object {SEL_ITEM} - the object to inquire
- Return value:
- t - object is a docuplane set
- nil - object is not a docuplane set
SD-INQ-DOCUPLANE-SET [function]
(sd-inq-docuplane-set docuplane)
- Description:
-
Inquires the owning docuplane set of a docuplane
- Parameters:
-
docuplane {SEL_ITEM} - the docuplane to inquire
- Return value:
- item {SEL_ITEM} - The item of the owning docuplane set
- nil - if the parameter is no docuplane
SD-DOCUPLANE-P [function]
(sd-docuplane-p object)
- Description:
-
Predicate to determine whether the passed object is a docuplane
- Parameters:
-
object {SEL_ITEM} - the object to inquire
- Return value:
- t - object is a docuplane
- nil - object is not a docuplane
SD-INQ-DOCUPLANE-SETTINGS [function]
(sd-inq-docuplane-settings docuplane :values values)
- Description:
-
Returns the settings of a docuplane
- Parameters:
- docuplane {SEL_ITEM} - the docuplane 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
- :front_border_color {NUMBER} - front color of the docuplane
border
- :back_border_color {NUMBER} - back color of the docuplane
border
-
:border_type {KEYWORD} - one of the following:
- :outline - outline border
- :full - full border
- :invisible - invisible border
-
:grid_mode {KEYWORD} - one of the following:
- :off - no grid is displayed
- :line - line grid is displayed
- :dots - dot grid is displayed
- :grid_width {NUMBER} - Grid width
- :grid_height {NUMBER} - Grid height
-
nil - An error occurred.
- Note: To extract values from the return list, use
getf.
- Example:
-
(sd-inq-docuplane-settings docuplane)
=> (:FRONT_BORDER_COLOR 65535
:BACK_BORDER_COLOR 65535
:BORDER_TYPE :OUTLINE
:GRID_MODE :DOTS
:GRID_WIDTH 3.5
:GRID_HEIGHT 2.0)
(getf (sd-inq-docuplane-settings docuplane) :GRID_MODE)
=> :DOTS
SD-INQ-DOCUPLANE-TYPE [function]
(sd-inq-docuplane-type docuplane)
- Description:
-
Returns a keyword containing the type of a docuplane.
- Parameters:
-
docuplane {SEL_ITEM} - the docuplane to inquire
- Return value:
-
type {KEYWORD} - one of the following:
- :front - Standard Front Docuplane
- :back - Standard Back Docuplane
- :top - Standard Top Docuplane
- :bottom - Standard Bottom Docuplane
- :left - Standard Left Docuplane
- :right - Standard Right Docuplane
- :section - Section Docuplane
- :general - General Docuplane
- :detail - Detail Docuplane
-
nil - An error occurred.
- Example:
-
(sd-inq-docuplane-type docuplane)
=> ":left"
SD-INQ-DOCUPLANE-PROPS [function]
(sd-inq-docuplane-props docuplane :values values)
- Description:
-
Returns the docuplane properties
- Parameters:
- docuplane {SEL_ITEM} - the docuplane 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
- :name {String} - the name of the docuplane
- :u-dir {GPNT3D} - the docuplane's U-axis direction
vector
- :v-dir {GPNT3D} - the docuplane's V-axis direction
vector
- :w-dir {GPNT3D} - the docuplane's W-axis direction
vector
- :origin {GPNT3D} - the docuplane's origin
- :scale {NUMBER} - the docuplane's scale value
- :configuration {SEL_ITEM} - The configuration attached to
the docuplane or nil, if there is no configuration
-
nil - An error occurred.
- Note: To extract values from the return list, use
getf.
- Example:
-
(sd-inq-docuplane-props docuplane)
=> (:NAME "Front1"
:U-DIR 1.0,0.0,0.0
:V-DIR 0.0,1.0,0.0
:W-DIR 0.0,0.0,1.0
:ORIGIN NIL
:SCALE 1
:CONFIGURATION NIL)
(getf (sd-inq-docuplane-settings docuplane) :SCALE)
=> 1
SD-INQ-DOCUPLANE-DEFAULT-SETTINGS [function]
(sd-inq-docuplane-default-settings :values values)
- Description:
-
Returns the default settings used when creating a new docuplane
- Parameters:
-
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
- :front_border_color {NUMBER} - front color of the docuplane
border
- :back_border_color {NUMBER} - back color of the docuplane
border
-
:border_type {KEYWORD} - one of the following:
- :outline - outline border
- :full - full border
-
:grid_mode {KEYWORD} - one of the following:
- :off - no grid is displayed
- :line - line grid is displayed
- :dots - dot grid is displayed
- :grid_width {NUMBER} - Grid width
- :grid_height {NUMBER} - Grid height
-
nil - An error occurred.
- Note: To extract values from the return list, use
getf.
- Example:
-
(sd-inq-docuplane-default-settings :all)
=> (:FRONT_BORDER_COLOR 65535
:BACK_BORDER_COLOR 65535
:BORDER_TYPE :OUTLINE
:GRID_MODE :DOTS
:GRID_WIDTH 3.5
:GRID_HEIGHT 2.0)
(getf (sd-inq-docuplane-default-settings docuplane) :GRID_HEIGHT)
=> 2.0
SD-INQ-DOCUPLANE-ANNOTATIONS [function]
(sd-inq-docuplane-annotations docuplane)
- Description:
-
Returns all 3D Annotations connected to the specified docuplane.
- Parameters:
-
docuplane {SEL_ITEM} - the docuplane to inquire
- Return value:
- {LIST of 3D Annotation SEL_ITEMS} - 3D Annotations of the
docuplane
- nil - if no 3D Annotation is connected to the docuplane
- Example:
-
(sd-inq-docuplane-annotations docuplane)
=> NIL
SD-INQ-CURR-DOCUPLANE [function]
(sd-inq-curr-docuplane)
- Description:
-
Returns the active docuplane
- Return value:
- {SEL_ITEM} - the active docuplane
- nil - if no active docuplane is defined
SD-PARTIAL-DOCUPLANE-P [function]
(sd-partial-docuplane-p object)
- Description:
-
Predicate to determine whether the passed object is a partial docuplane
- Parameters:
-
object {SEL_ITEM} - the object to inquire
- Return value:
- t - object is a partial docuplane
- nil - object is not a partial docuplane
SD-INQ-DETAIL-DOCUPLANE-PARENT [function]
(sd-inq-detail-docuplane-parent object)
- Description:
-
Returns the parent docuplane of a detail docuplane
- Parameters:
-
object {SEL_ITEM} - the detail docuplane to inquire
- Return value:
- {SEL_ITEM} - the parent docuplane
- nil - an error occured.
SD-INQ-SECTION-DOCUPLANE-PARENT [function]
(sd-inq-section-docuplane-parent object)
- Description:
-
Returns the parent docuplane of a section docuplane
- Parameters:
-
object {SEL_ITEM} - the section docuplane to inquire
- Return value:
- {SEL_ITEM} - the parent docuplane
- nil - no section parent docuplane provided or an error
occured.
- Note: This function also works for partial section
docuplanes.
SD-INQ-DOCUPLANE-SECTION-LINE [function]
(sd-inq-docuplane-section-line section-docuplane :values values)
- Description:
-
Returns all elements of a section line within the parent docuplane
- Parameters:
- section-docuplane {SEL_ITEM} - the section docuplane
-
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 elements
- :line {SEL_ITEM} - the main section line (for single plain
sections) or
- :line {LIST of line SEL_ITEMS} - the section polygon
- :segments {LIST of line SEL_ITEMS} - the two segments of
the section line or NIL
- :labels {LIST of 3D Annotation SEL_ITEMS} - the two section
line labels
- :arrows {LIST of 3D Annotation SEL_ITEMS} - the two section
line arrows
-
nil - Either:
- The provided docuplane is no section docuplane
- The section docuplane does not have a parent docuplane
- The section docuplane does not have a section line in the parent
docuplane
- An error occurred.
- Note: To extract values from the return list, use
getf.
SD-DOCUPLANE-SECTION-LINE-P [function]
(sd-docuplane-section-line-p element)
- Description:
-
Predicate to determine whether the passed element belongs to a docuplane
section line
- Parameters:
-
element {SEL_ITEM} - the element (2D line or 3D Annotation) to
inquire
- Return value:
- t - element belongs to a section line
- nil - element does not belong to a section line
SD-INQ-DOCUPLANE-COMPONENTS [function]
(sd-inq-docuplane-components docuplane)
- Description:
-
Inquire the components of a docuplane as specific with the MANAGE PARTS
command
- Parameters:
-
docuplane {SEL_ITEM} - the docuplane to inquire
- Return value:
- {LIST of SEL_ITEM} - representing the components of the
docuplane
SD-SET-DOCUPLANE-RESOLUTION [function]
(sd-set-docuplane-resolution resolution)
- Description:
- When gathering 3D dimensions to a docuplane the system checks, if the
measure direction
- of the docuplane corresponds to the docuplane directions.
- This check is executed without any tolerance.
-
This function allows to set a tolerance for the check.
- The function has to be executed within the start sequence of base
OSDM
- (calling it via d3d_customize is too late).
- This is necessary because otherwise annotation_3d's that are valid
in a docuplane
- because of this special resolution would fall out of the docuplane
during load,
-
if the resolution is not set again.
- Parameters:
- resolution {NUMBER} - 0 means that the check is performed
without tolerance (default)
-
- 0 up to 1.745e-3 (corresponds to 0.1 degreees)
- Return value:
- T - if successful
- nil or error message - if failing
© 2023 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}