Erweiterte Module > 3D-Dokumentation > 3D-Dokumentation erstellen > Dokumentationsebenen
  
Dokumentationsebenen
In 3D-Dokumentation können Sie die folgenden Bereiche für Dokumentationsebenen anpassen:
• Die Funktion SET-DELETE-DOCUPLANE-DEFAULT-MODE
• Die Funktion DOC3D_SHOW_DOCUPLANE_CONSIDERS_ORIGIN
• Die Funktion DOC3D-SET-SECTION-PARENT-PARAMETER-OPTIONAL
• Die Funktion DOC3D_SHOW_DOCUPLANE_USES_MODEL_CLIPPING_PLANES
• Die Funktion DOC3D-ALLOW-DIRECTION-CHANGE-FOR-DETAILS-AND-PARENTS
• Die Funktion DOC3D-CONFIG-SECTION-DP
• Die Funktion DOC3D-CONFIG-DETAIL-DP
• Die Funktion DOC3D-CONFIG-DP-LABELS
• Die Funktion DOC3D-CONFIG-SCALE-INFO-WITHIN-DP-LABELS
• Die Funktion "doc3d::doc3d-set-dp-naming-standards"
• Die Funktion "doc3d::doc3d-set-default-docuplane-offset"
Die Funktion SET-DELETE-DOCUPLANE-DEFAULT-MODE
Mit der Funktion SET-DELETE-DOCUPLANE-DEFAULT-MODE können Sie das Standardverhalten beim Löschen von Dokumentationsebenen bestimmen. Sie können festlegen, dass Annotationen, die zu einer gelöschten Dokumentationsebene gehören, ebenfalls gelöscht oder zu freien Annotationen werden sollen.
Syntax
(DOC3D:SET-DELETE-DOCUPLANE-DEFAULT-MODE :DELETE_ANNOS or :FREE_ANNOS)
Optionen
• Mit :DELETE_ANNOS legen Sie fest, dass Annotationen (standardmäßig) zusammen mit der zugehörigen Dokumentationsebene zum Löschen ausgewählt werden.
• Mit :FREE_ANNOS legen Sie fest, dass Annotationen (standardmäßig) zu freien Annotationen werden, wenn die zugehörige Dokumentationsebene gelöscht wird.
Beispiel
(doc3d:set-delete-docuplane-default-mode :FREE_ANNOS)
Die Funktion DOC3D_SHOW_DOCUPLANE_CONSIDERS_ORIGIN
Mit der Funktion DOC3D_SHOW_DOCUPLANE_CONSIDERS_ORIGIN können Sie die Fensteraktion im Hinblick auf den Ursprung bei Verwendung des Befehls "DokuEbene zeigen" festlegen. Sie können festlegen, dass der Ursprung der Dokumentationsebene in der Mitte des Darstellungsfensters positioniert wird, wenn Sie den Befehl "Zeigen" (t) starten, während nach wie vor das vollständige Modell angezeigt wird. Ansonsten (nil) können Sie festlegen, dass der Ursprung nicht berücksichtigt wird; in diesem Fall führt der Befehl "Zeigen" einfach eine Einpassaktion im Fenster aus.
Syntax
(DOC3D:DOC3D_SHOW_DOCUPLANE_CONSIDERS_ORIGIN t or nil)
Beispiel
(doc3d:doc3d_show_docuplane_considers_origin nil)
Die Funktion DOC3D-SET-SECTION-PARENT-PARAMETER-OPTIONAL
Die Funktion DOC3D-SET-SECTION-PARENT-PARAMETER-OPTIONAL wirkt sich auf die Befehle CREATE und MODIFY für Dokumentationsebenen wie folgt aus: Mit dem Parameter "t" ist das Feld SECTION PARENT optional. Ist der Parameter NULL, muss SECTION PARENT angegeben werden. Wenn Sie also beabsichtigen, Dokumentationsebenen nach Creo Elements/Direct Annotation zu übertragen, sollten Sie hier den Parameter NULL verwenden.
Syntax
(DOC3D:DOC3D-SET-SECTION-PARENT-PARAMETER-OPTIONAL t or nil)
Beispiel
(doc3d:doc3d-set-section-parent-parameter-optional nil)
Die Funktion DOC3D_SHOW_DOCUPLANE_USES_MODEL_CLIPPING_PLANES
Mit der Funktion DOC3D_SHOW_DOCUPLANE_USES_MODEL_CLIPPING_PLANES können Sie die Sichtbarkeit von Schnittebenen beim Anzeigen von Dokumentationsebenen definieren.
Syntax
(DOC3D:DOC3D_SHOW_DOCUPLANE_USES_MODEL_CLIPPING_PLANES t or nil)
Beispiel
(doc3d:doc3d_show_docuplane_uses_model_clipping_planes nil)
Die Funktion DOC3D-ALLOW-DIRECTION-CHANGE-FOR-DETAILS-AND-PARENTS
Die Funktion DOC3D-ALLOW-DIRECTION-CHANGE-FOR-DETAILS-AND-PARENTS wirkt sich auf den Befehl MODIFY DOCUPLANE aus. Wenn Sie die Einstellung auf "t" setzen, können Sie die Optionen NORMAL und BY DIM im Befehl MODIFY DOCUPLANE verwenden für:
• Detail-Dokumentationsebenen.
• Übergeordnete Dokumentationsebenen, die zu Details und Schnitten gehören.
* 
Eine Warnung wird ausgegeben, die Sie bestätigen müssen. Dokumentationsebenen, die unter Ignorierung dieser Warnung geändert werden, können nicht nach Creo Elements/Direct Annotation übertragen werden.
Mit der Einstellung "nil" werden die Schaltflächen "ausgegraut", d. h., sie sind nicht verfügbar.
Syntax
(DOC3D:DOC3D-ALLOW-DIRECTION-CHANGE-FOR-DETAILS-AND-PARENTS t or nil)
Beispiel
(doc3d:doc3d-allow-direction-change-for-details-and-parents nil)
Die Funktion DOC3D-CONFIG-SECTION-DP
Diese Funktion definiert die Darstellung der
• Schnittlinie in der übergeordneten Dokumentationsebene
• Schnittbeschriftung und der Beschriftung der Schnitt-Dokumentationsebenen.
Eine Schnittlinie besteht aus Folgendem:kk
label_1
label_2
<---------Hinweislinien -------->
arrow_1 \
/------------------ -- --------------------\
/arrow_2
segment1
die Schnittlinie
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
Die folgenden Einstellungen legen die Beschriftungen seitlich der Schnittlinie fest.
: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
Mit folgenden Einstellungen wird die Beschriftung unterhalb der Schnittansicht definiert:
: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
)
Optionen
• Optionen für "Line-type":
Option
Ergebnis
:DOT_CENTER (Strichpunktlinie)
:SOLID (Volllinie)
:DASHED (Strichlinie)
:LONG_DASHED (Langstrichlinie)
:DASH_CENTER (Langstrich-Strichlinie)
:PHANTOM (Langstrich-Zweipunktlinie)
:CENTER_DASH_DASH (Langstrich-Zweistrichlinie)
:DOTTED (Punktlinie)
• Mit "Line-color" kann die Farbe der Linie geändert werden.
• "Segment-mode" bestimmt, ob die Segmente mit dem Ende der Schnittlinie überlappen oder nicht:
◦ :SEGM_OVERLAP
◦ :SEGM_NO_OVERLAP
• Der numerische Wert "Segment-length" legt die Länge der Segmente fest.
• Mit "segment-ltype" kann die Linienart für die Segmente definiert werden.
• Mit "Segment-color" kann die Farbe des Segments geändert werden.
• Der numerische Wert "Leader-length" legt die Länge der Hinweislinie fest.
• Mit "Leader-color" kann die Farbe der Hinweislinie und des Pfeils geändert werden.
• Optionen für "Arrow-type":
Option
Ergebnis
:ARROW_TYPE (Pfeilart)
:DOT_TYPE (Mit Punkt)
l
:SLASH_TYPE (Mit Strich)
\
:TRIANGLE_TYPE (Mit Dreieck)
:JIS_TYPE (JIS)
• Der numerische Wert "Arrow-size" legt die Größe des Pfeils fest.
• Der numerische Wert "Offset" bestimmt den Abstand der Beschriftung vom Teil.
• Position
Für Schnittlinienbeschriftungen:
Option
Ergebnis
:TOP (Oben)
Am Ende der Hinweislinie
:TOP_SIDE (Oben seitlich)
Seitlich vom Anfang der Hinweislinien
:BOTTOM_SIDE (Unten seitlich)
Am Ende der Segmentlinien
Beschriftungen in der Schnittansicht können je nach Orientierung der Dokumentationsebenen links oder rechts angezeigt werden.
Option
Ergebnis
:BELOW (Darunter)
Die Beschriftung wird auf der übergeordneten Dokumentationsebene unterhalb des Teils angezeigt
:ABOVE (Darüber)
Die Beschriftung wird auf der übergeordneten Dokumentationsebene oberhalb des Teils angezeigt
• Geben Sie alternative Schriftarten in doppelten Anführungszeichen an:
◦ hp_i3098_v
◦ hp_block_v
• Der numerische Wert "Label-size" gibt die Schriftgröße an.
• Mit "Color" kann die Beschriftungsfarbe geändert werden.
• Mit den Optionen für "Frame-style" werden Form und Art des Beschriftungsrandes angegeben:
◦ :OFF (Aus)
◦ :BOX (Rahmen)
◦ :BALLOON (Ballon)
• "Prefix" bestimmt den Text, der in der Beschriftung angezeigt wird.
• Mit "Position" wird die Platzierung der Beschriftung auf der Dokumentationsebene festgelegt:
◦ :BELOW (Darunter)
◦ :ABOVE (Darüber)
• Die Option "scale-info" bestimmt, ob Skalierungsinformationen in der Beschriftung auf der Dokumentationsebene enthalten sein sollen. Optionen:
◦ :NO
◦ :YES
◦ :AUTOMATIC – Skalierungsinformationen werden nur angezeigt, wenn der Maßstab der Dokumentationsebene geändert wurde.
Beispiel
(DOC3D:DOC3D-CONFIG-SECTION-DP
:DOC3D_SECTION_LINE_GEO_LTYPE
:DOT_CENTER (Strichpunktlinie)
: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 (Volllinie)
: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 (Pfeilart)
:DOC3D_SECTION_LINE_LEADER_ARR_SIZE
10.5
Die folgenden Einstellungen legen die Beschriftungen seitlich der Schnittlinie fest.
:doc3d_section_line_label_offset
7.0
:doc3d_section_line_label_position
:TOP_SIDE (Oben seitlich)
: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 (Aus)
Mit folgenden Einstellungen wird die Beschriftung unterhalb der Schnittansicht definiert:
: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 (Aus)
:doc3d_section_dp_label_position
:BELOW (Darunter)
:doc3d_section_dp_label_includes_scaling_info
:AUTOMATIC
)
Die Funktion DOC3D-CONFIG-DETAIL-DP
Mit dieser Funktion können Sie die Darstellung der Beschriftungen von Teil- und Detail-Dokumentationsebenen festlegen.
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
)
Optionen
• Der numerische Wert "Offset" bestimmt den Abstand der Beschriftung vom Teil.
• Geben Sie alternative Schriftarten in doppelten Anführungszeichen an:
◦ hp_i3098_v
◦ hp_block_v
• Der numerische Wert "Label-size" gibt die Schriftgröße an.
• Mit "Color" kann die Beschriftungsfarbe geändert werden.
• Mit den Optionen für "Frame-style" werden Form und Art des Beschriftungsrandes angegeben:
◦ :OFF (Aus)
◦ :BOX (Rahmen)
◦ :BALLOON (Ballon)
• Die Option "scale-info" bestimmt, ob Skalierungsinformationen in der Beschriftung auf der Dokumentationsebene enthalten sein sollen. Optionen:
◦ :NO
◦ :YES
◦ :AUTOMATIC – Skalierungsinformationen werden nur angezeigt, wenn der Maßstab der Dokumentationsebene geändert wurde.
• Mit "Position" wird die Platzierung der Beschriftung auf der Dokumentationsebene festgelegt:
◦ :BELOW (Darunter)
◦ :ABOVE (Darüber)
• Über den Parameter "show" lässt sich die Beschriftung der Dokumentationsebene ein- oder ausblenden:
◦ :OFF (Aus)
◦ :ON
Beispiel
(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 (Aus)
:doc3d_detail_dp_label_includes_scaling_info
:AUTOMATIC
:doc3d_detail_dp_label_position
:BELOW (Darunter)
:doc3d_detail_dp_show_dp_label
:NO
)
Die Funktion DOC3D-CONFIG-DP-LABELS
Definieren Sie mit dieser Funktion die Darstellung der standardmäßigen und allgemeinen Beschriftungen der Dokumentationsebenen.
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
)
Optionen
• Der numerische Wert "Offset" bestimmt den Abstand der Beschriftung vom Teil.
• Geben Sie alternative Schriftarten in doppelten Anführungszeichen an:
◦ hp_i3098_v
◦ hp_block_v
• Der numerische Wert "Label-size" gibt die Schriftgröße an.
• Mit "Color" kann die Beschriftungsfarbe geändert werden.
• Label-frame (ein oder aus – kein sichtbarer Unterschied)
• Mit dem Parameter "dpname" können Sie den Namen der Dokumentationsebene in der Beschriftung ein- oder ausblenden:
◦ :ON
◦ :OFF (Aus)
• Die Option "scale-info" bestimmt, ob Skalierungsinformationen in der Beschriftung auf der Dokumentationsebene enthalten sein sollen. Optionen:
◦ :NO
◦ :YES
◦ :AUTOMATIC – Skalierungsinformationen werden nur angezeigt, wenn der Maßstab der Dokumentationsebene geändert wurde.
• "Position" bestimmt die Platzierung der Beschriftung in Bezug zum Rahmen der Dokumentationsebene:
◦ :BELOW (Darunter)
◦ :ABOVE (Darüber)
• Über den Parameter "show" lässt sich die Anzeige der Beschriftung ein- oder ausblenden:
◦ :ON
◦ :OFF (Aus)
Beispiel
(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 (Aus)
:doc3d_dp_label_includes_dpname
:YES
:doc3d_dp_label_includes_scaling_info
:AUTOMATIC
:doc3d_dp_label_position
:BELOW (Darunter)
:doc3d_dp_show_dp_label
:YES
)
Die Funktion DOC3D-CONFIG-SCALE-INFO-WITHIN-DP-LABELS
Die Funktion DOC3D-CONFIG-SCALE-INFO-WITHIN-DP-LABELS bestimmt die Darstellung von Skalierungsinformationen in den Beschriftungen von Dokumentationsebenen.
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
)
Optionen
• "Prefix" bestimmt den Text, der in der Beschriftung angezeigt wird; die Standardeinstellung ist "Scale".
• Syntaxoptionen:
Option
Ergebnis
:COLON_SYNTAX
Scale 2.5:1
:SLASH_SYNTAX
Scale 2.5/1
:DECIMAL_SYNTAX
Scale 2.5
:X_SYNTAX
Scale 2.5x
• Klammernoptionen:
Option
Ergebnis
:NONE
Scale 1
:ROUND_BRACKETS
Scale (1)
:SQUARE_BRACKETS
Scale [1]
:BRACE
Scale {1}
Beispiel
(: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
)
Die Funktion "doc3d::doc3d-set-dp-naming-standards"
Die Funktion "doc3d-set-dp-naming-standards" steuert die Einbeziehung der Namen von übergeordneten Dokumentationsebenen in die Namen von Teil- und Detail-Dokumentationsebenen sowie die Einbeziehung des Wortes "Teil-" als Präfix für den Namen einer Schnitt-Dokumentationsebene.
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
)
Optionen
Option
Ergebnis
:include-parent-in-partial-name
:ON
Partia1l-of-Front1
:OFF (Aus)
Partial1
:include-parent-in-detail-name
:ON
Detail1-of-Front1
:OFF (Aus)
Detail1
:include-partial-prefix-for-section
:ON
Partial1-of-A-A
:OFF (Aus)
A-A
Beispiel
(:doc3d::doc3d-set-dp-naming-standards
:include-parent-in-partial-name
:ON
:include-parent-in-detail-name
:ON
:include-partial-prefix-for-section
:ON
)
Die Funktion "doc3d::doc3d-set-default-docuplane-offset"
Mit der Funktion "doc3d::doc3d-set-default-docuplane-offset" definieren Sie den Standardabstand beim Erstellen von standardmäßigen und allgemeinen Dokumentationsebenen. Diese Funktion kann nicht für Schnitt-Dokumentationsebenen eingesetzt werden.
Syntax
(doc3d::doc3d-set-default-docuplane-offset     0      or     positive integer)
Beispiel
(doc3d::doc3d-set-default-docuplane-offset 25)