延伸模块 > 3D 文档 > 创建 3D 文档 > 标注平面
  
标注平面
可以自定义与标注平面相关的 3D Documentation 的以下区域：
• SET-DELETE-DOCUPLANE-DEFAULT-MODE 函数
• DOC3D_SHOW_DOCUPLANE_CONSIDERS_ORIGIN 函数
• DOC3D-SET-SECTION-PARENT-PARAMETER-OPTIONAL 函数
• DOC3D_SHOW_DOCUPLANE_USES_MODEL_CLIPPING_PLANES 函数
• DOC3D-ALLOW-DIRECTION-CHANGE-FOR-DETAILS-AND-PARENTS 函数
• DOC3D-CONFIG-SECTION-DP 函数
• DOC3D-CONFIG-DETAIL-DP 函数
• DOC3D-CONFIG-DP-LABELS 函数
• doc3d-config-scale-info-within-dp-labels 函数
• doc3d::doc3d-set-dp-naming-standards 函数
• doc3d::doc3d-set-default-docuplane-offset 函数
SET-DELETE-DOCUPLANE-DEFAULT-MODE 函数
SET-DELETE-DOCUPLANE-DEFAULT-MODE 函数可以设置删除标注平面时的默认行为。可以指定属于被删除标注平面的注释也被删除，或指定它们应成为自由注释。
语法
(DOC3D:SET-DELETE-DOCUPLANE-DEFAULT-MODE :DELETE_ANNOS or :FREE_ANNOS)
选项
• :DELETE_ANNOS 指定注释应该 (默认情况下) 与它们拥有的标注平面一起被选择删除。
• :FREE_ANNOS 指定当删除注释拥有的标注平面时，注释应该 (默认情况下) 成为自由注释。
示例
(doc3d:set-delete-docuplane-default-mode :FREE_ANNOS)
DOC3D_SHOW_DOCUPLANE_CONSIDERS_ORIGIN 函数
当您使用“显示标注平面”命令时，DOC3D_SHOW_DOCUPLANE_CONSIDERS_ORIGIN 函数可以指定相对于原点的视区操作。当您启动“显示”(t)，并仍然显示完整模型时，可以设置标注平面原点，将它放置在视区的中心。否则 (nil)，您可以指定不考虑原点；在这种情况下，“显示”仅在视区中执行“调整”操作。
语法
(DOC3D:DOC3D_SHOW_DOCUPLANE_CONSIDERS_ORIGIN t or nil)
示例
(doc3d:doc3d_show_docuplane_considers_origin nil)
DOC3D-SET-SECTION-PARENT-PARAMETER-OPTIONAL 函数
DOC3D-SET-SECTION-PARENT-PARAMETER-OPTIONAL 函数用以下方式影响命令 CREATE 和 MODIFY 标注平面：如果参数是 t，“截面父项”字段则是可选的。如果参数是 nil，就要指定“截面父项”。这样，如果您计划将标注平面传递至 Creo Elements/Direct Annotation，就应使用此处的参数 nil。
语法
(DOC3D:DOC3D-SET-SECTION-PARENT-PARAMETER-OPTIONAL t or nil)
示例
(doc3d:doc3d-set-section-parent-parameter-optional nil)
DOC3D_SHOW_DOCUPLANE_USES_MODEL_CLIPPING_PLANES 函数
DOC3D_SHOW_DOCUPLANE_USES_MODEL_CLIPPING_PLANES 可以定义显示标注平面时的“剖切平面”可见性。
语法
(DOC3D:DOC3D_SHOW_DOCUPLANE_USES_MODEL_CLIPPING_PLANES t or nil)
示例
(doc3d:doc3d_show_docuplane_uses_model_clipping_planes nil)
DOC3D-ALLOW-DIRECTION-CHANGE-FOR-DETAILS-AND-PARENTS 函数
DOC3D-ALLOW-DIRECTION-CHANGE-FOR-DETAILS-AND-PARENTS 影响命令 MODIFY DOCUPLANE。将选项设置为 't' 时，可以针对以下内容在命令 MODIFY DOCUPLANE 中使用选项 NORMAL 和 BY DIM：
• 细节标注平面。
• 属于细节和截面的父标注平面。
* 
将会发出需要您确认的警告。忽略该警告更改的标注平面不能被传递至 Creo Elements/Direct Annotation。
设置选项 'nil' 将会导致“用户界面”按钮灰显。
语法
(DOC3D:DOC3D-ALLOW-DIRECTION-CHANGE-FOR-DETAILS-AND-PARENTS t or nil)
示例
(doc3d:doc3d-allow-direction-change-for-details-and-parents nil)
DOC3D-CONFIG-SECTION-DP 函数
该函数定义
• 父标注平面中剖面线的外观
• 截面标签和截面标注平面标签的外观。
剖面线由以下部分组成：
label_1
label_2
<---------指引线 -------->
arrow_1 \
/------------------ -- --------------------\
/arrow_2
segment1
剖面线
segment2
语法
(DOC3D:DOC3D-CONFIG-SECTION-DP
:DOC3D_SECTION_LINE_GEO_LTYPE
:line-type
:DOC3D_SECTION_LINE_GEO_COLOR
(line-color)
:DOC3D_SECTION_LINE_SEGM_MODE
segment-mode
:DOC3D_SECTION_LINE_SEGM_LENGTH
segment-length
:DOC3D_SECTION_LINE_SEGM_LTYPE
segment-ltype
:DOC3D_SECTION_LINE_SEGM_COLOR
segment-color
:DOC3D_SECTION_LINE_LEADER_LENGTH
leader-length
:DOC3D_SECTION_LINE_LEADER_COLOR
leader-color
:DOC3D_SECTION_LINE_LEADER_ARR_TYPE
arrow-type
:DOC3D_SECTION_LINE_LEADER_ARR_SIZE
arrow-size
以下设置可定义剖面线每侧的标签。
:doc3d_section_line_label_offset
offset
:doc3d_section_line_label_position
:position
:doc3d_section_line_label_font
"font"
:doc3d_section_line_label_size
label-size
:doc3d_section_line_label_color
(color)
:doc3d_section_line_label_frame
:frame-style
以下设置可定义截面视图下面的标签
:doc3d_section_dp_label_prefix
"Prefix"
:doc3d_section_dp_label_offset
offset
:doc3d_section_dp_label_font
"font"
:doc3d_section_dp_label_size
label-size
:doc3d_section_dp_label_color
(color)
:doc3d_section_dp_label_frame
:frame-style
:doc3d_section_dp_label_position
:position
:doc3d_section_dp_label_includes_scaling_info
:scale-info
)
选项
• Line-type 选项：
选项
结果
:DOT_CENTER
:SOLID
:DASHED
:LONG_DASHED
:DASH_CENTER
:PHANTOM
:CENTER_DASH_DASH
:DOTTED
• Line-color 可更改线的颜色。
• Segment-mode 可确定段是否与剖面线的端点重叠：
◦ :SEGM_OVERLAP
◦ :SEGM_NO_OVERLAP
• Segment-length，一个用于定义段长度的数值。
• 使用 segment-ltype 定义段所使用的线类型。
• Segment-color 可更改段的颜色。
• Leader-length，一个用于定义引线长度的数值。
• Leader-color 可更改指引线和箭头的颜色。
• Arrow-type 选项：
选项
结果
:ARROW_TYPE
:DOT_TYPE
l
:SLASH_TYPE
\
:TRIANGLE_TYPE
:JIS_TYE
• Arrow-size，一个用于定义箭头大小的数值。
• 偏移，一个用于确定标签与零件之间的距离的数值。
• 位置
对于剖面线标签：
选项
结果
:TOP
在指引线的末端
:TOP_SIDE
在指引线开始的一侧
:BOTTOM_SIDE
在线段的端点
对于截面视图标签，取决于标注平面的方向，标签可能显示在左侧或右侧。
选项
结果
:BELOW
标签显示在零件下方的父标注平面上
:ABOVE
标签显示在零件上方的父标注平面上
• 在双引号中指定替代字体：
◦ hp_i3098_v
◦ hp_block_v
• 标签大小，一个用于指定字体大小的数值。
• 颜色可用于更改标签颜色。
• 框架样式选项可指定是否使用标签边界以及标签边界的形状：
◦ :OFF
◦ :BOX
◦ :BALLOON
• "Prefix" 确定显示在标签中的文本；"Section" 是默认的。
• 位置可确定标注平面上标签的放置：
◦ :BELOW
◦ :ABOVE
• 比例信息选项可确定标注平面标签中是否包含缩放信息。选项为：
◦ :NO
◦ :YES
◦ :AUTOMATIC - 仅在修改标注平面比例后显示缩放信息。
示例
(DOC3D:DOC3D-CONFIG-SECTION-DP
:DOC3D_SECTION_LINE_GEO_LTYPE
:DOT_CENTER
:DOC3D_SECTION_LINE_GEO_COLOR
(oli::sd-rgb-to-color 1.0,1.0,1.0)
:DOC3D_SECTION_LINE_SEGM_MODE
:SEGM_OVERLAP
:DOC3D_SECTION_LINE_SEGM_LENGTH
5.0
:DOC3D_SECTION_LINE_SEGM_LTYPE
:SOLID
:DOC3D_SECTION_LINE_SEGM_COLOR
(oli::sd-rgb-to-color 1.0,1.0,1.0)
:DOC3D_SECTION_LINE_LEADER_LENGTH
20.0
:DOC3D_SECTION_LINE_LEADER_COLOR
(oli::sd-rgb-to-color 1.0,1.0,1.0
:DOC3D_SECTION_LINE_LEADER_ARR_TYPE
:ARROW_TYPE
:DOC3D_SECTION_LINE_LEADER_ARR_SIZE
10.5
以下设置可定义剖面线每侧的标签。
:doc3d_section_line_label_offset
7.0
:doc3d_section_line_label_position
:TOP_SIDE
:doc3d_section_line_label_font
"hp_i3098_v"
:doc3d_section_line_label_size
3.5
:doc3d_section_line_label_color
(oli::sd-rgb-to-color 1.0,1.0,1.0)
:doc3d_section_line_label_frame
:OFF
以下设置可定义截面视图下面的标签
:doc3d_section_dp_label_prefix
"Section"
:doc3d_section_dp_label_offset
5.0
:doc3d_section_dp_label_font
"hp_i3098_v"
:doc3d_section_dp_label_size
3.5
:doc3d_section_dp_label_color
(oli::sd-rgb-to-color 1.0,1.0,1.0)
:doc3d_section_dp_label_frame
:OFF
:doc3d_section_dp_label_position
:BELOW
:doc3d_section_dp_label_includes_scaling_info
:AUTOMATIC
)
DOC3D-CONFIG-DETAIL-DP 函数
可以使用该函数自定义局部和细节标注平面的标签的外观。
语法
(doc3d:doc3d-config-detail-dp
:doc3d_detail_dp_label_offset
offset
:doc3d_detail_dp_label_font
"font"
:doc3d_detail_dp_label_size
label-size
:doc3d_detail_dp_label_color
(color)
:doc3d_detail_dp_label_frame
:frame-style
:doc3d_detail_dp_label_includes_scaling_info
:scale-info
:doc3d_detail_dp_label_position
:position
:doc3d_detail_dp_show_dp_label
:show
)
选项
• 偏移，一个用于定义标签与零件之间的距离的数值。
• 在双引号中指定替代字体：
◦ hp_i3098_v
◦ hp_block_v
• 标签大小，一个用于指定字体大小的数值。
• 颜色可用于更改标签颜色。
• 框架样式选项可指定是否使用标签边界以及标签边界的形状：
◦ :OFF
◦ :BOX
◦ :BALLOON
• 比例信息选项可确定标注平面标签中是否包含缩放信息。选项为：
◦ :NO
◦ :YES
◦ :AUTOMATIC - 仅在修改标注平面比例后显示缩放信息。
• 位置可确定标注平面上标签的放置：
◦ :BELOW
◦ :ABOVE
• show 参数可以显示或隐含标注平面标签的显示：
◦ :OFF
◦ :ON
示例
(doc3d:doc3d-config-detail-dp
:doc3d_detail_dp_label_offset
5.0
:doc3d_detail_dp_label_font
"hp_i3098_v"
:doc3d_detail_dp_label_size
3.5
:doc3d_detail_dp_label_color
(oli::sd-rgb-to-color 1.0,1.0,1.0)
:doc3d_detail_dp_label_frame
:OFF
:doc3d_detail_dp_label_includes_scaling_info
:AUTOMATIC
:doc3d_detail_dp_label_position
:BELOW
:doc3d_detail_dp_show_dp_label
:NO
)
DOC3D-CONFIG-DP-LABELS 函数
用该函数定义标准和普通标签的外观。
语法
(doc3d:doc3d-config-dp-labels
:doc3d_dp_label_offset
offset
:doc3d_dp_label_font
"font"
:doc3d_dp_label_size
label-size
:doc3d_dp_label_color
(color)
:doc3d_dp_label_frame
:label-frame
:doc3d_dp_label_includes_dpname
:dpname
:doc3d_dp_label_includes_scaling_info
:scale-info
:doc3d_dp_label_position
:position
:doc3d_dp_show_dp_label
:show
)
选项
• 偏移，一个用于定义标签与零件之间的距离的数值。
• 在双引号中指定替代字体：
◦ hp_i3098_v
◦ hp_block_v
• 标签大小，一个用于指定字体大小的数值。
• 颜色可用于更改标签颜色。
• Label-frame (开启或关闭 - 没有明显的差异)
• dpname 参数可以显示或隐含标签中标注平面的名称：
◦ :ON
◦ :OFF
• 比例信息选项可确定标注平面标签中是否包含缩放信息。选项为：
◦ :NO
◦ :YES
◦ :AUTOMATIC - 仅在修改标注平面比例后显示缩放信息。
• position 可确定标签相对于标注平面框架的放置：
◦ :BELOW
◦ :ABOVE
• show 参数可以显示或隐含标签的显示：
◦ :ON
◦ :OFF
示例
(doc3d:doc3d-config-dp-labels
:doc3d_dp_label_offset
5.0
:doc3d_dp_label_font
"hp_i3098_v"
:doc3d_dp_label_size
3.5
:doc3d_dp_label_color
(oli:sd-rgb-to-color 1.0,1.0,1.0)
:doc3d_dp_label_frame
:OFF
:doc3d_dp_label_includes_dpname
:YES
:doc3d_dp_label_includes_scaling_info
:AUTOMATIC
:doc3d_dp_label_position
:BELOW
:doc3d_dp_show_dp_label
:YES
)
doc3d-config-scale-info-within-dp-labels 函数
DOC3D-CONFIG-SCALE-INFO-WITHIN-DP-LABELS 函数定义标注平面标签中的缩放信息的外观。
语法
(:doc3d_doc3d-config-scale-info-within-dp-labels
:doc3d_dp_label_scaling_prefix
"prefix"
:doc3d_dp_label_scaling_syntax
:syntax
:doc3d_dp_label_scaling_brackets
:bracket
)
选项
• "Prefix" 确定显示在标签中的文本；"Scale" 是默认的。
• 语法选项：
选项
结果
:COLON_SYNTAX
Scale 2.5:1
:SLASH_SYNTAX
Scale 2.5/1
:DECIMAL_SYNTAX
Scale 2.5
:X_SYNTAX
Scale 2.5x
• 括号选项：
选项
结果
:NONE
Scale 1
:ROUND_BRACKETS
Scale (1)
:SQUARE_BRACKETS
Scale [1]
:BRACE
Scale {1}
示例
(:doc3d_doc3d-config-scale-info-within-dp-labels
:doc3d_dp_label_scaling_prefix
"Scale"
:doc3d_dp_label_scaling_syntax
:COLON_SYNTAX
:doc3d_dp_label_scaling_brackets
:brace
)
doc3d::doc3d-set-dp-naming-standards 函数
doc3d-set-dp-naming-standards 函数控制在局部和细节标注平面的名称中是否包含父标注平面的名称，和控制是否将 "partial" 单词作为截面标注平面名称的前缀。
语法
(:doc3d::doc3d-set-dp-naming-standards
:include-parent-in-partial-name              :ON or :OFF
:include-parent-in-detail-name               :ON or :OFF
:include-partial-prefix-for-section           :ON or :OFF
)
选项
选项
结果
:include-parent-in-partial-name
:ON
Partia1l-of-Front1
:OFF
Partial1
:include-parent-in-detail-name
:ON
Detail1-of-Front1
:OFF
Detail1
:include-partial-prefix-for-section
:ON
Partial1-of-A-A
:OFF
A-A
示例
(:doc3d::doc3d-set-dp-naming-standards
:include-parent-in-partial-name
:ON
:include-parent-in-detail-name
:ON
:include-partial-prefix-for-section
:ON
)
doc3d::doc3d-set-default-docuplane-offset 函数
创建标准和普通标注平面时，使用 doc3d::doc3d-set-default-docuplane-offset 函数定义默认偏移。该函数对截面标注平面无效。
语法
(doc3d::doc3d-set-default-docuplane-offset     0      or     positive integer)
示例
(doc3d::doc3d-set-default-docuplane-offset 25)