Docuplanes

Extended modules > 3D Documenation > Create 3D documentation > Docuplanes

Docuplanes

You can customize the following areas of 3D Documentation relating to docuplanes:

• The SET-DELETE-DOCUPLANE-DEFAULT-MODE function

• The DOC3D_SHOW_DOCUPLANE_CONSIDERS_ORIGIN function

• The DOC3D-SET-SECTION-PARENT-PARAMETER-OPTIONAL function

• The DOC3D_SHOW_DOCUPLANE_USES_MODEL_CLIPPING_PLANES function

• The DOC3D-ALLOW-DIRECTION-CHANGE-FOR-DETAILS-AND-PARENTS function

• The DOC3D-CONFIG-SECTION-DP function

• The DOC3D-CONFIG-DETAIL-DP function

• The DOC3D-CONFIG-DP-LABELS function

• The doc3d-config-scale-info-within-dp-labels function

• The doc3d::doc3d-set-dp-naming-standards function

• The doc3d::doc3d-set-default-docuplane-offset function

The SET-DELETE-DOCUPLANE-DEFAULT-MODE function

The SET-DELETE-DOCUPLANE-DEFAULT-MODE function allows you to set the default behavior when deleting docuplanes. You can specify that annotations belonging to a deleted docuplane should also be deleted, or that they should be made free.

Syntax

(DOC3D:SET-DELETE-DOCUPLANE-DEFAULT-MODE :DELETE_ANNOS or :FREE_ANNOS)

Options

• :DELETE_ANNOS specifies that annos should (by default) be selected for deletion along with their owning docuplane.

• :FREE_ANNOS specifies that annos should (by default) be freed when their owning docuplane is deleted.

Example

(doc3d:set-delete-docuplane-default-mode :FREE_ANNOS)

The DOC3D_SHOW_DOCUPLANE_CONSIDERS_ORIGIN function

The DOC3D_SHOW_DOCUPLANE_CONSIDERS_ORIGIN function allows you to specify the viewport action with respect to the origin when you use the Show Docuplane command. You can set the docuplane origin to be placed at the center of the viewport when you start Show (t), while still displaying the full model. Otherwise (nil), you can specify that the origin is not taken into account; in this case, Show simply performs a Fit operation on the viewport.

Syntax

(DOC3D:DOC3D_SHOW_DOCUPLANE_CONSIDERS_ORIGIN t or nil)

Example

(doc3d:doc3d_show_docuplane_considers_origin nil)

The DOC3D-SET-SECTION-PARENT-PARAMETER-OPTIONAL function

The DOC3D-SET-SECTION-PARENT-PARAMETER-OPTIONAL function influences the commands CREATE and MODIFY docuplane in the following way: if the parameter is t, the SECTION PARENT field is optional. If the parameter is nil, the SECTION PARENT has to be specified. So if you plan to transfer the docuplanes to Creo Elements/Direct Annotation, then you should use the parameter nil here.

Syntax

(DOC3D:DOC3D-SET-SECTION-PARENT-PARAMETER-OPTIONAL t or nil)

Example

(doc3d:doc3d-set-section-parent-parameter-optional nil)

The DOC3D_SHOW_DOCUPLANE_USES_MODEL_CLIPPING_PLANES function

The DOC3D_SHOW_DOCUPLANE_USES_MODEL_CLIPPING_PLANES allows you to define the visibility of Clipping Planes when showing docuplanes.

Syntax

(DOC3D:DOC3D_SHOW_DOCUPLANE_USES_MODEL_CLIPPING_PLANES t or nil)

Example

(doc3d:doc3d_show_docuplane_uses_model_clipping_planes nil)

The DOC3D-ALLOW-DIRECTION-CHANGE-FOR-DETAILS-AND-PARENTS function

The DOC3D-ALLOW-DIRECTION-CHANGE-FOR-DETAILS-AND-PARENTS influences the command MODIFY DOCUPLANE. When you set the option to 't', you can use the options NORMAL and BY DIM within the command MODIFY DOCUPLANE for:

• detail docuplanes.

• parent docuplanes belonging to details and sections.

A warning will be issued that you need to confirm. Docuplanes which are changed ignoring this warning cannot be transferred to Creo Elements/Direct Annotation.

Setting the option 'nil' will cause the UI buttons to be greyed out.

Syntax

(DOC3D:DOC3D-ALLOW-DIRECTION-CHANGE-FOR-DETAILS-AND-PARENTS t or nil)

Example

(doc3d:doc3d-allow-direction-change-for-details-and-parents nil)

The DOC3D-CONFIG-SECTION-DP function

This function defines the appearance of the

• section line within the parent docuplane

• section label and the section docuplane label.

A section line consists of the following:kk

label_1		label_2
	<---------leader lines -------->

arrow_1 \	/------------------ -- --------------------\	/arrow_2
segment1	the section line	segment2

Syntax

(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

The following settings define the label on each side of the section line.

: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

The following settings define the label below the section view

: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
)

Options

• Line-type options:

Option	Result
:DOT_CENTER
:SOLID
:DASHED
:LONG_DASHED
:DASH_CENTER
:PHANTOM
:CENTER_DASH_DASH
:DOTTED

• Line-color changes the color of the line.

• Segment-mode determines whether the segments overlap the ends of the section line or not:

◦ :SEGM_OVERLAP

◦ :SEGM_NO_OVERLAP

• Segment-length, a numeric value, defines the length of the segments.

• Use segment-ltype to define the type of line to be used for the segments.

• Segment-color changes the color of the segment.

• Leader-length, a numeric value, defines the length of the leader-line.

• Leader-color change the color of the leader line and arrow.

• Arrow-type options:

Option	Result
:ARROW_TYPE
:DOT_TYPE	l
:SLASH_TYPE	\
:TRIANGLE_TYPE
:JIS_TYE

• Arrow-size, a numeric value, defines the size of the arrow.

• Offset, a numeric value, determines the distance of the label from the part.

• Position

For section line labels:

Option	Result
:TOP	At end of leader line
:TOP_SIDE	At side of the beginning of the leader lines
:BOTTOM_SIDE	At the ends of the segment lines

For section view labels, depending on the orientation of the docuplanes, the label may appear to the left or right.

Option	Result
:BELOW	Label appears on parent docuplane below part
:ABOVE	Label appears on parent docuplane above part

• Specify font alternatives in double quotes:

◦ hp_i3098_v

◦ hp_block_v

• Label-size, a numeric value, specifies the size of the font.

• Use color to change the label color.

• Frame-style options specify the existence and shape of the label border:

◦ :OFF

◦ :BOX

◦ :BALLOON

• "Prefix" determines the text displayed in the label; "Section" is the default.

• Position determines the placement of the label on the docuplane:

◦ :BELOW

◦ :ABOVE

• The scale-info option determines whether scaling information is to be included in the docuplane label. Options are:

◦ :NO

◦ :YES

◦ :AUTOMATIC—Scaling information displayed only if docuplane scale has been modified.

Example

(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

The following settings define the label on each side of the section line.

: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

The following settings define the label below the section view

: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
)

The DOC3D-CONFIG-DETAIL-DP function

This function allows you to customize the appearance of the labels of partial and detail docuplanes.

Syntax

(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
)

Options

• Offset, a numeric value, defines the distance of the label from the part.

• Specify font alternatives in double quotes:

◦ hp_i3098_v

◦ hp_block_v

• Label-size, a numeric value, specifies the size of the font.

• Use color to change the label color.

• Frame-style options specify the existence and shape of the label border:

◦ :OFF

◦ :BOX

◦ :BALLOON

• The scale-info option determines whether scaling information is to be included in the docuplane label. Options are:

◦ :NO

◦ :YES

◦ :AUTOMATIC - Scaling information displayed only if docuplane scale has been modified.

• Position determines the placement of the label on the docuplane:

◦ :BELOW

◦ :ABOVE

• The show parameter allows you to show or suppress display of the docuplane label:

◦ :OFF

◦ :ON

Example

(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
)

The DOC3D-CONFIG-DP-LABELS function

Define the appearance of standard and general docuplane labels with this function.

Syntax

(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
)

Options

• Offset, a numeric value, defines the distance of the label from the part.

• Specify font alternatives in double quotes:

◦ hp_i3098_v

◦ hp_block_v

• Label-size, a numeric value, specifies the size of the font.

• Use color to change the label color.

• Label-frame (on or off--no apparent difference)

• The dpname parameter allows you to show or suppress the name of the docuplane in the label:

◦ :ON

◦ :OFF

• The scale-info option determines whether scaling information is to be included in the docuplane label. Options are:

◦ :NO

◦ :YES

◦ :AUTOMATIC—Scaling information displayed only if docuplane scale has been modified.

• Position determines the placement of the label with respect to the docuplane frame:

◦ :BELOW

◦ :ABOVE

• The show parameter allows you to show or suppress the display of the label:

◦ :ON

◦ :OFF

Example

(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
)

The doc3d-config-scale-info-within-dp-labels function

The DOC3D-CONFIG-SCALE-INFO-WITHIN-DP-LABELS function defines the appearance of scaling information in docuplane labels.

Syntax

(: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
)

Options

• "Prefix" determines the text displayed in the label; "Scale" is the default.

• Syntax options:

Option	Result
:COLON_SYNTAX	Scale 2.5:1
:SLASH_SYNTAX	Scale 2.5/1
:DECIMAL_SYNTAX	Scale 2.5
:X_SYNTAX	Scale 2.5x

• Brackets options:

Option	Result
:NONE	Scale 1
:ROUND_BRACKETS	Scale (1)
:SQUARE_BRACKETS	Scale [1]
:BRACE	Scale {1}

Example

(: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
)

The doc3d::doc3d-set-dp-naming-standards function

The doc3d-set-dp-naming-standards function controls the inclusion of parent docuplane names in the names of partial and detail docuplanes, and the inclusion of the word, "partial," as a prefix for a section docuplane name.

Syntax

(: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
)

Options

Option	Result
: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

Example

(:doc3d::doc3d-set-dp-naming-standards
:include-parent-in-partial-name	:ON
:include-parent-in-detail-name	:ON
:include-partial-prefix-for-section	:ON
)

The doc3d::doc3d-set-default-docuplane-offset function

Use the doc3d::doc3d-set-default-docuplane-offset function to define the default offset when creating standard and general docuplanes. This function does not work for section docuplanes.

Syntax

(doc3d::doc3d-set-default-docuplane-offset 0 or positive integer)

Example

(doc3d::doc3d-set-default-docuplane-offset 25)