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

Hatch Inquiries

Structures:
sd-am-hatch-pattern-struct
sd-am-simple-pattern-struct

Inquiries:
sd-am-inq-registered-hatch-pattern-names
sd-am-inq-curr-automatic-hatch-pattern-name
sd-am-inq-curr-manual-hatch-pattern-name
sd-am-inq-hatch-pattern
sd-am-inq-hatch-mode

Function Index Top of Page

SD-AM-HATCH-PATTERN-STRUCT  [structure]

(sd-am-hatch-pattern-struct-p        sd-am-hatch-pattern-struct)
(sd-am-hatch-pattern-struct-name     sd-am-hatch-pattern-struct)
(sd-am-hatch-pattern-struct-label    sd-am-hatch-pattern-struct)
(sd-am-hatch-pattern-struct-angle    sd-am-hatch-pattern-struct)
(sd-am-hatch-pattern-struct-distance sd-am-hatch-pattern-struct)
(sd-am-hatch-pattern-struct-patterns sd-am-hatch-pattern-struct)
Description:
Describes a hatch pattern. The parameters angle and distance are absolute values defined in system units, as a reference for the simple patterns.

Slots:
name {STRING} - The registered pattern name.
label {STRING} - The displayed pattern name.
angle {LONG-FLOAT} - The absolute angle of the hatch lines.
distance {LONG-FLOAT} - The absolute distance between the hatch lines.
patterns {LIST of SD-AM-SIMPLE-PATTERN-STRUCTs} - The list of simple patterns overlayed by each other.

See Also:
SD-AM-SIMPLE-PATTERN-STRUCT [structure]
SD-AM-INQ-HATCH-PATTERN [function]

Function Index Top of Page

SD-AM-SIMPLE-PATTERN-STRUCT  [structure]

(sd-am-simple-pattern-struct-p         sd-am-simple-pattern-struct)
(sd-am-simple-pattern-struct-offset    sd-am-simple-pattern-struct)
(sd-am-simple-pattern-struct-distance  sd-am-simple-pattern-struct)
(sd-am-simple-pattern-struct-angle     sd-am-simple-pattern-struct)
(sd-am-simple-pattern-struct-color     sd-am-simple-pattern-struct)
(sd-am-simple-pattern-struct-line-type sd-am-simple-pattern-struct)
Description:
Describes a simple pattern. One or more simple patterns may constitute a hatch pattern. The parameters angle and distance are relative values defined in system units.

Slots:
name {STRING} - The registered pattern name.
offset {LONG-FLOAT} - The offset from 0,0 to the nearest hatch line.
distance {LONG-FLOAT} - The relative distance between the hatch lines.
angle {LONG-FLOAT} - The relative angle of the hatch lines.
color {STRING} - The hatch line color, one of
"WHITE"
"RED"
"GREEN"
"BLUE"
"YELLOW"
"MAGENTA"
"CYAN"
"BLACK"
line-style {STRING} - The hatch line style, one of
"SOLID"
"DOTTED"
"DASHED"
"LONG_DASHED"
"DOT_CENTER"
"DASH_CENTER"
"CENTER_DASH_DASH"
"PHANTOM"

See Also:
SD-AM-HATCH-PATTERN-STRUCT [structure]
SD-AM-INQ-HATCH-PATTERN [function]

Function Index Top of Page

SD-AM-INQ-REGISTERED-HATCH-PATTERN-NAMES  [function]

(sd-am-inq-registered-hatch-pattern-names)

Description:
Returns a list of all registered hatch patterns for automatic or manual hatching.

Parameters:
Return Value:
{LIST of STRINGs} - The list of hatch pattern names.
nil - An error occured.

Function Index Top of Page

SD-AM-INQ-CURR-AUTOMATIC-HATCH-PATTERN-NAME  [function]

(sd-am-inq-curr-automatic-hatch-pattern-name)

Description:
Returns the name of the current hatch pattern for automatic hatching.

Parameters:
Return Value:
{STRING} - The hatch pattern name.
nil - An error occured.
-------------------------------------------------------------------------------

Function Index Top of Page

SD-AM-INQ-CURR-MANUAL-HATCH-PATTERN-NAME  [function]

(sd-am-inq-curr-manual-hatch-pattern-name)

Description:
Returns the name of the current hatch pattern for manual hatching.

Parameters:
Return Value:
{STRING} - The hatch pattern name.
nil - An error occured.

Function Index Top of Page

SD-AM-INQ-HATCH-PATTERN  [function]

(sd-am-inq-hatch-pattern name)

Description:
Returns the hatch pattern definition for the given pattern name.

Parameters:
name {STRING} - The name of the registered hatch pattern to inquire.

Return Value:
{ SD-AM-HATCH-PATTERN-STRUCT} - The inquired hatch pattern.
nil - An error occured.

Function Index Top of Page

SD-AM-INQ-HATCH-MODE  [function]

(sd-am-inq-hatch-mode hatch)

Description:
Inquires whether a hatch is automatic or manual. Automatic hatches are generated automatically and represent section faces in section views.

Parameters:
hatch {SEL_ITEM} - The hatch to inquire.

Return Value:
{KEYWORD} - One of the following:
:MANUAL
:AUTOMATIC
nil - An error occured.
[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