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

Workplane Inquiries



sd-basic-wp-profile-check-p

sd-inq-wp-color
sd-inq-wp-border-type
sd-inq-wp-min-size
sd-inq-wp-grid-spacing
sd-inq-wp-grid-mode

sd-inq-wp-origin
sd-inq-wp-u-dir
sd-inq-wp-v-dir
sd-inq-wp-w-dir

sd-inq-default-wp-color
sd-inq-default-wp-min-size
sd-inq-default-wp-border-type
sd-inq-default-wp-grid-width
sd-inq-default-wp-grid-height
sd-inq-default-wp-grid-mode

sd-inq-wp-resolution
sd-inq-default-wp-resolution

Function Index Top of Page

SD-BASIC-WP-PROFILE-CHECK-P  [function]

(sd-basic-wp-profile-check-p wp)
Description:
Basic check of workplane profile validity for linear sweep machining operations like extrude. The profile is checked using the default system resolution. Does not guarantee that profile is valid for all machining operations.

Parameters:
wp {SEL_ITEM} - the workplane to check

Return Value:
t - if the workplane contains a valid profile
nil - if the workplane does not contain a valid profile

Function Index Top of Page

SD-INQ-WP-COLOR  [function]

(sd-inq-wp-color wp whichcolor)
Description:
Returns the specified color of the specified workplane.

Parameters:
wp {SEL_ITEM} - the workplane to inquire.
whichcolor {SYMBOL} - One of:
:front - Color of the front side of the WP if not active
:back - Color of the back side of the WP if not active
:geom - Color for the 2D geometry
:constr - Color for the 2D construction geometry
:grid - Color for the workplane grid

Return Value:
color {GPNT3D} - the color in the form of a vector R,G,B
nil - if the specified workplane is invalid, or unknown whichcolor keyword.

See Also:
SET_WP_COLOR [terminate action]

Function Index Top of Page

SD-INQ-WP-BORDER-TYPE  [function]

(sd-inq-wp-border-type wp)
Description:
Returns the border type of the specified workplane, represented by a keyword.

Parameters:
wp {SEL_ITEM} - the workplane to inquire.

Return Value:
:outline - if the workplane shows a outlined border
:full - if the workplane shows a full border
nil - the specified wp is invalid

See Also:
SET_WP_BORDER_TYPE [terminate action]

Function Index Top of Page

SD-INQ-WP-MIN-SIZE  [function]

(sd-inq-wp-min-size wp)
Description:
Returns the minimum size of the specified workplane, represented by two points.

Parameters:
wp {SEL_ITEM} - the workplane to inquire.

Return Value:
two points {LIST of two GPNT2Ds}
the minimum size of the workplane specified as a list of two points
nil - the specified wp is invalid

See Also:
SET_WP_MIN_SIZE [terminate action]

Function Index Top of Page

SD-INQ-WP-GRID-SPACING  [function]

(sd-inq-wp-grid-spacing wp)
Description:
Returns the grid spacing of the specified workplane as a list of the form '(width height).

Parameters:
wp {SEL_ITEM} - the workplane to inquire.

Return Value:
spacing {LIST of two LONG-FLOATs}
the grid spacing, as a list in the format '(width height).
nil - the specified workplane is invalid

See Also:
SET_WP_GRID_SIZE [terminate action]

Function Index Top of Page

SD-INQ-WP-GRID-MODE  [function]

(sd-inq-wp-grid-mode wp)
Description:
Returns the grid mode of the specified workplane.

Parameters:
wp {SEL_ITEM} - the workplane to inquire.

Return Value:
:off - The grid is turned off
:line - The grid is in line mode
:dots - The grid is in dots mode
nil - the specified workplane is invalid

See Also:
SET_WP_GRID_MODE [terminate action]

Function Index Top of Page

SD-INQ-WP-ORIGIN  [function]

(sd-inq-wp-origin wp)
Description:
Returns the origin of the specified workplane in global coordinates.

Parameters:
wp {SEL_ITEM} - the workplane to inquire.

Return Value:
origin {GPNT3D} - The workplane's origin in global coordinates.
nil - the specified workplane is invalid

Function Index Top of Page

SD-INQ-WP-U-DIR  [function]

(sd-inq-wp-u-dir wp)
Description:
Returns the U-axis direction vector of the specified workplane.

Parameters:
wp {SEL_ITEM} - the workplane to inquire.

Return Value:
u-dir {GPNT3D} - The workplane's U-axis direction vector.
nil - the specified workplane is invalid

Function Index Top of Page

SD-INQ-WP-V-DIR  [function]

(sd-inq-wp-v-dir wp)
Description:
Returns the V-axis direction vector of the specified workplane.

Parameters:
wp {SEL_ITEM} - the workplane to inquire.

Return Value:
v-dir {GPNT3D} - The workplane's V-axis direction vector.
nil - the specified workplane is invalid

Function Index Top of Page

SD-INQ-WP-W-DIR  [function]

(sd-inq-wp-w-dir wp)
Description:
Returns the W-axis direction vector of the specified workplane.

Parameters:
wp {SEL_ITEM} - the workplane to inquire.

Return Value:
w-dir {GPNT3D} - The workplane's W-axis direction vector.
nil - the specified workplane is invalid

Function Index Top of Page

SD-INQ-DEFAULT-WP-COLOR  [function]

(sd-inq-default-wp-color whichcolor)
Description:
Returns the default workplane color specified by whichcolor

Parameters:
whichcolor {KEYWORD} - One of:
:front_border - Default color of the front side of non-active WPs
:back_border - Default color of the back side of non-active WPs
:front_current - Default color of the front side of the active WP
:back_current - Default color of the back side of the active WP
:geom - Default color for 2D geometry
:constr - Default color for 2D construction geometry
:grid - Default color for the workplane grid

Return Value:
color {GPNT3D} - the color represented as an RGB vector
nil - the whichcolor keyword is invalid

See Also:
SET_WP_DEFAULT_FRONT_BORDER_COLOR [interrupt action]
SET_WP_DEFAULT_BACK_BORDER_COLOR [interrupt action]
SET_WP_DEFAULT_FRONT_CURRENT_COLOR [interrupt action]
SET_WP_DEFAULT_BACK_CURRENT_COLOR [interrupt action]
SET_WP_DEFAULT_GEOM_COLOR [interrupt action]
SET_WP_DEFAULT_CONSTR_COLOR [interrupt action]
SET_WP_DEFAULT_GRID_COLOR [interrupt action]

Function Index Top of Page

SD-INQ-DEFAULT-WP-MIN-SIZE  [function]

(sd-inq-default-wp-min-size)
Description:
Returns the minimum default size for workplanes, represented by two points.

Return Value:
two points {LIST of two GPNT2Ds}
the minimum default workplane size specified as a list of two points.

See Also:
SET_WP_DEFAULT_MIN_SIZE_FIRST_POINT [interrupt action]
SET_WP_DEFAULT_MIN_SIZE_SECOND_POINT [interrupt action]

Function Index Top of Page

SD-INQ-DEFAULT-WP-BORDER-TYPE  [function]

(sd-inq-default-wp-border-type)
Description:
Returns the default workplane border type.

Return Value:
:outline
:full

See Also:
SET_WP_DEFAULT_BORDER_TYPE [interrupt action]

Function Index Top of Page

SD-INQ-DEFAULT-WP-GRID-WIDTH  [function]

(sd-inq-default-wp-grid-width)
Description:
Returns the default workplane grid width.

Return Value:
width {LONG-FLOAT}

See Also:
SET_WP_DEFAULT_GRID_WIDTH [interrupt action]

Function Index Top of Page

SD-INQ-DEFAULT-WP-GRID-HEIGHT  [function]

(sd-inq-default-wp-grid-height)
Description:
Returns the default workplane grid height.

Return Value:
height {LONG-FLOAT}

See Also:
SET_WP_DEFAULT_GRID_HEIGHT [interrupt action]

Function Index Top of Page

SD-INQ-DEFAULT-WP-GRID-MODE  [function]

(sd-inq-default-wp-grid-mode)
Description:
Returns the default workplane grid mode.

Return Value:
:off
:line
:dots

See Also:
SET_WP_DEFAULT_GRID_MODE [interrupt action]

Function Index Top of Page

SD-INQ-WP-RESOLUTION  [function]

(sd-inq-wp-resolution wp)
Description:
Returns the geometric resolution (in internal units of millimeters) of the specified workplane.

Parameters:
wp {SEL_ITEM} - the workplane to inquire.

Return Value:
resolution {LONG-FLOAT}

See Also:
SET_WP_GEO_RESOL [terminate action]

Function Index Top of Page

SD-INQ-DEFAULT-WP-RESOLUTION  [function]

(sd-inq-default-wp-resolution)
Description:
Returns the default geometric resolution (in internal units of millimeters) of newly created workplanes.

Return Value:
resolution {LONG-FLOAT}

See Also:
SET_WP_DEFAULT_RESOLUTION [terminate 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