0% found this document useful (0 votes)
15 views2,092 pages

Drawingsand Reports Reference Data Guide

Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
Download as pdf or txt
0% found this document useful (0 votes)
15 views2,092 pages

Drawingsand Reports Reference Data Guide

Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
Download as pdf or txt
Download as pdf or txt
You are on page 1/ 2092

Drawings and Reports

Reference Data Guide

Version 2016 (11.0)


November 2016
Copyright
Copyright © 2002-2016 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains
confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and
international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.
Portions of this software are owned by Spatial Corp. © 1986-2016. All Rights Reserved.
Portions of the user interface are copyright © 2012-2016 Telerik AD.

U.S. Government Restricted Rights Legend


Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the
United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
305 Intergraph Way
Madison, AL 35758

Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.

Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.

Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial use. The Other Documentation
may not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and
for any reason by Intergraph Corporation by giving written notice to Licensee.
Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.
The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.

Drawings and Reports Reference Data Guide 2


Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.

Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.

Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.

Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, FrameWorks, I-Sketch, SmartMarine, IntelliShip, ISOGEN, SmartSketch,
SPOOLGEN, SupportManager, SupportModeler, Sapphire, and Intergraph Smart are trademarks or registered trademarks of
Intergraph Corporation or its subsidiaries in the United States and other countries. Hexagon and the Hexagon logo are registered
trademarks of Hexagon AB or its subsidiaries. Microsoft and Windows are registered trademarks of Microsoft Corporation. ACIS is a
registered trademark of SPATIAL TECHNOLOGY, INC. Infragistics, Presentation Layer Framework, ActiveTreeView Ctrl,
ProtoViewCtl, ActiveThreed Ctrl, ActiveListBar Ctrl, ActiveSplitter, ActiveToolbars Ctrl, ActiveToolbars Plus Ctrl, and ProtoView are
trademarks of Infragistics, Inc. Incorporates portions of 2D DCM, 3D DCM, and HLM by Siemens Product Lifecycle Management
Software III (GB) Ltd. All rights reserved. Gigasoft is a registered trademark, and ProEssentials a trademark of Gigasoft, Inc.
VideoSoft and VXFlexGrid are either registered trademarks or trademarks of ComponentOne LLC 1991-2013, All rights reserved.
Oracle, JD Edwards, PeopleSoft, and Retek are registered trademarks of Oracle Corporation and/or its affiliates. Tribon is a
trademark of AVEVA Group plc. Alma and act/cut are trademarks of the Alma company. Other brands and product names are
trademarks of their respective owners.

Drawings and Reports Reference Data Guide 3


Contents
Preface ........................................................................................................................................................ 28
What's New in Drawings and Reports Reference Data ........................................................................ 28
ISO Standards in Marine Drawings....................................................................................................... 31
AWS Standards in Drawings................................................................................................................. 34

The Management Console, Folders, and Components ......................................................................... 35


Locations of Drawings and Reports Data ............................................................................................. 39
Shortcut Menus ..................................................................................................................................... 40
Configure New Command on a Folder ........................................................................................... 40
3D Model By Query ............................................................................................................................... 41
3D Model Data ...................................................................................................................................... 42
Exporting 3D Model Graphics to MicroStation ...................................................................................... 43
Generic Module Folder ......................................................................................................................... 44
Composed Drawings ............................................................................................................................. 44
Drawings by Query Manager ................................................................................................................ 47
Orthographic Drawings by Query.......................................................................................................... 48
Isogen Isometric Drawings by Query .................................................................................................... 49
Spreadsheet Reports ............................................................................................................................ 51
Search Folders ...................................................................................................................................... 51
Volume Drawings .................................................................................................................................. 53

Tools Menu ................................................................................................................................................. 55


Define View Style Command (Tools Menu) .......................................................................................... 56
View Style Rules ............................................................................................................................. 57
Define View Style Dialog Box ......................................................................................................... 58
View Style Properties Dialog Box ................................................................................................... 59
Edit Ruleset View Style Dialog Box .............................................................................................. 118
Key Plan Style Dialog Box ............................................................................................................ 140
Select Filter Dialog Box ................................................................................................................ 143
Define Layout Style Command (Tools Menu) ..................................................................................... 145
Define Layout Style Dialog Box .................................................................................................... 146
Edit Layout Style Dialog Box ........................................................................................................ 146
Define a Layout Style ................................................................................................................... 147
Set up custom layout processor modules .................................................................................... 147
Create a new layout style with custom layout processors ............................................................ 148
Edit Border Template Command (Tools Menu) .................................................................................. 149
Select Template Dialog Box ......................................................................................................... 150
Import a Border File and Create a Drawing Area ......................................................................... 150
Create Border and Layout Templates .......................................................................................... 151
Edit Layout Template Command (Tools Menu) .................................................................................. 152
Select Layout Template Dialog Box ............................................................................................. 153
Select Border Family Dialog Box .................................................................................................. 154
Edit a Layout Template................................................................................................................. 154
Custom Commands ............................................................................................................................ 156

Drawings and Reports Reference Data Guide 4


Contents

Create custom commands ........................................................................................................... 159


Add custom commands ................................................................................................................ 159
Run a custom command............................................................................................................... 159
Edit a custom command ............................................................................................................... 159
Delete a custom command ........................................................................................................... 160
Custom Commands Dialog Box ................................................................................................... 160
Add Custom Command Dialog Box .............................................................................................. 161
Edit Custom Command Dialog Box .............................................................................................. 161
Delivered Custom Commands ..................................................................................................... 162

Drawings by Rule Reference Data ......................................................................................................... 163


Drawings by Rule Packages ............................................................................................................... 164
Mfg Templateset (Full Scale) Package ........................................................................................ 166
Drawings by Rule View Styles ............................................................................................................ 167
Hull Lines - Body Plan View ......................................................................................................... 170
Member Part ................................................................................................................................. 176
Mfg PinJig SideView ..................................................................................................................... 177
Mfg Profile Sketch ........................................................................................................................ 179
Mfg TemplateSet - Full Scale ....................................................................................................... 181
Shell Expansion ............................................................................................................................ 182
Steel Order - Reference Plane (Generic) View Style ................................................................... 184
Steel Order - Section and Detail (Generic) Views ........................................................................ 186
Steel Order (Generic) ................................................................................................................... 188
Drawings by Rule View Style Rule Sets ............................................................................................. 190
Assembly Drawing Rule Set ......................................................................................................... 190
Generic Rule Set .......................................................................................................................... 191
Hull Lines Drawings Rule Set ....................................................................................................... 196
Manufacturing PinJig Drawing Rule Set ....................................................................................... 206
Manufacturing Profile Sketch Rule Set ......................................................................................... 207
Manufacturing Sketch Rule Set .................................................................................................... 212
Manufacturing Template Drawing Rule Sets ................................................................................ 216
Manufacturing Templateset Full Scale Drawing Rule Set ............................................................ 219
Manufacturing PinJig Side View Rule Set .................................................................................... 222
Steel Order Drawing Rule Set ...................................................................................................... 225
Examples of Actions in Scantling Drawing View Styles ............................................................... 241
Ruleset Custom Tests ......................................................................................................................... 263
Belongs to Query .......................................................................................................................... 264
Bevel Orientation .......................................................................................................................... 265
Block Location .............................................................................................................................. 266
Bounded ....................................................................................................................................... 268
Connected Parts ........................................................................................................................... 268
Connection Species...................................................................................................................... 270
Connection Type .......................................................................................................................... 271
Coordinate System Relation ......................................................................................................... 272
Direction ....................................................................................................................................... 273
Draw Detail ................................................................................................................................... 274
Draw Flange on Web .................................................................................................................... 275
Gathered ....................................................................................................................................... 276
Get Parts in Range ....................................................................................................................... 276
Has Intersection Seam ................................................................................................................. 277

Drawings and Reports Reference Data Guide 5


Contents

Is Root Logical Connection .......................................................................................................... 278


Level ............................................................................................................................................. 278
Opening Type ............................................................................................................................... 279
Orientation .................................................................................................................................... 279
Orientation Angle .......................................................................................................................... 280
Owned By ..................................................................................................................................... 280
Parent Parts .................................................................................................................................. 280
Parent Plate .................................................................................................................................. 280
Primary and Secondary Orientation ............................................................................................. 281
Related Object Exists ................................................................................................................... 285
Relation to Target ......................................................................................................................... 286
Relation to Target Plate ................................................................................................................ 287
Stiffened Plates ............................................................................................................................ 288
Web Orientation ............................................................................................................................ 288
Add-on Ruleset View Styles ................................................................................................................ 288
Grid Add-on Rulesets ................................................................................................................... 291
Collation Rules in Drawings by Rule ................................................................................................... 293
Orientation Rules in Drawings by Rule ............................................................................................... 297
Layout Style Rules in Drawings by Rule ............................................................................................. 302
Gathering Rules in Drawings by Rule ................................................................................................. 307
Section View Orientation Rules in Drawings by Rule ......................................................................... 308
Line Styles in Drawings by Rule ......................................................................................................... 313
Document and Sheet Naming Rules in Drawings by Rule ................................................................. 313
View Naming Rules in Drawings by Rule ........................................................................................... 317
Drawings by Rule Reports .................................................................................................................. 319

Orthographic Drawings Reference Data ............................................................................................... 321


Bulkload Files ...................................................................................................................................... 321
Drawings Workbook ..................................................................................................................... 322
Custom Scale Codelist Workbook ................................................................................................ 323
Custom Attributes ......................................................................................................................... 325
DrawingIssueReason_Codelist Workbook ................................................................................... 328
Orthographic Drawing Packages ........................................................................................................ 330
Electrical Packages ...................................................................................................................... 330
Equipment Packages.................................................................................................................... 342
HVAC Packages ........................................................................................................................... 347
Instrument Packages .................................................................................................................... 352
Isometrics (by Query) Packages .................................................................................................. 357
Orthographic (by Query) Packages .............................................................................................. 358
Piping Packages ........................................................................................................................... 361
Structural Framing Packages ....................................................................................................... 366
Orthographic and Key Plan View Styles ............................................................................................. 370
Drawing View Style Creation Process .......................................................................................... 371
Key Plan View Styles.................................................................................................................... 373
Civil View Styles ........................................................................................................................... 375
Electrical View Styles ................................................................................................................... 398
Equipment View Styles ................................................................................................................. 459
HngSup View Styles ..................................................................................................................... 489
HVAC View Styles ........................................................................................................................ 498
Instrument View Styles ................................................................................................................. 517

Drawings and Reports Reference Data Guide 6


Contents

Nozzle View Styles ....................................................................................................................... 560


Pipe Supports View Styles ........................................................................................................... 564
Piping View Styles ........................................................................................................................ 566
Layout Style Rules in Orthographic Drawings .................................................................................... 635

Isogen Isometric Drawings Reference Data ......................................................................................... 639


Bulkload Files ...................................................................................................................................... 641
PipeMfgRules Sheet ..................................................................................................................... 642
PipeMfgMapSymbol Sheet ........................................................................................................... 642
PipeMfgSpoolRule Sheet ............................................................................................................. 643
HS_Property_Interface Sheet ...................................................................................................... 644
Isogen Isometric Drawing by Query Packages ................................................................................... 645
Modify an Existing Border File ............................................................................................................ 645
Create a new isometric drawing style ................................................................................................. 646
Import an Existing MicroStation DGN Border ..................................................................................... 648
Edit an Isometric Backing Sheet ......................................................................................................... 649
Place Piping Isometric Drawings Surface-mounted Components ...................................................... 649

Reports Reference Data .......................................................................................................................... 651


Report Sheet ....................................................................................................................................... 652
Run Time Query Options .................................................................................................................... 653
Add a Report Template ....................................................................................................................... 655
Create a filter-based report that uses the DrawingMAP table ............................................................ 656

Material Handling Drawing View Styles ................................................................................................ 657


MHE Plate-Openings View Style ........................................................................................................ 658
MHE_Chute System Details ............................................................................................................... 658
MHE_Chute System Isometric View Style .......................................................................................... 659
MHE_InclinedPlateDimensions View Style ......................................................................................... 660
MHE_Incremental and Normal Dimensions View Style ...................................................................... 661
MHE_Member Openings .................................................................................................................... 661
MHE_Plate Details View Style ............................................................................................................ 662
MHE_Plot Plan View Style .................................................................................................................. 663
MHE_Profile Details View Style .......................................................................................................... 664
MHE_ProfileAndData View Style ........................................................................................................ 665
MHE_ProfileAndData_IdlersNormalToBelt View Style ....................................................................... 667
MHE_ProfileAssembly_Isometric View Style ...................................................................................... 675
MHE_ProfileAssembly_M View Style ................................................................................................. 676
MHE_SketchedFeatures ..................................................................................................................... 677
MHE_Site Plan View Style .................................................................................................................. 678

Dimensions .............................................................................................................................................. 679


Dimension Rules ................................................................................................................................. 680
Dimension Anchors ............................................................................................................................. 690
Marine Dimension Rules ..................................................................................................................... 690
Manufacturing Dimension Rules ......................................................................................................... 693
Dimension Templates Overview ......................................................................................................... 694
Common Dimension Template Properties ................................................................................... 694

Drawings and Reports Reference Data Guide 7


Contents

Generic Horizontal Dimensions .................................................................................................... 698


Generic Vertical Dimensions ........................................................................................................ 700
Hangers and Supports Dimensions .............................................................................................. 701
Horizontal and Vertical Cable Trays ............................................................................................. 704
Horizontal Structure Dimensions .................................................................................................. 705
Miscellaneous Dimensions ........................................................................................................... 707
Structure Margin Dimensions ....................................................................................................... 710
Vertical Routable Dimensions ...................................................................................................... 711
Vertical Structure Dimensions ...................................................................................................... 712
Marine Dimension Templates ....................................................................................................... 715

Graphic Rules .......................................................................................................................................... 725


Customized Graphic Rules ................................................................................................................. 726
Cutting Surface Intersection ................................................................................................................ 726
Draw 2D Graphics ............................................................................................................................... 728
Landing Curve with End Cuts ............................................................................................................. 729
Not Drawn ........................................................................................................................................... 730
Replace Intersection Seam with Slot Symbol ..................................................................................... 731
Replace Objects with Line .................................................................................................................. 732
Resymbolized by Rule Set .................................................................................................................. 734
Visible/Hidden Edges (VHL) ............................................................................................................... 734

Labels ....................................................................................................................................................... 740


Compound Labels ............................................................................................................................... 744
Create a Compound Label Using Label Rules ............................................................................. 745
Create a Compound Label with a Combined Symbol .................................................................. 748
Create a Compound Label Using the Content Module ................................................................ 750
Group Labels....................................................................................................................................... 753
Generic Name Labels ......................................................................................................................... 758
Label Rules ......................................................................................................................................... 764
North-East Coordinate Labels ...................................................................................................... 784
Label Templates.................................................................................................................................. 786
Label Templates Overview ........................................................................................................... 786
Clipped Labels .............................................................................................................................. 822
Coordinate and Control Point Labels ........................................................................................... 823
Coordinate Labels ........................................................................................................................ 826
Grid Labels ................................................................................................................................... 829
Longest Segment Labels .............................................................................................................. 833
Miscellaneous Labels ................................................................................................................... 834
Name Labels (DrawingAbsolute) .................................................................................................. 841
Name Labels (DwgLinearAbsPos) ............................................................................................... 845
Name Labels (Name-Elevation-Width) ......................................................................................... 847
Nozzle Orientation Labels ............................................................................................................ 848
Reference Labels ......................................................................................................................... 850
Section Size Labels ...................................................................................................................... 851
Label Rules in Drawings by Rule ........................................................................................................ 852
General Label Rules ..................................................................................................................... 852
Scantling Label Rules ................................................................................................................... 853
Hull Lines and Manufacturing Label Rules ................................................................................... 856

Drawings and Reports Reference Data Guide 8


Contents

North Arrow Label Rules .............................................................................................................. 858


Label Templates in Drawings by Rule ................................................................................................ 859
Label Templates: A - G................................................................................................................. 859
Label Templates: H - L ................................................................................................................. 865
Label Templates: Mfg - R ............................................................................................................. 867
Label Templates: Scantling .......................................................................................................... 872
Label Templates: Ship Structure Plate ......................................................................................... 880
Label Templates: Ship Structure Profile ....................................................................................... 883
Label Templates: StrMfg - W ........................................................................................................ 886
North Arrow Templates................................................................................................................. 894
View Templates ............................................................................................................................ 897
Steel Order Templates ................................................................................................................. 898
Symbols in Orthographic Drawings..................................................................................................... 906
Create a Custom Symbol for Drawings ........................................................................................ 906
Create a Custom Cutting Plane Symbol....................................................................................... 907
Drawings by Rule Labels, Symbols, and Dimensions ........................................................................ 910
Label Definition for Drawings by Rule .......................................................................................... 912
Concatenated Labels for Drawings by Rule ................................................................................. 915
Symbol Definition for Drawings by Rule ....................................................................................... 916
View Label Rules in Drawings ............................................................................................................ 918
DetailSimpleReference ................................................................................................................. 919
Hanger and Support Piping Properties ......................................................................................... 919
PartOccTestCOMLabelFormat ..................................................................................................... 919
SectionSimpleReference1 ............................................................................................................ 920
SectionSimpleReference2 ............................................................................................................ 920
View Label Rules in Drawings by Rule ............................................................................................... 920
ViewNameDirectionScale View Label Template .......................................................................... 921
ShipParentBlockAndPartName View Label Template ................................................................. 922
Label Editor ......................................................................................................................................... 922
Select Rule Dialog Box (Label Editor - Unit of Measure) ............................................................. 928
Create a Label .............................................................................................................................. 929
Modify Label Symbol File ............................................................................................................. 930
Modify Label XML File .................................................................................................................. 931
Create a New Label Rule ............................................................................................................. 931
Matchline Rules................................................................................................................................... 932
Matchline Drawing Requirements ................................................................................................ 933
North Arrow Rules ............................................................................................................................... 934

View Rules ................................................................................................................................................ 935


View Label Rules in Drawings ............................................................................................................ 935
Select View Rule Dialog Box .............................................................................................................. 936
View Frame Rule Dialog Box .............................................................................................................. 937

Weld Labels .............................................................................................................................................. 938


Scantling Shell Profile Weld Label ...................................................................................................... 938
Scantling Profile Weld_IButt ......................................................................................................... 938
Scantling Profile Weld_IVButt ...................................................................................................... 939
Scantling Profile Weld_IXButt ...................................................................................................... 939
Scantling Profile Weld_VButt ....................................................................................................... 940

Drawings and Reports Reference Data Guide 9


Contents

Scantling Profile Weld_XButt ....................................................................................................... 940


Scantling Profile Weld_XButtSM .................................................................................................. 941
Scantling Profile Weld_YButt ....................................................................................................... 941
Structure_Weld ................................................................................................................................... 942
WeldLabel ........................................................................................................................................... 949
Structure_Weld_Fillet ................................................................................................................... 949
Structure_Weld_IButt ................................................................................................................... 950
Structure_Weld_IVButt ................................................................................................................. 950
Structure_Weld_IXButt ................................................................................................................. 950
Structure_Weld_VButt .................................................................................................................. 951
Structure_Weld_XButt .................................................................................................................. 951
Structure_Weld_YButt .................................................................................................................. 952
Structure_Weld_Tee1................................................................................................................... 952
Structure_Weld_Tee2................................................................................................................... 953
Structure_Weld_Tee3................................................................................................................... 953
Structure_Weld_Tee4................................................................................................................... 954
Structure_Weld_Tee5................................................................................................................... 954
Structure_Weld_Tee6................................................................................................................... 955
Structure_Weld_Tee7................................................................................................................... 955
Structure_Weld_TeeK .................................................................................................................. 956
Structure_Weld_TeeV .................................................................................................................. 956
Structure_Weld_TeeX .................................................................................................................. 957
Structure_Weld_TeeY .................................................................................................................. 957
ViewTypeDirectionAndScale ........................................................................................................ 958
WeldSymbol ................................................................................................................................. 958

Graphic Preparation Rules ..................................................................................................................... 959


Civil Elevation...................................................................................................................................... 961
Civil Overall Key Plan ......................................................................................................................... 961
Civil Plan ............................................................................................................................................. 961
Electrical Above Ground Plan ............................................................................................................. 961
Electrical CableTray Elevation ............................................................................................................ 961
Electrical CableTray Layout Plan ........................................................................................................ 962
Electrical CableTray Overall Key Plan ................................................................................................ 962
Electrical CableTray Plan .................................................................................................................... 962
Electrical Equipment Elevation ........................................................................................................... 962
Electrical Equipment Key Plan ............................................................................................................ 962
Electrical Equipment Overall Key Plan ............................................................................................... 963
Electrical Raceway Plan ..................................................................................................................... 963
Equipment Elevation ........................................................................................................................... 963
Equipment Overall Key Plan ............................................................................................................... 963
Equipment Plan ................................................................................................................................... 963
HngSup - CAD Detail .......................................................................................................................... 964
HngSup - End...................................................................................................................................... 964
HngSup - End Style2 .......................................................................................................................... 964
HngSup - Key Plan ............................................................................................................................. 964
HngSup - Side Style2 .......................................................................................................................... 965
HVAC Elevation .................................................................................................................................. 965
HVAC Isometric................................................................................................................................... 965
HVAC Overall Key Plan ...................................................................................................................... 965

Drawings and Reports Reference Data Guide 10


Contents

HVAC Plan .......................................................................................................................................... 966


Instrument Elevation ........................................................................................................................... 966
Instrument Overall Key Plan ............................................................................................................... 966
MHE_Member Details ......................................................................................................................... 966
Pipe Supports...................................................................................................................................... 967
Piping Elevation .................................................................................................................................. 967
Piping Fire Protection Plan ................................................................................................................. 967
Piping Isometric Detail ........................................................................................................................ 967
Piping Overall Key Plan ...................................................................................................................... 967
Piping Safety Shower Plan ................................................................................................................. 968
Piping Utility Station Plan .................................................................................................................... 968
SM_Electrical_Cable_Tray_Elevation ................................................................................................ 968
SM_Electrical_Cable_Tray_Plan ........................................................................................................ 968
SM_Equipment_Plan .......................................................................................................................... 969
SM_HVAC_Elevation .......................................................................................................................... 969
SM_HVAC_Plan.................................................................................................................................. 970
SM_Lighting_Plan ............................................................................................................................... 970
SM_Piping_Elevation .......................................................................................................................... 970
SM_Piping_Plan.................................................................................................................................. 971
Structural Framing Elevation ............................................................................................................... 971
Structural Framing Plan ...................................................................................................................... 971

Custom Graphic Modules ....................................................................................................................... 972


Create a View Style with Resymbolized Normal Pipes ...................................................................... 974
Create a View Style with Single Line Pipes ........................................................................................ 977
Actual 3D Geometry ............................................................................................................................ 982
Beam Part ........................................................................................................................................... 982
Bracket with Flange ............................................................................................................................ 982
Built-up Member To Parts ................................................................................................................... 984
Capped Normal Pipe ........................................................................................................................... 984
Clipped Geometry With Volume.......................................................................................................... 985
Default Graphics ................................................................................................................................. 985
Design Equipment Part Separator ...................................................................................................... 986
Drawable Default Graphics ................................................................................................................. 987
Elbow To Arc ....................................................................................................................................... 987
Elbow To Single Arc ............................................................................................................................ 988
Enumerate Equipment Graphic Children ............................................................................................ 988
Enumerate Hanger Graphic Children ................................................................................................. 990
Equipment Nozzle Separator .............................................................................................................. 992
Exclude ............................................................................................................................................... 993
Exclude with Not Drawn Rule ....................................................................................................... 994
Extended Structure Geometry ............................................................................................................ 996
Generic Line ........................................................................................................................................ 996
Generic Plate Anti-Molded Side .......................................................................................................... 997
Generic Plate Anti-Molded Side Without Features ............................................................................. 997
Generic Plate Both Sides Without Features ....................................................................................... 997
Generic Plate Molded Side ................................................................................................................. 997
Generic Plate Molded Side Without Features ..................................................................................... 998
Generic Stiffener Extended Geometry ................................................................................................ 998
Generic Stiffener Landing Curve ......................................................................................................... 998

Drawings and Reports Reference Data Guide 11


Contents

Generic Stiffener Web Left .................................................................................................................. 999


Generic Stiffener with Flange .............................................................................................................. 999
Grid Line ............................................................................................................................................ 1004
Grid Plane ......................................................................................................................................... 1004
Logical Connection to Intersection Seam ......................................................................................... 1004
Make Drawable ................................................................................................................................. 1004
Make Drawable Assembly ................................................................................................................ 1005
Make Drawable Simple ..................................................................................................................... 1006
Manufacturing Margin ....................................................................................................................... 1006
Manufacturing Shrinkage .................................................................................................................. 1006
Member Centerline ........................................................................................................................... 1007
Opening ............................................................................................................................................. 1007
Opening To X .................................................................................................................................... 1008
Pipe Turn Feature To Arc ................................................................................................................. 1010
Plane Geometry ................................................................................................................................ 1011
Plate Anti-Molded Side ..................................................................................................................... 1011
Plate Anti-Molded Side Without Features ......................................................................................... 1011
Plate Both Sides Without Features ................................................................................................... 1011
Plate Contour .................................................................................................................................... 1012
Plate Molded Side ............................................................................................................................. 1013
Plate Molded Side Without Features ................................................................................................ 1013
Plate Molded Surface ........................................................................................................................ 1013
Plate Outer Contour .......................................................................................................................... 1014
Plate Part .......................................................................................................................................... 1015
Plate System ..................................................................................................................................... 1016
Ports Separator ................................................................................................................................. 1017
Profile Cross Section ........................................................................................................................ 1018
Profile Knuckle As Curve .................................................................................................................. 1019
Profile Part ........................................................................................................................................ 1019
Profile System ................................................................................................................................... 1020
Profile System Cross Section ........................................................................................................... 1021
Range Center .................................................................................................................................... 1022
Replace Sloped Pipe On Hanger ...................................................................................................... 1022
Replace With Point ........................................................................................................................... 1024
Route Component Centerline ........................................................................................................... 1025
Rulers – Axis ..................................................................................................................................... 1026
Rulers – Reference Plane ................................................................................................................. 1026
Seam ................................................................................................................................................. 1026
Simple Volume To X ......................................................................................................................... 1027
Sloped Pipe With Arc Symbol ........................................................................................................... 1027
Std Member With Flange .................................................................................................................. 1028
Std Member With Web ...................................................................................................................... 1028
Stiffener With Flange ........................................................................................................................ 1029
Cross-Section Edge Names ....................................................................................................... 1034
Structural Transient Ports ................................................................................................................. 1040
Trench Parts Ports ............................................................................................................................ 1040
Trim Pipe Surface ............................................................................................................................. 1041
Volume Wire Frame .......................................................................................................................... 1041
Weld To Line ..................................................................................................................................... 1042

Drawings and Reports Reference Data Guide 12


Contents

Embedded Symbol Rules ..................................................................................................................... 1043


End Cut Embedded Symbols (Steel Order Rule Set) ....................................................................... 1045
End Cut Embedded Symbols (Generic Rule Set) ............................................................................. 1053
Slot Embedded Symbols ................................................................................................................... 1056
Marking Line Embedded Symbols .................................................................................................... 1061
Feature Embedded Symbols ............................................................................................................ 1064
Catalog Symbols ............................................................................................................................... 1065

Appendix: Annotation Rule Manager Customization ........................................................................ 1066


User Interface Schema Overview ..................................................................................................... 1066
Schema File Types ..................................................................................................................... 1067
Module-to-Module Compatibilities .............................................................................................. 1068
XML Structure of Compatible Modules ....................................................................................... 1069
XML Structure of Supported Properties ..................................................................................... 1072
XML Structure for Property and Property Group Definitions ...................................................... 1073
XML Structure of Module Definitions .......................................................................................... 1093
Reserved Tags ........................................................................................................................... 1094
Rule Manager and XML Template Difference ............................................................................ 1095
Customization Examples .................................................................................................................. 1096

Label Rule Manager............................................................................................................................... 1099


Launch Label Rule Manager (Orthographic Drawings) .................................................................... 1099
Launch Label Rule Manager (Drawings by Rule) ............................................................................. 1100
Add Template Dialog Box ................................................................................................................. 1100
Copy a Rule ...................................................................................................................................... 1101
Delete a Template ............................................................................................................................. 1102
Properties Tab................................................................................................................................... 1103
Content Module (Properties tab) ....................................................................................................... 1105
Annotation Control Generator Module (Properties tab) .................................................................... 1107
Leader Module (Properties tab) ........................................................................................................ 1107
Point Generator Module (Properties tab) .......................................................................................... 1108
Geometric Analyzer Module (Properties tab) .................................................................................... 1109
Positioning Module (Properties tab) .................................................................................................. 1110
Relationships Tab ............................................................................................................................. 1111
Comments Tab.................................................................................................................................. 1112

Overview of Label Properties ............................................................................................................... 1113


Absolute Along Linear Object (DwgLinearAbsPos) .......................................................................... 1113
Absolute Axis Position (SMDwgPositionAxis) ................................................................................... 1117
Absolute Grid Margin (DrawingGridLblMgnAbsPos) ........................................................................ 1118
Absolute Points (ISAbsolutePointLabelPG) ...................................................................................... 1120
Absolute Position by 2D Curve (ISDwgAbsolutePositionByCurve2D).............................................. 1120
Absolute Position by 2D Curve at Axis (SMDwgPositionByCurve2DAtAxis) ................................... 1124
Absolute Radial from View Center (DrawingVectorAbsolute) ........................................................... 1129
Absolute XY Offset (DrawingAbsolute) ............................................................................................. 1130
Add Point along Horizontal Girth Length .......................................................................................... 1134
Add Point along Vertical Girth Length ............................................................................................... 1134
Aligned Objects (DrawingGALabelInline) ......................................................................................... 1135

Drawings and Reports Reference Data Guide 13


Contents

Allow Acute Breakline Angle ............................................................................................................. 1142


Allow Labels Outside View ................................................................................................................ 1144
Allow Non-Orthogonal Directions ...................................................................................................... 1145
Allow Short Leaders .......................................................................................................................... 1147
Anchor ............................................................................................................................................... 1148
Angle ................................................................................................................................................. 1149
Axis Angle ......................................................................................................................................... 1152
Axis Connect Point ............................................................................................................................ 1152
Axis Definition ................................................................................................................................... 1153
Axis X Offset, Axis Y Offset .............................................................................................................. 1154
Bidirectional Symbol ......................................................................................................................... 1155
Breakline Length ............................................................................................................................... 1155
Cardinal Point.................................................................................................................................... 1156
Choice ............................................................................................................................................... 1157
Clearance .......................................................................................................................................... 1158
Clear Space Along Linear Object (DwgLinearPositioning) ............................................................... 1159
Clear Space Center Then Above (DrawingCenterThenAbove) ........................................................ 1159
Clear Space Center Then Above Centerline (DrawingCenterThenAboveCL) .................................. 1162
Clear Space Center Then Rotate (DrawingCenterThenRotate) ....................................................... 1164
Clear Space Clipped (DwgClippedPositioning) ................................................................................ 1166
Clear Space Coordinate (DrawingCoordLblPosMod) ....................................................................... 1167
Clear Space End of Linear Object (DwgLblEndOfSegmentPos) ...................................................... 1172
Clear Space Grid Horizontal (DrawingGridLblHoriz) ........................................................................ 1175
Clear Space Grid Margin (DrawingGridLblMarginOnly).................................................................... 1180
Clear Space Grid Vertical (DrawingGridLblVert) .............................................................................. 1184
Clear Space Margin (DrawingMarginOnly) ....................................................................................... 1189
Clear Space Margin with Dimensions (DwgMatchlineWithDim) ....................................................... 1191
Clear Space Position by 2D Curve (ISDwgPositionByCurve2D) ...................................................... 1203
Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin) ....................... 1211
Clear Space Position Marine Grid Label at Margin
(SMDwgPositionGridLblMarginOnly) ................................................................................................ 1219
Clear Space Quadrant 1 (DrawingQuadOne) ................................................................................... 1224
Clear Space Quadrant 2 (DrawingQuadTwo) ................................................................................... 1229
Clear Space Quadrant 3 (DrawingQuadThree) ................................................................................ 1234
Clear Space Quadrant 4 (DrawingQuadFour) .................................................................................. 1240
Clear Space Radial (DrawingRadial) ................................................................................................ 1246
Clear Space Radial from Object Center with Clustering (DrawingCentroid) .................................... 1247
Clear Space Tiling (CAD Details) (DrawingTileInView) .................................................................... 1255
Connect Point.................................................................................................................................... 1257
Control Point Label Type .................................................................................................................. 1259
Control Point Only (DrawingPGCPThenNone) ................................................................................. 1260
Control Point then Local CS Origin then Center (DrawingPGControlPoint) ..................................... 1261
Coordinate (DrawingCoordLeaderControl) ....................................................................................... 1262
Default (DefaultLabelControlGenerator) ........................................................................................... 1265
Default (DrawingLabelHelper) ........................................................................................................... 1268
Default (DwgLeaderControl) ............................................................................................................. 1271
Default Marine Label (ISRulesetLabelContent) ................................................................................ 1275
Default Marine Label Text (ISRulesetLabelAnalyzer) ....................................................................... 1276
Default Marine Point (ISRulesetPointGenerator) .............................................................................. 1276
Dimension Perimeter Offset .............................................................................................................. 1277
Dimension Style ................................................................................................................................ 1278

Drawings and Reports Reference Data Guide 14


Contents

Dimension Text Rotate Clearance .................................................................................................... 1280


Display Breakline .............................................................................................................................. 1281
Display Dimension ............................................................................................................................ 1283
Display Empty/Error Labels .............................................................................................................. 1284
Dummy (DummyGeomAnalyzer) ...................................................................................................... 1285
Eliminate Labels with Missing Parents (SMDGAEliminateLabelsWithMissingParents) ................... 1286
Eliminate Most Common Labels (ISGAEliminateMostCommonLabels) ........................................... 1287
Eliminate Overlapping Labels (ISGAEliminateOverlappingLabels) .................................................. 1289
Embedded Label ............................................................................................................................... 1290
End Curve Ratio ................................................................................................................................ 1292
End of Segment (DrawingGAEndOfSegment).................................................................................. 1292
Equivalence Label ............................................................................................................................. 1295
Equivalence Label ............................................................................................................................. 1295
Equivalence Property Interface Name .............................................................................................. 1296
Equivalence Property Value .............................................................................................................. 1296
Feature Type ..................................................................................................................................... 1297
Flow Direction (DrawingFlowDirectionContent) ................................................................................ 1298
From Matchline ................................................................................................................................. 1301
Generic Interoperability (GenericGeometricAnalyzerInterop) ........................................................... 1303
Generic Interoperability (SMDGenericContentInterOp) .................................................................... 1304
Granularity......................................................................................................................................... 1305
Group Bubble Label .......................................................................................................................... 1307
Group by Axis (SMDwgGroupByAxisGA) ......................................................................................... 1307
Group Clipped Points ........................................................................................................................ 1308
Group Label Clearance ..................................................................................................................... 1309
Hanger Key Plan Control Point then Support Location
(DrawingPGKeyPlanControlPoint) .................................................................................................... 1310
Honor Maximum Offset for Grouping ................................................................................................ 1311
Honor View Direction ........................................................................................................................ 1312
Horizontal Offset, Vertical Offset....................................................................................................... 1313
Horizontal Ruler Axis Offset .............................................................................................................. 1315
Horizontal Ruler Axis Position........................................................................................................... 1315
Horizontal Ruler Axis Style ............................................................................................................... 1317
Horizontal Ruler Axis Tick Mark Length Away from View ................................................................. 1318
Horizontal Ruler Axis Tick Mark Length toward View ....................................................................... 1319
Horizontal Ruler Axis Tick Mark Style ............................................................................................... 1320
ID ....................................................................................................................................................... 1320
Inside or Along 2D Curve (InsideOrAlongCurve2D) ......................................................................... 1321
Invert Elevation Location ................................................................................................................... 1324
Jog Segment Offset .......................................................................................................................... 1325
Jog Segment Offset 1 ....................................................................................................................... 1327
Jog Segment Offset 2 ....................................................................................................................... 1328
Justification ....................................................................................................................................... 1330
Keep Duplicate Labels ...................................................................................................................... 1332
Keep Label by Location .................................................................................................................... 1333
Keep Left or Right Duplicate ............................................................................................................. 1334
Keep Top or Bottom Duplicate .......................................................................................................... 1335
Key Point (DefaultLabelPointGenerator) .......................................................................................... 1338
Knuckle Angle Symbol (ISKnuckleAngleSymbolContent) ................................................................ 1338
Label Layer (labelLayer) ................................................................................................................... 1339
Label Offset ....................................................................................................................................... 1340

Drawings and Reports Reference Data Guide 15


Contents

Label Offset from Member or Widget ................................................................................................ 1341


Label Orientation ............................................................................................................................... 1342
Label Symbol File.............................................................................................................................. 1344
Label Type ........................................................................................................................................ 1345
Leader Length ................................................................................................................................... 1346
Leader Offset .................................................................................................................................... 1348
Leaders as Clear Space ................................................................................................................... 1350
Linear (DrawingLinearLeader) .......................................................................................................... 1352
Linear Endpoints (DrawingGAByOppositePoints) ............................................................................ 1356
Linear Object Endpoints (DrawingPGLinear) .................................................................................... 1357
Linear Pipe Endpoints (DrawingPGPipeSegments) ......................................................................... 1357
Line Style .......................................................................................................................................... 1358
Local Coordinate System Origin (DrawingPGLocalCS).................................................................... 1359
Local CS Origin with Object Axis (DrawingPGEquipmentStyle2) ..................................................... 1360
Location Curve Ratio ........................................................................................................................ 1362
Location ID ........................................................................................................................................ 1362
Location Target ................................................................................................................................. 1364
Location Target Name ...................................................................................................................... 1365
Longest Segment (DrawingGALongestSegment) ............................................................................. 1366
Manufacturing Margin Symbol (ISMfgMarginSymbolContent) ......................................................... 1369
Manufacturing Pin Height Label (SMDwgMfgPinHeightLabelContent) ............................................ 1369
Manufacturing Profile Margin Symbol (SMDwgMfgProfileMarginSymContent) ............................... 1370
Manufacturing Sketch (MfgSketchContent) ...................................................................................... 1371
Margin (DwgMarginLeaderControl)................................................................................................... 1372
Margin Definition ............................................................................................................................... 1380
Materials Handling Absolute (MHDrawingAbsoluteLeader) ............................................................. 1381
Maximum Offset ................................................................................................................................ 1384
Maximum Offset for Grouping ........................................................................................................... 1388
Maximum Pin Height for Deletion ..................................................................................................... 1388
MfgSketchNameFeaturesGA ............................................................................................................ 1389
MidPoint (ISMidPointLabelPG) ......................................................................................................... 1389
Minimum Diameter ............................................................................................................................ 1390
Minimum Offset ................................................................................................................................. 1393
Move Dimension Text to Outside ...................................................................................................... 1397
No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) .............................................. 1398
NoFlow Symbol ................................................................................................................................. 1398
No Label Content (DrawingNoContent) ............................................................................................ 1399
North Arrow (DrawingNArrowContent) ............................................................................................. 1400
Nozzle (DrawingPGNozzleandBrace) ............................................................................................... 1401
Object Axis (DrawingGAEquipmentStyle2) ....................................................................................... 1401
Object Type ....................................................................................................................................... 1405
Offset Label from Widget .................................................................................................................. 1406
Only Outside of Object (DwgLeaderInOutsideControl) ..................................................................... 1407
Opening Objects (DrawingPGOpeningObjects) ............................................................................... 1410
Orientation......................................................................................................................................... 1412
Percentage Offset ............................................................................................................................. 1422
Perimeter Offset (perimeterOffset).................................................................................................... 1423
Pin Jig Seam Offset Label (SMDPinJigSeamOffsetCM) .................................................................. 1424
Piping Elevation (DrawingBOLabelContent) ..................................................................................... 1425
Place Lines (placeLines) ................................................................................................................... 1426
Place Lines on Sheet ........................................................................................................................ 1427

Drawings and Reports Reference Data Guide 16


Contents

Plate Angle Symbol (ISPlateAngleSymbolContent).......................................................................... 1427


Plate Grid Name Label (SMDwgPlateGridNameLabelContent) ....................................................... 1428
Point at Corner Cut (MHDrawingPGCornerCut) ............................................................................... 1428
Point for Profile Sketch Bevel Shape (SMProfileSketchBevelShapeLabelsPG) .............................. 1431
Point on Remarking Curve along Girth (SM3DDwgRemarkingGirthLengthPG) ............................... 1432
Points Along 2D Curve (ISDwgPointsAlongCurve2D) ...................................................................... 1433
Points Along 2D Range (ISDwgPointsAlongRange2D) .................................................................... 1436
Points at Manufacturing Sketch Coordinates (MfgSketchPG) .......................................................... 1437
Points by 2D Shape Type (SMDwgPointsByType) ........................................................................... 1438
Points by Associated Object ID (SMPointsByAssociateObjectID) .................................................... 1439
Points for View (ISDwgPointsForView) ............................................................................................. 1440
Positioning Point ............................................................................................................................... 1440
Priority (priority) ................................................................................................................................. 1442
Profile Angle Symbol (ISProfileAngleSymbolContent) ..................................................................... 1444
ISProfilePartThicknessSymContent .................................................................................................. 1444
Profile Sketch Bevel Shape Label (SMProfileSketchBevelShapeLabelsCM) .................................. 1445
Profile Sketch Bevel Symbol (SMProfileSketchBevelSymbolCM) .................................................... 1446
Profile Sketch Detail Name Label (SMDwgProfileSketchDetailNameLabelContent) ....................... 1446
Profile Sketch Knuckle Label (SMDwgProfileSketchKnuckleLabelContent) .................................... 1447
Profile Sketch Label (SMDwgProfileSketchLabelsContent) ............................................................. 1447
Profile Weld Points (SMDwgProfileWeldsPG) .................................................................................. 1448
Radius Offset .................................................................................................................................... 1449
Range Point ...................................................................................................................................... 1450
Reference (DrawingReferenceLabelContent) ................................................................................... 1451
Remarking Girth Length Label (SM3DDwgRemarkingGirthLengthCM) ........................................... 1452
Report Template ............................................................................................................................... 1452
Rotation ............................................................................................................................................. 1453
Ruler Axis (SMRulerAxisSymbolContent) ......................................................................................... 1455
Scale Factor Percentage (scaleFactor) ............................................................................................ 1460
Scantling Near Side or Far Side Direction Symbol
(SMDwgScantlingNSorFSDirectionContent) .................................................................................... 1461
Search Mode ..................................................................................................................................... 1462
Ship Direction Symbol (ISShipDirectionSymbolContent) ................................................................. 1463
Sheet Direction.................................................................................................................................. 1465
Spacing ............................................................................................................................................. 1465
Stacked Labels (DwgStackLabelLeader) .......................................................................................... 1466
Start Curve Ratio............................................................................................................................... 1469
Structural Widget (StructuralWidgetLabelContent) ........................................................................... 1470
Style .................................................................................................................................................. 1471
Style .................................................................................................................................................. 1471
Subpriority ......................................................................................................................................... 1474
Symbol Attribute Name ..................................................................................................................... 1474
Symbol Path Label ............................................................................................................................ 1474
Template Set Full Scale Direction Symbol
(SMTemplatesetFullScaleDirSymbolContent) .................................................................................. 1475
Tolerance Angle ................................................................................................................................ 1476
Tolerance Angle for Single Bevel J Weld ......................................................................................... 1476
Tolerance Zone ................................................................................................................................. 1477
Top, Bottom, Left, Right .................................................................................................................... 1477
Top, Bottom, Left, Right Margin Labels ............................................................................................ 1478
Trench (DrawingCivilLabelContent) .................................................................................................. 1479

Drawings and Reports Reference Data Guide 17


Contents

Trench (CivilElevationPointGenerator) ............................................................................................. 1481


Unidirectional Symbol ....................................................................................................................... 1483
Use Clear Space ............................................................................................................................... 1483
Vertical Offset.................................................................................................................................... 1484
Vertical Ruler Axis Offset .................................................................................................................. 1484
Vertical Ruler Axis Position ............................................................................................................... 1485
Vertical Ruler Axis Style .................................................................................................................... 1486
Vertical Ruler Axis Tick Mark Length Away from View ..................................................................... 1487
Vertical Ruler Axis Tick Mark Length toward View ........................................................................... 1488
Vertical Ruler Axis Tick Mark Style ................................................................................................... 1489
Weld (DrawingWeldLeader) .............................................................................................................. 1490
Weld (DrawingWeldSymbols) ........................................................................................................... 1492
Weld Label Text (DrawingGAWelds) ................................................................................................ 1493
Weld Point (DrawingPGWelds) ......................................................................................................... 1494
Weld Type ......................................................................................................................................... 1497

Dimension Rule Manager...................................................................................................................... 1503


Launch Dimension Rule Manager (Orthographic Drawings) ............................................................ 1504
Launch Dimension Rule Manager (Drawings by Rule) ..................................................................... 1504
Copy a Rule ...................................................................................................................................... 1505
Properties Tab (Dimension Rule Manager) ...................................................................................... 1506
Content Module (Properties tab) ....................................................................................................... 1508
Annotation Control Generator Module (Properties tab) .................................................................... 1508
Point Generator Module (Properties tab) .......................................................................................... 1509
Geometric Analyzer Module (Properties tab) .................................................................................... 1510
Positioning Module (Properties tab) .................................................................................................. 1510
Relationships Tab (Dimension Rule Manager) ................................................................................. 1511
Comments Tab (Dimension Rule Manager) ..................................................................................... 1512

Overview of Dimension Properties ...................................................................................................... 1513


2D Object Center (ISStruct2DRangePG) ......................................................................................... 1513
3D Object Center (DrawingPointGenerator) ..................................................................................... 1514
Absolute Dimension Offset (DrawingDimAbsolutePos) .................................................................... 1514
Absolute Margin (DrawingDimMarginPos) ........................................................................................ 1516
Align (align) ....................................................................................................................................... 1517
Anchor (dimensionAnchor value) ...................................................................................................... 1518
Anchor to Nearest Object (DrawingSepDimGenerator) .................................................................... 1520
Between Points (ISDimensionBetweenPointsGA) ............................................................................ 1522
Between Points (ISDimensionBtwPointsPG) .................................................................................... 1522
Clear Space Horizontal Bottom (DrawingDimHorizBottomCS) ........................................................ 1523
Clear Space Horizontal Top (DrawingDimHorizTopCS) ................................................................... 1525
Clear Space Pipe Segments (DrawingDimPipeSegPos) .................................................................. 1526
Clear Space Vertical Left (DrawingDimVertLeftCS) ......................................................................... 1527
Clear Space Vertical Right (DrawingDimVertRightCS)..................................................................... 1528
Control Point Only (DrawingPGCPThenNone) ................................................................................. 1529
Control Point then Local CS Origin then Center (DrawingPGControlPoint) ..................................... 1530
Convert to Coordinate Dimension (SMDwgConvertToCoordDimGA) .............................................. 1531
Coordinate (DrawingCoordDimGenerator) ....................................................................................... 1532
Default (DrawingDimGenerator) ....................................................................................................... 1533

Drawings and Reports Reference Data Guide 18


Contents

Default (DrawingGeometricAnalyzer) ............................................................................................... 1534


Default Marine Point (ISRulesetPointGenerator) .............................................................................. 1536
Dimension Layer (dimLayer) ............................................................................................................. 1536
Display Angular (angular) ................................................................................................................. 1537
Display Horizontal (horiz) .................................................................................................................. 1537
Display Overall Dimensions (overall) ................................................................................................ 1538
Display Vertical (vert) ........................................................................................................................ 1539
Dummy (DummyGeomAnalyzer) ...................................................................................................... 1540
Edge to Edge (MHEdgeToEdgePG) ................................................................................................. 1540
External Dimension (externalDimension) ......................................................................................... 1541
Granularity (granularity) .................................................................................................................... 1543
Hanger Key Plan Control Point then Support Location
(DrawingPGKeyPlanControlPoint) .................................................................................................... 1544
Holes (MHPGForHoles) .................................................................................................................... 1545
Horizontal Coordinate Dimensions (DrawingCoordDimContLinHNoReplace) ................................. 1545
Horizontal Linear Dimensions (DrawingDimContLinHNoReplace) ................................................... 1546
Horizontal Linear Dimensions with Value Replacement (DrawingDimContentLinearH) .................. 1547
Horizontal Linear Object Endpoints (DrawingPGStructHoriz) .......................................................... 1547
Horizontal Offset (hOffset) ................................................................................................................ 1548
Horizontal Object Anchor (DrawingPGAnchorHoriz) ........................................................................ 1549
Horizontal Routable Object (DrawingPGRoutableObjHoriz) ............................................................ 1549
Incremental (MHIncDimPos) ............................................................................................................. 1550
Incremental (MHIncrementalDimGenerator) ..................................................................................... 1551
Internal Dimension (internalDimension) ............................................................................................ 1552
Interval (interval) ............................................................................................................................... 1554
Keep Equal Distance Duplicates (keepEqualDistanceDup) ............................................................. 1554
Keep Left or Right Duplicate (keepLeftOrRightDup)......................................................................... 1556
Keep Top or Bottom Duplicate (keepTopOrBottomDup) .................................................................. 1557
Linear Object Endpoints (DrawingPGLinear) .................................................................................... 1558
Local Coordinate System Origin (DrawingPGLocalCS).................................................................... 1558
Location Target Name (targetName) ................................................................................................ 1559
Margin (DrawingGAMarginOnly) ....................................................................................................... 1559
Margin with Occluded Graphics (DrawingGAMarginOnlyWithOccludedGraphics) .......................... 1561
Marine Linear (SMDrawingDimContentLinear) ................................................................................. 1562
Maximum Dimension Offset (maxDimOffset) ................................................................................... 1563
Maximum Offset (maxOffset) ............................................................................................................ 1564
Maximum Witness Length (maxWitnessLength) .............................................................................. 1566
MidPoint (ISMidPointLabelPG) ......................................................................................................... 1567
Minimum Dimension Distance (minimumDimension) ....................................................................... 1568
Minimum Offset (minOffset) .............................................................................................................. 1569
Nearest Pin (ISPinJigPointsOnNearestPin) ...................................................................................... 1571
Note (DrawingPGByNote) ................................................................................................................. 1572
Object Corners (DrawingPGObjectCorners) ..................................................................................... 1573
Offset from Range (overall) ............................................................................................................... 1574
Opening Objects (DrawingPGOpeningObjects) ............................................................................... 1575
Orientation (orientation) .................................................................................................................... 1576
Overall Dimension (overallDimension value) .................................................................................... 1578
Overall Offset (overallOffset) ............................................................................................................ 1578
Override (ISDimensionContentOverride) .......................................................................................... 1579
Parse Graphics (parseGraphics) ...................................................................................................... 1579
Penetration Plate (PenPlatePointGenerator) .................................................................................... 1580

Drawings and Reports Reference Data Guide 19


Contents

Perimeter Offset (perimeterOffset).................................................................................................... 1580


Pin Jig Corners (SMDwgPinJigCornersDistancePG) ....................................................................... 1581
Pipe Segments (DrawingGAPipeSegments) .................................................................................... 1582
Pipe Segments (DrawingPipeSegmentsCG) .................................................................................... 1583
Place Lines (placeLines) ................................................................................................................... 1584
Point Location (pointLocation) .......................................................................................................... 1585
Point Name (filterCriteriaPointName)................................................................................................ 1586
Points at Manufacturing Sketch Coordinates (MfgSketchPG) .......................................................... 1586
Preserve Text Orientation (preserveTextOrientation) ....................................................................... 1587
Priority (priority) ................................................................................................................................. 1589
Profile Sketch Linear Feature (ISProfileSketchFeatureLinearDimCM) ............................................. 1590
Profile Sketch Linear Feature (ISProfileSketchFeatureLinearDimPG) ............................................. 1590
Profile Sketch Radial Feature (ISProfileSketchFeatureRadialDimCM) ............................................ 1591
Profile Sketch Radial Feature (ISProfileSketchFeatureRadialDimPG)............................................. 1591
Radial Dimensions with Value Replacement (DrawingDimContentRadial) ...................................... 1592
Range (range) ................................................................................................................................... 1593
Range Offset (rangeOffset)............................................................................................................... 1594
Style (dimStyle) ................................................................................................................................. 1595
Template Offset (StrMfgTemplateOffsetPG) .................................................................................... 1597
Template Set Offset (StrMfgTemplateSetOffsetPG)......................................................................... 1598
Trim Witness (trimWitness) ............................................................................................................... 1599
Vertical Coordinate Dimensions (DrawingCoordDimContLinVNoReplace) ...................................... 1600
Vertical Linear Dimensions (DrawingDimContLinVNoReplace) ....................................................... 1601
Vertical Linear Dimensions with Value Replacement (DrawingDimContentLinearV) ....................... 1602
Vertical Linear Object Endpoints (DrawingPGStructVert) ................................................................ 1603
Vertical Object Anchor (DrawingPGAnchorVert) .............................................................................. 1604
Vertical Offset (vOffset) ..................................................................................................................... 1605

Matchline Rule Manager ....................................................................................................................... 1606


Launch Matchline Rule Manager ...................................................................................................... 1606
Add Template Dialog Box ................................................................................................................. 1607
Copy a Compound Matchline Rule ................................................................................................... 1607
Properties Tab................................................................................................................................... 1608
Content Module (Properties tab) ....................................................................................................... 1609
Annotation Control Generator Module (Properties tab) .................................................................... 1610
Leader Module (Properties tab) ........................................................................................................ 1610
Point Generator Module (Properties tab) .......................................................................................... 1610
Geometric Analyzer Module (Properties tab) .................................................................................... 1611
Positioning Module (Properties tab) .................................................................................................. 1611
Relationships Tab ............................................................................................................................. 1611
Comments Tab.................................................................................................................................. 1612

Overview of Matchline Properties ........................................................................................................ 1613


Absolute Matchline (DrawingMatchlinePositioning) .......................................................................... 1613
Adjacent Edge Overlap Percentage (adjacentOverlap) .................................................................... 1613
Default (DefaultLabelControlGenerator) ........................................................................................... 1615
Display Empty/Error Labels .............................................................................................................. 1617
East Report Template ....................................................................................................................... 1618
East Symbol Attribute Name ............................................................................................................. 1618

Drawings and Reports Reference Data Guide 20


Contents

Gap Tolerance (gapTolerance) ......................................................................................................... 1618


Label Layer (labelLayer) ................................................................................................................... 1620
Label Symbol File.............................................................................................................................. 1621
Matchline (DrawingMatchlineContent) .............................................................................................. 1621
Matchline (DrawingMatchlinePG) ..................................................................................................... 1623
Matchline Layer (matchlineLayer) ..................................................................................................... 1626
No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) .............................................. 1626
North Report Template ..................................................................................................................... 1627
North Symbol Attribute Name ........................................................................................................... 1627
Occluded Matchline Style (occludedMatchlineStyle) ........................................................................ 1627
Priority (priority) ................................................................................................................................. 1628
Side (side) ......................................................................................................................................... 1629
South Report Template ..................................................................................................................... 1630
South Symbol Attribute Name........................................................................................................... 1630
West Report Template ...................................................................................................................... 1630
West Symbol Attribute Name ............................................................................................................ 1630
White Object Layer (whiteObj) .......................................................................................................... 1631
Visible Matchline Style (visibleMatchlineStyle) ................................................................................. 1632

North Arrow Rule Manager ................................................................................................................... 1633


Launch North Arrow Rule Manager .................................................................................................. 1633
Add Template Dialog Box ................................................................................................................. 1634
Copy a Rule ...................................................................................................................................... 1634
Properties Tab................................................................................................................................... 1636
Content Module (Properties tab) ....................................................................................................... 1637
Annotation Control Generator Module (Properties tab) .................................................................... 1638
Leader Module (Properties tab) ........................................................................................................ 1639
Point Generator Module (Properties tab) .......................................................................................... 1639
Geometric Analyzer Module (Properties tab) .................................................................................... 1640
Positioning Module (Properties tab) .................................................................................................. 1640
Relationships Tab ............................................................................................................................. 1641
Comments Tab.................................................................................................................................. 1641

Overview of North Arrow Rule Properties .......................................................................................... 1642


Absolute Points (ISAbsolutePointLabelPG) ...................................................................................... 1642
Absolute XY Offset (DrawingAbsolute) ............................................................................................. 1643
Clear Space Quadrant 1 (DrawingQuadOne) ................................................................................... 1648
Clear Space Quadrant 2 (DrawingQuadTwo) ................................................................................... 1654
Clear Space Quadrant 3 (DrawingQuadThree) ................................................................................ 1659
Clear Space Quadrant 4 (DrawingQuadFour) .................................................................................. 1665
Control Point Only (DrawingPGCPThenNone) ................................................................................. 1671
Control Point then Local CS Origin then Center (DrawingPGControlPoint) ..................................... 1672
Default (DefaultLabelControlGenerator) ........................................................................................... 1673
Default (DrawingLabelHelper) ........................................................................................................... 1675
Default Marine Point (ISRulesetPointGenerator) .............................................................................. 1678
Display Empty/Error Labels .............................................................................................................. 1678
Hanger Key Plan Control Point then Support Location
(DrawingPGKeyPlanControlPoint) .................................................................................................... 1680
Inside or Along 2D Curve (InsideOrAlongCurve2D) ......................................................................... 1681

Drawings and Reports Reference Data Guide 21


Contents

Key Point (DefaultLabelPointGenerator) .......................................................................................... 1684


Knuckle Angle Symbol (ISKnuckleAngleSymbolContent) ................................................................ 1684
Label Symbol File.............................................................................................................................. 1685
Linear Object Endpoints (DrawingPGLinear) .................................................................................... 1685
Linear Pipe Endpoints (DrawingPGPipeSegments) ......................................................................... 1686
Local Coordinate System Origin (DrawingPGLocalCS).................................................................... 1686
Local CS Origin with Object Axis (DrawingPGEquipmentStyle2) ..................................................... 1687
Manufacturing Margin Symbol (ISMfgMarginSymbolContent) ......................................................... 1689
Manufacturing Pin Height Label (SMDwgMfgPinHeightLabelContent) ............................................ 1689
Manufacturing Profile Margin Symbol (SMDwgMfgProfileMarginSymContent) ............................... 1690
MidPoint (ISMidPointLabelPG) ......................................................................................................... 1690
No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) .............................................. 1691
No Label Content (DrawingNoContent) ............................................................................................ 1691
North Arrow (DrawingNArrowContent) ............................................................................................. 1693
Nozzle (DrawingPGNozzleandBrace) ............................................................................................... 1694
Pin Jig Seam Offset Label (SMDPinJigSeamOffsetCM) .................................................................. 1694
Piping Elevation (DrawingBOLabelContent) ..................................................................................... 1695
Plate Angle Symbol (ISPlateAngleSymbolContent).......................................................................... 1696
Plate Grid Name Label (SMDwgPlateGridNameLabelContent) ....................................................... 1697
Point at Corner Cut (MHDrawingPGCornerCut) ............................................................................... 1697
Point for Profile Sketch Bevel Shape (SMProfileSketchBevelShapeLabelsPG) .............................. 1700
Point on Remarking Curve along Girth (SM3DDwgRemarkingGirthLengthPG) ............................... 1701
Points Along 2D Curve (ISDwgPointsAlongCurve2D) ...................................................................... 1702
Points Along 2D Range (ISDwgPointsAlongRange2D) .................................................................... 1705
Points at Manufacturing Sketch Coordinates (MfgSketchPG) .......................................................... 1706
Points by 2D Shape Type (SMDwgPointsByType) ........................................................................... 1707
Points by Associated Object ID (SMPointsByAssociateObjectID) .................................................... 1708
Points for View (ISDwgPointsForView) ............................................................................................. 1709
Profile Angle Symbol (ISProfileAngleSymbolContent) ..................................................................... 1709
Profile Sketch Bevel Symbol (SMProfileSketchBevelSymbolCM) .................................................... 1710
Profile Sketch Label (SMDwgProfileSketchLabelsContent) ............................................................. 1710
Profile Weld Points (SMDwgProfileWeldsPG) .................................................................................. 1711
Reference (DrawingReferenceLabelContent) ................................................................................... 1712
Scantling Near Side or Far Side Direction Symbol
(SMDwgScantlingNSorFSDirectionContent) .................................................................................... 1713
Sheet Direction.................................................................................................................................. 1714
Ship Direction Symbol (ISShipDirectionSymbolContent) ................................................................. 1714
Template Set Full Scale Direction Symbol
(SMTemplatesetFullScaleDirSymbolContent) .................................................................................. 1716
Trench (CivilElevationPointGenerator) ............................................................................................. 1717
Weld Point (DrawingPGWelds) ......................................................................................................... 1719

Appendix: Migrating Dimension Rules ............................................................................................... 1722


Dimension Anchoring Overview ........................................................................................................ 1722
Migrate Dimension Rules Command Overview ......................................................................... 1723
Migrate Dimension Rules Command.......................................................................................... 1723
Migrate Dimension Rules Dialog Box ......................................................................................... 1724
Command Line Interface ............................................................................................................ 1725
Migration Activities ............................................................................................................................ 1725
On-the-Fly Migration (Dimension Rule Manager) ............................................................................. 1727

Drawings and Reports Reference Data Guide 22


Contents

Drawing/View Update Checker ......................................................................................................... 1727

Annotation Modules .............................................................................................................................. 1728


Point Generators ............................................................................................................................... 1730
3D Object Center (DrawingPointGenerator)............................................................................... 1732
Control Point Only (DrawingPGCPThenNone) .......................................................................... 1732
Control Point then Local CS Origin then Center (DrawingPGControlPoint) ............................... 1733
Local CS Origin with Object Axis (DrawingPGEquipmentStyle2) .............................................. 1734
Hanger Key Plan Control Point then Support Location
(DrawingPGKeyPlanControlPoint) ............................................................................................. 1736
Points Along 2D Range (ISDwgPointsAlongRange2D) ............................................................. 1736
Local Coordinate System Origin (DrawingPGLocalCS) ............................................................. 1738
Point at Corner Cut (MHDrawingPGCornerCut) ........................................................................ 1738
Note (DrawingPGByNote) .......................................................................................................... 1741
Object Corners (DrawingPGObjectCorners) .............................................................................. 1742
Opening Objects (DrawingPGOpeningObjects) ......................................................................... 1743
Points at Manufacturing Sketch Coordinates (MfgSketchPG) ................................................... 1744
Trench (CivilElevationPointGenerator) ....................................................................................... 1745
Weld Point (DrawingPGWelds) .................................................................................................. 1747
Inside or Along 2D Curve (InsideOrAlongCurve2D) ................................................................... 1750
Absolute Points (ISAbsolutePointLabelPG) ............................................................................... 1753
Between Points (ISDimensionBtwPointsPG) ............................................................................. 1753
Points Along 2D Curve (ISDwgPointsAlongCurve2D) ............................................................... 1756
Points for View (ISDwgPointsForView) ...................................................................................... 1759
MidPoint (ISMidPointLabelPG) ................................................................................................... 1759
Nearest Pin (ISPinJigPointsOnNearestPin) ............................................................................... 1760
Profile Sketch Linear Feature (ISProfileSketchFeatureLinearDimPG) ...................................... 1760
Profile Sketch Radial Feature (ISProfileSketchFeatureRadialDimPG) ...................................... 1761
Default Marine Point (ISRulesetPointGenerator) ....................................................................... 1764
Pinjig Corners (SMDwgPinjigCornersDistancePG) .................................................................... 1764
Points by 2D Shape Type (SMDwgPointsByType) .................................................................... 1765
Profile Weld Points (SMDwgProfileWeldsPG)............................................................................ 1766
Points by Associated Object ID (SMPointsByAssociateObjectID) ............................................. 1767
Point for Profile Sketch Bevel Shape (SMProfileSketchBevelShapeLabelsPG) ........................ 1768
Point on Remarking Curve along Girth (SM3DDwgRemarkingGirthLengthPG) ........................ 1768
Key Point (DefaultLabelPointGenerator) .................................................................................... 1769
Matchline (DrawingMatchlinePG) ............................................................................................... 1770
DrawingPGCuttingPlane............................................................................................................. 1773
Linear Object Endpoints (DrawingPGLinear) ............................................................................. 1773
Nozzle (DrawingPGNozzleandBrace) ........................................................................................ 1774
Linear Pipe Endpoints (DrawingPGPipeSegments) ................................................................... 1774
Horizontal Linear Object Endpoints (DrawingPGStructHoriz) .................................................... 1775
Vertical Linear Object Endpoints (DrawingPGStructVert) .......................................................... 1776
Penetration Plate (PenPlatePointGenerator) ............................................................................. 1777
Template Offset (StrMfgTemplateOffsetPG) .............................................................................. 1778
Template Set Offset (StrMfgTemplateSetOffsetPG) .................................................................. 1779
Geometric Analyzers ......................................................................................................................... 1781
Object Axis (DrawingGAEquipmentStyle2) ................................................................................ 1781
Margin with Occluded Graphics (DrawingGAMarginOnlyWithOccludedGraphics) .................... 1786
Generic Interoperability (GenericGeometricAnalyzerInterop) .................................................... 1787

Drawings and Reports Reference Data Guide 23


Contents

MfgSketchNameFeaturesGA ..................................................................................................... 1787


Weld Label Text (DrawingGAWelds) .......................................................................................... 1788
Between Points (ISDimensionBetweenPointsGA) ..................................................................... 1788
Eliminate Most Common Labels (ISGAEliminateMostCommonLabels) .................................... 1789
Eliminate Overlapping Labels (ISGAEliminateOverlappingLabels) ........................................... 1791
Default Marine Label Text (ISRulesetLabelAnalyzer) ................................................................ 1792
Eliminate Labels with Missing Parents
(SMDGAEliminateLabelsWithMissingParents) .......................................................................... 1793
Convert to Coordinate Dimension (SMDwgConvertToCoordDimGA) ........................................ 1794
Group by Axis (SMDwgGroupByAxisGA)................................................................................... 1794
No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) ........................................ 1795
Linear Endpoints (DrawingGAByOppositePoints) ...................................................................... 1796
End of Segment (DrawingGAEndOfSegment) ........................................................................... 1796
Aligned Objects (DrawingGALabelInline) ................................................................................... 1800
Longest Segment (DrawingGALongestSegment) ...................................................................... 1807
Pipe Segments (DrawingGAPipeSegments) .............................................................................. 1812
Margin (DrawingGAMarginOnly) ................................................................................................ 1814
Dummy (DummyGeomAnalyzer) ............................................................................................... 1815
Default (DrawingGeometricAnalyzer) ......................................................................................... 1816
Content Modules ............................................................................................................................... 1818
Piping Elevation (DrawingBOLabelContent) .............................................................................. 1819
Trench (DrawingCivilLabelContent) ........................................................................................... 1821
Horizontal Coordinate Dimensions (DrawingCoordDimContLinHNoReplace) ........................... 1823
Vertical Coordinate Dimensions (DrawingCoordDimContLinVNoReplace) ............................... 1823
DrawingCuttingPlanesContent ................................................................................................... 1824
Object Coordinates (DrawingEquipmentStyle2Content) ............................................................ 1825
Flow Direction (DrawingFlowDirectionContent) ......................................................................... 1827
Hanger Key Plan (DrawingHangerLabelContent) ...................................................................... 1830
Default (DrawingLabelHelper) .................................................................................................... 1831
Matchline (DrawingMatchlineContent) ....................................................................................... 1835
DrawingOrientToY0Content ....................................................................................................... 1837
Reference (DrawingReferenceLabelContent) ............................................................................ 1838
Knuckle Angle Symbol (ISKnuckleAngleSymbolContent) .......................................................... 1839
Manufacturing Margin Symbol (ISMfgMarginSymbolContent) ................................................... 1840
Profile Sketch Linear Feature (ISProfileSketchFeatureLinearDimCM) ...................................... 1840
Profile Sketch Radial Feature (ISProfileSketchFeatureRadialDimCM)...................................... 1841
ISRulesetSymbolContent ........................................................................................................... 1841
Manufacturing Sketch (MfgSketchContent)................................................................................ 1842
Scantling Weld Symbol (DwgScantlingWeld) ............................................................................. 1842
Override (ISDimensionContentOverride) ................................................................................... 1844
ISDwgEndCutRuleServer ........................................................................................................... 1844
ISDwgProfileEndCutSymbol ....................................................................................................... 1845
ISDwgSlotRuleServer ................................................................................................................. 1847
Knuckle Point Symbol (ISKnucklePointSymbolContent) ............................................................ 1848
Knuckle Sloping Direction Symbol (ISKnuckleSlopingDirectionSymbolContent)....................... 1849
Plate Angle Symbol (ISPlateAngleSymbolContent) ................................................................... 1850
Plate Thickness Symbol (ISPlateThicknessSymbolContent) ..................................................... 1851
Profile Angle Symbol (ISProfileAngleSymbolContent) ............................................................... 1852
ISProfilePartThicknessSymbolContent ...................................................................................... 1853
Profile System Thickness Symbol (ISProfileSysThicknessSymbolContent) .............................. 1855
Default Marine Label (ISRulesetLabelContent) .......................................................................... 1856

Drawings and Reports Reference Data Guide 24


Contents

Seam Symbol (ISSeamSymbolContent) .................................................................................... 1856


Ship Direction Symbol (ISShipDirectionSymbolContent) ........................................................... 1858
Manufacturing Profile Plate Location Symbol (MfgProfilePlateLocSymContent) ....................... 1860
SM3D ProfileSketchFeatureSymbol ........................................................................................... 1862
ProfileSketchMarkingLineSymbol ............................................................................................... 1864
SlotSymbols ................................................................................................................................ 1864
Remarking Girth Length Label (SM3DDwgRemarkingGirthLengthCM) ..................................... 1866
Marine Linear (SMDrawingDimContentLinear) .......................................................................... 1866
Manufacturing Pin Height Label (SMDwgMfgPinHeightLabelContent) ...................................... 1867
Manufacturing Profile Margin Symbol (SMDwgMfgProfileMarginSymContent) ......................... 1868
Plate Grid Name Label (SMDwgPlateGridNameLabelContent) ................................................. 1868
Scantling Near Side or Far Side Symbol (SMDwgScantlingNSorFSContent) ........................... 1869
Scantling Near Side or Far Side Direction Symbol
(SMDwgScantlingNSorFSDirectionContent) .............................................................................. 1869
Profile Seam Symbol (SMProfileSeamSymbolContent) ............................................................. 1870
Profile Sketch Bevel Shape Label (SMProfileSketchBevelShapeLabelsCM) ............................ 1871
Profile Sketch Bevel Symbol (SMProfileSketchBevelSymbolCM) ............................................. 1872
Ruler Axis (SMRulerAxisSymbolContent) .................................................................................. 1873
Template Set Full Scale Direction Symbol
(SMTemplatesetFullScaleDirSymbolContent) ............................................................................ 1878
Thickness Direction Symbol (ThicknessSymContent) ............................................................... 1879
Pin Jig Seam Offset Label (SMDPinJigSeamOffsetCM) ............................................................ 1880
Profile Sketch Label (SMDwgProfileSketchLabelsContent) ....................................................... 1881
Profile Sketch Web Thickness Symbol (SMPSWebThicknessContent) .................................... 1881
Angular Dimensions (DrawingDimContAngNoReplace) ............................................................ 1883
Angular Dimensions with Value Replacement (DrawingDimContentAngular) ........................... 1884
Horizontal Linear Dimensions with Value Replacement
(DrawingDimContentLinearH) .................................................................................................... 1885
Vertical Linear Dimensions with Value Replacement
(DrawingDimContentLinearV) .................................................................................................... 1886
Radial Dimensions with Value Replacement (DrawingDimContentRadial) ............................... 1887
Horizontal Linear Dimensions (DrawingDimContLinHNoReplace) ............................................ 1888
Vertical Linear Dimensions (DrawingDimContLinVNoReplace) ................................................. 1889
Radial Dimensions (DrawingDimContRadNoReplace) .............................................................. 1890
North Arrow (DrawingNArrowContent) ....................................................................................... 1891
No Label Content (DrawingNoContent) ...................................................................................... 1893
Pipe Segment Dimensions with Value Replacement
(DrawingPipeSegsDimContent) ................................................................................................. 1894
Pipe Segment Dimensions (DrawingPipeSegsDimContNoReplace) ......................................... 1895
Weld (DrawingWeldSymbols) ..................................................................................................... 1896
SP3DDrawingLabelQuery .......................................................................................................... 1897
Structural Widget (StructuralWidgetLabelContent) .................................................................... 1897
Control Generators ........................................................................................................................... 1899
Coordinate (DrawingCoordDimGenerator) ................................................................................. 1899
Default (DrawingDimGenerator) ................................................................................................. 1901
Default (DefaultLabelControlGenerator)..................................................................................... 1902
Pipe Segments (DrawingPipeSegmentsCG) ............................................................................. 1905
Positioning Modules .......................................................................................................................... 1905
Absolute Dimension Offset (DrawingDimAbsolutePos) ............................................................. 1907
Clear Space Horizontal Bottom (DrawingDimHorizBottomCS) .................................................. 1908
Clear Space Horizontal Top (DrawingDimHorizTopCS) ............................................................ 1909

Drawings and Reports Reference Data Guide 25


Contents

Absolute Margin (DrawingDimMarginPos) ................................................................................. 1910


Clear Space Vertical Left (DrawingDimVertLeftCS) ................................................................... 1911
Clear Space Vertical Right (DrawingDimVertRightCS) .............................................................. 1912
Clear Space Radial (DrawingRadial) .......................................................................................... 1913
Clear Space Tiling (CAD Details) (DrawingTileInView) .............................................................. 1914
Absolute Position by 2D Curve (ISDwgAbsolutePositionByCurve2D) ....................................... 1915
Clear Space Position by 2D Curve (ISDwgPositionByCurve2D) ............................................... 1919
Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin) ................. 1927
Absolute Axis Position (SMDwgPositionAxis) ............................................................................ 1935
Absolute Position by 2D Curve at Axis (SMDwgPositionByCurve2DAtAxis) ............................. 1936
Clear Space Position Marine Grid Label at Margin
(SMDwgPositionGridLblMarginOnly) .......................................................................................... 1942
Absolute XY Offset (DrawingAbsolute) ...................................................................................... 1947
Clear Space Center Then Above (DrawingCenterThenAbove) ................................................. 1952
Clear Space Center Then Above Centerline (DrawingCenterThenAboveCL) ........................... 1954
Clear Space Center Then Rotate (DrawingCenterThenRotate) ................................................ 1956
Clear Space Radial from Object Center with Clustering (DrawingCentroid) .............................. 1959
Clear Space Coordinate (DrawingCoordLblPosMod) ................................................................ 1967
Absolute Dimension Offset (DrawingDimAbsolutePos) ............................................................. 1973
Clear Space Pipe Segments (DrawingDimPipeSegPos) ........................................................... 1973
Clear Space Grid Horizontal (DrawingGridLblHoriz) .................................................................. 1973
Clear Space Grid Margin (DrawingGridLblMarginOnly) ............................................................. 1979
Absolute Grid Margin (DrawingGridLblMgnAbsPos) .................................................................. 1983
Clear Space Grid Vertical (DrawingGridLblVert) ........................................................................ 1985
Clear Space Margin (DrawingMarginOnly)................................................................................. 1989
Absolute Matchline (DrawingMatchlinePositioning) ................................................................... 1992
Clear Space Quadrant 4 (DrawingQuadFour) ............................................................................ 1993
Clear Space Quadrant 1 (DrawingQuadOne) ............................................................................ 1999
Clear Space Quadrant 3 (DrawingQuadThree) .......................................................................... 2005
Clear Space Quadrant 2 (DrawingQuadTwo) ............................................................................ 2011
Absolute Radial from View Center (DrawingVectorAbsolute) .................................................... 2016
Clear Space Clipped (DwgClippedPositioning) .......................................................................... 2016
Clear Space End of Linear Object (DwgLblEndOfSegmentPos) ............................................... 2017
Absolute Along Linear Object (DwgLinearAbsPos) .................................................................... 2020
Clear Space Along Linear Object (DwgLinearPositioning) ......................................................... 2023
Clear Space Margin with Dimensions (DwgMatchlineWithDim) ................................................ 2024
posModulesSet ........................................................................................................................... 2037
Leader Modules ................................................................................................................................ 2040
Clear Space Tiling (CAD Details) (DrawingTileInView) .............................................................. 2040
Weld (DrawingWeldLeader) ....................................................................................................... 2042
Only Outside of Object (DwgLeaderInOutsideControl) .............................................................. 2044
Margin (DwgMarginLeaderControl) ............................................................................................ 2046
ISDwgMarginLeader ................................................................................................................... 2054
Materials Handling Absolute (MHDrawingAbsoluteLeader) ....................................................... 2058
Coordinate (DrawingCoordLeaderControl)................................................................................. 2060
Linear (DrawingLinearLeader) .................................................................................................... 2063
Default (DwgLeaderControl) ....................................................................................................... 2067
Stacked Labels (DwgStackLabelLeader) ................................................................................... 2072

Drawings and Reports Reference Data Guide 26


Contents

Index ....................................................................................................................................................... 2076

Drawings and Reports Reference Data Guide 27


Preface
This document is a reference data guide for the Intergraph SmartTM 3D Drawings and Reports
task. The purpose of this document is to describe the reference data delivered with the software
for this task.
Reference data includes both catalog data and specification data. Catalog data includes the
parts that you place in the model, such as piping components and equipment. Specification data
includes the rules that govern how those parts are placed and connected.
For more information, refer to the Drawings and Reports task user documentation:
 Orthographic Drawings User's Guide
 Isogen Isometric Drawings User's Guide
 Reports User's Guide

Documentation Comments
For the latest support information for this product, comments or suggestions about this
documentation, and documentation updates for supported software versions, please visit
Intergraph Smart Support (https://smartsupport.intergraph.com).

What's New in Drawings and Reports Reference Data


The following changes have been made to the Drawings and Reports reference data.
Version 2016 (11.0)
 You can now add a unit delimiter between primary and secondary units in a report label.
You can also define a label with unit delimiter. For more information, see Label Editor (on
page 922) and Create a Label (on page 929) (P2 CP:140982)
 Clarified descriptions of graphic rules, graphic preparation rules, and custom graphic
modules. For more information, see Graphic Rules (on page 725), Graphic Preparation
Rules (on page 959), and Custom Graphic Modules (on page 972). (P2 CP:143796)
 You can now add a point element to a symbol that only contains a text box element to
ensure that label leaders stay attached to the symbol. For more information, see Select
Graphic Rule Dialog Box (on page 68). (P2 CP:169376)
 Added a new custom graphic module, Bracket with Flange. For more information, see
Bracket with Flange (on page 982). (P2 CP:183786)
 Added changes to the View Style Properties dialog box to make it quicker and easier to
use. For more information, see View Style Properties Dialog Box (on page 59). (P2
CP:186749)
 Added the North Arrow Rule to the Label Rule Manager to make it easier to modify
automated drawing labels. For more information, see North Arrow Rule Manager (on page
1633). (P2 CP:234383)
 You can load layout processors from the symbol share to simplify the deployment of content
packages. For more information, see Set up custom layout processor modules (on page

Drawings and Reports Reference Data Guide 28


Preface

147) and Create a new layout style with custom layout processors (on page 148). (P2
CP:236985)
 Added a new ribbon, Generic View Ribbon, to the Associate Objects to View command
that allows you to specify options on a selected graphic view with a generic rule set view
style. For more information, see General Tab (Edit Ruleset View Style Dialog Box) (on page
133). (P2 CP:244388)
 Added two properties, Extend Into and Extend Out Of, that define the gathering range for a
volume creation rule. For more information, see Generic Rule Set (on page 191). (P2
CP:244388)
 Added a new rule set custom test, Gathered. For more information, see Gathered (on page
276). (P2 CP:244388)
 In various content modules, you can now use the annotationModule property to define the
report template location in the label template XML file. For more information, see Content
Modules (on page 1818). (P2 CP:244726)
 You can now produce cable tray and HVAC isometric drawings. To support this
enhancement, two new drawing styles are delivered with the software: Iso_Cabletray and
Iso_HVAC. For more information, see PipeMfgRules Sheet (on page 642).(P2 CP:246176)
 A new dimension rule and content module override manual 2D dimensions with 3D
dimensions in SmartSketch Drawing Editor. For more information, see Dimensions (on page
679), Dimension Templates Overview (on page 694), 3D Dimensions, and
Simple3DDimension. (P2 CP:252113)
 You can now customize the shortcut menu on a folder in the Management Console. For
more information, see Configure New Command on a Folder (on page 40). (P2 CP:255695)
 Previous versions of the Smart 3D user interface (UI) refer to Piping Isometric Drawings.
Because the software now supports the production of cable tray and HVAC isometric
drawings, the UI now reflects the generic term Isogen Isometric Drawings. This document
has been updated to reflect this change in the UI. (P2 CP:259784)
 Added the Tangent Edge Visible Line Style option to the Graphic Rule - VHL dialog box
and the Visible/Hidden Edges (VHL) Graphic Rule. For more information, see Graphic
Rule - VHL Dialog Box (on page 71) and Visible/Hidden Edges (VHL) (on page 734). (P2
CP:261508)
 Enhanced custom tests and graphic modules support the existing reference data migration
from VB 6 to C++. For more information, see Drawings by Rule View Styles (on page 167)
and Generic Rule Set (on page 191). (P2 CP:266707)
 A new generic rule set, new custom tests, new options to a graphic rule, and new custom
graphic modules improve view style customization. For more information, see Custom Tests
Dialog Box (Generic Rule Set) (on page 123), Generic Rule Set (on page 191), Ruleset
Custom Tests (on page 263), Cutting Surface Intersection (on page 726), and Custom
Graphic Modules (on page 972). (P2 CP:266709, P2 CP:271474, P2 CP:266686, P2
CP:277066, P2 CP: 268199, P3 CP:208447)
 A new property, Clipped Line Style, specifies a line style for an object clipped by the
drawing view. For more information, see Graphic Rule - VHL Dialog Box (on page 71) and
Visible/Hidden Edges (VHL) (on page 734). (P2 CP:141534, P2 CP:267090)
 The new Migrate Dimension Tool makes dimension anchoring easier for users who have
existing templates tied together using the filter-based anchoring mechanism. For more
information, see Appendix: Migrating Dimension Rules (on page 1722). (P2 CP:269886)

Drawings and Reports Reference Data Guide 29


Preface

 New end cut rules and symbols are used with the generic rule set for drawings by rule. For
more information, see Landing Curve with End Cuts (on page 729) and End Cut Embedded
Symbols (Generic Rule Set) (on page 1053). (P2 CP:273727)
 The Point Location property has been added to the Dimension Rule Manager. The Point
Location property specifies where to place points that the Horizontal Routable Object
point generator module creates. You can place points on the bottom, at the center, or on top
of a routable object, such as a cable tray. For more information, see Point Location
(pointLocation) (on page 1585) and Horizontal Routable Object
(DrawingPGRoutableObjHoriz) (on page 1549). (P2 CP:275187)
 You can now use the Copy command in the Select Label Rule dialog box to create new
north arrow rules based on an existing rule. For more information, see Copy a Rule (on page
86). (P2 CP:275543)
 You can now use the Copy command in the Select Label Rule dialog box to create new
matchline rules based on an existing rule. For more information, see Copy a Rule (on page
86). (P2 CP:275544)
 Added the CONTENT_SUPPORTED attribute to restrict unsupported label content module
behavior in the Label Rule Manager. For more information, see CONTENT_SUPPORTED
(on page 1071) in Appendix: Annotation Rule Manager Customization (on page 1066). (P2
CP:276324)
 The label and dimension common module schema files now support module ProgIDs.
Previously, these files only supported module .dll names. This allows you to use either .dll
names or ProgIDs for modules in dimension and label template .xml files. For more
information, see Schema File Types (on page 1067) and XML Structure of Module
Definitions (on page 1093). (P2 CP:272492)
 The Style2 view styles follow certain parameters when defining the dimPerimeterOffset
value. For more information, see HngSup - Side Style2 View Style (on page 496), HngSup -
End Style2 View Style (on page 491), Piping Plan Style2 View Style (on page 606), and
Piping Elevation Style2 View Style (on page 577). (P2 CP:281697)
 The Scale Factor command is now called Scale Factor Percentage. For more information,
see Scale Factor Percentage (scaleFactor) (on page 1460). (P2 CP:284964)
 You can now specify a scale factor to control the size of pipe flow direction arrows. For more
information, see Scale Factor Percentage (scaleFactor) (on page 1460). (P2 CP:282426)
 Added the SYMBOL_FILE attribute to specify that a label content module does not use any
symbol files. For more information, see SYMBOL_FILE (on page 1072) in Appendix:
Annotation Rule Manager Customization (on page 1066). (P2 CP:283456)
 Added new relations to the Custom Tests dialog box. For more information, see Relations
for Custom Tests (on page 124) (P2 CP:294731)
 Added new properties to the Relation to Target ruleset custom test. For more information,
see Relation to Target (on page 286). (P2 CP:294731)
 You can now prevent landing curves from occluding other landing curves using the
AddSolidForVHL flag. For more information, see Generic Stiffener Landing Curve (on page
998). (P2 CP:296036)
 A new label template allows you to place a group label for multiple objects. For more
information, see Group Labels (on page 753). (P3 CP:181864)

Drawings and Reports Reference Data Guide 30


Preface

 You can now delete lines placed by Drawings on the drawing sheet by using the
placeLinesOnsheet property with a geometric analyzer module. For more information, see
Aligned Objects (DrawingGALabelInline) (on page 1135). (P3 CP:230173)
 Added full support for horizontal and vertical properties for the Ruler Axis content module.
For more information, see Ruler Axis (SMRulerAxisSymbolContent) (on page 1455) in Label
Rule Manager (on page 1099). (P3 CP:246317)
 Added a note to clarify label creation for the Opening To X custom graphic module. For
more information, see Opening To X (on page 1008). (P3 CP:251779)
 Civil view styles support drawing trench parts and drawing the centerline of trench features.
For more information, see Civil Elevation View Style (on page 375), Civil Isometric View
Style (on page 376), Civil Plan View Style (on page 390), and Trench Parts Ports (on page
1040). (P3 CP:257402)
 Added information about dimension anchoring. For more information, see Dimension
Anchors (on page 690). (P3 CP:265877)
 Added information about the new DrawingGAMarginOnlyWithOccludedGraphics annotation
module. For more information, see Margin with Occluded Graphics
(DrawingGAMarginOnlyWithOccludedGraphics) (on page 1786). (P3 CP:266384)
 A new property, Additional View Inputs, defines an .xml file from which to import additional
view properties. For more information, see General Tab (Edit Ruleset View Style Dialog Box)
(on page 133). (P3 CP:266696)
 Updated the description of the Custom Scale Codelist workbook. For more information, see
Custom Scale Codelist Workbook (on page 323). (P3 CP:272719)
 Added a new property, View Offset, to the Edit Ruleset View Style dialog box. For more
information, see Area Tab (Edit Ruleset View Style Dialog Box) (on page 130). (P3
CP:272849)
 Expanded the notes section for DrawingWeldSymbols. For more information, see Weld
(DrawingWeldSymbols) (on page 1492). (P3 CP:279138)
 Added a new custom graphic module, Make Drawable Assembly. For more information,
see Make Drawable Assembly (on page 1005). (P3 CP:281372)
 You can now specify whether the software should place an acute breakline angle. For more
information, see Allow Acute Breakline Angle (on page 1142). (P4 CP:248885)

ISO Standards in Marine Drawings


Intergraph SmartTM 3D marine drawings are ISO compliant. Several ISO templates are delivered
with the product.
Below is a list of ISO Reference numbers and the description of the document.

ISO 128-20:1996(E) Technical Drawings – General principles of presentation Basic


conventions for lines

ISO 128-21:1997(E) Technical Drawings – General principles of presentation Preparation of


lines by CAD systems

Drawings and Reports Reference Data Guide 31


Preface

ISO 128-22:1999(E) Technical Drawings – General principles of presentation Basic


conventions for applications for leader lines and reference lines

ISO 128-23:1999(E) Technical Drawings – General principles of presentation Lines on


construction drawings

ISO 128-24:1999(E) Technical Drawings General principles of presentation Lines on


mechanical engineering drawings

ISO 128-25:1999(E) Technical Drawings General principles of presentation – Part 25: Lines
on shipbuilding drawings

ISO 128-30:2001(E) Technical Drawings – General principles of presentation – Part 30: Basic
conventions for views

ISO 128-40:2001(E) Technical Drawings – General principles of presentation – Part 40: Basic
conventions for cuts and sections

ISO 128-50:2001(E) Technical Drawings – General principles of presentation – Part 50: Basic
conventions for representing areas on cuts and sections

ISO 5457:1999(E) Technical product documentation – Sizes and layout of drawing sheets

ISO 7200:2400(E) Technical product documentation – Data fields in title blocks and
document headers

ISO 5261:1995(E) Technical Drawings – Simplified representation of bars and profile


sections

ISO 2553:1992(E) Welded, brazed and soldered joints – Symbolic representation on


drawings

ISO 5572:1987(E) Shipbuilding and marine structures – Numbering of equipment and


structural elements in ships

ISO 7462:1985(E) Shipbuilding – Principal ship dimensions. Terminology and definitions for
computer applications

ISO 8193:1984(E) Shipbuilding – Shell plating information

ISO 9203-1:1989(E) Shipbuilding – Topology of ship hull structure elements – Part 1:


Location of elements

ISO 9203-2:1989(E) Shipbuilding – Topology of ship hull structure elements – Part 2:


Description of elements

ISO 9203-3:1989(E) Shipbuilding – Topology of ship hull structure elements – Part 3:


Relations of elements

ISO 129-1:2004(E) Technical drawings – Indication of dimensions and tolerances – Part 1:


General principles

Drawings and Reports Reference Data Guide 32


Preface

ISO 6428:1982(E) Requirements for microcopying

ISO 3898:1997(E) Bases for design of structure – Notations – General symbols

ISO 3098-0:1997(E) Technical product documentation – Lettering – Part 0: General


requirements

ISO 3098-2:2000(E) Technical product documentation – Lettering – Part 2: Latin alphabet,


numerals and marks

ISO 3098-5:1997(E) Technical product documentation – Lettering – Part 5: CAD lettering of


Latin alphabet, numerals and marks

By default, the following metric drawing templates are delivered in the ISO format.
LARGE
 Paper Format (ISO 5457)
 A0 (valid for A1 and enlarged formats)
 Title-block (ISO 7200)
 Lines (ISO 128 Part.25, ISO 6428)
 Wide 0.7 mm
 Narrow 0.35 mm
 Characters (ISO 3098-5, ISO 6428)
 Titles 7 mm (ISO 3098 BVL – 7)
 Labels 3.5, bold or 5 (ISO 128 Part.22)
 Dimensions 3.5, values rounded to 1 mm (ISO 129)
 Symbols to match above lines and characters for
 Relative positions of structural elements (BL, CL,...)
 Sections and details (Section plane, Section and Detail Titles)
 Profile cross-sections (ISO 5261)
 Profile end-cuts re-symbolization
 Section and plates butt joints
 Welds (ISO 2553)

Drawings and Reports Reference Data Guide 33


Preface

AWS Standards in Drawings


Smart 3D follows the ANSI/AWS A2.4:2007 standard for weld labels constructed with the
Structure_Weld label.
The Structure_Weld.xml file is located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder and uses symbols in the
[Reference Data Folder]\SharedContent\Drawings\Catalog\Labels\Templates\WeldSymbols
folder. For more information on this weld label, see Structure_Weld (on page 942).

1 - Primary Side Symbol or Primary Side Groove 13 - Secondary Side Pitch or Distance Between the Ends of
Adjacent Welds

2 - Secondary Side Symbol or Secondary Side Groove 14 – Primary Side Contour

3 – Primary Side Groove Size 15 – Secondary Side Contour

4 – Secondary Side Groove Size 16 – Primary Side Finish Method

5 - Primary Side Bevel Depth or Leg Length or Actual 17 – Secondary Side Finish Method
Throat Thickness or Strength

6 - Secondary Side Bevel Depth or Leg Length or Actual 18 – Primary Side Root Opening or Depth of Filling
Throat Thickness or Strength

7 – Field Weld 19 - Secondary Side Root Opening or Depth of Filling

8 - All Around 20 – Primary Side Groove Angle or Included Angle of


Countersink

9 – Tail Notes 21 - Secondary Side Groove Angle or Included Angle of


Countersink

10 – Primary Side Length 22 – Primary Side Number Of Welds

11 – Secondary Side Length 23 - Secondary Side Number Of Welds

12 – Primary Side Pitch or Distance Between the Ends


of Adjacent Welds

Drawings and Reports Reference Data Guide 34


The Management Console, Folders, and Components

SECTION 1

The Management Console, Folders, and


Components
The Management Console allows you to manage your drawing and report documents with
folders, components, and packages. The panel is located on the left side of the application
window, as shown in the following plant mode example.

To add folders, components, and packages to the Management Console, right-click the top
level or an existing folder, and select New on the shortcut menu to display the Add Component
dialog box. For more information on the New command, see any of the Drawings and Reports
user's guides:
 Orthographic Drawings User's Guide
 Isogen Isometric Drawings User's Guide
 Reports User's Guide
You can also manage documents, components, and packages in the 3D modeling
tasks using the Tools > Drawings Console command. For more information, see the Common
User's Guide.
When you first enter the Drawings and Reports task, the Management Console is empty
except for the top-most level, the Model. You add Folders to the model, then begin
adding components and packages to the folders you create. For example, you can add a folder
and call it Equipment, then add the Imperial_Equipment Drawing package to the folder to
create equipment drawings.

Delivered Components and Folders


Components provide the basic setup for a method of drawing.
The following components are shown on the General tab of the Add Component dialog box:

Drawings and Reports Reference Data Guide 35


The Management Console, Folders, and Components

Delivered Component Description

3D Model By Query Creates a 3D Model By Query component in the


Console. You can use the 3D Model By Query
component to export 3D model data in bulk as CAD
(SAT) files. The software uses a filter-based query to
collect the objects and document them automatically.
More information is available in the Orthographic
Drawings User's Guide.

3D Model Data Creates a 3D Model Data component in the Console.


Right-click the component and select Setup on the
shortcut menu to specify a filter that identifies the
objects you want collected by the 3D Model Data
component. You can use the 3D Model Data
component to output SmartPlant Review files or CAD
(SAT) files. More information is available in the
Orthographic Drawings User's Guide.

MicroStation 3D DGN Creates a MicroStation 3D DGN component in the


Console. Right-click the component and select Setup
from the shortcut menu to define the MicroStation seed
file and style to use in generating the component
documents. More information is available in the
Orthographic Drawings User's Guide.

Folder Creates an empty folder in the Console.

Drawings By Query Manager Creates a Drawings by Query Manager in the Console.


The Drawings by Query Manager is used in conjunction
with other components, such as the Orthographic
Drawing by Query and Isogen Isometric Drawing by
Query components, to complete the query for objects in
the model. The Drawings by Query Manager provides
the filter that specifies the "where" side of the query. It
tells the query "where" to look for the objects specified
by the component "what" filter. More information is
available in the Orthographic Drawings Users Guide
and the Isogen Isometric Drawings User's Guide.

Generic Module Folder Creates a Generic Module Folder in the Console. The
Generic Module Folder component provides a way for
you to run your custom VB modules to create custom
drawings. You set up the Generic Module Folder
component to use your custom VB module. More
information is available in the Orthographic Drawings
User's Guide.

Drawings and Reports Reference Data Guide 36


The Management Console, Folders, and Components

Delivered Component Description

Imported Folder Imports an external Windows folder from a shared


network folder into the Management or Drawing
console. The imported folder can contain any type of
file available in Windows. You can manage the
imported documents, and publish them using Imported
Folder menu options. For more information, refer to
Drawings Folders in the Orthographic Drawings User's
Guide.

Composed Drawings Creates a Composed Drawing component in the


Console. Composed drawings are orthographic
drawings created in a 3D task such as Common. The
composed drawing component manages the composed
drawings you create. More information is available in
the Orthographic Drawings User's Guide.

Orthographic Drawings by Creates an Orthographic Drawings by Query


Query component in the Console. The Orthographic Drawing
by Query component allows you to create drawings for
many objects in the model all in the same manner. This
component does not require physical volumes in the
model. The software uses a filter-based query to collect
the objects and document them automatically. More
information is available in the Orthographic Drawings
User's Guide.

Isogen Isometric Drawings by Creates an Isogen Isometric Drawings by Query


Query component in the Console. You create an isometric
drawing by associating an Isogen Isometric Drawing by
Query component to a Query Manager. The Isogen
Isometric Drawing by Query component specifies the
"what" portion of the query, while the Query Manager
specifies the "where." More information is available in
the Isogen Isometric Drawings User's Guide.

Spreadsheet Reports Creates a Spreadsheet Report component in the


Console. More information is available in the Reports
User's Guide.

Search Folder Creates a Search Folder in the Console. Search


Folders allow you to search for documents based on
common properties such as out-of-date status,
approval, or documents that have been published to a
certain contract in integrated environment. More
information is available in the Orthographic Drawings
User's Guide.

Drawings and Reports Reference Data Guide 37


The Management Console, Folders, and Components

Delivered Component Description

Volume Drawings Creates a Volume Drawings component in the Console.


The Volume Drawing component uses a template to
create drawings. You can place a view on the template
and associate the view with a view style to control the
output. To define the contents of the view, you create a
drawing volume in the model. More information is
available in the Orthographic Drawings User's Guide.

In marine mode, the following component is found on the Ship tab of the Add Component
dialog box:

Delivered Component Description

Drawings by Rule Creates a Drawing by Rule component in the


Console. The component allows you to create
empty drawings by rule. For more information, see
the Orthographic Drawings User's Guide.

Delivered Packages
Packages contain components that have been further defined with view template, styles,
queries, and filters to create specific types of drawings. These packages are shown on other
tabs of the Add Component dialog box. They are organized by discipline such as Electrical or
Structural. For more information on the delivered packages, see:
 Orthographic Drawing Packages (on page 330)
 Isogen Isometric Drawing by Query Packages (on page 645)
 Drawings by Rule Packages (on page 164) (Marine mode only)
See Also
Locations of Drawings and Reports Data (on page 39)

Drawings and Reports Reference Data Guide 38


The Management Console, Folders, and Components

Locations of Drawings and Reports Data


Drawings reference data are delivered in the [Reference Data Folder]\SharedContent\Drawings
folder and displayed within the hierarchy in the Catalog task.

Drawing Documents
Drawing documents, sheets and views are not included in the catalog database. Generated
drawings are maintained within the model database. You can use drawing objects to create
filters for use in view styles and in creating search folders:

Templates
Report and label templates reside in the catalog and are displayed in the hierarchy in the
Catalog task:

You can copy a label from the [Reference Data Folder]SharedContent\Labels\Types


of Labels folder to the [Reference Data
Folder]\SharedContent\Drawings\Drawings\Catalog\Labels\Templates folder to use them as
drawing labels in a drawing view style.

Drawings and Reports Reference Data Guide 39


The Management Console, Folders, and Components

Report and label occurrences used in drawings reside in the model database. When you are
creating or applying filters, the Report Templates node is included in the Object Type hierarchy:

Drawing Volumes
Drawing volumes are included as space definitions in the model and display in the Space
Management task hierarchy within the Space tab of the Workspace Explorer.
For additional information on drawing volumes, see Drawings Workbook (on page
322) and the Space Management User's Guide.
See Also
The Management Console, Folders, and Components (on page 35)

Shortcut Menus
Configure New Command on a Folder
You can create an XML file to configure the New command on a folder shortcut menu in the
Management Console. For example, you can add the option to create a new search folder or
imported folder.
1. Create a new XML file called NewPopUpMenus.xml.
2. Type the following code:
<?xml version="1.0" encoding="utf-8"?>
<xml>
<PopupMenu id="{AF2EE992-B592-11D4-8B30-0050DA23CBE0}">
<Menuitem id="Folder" arg1="" action="" accel=""
caption="&amp;Folder"/>
<Menuitem id="Group1" caption="-"/>
<Menuitem id="Imported Folder" arg1="" action="" accel=""
caption="&amp;Imported Folder"/>
<Menuitem id="Search Folder" arg1="" action="" accel="" caption="My
&amp;Search Folder"/>
</PopupMenu>
</xml>

 id - Specifies the package name. The name must correlate to a folder in


<SymbolShare>\Drawings\Catalog\Packages. If the package name is not found, the
system ignores the corresponding Menuitem, and the Error Log is updated.
 Caption - Specifies the text that displays on the shortcut menu. Type "-" to insert a
separation between commands. Each caption must be unique.
 arg1, action, and accel are not currently used by the system.
 PopupMenu id – Specifies that the menu applies to the folder in the Management
Console. Do not edit or delete this value.

Drawings and Reports Reference Data Guide 40


The Management Console, Folders, and Components

3. Save the NewPopUpMenus.xml file in the <SymbolShare>\Drawings\Catalog\Packages


folder.
When you right-click a folder in the Management Console, the shortcut menu displays as
shown:

3D Model By Query
You can create a 3D Model by Query component and base it on a specific filter that
determines what objects to document. You can use the 3D Model by Query component to output
CAD (SAT) files. The software uses a filter-based query to collect the objects and document
them automatically. For more information on setting up the 3D Model by Query component, see
Set up a 3D Model by Query component in the Orthographic Drawings User's Guide, available
from Help > Printable Guides.

Output as Neutral CAD (SAT) Graphics File


You can setup the 3D Model by Query component to output your model objects to a neutral
CAD (.sat) file format. Right-click the 3D Model by Query component and select Setup to set the
filter and navigation rule.

Project Supervisor Setup


Your project supervisor should set up appropriate filters that define the objects to include in the
component documents when they are created.

Drawings and Reports Reference Data Guide 41


The Management Console, Folders, and Components

3D Model Data
You can create a 3D Model Data component and base it on a specific filter. The filter defines
the contents of the component documents when they are created. You can use the 3D Model
Data component to output SmartPlant Review files or CAD (SAT) files.

Output as Neutral CAD (SAT) Graphics File


You can setup the 3D Model Data component to output your model objects to a neutral CAD
(.sat) file format. Right-click the 3D Model Data component, and select Setup to set the filter and
output file path.

Output as SmartPlant Review File


You can setup the 3D Model Data component to output your model objects as SmartPlant
Review files depending on how you set up the 3D Model Data component. The software creates
.vue and .xml files by default. If you select the Generate streaming vue output (.zvf file) option
on the Setup dialog box, the software creates all three SmartPlant Review files: .zvf, .vue, and
.xml.
You can set the output on the 3D Model Data component to save the SmartPlant Review (SPR)
file to disk only, database only or both.
 Select Disk only (do not save to database) to save the generated graphics and data files
to the specified path. You can then update and publish the 3D Model Data files to
SmartPlant Foundation in an integrated environment. This option helps prevent data
congestion by allowing you to save and publish your files locally.
 Clear Disk only (do not save to database) and do not specify output paths to save the
data only to the database.
 Clear Disk only (do not save to database and specify the output paths to save the data to
the database, and as files to the specified paths.

The basic workflow for creating a 3D Model Data component is as follows:


 Create a 3D Model Data component, and set it up with a filter and output file information.
 Create the 3D Model Data document (one document per 3D Model Data component).
SmartPlant Review shows the objects from the .vue file using global coordinates.
If you plan to save the 3D Model Data component documents to a .vue file using the Save
as SmartPlant Review File command, right-click the component and select Properties to
check the Style tab Coordinate System property setting. You want to make sure the Plant
Monument Coordinate Offset is passed correctly to SPR when creating the .vue file. The
offset value allows you to see the original coordinates relative to the new SPR coordinate
system.
 Revise the documents if publishing to SmartPlant Foundation.
 Set properties Surface Styles and Aspects properties as needed on the 3D Model Data
documents.
 Update the documents using Update Now or Batch > Update on the 3D Model Data
component shortcut menu.

Drawings and Reports Reference Data Guide 42


The Management Console, Folders, and Components

 If SmartPlant Foundation requires a password, you are prompted to type it when updating
3D Model Data documents.
 Save the documents to a predefined location for viewing in SmartPlant Review or publish
the documents to the registered SmartPlant Foundation plant.

Recommendations for Exporting to SmartPlant Review


 The number of objects generated by a 3D Model Data component and exported successfully
to a SmartPlant Review file depends largely on the type of objects and your hardware
resources. We recommend that you limit each 3D Model Data component filter.
 Monitor the error logs regularly for resource issues, even if the specified filter worked
initially. You can add more objects to the model meeting the filter criteria.
 SmartPlant Review (SPR) version 6.1.0.15 (or higher) allows you to open multiple .vue files
simultaneously. Refer to your SmartPlant Review documentation for more information. When
you open .vue and .xml files in SPR for the first time, SPR builds a database containing the
tag information for the files. This process can take a significant amount of time.
 SmartPlant Review (SPR) version 6.2.0.29 (or higher) supports turning SmartPlant aspects
on and off. All aspects are turned on by default in SPR. The SPRSchema.txt file can be
customized to add any customized aspects.
The 3D View Control used for viewing the published graphics in SmartPlant Markup
Plus does not currently support turning aspects on and off.

Project Supervisor Setup


Your project supervisor should set up appropriate filters that define the objects to include in the
component documents when they are created.
You must install the SmartPlant Schema Component and the SmartPlant Client to use this
component.

Exporting 3D Model Graphics to MicroStation


You can export 3D model graphics directly to MicroStation J (V7) and MicroStation V8 DGN
file formats. The actual export is not a drawing file. It is an actual 3D file translated into
MicroStation graphic types. While the workflow is similar to that of regular volume drawings,
there are some differences.
Create a MicroStation component with the Add Component command. After the component is
created, right-click and select Setup from the shortcut menu. The Setup command allows you to
define the MicroStation version, seed file, and style to use in generating the component
documents.
The view style you specify for the component determines which model object graphics are
included in the component documents. The view style also specifies the layers on which the
graphics are placed as well as colors and linear styles when imported in MicroStation. The
MicroStation version you specify defines the type of DGN file to be generated. The seed file
selected determines the MicroStation symbology used within the document.
Layers are referred to as Levels in MicroStation. Levels are defined by integers 1-63
and must be typed in the Layer property in the View Style properties dialog box.

Drawings and Reports Reference Data Guide 43


The Management Console, Folders, and Components

Generic Module Folder


The Generic Module Folder component provides a way for you to run your custom VB
modules to create custom drawings. You set up the Generic Module Folder component to use
your custom VB module. For example, you might create a VB module to create MicroStation 3D
drawings, AutoCAD 3D drawings, or Electrical Isometric drawings. The Generic Module Folder
is simply a container for your VB modules. You create the component just like other
components, but when you perform Setup on the component, you specify a custom VB module.
The software builds the list of available VB modules from the SharedContent library, specifically
from [Reference Data Folder]\SharedContent\Drawings\Catalog\DwgTypeModules. You must
store your VB module in this location to have access to it when setting up the component.

Custom VB Module
The behavior of the component depends entirely on how the VB module is developed.
Everything is controlled by the VB module. When you right-click the component, the VB module
determines the menu items that are available. If the module has a command that creates
documents, you see the Create Documents command. If, for whatever reason, the module
does not need documents, the document-related commands do not display on the shortcut
menu. Other commands the VB module can include are Rename, Delete, Refresh, and Print.
For more information on general commands available, see Shortcut Menus in any of the Smart
3D Drawings user's guides, available from Help > Printable Guides.
If the module supports publishing, the right-click menu includes the Publish command. This
command is available only if your model has been registered using the Smart 3D Registration
Wizard. For more information, see Publishing Documents in the Integration Reference Guide, or
in any of the Smart 3D Drawings user's guides, available from Help > Printable Guides.
For information on the interfaces used to create a custom VB drawing module, see the
Intergraph SmartTM 3D Programmer's Guide. Contact your administrator or Intergraph Support if
you need the Intergraph SmartTM 3D Programmer's Guide. You can find support information on
our web site http://support.intergraph.com (http://support.intergraph.com/).

Composed Drawings
Composed drawings are orthographic drawings created in a 3D task, such as Common,
through the Drawing Console. The composed drawing component manages the composed
drawings you create. Composed drawings are flexible, allowing you to have views that are
managed by a drawing region and to associate the views to volumes and other views.
In 3D modeling tasks such as Common, you can use the Tools > Drawing Console command
to create a composed drawing component and the drawings associated with it. In the Drawings
and Reports task, you can create the composed drawing component, but you must use the 3D
modeling tasks to associate the drawing to objects in the model.
1. In the Drawings and Reports task, use the Tools > Define Layout Style command to create
layout styles you need for your composed drawing regions, then use the layout styles when
you create your layout templates with the Tools > Edit Layout Template command.
2. Create a folder for the drawing component in the Management Console, or go to a 3D task
and use Tools > Drawing Console to create the component.

Drawings and Reports Reference Data Guide 44


The Management Console, Folders, and Components

3. In the 3D modeling task, use the Drawing Console to create new composed drawings.
Right-click the component, and select New Drawing. For more information, see New
Drawing in the Orthographic Drawings User's Guide, available from Help > Printable
Guides. You can also use Edit on the shortcut menu to view or modify existing composed
drawings. You can select Tools > Snapshot View to add snapshots of the model to
composed drawings. For additional information, see the Common User's Guide available
from Help > Printable Guides.
4. When the composed drawing is open in the SmartSketch Drawing Editor, you can add
views, associate views to volumes or other views, remove view associations, add dependent
report views, and modify the layout of the drawing sheet. For more information, see Create a
new composed drawing in the Orthographic Drawings User's Guide. For information on the
Drawings Compose toolbar in plant mode, see Working with 3D Task Drawings in the
SmartSketch Drawing Editor Help. For information on the Drawings Compose Toolbar in
marine mode, see Working with Marine 3D Drawings in the SmartSketch Drawing Editor
Help.
5. After saving the drawing in SmartSketch Drawing Editor, return to the Drawing Console to
do additional editing, update the drawing, and revise and publish the drawing. After the
composed drawing is created, it is just like any other drawing document and can be
managed in the Drawings and Reports task. For information on the 2D commands available
for editing, see the SmartSketch Drawing Editor Help.
If the drawing document you are looking at in the Detail View has a yellow icon (for
example: ), the drawing document is a version 6.1 legacy Snapshot drawing. You should use
the Tools > Convert Legacy Snapshots command to convert this document to a Composed
Drawing for use in the current version of the software. If you do not convert the legacy snapshot
drawing, you cannot perform edit operations on the drawing, including update, revise, and
publish. For more information, see Convert Legacy Snapshots in the Orthographic Drawings
User's Guide.

Drawings and Reports Reference Data Guide 45


The Management Console, Folders, and Components

Drawing Regions and Drawing Views


A region is a container that manages drawing views. The layout style associated with the region
dictates the order and placement of the managed drawing views. Drawing views are associated
with objects, volumes, or other drawing views. You place regions and views on a composed
drawing when it is open in SmartSketch Drawing Editor. For more information on placing regions
and views, see the SmartSketch Drawing Editor Help.

Regions and drawing views behave as follows:


 You can create a drawing view outside a region, but this makes the drawing view an
"unmanaged view," meaning the properties of the region do not impact the drawing view.
However, if a view is inside a region or touching a region, the region manages the drawing
view. When you update the drawing, the software associates the drawing view with the
region and updates it based on the applied region layout style.
 If a region refuses to accept a drawing view (for example, if the region is defined for three
views, and you are attempting to add a fourth view), the drawing view is added as an
unmanaged view, just outside and to the upper left of the region. If another region occupies
this space in the drawing area, the unmanaged view is placed as close to the original region
as possible.
 If a drawing view "straddles" two or more regions, the region that contains more of the
drawing view manages it. If the drawing view equally straddles two or more regions, the
software uses the first drawing view point to measure distance and determine which region
manages the drawing view.
 If a region contained a drawing view and the drawing view properties make it ineligible for
the region, the software removes the drawing view from the region automatically and places
it in the upper left of the drawing area, outside of other regions.

Drawings and Reports Reference Data Guide 46


The Management Console, Folders, and Components

Layout Templates and Layout Styles


Composed drawings use layout templates and layout styles to assist you in creating reusable
drawings. The software combines layout templates with drawing borders to create composed
drawings. Layouts also use regions as containers to manage drawing views. You also define a
layout style associated with the region. The layout style dictates the order and placement of the
managed drawing views. For more information on defining layout styles, see Define Layout Style
Command (Tools Menu) (on page 145). For additional information on editing layout templates,
see Edit Layout Template Command (Tools Menu) (on page 152).

Drawing Borders
When you create a composed drawing in a 3D task, you specify a border template to use with
the drawing. After the drawing is created, you can switch the border associated with the drawing
using the Switch Border command on the shortcut menu of the drawing. For more information,
see Switch Border in the Orthographic Drawings User's Guide.

Drawings by Query Manager


The Drawings by Query Manager component works in conjunction with the Orthographic
Drawing by Query and Isogen Isometric Drawing by Query components. The Drawings by Query
Manager provides the filter that specifies the "where" side of the query. It tells the query where
to look for the objects specified by the component "what" filter.
After you have set up the Drawings by Query Manager, you are ready to start creating drawings
with either an Orthographic Drawing by Query and Isogen Isometric by Query components.
The Drawings by Query Manager uses the normal filter to specify where to look for the objects
included in the drawing. You do not use an asking filter with the Drawings by Query Manager.
The Drawings by Query Manager component is available by running the New command from
the shortcut menu of a folder in the Console hierarchy.
It is best to store the Drawings by Query Manager in the same location as the other
components with which it works.

Drawings by Query Manager Shortcut Menu


Right-click on the Drawings by Query Manager component to display the shortcut menu.
Run Query - Runs the query specified by the Drawings by Query Manager setup definition. If
you have not run the Drawings by Query Manager Setup command, this command is
unavailable.
Copy - Copies the Drawings by Query Manager component. After you paste the copy to a
different location in the Console hierarchy, you can run Setup again as needed for the new
Drawings by Query Manager.
Delete - Deletes the Drawings by Query Manager component. It does not delete any of the
associated Drawings by Query components or documents.
Rename - Renames the component. It does not affect any of the associated Drawings by Query
components or documents.
Save Package - Allows you to save the Drawings by Query Manager and its definition as a
package to be reused in other folder locations in the hierarchy.

Drawings and Reports Reference Data Guide 47


The Management Console, Folders, and Components

Setup - Specifies the Filter and Package to query for the Drawings by Query components.
Properties - Displays the Properties dialog box for the component.

Orthographic Drawings by Query


You can generate orthographic (volume) drawings using a filter-based query. The
Orthographic Drawing by Query component allows you to create drawings for many objects in
the model all in the same manner. This component does not require physical volumes in the
model. The software uses a filter-based query to collect the objects and document them
automatically.
For example, Hanger drawings use parts that can be queried from the database. There are
many of them, and in most cases, they are documented the same way. Using the Orthographic
Drawing by Query component means you do not have to place hundreds of drawing volumes to
document each type of part or assembly.
The basic workflow for creating Orthographic Drawings by Query is as follows:
 Create an Orthographic Drawing by Query component that specifies what you want to
document.
 Create a Query Manager that says where to look for the data.
 Run the filter-based query.
 Create the drawings.
 Update the drawings.
 Publish the drawings to a viewable graphic file; no physical data is published.

Administrator Setup
Your administrator sets up appropriate templates to use with the Orthographic Drawings by
Query component. The administrator is also responsible for creating filters that define what to
look for and filters that specify where in the model to look for the objects. The template and the
"what" filter information within the component are saved as a package.

Drawings by Query Manager


The Drawings by Query Manager uses the normal filter to specify where to look for the objects
included in the drawing. You do not use an asking filter with the Drawings by Query Manager.
For more information on the filters necessary for setting up a Drawings by Query component,
see Drawings by Query Filters in the Orthographic Drawings User's Guide.

Navigator Rules
The navigator rules for Orthographic Drawings by Query tell the software how to traverse
elements to be included in the range for the drawing view objects. The navigator rules can also
return separate object collections with ranges that are included in the 3D object range. If no
navigator rule is specified for a drawing view, the drawing object collection includes everything in
the 3D object range. The delivered rules are as follows

Drawings and Reports Reference Data Guide 48


The Management Console, Folders, and Components

 HngSupSimpleNavigator.dll - Returns support components, supporting objects, supported


objects, and design children. This rule also returns the control points on the components.
This rule is specific to objects created in the Hangers and Support task.
 HngSupRangeNavigator.dll - Returns support components, supporting objects, supported
objects, and design children collections that extend the Hangers and Support range. This
rule also returns the control points on the components. This rule is specific to objects
created in the Hangers and Support task and operates similarly to the
HngSupSimpleNavigator.dll rule.
 HngSupNoSupportingRange.dll - Returns the same components and objects as
HngSupRangeNavigator.dll, excluding the supporting objects.
 DrawingSpoolNavigator.dll - Returns the spool, its connected parts, and their features.
This rule is specific to pipe spools.
 AssemblyNavigator.dll - Returns the assemblies, pipe spool, penetration spool, its
connected parts, and their features. This rule is specific to assemblies.
 SystemRangeNavigator.dll - Returns the Equipment objects, as specified by the "what"
filter. It also returns design hierarchy children of the Equipment, including any Route objects
that are children of the Equipment (Runs, Parts, and Features). This rule is specific to
Equipment objects.
When you edit the template associated to an Orthographic Drawing by Query component, such
as the HgrSup3View package, you can set the navigator rule assigned to each drawing view.
Right-click the component or package and select Edit Template to open the drawing template in
SmartSketch Drawing Editor. Select and right-click a drawing view to display the Drawing
View Properties and set the navigator rule. For more information, see the SmartSketch
Drawing Editor Help.

Isogen Isometric Drawings by Query


Isometric drawings communicate several important types of information to a fabrication
workshop. In the case of a piping isometric drawing, this information includes pipe cut lengths,
bend angles, and welds. You create an isometric drawing by associating an Isogen Isometric
Drawing by Query component to a Query Manager. The Isogen Isometric Drawing by Query
component specifies the what portion of the query, while the Query Manager specifies the where
portion.
The basic workflow for creating Isogen Isometric Drawings by Query is as follows:
 Create an Isogen Isometric Drawing by Query component that specifies what you want to
document.
 Create a Drawings by Query Manager that specifies where to look for the data.
 Run the filter-based query.
 Create the drawings.
 Update the drawings, if needed.
 Publish the drawings to a viewable graphic file; no physical data is published.
Each Isogen Isometric Drawing by Query component has an associated isometric style. The
delivered styles are Iso_Pipeline, Iso_Piperun, Iso_PenSpool, Iso_Spool, Iso_WBS, Iso_Stress,
Iso_Assembly, Iso_System, Iso_HVAC, and Iso_CableTray. You use Isogen Configuration to

Drawings and Reports Reference Data Guide 49


The Management Console, Folders, and Components

set options for isometric drawing format and content. You can open Isogen Configuration from
any of the isometric drawing styles by right-clicking the drawing style in the Management
Console or Drawing Console, and selecting Edit Options on the shortcut menu. For more
information, see Isogen Configuration.
After creating an Isogen isometric drawing, you can open it for viewing, editing, printing, and
publishing (if your model has been registered using the SmartPlant Registration Wizard). To
troubleshoot a drawing, you can use the View Data command to access part and reports
information and log files.
The software uses Isogen, a third-party engine made by Alias, to generate isometric drawings
from the three-dimensional model. The following illustration shows the process of creating the
drawings.

The application creates a piping component file (PCF), which is used along with the isometric
style information to create an intermediate data file (IDF). The Isogen engine then reads the IDF
and creates the isometric drawings.

Administrator Setup
Your administrator should set up appropriate isometric styles to use with the Isogen Isometric
Drawings by Query component. The administrator is also responsible for creating filters that
define what to look for and filters that specify where in the model to look for the objects. The
template and the what filter information within the component are saved as a package.

Drawings by Query Manager


The Drawings by Query Manager uses the filter to specify where to look for the objects included
in the drawing.
For more information on the filters necessary for setting up a Drawings by Query component,
see Drawings by Query Filters.

Drawings and Reports Reference Data Guide 50


The Management Console, Folders, and Components

Spreadsheet Reports
The Spreadsheet Report component allows you to define report templates and create report
deliverables.
The software features a tabbed editor called the Report Template Editor that allows you to
create and modify report templates. Most of the delivered reports use a combination of filters
and SQL. The Report Template Editor includes an interface for entering database query
syntax and testing the results of a query as part of the report. The editor also features an Excel
component in which you can perform a drag and drop operation of attributes onto a worksheet.
The default format of all reports is Microsoft Excel format.
After you make changes to a template, you can test the template by using the Update
Document(s) or Update Now command. For more information on updating documents, see
Updating Documents.
There are several types of spreadsheet reports delivered with the software. They are defined
and described in the Reports.xls workbook. For more information on the workbook, see the
Drawings and Reports Reference Data Guide.

 Microsoft Excel 2003 is the minimum supported version for the Drawings and Reports task.
 Excel 2007 uses a new file format and extension (.xlsx). However, the delivered report
templates still use the old .xls extension. If you create a report template with the .xlsx
extension, only machines with Excel 2007 will be able to handle (edit, update, or open) the
report. If you attempt to open a .xlsx file with an older version of Excel, an error message
displays stating that the file is not compatible with the version of Excel.
 If you are using Office 2003, in Microsoft Excel under the Tools > Macro > Security >
Trusted Publishers tab, check the Trust Access to Visual Basic Project option.
 If you are using Office 2007 and Office 2010, click the Microsoft Office button to access
Excel Option. Go to the Trust Center category and select Trust Center Settings. Select
the Macro Settings category, and check Trust access to the VBA project object model.
 For more information about Microsoft Office and service packs, refer to the Microsoft web
site (http://www.microsoft.com/).

Search Folders
Search Folder allows you to search for documents based on common properties such as
out-of-date status, approval, or documents that have been published to a certain contract in
integrated environment. You create a search folder by right-clicking the root model or a
folder in the Management Console or the Drawing Console and selecting New > Search
Folder.
After running the query defined for a search folder, you can perform such tasks as Update or
Publish as if you are working from the actual component for the documents.
The documents found by a search folder query are listed in the Detail View. You are able to
interact with the search folder documents just as if you were dealing with the actual components
that own the documents. Search folders can also be used for reports.

Drawings and Reports Reference Data Guide 51


The Management Console, Folders, and Components

Search Folder Shortcut Menu


Right-click a search folder component to display the shortcut menu.
Run Query
Runs the query specified by the search folder setup definition. If you have not run the search
folder Setup command, this command is not available.
Publish
Publishes a single document or all documents in the imported folder. This command is only
available if the model is registered with SmartPlant Foundation.
Update and Publish
Updates and immediately publishes a single document or all documents in the search folder.
This command is only available if the model is registered with SmartPlant Foundation.
Setup
Specifies the query to run for the search folder. For more information, see Setup (Search
Folder).
Setup for the search folder does not perform the individual setups for any of the
drawing by query documents found in the search folder query and shown in the detail view.
Copy
Copies the search folder. It does not copy the associated documents shown in the detail
view area. The search folder setup information is saved with the copy. After you paste the
copy to a different location in the Console hierarchy, you can run Setup again as needed
for the new search folder.
Delete
Deletes the search folder. It does not delete any of the documents found in the associated
detail view.
Rename
Renames the search folder. It does not affect any of the documents found in the associated
detail view.
Revise
Allows you to revise all documents in the search folder without publishing them. This
command is only available if the model is registered with SmartPlant Foundation. For more
information, see Revise.
Save Package
Allows you to save the search folder and its definition as a package to be reused in other
folder locations in the hierarchy. If you have not run the search folder Setup command, this
command is not available.
Properties
Displays the Configuration Properties for the document.

Drawings and Reports Reference Data Guide 52


The Management Console, Folders, and Components

To change properties on the document, go to the root location of the document.


The search folder does not participate in any propagation of properties to its documents.

 After a search folder is placed in the console, it follows the same localized naming
convention as a folder, such as "New Search Folder" and "New Search Folder (2)."

 Unlike a folder , you cannot create child components in a search folder . This includes
pasting existing components; however, you can copy the search folder and paste it
elsewhere in the hierarchy.
 Performing Publish, Update and Publish, and Revise on a folder does not include
documents under a child search folder. The commands need to be performed separately on
the child search folder in order for its documents to be affected.
You can run commands from the search folder level to modify all of the documents within the
folder, or you can modify the individual documents by selecting them in the Detail View.

Volume Drawings
The Volume Drawing component uses a template to create drawings. You can place a view
on the template and associate the view with a view style to control the output. To define the
contents of the view, you create a drawing volume in the model. Before you create these types
of drawings, an administrator should create or edit drawing view styles and templates for use
with the drawings. For example, you can place title block labels and reports on the templates to
reflect your project or company standards.
After you have your view styles and templates in place, you are ready to start creating drawings.
The volume drawings require that the changes occur within the drawing template.
The software allows you to place several views on a template, each with independent scale. In
the Space Management task, you can place a volume, which is associated to single or multiple
views. The volume you create in Space Management is associated with all the views you create
within a volume drawing template. Therefore, in a multiple view volume drawing, you can have
multiple views of the same volume, and each view specifies the style, scale, and orientation for
the volume associated with the view. If the volume you create is too big for a particular view at
its scale, the volume is clipped.
For example, if you place two views in a drawing template with the following property settings:
 DrawingView1 - Size 6" x 6", Scale 1" = 1', and Orientation = Plan
 DrawingView2 - Size 6" x 6", Scale 1" = 1', and Orientation = North,
you use the Place Volume By 2-Points command in the Space Management task from
coordinates (0,0,0) to (6,6,6). In this case, the volume is exactly the right size based on scale
and orientation. The generated drawing contains the complete contents of the volume.
However, if your volume was placed from (0,0,0) to (8,6,6), the volume is too big for the drawing
view on the template. The maximum volume size the view can accommodate is no more than 6
inches on each side. The software centers the volume in the drawing view, effectively giving you
the information from (1,0,0) to <7,6,6 in the output drawing.
The overall processing for volume drawings is as follows:

Drawings and Reports Reference Data Guide 53


The Management Console, Folders, and Components

 Identify a drawing volume. This is a query of all the objects that have been created in the
database which reside inside the volume borders. The objects do not have to be visible or
even in the current workspace to be included.
 When the drawing is created, the software checks the objects from the volume query
against the list of filters in the specified view style.
 If an object in the volume matches one of the specified view style filters, the software applies
the rules set for the object filter. If the object does not match a filter, it is not included in the
drawing view.
The following conceptual graphic shows the workflow for creating volume drawings:

The software applies the view styles in a top-down manner. If an object finds its match in several
filters, the last one applied (the bottommost style) overrides any preceding style rules.
When a drawing is updated, it can be published by right-clicking the document and selecting
Publish on the right-click menu. The document is published as a viewable graphic file; no
physical data is published. For more information, see Publishing Documents in any of the Smart
3D Drawings user's guides, available from Help > Printable Guides.

Drawings and Reports Reference Data Guide 54


SECTION 2

Tools Menu
Several tools are provided within the Drawings and Reports task. These tools display on the
Tools menu in the Drawings and Reports task.

Reference Data Tools


The following commands on the Tools menu are for use by your reference data administrator.
They apply strictly to customizing orthographic drawing and marine mode drawings by rule
reference data:
 Define View Style
 Define Layout Style
 Edit Border Template
 Edit Layout Template
You do not use these commands in the normal workflow of creating drawings and reports. For
more information, see the Drawings and Reports Reference Data Guide.

Other Tools
You can use the Custom Command tool to set up special macro commands you use in your
documents. Batch Management processes drawing updates and printing on a batch server.
Convert Legacy Snapshots converts legacy version 6.1 snapshot drawings to composed
drawings. For more information, see the Orthographic Drawings User's Guide.

In This Section
Define View Style Command (Tools Menu) ................................... 56
Define Layout Style Command (Tools Menu) ................................ 145
Edit Border Template Command (Tools Menu) ............................. 149
Edit Layout Template Command (Tools Menu) ............................. 152
Custom Commands ....................................................................... 156

Drawings and Reports Reference Data Guide 55


Tools Menu

Define View Style Command (Tools Menu)


Defines drawing view and key plan styles for drawings and MicroStation 3D DGN documents
and defines rule set view styles to use with marine mode drawings by rule components and
packages. This command displays the Define View Style dialog box, which lists the available
styles.
Each drawing view and MicroStation 3D DGN document in the software has an associated view
style and can have a key plan style. A view style contains several rules for filtering, labeling, and
creating the graphics in the output document. The key plan style specifies the rules used to
define the appearance of the key plan associated to a drawing view.
Rule set view styles define the style information for drawings created using a marine mode
drawings by rule component.

Define View Style Dialog Box (on page 58)

Defining Filters for View Styles


You can set up the filters for styles by using File > Define Workspace or Tools > Select by
Filter in any 3D task. One way to organize the drawing filters is by discipline, such as Piping,
Equipment, or Structure. You can also define filters within the View Style Properties dialog box
by selecting More in the Filter dropdown.
For more information, see Select Filter Dialog Box (on page 143) in the Common User's Guide.

Defining View Styles for Drawing Views


For orthographic drawings, you can create and edit view styles using Tools > Define View
Style. For Isogen isometric drawings, you can modify drawing output using the Isometric Style
Options Browser dialog box.
The software comes with default view styles for a number of drawing types. These view styles
can be used as delivered, or copied and modified to suit your needs.
You can change the order of the rows on the View Style Properties dialog box by selecting a
row and then clicking the up and down arrows on the left side of the dialog box. The software
applies the graphic rules in a top-down manner. If an object finds its match in several filters, the
last graphic rule applied (the bottommost style) overrides any preceding graphic rules. Label
rules and dimension rules accumulate.

Defining Styles for Key Plans


The Tools > Define View Style command also allows you to create and maintain styles for key
plans you place within a drawing. The key plan style uses an existing drawing view style to
define the appearance of the key plan. You can create three different types of key plan styles:
One Volume with Model View, Natural Volumes Only, and Normalized Volumes Only.

Defining Marine Rule Set View Styles


Within a marine mode drawings by rule component or package, you can have multiple view
types. Each view type can have many view styles. You create the view styles from valid rule
sets available in the catalog. You can create multiple view styles from a single rule set. You then

Drawings and Reports Reference Data Guide 56


Tools Menu

specify the view style to use when creating a drawing view of a particular view type within a
drawing by rule component or package.
With regard to the graphic rules specified as part of the view style properties, the
software honors only the last aspect applied.
See Also
Create a Rule Set View Style (on page 135)

View Style Rules


View styles consist of tests and actions. One of the tests must be a filter, and the actions are
rules that control the drawing results. Each rule is an XML file, which is used as an input to the
view style XML file. The rule XML files are located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules folder.

Graphic Rules
Graphic rules control the representation of the model graphics on drawings. For example, you
can represent pipe runs as single lines while representing equipment as control point symbols.
You can also resymbolize structural members as single lines with detailed widgets placed along
the lines. To specify the resymbolization, you create a custom symbol and incorporate the
symbol into a graphic rule for a view style. For more information, see Graphic Rules (on page
725).

Label Rules
Label rules control automatic label placement on drawings. For more information, see Labels
(on page 740).
Before creating a new label rule, you must first create the label query using the
Define Label command in the Catalog task. For more information, see Label Editor.

Dimension Rules
Dimension rules control the placement of dimensions while dimension styles control the
appearance, including the units, of dimensions on orthographic drawings. You can specify the
granularity, offsets, style, text size, and object types for the dimensions. For more information,
see Dimensions (on page 679). For more information on working with dimensions, see
Dimensions in the Orthographic Drawings User's Guide.

View Rules
The view rules use properties to define how objects are associated to a drawing view. For more
information, see View Rules (on page 935).

Matchline Rules
The matchline rule uses labels to specify the drawing extents and the names of adjoining
drawings. For more information, see Matchline Rules (on page 932).

North Arrow Rules


The north arrow rule uses a label to specify the direction toward north on drawings. For more
information, see North Arrow Rules (on page 934).

Drawings and Reports Reference Data Guide 57


Tools Menu

The drawing dimension and label rules are discussed further in the Intergraph
SmartTM 3D Programmer's Guide under Extending the Capabilities of the Software. Contact your
administrator or Intergraph Support if you need the Intergraph SmartTM 3D Programmer's Guide.
You can find support information on our web site http://support.intergraph.com
(http://support.intergraph.com/).
See Also
Define View Style Command (Tools Menu) (on page 56)
Create an Orthographic Drawing View Style (on page 87)

Define View Style Dialog Box


Defines and edits view styles for drawings and MicroStation 3D DGN documents. You can open
this dialog box by clicking Tools > Define View Style. When you create view styles, the
software stores them as files in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules folder.
View Style Type
Specifies a type of view style. The selected view style filters the hierarchy with the available
styles found in the SharedContent folder. The following view styles types are delivered:
 Key Plan - For more information, see Key Plan View Styles (on page 373).
 Orthographic - Orthographic and isometric view styles. For more information, see
Orthographic and Key Plan View Styles (on page 370).
 Ruleset Styles (Marine mode only) - Drawings by Rule styles. For more information,
see Drawings by Rule View Styles (on page 167).
 Spatial - Orthographic view styles specific to Smart 3D drawings. For more information,
see Orthographic and Key Plan View Styles (on page 370).
New Style
Adds a new view style to the selected folder.
Delete
Deletes the selected style from the hierarchy and removes it from the folder.

Rename
Renames the selected view style.
Properties
Displays the properties for the selected View Style Type for editing:
 For Key Plan properties, see Key Plan Style Dialog Box (on page 140).
 For Orthographic properties, see View Style Properties Dialog Box (on page 59).
 For marine mode rule set styles, see Edit Ruleset View Style Dialog Box (on page
118).
Close
Dismisses the dialog box.

Drawings and Reports Reference Data Guide 58


Tools Menu

View Style Properties Dialog Box


Defines view styles for orthographic drawings and MicroStation 3D .dgn documents. You can
open this dialog box from the Select View Style dialog box by selecting Orthographic or
Spatial in the View Style Type box, selecting a view style from the list, and then clicking
Properties.
If you are editing the properties of an existing view style, the current properties display. If this is
a new view style, all the fields are blank.

View Style Name


Specifies the name of the view style. The view style name can contain up to 128 characters.
If you are creating a new view style, you must type a new name.
Smart 3D does not support special characters such as $, #, =, /, or \ in the view
style name.
Description
Describes the view style.

View Style Settings


Lists graphic preparation rules and resolution settings for intersections between objects. This
section also lists tests and actions for the view style. Each row in the grid must contain a filter. If
all the tests in a row are true, then the software executes the actions in that row.
Filter Behavior
Specifies the content behavior for the objects returned by the selected filters when a
drawing view is created. The options are as follows:
 Filters determine which objects are processed (Volume) - Specifies that all objects
inside the volume run through the view style, regardless of workspace and show/hide
settings. The items that match a filter in the view style display in the drawing with the

Drawings and Reports Reference Data Guide 59


Tools Menu

appropriate rules applied. Items that do not match a filter are not included in the
drawing.
 Filters provide overrides to set of objects (Snapshot) - Indicates that a list of objects
(that is, a combination of the workspace and the show/hide settings at the time you
created the snapshot drawing volume) run through the view style. The items that match
a filter in the view style display in the drawing with the appropriate rules applied. Items
that do not match a filter are included in the drawing with a basic Visible Hidden Line
(VHL) style applied.
Graphic Preparation Rules
Specifies or defines a graphic preparation rule. One rule might contain several modules (.dll
files). A module can replace the three-dimensional graphics shown in the model workspace
with other three-dimensional graphics for the drawing. Press F12 to display the Custom
Graphic Rule dialog box to edit the rule. Click More in the field to select any rule. For more
information, see Select Graphic Preparation Rule Dialog Box (on page 67) and Create or
Edit a Graphic Preparation Rule (on page 91). For more information on the graphic rule files
delivered with the product, see Custom Graphic Modules (on page 972).
Intersection Edges
Creates lines where surfaces intersect each other. At High Resolution, Smart 3D displays
more detail in the drawing by creating lines between all intersecting surfaces. At Low
Resolution, Smart 3D displays less detail by omitting the b-spline properties. For example,
changing from Off to High Resolution would produce the following effect for your graphics:

Using High Resolution increases the drawing generation time.


Preserve Z Order
Maintains the three-dimensional order of resymbolized graphics. This setting overrides the
top-down ordering in the view style for the graphic rules. For example, pipe gaps display
according to their layering in the 3D model. A cleaner-looking drawing results if this option is
selected.

Row Numbers
Display the order of the filters in the table. These numbers make it easier to find filters in the
table.

Drawings and Reports Reference Data Guide 60


Tools Menu

Filter Name
Specifies a filter in the current model. If you know the name, you can type it directly into the
box. If you know part of the name, you can use * as a wild card character. For example, to
find names starting with Equipment, type Equipment*. To find names that contain (but do
not start with) Equipment, type *Equipment. The software automatically adjusts the width of
the list to display the full name. Click More to choose existing filters or define new filters.
Press CTRL+C to copy and CTRL+V to paste filters from one cell to another.
Smart 3D supports asking or parameterized filters only when they are asking for a
WBS Project.
These custom tests are used with orthographic view styles for outfitting drawings and
drawings by rule styles for scantling drawings.
Primary Orientation
Displays the orientation of the primary linear axis of an object with respect to the drawing
view. The primary linear axis is along the x-axis of the local coordinate system.

Secondary Orientation
Displays the orientation of the secondary linear axis of an object with respect to the drawing
view. The secondary linear axis is along the y-axis of the local coordinate system. For
members, this corresponds to the web orientation.

Primary Orientation and Secondary Orientation use the same options to display the model
with respect to the drawing view.
The options that specify a direction (for example, Normal, toward you) are
specialized orientations. They are most commonly used for steel members and pipes that have
an air or liquid flow.
Normal
 Normal, toward you

Drawings and Reports Reference Data Guide 61


Tools Menu

 Normal, away from you

Sloped
 Sloped, toward you
 Sloped, away from you
 Sloped, projects horizontal
 Sloped, projects vertical
The example below, from left to right, shows pipes with the orientations Sloped, projects
horizontal, Sloped, projects vertical, and Sloped.

The Sloped, projects horizontal and Sloped, projects vertical options provide special
orientations for situations in which the drawing needs to distinguish between a sloped pipe or
member that projects orthogonally on the sheet and those that project non-orthogonally on the
sheet. For example, you may prefer orthogonally-projected pipe be dimensioned in the drawing
with the pipes that are parallel and orthogonal to the sheet. The following graphic shows
examples of a 3D model with pipe for both cases:

Drawings and Reports Reference Data Guide 62


Tools Menu

1 This pipe is sloped in the 3D space of the model,


but projects using the Sloped, projects horizontal
primary orientation. The view style specifies that the
dimensions for the pipe are handled the same as
the actual parallel, horizontal, and vertical pipe in
the view.

2 This pipe is sloped in the 3D space of the model,


but uses the Sloped primary orientation and does
not project horizontally or vertically. The view style
distinguishes between this pipe and pipe 1.

3 These pipes are parallel and horizontal or vertical to


the view, and use the Parallel, horizontal and
Parallel, vertical primary orientations.

Parallel
 Parallel, vertical
 Parallel, pointing up
 Parallel, pointing down
 Parallel, horizontal
 Parallel, pointing right
 Parallel, pointing left
 Parallel, sloped

The following graphic shows an example for members:

1 This target member has a primary orientation of


Parallel, vertical and a secondary orientation of
Parallel, horizontal.

Drawings and Reports Reference Data Guide 63


Tools Menu

2 This non-target member has a primary orientation of


Normal, toward you and a secondary orientation of
Parallel, horizontal.

For dimensioning purposes in the drawing view, the Parallel, horizontal and Sloped, projects
horizontal pipes are part of the same dimensioning chain. The Sloped pipe is not included in
the dimensioning.

You can resymbolize the model graphics based on special orientation cases. For
example, you might want to represent piping items that are parallel to the sheet plane as single
lines, while representing the items coming straight out of the sheet as special symbols.
Clipping
Lists the various clipping options. For example, you might want to put a cap on a pipe that is
clipped to the right of the sheet.
Use the Clipped option when testing for objects that are clipped by one of the sides (Top,
Bottom, Right, or Left) of the volume. Dimensioning pipe that is clipped by the volume can
take advantage of this option setting.
Use the Not Clipped option to test for objects that are not clipped at all.
The Clipped and Not Clipped options ignore front and back clipping.

Drawings and Reports Reference Data Guide 64


Tools Menu

The following picture illustrates the various clipping options - Left, Right, Front, Back, Top,
and Bottom.

Graphic Rule
Determines how objects passing the tests display. Objects can be displayed as Vector
Hidden Line (VHL) or resymbolized. If you know the name, you can type it directly into the
box. If you know part of the name, you can use the asterisk (*) as a wild card character. For
example, to find rules starting with Equipment, type Equipment*. To find rules that contain
(but do not start with) Equipment, type *Equipment. The software automatically adjusts the
width of the list to display the full name. Press F12 to display the Graphic Rule - VHL dialog
box to edit the rule. Click More to open the Select Graphic Rule dialog box and define a
new graphic rule. For more information, see Select Graphic Rule Dialog Box (on page 68)
and Graphic Rules (on page 725).
Label Rule
Determines how objects passing the tests are labeled. If you know the name, you can type it
directly into the box. If you know part of the name, you can use the asterisk (*) as a wild card
character. For example, to find rules starting with Equipment, type Equipment*. To find
rules that contain (but do not start with) Equipment, type *Equipment. The software
automatically adjusts the width of the list to display the full name. Press F12 to display the
Label Rule Manager dialog box to edit the rule. Click More to open the Select Label Rule
dialog box and define a label rule. For more information, see Select Label Rule Dialog Box
(on page 84) and Labels (on page 740). For information on using bubble labels in your
drawings, see Use Bubble Labels in Drawings (on page 115).
Dimension Rule
Determines the placement of dimensions on objects passing the tests. If you know the
name, you can type it directly into the box. If you know part of the name, you can use the
asterisk (*) as a wild card character. For example, to find rules starting with Equipment, type
Equipment*. To find rules that contain (but do not start with) Equipment, type *Equipment.

Drawings and Reports Reference Data Guide 65


Tools Menu

The software automatically adjusts the width of the list to display the full name. Press F12 to
display the Dimension Rule Manager dialog box to edit the rule. For more information, see
Dimension Rule Manager (on page 1503). Click More to open the Select Dimension Rule
dialog box and define a dimension rule. For more information, see Select Dimension Rule
Dialog Box (on page 85) and Dimensions (on page 679).
Move Up and Move Down
Moves the selected rows up or down in the display. This allows you to group similar items so
that they are easier to find and use. You can also move multiple adjacent rows up or down.
Select the rows to move. Then, click to move the selected rows up, or click to move
the selected rows down.

View Frame
This section provides additional view frame properties you can set within the view style.
View Rule
Identifies the view frame rule to use for detail and section views within the drawing. Press
F12 to display the View Frame Rule dialog box to edit the rule. Click More in the list to
select a view rule, modify an existing rule, or create a new rule. For more information, see
View Rules (on page 935).

Matchline Rule
Provides a selectable list of delivered matchline labels. Press F12 to display the Matchline
Rule Manager dialog box to edit the rule. Click More in the field to select a matchline rule.
For more information, see Matchline Rules (on page 932).
North Arrow Rule
Provides a selectable list of delivered north arrow labels. Press F12 to display the North
Arrow Rule Manager dialog box to edit the rule. Click More in the field to select a north
arrow label. For more information, see North Arrow Rules (on page 934).
Copy and Insert Row
Duplicates the selected row. You can then edit the new row. This option is available only
when you have a single row selected.

Drawings and Reports Reference Data Guide 66


Tools Menu

Clear All
Removes all data in the grid, but not the name or description of the view style.

 You can change the order of the rows on the View Style Properties dialog box by
selecting a row and then clicking the up and down arrows at the left side of the dialog
box. If an object finds its match in several different filters, the last graphic rule applied
(bottommost row) is used.
 To delete a row from the table, select the row and press DELETE on the keyboard.
 If any text string is longer than the width of its box on the grid, a ToolTip provides the
entire string.
See Also
Create an Orthographic Drawing View Style (on page 87)
Define View Style Command (Tools Menu) (on page 56)

Select Graphic Preparation Rule Dialog Box


Lists the available graphic preparation rules. You can open this dialog box by clicking More in
the Graphic Preparation Rules box on the View Style Properties dialog box.
Views
Switches the view from List to Details. When you choose the List mode, descriptions of
each rule do not display.
Rule Name
Lists the names of the graphic rules. For more information, see Graphic Preparation Rules
(on page 959).
Description
Lists the descriptions of the graphic rules.
New
Creates a new graphic rule of the selected type.
Rename
Renames the selected graphic rule.
Delete
Deletes the selected graphic rule.
Properties
Displays the properties for the selected graphic rule for editing.
When you create a new custom rule or edit the properties for an existing rule, the Custom
Graphic Rule dialog box displays. For more information, see Custom Graphic Rule Dialog Box
(on page 68).
See Also
Create or Edit a Graphic Preparation Rule (on page 91)
View Style Properties Dialog Box (on page 59)

Drawings and Reports Reference Data Guide 67


Tools Menu

Custom Graphic Rule Dialog Box


Sets options for a custom graphic preparation rule.
Rule Name
Specifies the name of the custom graphic rule. For more information, see Custom Graphic
Modules (on page 972).
Description
Describes the rule.
Filter Name
Specifies a filter. The filter sets the criteria to meet for the custom rule to be applied.
Custom Module
Specifies the module (a .dll file) that contains the changes you want to incorporate to objects
meeting the criteria determined by the filter.
See Also
Create or Edit a Graphic Preparation Rule (on page 91)
View Style Properties Dialog Box (on page 59)
Select Graphic Preparation Rule Dialog Box (on page 67)

Select Graphic Rule Dialog Box


Lists the available graphic rules. You can open this dialog box by clicking More in the Graphic
Rule box on the View Style Properties dialog box.
Graphic Rule Type
Specifies a type of graphic rule. The rule types available include the following:
 Visible/Hidden Lines (VHL) - Creates a wireframe representation of objects, where just
the outline of the object is drawn.

Drawings and Reports Reference Data Guide 68


Tools Menu

 Replace Objects with Line - Replaces objects, such as pipes, with lines.

 Replace Objects with Line and Widget - Replaces objects, such as structural
members, with a line plus widget combination.

 Replace Objects with Symbol - Replaces objects with symbols.

If the replacing symbol only contains a text box element, label leaders may
become detached from the symbol. To avoid this problem, we recommend adding a point
element at the origin of the symbol.

Drawings and Reports Reference Data Guide 69


Tools Menu

Views
Switches the view from List to Details. When you choose List mode, descriptions of each
rule do not display.
Rule Name
Lists the names of the graphic rules applicable within the selected rule type.
Description
Lists the descriptions of the graphic rules.
New
Creates a new graphic rule of the selected type.
Rename
Renames the selected graphic rule.
Delete
Deletes the selected graphic rule.
Properties
Displays the properties for the selected graphic rule for editing. Each rule type displays a
dialog box with specific properties:
 Graphic Rule - VHL Dialog Box (on page 71)
 Graphic Rule - Line Dialog Box (on page 76)
 Graphic Rule - Line with Widget Dialog Box (on page 78)
 Graphic Rule - Symbol Dialog Box (on page 82)
See Also
View Style Properties Dialog Box (on page 59)
Graphic Rules (on page 725)

Drawings and Reports Reference Data Guide 70


Tools Menu

Graphic Rule - VHL Dialog Box


Sets options for a specific Visible/Hidden Lines (VHL) graphic rule. The VHL graphic rules
create a wireframe representation of objects, where just the outline of the object is drawn. You
can open this dialog box in the Select Graphic Rule dialog box by selecting Visible/Hidden
Lines (VHL) in the Graphic Rule Type box and clicking Properties.

Rule Name
Specifies the name of the graphic rule. The rule name can be up to 128 characters long.
Description
Describes the rule.
Aspect
Provides a list of available aspects that can be resymbolized independently. For example,
you might have pipes that use an insulation aspect, and you want both the pipe and its
insulation symbolized uniquely on the drawing. You can use this property on the VHL
graphics to resymbolize both the pipe and its insulation. For more information, see Apply
Symbology to Graphic Object Aspects (on page 106).
Show aspect
Specifies that you want to show the selectee aspect symbology for the selected objects
within the drawing. This option can be specified independently for each aspect.
Graphic Module
Specifies a module that allows you to customize the graphics included in your graphic rule.
For more information, see Custom Graphic Modules (on page 972).
For orthographic drawings, this module affects only those items that meet the
criteria of the filter on the selected row of the table in the View Style Properties dialog box.
To apply a module to all items in the view style, choose a Graphic Preparation Rule on the
View Style Properties dialog box.

Drawings and Reports Reference Data Guide 71


Tools Menu

Visible Line Style


Specifies the line style for visible edges of objects and for centerlines in the Centerline
aspect.
Hidden Line Style
Specifies the line style for edges of an object hidden by the surface of other objects and for
centerlines in the Centerline aspect. The line style is shown as dashed red in the example
below.

Hidden By Self Line Style


Specifies the line style for edges of an object that are hidden by the surface of the same
object and for centerlines in the Centerline aspect. The line style is shown as dashed red in
the example below.

Occluded Line Style


Specifies a line style when the line is aligned with and completely hidden by edges of
another object. For example, you may use this style when you have two objects that are
aligned but at different elevations. The line style is shown as dashed red behind the solid
black visible line in the example below.

Occluded lines are drawn but are frequently not visible because the visible line
style dominates.
Clipped Line Style
Specifies a line style for an object that is clipped by the drawing view. You can use this style
to distinguish between different clipped objects. For example, the following image shows a
clipped object with a Zig-Zag line style:

Layer
Specifies the drawing layer (or level, if saving to a MicroStation file) on which the graphic is

Drawings and Reports Reference Data Guide 72


Tools Menu

placed. For example, type LinesAndSymbols in the value field to place your VHL graphics
on the LinesAndSymbols layer of your drawing. If the layer does not already exist in the
template you are using to create drawings, the software creates the layer automatically.
For graphic rules used in the conversion to MicroStation files, the software
only recognizes whole numbers between 1 and 63, inclusive, in the Layer field. Other
values are ignored, and the object is placed on level 1 in the DGN file.
Visible Fill Style
Specifies the fill style for visible surfaces of objects within the clipped area of the view. Every
face of every instance of the objects matching the applied filter in the view style will have the
selected fill style. For an example workflow showing how fill styles can be applied, see Apply
a Visible Fill Style to a Drawing (on page 98). In the following graphic, everything that is a
slab (everything except the two barrels and the wall piece) has a Hexagon fill style applied.

Clipped Solid Fill Style


Specifies the fill style for clipped faces of objects that match the applied filter in the view
style. For more information, see Apply a Clipped Solid Fill Style to a Drawing (on page 101).
For example, the following graphic shows where a clipped wall surface is filled with a
Honeycomb fill style, while the underlying slab surfaces (also clipped) are not filled.

Make Clipped Solid Monolithic


When set to Yes, specifies that all solid objects assigned with this graphic rule are based on
the view style tests they passed (Filter, Orientation, Clipping) and that all of the objects in
each group are merged into a transient object. The software finds the intersection body or
contour of the transient object with the drawing volume. Only the intersection contour is
drawn and filled on the top of the constructing objects, masking out their common internal

Drawings and Reports Reference Data Guide 73


Tools Menu

edges. For more information, see Use the Make Clipped Solid Monolithic Option (on page
109).
Aspect (Multi-Select)
Specifies the envelope around the objects for VHL processing. Examples are maintenance
or insulation envelopes. You can select multiple aspects by holding the CTRL or SHIFT
keys. This setting is currently not supported.
Show Centerline
Specifies whether the centerline displays in addition to the 3D graphics. If you reset this
property to No, the Centerline Visible Line Style, Centerline Hidden Line Style, and
Centerline Extension boxes display <Not Drawn>.
Centerline Visible Line Style
Specifies the line style for a visible centerline.
Centerline Hidden Line Style
Specifies the line style for a hidden centerline.
Centerline Extension
Specifies the length of the extension at the ends of a centerline.

 Centerlines are only drawn on the appropriate types of geometry on equipment, such as
revolved surfaces, tori, cones, ruled surfaces with elliptical top and base curves, and
projections.
 Centerlines are drawn for all straight pipe, bent pipe, pipe nozzles, and HVAC nozzles.
Clipping
Indicates whether or not the graphics are clipped within the drawing. For example, in plan

Drawings and Reports Reference Data Guide 74


Tools Menu

views, certain objects such as stairs or ladders are best represented unclipped by the
drawing volume. You would specify a filter row in the view style for stairs or ladders and set
this option to unclipped to achieve the needed graphic representation.
Make Transparent
Specifies how transparency is applied to an aspect:
 No - The aspect will not be transparent.

 For all objects in view - Full transparency. The aspect of the object is transparent for
all other objects and all aspects of the same object (that is, it does not hide other objects
or aspects of the same object).

 For other aspects of same objects - Relative transparency between objects. The
aspect of the object is transparent only for other aspects of the same object (that is, the
given aspect does not hide other aspects for the same object, such as the flanges and
web of a built-up member, but hides other objects).

In orthographic view styles, the Make Transparent option is especially useful when you
need to show objects beneath another object. In drawings by rule view styles, the Make
Transparent option is only available for members. For example workflows, see Apply
Transparency to an Orthographic View Style (on page 103).
Tangent Edge Visible Line Style
Specifies the line style for visible tangent edges of objects.
There is not currently a separate property for specifying the line style of hidden
tangent edges. Smart 3D uses this property for any visible, hidden, occluded, or
self-occluded tangent edges.

 All line styles are found in the Styles.sha and IS Styles.sha file, located in the [Reference
Data Folder]\SharedContent\Drawings\Catalog\Templates folder. You can add new line
styles to this file.
 Drawing view styles work in a top-to-bottom priority order. If an object finds its match in
several different filters, the last graphic rule applied (bottommost row) is used.

Drawings and Reports Reference Data Guide 75


Tools Menu

 You can create new line styles to use with the properties on this dialog box. For more
information, see Create Line Styles to Use in Drawing View Styles (on page 89).
See Also
View Style Properties Dialog Box (on page 59)
Graphic Rules (on page 725)
Select Graphic Rule Dialog Box (on page 68)

Graphic Rule - Line Dialog Box


Sets options for a single line graphic rule. The single line graphic rules replace linear objects,
such as pipes and structural members, with single lines. If possible, the centerline of the object
is used. The graphic below shows pipes replaced with a blue line. You can open this dialog box
in the Select Graphic Rule dialog box by selecting Replace Objects with Line in the Graphic
Rule Type box and clicking Properties.

Rule Name
Specifies the name of the graphic rule. The rule name can be up to 128 characters long.
Description
Describes the rule.
Graphic Module
Specifies a module that allows you to customize the graphics included in your graphic rule.
For more information, see Custom Graphic Modules (on page 972).
For orthographic drawings, this module affects only those items that meet the
criteria of the filter on the selected row of the table in the View Style Properties dialog box.
To apply a module to all items in the view style, choose a Graphic Preparation Rule on the
View Style Properties dialog box.
Visible Line Style
Specifies the line style for visible edges of objects and for centerlines in the Centerline
aspect.
Hidden Line Style
Specifies the line style for edges of an object hidden by the surface of other objects and for
centerlines in the Centerline aspect. The line style is shown as dashed red in the example

Drawings and Reports Reference Data Guide 76


Tools Menu

below.

Occluded Line Style


Specifies a line style when the line is aligned with and completely hidden by edges of
another object. For example, you may use this style when you have two objects that are
aligned but at different elevations. The line style is shown as dashed red behind the solid
black visible line in the example below.

Occluded lines are drawn but are frequently not visible because the visible line
style dominates.
Layer
Specifies the drawing layer (or level, if saving to a MicroStation file) on which the graphic is
placed. For example, type LinesAndSymbols in the value field to place your line graphics
on the LinesAndSymbols layer of your drawing. If the layer does not already exist in the
template you are using to create drawings, the software creates the layer automatically.
For graphic rules used in the conversion to MicroStation files, the software
only recognizes whole numbers between 1 and 63, inclusive, in the Layer field. Other
values are ignored, and the object is placed on level 1 in the DGN file.

 Drawing view styles work in a top-to-bottom priority order. If an object finds its match in
several different filters, the last graphic rule applied (bottommost row) is used.
 All line styles are found in the Styles.sha and IS Styles.sha file, located in the [Reference
Data Folder]\SharedContent\Drawings\Catalog\Templates folder. You can add new line
styles to this file.
See Also
View Style Properties Dialog Box (on page 59)
Graphic Rules (on page 725)
Select Graphic Rule Dialog Box (on page 68)

Drawings and Reports Reference Data Guide 77


Tools Menu

Graphic Rule - Line with Widget Dialog Box


Sets options for a line with widget graphic rule. The line with widget graphic rules replace
objects, such as pipes, in the graphic view with a line plus widget combination. A widget is a
symbol placed at a user-defined spacing along the line. The graphic below shows a line plus
widget combination of a black line with a red rectangle widget. You can open this dialog box in
the Select Graphic Rule dialog box by selecting Replace Objects with Line and Widget in the
Graphic Rule Type box and clicking Properties.

Rule Name
Specifies the name of the graphic rule. The rule name can be up to 128 characters long.
Description
Describes the rule.
Graphics Tab (Graphic Rule - Line with Widget Dialog Box) (on page 78).
Widget Tab (Graphic Rule - Line with Widget Dialog Box) (on page 80).
See Also
View Style Properties Dialog Box (on page 59)
Graphic Rules (on page 725)
Select Graphic Rule Dialog Box (on page 68)

Graphics Tab (Graphic Rule - Line with Widget Dialog Box)


Sets line and fill style properties for a line with widget combination graphic rule. To set the
widget properties, go to the Widget Tab (Graphic Rule - Line with Widget Dialog Box) (on page
80).
Graphic Module
Specifies a module (.dll file) that allows you to customize the graphics included in your
graphic rule.
This module affects only those items that meet the criteria of the filter on the
selected row of the table in the View Style Properties dialog box. To apply a module to all
items in the view style, choose a Graphic Preparation Rule on the View Style Properties
dialog box.

Drawings and Reports Reference Data Guide 78


Tools Menu

Visible Line Style


Specifies the line style for visible edges of objects and for centerlines in the Centerline
aspect.
Hidden Line Style
Specifies the line style for edges of an object hidden by the surface of other objects and for
centerlines in the Centerline aspect. The line style is shown as dashed red in the example
below.

Occluded Line Style


Specifies a line style when the line is aligned with and completely hidden by edges of
another object. For example, you may use this style when you have two objects that are
aligned but at different elevations. The line style is shown as dashed red behind the solid
black visible line in the example below.

Occluded lines are drawn but are frequently not visible because the visible line
style dominates.
Layer
Indicates the drawing layer (or level, if saving to a MicroStation file) on which the graphic is
placed. For example, you would type LinesAndSymbols in the value field to place your
symbol graphics on the LinesAndSymbols layer of your drawing. If the layer does not
already exist in the template you are using to create drawings, the software creates the layer
automatically.
For graphic rules used in the conversion to MicroStation files, the software
only recognizes whole numbers between 1 and 63, inclusive, in the Layer field. Other
values are ignored and the object is placed on level 1 in the DGN file.

 Drawing view styles work in a top-to-bottom priority order. If an object finds its match in
several different filters, the last graphic rule applied (bottommost row) is used.
 All line styles are found in the Styles.sha and IS Styles.sha file, located in the [Reference
Data Folder]\SharedContent\Drawings\Catalog\Templates folder. You can add new line
styles to this file.

Drawings and Reports Reference Data Guide 79


Tools Menu

Widget Tab (Graphic Rule - Line with Widget Dialog Box)


Sets options for widgets (symbols) on a line for the line plus widget combination graphic rule. To
set the line and fill style properties, go to the Graphics Tab (Graphic Rule - Line with Widget
Dialog Box) (on page 78).
Widget Graphics
Specifies whether an aspect or symbol should be used as part of the graphic rule.

Aspect Properties
Aspect (Multi-Select)
Specifies one or more envelopes to display around objects. You can select multiple aspects
by holding the CTRL or SHIFT keys.
Aspect Length (%)
Sets the length of the aspect as a percentage of the line on which it is placed.
Aspect Height (%)
Sets the height of the aspect as a percentage of the height of the object.
Widget Position (% along object)
Sets the positioning of the widget as a percentage of total length from the start of the line.
Visible Line Style
Specifies the line style for visible edges of the aspect.
Hidden By Self Line Style
Specifies the line style for edges of an aspect that are hidden by itself.
Layer
Indicates the drawing layer (or level, if saving to a MicroStation file) on which the graphic is
placed. For example, you would type LinesAndSymbols in the value field to place your
symbol graphics on the LinesAndSymbols layer of your drawing. If the layer does not
already exist in the template you are using to create drawings, the software creates the layer
automatically.
For graphic rules used in the conversion to MicroStation files, the software
only recognizes whole numbers between 1 and 63, inclusive, in the Layer field. Other
values are ignored, and the object is placed on level 1 in the DGN file.
Show Centerline
Specifies whether the centerline displays in addition to the 3D graphics. If you reset this
property to No, the Centerline Visible Line Style, Centerline Hidden Line Style, and
Centerline Extension boxes display <Not Drawn>.
Centerline Visible Line Style
Specifies the line style for a visible centerline.
Centerline Hidden Line Style
Specifies the line style for a hidden centerline.

Drawings and Reports Reference Data Guide 80


Tools Menu

Centerline Extension
Specifies the length of the extension at the ends of a centerline.

Symbol Properties
Symbol
Specifies a symbol file. You can click More to open the Choose Symbol dialog box.
Symbols are saved in the SharedContent share in the \Drawings\Catalog\Symbols folder.
For more information, see Choose Symbol Dialog Box (on page 84).
Widget Position (% along object)
Sets the positioning of the widget as a percentage of the total length from the start of the
line.
Layer
Indicates the drawing layer (or level, if saving to a MicroStation file) on which the graphic is
placed. For example, you would type LinesAndSymbols in the value field to place your
symbol graphics on the LinesAndSymbols layer of your drawing. If the layer does not
already exist in the template you are using to create drawings, the software creates the layer
automatically.
For graphic rules used in the conversion to MicroStation files, the software
only recognizes whole numbers between 1 and 63, inclusive, in the Layer field. Other
values are ignored and the object is placed on level 1 in the DGN file.
Show Centerline
Specifies whether the centerline displays in addition to the 3D graphics. If you reset this
property to No, the Centerline Visible Line Style, Centerline Hidden Line Style, and
Centerline Extension boxes display <Not Drawn>.
Centerline Visible Line Style
Specifies the line style for a visible centerline.
Centerline Hidden Line Style
Specifies the line style for a hidden centerline.
Centerline Extension
Specifies the length of the extension at the ends of a centerline.

 All line styles are found in the Styles.sha and IS Styles.sha file, located in the [Reference
Data Folder]\SharedContent\Drawings\Catalog\Templates folder. You can add new line
styles to this file.
 Drawing view styles work in a top-to-bottom priority order. If an object finds its match in
several different filters, the last graphic rule applied (bottommost row) is used.

Drawings and Reports Reference Data Guide 81


Tools Menu

Graphic Rule - Symbol Dialog Box


Specifies a symbol for a graphic rule. The symbol graphic rule replaces objects in the graphic
view with a symbol. You can open this dialog box in the Select Graphic Rule dialog box by
selecting Replace Objects with Symbol in the Graphic Rule Type box and clicking
Properties.

In the example below, an object is replaced by the symbol .

The symbol files are saved in the [Reference Data


Folder]\SharedContent\Drawings\Catalog\Symbols folder.
Rule Name
Names of the graphic rule. The rule name can be up to 128 characters long.
Description
Describes the rule.
Graphic Module
Specifies a module (.dll file) that allows you to customize the graphics included in your
graphic rule.
This module affects only those items that meet the criteria of the filter on the
selected row of the table in the View Style Properties dialog box. To apply a module to all
items in the view style, choose a Graphic Preparation Rule on the View Style Properties
dialog box.
Symbol
Specifies a symbol for objects that are visible. You can click More to open the Choose
Symbol dialog box. For more information, see Choose Symbol Dialog Box (on page 84).

Drawings and Reports Reference Data Guide 82


Tools Menu

When selecting a symbol to replace an object, you can set the symbol as scalable.
To achieve this, open the symbol in SmartSketch Drawing Editor. Define the variable in the
symbol, and map the name of a label to the symbol so that the symbol receives the scale
variable from the 3D model. For example, the symbol FrontClipPipe1.sym specifies the OPD
variable, which calls the label OPD.rtp from the [Reference Data
Folder]\SharedContent\Reports\Templates\DrawingsReports\SymbolParameters folder.

When the software replaces the objects with the FrontClipPipe1 symbol, it evaluates the
OPD label for the object being replaced, then takes the value returned and uses it to scale
the 2D symbol in the drawing view.

Hidden Object Symbol


Specifies a symbol for objects that are hidden.
Layer
Indicates the drawing layer (or level, if saving to a MicroStation file) on which the graphic is
placed. For example, you would type LinesAndSymbols in the value field to place your
symbol graphics on the LinesAndSymbols layer of your drawing. If the layer does not
already exist in the template you are using to create drawings, the software creates the layer
automatically.
For graphic rules used in the conversion to MicroStation files, the software
only recognizes whole numbers between 1 and 63, inclusive, in the Layer field. Other
values are ignored and the object is placed on level 1 in the DGN file.

Drawings and Reports Reference Data Guide 83


Tools Menu

Orientation
Sets the orientation behavior for the symbol. Set the value to Fixed Orientation - Upwards
to always have the symbol orientation in the upward direction on the drawing. Set the value
to Orients as Replaced Object Did to set the symbol orientation to match the replaced
graphic object orientation.
Drawing view styles work in a top-to-bottom priority order. If an object finds its match
in several different filters, the last graphic rule applied (bottommost row) is used.
See Also
View Style Properties Dialog Box (on page 59)
Graphic Rule - Line with Widget Dialog Box (on page 78)
Graphic Rules (on page 725)
Select Graphic Rule Dialog Box (on page 68)

Choose Symbol Dialog Box


Specifies a symbol for the replace with symbol and replace with line and widget graphic rule
types.
You can open this dialog box in two ways:
 Select More in the Symbol or Hidden Object Symbol fields on the Graphic Rules -
Symbols dialog box. For more information, see Graphic Rule - Symbol Dialog Box (on page
82).
 Select More in the Symbol field on the Widget tab of the Line with Widget dialog box. For
more information, see Widget Tab (Graphic Rule - Line with Widget Dialog Box) (on page
80).
Symbol
Shows a hierarchical list of available symbols from the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Symbols folder. Select a symbol from the list and
click OK to return to the previous dialog box.
See Also
View Style Properties Dialog Box (on page 59)
Graphic Rules (on page 725)
Select Graphic Rule Dialog Box (on page 68)

Select Label Rule Dialog Box


Lists the available label rules. You can open this dialog box by clicking More in the Label Rule
field on the View Style Properties dialog box. You can also open this dialog box from the
Matchline Label or North Arrow Label lists.
Views
Switches the view from List to Details. When you choose the List mode, descriptions of
each rule do not display.
Rule Name
Lists the names of the rules.
Description
Lists the descriptions of the rules.

Drawings and Reports Reference Data Guide 84


Tools Menu

New
Creates a new rule. This option is not currently available.
Rename
Renames the selected rule. This option is not currently available.
Copy
Allows you to copy a label rule. For more information, see Copy a Rule (on page 86).
Delete
Deletes the selected rule.
Properties
Allows you to edit the properties for the selected rule. Properties launches the Label Rule
Manager, from which you can select options for each property that you apply to the selected
label rule. For more information, see Launch Label Rule Manager (Orthographic Drawings)
(on page 1099).
See Also
Label Rule Manager (on page 1099)
Copy a Rule (on page 86)
View Style Properties Dialog Box (on page 59)
Labels (on page 740)

Select Dimension Rule Dialog Box


Lists the available dimension rules. You can open this dialog box by clicking More in the
Dimension Rule box on the View Style Properties dialog box.
Views
Switches the view from List to Details. When you choose the List mode, descriptions of
each rule do not display.
Rule Name
Lists the names of the rules. For more information, see Use Dimension Rules in the
Orthographic Drawings User's Guide, available from Help > Printable Guides.
Description
Lists the descriptions of the rules.
New
Creates a new rule. This option is not currently available.
Rename
Renames the selected rule. This option is not currently available.
Delete
Deletes the selected rule.
Properties
Opens the Dimension Rule Manager, where you edit the properties for the selected rule.
This option is not currently available.

Drawings and Reports Reference Data Guide 85


Tools Menu

See Also
View Style Properties Dialog Box (on page 59)
Dimension Rule Manager (on page 1503)

Copy a Rule
Copy a Simple Label, North Arrow, or Dimension Rule
A simple rule only has one template, and may have a single symbol file and a single
report file.
1. In the Select [Label or Dimension] Rule dialog box, select the label, north arrow, or
dimension rule to copy.
2. Click Copy.
The Copy [Label, North Arrow, or Dimension] Rule dialog box displays.
3. Type the name for the new rule in the Change Rule Name box.
Rule names do not support any character not supported by your operating
system.
The software displays all affected files in the View Changes pane and dynamically updates
the file names as you type.
4. Click Copy.
The software returns you to the Select (Label or Dimension) Rule dialog box with the
newly copied rule selected.

Copy a Compound Label, Matchline, or North Arrow Rule


A compound rule can have multiple templates and can be associated with multiple
symbol and report files.
1. In the Select Label Rule dialog box, select the label, matchline, or north arrow rule to copy.
2. Click Copy.
The Copy [Label, Matchline, or North Arrow] Rule dialog box displays.
3. Click Add Prefix or Add Suffix.
—OR—
Select both options to add a prefix and a suffix to the rule name.
The software populates the Change Rule Name box with the existing name and positions
the cursor according to your selection.
4. Type to add the prefix or suffix to the rule name.
Rule names do not support any character not supported by your operating
system.
The software displays all affected files in the View Changes display and dynamically
updates the file names as you type.
5. Click Copy.
The software returns you to the Select Label Rule dialog box with the newly copied rule

Drawings and Reports Reference Data Guide 86


Tools Menu

selected.

 You cannot copy a template if you do not have certain permissions. For example, if you do
not have write permissions to the Labels\Templates folder or the Dimensions\Templates
folder, then an error message displays, and the command exits.
 If the software cannot copy a label, matchline, north arrow, or dimension rule, an error
message displays and the command exits. Copy errors can occur in the following situations:
 The rule contains a template that is missing from disk.
 The rule contains one or more templates with XML errors.
 If you are copying a label associated with a formatting file (.rfm) that references a formatting
parameter file (.rfp), the .rfm and .rfp file prefixes must be identical. Otherwise, the software
does not copy the .rfp file, and the new label continues to reference the original .rfp file.
See Also
Label Rule Manager (on page 1099)
Dimension Rule Manager (on page 1503)

Create an Orthographic Drawing View Style


The following procedure steps you through creating an orthographic drawing view style with the
Tools > Define View Style command.
1. Select Tools > Define View Style. The Define View Style dialog box displays. For more
information, see Define View Style Dialog Box (on page 58).
2. In the View Style Type box, select the Orthographic view style type.

3. Click New Style to create a new orthographic view style. Click Rename to change
the name of the new style.
4. Select the new orthographic view style, and click Properties to open the View Style
Properties dialog box. For more information, see View Style Properties Dialog Box (on
page 59).
5. In the View Style Name box, type the style name.
6. In the Description box, type an optional description of the style.
7. You can specify how the style rules are applied with regard to the objects found by the filter
by selecting a Filter Behavior.
8. Under Graphic Preparation Rule, select or define a rule, if necessary. The rule can contain
multiple modules (.dll files).
Create or Edit a Graphic Preparation Rule (on page 91)
9. Specify the resolution in the Intersection Edges box.
10. Select the Preserve Z Order option if necessary. This option maintains the three-
dimensional order of the resymbolized graphics.
11. In the Filter Name column, select More to choose an existing filter or to create a new filter.
12. If necessary, select additional tests in the Primary Orientation, Secondary Orientation,
and Clipping columns.

Drawings and Reports Reference Data Guide 87


Tools Menu

13. In the Graphic Rule box, select an existing graphic rule or create a new graphic rule by
clicking More. Graphic rules control the line style and formatting of the output.
14. In the Label Rule box, select a labeling rule.
15. In the Dimension Rule box, select a dimension rule.
16. Select a matchline label, if applicable.
17. Select a north arrow label, if applicable.

 Test your view style by creating drawings. You can edit the view style with the Tools >
Define View Style command.
 The rules and associated files are saved in the SharedContent share in the
\Drawings\Catalog folder.
 You can change the order of the rows on the View Style Properties dialog box by selecting
a row and then clicking the up and down arrows at the left side of the dialog box. If an object
finds its match in several different filters, the last graphic rule applied (bottommost row)
takes precedence.
 To delete a row in the view style properties table, select the row, and press DELETE on the
keyboard.
See Also
Define View Style Command (Tools Menu) (on page 56)

Create a Key Plan View Style


The following procedure steps you through creating a key plan view style with the Tools >
Define View Style command.
1. Select Tools > Define View Style. The Define View Style dialog box displays. For more
information, see Define View Style Dialog Box (on page 58).
2. In the View Style Type box, select the Key Plan style type.

3. Click New Style to create a new key plan view style. Click Rename to change the
name of the new style.
4. Select the new style and click Properties to open the Key Plan Style dialog box. For
more information, see Key Plan Style Dialog Box (on page 140).
5. Specify a name and description for the new key plan view style.
6. Select a Key Plan Type. The list of available properties updates.
7. Select More for the Key Plan View Style property to display the Select View Style dialog
box.
8. Select the View Style Type.
9. Click New to display the View Style Properties dialog box.
10. In the View Style Name box, type the style name.
11. In the Description box, type a description of the style.

Drawings and Reports Reference Data Guide 88


Tools Menu

12. In the Filter Name box, select More to choose an existing filter or to create a new filter.

 To apply a style to the adjacent volume of the current drawing in the key plan, use the
term KEY_PLAN_ADJACENT_ELEMENT in the Filter column of the key plan view
style and then assign a graphic rule. You must use uppercase letters and underscores
as shown for the term.
 To apply a style to the volume of the current drawing in the key plan, use the term
KEY_PLAN_FOCUS_ELEMENT in the Filter column of the key plan view style and
then assign a graphic rule. You must use uppercase letters and underscores as shown
for the term.
13. In the Graphic Rule box, select an existing graphic rule, or create a new graphic rule by
clicking More.
14. In the Label Rule box, select a labeling rule, if applicable.
15. In the Dimension Rule box, select a dimension rule, if applicable.
16. Select a north arrow label, if applicable.

 A single drawing view can have multiple key plans.


 To delete a key plan style, select the style, and click Delete.
 Test your view style by creating drawings. You can edit the view style with the Tools >
Define View Style command.
 The rules and associated files are saved in the SharedContent share in the
\Drawings\Catalog folder.
 You can change the order of the rows on the View Style Properties dialog box by selecting
a row and then clicking the up and down arrows at the left side of the dialog box. If an object
finds its match in several different filters, the last graphic rule applied (bottommost row)
takes precedence.
 To delete a row in the view style properties table, select the row, and press DELETE on the
keyboard.
See Also
Define View Style Command (Tools Menu) (on page 56)

Create Line Styles to Use in Drawing View Styles


The following steps show you how to create new line styles in the SmartSketch Drawing Editor
and implement them in drawing view styles.
In plant mode, the lines styles used by drawing view styles are stored in the Styles.sha file in the
[Reference Data Folder]\SharedContent\Drawings\Catalog\templates\ folder. For drawings by
rule in marine mode and material handling mode, the lines styles used by drawing view styles
are stored in the ISStyles.sha file in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\templates\ folder.
To add line styles to this file, you need write permission to the file, as it is shared. If you do not
have write permission to the file, you will not be able to save changes you make to the file.
Contact your system administrator if you require write access to the file.

Drawings and Reports Reference Data Guide 89


Tools Menu

Create a New Line Style


For more information on commands available in SmartSketch Drawing Editor, see the
SmartSketch Drawing Editor Help.
1. Open the Styles.sha file (plant mode) or the ISStyles.sha file (marine mode or material
handling mode):
 Open SmartSketch Drawing Editor from the Start menu.
 Using File > Open, navigate to the location of the Styles.sha file or the ISStyles.sha file,
and open it.
2. In SmartSketch Drawing Editor, select Format > Style. The Style dialog box displays.
3. Change the Style type to Line, then click New to create a new line style.
4. On the New Line Style dialog box, name the new line style. For example, create a new line
style called AAA_Normal Dark Red.
5. In the Based on field, select a line style on which to base the new line style. For this
example, the base style is None, which applies the style settings Color=Black,
Weight=0.35 mm, Type=Dash Dot to the new line style.
6. Go to the General tab. Change the Color setting to Dk Red. Set the Width and Type
properties as needed.
7. Click OK to save the changes. The new line style displays in the Styles list on the Styles
dialog box. Click Close to exit the dialog box.
8. Select File > Save to save the Styles.sha file or the ISStyles.sha file with the new line style.
9. Exit SmartSketch Drawing Editor.

Implement a New Line Style in a Drawing View Style


For more information on creating view styles, see Define View Style Command (Tools Menu)
(on page 56).
1. In the Drawings and Reports task, select Tools > Define View Style. The Define View
Style dialog box displays.
2. Select an existing view style, and click Properties . This example uses the orthographic
Civil Plan view style. The dialog displayed depends on the type of view style selected. If
you select an orthographic view style, the View Style Properties dialog box displays. If you
are changing a key plan view style, the Key Plan Style dialog box displays. If you are
modifying a marine mode rule set view style, the Edit Ruleset View Style dialog box
displays.
3. With any view style type, you want to modify the Graphic Rule definition to use the new line
style. Select More in the Graphic Rule box to display the Select Graphic Rule dialog box.
4. Select an existing graphic rule from the list and click Properties to display the Graphic Rule
- VHL dialog box. You can select the Visible Line Style property, for example, and select
your new line style in the Value box. Click OK to modify the existing graphic rule, or you can
change the name in the Rule name field to save the changes to a new graphic rule name. If
you change the name, a confirmation dialog displays so that you can verify the graphic rule
action.

Drawings and Reports Reference Data Guide 90


Tools Menu

5. Use the modified or new graphic rule in the view style definition, and click OK to close the
dialog boxes. You can save the changes to the existing view style or change the name of
the view style. A confirmation dialog box displays so you can verify the view style action.
6. Use the modified or new view style to create drawings and verify the appearance of the new
line style.
See Also
View Style Properties Dialog Box (on page 59)
Key Plan Style Dialog Box (on page 140)
Edit Ruleset View Style Dialog Box (on page 118)
Define View Style Command (Tools Menu) (on page 56)

Create or Edit a Graphic Preparation Rule


Graphic preparation rules allow you to customize the graphics included in your view style. You
can use a graphic preparation rule to implement functionality that does not generally support
interfaces that the Drawings environment requires. For example, the MakeDrawable custom
module forces objects that cannot normally display in a drawing, such as piping runs objects, to
be drawable.
1. Click Tools > Define View Style. The Define View Style dialog box displays.
2. In the View Style Type box, select a drawing view type.
3. To create a new style, click New Style to create a new view style in the current folder. If
you want to create a new folder for the view style, click New Folder first, then create the
new style in the new folder.

You can use Rename to change the name of the new folder or style.
4. Select a new or existing drawing view style, and click Properties to open the View
Style Properties dialog box. For more information, see View Style Properties Dialog Box
(on page 59).
5. In the Graphic Preparation Rule box, select More. The Select Custom Rule dialog box
displays.

Drawings and Reports Reference Data Guide 91


Tools Menu

6. Click New to create a new graphic rule, or select an existing rule and click Properties to edit
the properties. The Custom Graphic Rule dialog box displays.

7. In the Rule Name box, type a name.


8. In the Description box, type a description.
9. In the Filter Name column, select a filter, such as Equipment.
10. In the Custom Module column, select a .dll file.
11. Click OK on the Custom Graphic Rule dialog box.
12. On the Select Custom Rule dialog box, select the new or modified rule, and click OK to
return to the View Style Properties dialog box. You can continue specifying parts of the
view style on this dialog box.
See Also
Create an Orthographic Drawing View Style (on page 87)
Apply Grid Labels to Elevation Views (on page 92)

Apply Grid Labels to Elevation Views


The following procedure describes how to apply grid labels to elevation views on drawings.
Custom rules are required along with filters for grid plane objects.
This procedure creates separate view styles for Elevation views. You then create Elevation view
drawing type packages using the appropriate view styles. For more information, see Save
Package Command, found in any of the Smart 3D Drawings user's guides available from Help >
Printable Guides.
The example below uses the GridLinesDrawingWrapperEntity.dll custom rule to
resymbolize the grid plane as a set of lines. The lines draw at all perpendicular plane locations
and extend along the elevation plane from (lowest Z-1)m to (highest Z+1)m of the coordinate
system to which the grid plane belongs. For example, if the coordinate system has X=0,10,20,
Y=0,5,10 and EL=0,10, then for the grid plane at X=0, there will be three lines:
 Y=0 from Z-1 to Z+11

Drawings and Reports Reference Data Guide 92


Tools Menu

 Y=5 from Z-1 to Z+11


 Y=10 from Z-1 to Z+11

Check for the Required Filters


If the catalog you are using does not have filters for Grid Plane Elevation, you need to create
them. You need one for Elevations looking North/South.
Check the catalog for the filters. If you are using the default filters, these filters are
delivered under Catalog Filters > SP3D Object Filters > Grid Systems.

Create the Required Filters


If the Grid Plane Elevation filters do not exist, you can create them. For more information on
creating filters, see the Common User's Guide.
1. In the Common task, use File > Define Workspace to create two new filters. On the
Define Workspace dialog box, select Create new filter in the Filter box. The New Filter
Properties dialog box displays.
2. Go to the Object Type tab and select Grid Systems. Expand Grid Systems and select
Grid Plane.

Drawings and Reports Reference Data Guide 93


Tools Menu

3. Go to the Properties tab to further restrict the filter. For example, select Grid Planes and
restrict to Axis = X for the Elevation filter. Select More in the Property box. The Select
Properties dialog box displays so that you can specify the property definition for the Grid
Plane object. Click OK to return to the Properties tab to set the value for the selected
property. Refer to the graphic below for more information.

4. Click OK to save the new filter definitions.

Create an Orthographic Drawing View Style


After checking to make sure you have the required filters or creating new filters, you need to
create a view style that uses the filters to create the grid labels on your drawings. Go to the
Drawings and Reports task to perform the steps below.
1. Select Tools > Define View Style. The Define View Style dialog box displays. For more
information, see Define View Style Dialog Box (on page 58).
2. In the View Style Type box, select a drawing view style type.

Drawings and Reports Reference Data Guide 94


Tools Menu

3. Click New Style to create a new view style in the current folder. If you want to create a
new folder for the view style, click New Folder first, then create the new style in the new
folder. For example, you could create a view style called Elevation Grid Bubbles.

You can use Rename to change the name of the new folder or style.
4. Select the new style, and click Properties to open the View Style Properties dialog
box. For more information, see View Style Properties Dialog Box (on page 59).
5. In the Graphic Preparation Rule box, select More. The Select Custom Rule dialog box
displays.
6. Click New to create a new graphic rule. The Custom Graphic Rule dialog box displays.
7. Select the Grid Plane Elevation filter by selecting More in the Filter Name dropdown.
8. Apply the GridLinesDrawingWrapperEntity.dll custom rule to resymbolize the vertical grid
planes as lines.
9. Click OK on the Custom Graphic Rule dialog box.
10. On the Select Custom Rule dialog box, select the new rule, and click OK to return to the
View Style Properties dialog box.
11. Specify a graphic rule to apply color or style to the graphics in the drawing.
You can use the Invisible style to prevent the lines for Grid Planes from displaying.
The software labels them even when invisible.
12. Apply a label rule that returns the name as its value.
You can copy one of the delivered Grid labels and its supporting files in the
[Reference Data Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder and the
[Reference Data Folder]\SharedContent\Drawings\Catalog\Rules\LabelRules folder.
Rename the new label and substitute one of the delivered name label .rqe files for the new
labels query.

Drawings and Reports Reference Data Guide 95


Tools Menu

13. After defining the drawing view style, click OK to save the settings. The view style is now
ready to use with drawings.

Drawings and Reports Reference Data Guide 96


Tools Menu

This example uses columns and beams to give the results of the view style application and
meaning. The row referencing Grid Plane Elevations is the only required row. In a drawing using
the new view style, the Grid Planes are blue based on the settings from the view style:

Some modeling situations have intersections that cause unwanted Grid Planes to
display and be labeled. You may need to edit the drawing document and delete unwanted
labels. Be sure to save changes to make to the drawing document so that subsequent updates
are remembered.
See Also
Create an Orthographic Drawing View Style (on page 87)
Define View Style Command (Tools Menu) (on page 56)
Create or Edit a Graphic Preparation Rule (on page 91)

Drawings and Reports Reference Data Guide 97


Tools Menu

Apply a Visible Fill Style to a Drawing


The following procedure describes how to apply the Visible Fill Style VHL graphic rule option to
drawings. It uses the following model as an example:

Without using the Visible Fill Style VHL graphic rule option, the drawings of the slabs display
without a fill as follows:

Create a View Style Using a Visible Fill Style


Using the model shown previously, you want your drawings to display the top floor slab as a
metal grating without changing the appearance of the bottom floor slab. You can use the Visible
Fill Style on the VHL graphic rule for the view style to achieve this output.
1. In the Drawings and Reports task, select Tools > Define View Style.
The Define View Style dialog box displays.
2. Select Orthographic View Styles as the View Style Type, then click New Style . Give
the new style a name, and click Properties to display the View Style Properties dialog
box.

Drawings and Reports Reference Data Guide 98


Tools Menu

In order for a fill style to work properly in a drawing, Intersection Edges


must be set to Low Resolution or High Resolution. The default setting for an orthographic
view style is Low Resolution. For more information on Intersection Edges, see View Style
Properties Dialog Box (on page 59).
3. On the View Style Properties dialog box, create a filter for the view style. In the Filter
Name box, select Create New Filter. The Filter Properties dialog displays. On the Object
Type tab, select only the structure slab objects:

Then go to the Properties tab and specify the property definition to select only the slabs
that are higher than 2 feet in elevation.

4. On the View Style Properties dialog box, click More in the Graphic Rule box to display the
Select Graphic Rule dialog box. Select Visible/Hidden Edges (VHL) as the Graphic View
Type, then click New to create a new graphic rule.

Drawings and Reports Reference Data Guide 99


Tools Menu

5. On the Graphic Rule - VHL dialog box, give your new graphic rule a name and description.
Set the Visible Fill Style. For example, you would select Grate as the fill style for the
topmost slab definition.

For more information, see Graphic Rule - VHL Dialog Box (on page 71).
6. Click OK on all the view style dialog boxes to save the changes to the new graphic rule and
the view style. You can now use this view style to create fill style drawings.

See Also
Create an Orthographic Drawing View Style (on page 87)
Define View Style Command (Tools Menu) (on page 56)
Create or Edit a Graphic Preparation Rule (on page 91)

Drawings and Reports Reference Data Guide 100


Tools Menu

Apply a Clipped Solid Fill Style to a Drawing


The following procedure describes how to apply the Clipped Solid Fill Style VHL graphic rule
option to drawings. It uses the following model as an example:

The wall in the model is clipped by a drawing volume:

The following graphic shows the result of the clipping. The intersection of the drawing volume
and the wall are outlined in red. This is the area in the drawing that needs to be filled. Although
the wall appears to be a hollow sheet body, it is a solid. Therefore, the red outlines represent
planar surfaces capping the intersected wall.

Create a View Style Using a Clipped Solid Fill Style


1. In the Drawings and Reports task, select Tools > Define View Style.
The Define View Style dialog box displays.

Drawings and Reports Reference Data Guide 101


Tools Menu

2. Select Orthographic View Styles as the View Style Type, then click New Style . Give
the new style a name, and click Properties .
The View Style Properties dialog box displays.
In order for a fill style to work properly in a drawing, Intersection Edges
must be set to Low Resolution or High Resolution. The default setting for an Orthographic
View Style is Low Resolution. For more information on Intersection Edges, see View
Style Properties Dialog Box (on page 59).
3. On the View Style Properties dialog box, specify a filter for wall objects.

4. On the View Style Properties dialog box, click More in the Graphic Rule box to display the
Select Graphic Rule dialog box. Select Visible/Hidden Edges (VHL) as the Graphic View
Type, and then click New to create a new graphic rule.
5. On the Graphic Rule - VHL dialog box, give your new graphic rule a name and description.
Set the Visible Fill Style. Select Hatch as the Clipped Solid Fill Style for the wall
definition and Normal Blue as the Visible Line Style value to outline the walls in blue.
For more information, see Graphic Rule - VHL Dialog Box (on page 71).
6. Click OK on all the view style dialog boxes to save the changes to the new graphic rule and
the view style. You can now use this view style to create fill style drawings.

See Also
Create an Orthographic Drawing View Style (on page 87)
Define View Style Command (Tools Menu) (on page 56)
Create or Edit a Graphic Preparation Rule (on page 91)

Drawings and Reports Reference Data Guide 102


Tools Menu

Apply Transparency to an Orthographic View Style


The following procedure describes how to apply the Make Transparent VHL graphic rule option
to orthographic drawings. It shows how you can use the Make Transparent option to make pipe
objects under a slab visible through the slab object graphics.
Without using the Make Transparent VHL graphic rule option, a drawing of this type displays as
follows:

Create a View Style Using a Make Transparent Option


1. In the Drawings and Reports task, select Tools > Define View Style.
The Define View Style dialog box displays.
2. Select Orthographic View Styles as the View Style Type, then click New Style . Give
the new style a name, and click Properties to display the View Style Properties dialog
box. For more information, see View Style Properties Dialog Box (on page 59).
3. On the View Style Properties dialog box, create a filter for the view style. In the Filter
Name box, select a filter that looks for the slab objects, and then create a new graphic rule
that sets the Make Transparent option for the slabs to For all objects in view.

For more information, see Graphic Rule - VHL Dialog Box (on page 71).

Drawings and Reports Reference Data Guide 103


Tools Menu

4. Your filter setting to collect your pipeline objects should use a standard graphic rule.

5. Click OK on all the view style dialog boxes to save the changes to the new graphic rule and
the view style. You can now use this view style to create fill style drawings.

See Also
Create an Orthographic Drawing View Style (on page 87)
Define View Style Command (Tools Menu) (on page 56)
Create or Edit a Graphic Preparation Rule (on page 91)
Apply Symbology to Graphic Object Aspects (on page 106)

Apply Invisible Option to an Orthographic View Style


The following procedure describes how to apply the Invisible VHL graphic rule option to
orthographic drawing objects. It shows how you can use the Invisible option to label plan grid
lines that do not display in the drawing.
Without using the Invisible VHL graphic rule option, a drawing of this type displays as follows:

Create a View Style Using the Invisible Option


1. In the Drawings and Reports task, select Tools > Define View Style.

Drawings and Reports Reference Data Guide 104


Tools Menu

2. Select Orthographic as the View Style Type, then click New Style . Give the new style
a name, and click Properties to display the View Style Properties dialog box. For
more information, see View Style Properties Dialog Box (on page 59).
3. On the View Style Properties dialog box, create a filter for the view style. In the Filter
Name box, select two filters that look for grid lines.
4. In the Primary Orientation box, select Parallel, vertical for the first grid line row, and
Parallel, horizontal for the second grid line row.
5. Create a new graphic rule that sets the Visible Line Style and Hidden Line Style options
to Invisible for both grid line rows.

6. In the Label Rule box, select a grid line rule for each grid line row. For example, select
Equipment Plan_Grid Line_X Name and Equipment Plan_Grid Line_Y Name.
Assign the X Name graphic rule to the Parallel, vertical grid line row and the Y
Name graphic rule to the Parallel, horizontal grid line row.

For more information, see Graphic Rule - VHL Dialog Box (on page 71).
7. Add rows to the view style to document other objects in the model.

Drawings and Reports Reference Data Guide 105


Tools Menu

8. Click OK on all the view style dialog boxes to save the changes to the new graphic rule and
the view style. You can now use this view style to create a drawing that does not include a
graphic representation of grid lines but labels them.

Apply Symbology to Graphic Object Aspects


You can apply the Aspect VHL graphic rule option to drawings.
For example, you could have pipes in your model that include an Insulation aspect style. You
want your drawings to include the Insulation aspect as part of the drawing, and you also want
to set transparency so that both the pipes and the insulation can be seen as unique in the
drawing.

Drawings and Reports Reference Data Guide 106


Tools Menu

Use Tools > Define View Style to create a view style that applies a graphic rule setting the
aspect and transparency. As shown in the following example Graphic Rule - VHL dialog box,
the Insulation aspect is selected, and the Make Transparent property is set to For other
aspects of same object. This allows a different symbology to be applied to each aspect of the
graphic object if necessary.

In marine mode drawings by rule view styles, the Graphic Style dialog box is used to
assign VHL aspects. The dialog box looks different, but the procedure is similar to the above
description. For more information, see Graphic Tab (Graphic Style Dialog Box) (on page 126).
See Also
Create an Orthographic Drawing View Style (on page 87)
Define View Style Command (Tools Menu) (on page 56)
Graphic Rule - VHL Dialog Box (on page 71)
Apply Transparency to an Orthographic View Style (on page 103)

Add Flow Arrows to Orthographic Drawings


The following procedure describes how to add flow arrows to orthographic drawings as part of
the view style definition.
You can also add flow arrows after the drawing document is created. For more information, see
Place a Manual Flow Arrow on an Orthographic Drawing in the Orthographic Drawings User's
Guide.
1. In the Drawings and Reports task, select Tools > Define View Style.
The Define View Style dialog box displays.
2. Select Orthographic View Styles as the View Style Type, then click New Style . Give
the new style a name, and click Properties .

Drawings and Reports Reference Data Guide 107


Tools Menu

The View Style Properties dialog box displays.


3. On the View Style Properties dialog box, create a filter for the view style. In the Filter
Name box, select the Object Types\Piping\Piping Parts\Pipes filter.
4. Click More in the Graphic Rule box to display the Select Graphic Rule dialog box. Select
the graphic rule Piping Plan_Piping, or any graphic rule that has a Show Centerline
property of Yes. Click OK to close this dialog box.
5. In the Label Rule box, click More to display the Select Label Rule dialog box. Select a
label rule that adds a flow arrow to the object. Click OK to save the label rule definition to
the view style. For example, you can add the flow arrow label rule Piping
Plan_FlowArrow_Longest Segment to add the flow arrow to the longest segment of a
pipeline collected by the filter.
For more information, see Select Label Rule Dialog Box (on page 84).
6. Click OK on all the view style dialog boxes to save the changes to the new graphic rule and
the view style. You can now use this view style to create drawings with flow arrows placed
on the specified objects.

Pipes that have no flow direction defined will not have flow arrows applied in the
drawing. You can place NO FLOW arrows manually when you edit the drawing document.
See Also
Create an Orthographic Drawing View Style (on page 87)
Define View Style Command (Tools Menu) (on page 56)
View Style Properties Dialog Box (on page 59)

Drawings and Reports Reference Data Guide 108


Tools Menu

Use the Make Clipped Solid Monolithic Option


The following procedure describes how to apply the Make Clipped Solid Monolithic VHL
graphic rule option to drawings. It uses the following model of a wall and slab as an example.

You can also place a drawing volume that clips the east side of the wall and slab, as in the
example model.

Drawings and Reports Reference Data Guide 109


Tools Menu

You have a drawing view style that defines the graphic rule for structure objects. The graphic
rule applies a Normal Blue for visible edges and a LightGray non-transparent fill style for
clipped surfaces. By default, the Make Clipped Solid Monolithic option is set to No. For more
information on creating view styles, see Create an Orthographic Drawing View Style (on page
87).

The resulting drawing resembles the following graphic. You can see the line between the wall
and the slab because they are separate objects. For more information on creating view styles,
see Create an Orthographic Drawing View Style (on page 87).

Edit a View Style to Use the Make Clipped Solid Monolithic Volume Option
1. In the Drawings and Reports task, select Tools > Define View Style. The Define View
Style dialog box displays.

Drawings and Reports Reference Data Guide 110


Tools Menu

2. Select your Structure orthographic view style, and click Properties to edit the style
properties.
3. Modify the graphic rule applied to Structure objects and set Make Clipped Solid Monolithic
to Yes. For more information on the VHL properties, see Graphic Rule - VHL Dialog Box (on
page 71).

4. Click OK on all the view style dialog boxes to save the changes to the new graphic rule and
the view style.
5. Update the drawings that use the updated view style to incorporate the changes to the
drawing style. The wall and slab display as a monolithic body. The line between the wall and
slab is no longer displayed.

Drawings and Reports Reference Data Guide 111


Tools Menu

You should always use a non-transparent clipped solid fill style when creating
drawings that use this graphic rule functionality. When the drawing is open in SmartSketch
Drawing Editor and you drag the clipped surface aside, you will notice that the original wall and
slab graphics are still there under it. The non-transparent style allows the masking to work
properly in the drawing.

See Also
Create an Orthographic Drawing View Style (on page 87)
Define View Style Command (Tools Menu) (on page 56)
Graphic Rule - VHL Dialog Box (on page 71)

Place a Manual North Arrow on a Drawing


North arrows are typically included in drawing views when the option is selected in the view
style. The following workflow allows you to place a north arrow on a drawing independent of
other views. For example, you can place a master north arrow in the company border area or in
another generic location in the drawing to adhere to company standards.

Create a New North Arrow XML Template


1. Locate the delivered north arrow templates in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\NorthArrows folder.
2. In the NorthArrows folder, copy the NorthArrow.xml file.
3. Rename the copied XML file to NorthArrowManual.xml.
4. Edit the NorthArrowManual.xml file and remove the following text from the posModules
section:
<posModule value="DrawingQuadTwo">
<connectPoint>8</connectPoint>
<positioningPoint>8</positioningPoint>
</posModule>
<posModule value="DrawingQuadOne">
<connectPoint>6</connectPoint>
<positioningPoint>6</positioningPoint>
</posModule>
<posModule value="DrawingQuadThree">
<connectPoint>2</connectPoint>
<positioningPoint>2</positioningPoint>
</posModule>
<posModule value="DrawingQuadFour">
<connectPoint>0</connectPoint>

Drawings and Reports Reference Data Guide 112


Tools Menu

<positioningPoint>0</positioningPoint>
</posModule>
5. Edit the DrawingAbsolute positioning module as follows:
<posModule value="DrawingAbsolute">
<connectPoint>4</connectPoint>
<vOffset>0</vOffset>
<hOffset>0</hOffset>
</posModule>
6. Save the NorthArrowManual.xml file, and exit.

Create a New North Arrow XML Rule


1. Locate the delivered north arrow rules in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\NorthArrowRules folder.
2. In the NorthArrowRules folder, copy the NorthArrow.xml file.
3. Rename the copied XML file to NorthArrowManual.xml.
4. Edit the NorthArrowManual.xml file, and replace the NorthArrow name with your new north
arrow label name.
<labels>
<label>
<name>NorthArrows\NorthArrowManual</name>
</label>
</labels>
5. Save the NorthArrowManual.xml file and exit.

Create a New North Arrow Symbol


1. Locate the delivered north arrow symbol in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\NorthArrows folder.
2. In the NorthArrows folder, perform a copy and paste operation on the NorthArrow.sym file.
3. Rename the copied SYM file to NorthArrowManual.sym.

Create a New North Arrow View Style


1. In the Drawings and Reports task, select Tools > Define View Style.
2. In the Define View Style dialog box, select Orthographic in the View Style Type
dropdown menu, and click New Style. Name the new style NorthArrow.
3. Double-click the NorthArrow view style to edit the view style properties.
4. Select NorthArrowManual in the North Arrow Rule dropdown menu.

Create a New Graphic Preparation Rule


1. In the Graphic Preparation Rules dropdown of the View Style Properties dialog box,
select More.
2. In the Select Graphic Preparation Rule dialog box, click New.
3. Enter NorthArrow in the Rule Name field.

Drawings and Reports Reference Data Guide 113


Tools Menu

4. Select More in the Filter Name box and navigate to the Catalog Filters/Default
Filters/SP3D Object Filters/Object Types/Space/Space Entities/Drawing Volumes filter.
5. Click OK.
6. In the Custom Module box, select ReplaceWPoint.dll.
7. Click OK in the Custom Graphic Rule dialog box to save the new graphic preparation rule.
8. Select NorthArrow in the Select Graphic Preparation Rule dialog box, and click OK.
9. Click OK on the View Style Properties dialog box to save your new view style. Below is an
example of a finished NorthArrow view style.

Place a North Arrow View in the Drawing


1. Open an existing drawing, or create a new drawing, in the Drawings Console.
2. Place a new view in the drawing that uses your new NorthArrow view style. For more
information on placing views in drawings, see the SmartSketch Drawing Editor User's
Guide.
3. Select Fit to Scale in the Scale Family box.
4. Select the Look Direction for the north arrow.
5. On the Format tab of the Drawing View Properties dialog box, clear the Show Border
option.
6. Click OK.
7. Associate the view to a volume in the model, and update the drawing.

Drawings and Reports Reference Data Guide 114


Tools Menu

The north arrow displays in the view you placed and indicates the north direction.

See Also
View Style Rules (on page 57)

Use Bubble Labels in Drawings


You can use bubble labels to identify objects in a drawing view by the Item Numbers shown in
a report view. The drawing view style must identify a bubble label for the objects you want
labeled with the Item Numbers. The filter in the following view style example looks for Structure
objects and applies the HngSup Side_Reference_Circle_CA_L bubble label:

Drawings and Reports Reference Data Guide 115


Tools Menu

The drawing document must have a drawing view that is associated to a report view. The bubble
label looks for the Item Number field in the report to label the objects in the associated drawing
view. For example, you can use the delivered HgrSup3View package to create drawings that
use a bubble label to identify the part of a support object. The Item Numbers for each support
part are listed in the report shown on the drawing.

The bubble labels applied to the drawing view are generated from the Item
Number values in the report.
You can also place bubble labels manually using the Manual Place Label
command when a drawing is open in SmartSketch Drawing Editor. You must
still have a drawing view associated to a report before using the bubble label.
For more information on placing manual labels, see Place a Manual Label on a
Drawing in the Orthographic Drawings User's Guide, available from Help >
Printable Guides.
Label XML definition is discussed further in the Intergraph SmartTM
3D Programmer's Guide under Label Templates and Rules (XML) > XML
Tag Reference. When creating new bubble labels, see <content> XML tag
definitions to find the value of the DrawingReferenceLabelContent attribute.
Contact your administrator or Intergraph Support if you require the Intergraph
SmartTM 3D Programmer's Guide. You can find support information on our web
site http://support.intergraph.com (http://support.intergraph.com/).
See Also
View Style Properties Dialog Box (on page 59)
Labels (on page 740)
Define View Style Command (Tools Menu) (on page 56)

Drawings and Reports Reference Data Guide 116


Tools Menu

Assign Drawing Objects to Specific Layers


Layers provide a way to control the display of elements on a drawing sheet in SmartSketch
Drawing Editor. There are three different places in drawings that affect the layer settings: the
label templates folder, the dimension templates folder, and the graphic rule interface inside the
software.
By default, all objects in a drawing reside in the default view layer.
 To alter in which layer the labels display, see Modify the Label Template Layer (on page
117).
 To alter in which layer the dimensions display, see Modify the Dimension Template Layer.
 To alter in which layer the graphical objects display, you must modify the Layer field in the
Graphic Rule - VHL Dialog Box (on page 71), Graphic Rule - Line Dialog Box (on page 76),
or Graphic Rule - Symbol Dialog Box (on page 82).
The settings listed above determine which objects from certain templates display in non-default
layers in the drawing view. As a drawings administrator, you might want to pre-define layers in
the delivered view template for ease of use and export. For more information and an example
workflow, see Pre-Define Layers in Delivered View Template in the SmartSketch Drawing Editor
Help.

Modify the Label Template Layer


In this example, Equipment Plan_Equipment_Name.xml, Piping Plan_Piping
Parts_RunName.xml, and Structural Framing Plan_Beams_Section Size.xml will be used to
demonstrate the functionality of associating label templates to view layers.
1. Open Equipment Plan_Equipment_Name.xml. This file is located in the [Reference Data
Product Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder.
2. Add the following text to the XML file directly above the </label> tag.

3. Select File > Save.


4. Open Piping Plan_Piping Parts_RunName.xml.
5. Repeat Step 2, but replace the word Equipment with Piping.
6. Select File > Save.
7. Open Structural Framing Plan_Beams_Section Size.xml.
8. Repeat Step 2, but replace the word Equipment with Structure.
9. Select File > Save.
This workflow must be repeated for every label template that you want included in a
pre-defined layer.

Drawings and Reports Reference Data Guide 117


Tools Menu

Edit Ruleset View Style Dialog Box


Specifies view style settings for the selected marine mode rule set. You can open this dialog box
from the Select View Style dialog box by selecting Ruleset Styles in the View Style Type box,
selecting a view style from the list, and then clicking Properties . The view style defines the
style applied to the drawing view generated by the rule set. It determines the appearance of the
drawing to which it is applied.
Name Tab (Edit Ruleset View Style Dialog Box) (on page 118)
Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119)
Query Tab (Edit Ruleset View Style Dialog Box) (on page 129)
Area Tab (Edit Ruleset View Style Dialog Box) (on page 130)
AddOns Tab (Edit Ruleset View Style Dialog Box) (on page 132)
Labels Tab (Edit Ruleset View Style Dialog Box) (on page 132)
General Tab (Edit Ruleset View Style Dialog Box) (on page 133)
See Also
Drawings by Rule View Styles (on page 167)
Create a Rule Set View Style (on page 135)
Define View Style Dialog Box (on page 58)
Define View Style Command (Tools Menu) (on page 56)

Name Tab (Edit Ruleset View Style Dialog Box)


Sets or displays the name and description for the marine mode rule set view style.
Name
Specifies the name of the rule set view style.
For more information on the delivered marine mode view styles, see Drawings by
Rule View Styles (on page 167).
Description
Provides a brief description of the view style.
See Also
Define View Style Dialog Box (on page 58)
Define View Style Command (Tools Menu) (on page 56)
Drawings by Rule View Style Rule Sets (on page 190)
Edit Ruleset View Style Dialog Box (on page 118)
Create a Rule Set View Style (on page 135)

Drawings and Reports Reference Data Guide 118


Tools Menu

Actions Tab (Edit Ruleset View Style Dialog Box)


Specifies a rule set, source objects, and actions to use for the marine mode view style. After you
select the rule set, you set the style actions for each source in the Action table by identifying
tests that specify the objects called by the view and rules that specify how graphics, labels, and
dimensions are displayed within the view.

Select Ruleset
Provides a list of rule sets for this view style. Select a rule set from the list to populate the
Action table. For more information, see Drawings by Rule View Style Rule Sets (on page
190).

Edit action description for selected row


Specifies the tooltip that is visible when the cursor hovers over the number of an action row.
Select a row, and click Edit action description for selected row to display the Edit
Action Description dialog box. For more information, see Edit Action Description Dialog
Box (on page 121).
Source
Specifies an object type that receives action after extraction by the rule set view style query.
Each row of the grid represents a source object type. Each column in the grid represents an
action, or operation, to be performed on the source. You can add a new row from the list of
Source items. You can add more than one row belonging to the same source item.
 The available options for Source are defined by the selected rule set.
 Select Object Type - This option is available for view styles using asking filters, or
when you need to select an object type that is not defined by the selected rule set.
Any object type can be selected in the Select Object Types dialog box.
How Actions are Applied to a View (on page 121)
Delete a source on the Actions tab (on page 136)

 For more information about specific actions used in view styles, see Drawings by
Rule View Styles (on page 167).
 For more information about the sources available in rule sets, see Drawings by Rule
View Style Rule Sets (on page 190).

Tests
There are two types of tests you can apply to specify the objects against which the actions run.

Drawings and Reports Reference Data Guide 119


Tools Menu

Filter
Specifies a filter to use in specifying objects. Select More to display the Select Filter dialog
box. For more information, see Select Filter Dialog Box (on page 143).
Custom
Specifies a list of custom tests available for the selected rule set. Select Edit in to display
the Custom Tests dialog, and make any needed changes to the test you need for the
current action. For more information, see Custom Tests Dialog Box (on page 122) and
Custom Tests Dialog Box (Generic Rule Set) (on page 123).

Rules
Graphic
Specifies the graphic rule used for the current action. For each object processed by the rule
set view style, the software applies the first action that passes the specified Tests and has a
graphic rule specified. The software does not draw the graphic produced by the action
unless you select Custom or From ruleset. The From ruleset option tells the software to
use the symbols, colors, and line styles specified by the selected rule set. The Custom
option tells the software to use a custom graphic rule you provide. You can also use the Edit
Custom option to display the Graphic Style dialog box and edit the graphic definition as
needed. For more information, see Graphic Style Dialog Box (on page 126).
Label
Specifies the label rule used for the current action. For each object processed by the rule set
view style, the software applies the labels from all the actions that pass the applied tests.
More than one label can be added to an object. Select More to display the Select Label
dialog box. For more information, see Label Rules in Drawings by Rule (on page 852).
Dimension
Specifies the dimension rule used for the current action. For each object processed by the
rule set view style, the software applies the dimensions from all the actions that pass the
applied tests. More than one dimension can be added to an object. Select More to display
the Select Dimension dialog box. For more information, see Marine Dimension Rules (on
page 690).
See Also
Define View Style Dialog Box (on page 58)
Edit Ruleset View Style Dialog Box (on page 118)
Define View Style Command (Tools Menu) (on page 56)
Create a Rule Set View Style (on page 135)

Drawings and Reports Reference Data Guide 120


Tools Menu

How Actions are Applied to a View


When views are created by a marine mode view style, all source items are first drawn and then
labeled. The software processes the source items starting at the top of the list and working
down:
1. During the drawing phase, the first of each source/test/rule combination is gathered and
drawn, and remaining occurrences of the same combination are ignored. For example,
consider an Actions tab list consisting of:
Plate Part
Plate Part
Plate Part
Profile Part
Profile Part
Profile Part
where each Plate Part row uses the same tests and rules, and each Profile Part row uses
the same tests and rules. Objects in the model meeting the tests and rules of the first
occurrence of Plate Part and Profile Part are drawn, and subsequent occurrences are
ignored.
2. During the labeling phase, items in the model meeting the tests and rules of all occurrences
of Plate Part and Profile Part are labeled.
See Also
Drawings by Rule View Styles (on page 167)

Edit Action Description Dialog Box


Specify a description for the source and its actions on the selected row of the Action tab. The
description displays as a tooltip that is visible when the cursor hovers over the number of an
action row. You can open this dialog box when using the Actions tab of the Edit Ruleset View
Style dialog box by selecting a numbered row and clicking Edit action description for
selected row .
Description
Type a description of up to 255 characters.

Drawings and Reports Reference Data Guide 121


Tools Menu

Custom Tests Dialog Box


Provides a list of custom tests available for the current marine mode rule set. This dialog box
displays when you select Edit in the Custom box on the Actions tab of the Edit Ruleset View
Style dialog box. You can make changes to the tests as needed for the current rule set view
style action.

Filter Method
Provides options to either Match All or Match Any objects found by the selected tests.

Tests and Properties


For each test, you can specify how the test is applied to the current rule set view style action.
Use
Turns tests on or off. When the box is checked, the test is turned on and applied to the rule
set view style action.
Condition
Specifies the test condition checked by the rule set view style action.
Operator
Specifies the operator used in the test.
Value
Sets the value checked against the specified condition.
Custom test conditions are unique for each view style rule set.
For more information on custom tests, see Ruleset Custom Tests (on page 263).

Drawings and Reports Reference Data Guide 122


Tools Menu

See Also
Create a Rule Set View Style (on page 135)

Custom Tests Dialog Box (Generic Rule Set)


Allows the creation of custom tests available for the generic rule set. This dialog box displays
when you:
1. Select Tools > Define View Style and select a rule set view style.
2. In the Edit Ruleset View Style dialog box, select DBRGenericRuleSet.GenericRuleSet in
the Select Ruleset box on the Actions tab.
3. Select Edit in the Custom box.

Filter Method
Provides options to either Match All or Match Any objects found by the selected tests.

Tests and Properties


For each test, you can specify how the test is applied to the rule set view style action.
Use
Turns tests on or off. When the box is checked, the test is turned on.
Condition
Specifies the test condition checked by the rule set view style action. Double-click Add
to open the appropriate dialog box and define the test.
Custom Property on Source Object - Opens the Select Custom Property on Source
Object dialog box when you double-click Add .
Custom Property - Specifies the custom test for the source object. You can use any

Drawings and Reports Reference Data Guide 123


Tools Menu

custom test, but tests with names prefixed by Generic are designed to work with any
source type. For more information, see Ruleset Custom Tests (on page 263).
Custom Property on Related Objects - Opens the Select Custom Property on Related
Objects dialog box when you double-click Add .
Property matches
Determines the method of matching the related objects to the custom property.
 Any related objects - If any object returned by the selected relation matches the
selected custom property, then all objects are treated as matching.
 All related objects - All objects returned by the selected relation must match the
selected custom property.
Relation - Defines the relationship of the object to the source object. Type the name of
a relation, using the name of any .xml file delivered in the [Product
Directory]\ShipDrawings\Middle\Settings\SteelOrder\GenericRelations folder, such as
Stiffener Part to Stiffened Parent Plate Part. For more information, see
Relations for Custom Tests (on page 124).
Custom Property - Specifies the custom test for the related object. You can use any
custom test, but tests with names prefixed by Generic are designed to work with any
source type. For more information, see Ruleset Custom Tests (on page 263).
Filter on Related Objects - Under this category, double-click Add to open the Select
Filter on Related Objects dialog box.
Relation - Defines the relationship of the object to the source object. Type the name of
a relation, using the name of any .xml file delivered in the [Product
Directory]\ShipDrawings\Middle\Settings\SteelOrder\GenericRelations folder, such as
Stiffener Part to Stiffened Parent Plate Part. For more information, see
Relations for Custom Tests (on page 124).
Operator
Specifies the operator used in the test.
Value
Sets the value checked against the specified condition.
See Also
Create a Rule Set View Style (on page 135)

Relations for Custom Tests


The Relation box defines the relationship of the object to the source object.
Using Stiffener Part to Stiffened Parent Plate Part as an example, Stiffener Part is the object
related to the Stiffened Parent Plate Part source object.
The following relations are available:
 Built-up Member to Planning Item
 Built-up Member Part to Child Plate Parts
 Connection to Planning Item
 Connection to Parent Structural Parts

Drawings and Reports Reference Data Guide 124


Tools Menu

 Feature to Planning Item


 Feature to Parent Structural Part
 Grid Axis to Coordinate System
 Hole Trace to Hole Feature
 Intersection Seam to Feature
 Intersection Seam to Root Logical Connection
 Knuckle to Planning Item
 Knuckle to Parent Structural Parts
 Manufacturing Margin to Parent Structural Part
 Manufacturing Margin to Planning Item
 Manufacturing Marking Line to Parent Structural Part
 Manufacturing Marking Line to Planning Item
 Manufacturing Shrinkage to Parent Structural Part
 Manufacturing Shrinkage to Planning Item
 Opening to Planning Item
 Opening to Parent Structural Parts
 Outfitting Part to Planning Item
 Physical Connection to Child Physical Connection
 Reference Curve to Planning Item
 Reference Curve to Parent Structural Parts
 Reference Plane to Coordinate System
 Root Logical Connection to Intersection Seam
 Seam to Planning Item
 Seam to Parent Structural Parts
 Stiffened Plate Part to Stiffener Parts
 Stiffener Part to Stiffened Parent Plate Parts
 Structural Part to Connected Structural Parts
 Structural Part to Planning Item
 Structural System to Planning Item
 Structural System to Child Structural Parts

Drawings and Reports Reference Data Guide 125


Tools Menu

Graphic Style Dialog Box


Shows the current settings for the marine mode rule set graphic rule. This dialog box displays
when you select Edit Custom in the Graphic box on the Actions tab of the Edit Ruleset View
Style dialog box. You can make changes to the graphic style as needed for the current rule set
view style action.
Graphic Tab (Graphic Style Dialog Box) (on page 126)
Custom Tab (Graphic Style Dialog Box) (on page 129)
AddOns Tab (Graphic Style Dialog Box) (on page 129)
See Also
Create a Rule Set View Style (on page 135)

Graphic Tab (Graphic Style Dialog Box)


Displays the graphic settings for the graphic rule of the selected rule set.
Graphic Rule Type
Specifies the graphic rule. For more information about the delivered graphic rules, see
Graphic Rules (on page 725).
Aspect
Specifies the aspect to be resymbolized. This option is not available for the Resymbolized
by Ruleset graphic rule.
 Simple physical - Includes primitive shapes. This aspect creates a less cluttered view
of the object, showing only the body of equipment or a simplified cross-section for
structure, as shown below.

 Detailed physical - Provides a more detailed view of an object. This aspect shows all
the graphical details associated with the equipment or structure. For example, certain
types of equipment may include legs and lugs. For marine structure, this aspect uses all
geometry in the cross-section, as shown below.

Drawings and Reports Reference Data Guide 126


Tools Menu

 Insulation - Shows an area around a piece of equipment indicating the presence of


insulation. This aspect is also used to display structural fireproofing insulation. For
example, a 4-inch pipe with insulation might look like an 8-inch pipe when this aspect is
used.

 Operation - Includes the area or space around the object required for operation of the
object. This space shows in the model but not in drawings. For example, this aspect
leaves enough space around a motor for a person to operate the motor or the overhead
space needed for someone to walk up a stairway.

 Maintenance - Includes the area or space around the object required to perform
maintenance on the object. This space may appear in the model but not in drawings.
For example, this aspect leaves enough space around a motor to perform maintenance
on a motor, including space to remove the motor.

 Reference Geometry - Allows you to construct or add graphical objects that do not
participate in interference checking. For example, a reference geometry object could be
a spherical control or the obstruction volume for a door. For marine structure, this
aspect allows you to control the display of landing curves for design seams, profile
systems, reference curves, and knuckle curves.

Drawings and Reports Reference Data Guide 127


Tools Menu

 Centerline - Displays objects as a single line representation. For example, this aspect is
useful for when you want to display handrails or structural members as a single-line on
drawings. For structure, the centerline is determined from the cardinal point used to
place the member. That cardinal point is not always the center of the object.

 Molded Forms - Displays plate, profile, and beam systems for marine structure.
 Equipment Hole - Displays holes for marine structure created in the Hole Management
task.
 * - Matches all cross-sections.
For example, you want members and their fireproofing insulation symbolized and/or labeled
uniquely on the drawing. You can use the Insulation aspect on VHL graphics to
resymbolize both the member and its insulation.
Show Aspect
Specifies that you want to show the aspect symbology for the selected objects within the
drawing. Only the aspects for which this checkbox is checked are shown in the generated
drawings.
Preview
Shows a graphic example of the graphic rule.
Description
Provides a general description of the graphic rule.
Property
Displays the graphic properties available for the selected graphic rule.
 For more information about the properties available for each graphic rule, see Graphic
Rules in Drawings by Rule.
 For more information on the options available for the Graphic Module property, see
Custom Graphic Modules (on page 972).
Value
Click a value for the graphic rule property on the pull-down list. You type a numeric value for
some properties.
Graphic rules are used by a variety of view styles, and some properties might not
be valid for the selected view style type. Value displays as shaded for an invalid Property.

Drawings and Reports Reference Data Guide 128


Tools Menu

Custom Tab (Graphic Style Dialog Box)


Displays the custom graphic properties for the graphic rule of the selected rule set. You can
make changes to the custom graphic properties as needed on the Custom tab, such as defining
embedded symbol rules for end cuts or slots. The available properties are associated with the
values for Select Ruleset and Source on the Actions tab. For more information on custom
graphic properties, see the specific rule set and source under Drawings by Rule View Style Rule
Sets (on page 190).

AddOns Tab (Graphic Style Dialog Box)


Displays the view style add-ons properties for the graphic rule of the selected rule set, and
controls how the add-ons are used by the Source on the Actions tab.
Name
Name of an add-on from the AddOns tab of the Edit Ruleset View Style dialog box. For
more information, see AddOns Tab (Edit Ruleset View Style Dialog Box) (on page 132).
Apply AddOn to Source
Select True when the add-on needs to retrieve data from specific objects, instead of from
the global data shared across rule sets. The rule set for the primary view style passes
specific objects to the add-on. Select False when the add-on uses only the global data.

 False is the default value when a new add-on is added to the view style in the AddOns
tab of the Edit Ruleset View Style dialog box. You must change the value to True in
each source in which you want to apply the add-on.
 Add-ons that rely on global data shared across rule sets, such as ruler add-ons, do not
need to receive objects from the rule set of the primary view style. Always use False as
the value for Apply AddOn to Source for this type of add-on. If set to True, the add-on
will ignore the objects sent to it, but performance will be degraded.
See Also
Apply an Add-On to a Source Action (on page 138)

Query Tab (Edit Ruleset View Style Dialog Box)


Specifies the view query values for the marine mode rule set defined on the Actions tab of the
Edit Ruleset View Style dialog box.
Query
Sets the queries to use with the current rule set view style. Each view can have more than
one query applied. Depending on the query selected, this option also displays the Filter field
or the Value field.
A view query specifies the type of model object or parameter value used by the view
definition. The list of available queries is specific to the selected package. If you are a
reference data administrator customizing a drawing package, view queries are parts of the
rule set defined on the Actions tab of the Edit Ruleset View Style dialog box in the
Drawings and Reports task. For more information, see the appropriate drawing type under

Drawings and Reports Reference Data Guide 129


Tools Menu

Drawings by Rule View Style Rule Sets (on page 190) in the Drawings and Reports
Reference Data Guide.
Filter
Specifies the filter to use for this query definition:
 If applicable, a list of previously selected filters are available.
 Select More to display the Select Filter dialog and choose from a list of available
filters. For more information, see Select Filter Dialog Box (on page 143).
 Select Create New Filter to create a new filter with the Filter Properties dialog
box. For more information, see Filter Properties Dialog Box in the Common User's
Guide or the Orthographic Drawings User's Guide.
Properties
Displays only when the Filter box displays. Displays the Filter Properties dialog box so you
can modify the currently selected filter as needed. For more information, see Filter
Properties Dialog Box in the Common User's Guide or the Orthographic Drawings User's
Guide.
Remove Filter
Removes the specified filter from the selected query definition displayed in the Query box.
Value
Shows the current value used to define the query. If this field is blank, no value has been set
for the query.
 Edit - Changes the value.
 Reset - Sets the value back to the original value when the dialog displayed.
 Default - Resets to the default query for the current rule set.
See Also
Define View Style Dialog Box (on page 58)
Edit Ruleset View Style Dialog Box (on page 118)
Define View Style Command (Tools Menu) (on page 56)
Create a Rule Set View Style (on page 135)

Area Tab (Edit Ruleset View Style Dialog Box)


Specifies how the drawing area is computed for the view that has this marine mode rule set view
style. The properties on the Areas tab are part of the view style definition.
Area Computation
Determines the drawing area applied to the view. The values are as follows:
 Default (Ruleset) - The drawing area specified by the rule set (if any) is applied to the
view.
 Custom - The drawing area is computed based on settings specified in this view style
for every action.
 Discard - No drawing area is applied for this view, even if one is specified by the rule
set.

Drawings and Reports Reference Data Guide 130


Tools Menu

Boundary Overlap
Specifies the distance to extend the drawing view SmartFrame beyond the computed
boundaries.

View Offset
Expands the view on the drawing sheet in all directions in order to prevent matchline
distortion and grid plane clipping. The default offset value is 2 mm for composed views and
0 mm for ruleset views. The offset does not affect the size of the volume that is associated
with the view.

 View Offset is only available for views that are associated to a volume. Section and
detail views do not have this property value.
 Negative values are not permitted for this property.
Frame Border Style
Specifies the border style applied to the drawing view SmartFrame. You can set this value to
<Not Drawn> to have no border style, or to standard border styles such as Dashed,
Dotted, or Thick.
Frame Behavior
Determine the way the SmartFrame resizes when the view is placed. The values are as
follows:
 Frame size is fixed - Frame size is based on the initial size created with the Place
View command. For more information, see Place View Command in SmartSketch
Drawing Editor.
 Frame resizes to drawing area - Resizes the frame to the geometry in the view, as
determined by the Area Computation property.
See Also
Define View Style Dialog Box (on page 58)
Edit Ruleset View Style Dialog Box (on page 118)
Define View Style Command (Tools Menu) (on page 56)
Create a Rule Set View Style (on page 135)

Drawings and Reports Reference Data Guide 131


Tools Menu

AddOns Tab (Edit Ruleset View Style Dialog Box)


In marine mode, specifies add-on rule set view styles to include in the current rule set view style.
Add-ons are marine mode rule set view styles that are added to an existing ruleset view style.
The main use of an add-on is to enhance a view style by importing actions. A rule set view style
can have multiple add-on view styles.
Because an add-on is a rule set, it has access to global model data such as the following:
 The drawing view
 The coordinate system
 The thin volume used by a drawing view
 The query results, such as the level 0 objects returned by the query
If an add-on needs to retrieve data from specific objects, instead of from the global
data shared across rule sets, then the rule set for the primary view style can pass specific
objects to the add-on. This is more efficient and provides better performance. You set this option
for a Source item as a Graphic Rule in the Actions tab using the AddOns tab in the Graphic
Style dialog box. For more information, see AddOns Tab (Graphic Style Dialog Box) (on page
129).
AddOns

Displays add-ons selected for the view style. Click Browse in a table row to display the
Select AddOn dialog box to select from a list of rule set view styles.
All view styles are available, but some are designed to use specifically as
add-ons. For more information, see Add-on Ruleset View Styles (on page 288).
Delete AddOn
Deletes an add-on. Right-click on an add-on in a table row, and select this command to
delete the add-on.
See Also
Add an Add-on View Style to an Existing Ruleset View Style (on page 136)
Define View Style Dialog Box (on page 58)
Edit Ruleset View Style Dialog Box (on page 118)
Define View Style Command (Tools Menu) (on page 56)
Create a Rule Set View Style (on page 135)

Labels Tab (Edit Ruleset View Style Dialog Box)


Specifies the label rules used within the marine mode rule set view style.
View Label Rule
Controls placement of view names. Select More to open the Select View Rule dialog box
and select the needed rule.
View names are specified by the View Naming Rule property in the View
Definition dialog box. For more information, see General Tab (Setup Dialog Box - Drawings
by Rule) in the Orthographic Drawings User's Guide.
Ship Direction Rule

Drawings and Reports Reference Data Guide 132


Tools Menu

Controls placement of direction symbols for Port, Starboard, Forward, Aft, Up, and Down.
Select More to open the Select View Rule dialog box and select the needed rule.
See Also
Define View Style Dialog Box (on page 58)
Define View Style Command (Tools Menu) (on page 56)
Edit Ruleset View Style Dialog Box (on page 118)
Create a Rule Set View Style (on page 135)

General Tab (Edit Ruleset View Style Dialog Box)


Specifies miscellaneous rules used within the marine mode rule set view style.
Preview View Style
Specifies the view style used for preview geometry after a view is placed, but before
generating an update of the view. Select More to open the Select View Rule dialog box and
select the needed view style.
Added Object Color
Specifies the geometry color for added objects used by the Update view generation mode.
The default value is <Default from View Style>.
Modified Object Color
Specifies the geometry color for modified objects used by the Update view generation
mode. The default value is <Default from View Style>.
Deleted Object Color
Specifies the geometry color for deleted objects used by the Update view generation mode.
The default value is <Not Tracked>.
Associate Objects to View Command
Specifies which associate ribbon the software displays when associating objects to a view.
Select one of the following:
 Default (List-Based) - Displays a list-based Ruleset View Ribbon.
 Default (Step-Based) - Displays a step-based Ruleset View Ribbon. This ribbon
provides the most flexibility, including the ability to orient the drawing view by the local
coordinate system of a part selected in the graphic view.
 Expansion - Displays the Expansion View Ribbon for use with expansion drawings.
 Generic - Displays a step-based Ruleset View Ribbon designed specifically for the
generic rule set.
For more information about these ribbons, see Associate Objects to View in the
Orthographic Drawings User's Guide.

Drawings and Reports Reference Data Guide 133


Tools Menu

Intersection Edges
Creates lines where surfaces intersect each other. Select Off to omit all surface intersection
lines. Select Low Resolution to draw all lines except b-splines between intersecting
surfaces. Select High Resolution to draw all lines including b-splines between intersecting
surfaces. For example, changing from Off to High Resolution would produce the following
effect for your graphics:

High Resolution draws the most detail but increases view generation time.
Preserve Z Order
Maintains the three-dimensional order of resymbolized graphics. This setting overrides the
top-down ordering in the graphic rules of a view style. A cleaner-looking drawing results if
this option is selected. Select Yes to turn on the option. For example, pipe gaps display
according to their layering in the 3D model:

Projector
Defines the scaling method used for a manufacturing sketch. Select one of the following:
 Mfg Sketch - Not to Scale - Fits the sketch and all information into a fixed-size view. All
geometry, symbols, and annotations are clearly displayed, but the geometry is not to
scale. This is the typical selection for fixed-size manufacturing sketches.
 Mfg Sketch - To Scale - Draws geometry to scale. Geometry, symbol, and annotation
display is similar to the Part Monitor in the Structural Manufacturing task.
Additional View Inputs
Defines the .xml file from which to import additional view properties for the selected view
style. The view properties from the selected .xml file display on the View tab in the Drawing
View Properties dialog box. For more information, see Drawing View Properties Dialog Box
in the Smart 3D Orthographic Drawings User's Guide.

 Additional View Inputs is only supported for generic rule sets.


 To display the additional view properties, the value for the IsShowOnPropertyPage
attribute in the .xml file must be 1.

Drawings and Reports Reference Data Guide 134


Tools Menu

 You can either select a delivered .xml file, or create a new .xml file. You can also edit
the delivered Steel Order Extensions.xml file, located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DBRRules\AdditionalViewInputs folder,
to add or remove view properties.
See Also
Define View Style Dialog Box (on page 58)
Edit Ruleset View Style Dialog Box (on page 118)
Define View Style Command (Tools Menu) (on page 56)
Create a Rule Set View Style (on page 135)

Create a Rule Set View Style


The following procedure steps you through creating a marine mode rule set view style with the
Tools > Define View Style command.
1. Select Tools > Define View Style. The Define View Style dialog box displays.
2. In the View Style Type box, select the Ruleset view style type.

3. Click New Style to create a new rule set view style. Click Rename to change the
name of the new style.
4. Select the new rule set view style, and click Properties to open the Edit Ruleset View
Style dialog box.
5. On the Name tab, specify a name and description for the new rule set view style.
6. On the Actions tab, select the rule set you want to use in creating this view style definition.
The rule set determines the actions and options available for the rule set view style and
populates the Actions table.
7. In the Actions table, define the Source/Action combinations you want to include in this rule
set view style. Each source shows an action to be performed. You can add a new action
from the list of Source items. You can add more than one action belonging to the same
source. For example, a Plate Part source could have several different actions assigned on
multiple rows in the table.
8. For each row, set the needed Filter and Custom tests that the rule set view style runs to
identify the objects included in the drawing.
9. If you want to include an add-on rule set view style as part of your primary view style, go to
the AddOn tab to import the add-on style.
10. For each row, set the needed Graphic, Label, and Dimension rules applied to the drawing
output.
You can use symbols as part of the rule set view style for drawings by rule. The
symbols can display as part of the drawing view, enhancing graphic objects. You can also
place symbols on a drawing as a label in paper space.
11. On the Query tab, set the query to use. When you select a query, the Value field updates.
You can modify the value as needed.
12. On the Area tab, specify how the drawing area is computed for the view.
13. Click OK on the Edit Ruleset View Style dialog box to save the changes to the new rule set
view style.

Drawings and Reports Reference Data Guide 135


Tools Menu

14. Test your view style by creating drawings. You can edit the view styleas needed with Tools
> Define View Style.

Copy an Existing Rule Set View Style


You can also copy an existing rule set view style and modify it. There are two methods you can
use to copy rule set view styles:
1. In the [Reference Data Folder]\SharedContent\Drawings\Catalog\Rules\RulesetStyles
folder, copy the XML file for the rule set view style you need as a starting point and rename
the new file. In the Drawings and Reports task, select Tools > Define View Style. On the
Define View Style dialog box, select the copied rule set view style, and click Properties
to open the Edit Ruleset View Style dialog box and modify it as needed.
2. Click Tools > Define View Style. Select a rule set view style from the hierarchy and click
Properties . On the Name tab of the Edit Ruleset View Style dialog box, type in a new
name and make other changes to the rule set view style. Click OK. In the Name Change
message box, click Yes to save the new rule set style with the new name. The original rule
set view style is not changed. If you click No, the original rule set view style is saved with the
new name.

 The rules and associated files for view styles are found in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\RulesetStyles folder.
 To create an orthographic view style, see Create an Orthographic Drawing View Style (on
page 87).To create a key plan view style, see Create a Key Plan View Style (on page 88).
See Also
Define View Style Command (Tools Menu) (on page 56)
Edit Ruleset View Style Dialog Box (on page 118)

Delete a source on the Actions tab


To delete a Source item from the Actions tab:
1. Click on a row in the grid column to the right of Source. The row highlights.
2. Press Delete on the keyboard.

Add an Add-on View Style to an Existing Ruleset View Style


The following procedure steps you through adding an add-on rule set view style to a primary
rule set view style.
1. Select Tools > Define View Style.
The Define View Style dialog box opens.
2. Select Ruleset Styles as the View Style Type.
3. Select the view style to which you want to add the add-on rule set view style.
4. Click Properties .
The Edit Ruleset View Style dialog box displays, showing the definition for the selected
rule set view style.

Drawings and Reports Reference Data Guide 136


Tools Menu

5. On the AddOns tab, click the browse button in an AddOns table row.
The Select AddOn dialog box displays, showing a list of rule set styles.
6. Select an add-on rule set view style, and click OK.
7. In the Edit Ruleset View Style dialog box, click OK to save the changes to the view style.
8. In the Define View Style dialog box, click Close.
Add-ons can also be controlled by individual source actions. For more
information, see Apply an Add-on to a Source Action (on page 138).
In the example below, the AddOn - Grid Axis view style adds rulers based on a coordinate
system associated with the drawing view. All planes from the coordinate system are drawn as
well.
Without AddOn - Grid Axis:

Drawings and Reports Reference Data Guide 137


Tools Menu

With AddOn - Grid Axis:

See Also
Add-on Ruleset View Styles (on page 288)
Define View Style Command (Tools Menu) (on page 56)
Edit Ruleset View Style Dialog Box (on page 118)
AddOns Tab (Edit Ruleset View Style Dialog Box)

Apply an Add-on to a Source Action


1. If needed, add the needed add-on to the drawing view style:
Add an Add-on View Style to an Existing Ruleset View Style (on page 136)
The add-on must first be added to the view style before it can be applied to a
source within the view style.
2. If the Edit Ruleset View Style dialog box is not already open:
a. Click Tools > Define View Style.
The Define View Style dialog box displays.
b. Select Ruleset Styles as the View Style Type.
c. Select the needed view style.
d. Click Properties .
The Edit Ruleset View Style dialog box displays.
3. On the Actions tab, on the row for the needed source, select Edit Custom in the Graphic
box.

Drawings and Reports Reference Data Guide 138


Tools Menu

The Graphic Style dialog box displays.


4. To apply an add-on to the source, Select True in the Apply AddOn to Source field.
Each add-on rule set view style added to the drawing view style displays on the
AddOns tab. The default value for each is False.
5. Click OK.
6. In the Edit Ruleset View Style dialog box, click OK to save the changes to the view style.
7. In the Define View Style dialog box, click Close.
See Also
AddOns Tab (Graphic Style Dialog Box) (on page 129)
Define View Style Command (Tools Menu) (on page 56)

Change the End Cut Embedded Symbol Rule for a Source


Action
Some graphic actions used in the marine mode rule set view style accept symbol rules that
place symbols included with (embedded with) the object graphics. For example, in Steel Order
drawings, the target profiles or beams in a drawing view need to show the end cut symbols at
the end of the landing curve graphic. The action for the graphic rule used to draw the profile or
beam accepts an end cut symbol rule. For more information, see End Cut Embedded Symbols
(Steel Order Rule Set) (on page 1045).
To change the selected end cut symbol rules:
1. In the Define View Style dialog box, select a view style and click Properties .
2. In the Edit Ruleset View Style dialog box, select the Action tab.
3. For a value of Profile Part in the Source field of the grid, select Edit Custom... in the
Graphic box.
4. In the Graphic Style dialog box, select the Custom tab.
5. For the Property specified as EndCut Rule, ProfilePartEndCut is specified as the Value.
This is the default set of endcut embedded symbol rules.
6. Double-click Browse to open the EndCut dialog box and select a different rule.
See Also
Custom Tab (Graphic Style Dialog Box) (on page 129)
Define View Style Command (Tools Menu) (on page 56)

Apply Transparency to Members in a Ruleset View Style


The following procedure describes how to apply the Make Transparent VHL graphic rule option
to marine mode rule set view styles. It shows how you can use the Make Transparent option to
make a Member source transparent. For example, you might want to do this when a member
source uses the Insulation aspect, and you do not want the insulation to hide the member.
1. In the Drawings and Reports task, select Tools > Define View Style.
The Define View Style dialog box displays.
2. Select Ruleset Styles as the View Style Type,

Drawings and Reports Reference Data Guide 139


Tools Menu

3. Select a rule set view style and click Properties .


The Edit Ruleset View Style dialog box displays.
4. On the Actions tab, select a row with a Member source, or create a new action with a
Member source.
5. Click Edit Custom on the Graphic list for the row.
The Graphic Style dialog box displays.
6. On the Graphic tab:
 Select Visible/Hidden Edges (VHL) as the Graphic Rule Type.
 Select the Aspect (such as Insulation) that you want to make transparent.
 Click Show Aspect.
 Click For all objects in view or For other aspects of same objects from the Value list
for the Make Transparent property. For more information, see Visible/Hidden Edges
(VHL) (on page 734).
7. Click OK on all the view style dialog boxes to save the changes to the new graphic rule and
the view style.
See Also
Define View Style Command (Tools Menu) (on page 56)
Edit Ruleset View Style Dialog Box (on page 118)
Graphic Tab (Graphic Style Dialog Box) (on page 126)

Key Plan Style Dialog Box


Sets options for a key plan view style. You can open this dialog box from the Select View Style
dialog box by selecting KeyPlan in the View Style Type box, selecting a view style from the list,
and then clicking Properties .
Name
Specifies the name of the key plan style.
Description
Describes the key plan style.
Key Plan Type
Specifies a type for the key plan. The properties displayed depend on the key plan type you
select. Select one of the following options:

Drawings and Reports Reference Data Guide 140


Tools Menu

 One Volume with Plant View - Shows the full plant view with a "you are here"
representation for the associated volume, as shown in the example below.

 Natural Volumes Only - Specifies a key plan which displays the volumes by natural
size. The key plan layout is based on the size of each volume, which can be irregular if
the volumes are of different sizes, as shown in the example below.

 Normalized Volumes Only - Specifies a key plan that is arranged in a normalized


manner. Each volume has the same amount of space in the key plan, as shown in the
example below. The Default key plan that is delivered with the software is an example
of this type of key plan.

One Volume with Plant View Properties


 Coordinate System - Provides a list of all coordinate systems in the model. It also includes
the value Use the Coordinate System of Related View. Selecting this value will cause the
key plan to use the same coordinate system as the associated drawing view.

Drawings and Reports Reference Data Guide 141


Tools Menu

 Range Filter - Specifies the range to display beyond the associated volume. The range filter
determines the range and what objects can be displayed in the key plan view. For example,
if you want to have equipment and grids shown in the key plan view, both must be included
within the range filter and not only in the filters that are used in the volume view style
associated with the key plan view style. Click More to display the Select Filter dialog box.
For more information, see Select Filter Dialog Box (on page 143).
 Orientation - Provides a list of orientations available for the key plan type.
 View Style - Specifies the style used to display the key plan graphics. Click More to display
the Select View Style dialog box and select the view style type and a view style. The
selected view style type filters the available styles found in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules folder.

Natural Volumes Only Properties


 Coordinate System - Provides a list of all coordinate systems in the model. It also includes
the value Use the Coordinate System of Related View. Selecting this value will cause the
key plan to use the same coordinate system as the associated drawing view.
 Search Range in X direction (Multiple of volume width) - Specifies a search range as a
multiple of the volume width. This width defines the horizontal extents the software uses to
locate another drawing volume with the same parent as the current drawing.
 Search Range in Y direction (Multiple of volume height) - Specifies a search range as a
multiple of the volume height. This height defines the vertical extents the software uses to
locate another drawing volume with the same parent as the current drawing.
 View Style - Specifies the style used to display the key plan graphics. Click More to display
the Select View Style dialog box and select the view style type and a view style. The
selected view style type filters the available styles found in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules folder.

Normalized Volumes Only Properties


 Coordinate System - Provides a list of all coordinate systems in the model. It also includes
the value Use the Coordinate System of Related View. Selecting this value will cause the
key plan to use the same coordinate system as the associated drawing view.
 Search Range in X direction (Multiple of volume width) -Specifies a search range as a
multiple of the volume width. This width defines the horizontal extents the software uses to
locate another drawing volume with the same parent as the current drawing.
 Search Range in Y direction (Multiple of volume height) -Specifies a search range as a
multiple of the volume height. This height defines the vertical extents the software uses to
locate another drawing volume with the same parent as the current drawing.
 Alignment in X direction (Multiple of volume width) - Specifies an alignment tolerance as
a multiple of the volume width. This tolerance determines whether to align the vertical sides
of volumes within the key plan. The larger the tolerance, the more likely the vertical sides will
align.
 Alignment in Y direction (Multiple of volume height) - Specifies an alignment tolerance
as a multiple of the volume height. This tolerance determines whether to align the horizontal
sides of volumes within the key plan. The larger the tolerance, the more likely the horizontal
sides will align.

Drawings and Reports Reference Data Guide 142


Tools Menu

 Normalized in X direction (Multiple of volume width) - Specifies a resizing tolerance as a


multiple of the volume width. This tolerance determines whether to represent volumes within
the key plan with the same width as the volume of the current drawing. The larger the
tolerance, the more likely the volumes will be resized.
 Normalized in Y direction (Multiple of volume height) - Specifies a resizing tolerance as
a multiple of the volume height. This tolerance determines whether to represent volumes
within the key plan with the same height as the volume of the current drawing. The larger the
tolerance, the more likely the volumes will be resized.
 View Style - Specifies the style used to display the key plan graphics. Click More to display
the Select View Style dialog box and select the view style type and a view style. The
selected view style type filters the available styles found in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules folder.

 To apply a style to the volume of the current drawing in the key plan, use the term KEY
PLAN FOCUS ELEMENT in the Filter column of the key plan view style and then assign a
graphic rule. You must use uppercase letters for the term.
 Normalized key plan types do not support the use of graphic modules in their key plan view
styles.
 One Volume With Plant View key plan types do support the use of graphic modules in their
key plan view styles. For example, you can use the VolumeWireFrame.dll graphic module
to prevent the volume of the current drawing from obscuring objects within it.
See Also
Define View Style Command (Tools Menu) (on page 56)
Create a Key Plan View Style (on page 88)

Select Filter Dialog Box


Creates, edits, deletes, and selects filters for use with the Define Workspace, Surface Style
Rules, and other Select by Filter commands, including Project Management's Model Data
Reuse (MDR), Drawings View Styles, and Reports commands that require runtime filter
selection. You can access this dialog box in several ways.
 Select File > Define Workspace, and select the More option in the Filter box.
 Select Format > Surface Style Rules, click New or Modify, and then select the More
option in the Filter box.
 Select Tools > Select by Filter.
The tree view displays the following types of filters:
 Catalog Filters - These filters are used to reference data in the Catalog. For example, a
catalog filter could apply to company-wide operations. Your administrator can define
Company_Filter_1, Company_Filter_2, and so forth.
 Model Filters - These filters are available to everyone assigned to a specific model
database. There are delivered catalog filters to query on the different types of model objects.
You must have the appropriate privileges to create, edit, or delete these filters.
 My Filters - These are personal filters that you create and place in the My Filters folder.
They are visible only to you, the owner. You cannot see the personal filters of others, and

Drawings and Reports Reference Data Guide 143


Tools Menu

they cannot see your personal filters. Select a filter from one of the listed filters, or create a
new filter to meet your specific requirements.
New Folder
Creates a new folder.
New Filter (Simple or Asking)
Displays the New Filter Properties dialog box so that you can create a new filter. Asking
filters allow you to specify the parameters of the search. An asking filter has built-in
functionality to ask for values (with boxes that you are required to supply). The values apply
to properties that you have already designated you will supply when the filter runs. Asking
filters are portable between models.
Model Data Reuse (MDR) does not support asking filters. The only valid filter
types for an MDR transaction are System, Permission Group, Object Type, Volume and
Properties. You can define the filter on any one of these tabs or in a combination using
multiple tabs.

New Compound Filter


Displays the New Compound Filter Properties dialog box, which you use to create a new
compound filter containing the Or, And, or Not operators. Compound filters are not
supported for MDR.
New SQL Filter
Displays the New SQL Filter Properties dialog box, in which you can type the text of an
SQL query. SQL filters are not supported for MDR
Delete
Removes a filter or folder from the Select Filter list. If you delete a folder, the software also
deletes its contents.
Rename
Changes the name of an existing filter or folder from the Select Filter list.
Properties
Displays the Filter Properties dialog box so that you can select the properties that
determine your filter search criteria.

 If this dialog box is activated from the Select by Filter command, you can select multiple
filters on this dialog box. Hold CTRL or SHIFT, and click each filter. When you click OK, all
objects that fit the selected filters are selected.
 If this dialog box is activated from the Select by Filter command, it clears the select set
before adding objects to the select set.

Drawings and Reports Reference Data Guide 144


Tools Menu

Define Layout Style Command (Tools Menu)


Defines layout styles that control the position of the drawing views associated with a drawing
region. You can select an existing layout style and modify its properties or create a new layout
style. This command displays the Define Layout Style dialog box, which lists the available
styles.

Define Layout Style Dialog Box (on page 146)


The layout styles you create are available when you use the Tools > Edit Layout Template
command to create and edit regions within a layout template. For more information on layout
templates, see Edit Layout Template Command (Tools Menu) (on page 152).
You can have multiple regions on a layout template, and each region can use a different layout
style. After you have created your layout template with its regions and layout styles in the
Drawings and Reports task, you can use the layout template to create drawings in the Drawings
and Reports task or from Tools > Drawing Console in a 3D task.

After you create layout styles, use Edit Template on the shortcut menu of a marine
mode drawings by rule component to specify the layout styles used for the component drawings
and to place regions using the layout styles. For more information, see Edit a Drawings by Rule
Template in the Orthographic Drawings User's Guide.
See Also
Define a Layout Style (on page 147)

Drawings and Reports Reference Data Guide 145


Tools Menu

Define Layout Style Dialog Box


Defines layout styles for use with drawing regions, sheets, and documents within layout
templates. This dialog box displays when you select Tools > Define Layout Style.
You can select an existing layout style to modify or create a new layout style.
New Folder
Adds a new layout style folder to the hierarchy.
New
Displays the Edit Layout Style dialog box so you can create a new layout style. For more
information, see Edit Layout Style Dialog Box (on page 146).
Delete
Deletes the selected layout style from the hierarchy.

Rename
Allows you to rename the selected layout style.
Properties
Displays the Edit Layout Style dialog box so you can view and edit an existing style. Select
an existing style in the hierarchy before choosing this option. You can also double-click an
existing style to display the properties. For more information, see Edit Layout Style Dialog
Box (on page 146).
Select Layout Style to Edit
Shows a hierarchy of existing layout styles. If you are creating a new layout style, make sure
you place it in the correct folder in the hierarchy.
See Also
Define Layout Style Command (Tools Menu) (on page 145)

Edit Layout Style Dialog Box


Defines layout style properties. This dialog box displays when you select New or Properties
on the Define Layout Style dialog box.
Style name
Displays the name of the existing style. You can also type a new name for a new layout
style.
Description
Provides a description of the layout style.
Layout Processor
Displays a layout processor which defines how the drawing region behaves and how many
views it accepts. Each style is a variation of the layout processor, depending on the
properties set.

Drawings and Reports Reference Data Guide 146


Tools Menu

DefaultLayoutProcessor.dll
This processor allows you to choose a predefined arrangement of views to be aligned and
managed inside a region. Some of the delivered examples provide four views arranged in a
checkerboard fashion, four tall views aligned vertically, and four wide views aligned
horizontally. Other delivered examples increase the number of views, using similar
arrangements. If you define the region to have a layout style for four views, but you attempt
to place six views within the region, the software moves the extra drawing views to an
unmanaged area of the drawing sheet outside the region.
When you select a processor, the properties table updates so you can specify the properties
for the layout style.
See Also
Define Layout Style Command (Tools Menu) (on page 145)

Define a Layout Style


1. Select Tools > Define Layout Style.
The Define Layout Style dialog box displays.
2. Select an existing layout style and click Properties .
The Edit Layout Style dialog box displays.
3. Edit the layout properties as needed. You can also change the name of the existing style to
create a new layout style based on the old one.
4. Click OK.

 To create a new layout style, select a folder on the Define Layout Style dialog box and click
New . The new style is created in the selected folder.
 To create a new folder in the hierarchy, click New Folder .
See Also
Define Layout Style Command (Tools Menu) (on page 145)
Edit Layout Style Dialog Box (on page 146)

Set up custom layout processor modules


Layout processors are similar to wrappers and query interpreters for labels. You can load these
layout processors from the symbol share to simplify deployment of content packages.
1. Create a folder for the custom module in the [Product
Folder]\SmartPlant\3DRefData\SharedContent\bin\LayoutProcessors or [Product
Folder]\SmartPlant\3DRefData\SharedContent\Custom Symbols\LayoutProcessors folder.
The path must include the LayoutProcessors folder so that the layout processor
modules display in the Layout Processor list in the Edit Layout Style window.
2. Start Project Management.
3. Select the Catalog database.
4. Click Tools > Update Custom Symbol Configuration.
Smart 3D updates the information in CustomSymbolConfig.xml.

Drawings and Reports Reference Data Guide 147


Tools Menu

5. Use a text editor to open the SystemSymbolConfig.xml or CustomSymbolConfig.xml file in


the SharedContent\XML folder, and find the Prog ID of the custom module to load.

6. Type the Prog ID of the custom module as the module name in the layoutstyle.xml file.

Create a new layout style with custom layout processors


Custom layout processors must be written to the before you can use them to create layout
styles. For more information, see Set up custom layout processor modules (on page 147).
1. Start Drawings and Reports.
2. Click Tools > Define Layout Style.
The Define Layout Style Dialog Box (on page 146) displays.
3. Click New .
The Edit Layout Style Dialog Box (on page 146) displays.
4. Select the module to use from the Layout Processor list.

 Hover the cursor over the file name to display the full path to the module.
 Smart 3D lists all modules and .dll files under the SharedContent folder. The software
includes only custom modules under the LayoutProcessors folder. These custom
modules display the Prog ID rather than the .dll file name.
5. Type the Style Name, and click OK.

Drawings and Reports Reference Data Guide 148


Tools Menu

Edit Border Template Command (Tools Menu)


Opens a drawing border template in SmartSketch Drawing Editor for editing. You can then place
drawing property labels and manual graphics. This command displays the Select Template
dialog box, which lists the available templates.
Graphic objects used in the templates must be embedded, not linked, using the
Insert > Object command in SmartSketch Drawing Editor when editing the drawing or the
drawing template.

Select Template Dialog Box (on page 150)

Using Layers
When you place drawing property labels, SmartSketch Drawing Editor automatically makes the
DwgTemplate layer active. The labels must be on this layer to preserve them when you update
the drawing. You should not place manual markups on the DwgTemplate layer. Layers are
viewed using Tools > Layers in SmartSketch Drawing Editor.

If you use other native SmartSketch Drawing Editor commands (such as Place Line or Place
Dimension) to add manual markups to the template, put them on any layer in the template in
order to preserve the changes when you update drawings.
For more information on layers, see Layers (SmartSketch Drawing Editor Tools Menu) in the
Orthographic Drawings User's Guide.

Importing Border Files from Other Software


You can use a border file you created in MicroStation (DGN) or AutoCAD (DWG) as a border
template in 3D drawings. You can import the DGN or DWG file to SHA (the native SmartSketch
Drawing Editor format) and place a drawing area within the border. For more information, see
Import a Border File and Create a Drawing Area (on page 150).

 You can create new border templates. For more information, see Create Border and Layout
Templates (on page 151).
 The drawing area is the area on a border template in which you place views. Each border
template has a drawing area. When you create new drawings, a layout template and a
border template merge together to form the new drawing. A single view layout arrangement
works with multiple border sizes. For more information on using layouts with borders, see
Edit Layout Template Command (Tools Menu) (on page 152).

Drawings and Reports Reference Data Guide 149


Tools Menu

Select Template Dialog Box


Specifies a border template. This dialog box displays when you click Tools > Edit Border
Template. It also displays the first time you edit a template for a volume component. The
templates listed in this dialog box are located on the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Templates folder.
You select a template on this dialog box, and then click OK, or you can double-click a template.
The template then opens in SmartSketch Drawing Editor.
The application delivers a set of imperial and metric border templates. The names of the
templates indicate their size. The delivered imperial and metric border templates contain border
labels. Some of the templates also contain a label to display notes. The naming convention
indicates which templates contain this label.
See Also
Edit Border Template Command (Tools Menu) (on page 149)

Import a Border File and Create a Drawing Area


This procedure shows you how to import a file (MicroStation DGN or AutoCAD DWG) so that
you can edit it in the Drawings and Reports task and create a border template.
The drawing area is the area on a border template in which you place views. Each
border template has a drawing area. When you create new composed drawings, a layout
template and a border template combine to form the new drawing. A single view layout
arrangement works with multiple border sizes. For more information on using layouts with
borders, see Edit Layout Template Command (Tools Menu) (on page 152) and Edit Border
Template Command (Tools Menu) (on page 149).
1. From the Start menu, open SmartSketch Drawing Editor.
2. Click File > Open to open the DGN or DWG border file.
3. Save the file as an SHA file to the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Templates folder, and exit SmartSketch Drawing
Editor.
4. In the Drawings and Reports task, click Tools > Edit Border Template.
The Select Template dialog box displays.
5. Select the imported SHA file from the hierarchy on the dialog box, and click OK.

Drawings and Reports Reference Data Guide 150


Tools Menu

6. The imported border file opens in SmartSketch Drawing Editor. Place a drawing area using
Place Drawing Area . Click and drag to place the drawing area. For more information,
see Place Border Area Command in SmartSketch Drawing Editor Help.

The Place Drawing Area command creates a rectangle object and sets the
properties as needed for the drawing area. You can only place one drawing area per border
template. If you open a border template that already has a drawing area specified and try to
place a drawing area using this command, an error message displays.
7. Edit the template as needed, saving your changes in SmartSketch Drawing Editor.
After you edit your border templates, go to a the Drawings and Reports task, or Tools >
Drawing Console in a 3D task, and create new drawings that use this border.
See Also
Edit Border Template Command (Tools Menu) (on page 149)

Create Border and Layout Templates


This procedure shows you how to create a new border or layout template so that you can edit it
in the Drawings and Reports task. You can edit existing templates using commands on the
Tools menu. For more information, see Edit Border Template Command (Tools Menu) (on page
149) and Edit Layout Template Command (Tools Menu) (on page 152).
1. Copy an existing template .sha file in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Templates\Imperial (or Metric) folder.
2. Rename the new file.
3. In the Drawings and Reports task, select Tools > Edit Border Template if the new template
is a border template. Use Tools > Edit Layout Template if the new template is a layout
template.
4. Edit the new template as needed, saving your changes in SmartSketch Drawing Editor.
After you edit your border and layout templates, go to the Drawings and Reports task, or Tools
> Drawing Console in a 3D task and create new drawings using the template.

Drawings and Reports Reference Data Guide 151


Tools Menu

When creating a border template, the border graphics should be created in the
Working Sheets view. If the border template is created in the Background Sheets view, the
border will not be visible when a drawing is created. The Switch Border command will also not
work correctly if the drawing border was created in the Background Sheets view. For more
information on these views, see the SmartSketch Drawing Editor Help.
See Also
Select Layout Template Dialog Box (on page 153)
Select Border Family Dialog Box (on page 154)

Edit Layout Template Command (Tools Menu)


Opens a drawing layout template in SmartSketch Drawing Editor for editing. You can then
assign the template to a set of border templates that can be used with the layout template (a
border family). After you specify a border family, the layout template opens in SmartSketch
Drawing Editor for modification. This command displays the Select Layout Template dialog
box, which lists the available templates.

Select Layout Template Dialog Box (on page 153)

Select Border Family Dialog Box (on page 154)


You can create a new layout template or edit an existing layout template. For more information,
see Create Border and Layout Templates (on page 151) and Edit a Layout Template (on page
154).

Drawings and Reports Reference Data Guide 152


Tools Menu

When a layout template is open in SmartSketch Drawing Editor, you can place drawing regions,
views, and reports, edit the border family, and preview the layout against the border templates.
For more information on the commands available, see Drawing Compose Toolbar in
SmartSketch Drawing Editor Help.

 Layout templates are available when you create composed drawings in a 3D task using the
Tools > Drawing Console command. For more information, see Composed Drawings (on
page 44).
 The selected templates and layout styles for the Edit Layout Template command cannot
be read-only. To edit the template and style permissions, contact your administrator.
 The drawing area is the area on a border template in which you place views. Each border
template has a drawing area. When you create new drawings, a layout template and a
border template merge together to form the new drawing. A single view layout arrangement
works with multiple border sizes. For more information on using layouts with borders, see
Edit Border Template Command (Tools Menu) (on page 149).

Select Layout Template Dialog Box


Specifies the layout template you want to edit. This dialog box displays when you select Tools >
Edit Layout Template.
You select a template on this dialog box, and then click OK. The template then opens in
SmartSketch Drawing Editor.
For a new template, the Select Border Family also displays so you can specify the border
templates you want to associate with this layout template. For more information, see Select
Border Family Dialog Box (on page 154).

Drawings and Reports Reference Data Guide 153


Tools Menu

You can place regions, place views, place reports, change the border family, and preview the
layout against the border templates. For more information on the commands available, see the
SmartSketch Drawing Editor Help.
Inactive buttons on this dialog box are not supported.
See Also
Edit Layout Template Command (Tools Menu) (on page 152)
Create Border and Layout Templates (on page 151)
Edit a Layout Template (on page 154)

Select Border Family Dialog Box


Specifies the border templates to associate with the layout template. This dialog box displays
when you create a new layout template, and click OK on the Select Layout Template dialog
box. You can multi-select borders by holding down the CTRL key while selecting borders from
the hierarchy.
See Also
Select Layout Template Dialog Box (on page 153)
Edit Layout Template Command (Tools Menu) (on page 152)
Create Border and Layout Templates (on page 151)

Edit a Layout Template


1. Select Tools > Edit Layout Template.
The Select Layout Template dialog box displays.
2. Select an existing layout template, and click OK.
The template opens in SmartSketch Drawing Editor, and the Select Border Family dialog
box displays.
3. Select the borders you want to associate with the open layout template, and click OK.
4. A heavy black border indicates the layout area of the template. You can select the layout
area and position it as needed within the template.
5. Use the commands available in SmartSketch Drawing Editor to place regions, place views,
place reports, edit the border family, and preview the layout against the selected border
templates. For more information, see the SmartSketch Drawing Editor Help.
After you create your layout templates, go to a 3D task and create new composed drawings
using the layout template.

Deleting a Region from a Layout Template


Regions are used to manage the positioning of views within a layout template. For more
information on placing regions, see the SmartSketch Drawing Editor Help. Additional information
is available in Composed Drawings (on page 44).

Drawings and Reports Reference Data Guide 154


Tools Menu

1. To delete a region from a layout template, use PickQuick to select the outer boundary of
the region.

2. After selecting the region outer boundary, select Edit > Delete to remove the region
definition. You can also press the Delete key on the keyboard. Any views placed within the
region remain on the layout template as unmanaged views.

Drawings and Reports Reference Data Guide 155


Tools Menu

See Also
Edit Layout Template Command (Tools Menu) (on page 152)
Select Layout Template Dialog Box (on page 153)
Select Border Family Dialog Box (on page 154)

Custom Commands
Provides you with application programming capability for the 3D software. Using Microsoft®
Visual Basic, you can create a custom command that groups a series of commands and
instructions into a single command that runs as an operation in the 3D software. As a result, you
can access the customized commands that directly relate to the work routine in your operation.
In Visual Basic, the Command Wizard helps you to build a custom command. For example, the
first Command Wizard step prompts you to identify general information, including command
name, project name, author, and company. You can start the wizard in Visual Basic by clicking
Command Wizard on the Add-Ins menu. For more information about installing the Command
Wizard and other programming resources, see the Intergraph SmartTM 3D Installation Guide
available by clicking Help > Printable Guides in the software.
After adding a custom command in the 3D software, you can edit it. The Edit Custom
Command dialog box requires you to specify the program identifier (prog_id), command name
and description, command priority, and a command line of arguments in a string.

Delivered Custom Commands


The following list provides descriptions and ProgIDs for the delivered custom commands:

Custom ProgID Description


Command

Check SP3DCheckDatabaseIntegrity Creates records for the objects that need to be


Database . cleaned. You run this custom command directly
Integrity CCheckObj on a database (Site, Catalog, or Model). After you
run this command, you can generate a report to
review the errors that the Check Database
Integrity command generated. For more
information on the Check Database Integrity
command, see the Database Integrity Guide
available from Help > Printable Guides.

Clean SP3DCleanDatabaseCmd. Deletes or cleans an object. This command is


Database CCheckObj used when an action on the Check Database
Integrity report is To Be Removed or To Be
Repaired. For more information on deleting and
cleaning objects in the database, see the
Database Integrity Guide available from Help >
Printable Guides.

Drawings and Reports Reference Data Guide 156


Tools Menu

Custom ProgID Description


Command

Create MenuDrawView. Saves and converts the contents of a


Drawing View CMenuDrawView three-dimensional graphic view window into a
snapshot view. The command creates a
rectangular object associated to a clipping volume
or volumes in the three-dimensional model.
Before you create a snapshot view using this
command, you must have added at least one
composed drawing type to the Management
Console in the Drawings and Reports task.
You can save additional views by updating the
view contents and then saving the new design. If
you used the Tools > Hide command to avoid
displaying certain objects, those objects are
included in a composed drawing you create.
You must have appropriate permissions to access
composed drawing types, or you cannot use the
Tools > Snapshot View command. If you have
only read permission, you receive a message that
alerts you to this condition.
After you create the snapshot views, you can add
them to composed drawings when you use the
Tools > Drawings Console command.

Drawings DwgCheckUtility,Ingr.SP3D. Checks drawing items for problems, such as


Check and Drawings.Client.Commands. mismatches between views, smartframes, and
Repair Utility DwgCheckUtility. OIDs; duplications of views, smartframes, and
RunChecksCmd OIDs; and invalid dimensions with missing
smartframe attributes. After problems are found,
you can run repairs.
This command is intended for use by your
administrator.

Find Object SP3DFindObjectByReport. Finds objects with integrity problems in a graphic


by OID FindObjects view. Before running this command, you must
define your workspace to include these objects.
Run a database integrity report, and use the
reported OIDs of the objects in the workspace
definition. For more information on the Find
Objects by OID custom command, see the
Database Integrity Guide available from Help >
Printable Guides.

Fix Project SP3DPRJMGTRepairCmd. Synchronizes the model name in the Model


Root FixCnfgProjectRoot database and the Site database. The name in the
Site database prevails.
You must run this command from a

Drawings and Reports Reference Data Guide 157


Tools Menu

Custom ProgID Description


Command
task in the model, not from Project Management.

Fix Sector DwgBinaryEditorCmd. Adjusts the sector size from small to large.
Size of FixSectorSize Documents that have many sheets and a small
Documents sector size can cause the software to run out of
memory.

Reset Design IMSEngFrameworkCmd. Modifies the Design Basis timestamp. With this
Basis Time EngFrameworkCmd command, you can set the time and date back to
Argument = a point in the past. This command is useful if, for
ResetDesignBasisTime any reason, there are delete instructions that
could not be processed.

Synchronize DwgSynchTemplatesCmd.Sy Repairs a drawing component that has become


Drawing nchTemplates corrupted by synchronizing it with a different,
Component uncorrupted drawing component. This command
Templates requires that the source component is the same
type as the corrupted component, the source
component must have a template, and that the
source component cannot be corrupted. Also, the
number of views on the source component must
be the same as the number of views on the
corrupted component. The names of the views on
the source component must match the view
names of the corrupted component.

Verify P&ID SP3DDisplayPIDService. Validates the internal connections between


Integrity VerifyPIDCmd objects on a P&ID and objects in the Model
database. This command is useful when there is
a problem displaying a P&ID or selecting objects
on a P&ID. The command provides some basic
troubleshooting statistics: Number of design basis
objects, number of 3D objects (correlated),
number of P&ID objects, number of deleted P&ID
OIDs, and number of duplicate OIDs.

Custom Commands Dialog Box (on page 160)


Add Custom Command Dialog Box (on page 161)
Edit Custom Command Dialog Box (on page 161)

What do you want to do?


 Create custom commands (on page 159)
 Add custom commands (on page 159)
 Run a custom command (on page 159)
 Edit a custom command (on page 159)

Drawings and Reports Reference Data Guide 158


Tools Menu

 Delete a custom command (on page 160)

Create custom commands


1. Open Microsoft® Visual Basic.

 You do not create or modify custom commands within the software. You can edit the
code of the command in Visual Basic. You can edit a limited number of items, such as
the description of the command, using the Edit Custom Command dialog box.
 You must install the Command Wizard software in Visual Basic. The setup for the
Command Wizard is located at [Product Folder]\CommonApp\Tools\CommandWizard.
2. In Visual Basic, click Add-Ins > Command Wizard.
3. Complete all steps on each page of the Command Wizard.

Add custom commands


1. Click Tools > Custom Commands.
2. On the Custom Commands dialog box, click Add.
3. On the Add Custom Command dialog box, type the program identifier you assigned to the
command in Microsoft® Visual Basic in the Command ProgID box.
4. Type the name you assigned to the command in the Command name box.
5. Type a phrase that describes the command in the Description box.
6. If necessary, change the option in the Priority section.
7. Type command line arguments in a string in the Argument box.
After you complete this procedure, the Custom Commands dialog box lists the
command you added to the software. You can run the command, edit the settings, or delete the
command.

Run a custom command


1. Click Tools > Custom Commands.
The Custom Commands dialog box opens.
2. To start a custom command you created, select the command in the list box, and click Run.
3. After the command runs, click Close on the Custom Commands dialog box.

Edit a custom command


1. Click Tools > Custom Commands.
The Custom Commands dialog box opens.
2. To change the options for a custom command, select the command in the list box, and click
Edit. For example, you can change the name and description of the command.

Drawings and Reports Reference Data Guide 159


Tools Menu

3. After completing the needed changes, click Close on the Custom Commands dialog box.
You must open the command in Microsoft® Visual Basic if you want to edit the
underlying code.

Delete a custom command


1. Click Tools > Custom Commands.
The Custom Commands dialog box opens.
2. Select the command in the list box, and click Delete. The software removes the command
from the list box; however, the command code is not deleted.
3. After completing the needed changes, click Close on the Custom Commands dialog box.
This action does not delete the DLL for the custom command. It just removes access
to the custom command from the Custom Commands dialog box.

Custom Commands Dialog Box


Adds and edits customized commands you have created with the Command Wizard in
Microsoft® Visual Basic. For information on creating custom commands, see Create custom
commands (on page 159).
Command names
Lists the names of commands that have been added.
Run
Starts the custom command you select in the list box. For more information, see Run a
custom command (on page 159).
Close
Cancels the Custom Commands dialog box.
Edit
Opens the Edit Custom Command dialog box. You can change settings for the command,
such as the program identifier (prog_ID) and command name. For more information, see
Edit a custom command (on page 159).
Add
Installs the custom command into the software. For more information, see Add custom
commands (on page 159).
Delete
Removes the custom command from the software. For more information, see Delete a
custom command (on page 160).
Clear
Deletes the information you have typed in the boxes on the Custom Commands dialog
box.
Description
Contains an identifying phrase so you can better recognize the custom command with which

Drawings and Reports Reference Data Guide 160


Tools Menu

you are working.

Add Custom Command Dialog Box


Accesses a customized command you created in Microsoft® Visual Basic and saves the
command within the software.
Command ProgID
Identifies the program identifier for the custom command you created in Visual Basic.
Command name
Specifies the name you assigned to the custom command.
Description
Describes the custom command.
Priority
Assigns a priority of High, Normal, or Low.
Argument
Specifies command line arguments in a string.
See Also
Create custom commands (on page 159)

Edit Custom Command Dialog Box


Changes options for a customized command you added to the software.
Command ProgID
Specifies the program identifier for the custom command you created in Microsoft® Visual
Basic.
Command name
Provides a text box for you to change the name you assigned to the custom command.
Description
Provides a text box to provide a descriptive phrase for the custom command.
Priority
Changes priority to High, Normal, or Low.
Argument
Change the command line arguments in a string.
Reset Default
Returns the dialog box to its default settings.
See Also
Create custom commands (on page 159)

Drawings and Reports Reference Data Guide 161


Tools Menu

Delivered Custom Commands


This section describes some of the delivered custom commands. For a comprehensive list of the
custom commands, see Custom Commands in the Common User's Guide.

Repair Documents Custom Command


The Repair Documents custom command updates invalid Styles.sha or Symbol Browser file
paths on a document or a set of documents. Invalid file paths can occur when you change the
symbol share. This causes overhead while editing, saving, or updating documents.
Click Tools > Custom Commands to add the command using the ProgID
DwgRepairCmd.RepairDocuments. For more information, see Custom Commands in the
Common User's Guide.
Each time you use Repair Documents, the changes made to the component or document are
saved in a log file. You can access the file at %TEMP%\Drawings. The log file name starts with
"DwgRepairCmd_" as its prefix. A summary at the end of the log file lists all documents that the
command could not repair.

Repair Documents Dialog Box


Component or Document
Specifies the component or document to repair.
Actions
Shows the repair options for the selected component or document.
 Reset style resources - Resets the style resource files and to the Styles.sha file on
the current symbols share.
 Set symbol browser home - Sets the symbol browser home address. You can change
this address by typing in a new address or by clicking More and opening the file
folder.

Drawings and Reports Reference Data Guide 162


SECTION 3

Drawings by Rule Reference Data


You can customize your marine mode rule set drawings by understanding and modifying the
delivered drawings by rule reference data. You can use reference input data for multiple drawing
types, or you can configure different inputs for each type of drawing. The customizable
reference data includes the following:
 Rule set view styles
 Packages
 Rule sets
 Labels, symbols, and dimensions
 Reports
 Spreadsheets used to bulk load reference data into the catalog
Other customizable elements common to all drawings by rule include the following:
 Lines styles
 Naming rules
 Add-ons
 Layout styles
 Collation rules
 Orientation rules

In This Section
Drawings by Rule Packages...........................................................164
Drawings by Rule View Styles ........................................................167
Drawings by Rule View Style Rule Sets .........................................190
Ruleset Custom Tests ....................................................................263
Add-on Ruleset View Styles ...........................................................288
Collation Rules in Drawings by Rule ..............................................293
Orientation Rules in Drawings by Rule ...........................................297
Layout Style Rules in Drawings by Rule ........................................302
Gathering Rules in Drawings by Rule ............................................307
Section View Orientation Rules in Drawings by Rule .....................308
Line Styles in Drawings by Rule .....................................................313
Document and Sheet Naming Rules in Drawings by Rule .............313
View Naming Rules in Drawings by Rule .......................................317
Drawings by Rule Reports ..............................................................319

Drawings and Reports Reference Data Guide 163


Drawings by Rule Reference Data

Drawings by Rule Packages


Packages contain definition information for one or more components, plus template and style
definitions. You can create new packages or modify existing packages. Drawing documents are
not saved as part of the package. When you save a package using the Save Package
command in the Drawings and Reports task, you specify where it is saved. You can save the
package on a single drawing, an entire folder, or even the entire root. You can also create your
own tab when you save your packages. The tab displays in the Add Component dialog box of
the New command.
Packages are saved in the [Reference Data Folder]\SharedContent\Drawings\Catalog\Packages
folder. A sub-folder exists for each type of delivered package. When you use the New command
to add a package to the Management Console, each tab of the Add Component dialog box
represents a sub-folder showing the available packages for each drawing type. For example,
you find pin jig packages on the Manufacturing tab.
The delivered marine mode drawings by rule packages include the following:
On the Ship tab of the Add Component dialog box:
 Drawings by Rule - Creates a Drawing by Rule component in the Console. The component
allows you to create empty drawings by rule to which you add the needed views.

Assembly Drawings
On the Ship tab of the Add Component dialog box:
 Assembly Method - Creates views of individual parts and an isometric of the assembly.
 Assembly Sequence - Creates views showing the sequence of parts.
 Assembly - Creates plan, elevation, and isometric views for an assembly. All views are on a
single drawing sheet.
 Assembly (Generic) - Creates plan, elevation, and isometric views for an assembly using
the more efficient generic ruleset. All views are on a single drawing sheet.
For more information, see Assembly Drawings in the Orthographic Drawings User's Guide.

Hull Line Drawings


On the Ship tab of the Add Component dialog box:
 Hull Lines - Creates body plan, plan, and profile views of the hull lines.
 Body Plan - Creates body plan views of the hull lines.
For more information, see Hull Lines Drawings in the Orthographic Drawings User's Guide.

Manufacturing Drawings
On the Manufacturing tab of the Add Component dialog box:
 Mfg PinJig - Contains an asking filter to select the pin jigs.
 Mfg Profile Sketch - Contains an asking filter to select the profile.
 Mfg Profile Sketch (Multiple) - Contains an asking filter to select the profiles.
 Mfg Template Set - Contains an asking filter to select the template sets.

Drawings and Reports Reference Data Guide 164


Drawings by Rule Reference Data

 Mfg Templateset (Full Scale) Package - Contains an asking filter to select the template
sets. For more information, see Mfg Templateset (Full Scale) Package (on page 166) in the
Drawings and Reports Reference Data Guide.
For more information, see Manufacturing Drawings in the Orthographic Drawings User's Guide.

Scantling Drawings
On the Ship Structure tab of the Add Component dialog box:
 Shell Expansion - Creates unfolded port and starboard views of shell plate.
 Steel Order by Block or Assembly - Creates transverse, longitudinal, deck shell
expansion, and shell profile views for plate and profile parts within selected blocks or
assemblies.
 Steel Order by Reference Planes - Creates a single drawing for each reference plane
selected as input.
 Steel Order (Expansion) - Creates expanded shell profile views for plate and profile parts.
 Steel Order (Shell Profiles) - Creates plan views of individual shell profiles, also showing
level 2 non-target parts connected to the profiles.
 Steel Order by Block or Assembly (Generic) - Creates transverse, longitudinal, deck shell
expansion, and shell profile views for plate and profile parts within selected blocks or
assemblies using the more efficient generic ruleset.
 Steel Order by Reference Planes (Generic) - Creates a single drawing for each reference
plane selected as input using the more efficient generic ruleset.
 Steel Order - Shell Profiles (Generic) - Creates plan views of individual shell profiles
showing level 2 non-target parts connected to the profiles using the more efficient generic
ruleset.
The Steel Order packages use scantling steel order rule sets and view styles for light
(non-detailed) parts created in the Molded Forms task and detailed parts created in the
Structural Detailing task. The packages also use short name and typical labels for profiles and
plates.
For more information, see Scantling Drawings in the Orthographic Drawings User's Guide.

Offshore Drawings
On the Offshore tab of the Add Component dialog box:
 Member Parts - Creates drawings of individual member parts and their connected parts.
Two views are generated for each member part: one in the -Z direction and one in the +Y
direction of the member local coordinate system.
 Member Parts (Generic) - Creates drawings of individual member parts and their
connected parts using the more efficient generic ruleset. Two views are generated for each
member part: one in the -Z direction and one in the +Y direction of the member local
coordinate system.
 Pipe Supports (Generic) - Creates end, side, isometric, and detail views of a pipe support.
All views are on a single drawing sheet.
 Piping (Generic) - Creates forward-looking elevation, port-looking elevation, isometric, and
plan views for a pipeline. All views are on a single drawing sheet.

Drawings and Reports Reference Data Guide 165


Drawings by Rule Reference Data

Baseline Drawings by Rule Package


You can also use the baseline Drawings by Rule component to create an empty drawing
package to which you can add views as needed. The Drawings by Rule component displays on
the Ship tab of the Add Component dialog box. After adding the package to a Management
Console folder, you can set it up with views and reports, specify the query definition, and create
drawings.
For more information on adding Drawings by Rule packages to the Management Console, see
Add a Component or Package in the Orthographic Drawings User's Guide.
See Also
Steel Order Drawing Rule Set (on page 225)
Drawings by Rule View Styles (on page 167)

Mfg Templateset (Full Scale) Package


Name: Mfg Templateset (Full Scale) Package
Description: This package creates Full Scale Templateset drawings for Templatesets. After
loading this component, the user can select a Block, Assembly Block or Assembly to create the
related set of Views and generate Drawings.
Sheet Size: A1 Wide
Number of Sheets: 1
Template Location: [Reference Data Folder]\SharedContent\Drawings\Catalog\Packages\Mfg
Templateset (Full Scale)\template.sha

Template Example

Drawings and Reports Reference Data Guide 166


Drawings by Rule Reference Data

Drawings by Rule View Styles


View styles are used as part of the definition of marine mode drawings by rule components. A
view style defines source objects and the following conditions for the source objects:
Catalog Filters
 Custom tests applied to the filters
 Graphic styles
 Label rules
 Dimension rules
 View queries
Using the Tools > Define View Style command in the Drawings and Reports task, you specify
the rule set you want to use for your drawing view style. When you create a new view style or
modify an existing style, you select the rule set and specify source conditions on the Action tab
of the Edit Ruleset View Style dialog box. You specify view query properties on the Query tab
of the Edit Ruleset View Style dialog box. For more information, see Define View Style
Command (Tools Menu) (on page 56). There is no need to directly edit the view style XML files.
All values are set in the Edit Ruleset View Style dialog box.
Each type of drawing uses a specific view style to achieve the appropriate output. The delivered
view style XML files are found in the [Reference Data Folder]\
SharedContent\Drawings\Catalog\Rules\RulesetStyles folder.
The following definitions apply to the view styles:
 Steel Order - Draws detailed and light (non-detailed) parts. Uses short name and typical
labels for profiles and plates.
 Expansion - Draws parts in their unfolded form.
 Preview - Provides limited output for graphics by providing a preview of the target plate. You
can use the preview to position the views or clip the smart frame before updating. The
preview also provides enough geometry to place section and details views. After updating
the view, the complete resymbolized geometry is shown.
 Shell Profiles - Draws individual shell profiles and level 2 non-target parts connected to the
profiles.
 Member Part - Draws members created in the Structure task.
The delivered view styles include:

Assembly Drawings
Uses AssemblyRuleSets.Default (see "Assembly Drawing Rule Set" on page 190):
 Assembly Drawings
 Assembly Drawings - Sequence
Uses Steel Order Drawing Rule Set (on page 225):
 Assembly - Drawing-by-rule-based assembly views
Uses Generic Rule Set (on page 191):

Drawings and Reports Reference Data Guide 167


Drawings by Rule Reference Data

 Assembly (Generic)

Hull Line Drawings


Uses HullLinesRulesets.DefaultRuleset (see "Hull Lines Drawings Rule Set" on page 196):
 Hull Lines - Body Plan - Default
 Hull Lines - Body Plan View (on page 170)
 Hull Lines - Plan View
 Hull Lines - Profile View

Manufacturing Drawings
Uses MfgPinJigRuleset.Default (see "Manufacturing PinJig Drawing Rule Set" on page 206):
 Mfg PinJig - Pin Data
 Mfg PinJig - Remarking Data
 Mfg PinJig SideView (on page 177)
Uses MfgProfileRuleset.DefaultRuleset (see "Manufacturing Profile Sketch Rule Set" on page
207):
 Mfg Profile Sketch (Multiple)
 Mfg Profile Sketch (on page 179)
Uses MfgTemplateRuleset.DefaultRuleset (see "Manufacturing Template Drawing Rule Sets" on
page 216) and MfgTemplateSetRuleSet.DefaultRuleSet (see "Manufacturing Template Drawing
Rule Sets" on page 216):
 Manufacturing Template (see "Manufacturing Template Drawing Rule Sets" on page 216)
 Mfg Template Set - Base Control Line
Uses MfgTemplatesetFullScale.DefaultRuleset (see "Manufacturing PinJig Side View Rule Set"
on page 222):
 Mfg Templateset - Full Scale (on page 181)

Scantling Drawings
Uses Steel Order Drawing Rule Set (on page 225):
 Shell Expansion (on page 182)
 Steel Order - Detail Views
 Steel Order - Preview
 Steel Order - Section Views
 Steel Order (Decks)
 Steel Order (Longitudinal Bulkheads)
 Steel Order (Reference Plane) (see "Steel Order - Reference Plane (Generic) View Style"
on page 184)
 Steel Order (Shell Expansion)

Drawings and Reports Reference Data Guide 168


Drawings by Rule Reference Data

 Steel Order (Shell Profiles)


 Steel Order (Transverse Bulkheads)
 Steel Order (see "Steel Order (Generic)" on page 188)
Uses Generic Rule Set (on page 191):
 Steel Order (Generic)
 Steel Order - Preview (Generic)
 Steel Order - Reference Plane (Generic)
 Steel Order - RefPlane - Preview (Generic)
 Steel Order - Section and Detail (Generic)
 Steel Order - Shell Profile (Generic)

Offshore Drawings
Uses Steel Order Drawing Rule Set (on page 225):
 Member Part
 Member Part – Preview
 Member Part – Section and Detail Views
For more information, see Member Part (on page 176).
Uses Generic Rule Set (on page 191):
 Member Part (Generic)
 Member Part - Preview (Generic)
 Member Part - Section and Detail (Generic)
Uses Generic Rule Set (on page 191):
 Pipe Supports - CAD Details (Generic)
 Pipe Supports - END (Generic)
 Pipe Supports - ISO (Generic)
 Pipe Supports - Key Plan (Generic)
 Pipe Supports - SIDE (Generic)
 Piping (Generic)

 Delivered view styles not listed here are obsolete and no longer supported.
 There is no need to directly edit the view style .xml files. All values are set in the Edit
Ruleset View Style dialog box. For more information, see Edit Ruleset View Style Dialog
Box (on page 118).
 Add-on rule set view styles enhance a view style by importing actions from one or more
external view styles. For more information on add-on view styles, see Add-on Ruleset View
Styles (on page 288).

Drawings and Reports Reference Data Guide 169


Drawings by Rule Reference Data

See Also
Drawings by Rule Reference Data (on page 163)

Hull Lines - Body Plan View


Name: Hull Lines - Body Plan View
File name: Hull Lines - Body Plan View.xml
Description: Creates a full body plan view, looking forward, with aft frames on the port side and
forward frames on the starboard side. View direction is global coordinate system, looking aft or
forward.

Actions Tab (Edit Ruleset View Style Dialog Box)


Ruleset used: HullLinesRuleSets.DefaultRuleset (see "Hull Lines Drawings Rule Set" on page
196)

Row Source Description

1 Hull Lines Draws hull lines aft of the separation plane on the port side of the body
plan view.

2 Hull Lines Draws hull lines at the separation plane between the port and starboard
sides of the body plan view.

3 Hull Lines Draws hull lines forward of the separation plane on the starboard side of
the body plan view.

All actions combined:

1 - Forward
2 - Aft
3 - Port
4 - Starboard
5 - Separation plane
6 - Trimming plane
7 - Port hull lines - Drawn when aft of
the separation plane
8 - Starboard hull lines - Drawn when
forward of the separation plane

Query
Hull plate systems
Separation planes are optional.

Drawings and Reports Reference Data Guide 170


Drawings by Rule Reference Data

Area (for view)


Rectangular with boundary overlap and fixed frame size.
Area Computation - Custom
Area Shape - Rectangular
Boundary Overlap - 5 mm
Frame Shape - Rectangular
Frame Border Style - Not drawn
Frame Behavior - Frame size is fixed

Add-ons used
AddOn - Grid Axis and Lines - Draws X (waterline) and Z (buttock) coordinate system axes
and grid lines. For more information, see Add-on Ruleset View Styles (on page 288).

View Labels
View label rule: Default
Ship direction rule (for arrow): None
For more information, see View Label Rules in Drawings by Rule (on page 920).

General Tab (Edit Ruleset View Style Dialog Box) (on page 133)
Preview View Style: Not supported
Added, Modified, Deleted Object Color: Not supported
Intersection Edges: Off
Preserve Z Order: No

Drawings and Reports Reference Data Guide 171


Drawings by Rule Reference Data

Example

See Also
Edit Ruleset View Style Dialog Box (on page 118)
How Actions are Applied to a View (on page 121)
Drawings by Rule View Style Rule Sets (on page 190)

1. Hull Lines (Hull Lines - Body Plan View)


Draws hull lines aft of the separation plane on the port side of the body plan view.

Drawings and Reports Reference Data Guide 172


Drawings by Rule Reference Data

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Hull None Finds all transverse From the lines found Labels the drawn None
Lines hull lines aft of the by the custom tests, lines with the
separation plane. draws normal black name of the grid
lines on the port side plane.
of the view.
Match All:
Hull Lines_Name
Transverse Lines
Graphic: Normal black
Aft of separation lines
plane
Custom:
Draw Port
Draw Aft and Forward
- single curve
Draw Top and Bottom
- single curve

1 - Forward
2 - Port
3 - Separation plane (along X-axis)
4 - Transverse hull line aft of the separation plane.
Gathered by Custom Tests.
5 - Port side of transverse hull line is drawn. Set by
Graphic Rules.

See Also
Hull Lines - Body Plan View (on page 170)

Drawings and Reports Reference Data Guide 173


Drawings by Rule Reference Data

2. Hull Lines (Hull Lines - Body Plan View)


Draws hull lines at the separation plane between the port and starboard sides of the body plan
view.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Hull None Finds the transverse From the line found Labels the drawn None
Lines hull line at the by the custom tests, line with the name
separation plane. draws a thick black of the grid plane.
line on both sides of
the view.
Match All: Hull Lines_Name
Transverse Lines
Graphic: Thick black
On Reference lines
(separation plane)
Custom:
Draw Port and
Starboard - single
curve
Draw Aft and Forward
- single curve
Draw Top and Bottom
- single curve

1 - Forward
2 - Port
3 - Separation plane (along X-axis)
4 - Transverse hull line at the separation plane.
Gathered by Custom Tests.
5 - Both sides of transverse hull line are drawn. Set by
Graphic Rules.
If an X-axis frame is not coincident with the
separation plane, no hull line is drawn.

See Also
Hull Lines - Body Plan View (on page 170)

Drawings and Reports Reference Data Guide 174


Drawings by Rule Reference Data

3. Hull Lines (Hull Lines - Body Plan View)


Draws hull lines forward of the separation plane on the starboard side of the body plan view.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Hull None Finds the transverse From the lines found Labels the drawn None
Lines hull lines forward of by the custom tests, lines with the
the separation draws normal black name of the grid
plane. lines on the starboard plane.
side of the view.

Match All: Hull Lines_Name


Graphic: Normal
Transverse Lines
black lines
Forward of
Custom:
separation plane
Draw Starboard
Draw Aft and Forward
- single curve
Draw Top and Bottom
- single curve

1 - Forward
2 - Starboard
3 - Separation plane (along X-axis)
4 - Transverse hull line forward of the separation plane.
Gathered by Custom Tests.
5 - Port side of transverse hull line is drawn. Set by
Graphic Rules.

See Also
Hull Lines - Body Plan View (on page 170)

Drawings and Reports Reference Data Guide 175


Drawings by Rule Reference Data

Member Part
The following view styles are delivered for member part drawings:
Member Part (Generic)
Creates views of an individual member part and its connected parts. Two views are
generated: one in the -Z direction and one in the +Y direction of the member local
coordinate system.

Member Part - Preview (Generic)


Creates views of the outline of an individual member part only. Two views are generated:
one in the -Z direction and one in the +Y direction of the member local coordinate system.

Member Part - Section and Detail (Generic)

Drawings and Reports Reference Data Guide 176


Drawings by Rule Reference Data

Creates section and detail views on member parts when the Detail Envelope and
Cutting Plane commands are used in the SmartSketch Drawing Editor. For more
information, see Place Detail Envelope Command and Place Cutting Plane/Section View
Command in the SmartSketch Drawing Editor Help. An example is shown below.

View style files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rule\RulesetStyles folder.

Mfg PinJig SideView


Name: Mfg PinJig SideView
File name: Mfg PinJig SideView.xml
Description: View Style for Mfg PinJig side view drawing. Creates side views of the plates
supported by the PinJig for a selected block or assembly.

Actions Tab (Edit Ruleset View Style Dialog Box)


Ruleset used: MfgPinJigSideView.Default (see "Manufacturing PinJig Side View Rule Set" on
page 222)
PlateEdge Source (see "PlateEdge Source (MfgPinJigSideView.Default)" on page 223)
Seam Intersection Point Source (see "Seam Intersection Point Source
(MfgPinJigSideView.Default)" on page 224)
Chord Line Source (see "Chord Line Source (MfgPinJigSideView.Default)" on page 224)

Query
Manufacturing PinJig

Area (for view)


Area Computation - Default (Ruleset)
Area Shape - Rectangular
Boundary Overlap - 0
Frame Shape - Rectangular
Frame Border Style - Not drawn
Frame Behavior - Frame size is fixed

Drawings and Reports Reference Data Guide 177


Drawings by Rule Reference Data

Add-ons used
None

View Labels
View label rule: Default
Ship direction rule (for arrow): Not Defined
For more information, see View Label Rules in Drawings by Rule (on page 920).

General Tab (Edit Ruleset View Style Dialog Box) (on page 133)
Preview View Style: Not supported
Added, Modified, Deleted Object Color: Not supported
Intersection Edges: Off
Preserve Z Order: No

Example

See Also
Examples of Actions in Scantling Drawing View Styles (on page 241)
Manufacturing PinJig Side View Rule Set (on page 222)
Edit Ruleset View Style Dialog Box (on page 118)
How Actions are Applied to a View (on page 121)

Drawings and Reports Reference Data Guide 178


Drawings by Rule Reference Data

Mfg Profile Sketch


Name: Mfg Profile Sketch
File name: Mfg Profile Sketch.xml
Description: View Style for Profile Sketch drawing. Creates profile sketch views for a selected
block or assembly.

Actions
Ruleset used: MfgProfileRuleSet.DefaultRuleSet (see "Manufacturing Profile Sketch Rule Set"
on page 207)
Draw Profile
Web Cut
Flange Cut
Profile Outline (see "Profile Outline Source (MfgProfileRuleSet.DefaultRuleSet)" on page
211)
Corner Feature
Edge Feature (see "Edge Feature Source (MfgProfileRuleSet.DefaultRuleSet)" on page
210)
Slot Feature
Knuckle
Marking Lines Source (MfgProfileRuleSet.DefaultRuleSet) (on page 210)
Marking Lines Details
Connected Bracket
Web Thickness
Feature Distance
Margin
Bevel (see "Bevel Source (MfgProfileRuleSet.DefaultRuleSet)" on page 209)

Query
Manufacturing Profile
Length of Profile on Drawing (Optional)
Height of Profile on Drawing (Optional)
Reverse Profile Drawing (Optional)
Draw Multiple Profile Sketch (Optional)

Area (for view)


Area Computation - Default (Ruleset)
Area Shape - Rectangular
Boundary Overlap - 0

Drawings and Reports Reference Data Guide 179


Drawings by Rule Reference Data

Overlap Fill Style - Not drawn


Frame Shape - Rectangular
Frame Border Style - Not drawn
Frame Behavior - Frame size is fixed

Add-ons used
None

View Labels
View label rule: Not Defined
Ship direction rule (for arrow): Mfg Profile DirectionRule

General Tab (Edit Ruleset View Style Dialog Box) (on page 133)
Preview View Style: Not supported
Added, Modified, Deleted Object Color: Supported
Intersection Edges: Off
Preserve Z Order: No

Example

See Also
Examples of Actions in Scantling Drawing View Styles (on page 241)
Manufacturing Profile Sketch Rule Set (on page 207)
Edit Ruleset View Style Dialog Box (on page 118)
How Actions are Applied to a View (on page 121)

Drawings and Reports Reference Data Guide 180


Drawings by Rule Reference Data

Mfg TemplateSet - Full Scale


Name: Mfg TemplateSet - Full Scale
File name: Mfg TemplateSet - Full Scale.xml
Description: View Style for Mfg TemplateSet - Full Scale drawing. Creates Mfg TemplateSet
Full Scale views for a selected block or assembly.

Actions
Rule set used: MfgTemplatesetFullScale.DefaultRuleset (see "Manufacturing Templateset Full
Scale Drawing Rule Set" on page 219)
Template Source
Template Mid Line Source
Seam Source
Reference Curve Source

Query
Manufacturing TemplateSet
Cascade Horizontal Offset - Cx (Optional) - 100 mm
Cascade Vertical Offset - Cy (Optional) - 100 mm

Area (for view)


Area Computation - Default (Ruleset)
Area Shape - Rectangular
Boundary Overlap - 0
Frame Shape - Rectangular
Frame Border Style - Not drawn
Frame Behavior - Frame size is fixed

Add-ons used
None

View Labels
View label rule: View Label Rules in Drawings by Rule (on page 920)
Ship direction rule (for arrow): MfgTemplatesetFullScaleDirection Right

General Tab (Edit Ruleset View Style Dialog Box) (on page 133)
Preview View Style: Not supported
Added, Modified, Deleted Object Color: Not supported
Intersection Edges: Off
Preserve Z Order: No

Drawings and Reports Reference Data Guide 181


Drawings by Rule Reference Data

Example

See Also
Examples of Actions in Scantling Drawing View Styles (on page 241)
Manufacturing PinJig Side View Rule Set (on page 222)
Edit Ruleset View Style Dialog Box (on page 118)
How Actions are Applied to a View (on page 121)

Shell Expansion
Name: Shell Expansion
File name: Shell Expansion.xml
Description: Creates full shell expansion views.

Actions Tab (Edit Ruleset View Style Dialog Box)


Ruleset used: Steel Order Drawing Rule Set
Plate Part
Profile Part
Seam (see "Seam Source (ISSteelOrderRuleSet.Default)" on page 239)
Reference Curve
Plate Knuckle
Profile Knuckle (see "Profile Knuckle Source (ISSteelOrderRuleSet.Default)" on page 236)

 Each source can be used in multiple actions in the view style.


 For more information on actions, see Examples of Actions in Scantling Drawing View Styles
(on page 241).

Query
Structural Part or Plane
Positive and negative thicknesses from the view plane - 5 mm
Use expansion
Angle for target evaluation - 20 degrees

Drawings and Reports Reference Data Guide 182


Drawings by Rule Reference Data

Area (for view)


Area Computation - Custom
Area Shape - Rectangular
Boundary Overlap - 5 mm
Frame Shape - Rectangular
Frame Border Style - Not drawn
Frame Behavior - Frame resizes to drawing area

Add-ons used
AddOn - Horizontal Grid Axis - Draws Y (frame) coordinate system axis. For more information,
see Drawings by Rule View Style Rule Sets (on page 190).

View Labels
View label rule: ViewNameScaleRule. For more information, see View Label Rules in Drawings
by Rule (on page 920).
Ship direction rule (for arrow): None

General Tab (Edit Ruleset View Style Dialog Box) (on page 133)
Preview View Style: Not supported
Added, Modified, Deleted Object Color: Not supported
Intersection Edges: Off
Preserve Z Order: No

Drawings and Reports Reference Data Guide 183


Drawings by Rule Reference Data

Example
Only part of a full shell expansion view is shown for clarity.

See Also
Examples of Actions in Scantling Drawing View Styles (on page 241)
Edit Ruleset View Style Dialog Box (on page 118)
How Actions are Applied to a View (on page 121)

Steel Order - Reference Plane (Generic) View Style


Name: Steel Order - Reference Plane (Generic)
File name: Steel Order - Reference Plane (Generic).xml
Description: Creates a manual view for plates intersecting a selected reference plane.
Gathers all objects related to plates intersecting a selected reference plane and within the
boundaries of a selected block or assembly.

Actions Tab (Edit Ruleset View Style Dialog Box)


Ruleset used: Generic Rule Set (on page 191)
Sources used:
PlanningHierarchyItem[Planning]
PlanningBlock[Planning\PlanningHierarchyItem]
PlanningAssembly[Planning\PlanningHierarchyItem]

Drawings and Reports Reference Data Guide 184


Drawings by Rule Reference Data

PlateParts[ShipStructure\ShipStructureParts]
ProfileERPart[ShipStructure\ShipStructureParts\ProfileParts]
StiffenerParts[ShipStructure\ShipStructureParts\ProfileParts]
MemberPartPrismatic[Structure\Members];DesignedMember[Structure\Members]
PlateSeam[ShipStructure\Seams]
ProfileSeam[ShipStructure\Seams]
LogicalConnection[ShipStructure\StructConnections]
KnuckleCurve[ShipStructure\ReferenceCurves]
OpeningEntity[ShipStructure]
ProfileKnuckle[ShipStructure]
Margin[StructuralManufacturing\ProductionInfo]
MfgMarkingLines[StructuralManufacturing\ProductionInfo]
 Each source can be used in multiple actions in the view style. Pause over a row
number on the Actions tab to display a ToolTip description of an action.

Query
Structural Part or Plane - None
Block or assembly - Selected by user in the asking filter
Positive and negative thicknesses from the view plane - 5 mm

Area (for view)


Area Computation - Custom
Area Shape - Rectangular
Boundary Overlap - 5 mm
Frame Shape - Rectangular
Frame Border Style - Not drawn
Frame Behavior - Frame resizes to drawing area

Add-ons used
AddOn - Grid Axis (Generic) - Adds visible coordinate system rulers and axes to a rule set
view style that uses the generic rule set. This add-on is included as part of several delivered rule
set view styles, such as Steel Order (Generic), and uses the
DBRGenericRuleSet.GenericRuleSet rule set. For more information, see Generic Rule Set (on
page 191).

View Labels
View label rule: SteelOrderSectionadDetailViewRule. For more information, see View Label
Rules in Drawings by Rule (on page 920)
Ship direction rule (for arrow): ShipDirectionRule Right Up

Drawings and Reports Reference Data Guide 185


Drawings by Rule Reference Data

General Tab (Edit Ruleset View Style Dialog Box) (on page 133)
Preview View Style: Supported
Added, Modified, Deleted Object Color: Supported
Intersection Edges: Off
Preserve Z Order: No

Examples
For a view with reference plane D1 selected:

Steel Order - Section and Detail (Generic) Views


Name: Steel Order - Section and Detail (Generic)
File name: Steel Order - Section and Detail (Generic).xml
Description: View style for section or detail views. Manually select this style when creating a
section or detail view in SmartSketch Drawing Editor.

Actions Tab (Edit Ruleset View Style Dialog Box)


Ruleset used: Generic Rule Set (on page 191):
PlanningHierarchyItem[Planning]
PlateParts[ShipStructure\ShipStructureParts]
ProfileERPart[ShipStructure\ShipStructureParts\ProfileParts]
StiffenerParts[ShipStructure\ShipStructureParts\ProfileParts]
MemberPartPrismatic[Structure\Members];DesignedMember[Structure\Members]PlateSeam[Shi
pStructure\Seams]
ProfileSeam[ShipStructure\Seams]
LogicalConnection[ShipStructure\StructConnections]KnuckleCurve[ShipStructure\Reference
Curves]OpeningEntity[ShipStructure]
ProfileKnuckle[ShipStructure]

Drawings and Reports Reference Data Guide 186


Drawings by Rule Reference Data

Margin[StructuralManufacturing\ProductionInfo]
MfgMarkingLines[StructuralManufacturing\ProductionInfo]
Each source can be used in multiple actions in the view style.

Query
Structural Part or Plane
Block or assembly
Positive and negative thicknesses from the view plane.

Area (for view)


Area Computation - Custom
Area Shape - Rectangular
Boundary Overlap - 5 mm
Frame Shape - Rectangular
Frame Border Style - Not drawn
Frame Behavior - Frame resizes to drawing area

Add-ons used
None

View Labels
View label rule: SteelOrderSectionadDetailViewRule. For more information, see View Label
Rules in Drawings by Rule (on page 920).
Ship direction rule (for arrow): None

General Tab (Edit Ruleset View Style Dialog Box) (on page 133)
Preview View Style: Not supported
Added, Modified, Deleted Object Color: Not supported
Intersection Edges: Off
Preserve Z Order: No

Drawings and Reports Reference Data Guide 187


Drawings by Rule Reference Data

Steel Order (Generic)


The Steel Order (Generic) rule set view style is a custom view style specific to drawings by rule
used for detailed and light (non-detailed) parts. There are several labels that contribute to the
Steel Order view style, many of which are customizable. When using the
ViewNameDirectionScale view label, the software annotates the profile parts on decks using
three different labels. The view label, summary labels, and position index numbers work
together in order to effectively annotate the profile parts in a Steel Order drawing.

View Label
The delivered View Label rule, SteelOrderSectionandDetailViewRule, places a view label on
the drawing that displays the view name, direction, scale, and typical profile section size used.
For more information, see View Label Rules in Drawings by Rule (on page 920).

Summary Labels
Any profile parts that are non-typical are annotated with the Plate Stiffeners Summary and
Sibling Plates Stiffeners Summary labels. These labels display the non-typical profiles and their
section size. You must place these labels manually. For more information on these labels, see
Plate Stiffeners Summary Label Template (on page 903) and Sibling Plates Stiffeners Summary
Label Template (on page 903).

Position Index Numbers


The view style also assigns position index numbers to each profile part. The position index
numbers are used instead of the profile names in order to save space and improve readability.
Starting with 1, each profile part is given a number. If two or more profile parts are identical, they
are given the same number.

 In order to generate the position index numbers automatically, you must split and assign the
blocks and run Board Management. For more information on Block Assignments, see the
Planning User's Guide. For more information on Board Management, see the Structural
Detailing User's Guide.
 When the position index numbers are generated, the numbering sequence progresses from
the Aft to the Fore, and from the Centerline of the ship to both sides.

Drawings and Reports Reference Data Guide 188


Drawings by Rule Reference Data

Example
Typical label, summary labels, and position index numbers on a steel order drawing.

Drawings and Reports Reference Data Guide 189


Drawings by Rule Reference Data

Drawings by Rule View Style Rule Sets


You define and edit options for marine mode view style rule sets using the Actions tab of the
Edit Ruleset View Style dialog box.
See Also
Define View Style Command (Tools Menu) (on page 56)

Topics
Assembly Drawing Rule Set .......................................................... 190
Generic Rule Set ........................................................................... 191
Hull Lines Drawings Rule Set ........................................................ 196
Manufacturing PinJig Drawing Rule Set ........................................ 206
Manufacturing Profile Sketch Rule Set .......................................... 207
Manufacturing Sketch Rule Set ..................................................... 212
Manufacturing Template Drawing Rule Sets ................................. 216
Manufacturing Templateset Full Scale Drawing Rule Set ............. 219
Manufacturing PinJig Side View Rule Set ..................................... 222
Steel Order Drawing Rule Set ....................................................... 225
Examples of Actions in Scantling Drawing View Styles ................ 241

Assembly Drawing Rule Set


An assembly drawing view style uses the AssemblyRuleSets.Default rule set, which provides
a list of source actions. Each source draws specific types of items and applies drawing rules to
the items based on conditions allowed in the source. Using the Tools > Define View Style
command in the Drawings and Reports task, you specify the source/condition combination,
queries, view area properties, labels, and add-on rulesets you want to use for your drawing view
style.

AssemblyRuleSets.Default
This rule set is used for assembly drawings showing either the assembly method or assembly
sequence.

Source Items (Actions tab)


The rule set and the source/condition definitions are defined on the Action tab of the Edit
Ruleset View Style dialog box. For more information, see Actions Tab (Edit Ruleset View Style
Dialog Box) (on page 119).
The following options are available in the Source field:
Assembly
Assembled Part
Added Part
Planning Joint
There are no custom tests for these actions.

Drawings and Reports Reference Data Guide 190


Drawings by Rule Reference Data

View Queries (Query tab)


View query properties are defined on the Query tab of the Edit Ruleset View Style dialog box.
For more information, see Query Tab (Edit Ruleset View Style Dialog Box) (on page 129).
The following options are available in the Query field:
1. Assembly
2. Part List (Optional)
3. Added Part (Optional)

View Area Properties (Area tab)


View area and frame properties are defined on the Area tab of the Edit Ruleset View Style
dialog box. For more information and property definitions, see Area Tab (Edit Ruleset View Style
Dialog Box) (on page 130).
The following options are available in the Property field:
Area Computation
Area Shape
Frame Shape
Frame Border Style
Frame Behavior

Generic Rule Set


The DBRGenericRuleSet.GenericRuleSet rule set creates any type of drawing by rule.

Actions tab
You can define actions on selected object types (sources) on the Actions tab of the Edit
Ruleset View Style dialog box. For more information, see Actions Tab (Edit Ruleset View Style
Dialog Box) (on page 119).
Source
Defines any type of source item from the Select Object Types dialog box.
Filter tests
Defines any type of source item from the Select Filter dialog box (on page 143).
Custom Tests
Defines a custom test. You can use any custom test, but the following tests are designed to
work with any type of source:
 Block Location (on page 266)
 Connected Parts (on page 268)
 Connection Type (on page 271)
 Direction (on page 273)
 Has Intersection Seam (on page 277)

Drawings and Reports Reference Data Guide 191


Drawings by Rule Reference Data

 Is Root Logical Connection (on page 278)


 Level (on page 278)
 Parent Parts (on page 280)
 Related Object Exists (on page 285)
 Relation to Target (on page 286)
 Web Orientation (on page 288)
For more information, see Custom Tests Dialog Box (Generic Rule Set) (on page 123) and
Ruleset Custom Tests (on page 263).
Graphic Rule
Defines graphic rules on the Graphic tab of Graphic Style dialog box. See Graphic Tab
(Graphic Style Dialog Box) (on page 126).
Custom graphic modules are not available on the Custom tab of Graphic Style
dialog box.
Label Rule
Displays all label rules that are available. For more information, see Label Rules in Drawings
by Rule (on page 852).
Dimension Rule
Displays all dimension rules that are available. For more information, see Marine Dimension
Rules (on page 690).

Query tab
Defines view query properties on the Query tab of the Edit Ruleset View Style dialog box. For
more information, see Query Tab (Edit Ruleset View Style Dialog Box) (on page 129).
The following options are available in the Query field:
1. Any system, part, or reference plane
Defines the query by the selected outfitting or structural systems or parts, or a selected
reference plane. When systems are selected, the parts belonging to the systems are used.
Select objects that support the type of drawing view you want to create. A value for this
query is required. The following can be set:
 Plate parts or systems.
 Profile parts or systems.
 Member parts or systems.
 Outfitting parts or systems, including pipe lines, pipe runs, pipe parts, hangers and
supports, and equipment.
 Reference planes from any coordinate system.
Selections can be made manually using Associate Objects to Views in SmartSketch
Drawing Editor. Selections can also be specified automatically as output of an applicable
collation rule. For more information, see Collation Rules in Drawings by Rule in the
Drawings and Reports Reference Data Guide or Collation Rules in the Orthographic
Drawings User's Guide.

Drawings and Reports Reference Data Guide 192


Drawings by Rule Reference Data

2. Boundary (Block, volume, or assembly)


Defines the boundaries of a query by a selected planning block, volume, assembly, or
assembly block. A value for this query is optional.
3. Gathering rule
Defines the type of parts gathered in the drawing view. The rule provides a definition of the
objects to be gathered and drawn in a view. The gathering rule starts with the inputs
selected in Any system, part, or reference plane and adds more objects to the view based
on their relationships to each other. This option opens the Select Gathering Rule dialog
box. Select a rule that supports the type of drawing view you want to create, such as Steel
Order or Assembly. A value for this query is required. The default value is Steel Order.
4. Gathering method
Defines how model objects are included in the drawing view. The volume selected with
Block, volume, or Assembly or created with Volume creation rule is used as input for the
gathering method.
 Gather related objects in volume - Parts are gathered based on connections to
the selected parts resulting from Any system, part, or reference plane. If a volume
is defined for Volume creation rule, only connected objects in the volume are
gathered.
 Gather all objects in volume - All parts in the volume are gathered even if they are
not connected to the selected parts resulting from Any system, part, or reference
plane. If a volume is not defined for Volume creation rule, this option is not valid.
This is the default value.
Relationships (such as parent/child or bounded/bounding) for all gathered objects are also
gathered and used by the selected Gathering rule.
5. Volume creation rule
Defines the volume for the view by one of the following methods:
 Create volume along surface of input parts with boundary extents - The volume
follows the surfaces of the selected parts resulting from Any system, part, or
reference plane. The volume depth (normal to the view) is extended by the values of
Volume growth into drawing and Volume growth out of drawing. The volume area
(in the plane of the view) is extended to (or clipped by) the boundaries defined by
Boundary (Block, volume, or assembly). The gathering range is extended by the
values defined by Extend Into and Extend Out Of.

Example: Corrugated bulkhead


1 - Cross-section of volume
2 - Volume growth
3 - Extended gathering range
4 - Volume extended to boundaries
5 - View direction
6 - Additional part gathered into view
7 - Additional part not gathered into
view

Drawings and Reports Reference Data Guide 193


Drawings by Rule Reference Data

 Create volume along surface of input parts without boundary extents - The volume
follows the surfaces of the selected parts resulting from Any system, part, or
reference plane. The volume depth (normal to the view) is extended by the values of
Volume growth into drawing and Volume growth out of drawing. The volume area
(in the plane of the view) is not extended to (nor clipped by) the boundaries defined by
Boundary (Block, volume, or assembly). The gathering range is extended by the
values defined by Extend Into and Extend Out Of.

Example: Corrugated bulkhead

1 - Cross-section of volume
2 - Volume growth
3 - Extended gathering range
4 - View direction
5 - Additional part gathered into view
6 - Additional part not gathered into view

 Create volume from range box around input parts with boundary extents - The
volume is a rectangular range box around the selected parts resulting from Any
system, part, or reference plane. The volume depth (normal to the view) is extended
by the values of Volume growth into drawing and Volume growth out of drawing.
The volume is extended to (or clipped by) the boundaries defined by Boundary (Block,
volume, or assembly). See the corrugated bulkhead example below.

Example: Corrugated bulkhead


1 - Cross-section of volume
2 - Volume growth
3 - Additional part gathered into view
4 - View direction
5 - Volume extended to boundaries

 Create volume from range box around input parts without boundary extents - The
volume is a rectangular range box around the selected parts resulting from Any
system, part, or reference plane. The volume depth (normal to the view) is extended
by the values of Volume growth into drawing and Volume growth out of drawing.
The volume is not extended to (nor clipped by) the boundaries defined by Boundary
(Block, volume, or assembly). See the corrugated bulkhead example below.

Drawings and Reports Reference Data Guide 194


Drawings by Rule Reference Data

Example: Corrugated bulkhead

1 - Cross-section of volume
Example: Non-orthogonal member
2 - Volume growth
3 - Additional part gathered into view
4 - View direction

 Create oriented volume around input parts without boundary extents - The volume
is a rectangular box around the parts. The box is oriented around parts to minimize the
volume. The parts are typically not orthogonal, but the view direction is typically normal
to the box. The volume depth (normal to the view) is extended by the values of Volume
growth into drawing and Volume growth out of drawing.

 If the view direction is not normal to the box, then the volume is extended to (or
clipped by) the boundaries defined by Boundary (Block, volume, or assembly)
instead of Volume growth into drawing and Volume growth out of drawing.
 If the view direction is normal to the box, then the volume is extended to (or clipped
by) Volume growth into drawing and Volume growth out of drawing. These
values can be positive or negative.

Drawings and Reports Reference Data Guide 195


Drawings by Rule Reference Data

Example: Non-orthogonal member

1 - Cross-section of volume
2 - Volume growth
3 - Additional part gathered into view
4 - View direction

 Do not create volume - A volume is not used to restrict gathering using gathering rule.
For example, a shell longitudinal profile view does not use a volume. It instead uses
levels to gather secondary parts.
The volume selected with Boundary (Block, volume, or assembly) or created with
Volume creation rule is also used for view clipping in the graphic rule. For more information,
see Graphic Rules in Drawings by Rule in the Drawings and Reports Reference Data Guide.

Area tab
View area and frame properties are defined on the Area tab of the Edit Ruleset View Style
dialog box. For more information and property definitions, see Area Tab (Edit Ruleset View Style
Dialog Box) (on page 130).
The following options are available in the Property field:
 Area Computation
 Area Shape
 Boundary Overlap
 Overlap Fill Style
 Frame Shape
 Frame Border Style
 Frame Behavior

Hull Lines Drawings Rule Set


A hull lines view style uses the HullLinesRuleSets.DefaultRuleSet rule set, which provides a
list of source actions. Each source draws specific types of items and applies drawing rules to the
items based on conditions allowed in the source. Using the Tools > Define View Style
command in the Drawings and Reports task, you specify the source/condition combination,
queries, view area properties, labels, and add-on rulesets you want to use for your drawing view
style.

Drawings and Reports Reference Data Guide 196


Drawings by Rule Reference Data

HullLinesRuleSets.DefaultRuleSet
This rule set is used for all hull lines drawings, such as body plan drawings.
Hull lines are created by the intersection of a grid plane with the hull surface.

Source Items (Actions tab)


The rule set and the source/condition definitions are defined on the Action tab of the Edit
Ruleset View Style dialog box. For more information, see Actions Tab (Edit Ruleset View Style
Dialog Box) (on page 119).
The following options are available in the Source field:

Source Item Custom Tests

Hull Lines Line type


Port or Starboard
Aft or Forward
Top or Bottom

Plate Systems on Hull Port or Starboard


Aft or Forward
Top or Bottom

Profile Systems on Hull Port or Starboard


Aft or Forward
Top or Bottom

Seams on Hull Port or Starboard


Aft or Forward
Top or Bottom

Reference Curve Line type


Port or Starboard
Aft or Forward
Top or Bottom

View Queries (Query tab)


View query properties are defined on the Query tab of the Edit Ruleset View Style dialog box.
For more information, see Query Tab (Edit Ruleset View Style Dialog Box) (on page 129).
The following options are available in the Query field:
1. Hull Plate System(s)
Hull plate systems to be used for the hull lines drawings.
2. Separation Plane X (Optional)
Frame (transverse) grid plane (along the X-axis) used as a separation or trimming plane,
depending on the hull line view style:
 Body Plan (Transverse) - Used as a separation plane for gathering forward and aft hull
lines, usually at or near midship.

Drawings and Reports Reference Data Guide 197


Drawings by Rule Reference Data

 Plan (Waterline) View - Used as a trimming plane to clip the hull.


 Profile (Buttock) View - Used as a trimming plane to clip the hull
3. Separation Plane Y (Optional)
Buttock (longitudinal) grid plane (along the Y-axis) used as a separation or trimming plane,
depending on the hull line view style:
 Body plan (Transverse) - Used as a trimming plane for drawing the port or starboard
sides of hull lines, usually at longitudinal centerline.
 Plan (Waterline) View - Used as a trimming plane for drawing the port or starboard sides
of hull lines, usually at longitudinal centerline.
 Profile (Buttock) View - Used as a separation plane for port and starboard hull lines,
usually at longitudinal centerline.
4. Separation Plane Z (Optional)
Waterline (deck) grid plane (along the Z-axis) used as a separation or trimming plane,
depending on the hull line view style:
 Body plan (Transverse) - Used as a trimming plane to clip the hull below the top.
 Plan (Waterline) View - Used as a separation plane for gathering top and bottom hull
lines.
 Profile (Buttock) View - Used as a trimming plane to clip the hull.
If a separation plane is not selected and is required for gathering or drawing hull lines,
the software selects one based on the calculated midpoint of the appropriate axis. Separation
planes for clipping the hull are not required.

Hull Lines Source (HullLinesRuleSets.DefaultRuleset)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to hull lines created by the intersection of grid planes with the hull.

Custom Tests
See Custom Tests Dialog Box (on page 122).

Condition Values

Line Type Transverse Hull line created by the


Line intersection of a
transverse (x-axis) grid
plane with the hull

Drawings and Reports Reference Data Guide 198


Drawings by Rule Reference Data

Condition Values
1 - Forward
2 - Typical transverse grid plane
3 - Transverse Lines

Water Line Hull line created by the


intersection of a deck
(z-axis) grid plane with
the hull

1 - Forward
2 - Typical deck grid plane
3 - Water Lines

Buttock Line Hull line created by the


intersection of a
longitudinal (y-axis) grid
plane with the hull

1 - Forward
2 - Typical longitudinal grid plane
3 - Buttock Lines

Unknown

Port or Port
Starboard

Starboard

Both

OnReference Both - Lines on both sides are used

Drawings and Reports Reference Data Guide 199


Drawings by Rule Reference Data

Condition Values

Unknown
OnReference - The line is used if it is on the separation plane
Aft or Aft
Forward
Forward

Both

OnReference

Unknown

Top or Top
Bottom
Bottom

Both

OnReference

Unknown

Graphic Rule
Graphic tab of Graphic Style dialog box. See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: See Custom Tab (Graphic Style Dialog Box) (on page
129).

Property Values

Draw Port or Starboard Port


Starboard
Both
Whole Both - Both sides are
drawn as two curves
Draw Aft or Forward Aft
Forward
Both Whole - Both sides are
Whole drawn as a single curve

Draw Top or Bottom Top


Bottom
Both
Whole

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Drawings and Reports Reference Data Guide 200


Drawings by Rule Reference Data

See Also
Hull Lines Drawings Rule Set (on page 196)

Plate Systems on Hull Source


(HullLinesRuleSets.DefaultRuleset)
Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to plate systems that are connected to the hull.

Custom Tests
See Custom Tests Dialog Box (on page 122).

Condition Values

Port or Port
Starboard

Starboard

Both

OnReference

Unknown

Aft or Aft
Forward Both - Plate system lies on both sides
Forward

Both OnReference - The plate system lies on the separation plane

OnReference

Unknown

Top or Top
Bottom
Bottom

Both

OnReference

Unknown

Drawings and Reports Reference Data Guide 201


Drawings by Rule Reference Data

Graphic Rule
Graphic tab of Graphic Style dialog box. See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: See Custom Tab (Graphic Style Dialog Box) (on page
129).

Property Values

Draw Port or Starboard Port


Starboard
Both
Whole Both - Both sides are
drawn as two curves
Draw Aft or Forward Aft
Forward
Both Whole - Both sides are
Whole drawn as a single curve

Draw Top or Bottom Top


Bottom
Both
Whole

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Hull Lines Drawings Rule Set (on page 196)

Profile Systems on Hull Source


(HullLinesRuleSets.DefaultRuleset)
Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to profile systems on the hull.

Custom Tests
See Custom Tests Dialog Box (on page 122).

Condition Values

Port or Port
Starboard

Starboard

Both

Drawings and Reports Reference Data Guide 202


Drawings by Rule Reference Data

Condition Values

OnReference

Unknown

Aft or Aft Both - Profile system lies on both sides


Forward
Forward
OnReference - The profile system lies on the separation plane
Both

OnReference

Unknown

Top or Top
Bottom
Bottom

Both

OnReference

Unknown

Graphic Rule
Graphic tab of Graphic Style dialog box. See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: See Custom Tab (Graphic Style Dialog Box) (on page
129).

Property Values

Draw Port or Starboard Port


Starboard
Both
Whole
Both - Both sides are
Draw Aft or Forward Aft
drawn as two curves
Forward
Both
Whole
Whole - Both sides are

Drawings and Reports Reference Data Guide 203


Drawings by Rule Reference Data

Property Values

drawn as a single curve


Draw Top or Bottom Top
Bottom
Both
Whole

Draw Profile Orientation True


Mark False

Length of Profile 0.2 Default value can be


Orientation Mark changed

Mounting Angle Orientation Measured from Plate Surface


Representation Normal
Orientation Measured on the Reference
Plane

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Hull Lines Drawings Rule Set (on page 196)

Seams on Hull Source (HullLinesRuleSets.DefaultRuleset)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to seams on the hull.

Custom Tests
See Custom Tests Dialog Box (on page 122).

Condition Values

Port or Port
Starboard

Starboard

Both

OnReferenc
e

Unknown

Aft or Aft

Drawings and Reports Reference Data Guide 204


Drawings by Rule Reference Data

Condition Values
Forward Both - Seam lies on both sides
Forward

Both OnReference - The seam lies on the separation plane


OnReferenc
e

Unknown

Top or Top
Bottom
Bottom

Both

OnReferenc
e

Unknown

Graphic Rule
Graphic tab of Graphic Style dialog box. See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: See Custom Tab (Graphic Style Dialog Box) (on page
129).

Property Values

Draw Port or Starboard Port


Starboard
Both
Whole Both - Both sides are drawn as two curves

Draw Aft or Forward Aft


Forward Whole - Both sides are drawn as a single curve
Both
Whole

Draw Top or Bottom Top


Bottom
Both
Whole

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Hull Lines Drawings Rule Set (on page 196)

Drawings and Reports Reference Data Guide 205


Drawings by Rule Reference Data

Manufacturing PinJig Drawing Rule Set


A pin jig view style uses the MfgPinJigRuleSet.Default rule set, which provides a list of source
actions. Each source draws specific types of items and applies drawing rules to the items based
on conditions allowed in the source. Using the Tools > Define View Style command in the
Drawings and Reports task, you specify the source/condition combination, queries, view area
properties, labels, and add-on rulesets you want to use for your drawing view style.

MfgPinJigRuleSet.Default
This rule set is used for all pin jig drawings.

Source Items (Actions tab)


The rule set and the source/condition definitions are defined on the Action tab of the Edit
Ruleset View Style dialog box. For more information, see Actions Tab (Edit Ruleset View Style
Dialog Box) (on page 119).
The following options are available in the Source field:

Source Item Custom Test Conditions

Plate None

Pin None

Remarking Line Remarking Line Type

Axis None

Intersection Point Type Intersection Point Type


Horizontal Parent Type
Vertical Parent Type

View Queries (Query tab)


View query properties are defined on the Query tab of the Edit Ruleset View Style dialog box.
For more information, see Query Tab (Edit Ruleset View Style Dialog Box) (on page 129).
The following option is available in the Query field:
1. Pin Jig

View Area Properties (Area tab)


View area and frame properties are defined on the Area tab of the Edit Ruleset View Style
dialog box. For more information and property definitions, see Area Tab (Edit Ruleset View Style
Dialog Box) (on page 130).
The following options are available in the Property field:
Area Computation

Drawings and Reports Reference Data Guide 206


Drawings by Rule Reference Data

Area Shape
Frame Shape
Frame Border Style
Frame Behavior

Manufacturing Profile Sketch Rule Set


A profile sketch view style uses the MfgProfileRuleSet.DefaultRuleSet rule set, which provides
a list of source actions. Each source draws specific types of items and applies drawing rules to
the items based on conditions allowed in the source. Using the Tools > Define View Style
command in the Drawings and Reports task, you specify the source/condition combination,
queries, view area properties, labels, and add-on rulesets you want to use for your drawing view
style.

MfgProfileRuleSet.DefaultRuleSet
This rule set is used for all single and multiple profile sketch drawings.

Source Items (Actions tab)


The rule set and the source/condition definitions are defined on the Action tab of the Edit
Ruleset View Style dialog box. For more information, see Actions Tab (Edit Ruleset View Style
Dialog Box) (on page 119).
The following options are available in the Source field:

Source Item Custom Test


Conditions

Draw Profile Cell

Web Cut Cell

Flange Cut Cell

Profile Outline (see "Profile Cell


Outline Source
(MfgProfileRuleSet.DefaultRu
leSet)" on page 211)

Corner Feature Cell


Draw

Edge Feature (see "Edge Cell


Feature Source Draw
(MfgProfileRuleSet.DefaultRu
leSet)" on page 210)

Slot Feature Cell


Draw

Drawings and Reports Reference Data Guide 207


Drawings by Rule Reference Data

Source Item Custom Test


Conditions

Knuckle Cell

Marking Lines Source Cell


(MfgProfileRuleSet.DefaultRu
Marking Line Type
leSet) (on page 210)

Marking Lines Details Cell


Draw
Marking Line Type

Connected Bracket Cell

Web Thickness Cell

Feature Distance Cell


Draw

Margin Cell
Draw

Bevel (see "Bevel Source Cell


(MfgProfileRuleSet.DefaultRu Draw
leSet)" on page 209)

View Queries (Query tab)


View query properties are defined on the Query tab of the Edit Ruleset View Style dialog box.
For more information, see Query Tab (Edit Ruleset View Style Dialog Box) (on page 129).
The following options are available in the Query field:
1. Manufacturing Profile
2. Length of Profile on Drawing (Optional)
3. Height of Profile on Drawing (Optional)
4. Reverse Profile Drawing (Optional)
5. Draw Multiple Profile Sketch (Optional)

View Area Properties (Area tab)


View area and frame properties are defined on the Area tab of the Edit Ruleset View Style
dialog box. For more information and property definitions, see Area Tab (Edit Ruleset View Style
Dialog Box) (on page 130).
The following options are available in the Property field:
1. Area Computation
2. Area Shape

Drawings and Reports Reference Data Guide 208


Drawings by Rule Reference Data

3. Frame Shape
4. Frame Border Style
5. Frame Behavior

Bevel Source (MfgProfileRuleSet.DefaultRuleSet)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to each physical connection at the end of profile.

Custom Test
See Custom Tests Dialog Box (on page 122).

Condition Values

Cell Web Based on your selection, the respective


TopFlange cell's bevel is drawn.
BottomFlange

BevelDepths Numerical value Represents number of bevel depths on


a physical connection.

Parent Feature EndCut The bevel symbol is drawn for the


physical connection associated to the
WaterStop
selected feature type.

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box. See Custom Tab (Graphic Style Dialog Box) (on page
129).

Property Values

Draw Detail (on page 274) True


False

Bevel Orientation (on page Default


265)
Horizontal

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box)

Drawings and Reports Reference Data Guide 209


Drawings by Rule Reference Data

Edge Feature Source (MfgProfileRuleSet.DefaultRuleSet)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to each feature created on the manufacturing profile in the Structural
Manufacturing task.

Custom Test
See Custom Tests Dialog Box (on page 122).

Condition Values

Cell Web Based on your selection, the respective


TopFlange cell's edge feature is drawn.
BottomFlange

Draw OnProfile Based on your selection, the respective


InDetail feature is drawn on the profile or in a
detail box.

EdgeFeature Type EdgeFeature Based on your selection, the respective


WaterStop feature is drawn.

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box. No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Marking Lines Source (MfgProfileRuleSet.DefaultRuleSet)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to each marking line created on the manufacturing profile in the Structural
Manufacturing task.

Custom Test
See Custom Tests Dialog Box (on page 122).

Condition Values

Cell Web Based on your selection, the respective


TopFlange cell's marking line is drawn.
BottomFlange

Drawings and Reports Reference Data Guide 210


Drawings by Rule Reference Data

Condition Values

Marking Line Type Fitting Based on your selection, the respective


Reference Plane marking line is drawn.
Knuckle
Rend
Area Margin
Seam
Plate Location

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box. No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Profile Outline Source (MfgProfileRuleSet.DefaultRuleSet)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to each physical connection at the end of the profile.

Custom Test
See Custom Tests Dialog Box (on page 122).

Condition Values

Cell Web Based on your selection, draws the


TopFlange respective cell's outline.
BottomFlange

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box. See Custom Tab (Graphic Style Dialog Box) (on page
129).

Property Values

Draw Flange on Web (on True


page 275) False

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box)

Drawings and Reports Reference Data Guide 211


Drawings by Rule Reference Data

Manufacturing Sketch Rule Set


A manufacturing sketch view style uses S3DMfgSketch.RuleSet, which provides a list of source
actions. Each source draws specific types of items and applies drawing rules to the items based
on conditions allowed in the source. Using the Tools > Define View Style command in the
Drawings and Reports task, you specify the source/condition combination, queries, view area
properties, labels, and add-on rulesets you want to use for your drawing view style.

S3DMfgSketch.RuleSet
This rule set is used for all profile sketch drawings of members. The rule set and the
source/condition definitions are defined on the Action tab of the Edit Ruleset View Style dialog
box. For more information, see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).

Source (Actions tab)


Source specifies a named list of items that receive action after extraction by the rule set view
style query. The options available are taken from the manufacturing schema provided in
[Reference Data Folder]\SharedContent\Xml\StructManufacturing\MfgXMLSchema.xsd.
To select a source, click a cell in the Source column to open the Select Manufacturing Source
dialog box. Sources are selected using one of the following options:

Drawings and Reports Reference Data Guide 212


Drawings by Rule Reference Data

 Basic - Displays the manufacturing schema in a readable format.

 Expert - Displays the manufacturing schema as it appears in MfgXMLSchema.xsd.

Custom Test (Actions tab)


Custom specifies a list of properties for the selected value of Source. For more information, see
Custom Tests Dialog Box (on page 122).

Drawings and Reports Reference Data Guide 213


Drawings by Rule Reference Data

The options available for Custom are taken from the manufacturing schema provided in
[Reference Data Folder]\SharedContent\Xml\StructManufacturing\MfgXMLSchema.xsd. These
options are parameters and properties for the selected source selected on the Select
Manufacturing Source Property dialog box. The top pane displays parameters for the selected
manufacturing source. The bottom pane displays properties for a selected parameter. The
example below shows the SMS_EDGE source with the SMS_BEVEL selected in the top pane.
Properties for SMS_BEVEL are shown in the bottom pane.

Select properties for a manufacturing sketch source (on page 215)

Graphic Rule (Actions tab)


Graphic specifies the graphic rule used for the selected value of Source. For more information,
see Graphic Style Dialog Box (on page 126).
On the Graphic tab, select Draw 2D Graphics as the value for Graphic Rule Type, and select
the needed value for each property. For more information, see Draw 2D Graphics (on page
728).
On the Custom tab, select the needed value for Zone to draw. Drawings zones are defined by
the selected value for Projector on the General tab (see below). For example:

Drawings and Reports Reference Data Guide 214


Drawings by Rule Reference Data

1 - Reports region
and view
2 - Drawing region
and view

Drawing Zones:
3 - Main
4 - Feature Detail
5 - Bevel Detail

View Queries (Query tab)


View query properties are defined on the Query tab of the Edit Ruleset View Style dialog box.
For more information, see Query Tab (Edit Ruleset View Style Dialog Box) (on page 129).

View Area Properties (Area tab)


View area and frame properties are defined on the Area tab of the Edit Ruleset View Style
dialog box. For more information and property definitions, see Area Tab (Edit Ruleset View Style
Dialog Box) (on page 130).

Projector (General Tab)


General properties are defined on the General tab of the Edit Ruleset View Style dialog box.
For more information, see General Tab (Edit Ruleset View Style Dialog Box) (on page 133).
Projector specifies the scaling method for the selected drawing zone.

Select properties for a manufacturing sketch source


Use this workflow with the S3DMfgSketch.RuleSet rule set on the Actions tab of the Edit
Ruleset View Style dialog box.
To select custom test properties for a source:
1. On a row with a value selected for Source, click a cell in the Custom column and select
More.
The Custom Test dialog box displays.
2. Select the needed value for Filter method.
3. Click a cell in the Condition column.
The Select Manufacturing Property dialog box displays.

Drawings and Reports Reference Data Guide 215


Drawings by Rule Reference Data

4. Select a parameter in the top pane.


Properties for the parameter display in the bottom pane.
5. Select a property in the bottom pane.
6. Click OK.
The Select Manufacturing Property dialog box displays and the property displays in the
Condition column.
7. Select a property value in the Value column.
8. Repeat as needed to add additional properties.
9. Click OK to close the Custom Test dialog box.

Manufacturing Template Drawing Rule Sets


A template drawing view style uses the MfgTemplateRuleSet.DefaultRuleSet or
MfgTemplateSetRuleSet.DefaultRuleSet rule set, which provides a list of source actions. Each
source draws specific types of items and applies drawing rules to the items based on conditions
allowed in the source. Using the Tools > Define View Style command in the Drawings and
Reports task, you specify the source/condition combination, queries, view area properties,
labels, and add-on rulesets you want to use for your drawing view style.

MfgTemplateRuleSet.DefaultRuleSet
This rule set is used for single template drawings.

Source Items (Actions tab)


The rule set and the source/condition definitions are defined on the Action tab of the Edit
Ruleset View Style dialog box. For more information, see Actions Tab (Edit Ruleset View Style
Dialog Box) (on page 119).
The following options are available in the Source field:

Source Item Custom Test Conditions

Template Source (see "Template Source Seam's Side to Draw


(MfgTemplateRuleSet.DefaultRuleSet)" on page 217)

Base Control Source (see "Base Control Source Seam's Side to Draw
(MfgTemplateRuleSet.DefaultRuleSet)" on page 217)

Seam Source (see "Seam Source Seam's Side to Draw


(MfgTemplateRuleSet.DefaultRuleSet)" on page 218)

Offset Line Seam's Side to Draw

View Queries (Query tab)


View query properties are defined on the Query tab of the Edit Ruleset View Style dialog box.
For more information, see Query Tab (Edit Ruleset View Style Dialog Box) (on page 129).

Drawings and Reports Reference Data Guide 216


Drawings by Rule Reference Data

The following options are available in the Query field:


1. Manufacturing TemplateSet
2. Template Index (Optional)
3. Offset (Optional)

View Area Properties (Area tab)


View area and frame properties are defined on the Area tab of the Edit Ruleset View Style
dialog box. For more information and property definitions, see Area Tab (Edit Ruleset View Style
Dialog Box) (on page 130).
The following options are available in the Property field:
1. Area Computation
2. Area Shape
3. Frame Shape
4. Frame Border Style
5. Boundary Overlap
6. Overlap Fill Style
7. Frame Behavior

Template Source (MfgTemplateRuleSet.DefaultRuleSet)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box).
Applies to each template of the templateset created in the Structural Manufacturing
task.

Custom Test
No custom tests are used by the Template source.

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box. No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Manufacturing PinJig Side View Rule Set (on page 222)

Base Control Source (MfgTemplateRuleSet.DefaultRuleSet)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to the templateset created in the Structural Manufacturing task.

Drawings and Reports Reference Data Guide 217


Drawings by Rule Reference Data

Custom Test
No custom tests are used by the Base Control source.

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box. No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Manufacturing PinJig Side View Rule Set (on page 222)

Seam Source (MfgTemplateRuleSet.DefaultRuleSet)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to the lower and upper seams of the Template.

Custom Test
See Custom Tests Dialog Box (on page 122).

Condition Values

Seam Side to draw Upper Seam Based on your selection, the respective
Lower Seam seam is drawn. If you ignore the
condition, both seams are drawn.

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Manufacturing PinJig Side View Rule Set (on page 222)

Drawings and Reports Reference Data Guide 218


Drawings by Rule Reference Data

Manufacturing Templateset Full Scale Drawing Rule Set


A templateset full-scale drawing view style uses the MfgTemplatesetFullScale.DefaultRuleset
rule set, which provides a list of source actions. Each source draws specific types of items and
applies drawing rules to the items based on conditions allowed in the source. Using the Tools >
Define View Style command in the Drawings and Reports task, you specify the
source/condition combination, queries, view area properties, labels, and add-on rulesets you
want to use for your drawing view style.

MfgTemplatesetFullScale.DefaultRuleset
This rule set is used for templateset full-scale drawings.

Source Items (Actions tab)


The rule set and the source/condition definitions are defined on the Action tab of the Edit
Ruleset View Style dialog box. For more information, see Actions Tab (Edit Ruleset View Style
Dialog Box) (on page 119).
The following options are available in the Source field:
 Template Source (MfgTemplatesetFullScale.DefaultRuleset) (on page 220)
 Template Mid Line Source (MfgTemplatesetFullScale.DefaultRuleset) (on page 220)
 Seam Source (MfgTemplatesetFullScale.DefaultRuleset) (on page 221)
 Reference Curve Source (MfgTemplatesetFullScale.DefaultRuleset) (on page 221)

View Queries (Query tab)


View query properties are defined on the Query tab of the Edit Ruleset View Style dialog box.
For more information, see Query Tab (Edit Ruleset View Style Dialog Box) (on page 129).
The following options are available in the Query field:
1. Manufacturing TemplateSet - Templateset. A value for this query is always required.
2. Cascade Horizontal Offset - Cx (Optional) - The horizontal distance by which a template
should be cascaded with respect to its previous template. A value for this query is optional.
3. Cascade Vertical Offset - Cy (Optional) - The vertical distance by which a template should
be cascaded with respect to its previous template. A value for this query is optional.

Drawings and Reports Reference Data Guide 219


Drawings by Rule Reference Data

View Area Properties (Area tab)


View area and frame properties are defined on the Area tab of the Edit Ruleset View Style
dialog box. For more information and property definitions, see Area Tab (Edit Ruleset View Style
Dialog Box) (on page 130).
The following options are available in the Property field:
1. Area Computation
2. Area Shape
3. Boundary Overlap
4. Overlap Fill Style
5. Frame Shape
6. Frame Border Style
7. Frame Behavior

Template Source (MfgTemplatesetFullScale.DefaultRuleset)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to each template of the templateset created in the Structural Manufacturing
task.

Custom Test
No custom tests are used by the Template source.

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box. No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Manufacturing PinJig Side View Rule Set (on page 222)

Template Mid Line Source


(MfgTemplatesetFullScale.DefaultRuleset)
Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to each template of the templateset created in the Structural Manufacturing
task.

Custom Test
No custom tests are used by the Template Mid Line source.

Drawings and Reports Reference Data Guide 220


Drawings by Rule Reference Data

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box. No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Manufacturing PinJig Side View Rule Set (on page 222)

Seam Source (MfgTemplatesetFullScale.DefaultRuleset)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to the lower and upper seams of the Template.

Custom Test
See Custom Tests Dialog Box (on page 122).

Condition Values

Seam Side to draw Upper Seam Based on your selection, the respective
Lower Seam seam is drawn. If you ignore the
condition, both seams are drawn.

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Manufacturing PinJig Side View Rule Set (on page 222)

Reference Curve Source


(MfgTemplatesetFullScale.DefaultRuleset)
Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to reference curves created or imported on plate in the Molded Forms task.

Custom Test
No custom tests are used by the Reference Curve source.

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).

Drawings and Reports Reference Data Guide 221


Drawings by Rule Reference Data

Custom tab of Graphic Style dialog box: No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Manufacturing PinJig Side View Rule Set (on page 222)

Manufacturing PinJig Side View Rule Set


A PinJig side view drawing view style uses the MfgPinJigSideView.Default rule set, which
provides a list of source actions. Each source draws specific types of items and applies drawing
rules to the items based on conditions allowed in the source. Using the Tools > Define View
Style command in the Drawings and Reports task, you specify the source/condition
combination, queries, view area properties, labels, and add-on rulesets you want to use for your
drawing view style.

MfgPinJigSideView.Default
This rule set is used for PinJig side view drawings.

Source Items (Actions tab)


The rule set and the source/condition definitions are defined on the Action tab of the Edit
Ruleset View Style dialog box. For more information, see Actions Tab (Edit Ruleset View Style
Dialog Box) (on page 119).
The following options are available in the Source field:
PlateEdge (see "PlateEdge Source (MfgPinJigSideView.Default)" on page 223)
Seam (see "Seam Intersection Point Source (MfgPinJigSideView.Default)" on page 224)

View Queries (Query tab)


View query properties are defined on the Query tab of the Edit Ruleset View Style dialog box.
For more information, see Query Tab (Edit Ruleset View Style Dialog Box) (on page 129).
The following option is available in the Query field:
Manufacturing PinJig
PinJig. A value for this query is always required.

View Area Properties (Area tab)


View area and frame properties are defined on the Area tab of the Edit Ruleset View Style
dialog box. For more information and property definitions, see Area Tab (Edit Ruleset View Style
Dialog Box) (on page 130).
The following options are available in the Property field:
Area Computation
Area Shape
Boundary Overlap
Overlap Fill Style
Frame Shape

Drawings and Reports Reference Data Guide 222


Drawings by Rule Reference Data

Frame Border Style


Frame Behavior

PlateEdge Source (MfgPinJigSideView.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to the plate of the PinJig.

Custom Test
No custom tests are used by the PlateEdge source.

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box. No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Manufacturing PinJig Side View Rule Set (on page 222)

Drawings and Reports Reference Data Guide 223


Drawings by Rule Reference Data

Seam Intersection Point Source (MfgPinJigSideView.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to the lower and upper seams of the PinJig.

Custom Test
No custom tests are used by the Seam source.

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Manufacturing PinJig Side View Rule Set (on page 222)

Chord Line Source (MfgPinJigSideView.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to the end points of the PinJig plate.

Custom Test
No custom tests are used by the Seam source.

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Manufacturing PinJig Side View Rule Set (on page 222)

Drawings and Reports Reference Data Guide 224


Drawings by Rule Reference Data

Steel Order Drawing Rule Set


Scantling and steel order drawing view styles use the ISSteelOrderRuleSet.Default rule set,
which provides a list of source actions. Each source draws specific types of items and applies
drawing rules to the items based on conditions allowed in the source. Using the Tools > Define
View Style command in the Drawings and Reports task, you specify the source/condition
combination, queries, view area properties, labels, and add-on rulesets you want to use for your
drawing view style.

ISSteelOrderRuleSet.Default
This rule set is used for scantling production (steel order) and classification drawings using both
detailed parts and light (non-detailed) parts.

Source Items (Actions tab)


The rule set and the source/condition definitions are defined on the Action tab of the Edit
Ruleset View Style dialog box. For more information, see Actions Tab (Edit Ruleset View Style
Dialog Box) (on page 119).
The following options are available in the Source field:
 Block: Block Source (ISSteelOrderRuleSet.Default) (on page 230)
 Compartment: Compartment Source (ISSteelOrderRuleSet.Default) (on page 231)
 Plate Part: Plate Part Source (ISSteelOrderRuleSet.Default) (on page 234)
 Profile Part (including profile edge reinforcements): Profile Part Source
(ISSteelOrderRuleSet.Default) (on page 237)
 Member Part: Member Part Source (ISSteelOrderRuleSet.Default) (on page 233)
 Beam: Beam Part Source (ISSteelOrderRuleSet.Default) (on page 230)
 Seam: Seam Source (ISSteelOrderRuleSet.Default) (on page 239)
 Connection:Connection Source (ISSteelOrderRuleSet.Default) (on page 231)
 Reference Curve: Reference Curve Source (ISSteelOrderRuleSet.Default) (on page 238)
 Plate Knuckle: Plate Knuckle Source (ISSteelOrderRuleSet.Default) (on page 234)
 Profile Knuckle: Profile Knuckle Source (ISSteelOrderRuleSet.Default) (on page 236)
 Feature: Feature Source (ISSteelOrderRuleSet.Default) (on page 232)
 Opening: Opening Source (ISSteelOrderRuleSet.Default) (on page 233)

View Queries (Query tab)


View query properties are defined on the Query tab of the Edit Ruleset View Style dialog box.
For more information, see Query Tab (Edit Ruleset View Style Dialog Box) (on page 129).
The following options are available in the Query field:
1. Any system, part, or reference plane
Defines the query by the selected outfitting or structural systems or parts, or a selected
reference plane. When systems are selected, the parts belonging to the systems are used.
Select objects that support the type of drawing view you want to create. A value for this

Drawings and Reports Reference Data Guide 225


Drawings by Rule Reference Data

query is required. The following can be set:


 Plate parts or systems.
 Profile parts or systems.
 Member parts or systems.
 Outfitting parts or systems, including pipe lines, pipe runs, pipe parts, hangers and
supports, and equipment.
 Reference planes from any coordinate system.
Selections can be made manually using Associate Objects to Views in SmartSketch
Drawing Editor. Selections can also be specified automatically as output of an applicable
collation rule. For more information, see Collation Rules in Drawings by Rule in the
Drawings and Reports Reference Data Guide or Collation Rules in the Orthographic
Drawings User's Guide.
2. Boundary (Block, volume, or assembly)
Defines the boundaries of a query by a selected planning block, volume, assembly, or
assembly block. A value for this query is optional.
3. Gathering rule
Defines the type of parts gathered in the drawing view. The rule provides a definition of the
objects to be gathered and drawn in a view. The gathering rule starts with the inputs
selected in Any system, part, or reference plane and adds more objects to the view based
on their relationships to each other. This option opens the Select Gathering Rule dialog
box. Select a rule that supports the type of drawing view you want to create, such as Steel
Order or Assembly. A value for this query is required. The default value is Steel Order.
4. Gathering method
Defines how model objects are included in the drawing view. The volume selected with
Block, volume, or Assembly or created with Volume creation rule is used as input for the
gathering method.
 Gather related objects in volume - Parts are gathered based on connections to
the selected parts resulting from Any system, part, or reference plane. If a volume
is defined for Volume creation rule, only connected objects in the volume are
gathered.
 Gather all objects in volume - All parts in the volume are gathered even if they are
not connected to the selected parts resulting from Any system, part, or reference
plane. If a volume is not defined for Volume creation rule, this option is not valid.
This is the default value.
Relationships (such as parent/child or bounded/bounding) for all gathered objects are also
gathered and used by the selected Gathering rule.
5. Volume creation rule
Defines the volume for the view by one of the following methods:
 Create volume along surface of input parts with boundary extents - The volume
follows the surfaces of the selected parts resulting from Any system, part, or
reference plane. The volume depth (normal to the view) is extended by the values of
Volume growth into drawing and Volume growth out of drawing. The volume area
(in the plane of the view) is extended to (or clipped by) the boundaries defined by

Drawings and Reports Reference Data Guide 226


Drawings by Rule Reference Data

Boundary (Block, volume, or assembly). The gathering range is extended by the


values defined by Extend Into and Extend Out Of.

Example: Corrugated bulkhead


1 - Cross-section of volume
2 - Volume growth
3 - Extended gathering range
4 - Volume extended to boundaries
5 - View direction
6 - Additional part gathered into view
7 - Additional part not gathered into view

 Create volume along surface of input parts without boundary extents - The volume
follows the surfaces of the selected parts resulting from Any system, part, or
reference plane. The volume depth (normal to the view) is extended by the values of
Volume growth into drawing and Volume growth out of drawing. The volume area
(in the plane of the view) is not extended to (nor clipped by) the boundaries defined by
Boundary (Block, volume, or assembly). The gathering range is extended by the
values defined by Extend Into and Extend Out Of.

Example: Corrugated bulkhead

1 - Cross-section of volume
2 - Volume growth
3 - Extended gathering range
4 - View direction
5 - Additional part gathered into view
6 - Additional part not gathered into view

 Create volume from range box around input parts with boundary extents - The
volume is a rectangular range box around the selected parts resulting from Any
system, part, or reference plane. The volume depth (normal to the view) is extended
by the values of Volume growth into drawing and Volume growth out of drawing.
The volume is extended to (or clipped by) the boundaries defined by Boundary (Block,
volume, or assembly). See the corrugated bulkhead example below.

Drawings and Reports Reference Data Guide 227


Drawings by Rule Reference Data

Example: Corrugated bulkhead


1 - Cross-section of volume
2 - Volume growth
3 - Additional part gathered into view
4 - View direction
5 - Volume extended to boundaries

 Create volume from range box around input parts without boundary extents - The
volume is a rectangular range box around the selected parts resulting from Any
system, part, or reference plane. The volume depth (normal to the view) is extended
by the values of Volume growth into drawing and Volume growth out of drawing.
The volume is not extended to (nor clipped by) the boundaries defined by Boundary
(Block, volume, or assembly). See the corrugated bulkhead example below.

Example: Corrugated bulkhead

1 - Cross-section of volume
Example: Non-orthogonal member
2 - Volume growth
3 - Additional part gathered into view
4 - View direction

 Create oriented volume around input parts without boundary extents - The volume
is a rectangular box around the parts. The box is oriented around parts to minimize the
volume. The parts are typically not orthogonal, but the view direction is typically normal
to the box. The volume depth (normal to the view) is extended by the values of Volume
growth into drawing and Volume growth out of drawing.

 If the view direction is not normal to the box, then the volume is extended to (or
clipped by) the boundaries defined by Boundary (Block, volume, or assembly)
instead of Volume growth into drawing and Volume growth out of drawing.

Drawings and Reports Reference Data Guide 228


Drawings by Rule Reference Data

 If the view direction is normal to the box, then the volume is extended to (or clipped
by) Volume growth into drawing and Volume growth out of drawing. These
values can be positive or negative.

Example: Non-orthogonal member

1 - Cross-section of volume
2 - Volume growth
3 - Additional part gathered into view
4 - View direction

 Do not create volume - A volume is not used to restrict gathering using gathering rule.
For example, a shell longitudinal profile view does not use a volume. It instead uses
levels to gather secondary parts.
The volume selected with Boundary (Block, volume, or assembly) or created with
Volume creation rule is also used for view clipping in the graphic rule. For more information,
see Graphic Rules in Drawings by Rule in the Drawings and Reports Reference Data Guide.

View Area Properties (Area tab)


View area and frame properties are defined on the Area tab of the Edit Ruleset View Style
dialog box. For more information and property definitions, see Area Tab (Edit Ruleset View Style
Dialog Box) (on page 130).
The following options are available in the Property field:
 Area Computation
 Area Shape
 Boundary Overlap
 Overlap Fill Style
 Frame Shape
 Frame Border Style
 Frame Behavior

Drawings and Reports Reference Data Guide 229


Drawings by Rule Reference Data

Beam Part Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to detailed and light (non-detailed) beam parts.

Custom Test
Primary and Secondary Orientation (on page 281)
Orientation (on page 279)
Level (on page 278)
Web Orientation (on page 288)
Belongs to Query (on page 264)
Parent Parts (on page 280)
For more information, see Custom Tests Dialog Box (on page 122).

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: See Custom Tab (Graphic Style Dialog Box) (on page
129).

Property Values

Get Connected Objects True Includes connected objects when applying


False actions to objects on the next level

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Block Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to blocks, assemblies, and assembly blocks created in the Planning task.

Custom Test
Primary and Secondary Orientation (on page 281)
For more information, see Custom Tests Dialog Box (on page 122).

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box. No custom graphic rules are used.

Drawings and Reports Reference Data Guide 230


Drawings by Rule Reference Data

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Compartment Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to compartments created in the Compartmentation task.

Custom Test
Primary and Secondary Orientation (on page 281)
Orientation (on page 279)
Belongs to Query (on page 264)
Parent Parts (on page 280)
For more information, see Custom Tests Dialog Box (on page 122).

Graphic Rule
Graphic tab: For Graphic Module, use Simple Volume To X (on page 1027). See Graphic Tab
(Graphic Style Dialog Box) (on page 126).
Custom tab of Graphic Style dialog box: No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Connection Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to logical connections created in the Molded Forms task and physical
connections created in the Structural Detailing task.

Custom Test
Primary and Secondary Orientation (on page 281)
Connection Species (on page 270)
Connection Type (on page 271)
Belongs to Query (on page 264)
Parent Parts (on page 280)
Has Intersection Seam (on page 277)
For more information, see Custom Tests Dialog Box (on page 122).

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: No custom graphic rules are used.

Drawings and Reports Reference Data Guide 231


Drawings by Rule Reference Data

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Feature Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to features created in the Structural Detailing task and hole cuts created in
the Hole Management task.

Custom Test
Tests on Feature:
Primary and Secondary Orientation (on page 281)
Orientation (on page 279)
Belongs to Query (on page 264)
Parent Parts (on page 280)
Tests on Parts:
Primary and Secondary Orientation (on page 281)
Orientation (on page 279)
Level (on page 278)
Web Orientation (on page 288)
IsProfileAngular
Relation to Target Plate (on page 287)
Belongs to Query (on page 264)
Stiffened Plates (on page 288)
Parent Parts
For more information, see Custom Tests Dialog Box (on page 122).

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Drawings and Reports Reference Data Guide 232


Drawings by Rule Reference Data

Member Part Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to members. Members are created in the Structure task.

Custom Test
Applicable custom tests:
Primary and Secondary Orientation (on page 281)
Level (on page 278)
Belongs to Query (on page 264)
Parent Parts (on page 280)
For more information, see Custom Tests Dialog Box (on page 122).

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: See Custom Tab (Graphic Style Dialog Box) (on page
129).

Property Values

Get Connected Objects True Includes connected objects when applying


False actions to objects on the next level

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Opening Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to openings created in the Molded Forms task and hole traces created in the
Hole Management task.

Custom Test
Primary and Secondary Orientation (on page 281)
Orientation (on page 279)
Opening Type (on page 279)
Belongs to Query (on page 264)
Parent Parts (on page 280)
For more information, see Custom Tests Dialog Box (on page 122).

Drawings and Reports Reference Data Guide 233


Drawings by Rule Reference Data

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Plate Knuckle Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to plate knuckles created in the Molded Forms task.

Custom Test
Primary and Secondary Orientation (on page 281)
Orientation (on page 279)
Parent Plate (on page 280)
Relation to Target Plate (on page 287)
Belongs to Query (on page 264)
Parent Parts (on page 280)
For more information, see Custom Tests Dialog Box (on page 122).

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Plate Part Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to detailed and light (non-detailed) plates - planar, linear and non-linear
extruded, and knuckled.

Custom Test
Primary and Secondary Orientation (on page 281)
Orientation (on page 279)
Level (on page 278)
Relation to Target Plate (on page 287)
Orientation Angle (on page 280)

Drawings and Reports Reference Data Guide 234


Drawings by Rule Reference Data

Belongs to Query (on page 264)


Owned By (on page 280)
Parent Parts (on page 280)
For more information, see Custom Tests Dialog Box (on page 122).

Graphic Rule
Graphic tab of Graphic Style dialog box. See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: See Custom Tab (Graphic Style Dialog Box) (on page
129).

Property Values

Get Connected Indicates if connected True


Objects objects are to be False
gathered for this plate

Drawn Side The side of the plate Molded Side


part drawn in the view
Molded Side (Without Features)
Anti Molded Side
Anti Molded Side (Without Features)
Both
Both (Without Features)
Not Applicable
Molded Surface
For more information, see Molded Conventions
for Plate Parts (on page 240).

Orientation Select a value if you (None) - No override


(Override) want to override the
Treat as Target - irrespective of the computed
computed view
direction
orientation (Orientation
condition of the Treat as Non-Target - irrespective of the
Custom Test) computed direction
If the plate is a shell plate, always
select "Treat as Non-Target" to draw the
cross-section of the plate.

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

1. When a plate orientation is overridden, all profiles and seams on the plate are drawn based
on the plate's new orientation.

Drawings and Reports Reference Data Guide 235


Drawings by Rule Reference Data

2. A knuckled plate, because of its natural non-orthogonal orientation, is frequently given an


Orientation of Non-Target, even when selected as part of the query as Level 0. In this
case, an Orientation (Override) of Treat as Target should be selected.
In automated views, the CollationForSteelOrder rule separates flat, curved, and knuckled plates
into separate drawing views. The view for each knuckled or curved plate projects the view along
the closest major axis of the global coordinate system. For manual views, flat, curved, and
knuckled plates can be selected for a single view. In this case, you must choose the coordinate
system and view direction as part of the orientation rule. For more information, see Collation
Rules in Drawings by Rule and Orientation Rules in Drawings by Rule (on page 297).

Profile Knuckle Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to profile knuckles created in the Molded Forms task.

Custom Test
Tests on Profile Knuckle:
Primary and Secondary Orientation (on page 281)
Parent Parts (on page 280)
Tests on Profile:
Primary and Secondary Orientation (on page 281)
Orientation (on page 279)
Level (on page 278)
Web Orientation (on page 288)
IsProfileAngular
Relation to Target Plate (on page 287)
Belongs to Query (on page 264)
Stiffened Plates (on page 288)
Parent Parts (on page 280)
For more information, see Custom Tests Dialog Box (on page 122).
Profile Knuckle inherits its custom test values from Profile Part. For more
information, see Profile Part Source (ISSteelOrderRuleSet.Default) (on page 237).

Graphic Rule
Graphic tab: For Graphic Module, use Profile Knuckle As Curve (on page 1019) or Replace
With Point (on page 1024). See Graphic Tab (Graphic Style Dialog Box) (on page 126).
When Manufacturing Method for a knuckle is set to Extend in the model, no knuckle
for the profile exists on the profile part. This is a method of extending the straight section of a
profile when there is a knuckle on the parent plate. For more information, see Profile Knuckle
Dialog Box in the Molded Forms User's Guide.

Drawings and Reports Reference Data Guide 236


Drawings by Rule Reference Data

Custom tab of Graphic Style dialog box: No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Label Rule
For knuckle text labels, use Scantling Knuckle Line Label_CP_L or Scantling Knuckle Line
Label_CA_L.
For knuckle sloping direction symbols, use Scantling Knuckle Sloping Direction Symbol.
For more information, see Label Templates: Scantling (on page 872).

Profile Part Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to detailed and light (non-detailed) profiles and profile edge reinforcement
parts.

Custom Test
Primary and Secondary Orientation (on page 281)
Orientation (on page 279)
Level (on page 278)
Web Orientation (on page 288)
IsProfileAngular
Relation to Target Plate (on page 287)
Belongs to Query (on page 264)
Stiffened Plates (on page 288)
Parent Parts (on page 280)
For more information, see Custom Tests Dialog Box (on page 122).

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: See Custom Tab (Graphic Style Dialog Box) (on page
129).

Property Values

Get Connected Objects True Includes connected objects


False when applying actions to
objects on the next level

Drawings and Reports Reference Data Guide 237


Drawings by Rule Reference Data

Property Values

Drawing Rule (Auto) Automatically determines how


to draw the profile part
(See table below)

Draw Simple Projection Projects the profile part using


vector hidden line

Draw Landing Curve with Draw the profile part landing


EndCuts curve with endcut symbols

Draw Profile CrossSection Draws the cross-section of the


profile

EndCut Rule Target


Non-Target

(Auto) Drawing Rule

Is the profile an Profile Web Rule used


edge Orientation Orientation
reinforcement?

No Target Target Draw Simple Projection

No Target Non-Target Draw Landing Curve with EndCuts

No Non-Target - Draw Profile CrossSection

Yes Target - Draw Simple Projection

Yes Non-Target - Draw Profile CrossSection

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Reference Curve Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to reference curves created or imported on plates in the Molded Forms task.

Custom Test
Primary and Secondary Orientation (on page 281)
Orientation (on page 279)
Belongs to Query (on page 264)
Parent Parts (on page 280)

Drawings and Reports Reference Data Guide 238


Drawings by Rule Reference Data

For more information, see Custom Tests Dialog Box (on page 122).

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: No custom graphic rules are used.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Seam Source (ISSteelOrderRuleSet.Default)


Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
Applies to all seams (design, intersection, planning, and straking).

Custom Test
Primary and Secondary Orientation (on page 281)
Orientation (on page 279)
Parent Plate (on page 280)
Belongs to Query (on page 264)
Parent Parts (on page 280)
For more information, see Custom Tests Dialog Box (on page 122).

Graphic Rule
Graphic tab of Graphic Style dialog box: See Graphic Tab (Graphic Style Dialog Box) (on page
126).
Custom tab of Graphic Style dialog box: See Custom Tab (Graphic Style Dialog Box) (on page
129).

Property Values

Slot Rule ProgID of the slot graphic rule used for a seam at a slot
(profile penetrating a plate).

General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).

Drawings and Reports Reference Data Guide 239


Drawings by Rule Reference Data

Molded Conventions for Plate Parts


The molded surface never changes. Molded side and anti-molded side can change based on
the defined offset and thickness direction of the plate.

Drawings and Reports Reference Data Guide 240


Drawings by Rule Reference Data

Examples of Actions in Scantling Drawing View Styles


The following examples show the types of actions you can use to create scantling drawing view
styles when using the ISSteelOrderRuleSet.Default rule set. Add the actions on the Actions tab
of the Edit Ruleset View Style dialog box.
See Also
Edit Ruleset View Style Dialog Box (on page 118)
Drawings by Rule View Style Rule Sets (on page 190)

Topics
Block Action: Get Parts in Range of the Block .............................. 242
Plate Part Action: Draw Target Hull Plate Parts ............................ 242
Plate Part Action: Draw Non-Target Plates Bounded by Target Hull Plate
....................................................................................................... 243
Plate Part Action: Draw Target Hull Plates as Non-Target ............ 244
Plate Part Action: Draw Target Light Plates .................................. 245
Plate Part Action: Draw Target Plates ........................................... 246
Plate Part Action: Draw Non-Target Plates Spit by Target Plate .. 247
Plate Part Action: Draw Non-Target Plates Bounded by Target Plate
....................................................................................................... 248
Plate Part Action: Draw Non-Target Plates That Split Target Plate
....................................................................................................... 249
Profile Part Action: Draw and Label Hull Profiles .......................... 249
Profile Part Action: Draw Target Light Profiles .............................. 250
Profile Part Action: Draw Target Profiles ....................................... 251
Profile Part Action: Draw Edge Reinforcement Profiles ................ 252
Profile Part Action: Draw Non-Target Profiles ............................... 253
Seam Action: Draw Seam Symbols on Target Plates ................... 254
Seam Action: Draw Seam Symbols on Bounding Plates .............. 255
Connection Action: Label Connections with Intersection Symbols 256
Connection Action: Label with Penetration Symbols ..................... 257
Connection Action: Label Butt Welds ............................................ 258
Connection Action: Label Tee Welds ............................................ 259
Reference Curve Action: Draw and Label Reference Curves ....... 260
Knuckle Action: Label Knuckles .................................................... 261
Opening Action: Label with Typicals .............................................. 262

Drawings and Reports Reference Data Guide 241


Drawings by Rule Reference Data

Block Action: Get Parts in Range of the Block


Gathers, but does not draw, all objects within a volume created by the boundaries of the
selected block or assembly and a thin slice at the view plane. Objects are gathered even if they
are not assigned to the block/assembly.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Block None None Graphic elements in the None None


block are gathered but not
drawn.
Graphic: None
Custom:
Get parts in range (of the
block)
General:
Include graphics in view
area calculation

Plate Part Action: Draw Target Hull Plate Parts


Gathers and draws target detailed hull plate parts.

Source Filter Custom Tests Graphic Rules Label Dimension


Rules Rule

Plate None Finds level 0 target Graphic: None None


Part plate parts
Narrow blue visible
and hidden lines
Custom:
Get connected
objects
Molded side drawn

Drawings and Reports Reference Data Guide 242


Drawings by Rule Reference Data

Plate part graphics are typically hidden


behind black seam graphics.

Plate Part Action: Draw Non-Target Plates Bounded by Target


Hull Plate
Gathers and draws non-target plate parts that are bounded by the target hull plate and are part
of the block/assembly.

Source Filter Custom Tests Graphic Rules Label Dimension


Rules Rule

Plate None Finds non-target plate parts Graphic: None None


Part
Bounded by the target plate Wide dashed blue visible
and hidden lines
Plate parts belong to the
selected block/assembly Custom:
Do not get connected
objects
Molded side drawn

Drawings and Reports Reference Data Guide 243


Drawings by Rule Reference Data

Plate Part Action: Draw Target Hull Plates as Non-Target


Gathers and draws target hull plate parts, but classifies them as non-target plates.

Source Filter Custom Tests Graphic Rules Label Dimension


Rules Rule

Plate Hull Plate Parts Finds target plate None None


Part parts
Graphic:
(Orientation =
(Catalog Filters/ Narrow black
Target)
Default Intelliship visible and hidden
Filters/ lines
Intelliship Object Filters/
Plate parts do not Custom:
Object Types/
belong to the
All Parts/ Do not get
selected
Plate Parts/ connected objects
block/assembly
Hull Plate Parts)
Molded side drawn
Overrides the
custom test and
treats hull plate as
non-target

Drawings and Reports Reference Data Guide 244


Drawings by Rule Reference Data

Black line - Hull plate part drawn by this action

Plate Part Action: Draw Target Light Plates


Gathers and draws target light (non-detailed) plate parts that are part of the block/assembly.

Source Filter Custom Tests Graphic Rules Label Dimension


Rules Rule

Plate Light Plate Parts Finds target plate Graphic: None None
Part parts
Green visible and
(Orientation = hidden lines
(Catalog Filters/
Target)
Default Intelliship Custom:
Filters/
Get connected
Intelliship Object Filters/
Plate parts belong objects
Object Types/
to the selected
All Parts/ Molded side drawn
block/assembly
Plate Parts Light)

Green lines - Target light plate parts drawn by


this action

Drawings and Reports Reference Data Guide 245


Drawings by Rule Reference Data

Plate Part Action: Draw Target Plates


Gathers and draws target detailed plate parts that are part of the block/assembly.

Source Filter Custom Tests Graphic Rules Label Dimension


Rules Rule

Plate None Finds target plate Graphic: None None


Part parts
Blue visible and
(Orientation = hidden lines
Target)
Custom:
Get connected
Plate parts belong objects
to the selected
Molded side drawn
block/assembly
AddOns:
Mfg Scantling
addon applied

Blue lines - Target plate parts drawn by this


action

Drawings and Reports Reference Data Guide 246


Drawings by Rule Reference Data

Plate Part Action: Draw Non-Target Plates Spit by Target Plate


Gathers and draws non-target light (non-detailed) plate parts that are split by the target plate
and are part of the block/assembly.

Source Filter Custom Tests Graphic Rules Label Dimension


Rules Rule

Plate Light Plate Parts Finds non-target Graphic: None None


Part plate parts
Narrow green
(Orientation = visible and hidden
(Catalog Filters/
Non-Target) lines
Default Intelliship
Filters/ Split by the target Custom:
Intelliship Object Filters/ plate
Get connected
Object Types/
Plate parts belong objects
All Parts/
to the selected
Plate Parts Light) Molded side
block/assembly
drawn

Green line - Non-target light plate parts drawn by


this action

Drawings and Reports Reference Data Guide 247


Drawings by Rule Reference Data

Plate Part Action: Draw Non-Target Plates Bounded by Target


Plate
Gathers and draws non-target light (non-detailed) plate parts that are bounded by the target
plate and are part of the block/assembly.

Source Filter Custom Tests Graphic Rules Label Dimension


Rules Rule

Plate Light Plate Parts Finds non-target Graphic: None None


Part plate parts
Narrow green
(Orientation = visible and hidden
(Catalog Filters/
Non-Target) lines
Default Intelliship
Filters/ Bounded by the Custom:
Intelliship Object Filters/ target plate
Get connected
Object Types/
Plate parts belong objects
All Parts/
to the selected
Plate Parts Light) Molded side
block/assembly
drawn

Green line - Non-target light plate parts drawn by


this action

Drawings and Reports Reference Data Guide 248


Drawings by Rule Reference Data

Plate Part Action: Draw Non-Target Plates That Split Target


Plate
Gathers and draws non-target detailed plate parts that split the target plate and are part of the
block/assembly.

Source Filter Custom Tests Graphic Rules Label Dimension


Rules Rule

Plate None Finds non-target plate parts Graphic: None None


Part
(Orientation = Non-Target) Narrow blue visible and
hidden lines
Splits the target plate
Custom:
Plate parts belong to the
selected block/assembly Get connected objects
Both sides drawn

Blue line - Non-target plate part drawn by this


action

Profile Part Action: Draw and Label Hull Profiles


Draws and labels target hull profile parts that are part of the block/assembly. Labels with short
profile names.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Profile None Finds target profile parts Graphic: Ship Structure None
Part Profile Short
Wide dashed
Name
orange visible and
Not edge reinforcements
hidden lines
on target plate
Custom:
Do not get

Drawings and Reports Reference Data Guide 249


Drawings by Rule Reference Data

Profile parts belong to the connected objects


selected block/assembly
Draw endcuts

Stiffened Plates = Catalog


Filters\Default Intelliship
Filters\Intelliship Object
Filters\Object Types\All
Parts\Plate Parts\Hull Plate
Parts

Profile Part Action: Draw Target Light Profiles


Gathers and draws target light (non-detailed) profile parts that are part of the block/assembly.

Source Filter Custom Tests Graphic Rules Label Dimension


Rules Rule

Profile Light Profile Parts Finds target profile Graphic: None None
Part parts
Narrow dark red
Not edge visible and hidden
(Catalog Filters/
reinforcements on lines
Default Intelliship
target plate
Filters/ Custom:
Intelliship Object Filters/ Profile parts belong
Get connected
Object Types/ to the selected
objects
All Parts/ block/assembly
Profile Parts Light) Draw endcuts

Drawings and Reports Reference Data Guide 250


Drawings by Rule Reference Data

Dark red lines - Target light profile parts drawn


by this action

Profile Part Action: Draw Target Profiles


Gathers and draws target detailed profile parts that are part of the block/assembly.

Source Filter Custom Tests Graphic Rules Label Dimension


Rules Rule

Profile None Finds target profile Graphic: None None


Part parts
Narrow orange
Not edge visible and hidden
reinforcements on lines
target plate
Custom:
Profile parts belong
Do not get
to the selected
connected objects
block/assembly
Draw endcuts

Orange lines - Target profile parts drawn by this


action

Drawings and Reports Reference Data Guide 251


Drawings by Rule Reference Data

Profile Part Action: Draw Edge Reinforcement Profiles


Gathers and draws target detailed edge reinforcement profile parts that are part of the
block/assembly.

Source Filter Custom Tests Graphic Rules Label Dimension


Rules Rule

Profile Detailed Profile Parts Finds target profile Graphic: None None
Part parts
(no filter) Narrow orange
Edge visible and hidden
reinforcements on lines
target plate
Custom:
Profile parts belong
Do not get
to the selected
connected objects
block/assembly
Draw endcuts

Orange line - Target detailed edge reinforcement


profile part drawn by this action

Drawings and Reports Reference Data Guide 252


Drawings by Rule Reference Data

Profile Part Action: Draw Non-Target Profiles


Gathers and draws non- target light (non-detailed) profile parts that are part of the
block/assembly.

Source Filter Custom Tests Graphic Rules Label Dimension


Rules Rule

Profile Light Profile Parts Finds non-target Graphic: None None


Part profile parts
Narrow dark red
Profile parts belong visible and hidden
(Catalog Filters/
to the selected lines
Default Intelliship
block/assembly
Filters/ Custom:
Intelliship Object Filters/
Do not get
Object Types/
connected objects
All Parts/
Profile Parts Light) Draw endcuts

Dark red cross-sections - Non-target light profile


parts drawn by this action

Drawings and Reports Reference Data Guide 253


Drawings by Rule Reference Data

Seam Action: Draw Seam Symbols on Target Plates


Draws and labels target design seams on target plates. Seams are part of the block/assembly.
Labels with the target seam symbol.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Seam Design Seams Finds target seams Graphic: Scantling None


on target plate Target
Narrow black
Seam
Seams belong to visible and hidden
(Catalog Filters/ Symbol
the selected lines
Default Intelliship
block/assembly
Filters/ Custom:
Intelliship Object
Draw slots
Filters/
Object Types/
All Seams/
Design Seams)

Drawings and Reports Reference Data Guide 254


Drawings by Rule Reference Data

Seam Action: Draw Seam Symbols on Bounding Plates


Draws and labels non-target design seams on plates bounding the target plate. The seams are
part of the block/assembly. Labels with the non-target seam symbol.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Seam Design Seams Finds non-target Graphic: Scantling None


seams on plates Non-Target
Narrow black
bounding the target Seam
visible and hidden
(Catalog Filters/ plate Symbol
lines
Default Intelliship
Seams belong to
Filters/ Custom:
the selected
Intelliship Object
block/assembly Draw slots
Filters/
Object Types/
All Seams/
Design Seams)

Drawings and Reports Reference Data Guide 255


Drawings by Rule Reference Data

Connection Action: Label Connections with Intersection


Symbols
Labels connections where a target plate is intersected by non-target plates. The connections are
part of the block/assembly. Labels with the intersection symbol.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Connection Logical Finds side-on-face, Graphic: Scantling None


Connections plate-to-plate Connection
No graphics drawn
connections Intersection
Symbol
Connections
(Catalog Filters/
belong to the
Default Intelliship
selected
Filters/
block/assembly
Intelliship Object
Filters/
Object Types/
All Connections/
Logical
Connections)

Drawings and Reports Reference Data Guide 256


Drawings by Rule Reference Data

Connection Action: Label with Penetration Symbols


Labels connections where a target plate intersects non-target plates. The connections are part
of the block/assembly. Labels with the penetration symbol.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Connection Logical Finds face-on-side, Graphic: Scantling None


Connections plate-to-plate Connection
No graphics drawn
connections Penetration
Symbol
Connections
(Catalog Filters/
belong to the
Default
selected
Intelliship Filters/
block/assembly
Intelliship Object
Filters/
Object Types/
All Connections/
Logical
Connections)

Drawings and Reports Reference Data Guide 257


Drawings by Rule Reference Data

Connection Action: Label Butt Welds


Labels butt welds between target plates. The connections are part of the block/assembly. Labels
with the appropriate weld symbol.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Connection Physical Finds side-on-side, Graphic: WeldLabel None


Connections plate-to-plate
No graphics drawn
connections
Connections
(Catalog Filters/
belong to the
Default
selected
Intelliship Filters/
block/assembly
Intelliship Object
Filters/
Object Types/
All Connections/
Physical
Connections)

I butt weld shown

Drawings and Reports Reference Data Guide 258


Drawings by Rule Reference Data

Connection Action: Label Tee Welds


Labels tee welds between target and non-target plates. The connections are part of the
block/assembly. Labels with the appropriate weld symbol.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Connection Physical Finds side-on-face, Graphic: WeldLabel None


Connections plate-to-plate
No graphics drawn
connections
Connections
(Catalog Filters/
belong to the
Default
selected
Intelliship Filters/
block/assembly
Intelliship Object
Filters/
Object Types/
All Connections/
Physical
Connections)

Drawings and Reports Reference Data Guide 259


Drawings by Rule Reference Data

Reference Curve Action: Draw and Label Reference Curves


Draws and labels reference curves on the target hull plate parts and that are part of the
block/assembly.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Referenc None Finds reference Graphic: Generic_Name None


e Curve curves on target parts
Narrow long dashed
Reference curves dotted black visible
belong to the and hidden lines
selected
block/assembly

Drawings and Reports Reference Data Guide 260


Drawings by Rule Reference Data

Knuckle Action: Label Knuckles


Labels knuckles on target hull plates. The knuckles are part of the block/assembly. Labels with a
knuckle symbol.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Knuckle None Finds knuckles on Graphic: Scantling Knuckle None


target plates Line Symbol
No graphics drawn
Knuckles belong to
the selected
block/assembly

Drawings and Reports Reference Data Guide 261


Drawings by Rule Reference Data

Opening Action: Label with Typicals


Labels major openings on target plates. The openings are part of the block/assembly. Labels
with the opening name, using typical labels.

Source Filter Custom Tests Graphic Rules Label Rules Dimension


Rule

Opening None Finds major openings Graphic: Opening None


on target plates
Fully transparent lines
Openings belong to
(The lines are drawn,
the selected
but not visible The
block/assembly
opening is also drawn
as part of the plate
part)

Typical openings (circled) - Not labeled as


part of the view style, but typical label is part
of the view label
Non-typical openings (arrow) - Label
directly as part of the view style.

Drawings and Reports Reference Data Guide 262


Drawings by Rule Reference Data

Ruleset Custom Tests


Marine mode rule set custom tests are specified as part of the rule set view style definition using
Tools > Define View Style in the Drawings and Reports task. The number and type of tests
available depends on the source object type selected on the Actions tab of the Edit Ruleset
View Style dialog box, as part of the rule set view style property definition. For more
information, see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).
In the Edit Ruleset View Style dialog box, you can assign a custom test to each action (a row
on the grid) by clicking Edit in the Custom field. Edit displays the Custom Tests dialog box (on
page 122).
Custom Tests Dialog Box (Generic Rule Set) (on page 123) displays when you
select the Generic Rule Set (on page 191) on the Actions tab.

Topics
Belongs to Query ........................................................................... 264
Bevel Orientation ........................................................................... 265
Block Location ............................................................................... 266
Bounded......................................................................................... 268
Connected Parts ............................................................................ 268
Connection Species ....................................................................... 270
Connection Type ............................................................................ 271
Coordinate System Relation .......................................................... 272
Direction ......................................................................................... 273
Draw Detail .................................................................................... 274
Draw Flange on Web ..................................................................... 275
Gathered ........................................................................................ 276
Get Parts in Range ........................................................................ 276
Has Intersection Seam .................................................................. 277
Is Root Logical Connection ............................................................ 278
Level .............................................................................................. 278
Opening Type ................................................................................ 279
Orientation ..................................................................................... 279
Orientation Angle ........................................................................... 280
Owned By ...................................................................................... 280
Parent Parts ................................................................................... 280
Parent Plate ................................................................................... 280
Primary and Secondary Orientation .............................................. 281
Related Object Exists .................................................................... 285
Relation to Target .......................................................................... 286
Relation to Target Plate ................................................................. 287
Stiffened Plates .............................................................................. 288
Web Orientation ............................................................................. 288

Drawings and Reports Reference Data Guide 263


Drawings by Rule Reference Data

Belongs to Query
This custom test is for all sources (except Block) in the Actions tab of the Edit Ruleset View
Style dialog box. The custom test is used when a Block source is used first.
The test prevents extra objects from being drawn when using the Get Parts in Range (on page
276) for the Block source. The test is used by view styles in a component that uses an asking
filter for selecting a block. Objects that are assigned to the block are drawn and labeled. Objects
that are not assigned to the block, but are adjacent to the block and added by Get Parts in
Range are not drawn.
True
Objects assigned to the block are drawn regardless of its level. Objects not assigned to the
block are not drawn.
False
Objects are not assigned to the block. They can be drawn using different graphic styles.
Examples

1 - Objects assigned to the block

2 - Objects not assigned to the block, but added by Get Parts in Range.

When Get Parts in Range = True, and Belongs to Query is not used, all objects are drawn:

When Belongs to Query = True, objects not assigned to the block are not drawn:

Drawings and Reports Reference Data Guide 264


Drawings by Rule Reference Data

When a separate action uses Belongs to Query = False, objects not assigned to the block can
be drawn using different graphic styles:

Bevel Orientation
This custom test is to orient the bevel shape with labels on the drawing.
Default
The bevel shape and the values are placed with the default orientation (based on the
orientation in the Manufacturing Profile XML).
Horizontal
The bevel shape and the values are placed in horizontal orientation.
Examples
Bevel Orientation = Default

Drawings and Reports Reference Data Guide 265


Drawings by Rule Reference Data

Bevel Orientation = Horizontal

Block Location
Returns the location of a block in relation to the source planning input (a block, assembly, or
assembly block). Parts within the block are drawn according to the graphic rule selected for the
source.
This custom test is for all planning volume sources (block, assembly, or assembly block) in the
Actions tab of the Edit Ruleset View Style dialog box. The custom test is used with plate part,
profile part, and member sources.
Input
The block is the block selected as the input.

1 - Selected input

Parent of Input
In the Workspace Explorer hierarchy, the block is a parent of the source input. For
example, the block is the parent of an assembly selected as the input.

1 - Selected input
2 - Parent block

Child of Input
In the Workspace Explorer hierarchy, the block is a child of the source input. For example,
the block is the child of an assembly block selected as the input.

Drawings and Reports Reference Data Guide 266


Drawings by Rule Reference Data

1 - Selected input
2 - Child block

Adjacent to Input
In model space the block is next to the block selected as the input.

1 - Selected input
2 - Adjacent blocks

Above Input
In model space the block is above (in model space) the block selected as the input.

1 - Selected input
2 - Block above input

Drawings and Reports Reference Data Guide 267


Drawings by Rule Reference Data

Below Input
In model space the block is below (in model space) the block selected as the input.

1 - Selected input
2 - Block below input

No Input
No source planning input is selected.
Not Available
The part is not in a block.

Bounded
This custom test applies only to plates.
True
The evaluated plate, during initial creation, was bounded by one or more other plate
systems.
False
The evaluated plate, during initial creation, was bounded only by reference planes or was
not bounded.

Connected Parts
Specifies the type of connected parts or systems with respect to the target plate defined in the
view.
This custom test applies to logical and physical connections.
Connections are shown as heavy lines in the following graphics.

1 Target

2 Non-target

Connection

Drawings and Reports Reference Data Guide 268


Drawings by Rule Reference Data

Direction of view

Plate to Plate
A plate connects to a plate.

Profile to Plate
A target profile connects to a non-target plate.

Plate to Profile
A target plate connects to a non-target profile.

Profile to Profile
A profile connects to a profile.

Drawings and Reports Reference Data Guide 269


Drawings by Rule Reference Data

Connection Species
Specifies the type of connected parts or systems with respect to the target plate defined in the
view.
This custom test applies to logical and physical connections.
Connections are shown as heavy lines in the following graphics.

1 Target

2 Non-target

Connection

Direction of view

Plate to Plate
A plate connects to a plate.

Profile to Plate
A target profile connects to a non-target plate.

Plate to Profile
A target plate connects to a non-target profile.

Profile to Profile
A profile connects to a profile.

Drawings and Reports Reference Data Guide 270


Drawings by Rule Reference Data

Connection Type
Specifies the type of connection between the side or face of parts or systems with respect to the
target plate defined in the view.

S Side

F Face

This custom test applies to logical and physical connections.


Connections are shown as heavy lines in the following graphics.
Side on Face
A target side connects to a non-target face.

1 - Target
2 - Non-target
- Connection
- Direction of view

Face on Side
A target face connects to a non-target side.

Drawings and Reports Reference Data Guide 271


Drawings by Rule Reference Data

Face on Face
A face has a lapped connection with a face.

Side on Side
A side has an edge connection with a side.

Coordinate System Relation


Displays the relationship of the coordinate system to the view.
View Coordinate System
The coordinate system is used by the view.
Not Available
The coordinate system has no relation to the view.

Drawings and Reports Reference Data Guide 272


Drawings by Rule Reference Data

Direction
Specifies the orientation of a plate or profile with respect to the target plate defined in the view.
This custom test applies to systems and parts.

1 Orientation = Target
 The target object. The Level custom test is set to 0. For more information, see
Level (on page 278).

2 Orientation = Non-target
 A plate part or system normal is perpendicular to the view direction.
 A plate part or system normal is normal to other targets.
 A profile part or system is on the non-target plate.

3 Orientation = Target
 The normal of a plate part or system is parallel to the view direction.
 The normal of a plate part or system is aligned in the same direction as other
targets.
 A profile part or system is on the target plate.

Direction of view

Drawings and Reports Reference Data Guide 273


Drawings by Rule Reference Data

Draw Detail
This custom test is for bevel shapes with bevel values that need to be shown in a detail box for a
drawing.
True
All the bevel shapes and their bevel values are shown in detail boxes in the drawing.
False
The detail box for the bevels is not shown in the drawing.
Examples
Draw Detail = True:

All the bevel shapes and their bevel values are shown in detail boxes in the drawing.

Draw Detail = False:

The detail box for the bevels is not shown in the drawing.

Drawings and Reports Reference Data Guide 274


Drawings by Rule Reference Data

Draw Flange on Web


This custom test draws a flange line on the web for a profile sketch view. The flange line is
drawn with either the visible or hidden line style, depending on the view direction.
True
The flange line is drawn.
False
The flange line is not drawn.
Examples
Draw Flange on Web = True and flange is hidden:

Draw Flange on Web = True and flange is visible:

Draw Flange on Web = False:

Drawings and Reports Reference Data Guide 275


Drawings by Rule Reference Data

Gathered
Specifies if the object was gathered outside of the volume. This custom test triggers the
gathering of objects outside of the volume
From outside the volume
Specifies that the object was gathered outside of the volume.

Get Parts in Range


This custom test shows all detailed parts and light (non-detailed) parts in the range of the
selected block, assembly, or assembly block by taking a "thin slice" at the view plane and
getting all parts within the slice.
True
All parts in the range of the block/assembly are shown in the view, including shell plate and
shell profiles not assigned to the block.
False
Only parts that are assigned to the block/assembly are shown in the view.
Examples
Get Parts in Range = True:

All parts in the range of the block/assembly are shown in the view, including shell plate and shell
profiles not assigned to the block.
Get Parts in Range = False:

Only parts that are assigned to the block/assembly are shown in the view.

Drawings and Reports Reference Data Guide 276


Drawings by Rule Reference Data

Has Intersection Seam


This test allows you to draw connections at intersection seams.
True
Draws a connection when it has an intersection seam.
False
Ignores the presence of an intersection seam.

1 Connection has an intersection seam.

2 Bounded connection does not have an intersection seam.

 For the ISSteelOrderRuleSet.Default rule set, this custom test is available only for the
Connection source on the Actions tab of the Edit Ruleset View Style dialog box.
 For the DBRGenericRuleSet.GenericRuleSet rule set, this custom test is available for any
type of source.

Drawings and Reports Reference Data Guide 277


Drawings by Rule Reference Data

Is Root Logical Connection


This test determines whether the logical connection is a root logical connection.
True
The connection is a root logical connection.
False
The connection is a leaf logical connection.

Level
Specifies the number of relations that a part or system is from the selected input part or system
in the view hierarchy.
This custom test applies to systems and parts.

0 (Input) Level = 0, The selected object.

1 Level = 1. The object is connected to the Level 0 selected object.

2 Level = 2. The object is connected to a Level 1 selected object.

3 Level = 3. The object is connected to a Level 2 selected object.

Not The object does not have a level, such as when it is collected by the view range.
connected
to inputs

Other Levels outside of the defined levels (greater than 3 and less than 0).

Direction of view.

Additional levels progress upward in the same manner.

Drawings and Reports Reference Data Guide 278


Drawings by Rule Reference Data

Opening Type
Specifies the type of cut in a plate profile part.
This custom test applies to openings.
Major Opening
An opening created in the Molded Forms task.
Hole Trace
A hole created as the result of an outfitting penetration through a plate or profile, and
created in the Hole Management task.

Orientation
Specifies the orientation of a plate or profile with respect to the target plate defined in the view.
This custom test applies to systems and parts.

1 Orientation = Target
 The target object. The Level custom test is set to 0. For more information, see
Level (on page 278).

2 Orientation = Non-target
 A plate part or system normal is perpendicular to the view direction.
 A plate part or system normal is normal to other targets.
 A profile part or system is on the non-target plate.

3 Orientation = Target
 The normal of a plate part or system is parallel to the view direction.
 The normal of a plate part or system is aligned in the same direction as other
targets.
 A profile part or system is on the target plate.

Direction of view

Drawings and Reports Reference Data Guide 279


Drawings by Rule Reference Data

Orientation Angle
Specifies the angle (in degrees) of the plate part normal to the view direction.

Owned By
Specifies a parent object type for a plate part.
This custom test applies to plate parts.
Built-up Member
The plate is part of a built-up member created in the Molded Forms or Structure task.
Advanced Plate System
The plate is part of an advanced plate system created in the Molded Forms task.
Other
The plate is a child to a plate system.

Parent Parts
Species the child plate parts of the parent plate system of the selected object and meeting the
criteria of the selected filter.

Parent Plate
This custom test is for Seam and Knuckle sources in the Actions tab of the Edit Ruleset View
Style dialog box.
The Parent Plate test allows you to supply the relationship of the parent plate of the knuckle or
seam to the target plate:
 Not Applicable
 Splitting the Target
 Split By Target
 Bound By Target
 Bounding the Target
 Stiffens the Target
 Edge Reinforcement on Target
 Target
Without this test, target knuckles or seams on non-target plates cannot be controlled through the
rule set view style and can only be identified as target or non-target. For example, the knuckle
shown below is classified as target and drawn and labeled, even though it is on a non-target
plate and should not be drawn.

1 Target plate (the drawn plate)

Drawings and Reports Reference Data Guide 280


Drawings by Rule Reference Data

2 Non-target knuckles

3 Target knuckle on non-target plate

Primary and Secondary Orientation


These custom tests are used with orthographic view styles for outfitting drawings and
drawings by rule styles for scantling drawings.
Primary Orientation
Displays the orientation of the primary linear axis of an object with respect to the drawing
view. The primary linear axis is along the x-axis of the local coordinate system.

Secondary Orientation

Drawings and Reports Reference Data Guide 281


Drawings by Rule Reference Data

Displays the orientation of the secondary linear axis of an object with respect to the drawing
view. The secondary linear axis is along the y-axis of the local coordinate system. For
members, this corresponds to the web orientation.

Primary Orientation and Secondary Orientation use the same options to display the model
with respect to the drawing view.
The options that specify a direction (for example, Normal, toward you) are
specialized orientations. They are most commonly used for steel members and pipes that have
an air or liquid flow.
Normal
 Normal, toward you
 Normal, away from you

Sloped
 Sloped, toward you
 Sloped, away from you
 Sloped, projects horizontal
 Sloped, projects vertical

Drawings and Reports Reference Data Guide 282


Drawings by Rule Reference Data

The example below, from left to right, shows pipes with the orientations Sloped, projects
horizontal, Sloped, projects vertical, and Sloped.

The Sloped, projects horizontal and Sloped, projects vertical options provide special
orientations for situations in which the drawing needs to distinguish between a sloped pipe or
member that projects orthogonally on the sheet and those that project non-orthogonally on the
sheet. For example, you may prefer orthogonally-projected pipe be dimensioned in the drawing
with the pipes that are parallel and orthogonal to the sheet. The following graphic shows
examples of a 3D model with pipe for both cases:

1 This pipe is sloped in the 3D space of the model,


but projects using the Sloped, projects horizontal
primary orientation. The view style specifies that the
dimensions for the pipe are handled the same as
the actual parallel, horizontal, and vertical pipe in
the view.

2 This pipe is sloped in the 3D space of the model,


but uses the Sloped primary orientation and does
not project horizontally or vertically. The view style
distinguishes between this pipe and pipe 1.

3 These pipes are parallel and horizontal or vertical to


the view, and use the Parallel, horizontal and
Parallel, vertical primary orientations.

Parallel
 Parallel, vertical
 Parallel, pointing up
 Parallel, pointing down
 Parallel, horizontal
 Parallel, pointing right
 Parallel, pointing left

Drawings and Reports Reference Data Guide 283


Drawings by Rule Reference Data

 Parallel, sloped

The following graphic shows an example for members:

1 This target member has a primary orientation of


Parallel, vertical and a secondary orientation of
Parallel, horizontal.

2 This non-target member has a primary orientation of


Normal, toward you and a secondary orientation of
Parallel, horizontal.

Drawings and Reports Reference Data Guide 284


Drawings by Rule Reference Data

For dimensioning purposes in the drawing view, the Parallel, horizontal and Sloped, projects
horizontal pipes are part of the same dimensioning chain. The Sloped pipe is not included in
the dimensioning.

You can resymbolize the model graphics based on special orientation cases. For
example, you might want to represent piping items that are parallel to the sheet plane as single
lines, while representing the items coming straight out of the sheet as special symbols.

Related Object Exists


Specifies whether the object on the other side of a related object exists. This custom test applies
to any object type that belongs to a relationship.
True
Specifies that the object on the other side of the relationship exists.
False
Specifies that the object on the other side of the relationship does not exist.
This object property only applies to the Custom Property on Related Objects. In the
example below, the test locates root logical connections produced by intersection seams.

Drawings and Reports Reference Data Guide 285


Drawings by Rule Reference Data

Relation to Target
Specifies the relationship of the plate or profile to the target plate or profile.
This custom test applies to systems and parts.
Not Applicable
The custom test is not used.
Splitting the Target
The plate or profile splits the target plate or profile.
Splitting the Target Plate
The plate or profile splits the target plate.
Splitting the Target Profile
The plate or profile splits the target profile.
Splitting the Target Member
The plate or profile splits the target member.
Split by Target
The plate or profile is split by a target plate or profile.
Split by Target Plate
The plate or profile is split by a target plate.
Split by Target Profile
The plate or profile is split by a target profile.
Split by Target Member
The plate or profile is split by a target member.
Bound by Target
The plate or profile is bound by a target plate or profile.
Bound by Target Plate
The plate or profile is bound by a target plate.
Bound by Target Profile
The plate or profile is bound by a target profile.
Bound by Target Member
The plate or profile is bound by a target member.
Bounding the Target
The plate or profile bounds the target plate.
Bounding the Target Plate
The plate or profile bounds the target plate.

Drawings and Reports Reference Data Guide 286


Drawings by Rule Reference Data

Bounding the Target Profile


The plate or profile bounds the target profile.
Bounding the Target Member
The plate or profile bounds the target member.
Stiffens the Target
The profile stiffens the target plate.
Stiffened by the Target
The target profile stiffens the plate.
Edge Reinforcement on Target
The profile is an edge reinforcement on the target plate.
Edge Reinforced by the Target
The target profile reinforces the plate.
Target
The plate is the target.
Lapped by the Target Plate
The plate is lapped by the target plate.
Lapped by the Target Profile
The profile is lapped by the target profile.

Relation to Target Plate


Specifies the relationship of the plate or profile to the target plate or profile.
This custom test applies to systems and parts.
Not Applicable
The custom test is not used.
Splitting the Target
The plate or profile splits the target plate or profile.
Split by Target
The plate or profile is split by a target plate or profile.
Bound by Target
The plate or profile is bound by a target plate or profile.
Bounding the Target
The plate or profile bounds the target plate
Stiffens the Target
The profile stiffens the target plate.

Drawings and Reports Reference Data Guide 287


Drawings by Rule Reference Data

Edge Reinforcement on Target


The profile is an edge reinforcement on the target plate.
Target
The plate is the target.

Stiffened Plates
Species the stiffened plate parts meeting the criteria of the selected filter and stiffened by the
profile part.
This custom test apples to profile parts.

Examples
 For Hull profile parts, select the filter Stiffened Plates = "Catalog Filters\Default Intelliship
Filters\Intelliship Object Filters\Object Types\All Parts\Plate Parts\Hull Plate Parts.
 For Deck profile parts, select the filter Stiffened Plates = Catalog Filters\Default Intelliship
Filters\Intelliship Object Filters\Object Types\All Parts\Plate Parts\ Deck Plate Parts.

Web Orientation
This custom test is for profiles and beams.
Target
The profile or beam web is parallel to the evaluated objects.
Non-Target
The web is not parallel to the evaluated object.

Add-on Ruleset View Styles


Add-ons are marine mode rule set view styles that are added to an existing ruleset view style.
The main use of an add-on is to enhance a view style by importing actions. A rule set view style
can have multiple add-on view styles.
Because an add-on is a rule set, it has access to global model data such as the following:
 The drawing view
 The coordinate system
 The thin volume used by a drawing view
 The query results, such as the level 0 objects returned by the query
If an add-on needs to retrieve data from specific objects, instead of from the global
data shared across rule sets, then the rule set for the primary view style can pass specific
objects to the add-on. This is more efficient and provides better performance.
The delivered add-on rule set view styles are located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\RulesetsStyles folder. You add add-on rule sets
to a rule set view style using the Tools > Define View Style command in the Drawings and
Reports task.

Drawings and Reports Reference Data Guide 288


Drawings by Rule Reference Data

When you create a rule set view style, you can add add-on view styles to do the following:
 Import actions. You can import actions to improve the content of the primary rule set view
style. For example, you could add a manufacturing add-on rule set and a rulers add-on rule
set to a Scantling Steel Order view style.
 Override existing actions. You can override a behavior defined in the primary rule set view
style. To override an action, you would discard the action from the primary rule set view
style, enable propagation of the primary rule set view style query, and then make sure an
override action is enabled in the add-on.
The following add-on rule set view styles are delivered:
AddOn - Grid Axis and Lines
Adds visible coordinate system rulers, axes, and grid lines to a rule set view style. This
add-on is included as part of several delivered rule set view styles, such as Hull Lines view
styles. Uses the ISGridRuleSets.Default rule set. For more information, see Grid Add-on
Rulesets (on page 291).
Example

AddOn - Horizontal Grid Axis


Adds visible coordinate system ruler and axis for the horizontal axis to a rule set view style.
The ruler and axis for the vertical axis are not added. This add-on is included as part of
several delivered rule set view styles, such as the Steel Order (Shell Expansion) view
styles. Uses the ISGridRuleSets.Default rule set. For more information, see Grid Add-on
Rulesets (on page 291).

Drawings and Reports Reference Data Guide 289


Drawings by Rule Reference Data

Example

AddOn - Mfg Scantling


Adds manufacturing information created in the Structural Manufacturing task to a Steel
Order view style. This add-on is included as part of the Steel Order rule set view style. Uses
the MfgScantlingRuleSet.Default rule set. Plate margin, marking lines, and shrinkage can
be added as source actions for this add-on. Only plate margin is enabled by default.
AddOn - Grid Axis (Generic)
Adds visible coordinate system rulers and axes to a rule set view style that uses the generic
rule set. This add-on is included as part of several delivered rule set view styles, such as
Steel Order (Generic). Uses the DBRGenericRuleSet.GenericRuleSet rule set.

 The generic rule set only supports rulers add-ons. If you use a ruler add-on, you must
select a block. To process rulers without selecting a block, add the rows directly to the
main view style.

Drawings and Reports Reference Data Guide 290


Drawings by Rule Reference Data

 After you create a ruler add-on for the generic rule set, you must manually add the
information highlighted in the example below to the file:

See Also
Add an Add-on View Style to an Existing Ruleset View Style (on page 136)
AddOns Tab (Edit Ruleset View Style Dialog Box)
AddOns Tab (Graphic Style Dialog Box) (on page 129)
Rules in Drawings by Rule

Grid Add-on Rulesets


A grid add-on view style uses a grid rule set, which provides a list of source actions. Each
source draws specific types of items and applies drawing rules to the items based on conditions
allowed in the source. Using the Tools > Define View Style command in the Drawings and
Reports task, you specify the source/condition combination you want to use for your add-on
view style.
The following delivered rule set applies to grid add-on view styles:

ISGridRuleSets.Default
Source Item Condition

Coordinate System Drawn or Not Drawn. Applied to Grid Lines and Grid Axis

Grid Lines Line style, color, and visibility

Grid Axis Line style, color, and visibility

Available on the Actions tab of the Edit Ruleset View Style dialog box. For more information,
see Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119).

Custom Test
No custom tests are used by ISGridRuleSets.Default.

Drawings and Reports Reference Data Guide 291


Drawings by Rule Reference Data

Custom Tab of Graphic Style Dialog Box


Used only by the Coordinate System source action. See Custom Tab (Graphic Style Dialog
Box) (on page 129).

Property Values

Horizontal Grid Grid axis that is Drawn Applied to the Grid Lines
Axis horizontal with respect and Grid Axis source actions
Not Drawn
to the view

Vertical Grid Axis Grid axis that is Drawn Applied to the Grid Lines
vertical with respect to and Grid Axis source actions
Not Drawn
the view

Graphic Tab of Graphic Style Dialog Box


Graphic tab of Graphic Style dialog box. Used only by the Grid Lines and Grid Axis source
actions. Specifies the line styles, colors, and visibility. See Graphic Tab (Graphic Style Dialog
Box) (on page 126).
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Add-on Ruleset View Styles (on page 288)
Add an Add-on View Style to an Existing Ruleset View Style (on page 136)

Drawings and Reports Reference Data Guide 292


Drawings by Rule Reference Data

Collation Rules in Drawings by Rule


Marine mode collation rules specify how objects returned by a query are grouped. View styles
then use the groups to create views in drawings-by-rule drawings. You specify the collation rule
on the Queries tab of the Setup dialog box in the Drawings and Reports task. When you set up
a Drawings by Rule package in the Drawings and Reports task, the collation rule is part of the
query definition. For more information on using collation rules, see the Orthographic Drawings
User's Guide.
The following example shows the collation concept:

The collation rules are delivered on the client machine in the [Program
Folder]\ShipDrawings\Middle\Bin\CollationRules folder. The rules are also bulkloaded into the
catalog. For more information, see CollationRule Sheet.

CollateAssemblySequence
Identifies the parts in an assembly and the assembly sequence of the parts as defined in the
Planning task, then:
1. Places each part of the assembly in a separate group.
2. Creates a group for each step of the sequence by adding the next part(s) in the sequence.
Only groups parts within an assembly, not assemblies within an assembly or block.

CollateAssemblyStep
Identifies the parts and assemblies that make up an assembly or block and the assembly
sequence of each, then creates a group for each step of the sequence by adding the next
part(s) or assembly in the sequence.

CollateConnectedPlates
Groups connected plate parts. Connected plates are connected face-to-face (lapped
connections) or edge-to-edge (butt connections).

Drawings and Reports Reference Data Guide 293


Drawings by Rule Reference Data

CollateConnectedProfiles
Groups connected profiles parts. Connected profiles are connected end-to-end.

CollateContiguousBlocks
Groups spatially connected blocks.

CollateContiguousProfiles
Groups spatially connected profile parts.

CollateCoplanarPlates
Groups coplanar plate parts or plate parts with coplanar parent systems.

CollateForSteelOrder
Creates groups of major parts in a selected block/assembly. A grouping is created for parts that
meet each of the following tests:
Major Plate Part Tests
 Plate parts of the same type, such as deck plates, transverse bulkhead plates,
longitudinal bulkhead plates, and hull plates.
 Plate parts belonging to the same system.
 Coplanar plate parts that may be in different systems. Coplanar means that plates with
different thicknesses and thickness directions are collated if the thicknesses overlap.
 Connected plate parts or plate parts with connected parent systems. Connections must
be edge-to-edge (butt connections) or face-to-face (lapped connections).
Major Profile Part Tests
 Hull profile parts.
 Profile parts belonging to the same system.
 Connected profile parts or profile parts with connected parent systems. Connections
must be end-to-end.

 Hull plate parts are expanded and are separated into port and starboard groups.
 Brackets and standalone plate parts are not grouped because brackets (created in both the
Molded Forms and Structural Detailing tasks) and standalone plates (created in Structural
Detailing task) are not major parts. After drawings are created, you can manually create
views for these parts.

Drawings and Reports Reference Data Guide 294


Drawings by Rule Reference Data

The following example shows a simple collation using the CollateForSteelOrder rule:

CollateMemberParts
Groups standard member parts and plate parts that make up a built-up member part. A view is
created for each member part.

CollateSimilarProfiles
Groups similar profiles without sketch features to a single view by matching the following
conditions between profiles:
 Cross sections - The cross-section type and size must be the same.
 Material grade - The material grade must be the same.
 End cut counts.
 End cut smart items - The end cut types must be the same, but the end cut parameters may
be different.
 Corner feature counts.
 Corner feature smart items - The corner types must be the same but the feature parameters
may be different.
 Remaining feature counts.
 Remaining feature distances.
 Remaining feature parameter values - Edge features must be exactly the same, including
the position, type, and parameters.

Drawings and Reports Reference Data Guide 295


Drawings by Rule Reference Data

CollateSimilarProfilesByXML
Uses information in the manufacturing profile XML created in the Structural Manufacturing task.
Groups similar profiles without sketch features to a single view by matching conditions between
profiles. The goal is to group profiles based on the profile XML similar to the
CollateSimilarProfiles collation rule. However, the profile XML only contains the data to
support the following conditions:
 Material grade
 End cut counts
 Corner feature counts
 Remaining feature counts
 Remaining feature distances

CollateTemplateSetToTemplates
Places each template in a template set in a separate group.

CollateToFlipShellProfilesByDir
Groups shell profiles with aft orientation into a view and reverses the view direction.

CollateToMany
Places each part in a separate group.

CollateToOne
Groups all parts.
The following table shows how collation rules are typically used, depending on the type of
drawing you are creating:

Type of Drawing Collation Rules

Scantling Drawings, including the following delivered CollateToOne


packages: CollateToMany
CollateConnectedProfile
Steel Order - Expansion
CollateConnectedPlates
Steel Order by Block or Assembly
CollateContiguousProfiles
CollateCoplanarPlates
CollateForSteelOrder

Manufacturing Profile Sketch Drawings, including the CollateToOne


following delivered packages: CollateToMany
CollateSimilarProfiles
Mfg Profile Sketch
CollateSimilarProfilesByXML
Mfg Profile Sketch - Multiple
CollateToFlipShellProfilesByDir

Drawings and Reports Reference Data Guide 296


Drawings by Rule Reference Data

Type of Drawing Collation Rules

Manufacturing Template Drawings, including the CollateTemplateSetToTemplates


following delivered packages:
Mfg Template
Mfg Template Set

Manufacturing PinJig Drawings, including the following CollateToOne


delivered packages: CollateToMany
Mfg PinJig

Hull Lines Drawings, including the following delivered CollateToOne


packages: CollateToMany
Hull Lines

Assembly Drawings, including the following delivered CollateAssemblySequence


packages: CollateAssemblySteps
Assembly Method
Assembly Sequence

See Also
Create Line Styles to Use in Drawing View Styles (on page 89)

Orientation Rules in Drawings by Rule


Marine mode orientation rules specify the available orientations for the current view type. You
specify the orientation rule used with a layout style when you use Place View in a drawing
document open in SmartSketch Drawing Editor or on the General tab of the Setup dialog box in
the Drawings and Reports task. For more information on using orientation rules, see the
Orthographic Drawings User's Guide.
The orientation rules are delivered on the client machine in the [Program
Folder]\ShipDrawings\Middle\Bin folder. The rules are also bulkloaded into the catalog. For more
information, see OrientationRule Sheet.
Global Coordinate System (ISGlobalLCS.Default)
Orientation is relative to the global coordinate system. View direction options include planar
view options such as Looking Aft or Looking Port; and isometric view options such as Up
Port Aft and Plan Starboard Forward. Up direction options are dependent on the selected
view direction and include planar view options Plan, Up, Aft, Forward, Port, or Starboard;
and isometric view options Up, Down, Left, or Right.
Local Coordinate System
Orientation is relative to the local coordinate system of the part as defined by the software.
View direction options include planar view options such as Right (Along -X) or Top (Along

Drawings and Reports Reference Data Guide 297


Drawings by Rule Reference Data

+Z), and isometric view options such as Top Front Right and Bottom Back Left. Up
direction options are dependent on the selected view direction and include planar view
options along the X-, Y-, and Z-axes in both directions, and isometric view options Bottom,
Top, Back, or Front.
Not Applicable (SMNotApplicableLCS.Default)
Orientation rule has no significance. Both View direction and Up direction options are Not
Applicable.
Mfg PinJig SideView (SMMfgPinJigSideLCS.Default)
Orientation is relative to PinJig local coordinate system. View direction options include
planar view options such as Left (Along +X) or Right (Along -X). The up direction option
includes Jig Floor Up.
The up direction is along the jig floor and view directions are along +X and -X, as shown
below:

Scantlings for Plate/Profile


Orientation is relative to a view direction that is across the local x-, y-, and z - axes of the
view coordinate system. If the view does not have any coordinate system, the view direction
will be set to the global X-, Y- or Z-axis. The following are standard combinations of view
direction and up direction:
 Transverse Bulkheads
Section view Looking Aft: View direction is looking aft (Along -Z), Up direction is up
(Along +Y).
Section View Looking Fwd: View direction is looking forward (Along +Z), Up direction is
up (Along +Y).
 Longitudinal Bulkheads
Elevation Looking Stbd: View direction is looking starboard (Along -Z), Up direction is
up (Along +Y).

Drawings and Reports Reference Data Guide 298


Drawings by Rule Reference Data

Elevation Looking Port: View direction is looking port (Along +Z), Up direction is up
(Along +Y).
 Decks
Plan Looking Down: View direction is looking down (Along -Z), Up direction is port
(Along +Y). The forward end of the ship is always oriented to the right of the drawing.
 Shell Profiles
View direction will be either Global –Z or Global +Y based on the angle between the
web surface of the shell profile and Global –Z axis as shown below:

The orientation rule sets the view direction to:


 Global -Z (Plan looking Down) if the angle of inclination is less than the tolerance
angle.
 Global +Y (Looking Port) if the angle of inclination is more than the tolerance
angle.
The default value for the tolerance angle is set to 75 degrees. You can configure the
tolerance angle value using the Angle for Target Evaluation (Optional) view query in the
view style. For more information about view queries, see Steel Order Drawing Rule Set (on
page 225).
Mfg Template At Index
Orientation is relative to the local coordinate system of a template within a template set. The
template is identified by its index number within the template set. View direction options
include planar view options such as Right (Along -X) or Top (Along +Z), and isometric
view options such as Top Front Right and Bottom Back Left. Up direction options are
dependent on the selected view direction and include planar view options along the X-, Y-,
and Z-axes in both directions, and isometric view options Bottom, Top, Back, or Front.

Drawings and Reports Reference Data Guide 299


Drawings by Rule Reference Data

Shell Expansion for Plate


Used for partial shell plate expansions and expansion of curved and knuckled internal
plates. Orientation is relative to the global coordinate system. Up direction option is Up.
View direction options are as follows:
 Looking Outboard and Looking Inboard
 Looking Port and Looking Starboard
Expansion (Hull)
Used for full shell expansions. Orientation is relative to the global coordinate system. In all
view directions, hidden line conventions are ignored. The hull plate is always solid, and all
connected plates and profiles are dashed. The up direction option is Up. View direction
options are as follows:
 Centerline Looking Port and Starboard Looking Centerline - Forward is to the right
in the view.
 Centerline Looking Starboard and Port Looking Centerline - Forward is to the left in
the view.
View Coordinate System
Orientation is relative to the coordinate system specified in the view definition. View direction
options include planar view options, such as Right (Along -X) or Top (Along +Z), and
isometric view options, such as Top Front Right and Bottom Back Left. Up direction
options are dependent on the selected view direction and include planar view options along
the X-, Y-, and Z-axes in both directions, and isometric view options Bottom, Top, Back, or
Front.
If the View direction does not have any coordinate system, then it will be set to the global X-,
Y- or Z-axis.
Scantling By Plate Normal
Orientation is relative to plate normal. The following are standard combinations of view
direction and up direction:
 Plate normal inclined towards global X-axis
 Looking Aft: View direction is looking aft along the plate normal (Along –Z), Up
direction is up (Along +Y).
 Looking Forward: View direction is looking forward (Along +Z), Up direction is up
(Along +Y).
 Plate normal inclined towards global Y-axis
 Looking Stbd: View direction is looking starboard along the plate normal (Along –Z),
Up direction is up (Along +Y).
 Looking Port: View direction is looking port (Along +Z), Up direction is up (Along
+Y).
 Plate normal inclined towards global Z-axis
 Plan Looking Down: View direction is looking down (Along –Z), Up direction is port
(Along +Y).
The following table shows how orientation rules are typically used depending on the type of
drawing you are creating:

Drawings and Reports Reference Data Guide 300


Drawings by Rule Reference Data

Type of Drawing Orientation Rules

Scantling Drawings, including the following Global Coordinate System


delivered packages: Scantlings for Plate/Profile (for planar plates
Steel Order (Expansion) and Shell Profiles)
Steel Order by Block or Assembly Shell Expansion for Plate (for shell plates)
Steel Order (Shell Profiles)

Shell Expansion Expansion (Hull)

Hull Lines Drawings, including the following


delivered packages: Global Coordinate System
Hull Lines

Assembly Drawings, including the following


delivered packages: Local Coordinate System
Assembly Method
Assembly Sequence

Manufacturing Template Drawings,


including the following delivered packages: Local Coordinate System
Mfg Template at Index
Mfg Template Set

Manufacturing PinJig Drawings, including


the following delivered packages: Local Coordinate System
Mfg PinJig

Manufacturing Profile Sketch Drawings,


including the following delivered packages:
Not used
Mfg Profile Sketch
Mfg Profile Sketch (Multiple)

Manufacturing Templateset Full Scale


Not Applicable
Drawing

Manufacturing PinJig Side View Drawing Mfg PinJig SideView

See Also
Create Line Styles to Use in Drawing View Styles (on page 89)

Drawings and Reports Reference Data Guide 301


Drawings by Rule Reference Data

Layout Style Rules in Drawings by Rule


Marine mode layout style rules define the number of views per document, per sheet, and per
region in a drawings-by-rule drawing document. You use Tools > Define Layout Style in the
Drawings and Reports task to create new layout styles. For more information on using this
command, see the Orthographic Drawings User's Guide.
The delivered layout style rules are as follows:
 Document assignment rules that define how many views are in each document
 Sheet assignment rules that define how many views are in each sheet
 Region layout rules that define how many views are in each region
All delivered region layout rules have margins set to 2, with all borders and labels
turned off. The software populates the views within a region from bottom-to-top and left-to-right
across the region.

Document Assignment Rules Purpose

One Document Per Query Creates one document for each query no matter how many
views are created.

One View Puts a maximum of one view in each document.

Two Views Puts a maximum of two views in each document.

Three Views Puts a maximum of three views in each document.

Four Views Puts a maximum of four views in each document.

Five Views Puts a maximum of five views in each document.

Ten Views Puts a maximum of ten views in each document.

Twenty Views Puts a maximum of twenty views in each document.

No Assignment Creates one document with no views assigned.

Sheet Assignment Rules Purpose

Sheet By Regions Specifies that the number of sheets is controlled by the


number of views each region accepts.

One Sheet Per Assembly Specifies that the number of sheets is controlled by the
number of assemblies. This assignment rule is for use in
Assembly Drawings only.

Drawings and Reports Reference Data Guide 302


Drawings by Rule Reference Data

Sheet Assignment Rules Purpose

One Sheet Per Query Specifies that the number of sheets is controlled by the
number of queries.

No Assignment Specifies one sheet with no views assigned.

Region Layout Rules Purpose

Assembly Method A horizontal layout specifically for Assembly Method


Drawings.

Assembly Sequence A layout specifically for Assembly Sequence Drawings.

One View 1x1 A region by layout table with only one graphic view.

One View - Graphical or Report A region by layout table with either one graphic view or one
report view.

One View A region by layout table with only one graphic view.

One Report A region by layout table with only one report view.

Two Views 1x2 A region by layout table with two graphic views in two
columns.

Two Views 2x1 A region by layout table with two graphic views in two rows.

Three Views 1x3 A region by layout table with three graphic views in three
columns.

Three Views 3x1 A region by layout table with three graphic views in three
rows.

Four Views 1x4 A region by layout table with four graphic views in four
columns.

Four Views 2x2 A region by layout table with four graphic rules in two
columns and two rows.

Four Views 4x1 A region by layout table with four graphic rules in four rows.

MfgPinJigSideView-Left A layout with left end view of the plate supported by the
PinJig. This is specific to Manufacturing PinJig drawings.

MfgPinJigSideView-Right A layout with right end view of the plate supported by the
PinJig. This is specific to Manufacturing PinJig drawings.

Drawings and Reports Reference Data Guide 303


Drawings by Rule Reference Data

Region Layout Rules Purpose

MfgPinJigSideView-Main A layout with main view of the PinJig. This is specific to


Manufacturing PinJig drawings.

Each delivered rule uses a processor DLL that defines how the rule behaves within the software.

Processors Used with Document Assignment Rules


Rule Processor File Description Used In Attributes
Available

DBRDocumentByAssembly Creates one Assembly Drawings Maximum


document per number of views
assembly. Group by
Level

DBRDocumentByQuery Creates one All Drawings by Maximum


document per query. Rule documents number of views

DBRDocumentByViews Creates a document All Drawings by Maximum


by the maximum Rule documents number of views
number of views.

Processors Used with Sheet Assignment Rules


Rule Processor File Description Used In Attributes
Available

DBRSheetPerAssembly Creates one sheet All Drawings by Maximum


per assembly. Rule documents. number of views

DBRSheetByQuery Creates one sheet All Drawings by Maximum


per query. Rule documents. number of views

DBRSheetByRegion Creates a sheet by Assembly Drawings


the maximum number
of regions.

Processors Used with Region Layout Rules


Rule Processor File Description Used In Attributes
Available

DBRAssemblyMethodLayout Applies one region Assembly Method Layout style


layout per assembly Drawings
method.

Drawings and Reports Reference Data Guide 304


Drawings by Rule Reference Data

Rule Processor File Description Used In Attributes


Available

DBRAssemblySeqLayout Applies one region Assembly


layout per assembly Sequence
sequence. Drawings

DBRLayoutByTable Applies a All Drawings by Allowed view


user-defined region Rule documents. types
layout by table. You Minimum rows
can give the table row Maximum rows
and column attributes Minimum
to define how many columns
views are allowed in Maximum
the region. columns
Left margin
Right margin
Top margin
Bottom margin
Draw outline
Label views
Show view name
Show view scale

DBRMfgPinjigSideLayout Applies the Manufacturing Region Side


appropriate region PinJig Drawings
layout for PinJig
views as per the
user-defined rules.

Layout Style Rule Attributes


The attributes available for use with the processor rules listed above are described as follows:

Attribute Name Range of Values Description

Allowed view types Graphical views only Specifies whether the region accepts
Graphical views and graphical views, report views, or both.
reports
Reports only

Bottom margin 0 to n Sets the width (in meters) of the bottom


margin of the region.

Draw outline Line style Defines the line style used to draw the
rectangle for the outline for the region.

Group by Assembly or Block Distributes the views on the document


according to the Assembly or Block that
contains the objects.

Drawings and Reports Reference Data Guide 305


Drawings by Rule Reference Data

Attribute Name Range of Values Description

Label views Normal Turns the labels views on and off within a
Not Drawn region.

Layout style Horizontal Sets the arrangement order for the Assembly
Vertical Method Drawing views as either horizontal or
vertical within the region.

Left margin 0 to n Sets the width (in meters) of the left margin of
the region.

Level 1 to n Sets the number of levels from the Assembly


hierarchy to put on each document.

Maximum columns 1 to n Sets the maximum number of columns in a


region table layout.

Maximum number of 1 to n Sets the maximum number of views a


views particular sheet or document can accept.

Maximum rows 1 to n Sets the maximum number of rows in a region


table layout.

Minimum columns 1 to n Sets the minimum number of columns in a


region table layout.

Minimum rows 1 to n Sets the minimum number of rows in a region


table layout.

Right margin 0 to n Sets the width (in meters) of the right margin
of the region.

Show view name True Turns the view name on and off within the
False region.

Show view scale True Turns the view scale on and off within the
False region.

Top margin 0 to n Sets the width (in meters) of the top margin of
the region.

Region Side Left Sets the side view of the plate to be displayed
in the region.
Right
Main

Drawings and Reports Reference Data Guide 306


Drawings by Rule Reference Data

Gathering Rules in Drawings by Rule


Marine mode gathering rules specify the type of parts gathered for a selected view. You specify
the gathering rule used as part of the view style query. For more information on how gathering
rules are used, see Steel Order Drawing Rule Set (on page 225), Generic Rule Set (on page
191), Queries Tab (Setup Dialog Box - Drawings by Rule) in the Orthographic Drawings User's
Guide, and Associate Objects to View Command in the SmartSketch Drawing Editor Help.

Steel Order Drawing Rule Set Rules


Gathering rules for the Steel Order Drawing Rule Set are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DBRRules\GatheringRules folder. The following
rules are delivered:
 Steel Order.xml - Gathering plate, profile and member parts for steel order drawings. This is
the default value in the software.
 Assembly.xml - Gathers objects in an assembly for assembly drawings.

Generic Rule Set Rules


Gathering rules for the Generic Rule Set are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DBRRules\GenericGatheringRules folder. The
following rules are delivered:
 Assembly.xml - Gathers objects in an assembly for assembly drawings.
 Pipe Supports.xml - Gathers pipe supports and their connected parts for pipe support
drawings.
 Piping.xml - Gathers pipelines and their components for piping drawings.
 Steel Order – Extended Volume.xml - Gathers plate, profile, and member parts for steel
order drawings including objects in an extended volume.
 Steel Order – Member Part.xml - Gathers members and connected parts for member part
drawings.
 Steel Order – RefPlane – Preview.xml - Gathers target plates for the preview of steel order
drawings by reference planes.
 Steel Order.xml - Gathers plate, profile, and member parts for steel order drawings. This is
the default value in the software.
 Volume.xml - This is an empty gathering rule for pure volume drawings.
You can customize the existing rules or create new rules and add them to the appropriate
GatheringRules folder. The new rules then automatically display in the Select Gathering Rules
dialog box in the software. The file name without the .xml extension is displayed in the dialog
box.

Drawings and Reports Reference Data Guide 307


Drawings by Rule Reference Data

Section View Orientation Rules in Drawings by Rule


Plant Mode Section View Orientation Behavior
The software automatically determines the "up" direction for section views. In most cases, the
up direction is "up," or +Z. In cases where using +Z is impossible (for example, if the section
view direction is Looking Plan or Looking Up), the software orients the view to the North
direction.
The following examples outline common section view orientations:
Looking Plan

P1 Cutting Plane P2 Cutting Plane P3 Cutting Plane

Looking East Looking South Looking South, East

Up direction is up. Up direction is up. Up direction is up.

Drawings and Reports Reference Data Guide 308


Drawings by Rule Reference Data

Looking North

E1 Cutting Plane E2 Cutting Plane E3 Cutting Plane

Looking South Looking Plan Looking South, Plan

Up direction is up. Up direction is North. Up direction is up.

Drawings and Reports Reference Data Guide 309


Drawings by Rule Reference Data

Looking East

E4 Cutting Plane E5 Cutting Plane E6 Cutting Plane

Looking South Looking Plan Looking South, Plan

Up direction is up. Up direction is North. Up direction is up.

Drawings and Reports Reference Data Guide 310


Drawings by Rule Reference Data

Marine Mode Section View Orientation Behavior


The software automatically determines the "up" direction for section views. In most cases, the
up direction is "up," or +Z. In cases where using the z-axis is impossible (for example, if the
section view direction is Looking Plan or Looking Up), the software orients the view to the Port
direction.
Additionally, angled sections of elevation views, and any section of a non-standard view
direction (in which it is possible) uses Port orientation.
The following examples outline common section view orientations:
Looking Plan

P1 Cutting Plane P2A-P2B Cutting Plane P3 Cutting Plane

Looking Fore Looking Starboard Looking Fore, Starboard

Up direction is up. Up direction is up. Up direction is up.

Drawings and Reports Reference Data Guide 311


Drawings by Rule Reference Data

Looking Aft

E1 Cutting Plane E2 Cutting Plane E3 Cutting Plane

Looking Port Looking Plan Looking Port, Plan

Up direction is up. Up direction is Port. Up direction is Port.

Looking Port

E4 Cutting Plane E5 Cutting Plane E6 Cutting Plane

Drawings and Reports Reference Data Guide 312


Drawings by Rule Reference Data

Looking Fore Looking Plan Looking Fore, Plan

Up direction is up. Up direction is Port. Up direction is Port.

For more information, see Orientation Rules in Drawings by Rule (on page 297) in the Drawings
and Reports Reference Data Guide.

Line Styles in Drawings by Rule


Line styles used in marine mode drawings by rule are available in the ISStyles.sha file on the
[Reference Data Folder]\SharedContent\Drawings\Catalog\Templates folder. To add line styles
to this file, you need write permission to the file because it is shared. If you do not have write
permission to the file, you will not be able to save changes you make to the file. Contact your
system administrator if you require write access to the file.
Create Line Styles to Use in Drawing View Styles (on page 89)

Document and Sheet Naming Rules in Drawings by


Rule
Marine mode naming rules are used to define unique names for Drawings by Rule documents.
The naming rules also define sheet names within the drawings.
Rules for orthographic drawing names are delivered in the Visual Basic projects in the [Product
Folder]\ShipDrawings\Data\Rules\NamingRules\DrawingSheet folder. Each project is compiled
into a .dll and delivered in the [Product Folder]\ShipDrawings\Middle\Bin\NamingRules folder.
The rules are also bulkloaded into the catalog. For more information, see Naming Rules
Worksheet.
You can define document and sheet names for a component when you use the Edit Sheet
Properties command in SmartSketch Drawing Editor while a drawings by rule document is
open. Document naming rules are defined on the Document tab of the Sheet Properties dialog
box. Sheet naming rules are defined on the Current Sheet tab of the Sheet Properties dialog
box.
For more information on the Edit Sheet Properties command, see the SmartSketch Drawing
Editor Help.

Drawings and Reports Reference Data Guide 313


Drawings by Rule Reference Data

The following default naming rules are delivered:

Default
 Document
Names the drawing using the following criteria:
<plant name><model name>"-"<Global Workshare Location ID>"-D"<index number>
For example, if a model named L101 has a location ID set to 12 in the Project Management
task, the name of the second drawing created should be named L101-12-00002.
 Sheets - Names drawing sheets using the default software names. For example, two sheets
are named Sheet1 and Sheet2.

Name by Assembly
Finds the first view on the drawing (as sorted internally by the software), finds the primary input
object on the view (such as a system or part), and uses the parent assembly or block of the
primary object, as defined by the Planning task.
 Document
Names the drawing using the following criteria:
<model name>"-"<Global Workshare Location ID>"-"<assembly/block
name>"-D"<index number>
For example, for a model name of L101, a location ID of 1, and an assembly name of
A0123, the first drawing created based on the assembly name should be named
L101-1-A0123-D0001.
 Sheets
Names drawing sheets using the following criteria:
<assembly/block name>"_"<index number>
For example, three sheets using the same assembly name are named A0123, A0123_1,
and A0123_2. Two sheets using different assembly names are A0123 and A4567.
When the criteria for the rule are not met, the software defaults to the Default rule.

Name by Query
Finds the first view on the drawing (as sorted internally by the software) and uses the primary
input object on the view (such as a system or part). Also determines if the Global Workshare
Location ID is part of the block/assembly name.
 Document
Names the drawing using the following criteria:
<model name>"-"<Global Workshare Location ID>"-"<object name>"-D"<index
number>
For example, for a model name of L101, a location ID of 1, and a plate part name of
<B0.1>-LS.5-1, the second drawing created based on the part name should be named
L101-1-<B0.1>-LS.5-1-D02.
 Sheets

Drawings and Reports Reference Data Guide 314


Drawings by Rule Reference Data

Names drawing sheets using the following criteria:


<object name>"_"<index number>
For example, three sheets using the same plate system name are named A-103DCK,
A-103DCK_1, and A-103DCK_2. Two sheets using different assembly names are
A-103DCK and A-110DCK.
When the criteria for the rule are not met, the software defaults to the Default rule.

Name by Grid Plane


Finds the first view on the drawing (as sorted internally by the software), finds the primary input
object on the view, and looks for the parent system if the input object is not a system. The rule
then uses the name of the grid plane that defines a plate system or the profile system name for
a profile system. This rule is only used for planar plate systems or intersection profile systems.
 Document
Names the drawing using the following criteria:
<model name>"-"<Global Workshare Location ID>"-"<grid plane name>"+ or -"<offset
from grid plane>"-D"<index number>
If the drawing is for a shell profile, names the drawing using the following criteria:
<model name>"-"<Global Workshare Location ID>"- Shell Profile -"<parent profile
system name>"-"<index number>
For example, for a model name of L101, a location ID of 1, and a plate system defined by a
grid plane of F222, the third drawing created based on the grid plane should be named
L101-1-F222-D03. For a grid plane of F222 and a global coordinate system offset of -0.5 m,
the drawing is named L101-1-F222-0.5-D03. For a profile by intersection, the profile name is
used, such as L101-1-D47-1DCK-101T-D01.
 Sheets
Names drawing sheets using the following criteria:
<grid plane name>"+ or -"<offset from grid plane>"_"<index number>
For example, three sheets using the same assembly name are named F222, F222_1, and
F222_2. Two sheets using different assembly names are F222 and F232.
When the criteria for the rule are not met, the software defaults to the Default rule.

Name by Asking Assembly


 Document (automatically created, single view, shell plates)
If a block or assembly is selected through an asking filter, the drawing is named using the
following criteria:
<model name>"-"<Global Workshare Location ID>"-SH-EX-"<assembly/block name>" -
"<PORT/STBD>"-D"<index number>
For example, for a model name of L101, a location ID of 1, and a starboard block name of
B0.1.2, the second drawing created based on the grid plane should be named
L101-1-SH-EX-BO.1.2-STBD-D03.
If a single shell part is selected without the block/assembly asking filter, the drawing is
named using the following criteria:

Drawings and Reports Reference Data Guide 315


Drawings by Rule Reference Data

<model name>"-"<Global Workshare Location ID>"-SH-EX-"<part name>" -


"<PORT/STBD>"-D"<index number>
If multiple shell parts are selected without the block/assembly asking filter, the drawing is
named using the following criteria:
<model name>"-"<Global Workshare Location ID>"-SH-EX-"<PORT/STBD>"-D"<index
number>
 Document (automatically created, single view, non-shell plates)
Names the drawing using the following criteria:
<model name>"-"<Global Workshare Location ID>"-"<grid plane name>"+ or -"<offset
from grid plane>"-D"<index number>
For example, for a model name of L101, a location ID of 1, and a plate system defined by a
grid plane of F222, the third drawing created based on the grid plane should be named
L101-1-F222-D03. For a grid plane of F222 and a global coordinate system offset of -0.5 m,
the drawing is named L101-1-F222-0.5-D03.
 Document (automatically created, multiple views)
Names the drawing using the following criteria:
<model name>"-"<Global Workshare Location ID>"-MultipleViews-D"<index number>
For example, for a model name of L101, and a location ID of 1, the first drawing created
based on the assembly name should be named L101-1-MultipleViews-D0001.
 Document (manually created)
Use the Add Document command in the Management Console to manually create
documents.
Names the drawing using the following criteria:
<model name>"-"<Global Workshare Location ID>"-"<assembly/block
name>"-D"<index number>
For example, for a model name of L101, a location ID of 1, and an assembly name of
A0123, the first drawing created based on the assembly name should be named
L101-1-A0123-D0001.
 Sheets - Names drawing sheets using the default software names. For example, two sheets
are named Sheet1 and Sheet2.
When the criteria for the rule are not met, the software defaults to the Name by Query rule.

Name by Template Set Plate Part


This rule is applicable only to template set drawings.
Finds the first view on the drawing (as sorted internally by the software) and uses the primary
input object on the view (such as a system or part). Also determines if the Global Workshare
Location ID is part of the block/assembly name.
 Document
Names the drawing using the following criteria:
<model name>"-"<Global Workshare Location ID>"-"<TemplateSet Plate Part
name>"-D"<index number>

Drawings and Reports Reference Data Guide 316


Drawings by Rule Reference Data

For example, for a model name of L101, a location ID of 1, and a Templateset plate part
name of <B0.1>-LS.5-1, the second drawing created based on the part name should be
named L101-1-<B0.1>-LS.5-1-D02.
 Sheets
Names drawing sheets using the following criteria:
< TemplateSet Plate name>"_"<index number>
For example, three sheets using the same plate system name are named A-103DCK,
A-103DCK_1, and A-103DCK_2. Two sheets using different assembly names are
A-103DCK and A-110DCK.
When the criteria for the rule are not met, the software defaults to the Default rule.

Name for Full Expansion


This rule is applicable only to full expansion drawings.
Finds the shell expansion view on the drawing and finds the hull object on the view. Also
determines if the Global Workshare Location ID is part of the name, and whether a port or
starboard view type has been selected.
 Document
Names the drawing using the following criteria:
<model name>"-"<Global Workshare Location ID>"- SHELL EXPANSION -" <PORT or
STBD> "-D"<index number>
For example, for a ship name of L101, a location ID of 1, and a view type of starboard, the
drawing should be named L101-1- SHELL EXPANSION -STBD-D0001.
 Sheets - Names drawing sheets using the default software names. For example, two sheets
are named Sheet1 and Sheet2.
When the criteria for the rule are not met, the software defaults to the Default rule.

View Naming Rules in Drawings by Rule


Marine mode view naming rules control the name assigned to a drawing view. The rules are
delivered in the Visual Basic projects in the [Product
Folder]\ShipDrawings\Data\Rules\NamingRules\DrawingView folder. Each project is compiled
into a .dll and delivered in the [Product Folder]\ShipDrawings\Middle\Bin\NamingRules folder.
The rules are also bulkloaded into the catalog. For more information, see Naming Rules
Worksheet.
The rules have corresponding view labels. For more information, see View Label Rules in
Drawings by Rule (on page 920).
You define view names for a drawings by rule component in the Management Console or the
Drawing Console. Right-click the component and select Setup on the shortcut menu. When
you add a view or edit the view properties on the General tab of the Setup dialog box, the View
Definition dialog box displays. You can modify the View Naming Rule on this dialog box.
The following naming rules are delivered with the software:

Drawings and Reports Reference Data Guide 317


Drawings by Rule Reference Data

Default
Default naming convention is applied by the software. For example: View1.

Name by Block for Expansion


Uses the selected assembly, block, or assembly block name. This rule is used for shell
expansions in a block or assembly.
Names the view using "SHELL EXPANSION - "<PORT/STBD>" - "<assembly/block name>. For
example, for a starboard-side assembly name of A0123, the view is named SHELL
EXPANSION - STBD - A0123.

Name by Direction
Finds the primary input part in the view and the view direction returned from the orientation rule.
Names the view using <primary part name> "-" <view direction>. For example, for a member
part view, the name is BU1900x750x15x50-1-001 - Along +Y. For a view with a deck plate part
as the primary input, the name is <B412>-4LS.16-1 - Plan Looking Down.

Name by Grid Plane


Finds the primary input plate part in the view and uses the plate type and the grid plane used to
create the parent plate system of the part. This rule is used for plate parts and intersection
profile part.
For planar plates that lie on a major grid plane, names the view using <plate type> <grid plane
name>"+ or -"<offset from grid plane>. For example, for a transverse plate defined by a grid
plane of F234, the view is named Transverse F234. For a grid plane of F234 and a global
coordinate system offset of -0.5 m, the view is named Transverse F234-0.5.
For plates that do not lie on a major grid plane (such as inclined plates, knuckled plates, and
planar orthogonal plates that are between grid planes), names the view using <plate type>
<parent plate system name>. Collected plates are sorted alphabetically, and the first parent
plate system name is used.
For a shell profile view, names the view using "SHELL PROFILE -" <parent profile system
name>.

Name by Parts for Expansion


Uses the selected plate part name and finds the transverse side location of part. This rule is
used for expansions of a single part or expansions of multiple parts that are not selected by
block or assembly.
 View with an individual shell part - Names the view using "SHELL EXPANSION -
"<PORT/STBD>" - "<plate part name>. For example, SHELL EXPANSION - PORT -
<B0.1>-SH.1501-1.
 View with an individual non-shell part - Names the view using "EXPANSION - "<plate
part name>. For example, EXPANSION - <B0.1>-47_20223LS.102-1.
 View with multiple shell parts not selected by block/assembly - Names the view SHELL
EXPANSION - PORT or SHELL EXPANSION - STBD.

Drawings and Reports Reference Data Guide 318


Drawings by Rule Reference Data

Name by Query
Sheet name is the returned query name.

Name by Style
Names the view using the view definition name. For example, if the view definition used is “Mfg
PinJig - Pin Data” then the view is named Mfg PinJig - Pin Data. For more information about
view styles, see Define View Style Command (Tools Menu) (on page 56) in the Drawings and
Reports Reference Data Guide.

Name by Template
This rule is applicable only to template set drawings.
The view name is the name of the template in that view.

Name for Full Expansion


This rule is applicable only to full expansion drawings.
Names the view using "SHELL EXPANSION - "<view definition type name>". For example, if the
view definition used is "Starboard," the view is named SHELL EXPANSION - Starboard.
When the criteria for a selected naming rule are not met, the software defaults
to the Default rule.
For more information on setting up drawings by rule, see the Orthographic Drawings User's
Guide.

Drawings by Rule Reports


Two types of reports are part of the marine mode drawings by rule component setup. When you
set up a component or package in the Drawings and Reports task, you can add reports as part
of the setup definition. For more information on adding reports to a Drawings by Rule
component, see Setup a Drawings by Rule package in the Orthographic Drawings User's Guide.
Drawings by rule reports are installed in the [Reference Data
Folder]\SharedContent\Reports\Types of Reports\ShipDrawings folder. A sub-folder exists for
each delivered report.
Drawings by rule reports are delivered as dependent reports that are associated to a view, and
as embedded standalone reports that are not associated with a view.
The delivered drawings by rule reports include the following:

Drawing Type Reports Used

Scantling Drawings, including the following delivered Shell Expansion


packages:
Steel Order (Expansion)

Drawings and Reports Reference Data Guide 319


Drawings by Rule Reference Data

Drawing Type Reports Used

Manufacturing Profile Sketch Drawings, including the following Single Profile Sketch Report
delivered packages Multiple Profile Sketch Report
Mfg Profile Sketch
Mfg Profile Sketch (Multiple)

Manufacturing Template Drawings, including the following Mfg Template - Split Row
delivered packages:
Mfg Template Set

Manufacturing PinJig Drawings, including the following PinJig Report


delivered packages: Accuracy Data Report
Mfg PinJig

Hull Lines Drawings, including the following delivered None delivered.


packages:
Hull Lines

Assembly Drawings, including the following delivered None delivered.


packages:
Assembly Method
Assembly Sequence

For more information on adding drawing packages to the Management Console, see the
Orthographic Drawings User's Guide.
See Also
Drawings by Rule Packages (on page 164)

Drawings and Reports Reference Data Guide 320


SECTION 4

Orthographic Drawings Reference Data


You can customize your orthographic drawings by understanding and modifying the delivered
drawings reference data. You can use reference input data for multiple drawing types, or you
could configure different inputs for each type of drawing. The customizable reference data
includes the following:
 View styles (orthographic and key plan) and view style rules
 Packages
 Labels, symbols, and dimensions
There are other customizable elements which are common to all drawings, as follows:
 Lines styles
 Naming rules
 Layout styles

In This Section
Bulkload Files .................................................................................321
Orthographic Drawing Packages ....................................................330
Orthographic and Key Plan View Styles .........................................370
Layout Style Rules in Orthographic Drawings ................................635

Bulkload Files
Bulkload files are used to add reference data to the catalog. The reference data includes
codelist values, rule progIDs, symbol file locations, and default values for rule and symbol
parameters. The relationships between different types of reference data are also established.
Each bulkload file is delivered with default values that can be customized. For more information
about bulkloading, see the Smart 3D Reference Data Guide.
Additionally, special Microsoft Excel workbooks are delivered to aid in bulkloading new
reference data into the product.

Topics
Drawings Workbook ....................................................................... 322
Custom Scale Codelist Workbook ................................................. 323
Custom Attributes .......................................................................... 325
DrawingIssueReason_Codelist Workbook .................................... 328

Drawings and Reports Reference Data Guide 321


Orthographic Drawings Reference Data

Drawings Workbook
The Drawings.xls workbook defines drawing volumes, which are used in the creation of
drawings. The folder hierarchy in the catalog is also defined. This workbook is located in the
[Product Folder]\CatalogData\BulkLoad\DataFiles folder.
In the Catalog task, you can view the hierarchy of folders containing the drawing volumes.

The Drawing Volume Properties worksheet defines the part class information for drawing
volumes.
You can place drawing volumes in the Space Management task for use in the creation of
volume drawings. Drawing volumes are also automatically placed when creating snapshot views
for composed drawings. For more information about drawing volume placement, refer to the
Space Management User's Guide.
PartNumber
Specifies the part number.
All part numbers must be unique across the entire catalog.
PartDescription
Describes the part.
SymbolDefinition
Specifies a symbol definition. If the symbol definition for a part is the same as the definition
for the part class, type NULL or leave blank.
MirrorBehaviorOption
Indicates whether mirroring functionality is activated.

 For more information on modifying bulkload workbook, refer to the Reference Data Guide.
 All files must be located in the SharedContent folder for bulkloading to be successful.
See Also
Add A Drawing Volume Part Class (on page 323)

Drawings and Reports Reference Data Guide 322


Orthographic Drawings Reference Data

Add A Drawing Volume Part Class


1. Open the Drawings.xls workbook.
2. Select the Drawing Volume Properties sheet.
3. Select a row after the Start keyword but before the End keyword, and click Insert > Rows.
4. In column A, type A to indicate a new drawing volume part class will be added during the
next bulkload.
The left-most column (column A) of the sheet specifies the bulkload action taken
with regard to the row. For example, an A in the column indicates the drawing volume part
class is being added; the letter D specifies the class is deleted; the letter M indicates the
class is modified. A ! symbol specifies that the row is ignored during bulkloading.
5. In the PartNumber column, type a part number for the drawing volume part class.
6. Define the remaining properties for the new drawing volume part class.
7. Save the Drawings.xls workbook.
8. Bulkload the workbook into the catalog.

 For more information on bulkloading the workbook, see the Reference Data Guide.
 If you add new part classes after creating the reports databases, you must re-create the
reports databases in order to report on the new part classes. For more information, see the
Project Management User's Guide.

Custom Scale Codelist Workbook


The CustomScaleCodelist.xls workbook provides an example format for adding drawing
custom attributes, such as custom scales used in the codelists. This workbook is delivered in the
[Product Folder]\CatalogData\BulkLoad\SampleDataFiles folder.
The following example shows the DrawingUserSelectedScales worksheet. The values in red
are delivered in the software, while the blue values are custom values that are useful for
Drawings and Reports users. To add values, type A in the first column. To modify values in the
codelist, type M in the first column. To delete the values from the codelist, type D in the first
column.

Drawings and Reports Reference Data Guide 323


Orthographic Drawings Reference Data

When adding a new scale value, a Codelist Number value is required. The
new scale will be added to the end of the codelist regardless of the Codelist Number value.

DrawingUserSelectedScales ShortDescription
 This value must be unique in the spreadsheet.
 1000- is the prefix for all English units (as defined in row 11 on the previous figure).
2000- is the prefix for all Metric units (as defined in row 38 on the previous figure). 3000-
is the prefix for all Architectural units.
 The value following the prefix is equal to the fraction. For example, 1/240 =
0.004166667.
 You can leave off the prefix if the value is already unique in the spreadsheet. For
example, the prefix is not required in row 12 because 40 is a unique value. If you use 40
anywhere else in the spreadsheet, the prefix is required.
DrawingUserSelectedScales LongDescription
 The software displays this value in the User Selected Scale box in drawing properties.
 This value must be the actual scale.
 You must use a decimal point (.) as the decimal separator.
Codelist Number
This must be a unique number that falls between the prefix numbers. For example, all
English scales must use a number between 1000 and 2000.
After modifying the Excel file, save your changes, and exit Excel.
For information on creating custom drawing properties for use in drawings, see Place
a Custom Drawing Property Label on a Template in the Orthographic Drawings User's Guide.

Drawings and Reports Reference Data Guide 324


Orthographic Drawings Reference Data

Custom Attributes
To use custom attributes, the following workbooks must be bulkloaded:
 DrawingCustomProperties.xls
 Drawings-ExtendCustomAttributes.xls

DrawingCustomProperties Workbook
The DrawingCustomProperties.xls workbook provides an example format for adding drawing
custom attributes, such as custom drawing properties to be used in creating drawing borders.
This workbook is delivered in the product [Product
Folder]\CatalogData\BulkLoad\AdditionalDataFiles folder.
This workbook allows you to add up to approximately 25 custom properties. To add
more properties, see Drawings-ExtendCustomAttributes Workbook (on page 327).
The following example shows the CustomInterfaces sheet set up to use the IJDwgCustom
interface with a single property, CustomAttributeName.

The left-most column (column A) of the sheet specifies the bulkload action taken with regard to
the row. For example, an A in the column indicates the drawing volume part class is being
added; the letter D specifies the class is deleted; the letter M indicates the class is modified. A !
symbol specifies that the row is ignored during bulkloading.

CustomInterfaces Sheet
This sheet defines the custom attribute.
InterfaceName
Specifies the name of the custom interface you are using to implement the custom attributes
against the DwgPropertyObject class. For more information, see the Programmer's Guide.
CategoryName
Not used at this time.
AttributeName
Identifies the programmatic name of the attribute.
AttributeUserName
Identifies the user name for the attribute.

 The AttributeUserName must be unique for each user name entry. For example, Title1
cannot be used because it is a delivered AttributeUserName value. For a list of
delivered attribute user names, see Title Area Tab (Properties Dialog Box) and
Signature Area Tab (Properties Dialog Box) in the Orthographic Drawings User's Guide.

Drawings and Reports Reference Data Guide 325


Orthographic Drawings Reference Data

 For any integrated SmartPlant Enterprise application, the delivered AttributeUserName


values cannot be edited.
Type
Specifies the type of attribute. For example, char for character.
UnitsType
Specifies the unit type for the attribute.
PrimaryUnits
Identifies the primary unit for the attribute
CodeList
Specifies the name of the table that contains the codelisted values for this attribute. If the
cell is empty, the codelist is Null and ignored by the software.
OnPropertyPage
Specifies whether this attribute is displayed by the attribute control. Value is True if the
attribute is displayed on a control and False if not.
codelisttablenamespace
Identifies the table name space for the codelist if needed.
ReadOnly
Specifies whether the attribute can be modified by the attribute control. Value is True if the
attribute can be modified and False if not.
SymbolParameter
Identifies the symbol parameter used for the attribute if needed.

CustomClassInterfaceList Sheet
This sheet maps the custom attribute interface to the appropriate class.
ClassName
Identifies the class name for the attribute interface.
InterfaceName
Specifies the interface name mapped to the class name. The InterfaceName should match
with the specified name on the CustomInterfaces sheet.

 For more information on reference data workbooks, refer to the Reference Data Guide.
 All files must be located in the SharedContent folder for bulkloading to be successful.
 For information on creating custom drawing properties for use in drawings, see Place a
Custom Drawing Property Label on a Template in the Orthographic Drawings User's Guide.

Drawings and Reports Reference Data Guide 326


Orthographic Drawings Reference Data

Drawings-ExtendCustomAttributes Workbook
The Drawings-ExtendCustomAttributes.xls workbook allows you to manage large amounts of
custom attributes. Each row you add in this workbook provides storage for approximately 25
extra custom properties in the DrawingCustomProperties.xls workbook. This workbook is
delivered in the product [Product Folder]\CatalogData\BulkLoad\AdditionalDataFiles folder.
The following example shows the CustomInterfaces sheet set up to use the
IJDwgUAHelperEx interface with OverrideExtension properties.

The left-most column (column A) of the sheet specifies the bulkload action taken with regard to
the row. For example, an A in the column indicates the drawing volume part class is being
added; the letter D specifies the class is deleted; the letter M indicates the class is modified. A !
symbol specifies that the row is ignored during bulkloading.

CustomInterfaces Sheet
This sheet defines the custom attribute.
InterfaceName
Specifies the name of the custom interface you are using to implement the custom attributes
against the DwgPropertyObject class. For more information, see the Intergraph SmartTM 3D
Programmer's Guide.
CategoryName
Not used at this time.
AttributeName
Identifies the programmatic name of the attribute.
AttributeUserName
Identifies the user name for the attribute.

 The AttributeUserName must be unique for each user name entry. For example, Title1
cannot be used because it is a delivered AttributeUserName value. For a list of
delivered AttributeUserNames, see Title Area Tab and Signature Area Tab, available in
any of the Smart 3D Drawings user's guides accessible from the Help > Printable
Guides command in the software.
 For any integrated SmartPlant Enterprise application, the delivered AttributeUserName
values cannot be edited.
Type
Specifies the type of attribute. For example, char for character.

Drawings and Reports Reference Data Guide 327


Orthographic Drawings Reference Data

UnitsType
Specifies the unit type for the attribute.
PrimaryUnits
Identifies the primary unit for the attribute
CodeList
Specifies the name of the table that contains the codelisted values for this attribute. If the
cell is empty, the codelist is Null and ignored by the software.
OnPropertyPage
Specifies whether this attribute is displayed by the attribute control. Value is True if the
attribute is displayed on a control and False if not.
codelisttablenamespace
Identifies the table name space for the codelist if needed.
ReadOnly
Specifies whether the attribute can be modified by the attribute control. Value is True if the
attribute can be modified and False if not.
SymbolParameter
Identifies the symbol parameter used for the attribute if needed.

CustomClassInterfaceList Sheet
This sheet maps the custom attribute interface to the appropriate class.
ClassName
Identifies the class name for the attribute interface.
InterfaceName
Specifies the interface name mapped to the class name. The InterfaceName should match
with the specified name on the CustomInterfaces sheet.

 For more information on reference data workbooks, refer to the Reference Data Guide.
 All files must be located in the SharedContent folder for bulkloading to be successful.

DrawingIssueReason_Codelist Workbook
The DrawingIssueReason_Codelist.xls workbook defines values for the Issue Reason
property on the Issue tab of the Properties dialog box. The workbook is delivered in the
[Product Folder]\CatalogData\Bulkload\AdditionalDataFiles folder.
DrawingIssueReason ShortDescription
Specifies a short description of the Issue Reason value. The maximum length is 256
characters.
DrawingIssueReason LongDescription
Specifies a long description of the Issue Reason value. The maximum length is 256

Drawings and Reports Reference Data Guide 328


Orthographic Drawings Reference Data

characters.
CodeList Number
Specifies a unique number to identify the value. The number only needs to be unique within
the attribute category (that is, within the worksheet).
Sort Order
Specifies the order in which the codelist values display in the software. If left blank, the order
on the worksheet is used.
If you are bulkloading to an existing catalog database, you must mark A in column A
for each value. The values are then available for selection in the Properties dialog box.

Drawings and Reports Reference Data Guide 329


Orthographic Drawings Reference Data

Orthographic Drawing Packages


Packages contain definition information for one or more components, plus template and style
definitions. You can create new packages or modify existing packages. Drawing documents are
not saved as part of the package. When you save a package using the Save Package
command in the Drawings and Reports task, you specify where it is saved. You can save the
package on a single drawing, an entire folder, or even the entire root. You can also create your
own tab when you save your packages. The tab displays in the Add Component dialog box of
the New command.
Packages are saved in the [Reference Data Folder]\SharedContent\Drawings\Catalog\Packages
folder. A sub-folder exists for each type of delivered package. When you use the New command
to add a package to the Management Console, each tab of the Add Component dialog box
represents a sub-folder showing the available packages for each drawing type. For example,
you find electrical packages on the Electrical tab.
For more information on adding drawing components to the Management Console, see the
Orthographic Drawings User's Guide.

Topics
Electrical Packages ....................................................................... 330
Equipment Packages ..................................................................... 342
HVAC Packages ............................................................................ 347
Instrument Packages ..................................................................... 352
Isometrics (by Query) Packages ................................................... 357
Orthographic (by Query) Packages ............................................... 358
Piping Packages ............................................................................ 361
Structural Framing Packages ........................................................ 366

Electrical Packages
Topics
Electrical CableTray Drawings Package ....................................... 331
Electrical CableTray Elevation Package ........................................ 331
Electrical CableTray Isometric Package ........................................ 332
Electrical CableTray Layout Plan Package ................................... 333
Electrical CableTray Overall Key Plan Package ............................ 334
Electrical CableTray Plan Package ............................................... 335
Electrical Equipment Drawings Package ....................................... 336
Electrical Equipment Elevation Package ....................................... 336
Electrical Equipment Isometric Package ....................................... 337
Electrical Equipment Overall Key Plan Package ........................... 338
Electrical Equipment Plan Package ............................................... 339
Electrical Instrument Plan Package ............................................... 340
Electrical Lighting Plan Package ................................................... 341

Drawings and Reports Reference Data Guide 330


Orthographic Drawings Reference Data

Electrical CableTray Drawings Package


The Electrical CableTray Drawings package creates a folder that contains the Electrical
CableTray Elevation, Electrical CableTray Isometric, Electrical CableTray Overall Key
Plan, and Electrical CableTray Plan Volume Drawing components.
Electrical CableTray Elevation Package (on page 331)
Electrical CableTray Isometric Package (on page 332)
Electrical CableTray Overall Key Plan Package (on page 334)
Electrical CableTray Plan Package (on page 335)
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Electrical CableTray Elevation Package


Name: Electrical CableTray Elevation
Description: The Electrical CableTray Elevation package creates a Volume Drawing
component that uses the Electrical CableTray Elevation view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Electrical CableTray Elevation\Electrical CableTray
Elevation\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Electrical CableTray Elevation View Style (on page 398)
Orientation: Looking North
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 331


Orthographic Drawings Reference Data

Electrical CableTray Isometric Package


Name: Electrical CableTray Isometric
Description: The Electrical CableTray Isometric package creates a Volume Drawing
component that uses the Electrical CableTray Isometric view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Electrical CableTray Isometric\Electrical CableTray
Isometric\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Electrical CableTray Isometric View Style (on page 409)
Orientation: Looking Northeast (ISO)
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 332


Orthographic Drawings Reference Data

Electrical CableTray Layout Plan Package


Name: Electrical CableTray Layout Plan
Description: The Electrical CableTray Layout Plan package creates a Volume Drawing
component that uses the Electrical CableTray Layout Plan view style and also includes a key
plan drawing on the right-hand side of the sheet.
Sheet Size: A1 Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Electrical CableTray Layout Plan\Electrical CableTray Layout
Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Electrical CableTray Layout Plan View Style
Orientation: Looking Plan
Scale: 3/8" = 1'0"
Convert report output to text boxes (no Excel): No

Key Plan View


View Style: Electrical CableTray Key Plan View Style (on page 416)
Orientation: Defined by Key Plan Style
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 333


Orthographic Drawings Reference Data

Electrical CableTray Overall Key Plan Package


Name: Electrical CableTray Overall Key Plan
Description: The Electrical CableTray Overall Key Plan package creates a Volume Drawing
component that uses the Electrical CableTray Overall Key Plan view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Electrical CableTray Overall Key Plan\Electrical CableTray
Overall Key Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Electrical CableTray Overall Key Plan View Style (on page 417)
Orientation: Looking Plan
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 334


Orthographic Drawings Reference Data

Electrical CableTray Plan Package


Name: Electrical CableTray Plan
Description: The Electrical CableTray Plan package creates a Volume Drawing component that
uses the Electrical CableTray Plan view style and also includes a key plan drawing on the
right-hand side of the sheet.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Electrical CableTray Plan\Electrical CableTray
Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Electrical CableTray Plan View Style (on page 420)
Orientation: Looking Plan
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Key Plan View


View Style: Electrical CableTray Key Plan View Style (on page 416)
Orientation: Defined by Key Plan Style
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 335


Orthographic Drawings Reference Data

Electrical Equipment Drawings Package


The Electrical Equipment Drawings package creates a folder that contains the Electrical
Equipment Elevation, Electrical Equipment Isometric, Electrical Equipment Overall Key
Plan, and Electrical Equipment Plan Volume Drawing components.
Electrical Equipment Elevation Package (on page 336)
Electrical Equipment Isometric Package (on page 337)
Electrical Equipment Overall Key Plan Package (on page 338)
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Electrical Equipment Elevation Package


Name: Electrical Equipment Elevation
Description: The Electrical Equipment Elevation package creates a Volume Drawing
component that uses the Electrical Equipment Elevation view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Electrical Equipment Elevation\Electrical Equipment
Elevation\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Electrical Equipment Elevation View Style (on page 431)
Orientation: Looking North
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 336


Orthographic Drawings Reference Data

Electrical Equipment Isometric Package


Name: Electrical Equipment Isometric
Description: The Electrical Equipment Isometric package creates a Volume Drawing
component that uses the Electrical Equipment Isometric view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Electrical Equipment Isometric\Electrical Equipment
Isometric\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Electrical Equipment Isometric View Style (on page 435)
Orientation: Looking Northeast (ISO)
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 337


Orthographic Drawings Reference Data

Electrical Equipment Overall Key Plan Package


Name: Electrical Equipment Overall Key Plan
Description: The Electrical Equipment Overall Key Plan package creates a Volume Drawing
component that uses the Electrical Equipment Overall Key Plan view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Electrical Equipment Overall Key Plan\Electrical Equipment
Overall Key Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\CatalogData\Symbols\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Electrical Equipment Overall Key Plan View Style (on page 438)
Orientation: Looking Plan
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 338


Orthographic Drawings Reference Data

Electrical Equipment Plan Package


Name: Electrical Equipment Plan
Description: The Electrical Equipment Plan package creates a Volume Drawing component
that uses the Electrical Equipment Plan view style and also includes a key plan drawing on the
right-hand side of the sheet.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Electrical Equipment Plan\Electrical Equipment
Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Electrical Equipment Plan View Style (on page 440)
Orientation: Looking Plan
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Key Plan View


View Style: Electrical Equipment Key Plan View Style (on page 437)
Orientation: Defined by Key Plan Style
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 339


Orthographic Drawings Reference Data

Electrical Instrument Plan Package


Name: Electrical Instrument Plan
Description: The Electrical Instrument Plan package creates a Volume Drawing component
that uses the Electrical Instrument Plan view style and also includes a key plan drawing on the
right-hand side of the sheet.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Electrical Instrument Plan\Electrical Instrument
Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Electrical Instrument Plan View Style (on page 444)
Orientation: Looking Plan
Scale: 3/8" = 1'0"
Convert report output to text boxes (no Excel): No

Key Plan View


View Style: Instrument Key Plan View Style (on page 540)
Orientation: Defined by Key Plan Style
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 340


Orthographic Drawings Reference Data

Electrical Lighting Plan Package


Name: Electrical Lighting Plan
Description: The Electrical Lighting Plan package creates a Volume Drawing component that
uses the Electrical Lighting Plan view style and also includes a key plan drawing on the
right-hand side of the sheet.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Electrical Lighting Plan\Electrical Lighting Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Electrical Lighting Plan View Style (on page 453)
Orientation: Looking Plan
Scale: 3/8" = 1'0"
Convert report output to text boxes (no Excel): No

Key Plan View


View Style: Electrical CableTray Key Plan View Style (on page 416)
Orientation: Defined by Key Plan Style
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 341


Orthographic Drawings Reference Data

Equipment Packages
Topics
Equipment Drawings Package ....................................................... 342
Equipment Elevation Package ....................................................... 343
Equipment Isometric Package ....................................................... 344
Equipment Overall Key Plan Package ........................................... 345
Equipment Plan Package .............................................................. 346

Equipment Drawings Package


The Equipment Drawings package creates a folder that contains the Equipment Elevation,
Equipment Isometric, Equipment Overall Key Plan, and Equipment Plan Volume Drawing
components.
Equipment Elevation Package (on page 343)
Equipment Isometric Package (on page 344)
Equipment Overall Key Plan Package (on page 345)
Equipment Plan Package (on page 346)
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Drawings and Reports Reference Data Guide 342


Orthographic Drawings Reference Data

Equipment Elevation Package


Name: Equipment Elevation
Description: The Equipment Elevation package creates a Volume Drawing component that
uses the Equipment Elevation view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Equipment Elevation\Equipment Elevation\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Equipment Elevation View Style (on page 460)
Orientation: Looking North
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 343


Orthographic Drawings Reference Data

Equipment Isometric Package


Name: Equipment Isometric
Description: The Equipment Isometric package creates a Volume Drawing component that
uses the Equipment Isometric view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Equipment Isometric\Equipment Isometric\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Equipment Isometric View Style (on page 468)
Orientation: Looking Northeast (ISO)
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 344


Orthographic Drawings Reference Data

Equipment Overall Key Plan Package


Name: Equipment Overall Key Plan
Description: The Equipment Overall Key Plan package creates a Volume Drawing that uses
the Equipment Overall Key Plan view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Equipment Overall Key Plan\Equipment Overall Key
Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Equipment Overall Key Plan View Style (on page 474)
Orientation: Looking Plan
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 345


Orthographic Drawings Reference Data

Equipment Plan Package


Name: Equipment Plan
Description: The Equipment Plan package creates a Volume Drawing that uses the Equipment
Plan view style and also places a key plan drawing on the right-hand side of the sheet.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Equipment Plan\Equipment Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Equipment Plan View Style (on page 477)
Orientation: Looking Plan
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Key Plan View


View Style: Equipment Key Plan View Style (on page 473)
Orientation: Defined by Key Plan Style
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 346


Orthographic Drawings Reference Data

HVAC Packages
Topics
HVAC Drawings Package .............................................................. 347
HVAC Elevation Package .............................................................. 348
HVAC Isometric Package .............................................................. 349
HVAC Overall Key Plan Package .................................................. 350
HVAC Plan Package ...................................................................... 351

HVAC Drawings Package


The HVAC Drawings package creates a folder that contains the HVAC Elevation, HVAC
Isometric, HVAC Overall Key Plan, and HVAC Plan Volume Drawing components.
HVAC Elevation Package (on page 348)
HVAC Isometric Package (on page 349)
HVAC Overall Key Plan Package (on page 350)
HVAC Plan Package (on page 351)
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Drawings and Reports Reference Data Guide 347


Orthographic Drawings Reference Data

HVAC Elevation Package


Name: HVAC Elevation
Description: The HVAC Elevation package creates a Volume Drawing that uses the HVAC
Elevation view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\HVAC Elevation\HVAC Elevation\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: HVAC Elevation View Style (on page 498)
Orientation: Looking North
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 348


Orthographic Drawings Reference Data

HVAC Isometric Package


Name: HVAC Isometric
Description: The HVAC Isometric package creates a Volume Drawing that uses the HVAC
Isometric view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\HVAC Isometric\HVAC Isometric\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: HVAC Isometric View Style (on page 500)
Orientation: Looking Northeast (ISO)
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 349


Orthographic Drawings Reference Data

HVAC Overall Key Plan Package


Name: HVAC Overall Key Plan
Description: The HVAC Overall Key Plan package creates a Volume Drawing that uses the
HVAC Overall Key Plan view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\HVAC Overall Key Plan\HVAC Overall Key Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: HVAC Overall Key Plan View Style (on page 502)
Orientation: Looking Plan
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 350


Orthographic Drawings Reference Data

HVAC Plan Package


Name: HVAC Plan
Description: The HVAC Plan package creates a Volume Drawing that uses the HVAC Plan
view style and also includes a key plan drawing on the right-hand side of the sheet.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\HVAC Plan\HVAC Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: HVAC Plan View Style (on page 505)
Orientation: Looking Plan
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Key Plan View


View Style: HVAC Key Plan View Style (on page 501)
Orientation: Defined by Key Plan Style
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 351


Orthographic Drawings Reference Data

Instrument Packages
Topics
Instrument Drawings Package ....................................................... 352
Instrument Elevation Package ....................................................... 353
Instrument Isometric Package ....................................................... 354
Instrument Overall Key Plan Package ........................................... 355
Instrument Plan Package ............................................................... 356

Instrument Drawings Package


The Instrument Drawings package creates a folder that contains the Instrument Elevation,
Instrument Isometric, Instrument Overall Key Plan, and Instrument Plan Volume Drawing
components.
Instrument Elevation Package (on page 353)
Instrument Isometric Package (on page 354)
Instrument Overall Key Plan Package (on page 355)
Instrument Plan Package (on page 356)
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Drawings and Reports Reference Data Guide 352


Orthographic Drawings Reference Data

Instrument Elevation Package


Name: Instrument Elevation
Description: The Instrument Elevation package creates a Volume Drawing that uses the
Instrument Elevation view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Instrument Elevation\Instrument Elevation\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\CatalogData\Symbols\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Instrument Elevation View Style (on page 517)
Orientation: Looking North
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 353


Orthographic Drawings Reference Data

Instrument Isometric Package


Name: Instrument Isometric
Description: The Instrument Isometric package creates a Volume Drawing that uses the
Instrument Isometric view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Instrument Isometric\Instrument Isometric\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Instrument Isometric View Style (on page 534)
Orientation: Looking Northeast (ISO)
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 354


Orthographic Drawings Reference Data

Instrument Overall Key Plan Package


Name: Instrument Overall Key Plan
Description: The Instrument Overall Key Plan package creates a Volume Drawing that uses the
Instrument Overall Key Plan view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Instrument Overall Key Plan\Instrument Overall Key
Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Instrument Overall Key Plan View Style (on page 541)
Orientation: Looking Plan
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 355


Orthographic Drawings Reference Data

Instrument Plan Package


Name: Instrument Plan
Description: The Instrument Plan package creates a Volume Drawing that uses the Instrument
Plan view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Instrument Plan\Instrument Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Instrument Plan View Style (on page 545)
Orientation: Looking Plan
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Key Plan View


View Style: Instrument Key Plan View Style (on page 540)
Orientation: Defined by Key Plan Style
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 356


Orthographic Drawings Reference Data

Isometrics (by Query) Packages


Topics
Iso PenSpool Package .................................................................. 357
Iso Pipeline Package ..................................................................... 357
Iso Pipeline Manager Package ...................................................... 357
Iso Spool Package ......................................................................... 357
Iso Spool Manager Package.......................................................... 357
Iso Stress Package ........................................................................ 358

Iso PenSpool Package


The Iso PenSpool drawing package creates an Isogen Isometrics Drawings by Query
component that is pre-configured to use the Piping Penetration Spools filter and the
Iso_Penspool style. For more information on using Isogen Isometrics Drawings by Query
components, see the Smart 3D Isogen Isometric Drawings User's Guide.

Iso Pipeline Package


The Iso Pipeline drawing package creates an Isogen Isometrics Drawings by Query
component that is pre-configured to use the Pipelines filter and the Iso_Pipeline style. For
more information on using Isogen Isometrics Drawings by Query components, see the Smart 3D
Isogen Isometric Drawings User's Guide.

Iso Pipeline Manager Package


The Iso Pipeline Manager drawing package creates a Drawings by Query Manager
component that is pre-configured to use the Iso_Pipeline style. For more information on using
Isogen Isometric Drawings by Query components, see the Smart 3D Isogen Isometric Drawings
User's Guide.

Iso Spool Package


The Iso Spool drawing package creates an Isogen Isometrics Drawings by Query
component that is pre-configured to use the Piping Spools filter and the Iso_Spool style. For
more information on using Isogen Isometrics Drawings by Query components, see the Smart 3D
Isogen Isometric Drawings User's Guide.

Iso Spool Manager Package


The Iso Spool Manager drawing package creates a Drawing by Query Manager component
that is pre-configured to use the Iso_Spool style. For more information on using Isogen
Isometric Drawings by Query components, see the Smart 3D Isogen Isometric Drawings User's
Guide.

Drawings and Reports Reference Data Guide 357


Orthographic Drawings Reference Data

Iso Stress Package


The Iso Stress drawing package creates an Isogen Isometrics Drawings by Query
component that is pre-configured to use the Pipelines filter and the Iso_Stress style. For more
information on using Isogen Isometrics Drawings by Query components, see the Smart 3D
Isogen Isometric Drawings User's Guide.

Orthographic (by Query) Packages


Topics
HngSup3View Package ................................................................. 358
Pipe Support Drawings Package ................................................... 359

HngSup3View Package
Name: HngSup3View
Description: The HngSup3View package creates an Orthographic Drawings by Query
component that includes three views that use different looking directions. The package also
includes a location key plan view and a CAD Details view.
Sheet Size: C Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\HngSup3View\HngSup3View\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Elevation (Left)
View Style: HngSup - End View Style (on page 489)
Use object coordinate system: Yes
Orientation: Looking North
Scale: No Scale
Navigation Rule: HngSupRangeNavigator.dll
Convert report output to text boxes (no Excel): No

Elevation (Center)
View Style: HngSup - Side View Style (on page 494)
Use object coordinate system: Yes
Orientation: Looking East
Scale: No Scale
Navigation Rule: HngSupRangeNavigator.dll
Convert report output to text boxes (no Excel): No

Isometric Looking Northeast View


View Style: HngSup - ISO View Style (on page 493)
Use object coordinate system: No
Orientation: Looking Northeast (ISO)
Scale: No Scale

Drawings and Reports Reference Data Guide 358


Orthographic Drawings Reference Data

Navigation Rule: HngSupNoSupportingRangeNav.dll


Convert report output to text boxes (no Excel): No

CAD Details
View Style: HngSup - Cad Details View Style (on page 489)
Use object coordinate system: No
Orientation: Looking Plan
Scale: No Scale
Navigation Rule: HngSupSimpleNavigator.dll
Convert report output to text boxes (no Excel): No

Key Plan
View Style: HngSup - Key Plan View Style (on page 494)
Use object coordinate system: No
Orientation: Looking Plan
Scale: No Scale
Navigation Rule: HngSupSimpleNavigator.dll
Convert report output to text boxes (no Excel): No

Template Example

Pipe Support Drawings Package


Name: Pipe Support Drawings
Description: The Pipe Support Drawings package creates an Orthographic Drawings by Query
component that includes three views that use different angle directions.
Sheet Size: C Wide
Number of Sheets: 1
Notes Area Location: Top portion
Template Location: Packages\PIPE SUPPORT DRAWINGS\Pipe Support
Drawings\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Drawings and Reports Reference Data Guide 359


Orthographic Drawings Reference Data

Elevation Looking South View


View Style: Pipe Supports - Structure View Style (on page 565)
Use object coordinate system: Yes
Orientation: Looking South
Scale: No Scale
Navigation Rule: None
Convert report output to text boxes (no Excel): No

Elevation Looking East View


View Style: Pipe Supports - Piping View Style (on page 564)
Use object coordinate system: Yes
Orientation: Looking East
Scale: No Scale
Navigation Rule: None
Convert report output to text boxes (no Excel): No

Isometric Looking Northeast View


View Style: Pipe Supports - Components View Style (on page 564)
Use object coordinate system: Yes
Orientation: Looking Northeast (ISO)
Scale: No Scale
Navigation Rule: None
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 360


Orthographic Drawings Reference Data

Piping Packages
Topics
Piping Drawings Package .............................................................. 361
Piping Elevation Package .............................................................. 362
Piping Isometric Package .............................................................. 363
Piping Overall Key Plan Package .................................................. 364
Piping Plan Package ...................................................................... 365

Piping Drawings Package


The Piping Drawings package creates a folder that contains the Piping Elevation, Piping
Isometric, Piping Overall Key Plan, and Piping Plan Volume Drawing components.
Piping Elevation Package (on page 362)
Piping Isometric Package (on page 363)
Piping Overall Key Plan Package (on page 364)
Piping Plan Package (on page 365)
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Drawings and Reports Reference Data Guide 361


Orthographic Drawings Reference Data

Piping Elevation Package


Name: Piping Elevation
Description: The Piping Elevation package creates a Volume Drawing that uses the Piping
Elevation view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Piping Elevation\Piping Elevation\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Piping Elevation View Style (on page 566)
Orientation: Looking North
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 362


Orthographic Drawings Reference Data

Piping Isometric Package


Name: Piping Isometric
Description: The Piping Isometric package creates a Volume Drawing that uses the Piping
Isometric view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Piping Isometric\Piping Isometric\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Piping Isometric View Style (on page 579)
Orientation: Looking Northeast (ISO)
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 363


Orthographic Drawings Reference Data

Piping Overall Key Plan Package


Name: Piping Overall Key Plan
Description: The Piping Overall Key Plan package creates a Volume Drawing that uses the
Piping Overall Key Plan view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Piping Overall Key Plan\Piping Overall Key Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Piping Overall Key Plan View Style (on page 588)
Orientation: Looking Plan
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 364


Orthographic Drawings Reference Data

Piping Plan Package


Name: Piping Plan
Description: The Piping Plan package creates a Volume Drawing component that uses the
Piping Plan view style and includes a key plan drawing on the right-hand side of the sheet.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Piping Plan\Piping Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Piping Plan View Style (on page 591)
Orientation: Looking Plan
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Key Plan View


View Style: Piping Key Plan View Style (on page 587)
Orientation: Defined by Key Plan Style
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 365


Orthographic Drawings Reference Data

Structural Framing Packages


Topics
Structural Drawings Package ........................................................ 366
Structural Framing Elevation Package .......................................... 367
Structural Framing Isometric Package .......................................... 368
Structural Framing Plan Package .................................................. 369

Structural Drawings Package


The Imperial_Structural Drawings package creates a folder that contains the Structural
Framing Elevation, Structural Framing Isometric, and Structural Framing Plan Volume
Drawing components.
Structural Framing Elevation Package (on page 367)
Structural Framing Isometric Package (on page 368)
Structural Framing Plan Package (on page 369)
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Drawings and Reports Reference Data Guide 366


Orthographic Drawings Reference Data

Structural Framing Elevation Package


Name: Structural Framing Elevation
Description: The Structural Framing Elevation package creates a Volume Drawing component
that uses the Structural Framing Elevation view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Structural Framing Elevation\Structural Framing
Elevation\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Structural Framing Elevation View Style (on page 611)
Orientation: Looking North
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 367


Orthographic Drawings Reference Data

Structural Framing Isometric Package


Name: Structural Framing Isometric
Description: The Structural Framing Isometric package creates a Volume Drawing component
that uses the Structural Framing Isometric view style.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Structural Framing Isometric\Structural Framing
Isometric\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Structural Framing Isometric View Style (on page 621)
Orientation: Looking Northeast (ISO)
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 368


Orthographic Drawings Reference Data

Structural Framing Plan Package


Name: Structural Framing Plan
Description: The Structural Framing Plan package creates a Volume Drawing component that
uses the Structural Framing Plan view style and also includes a key plan drawing on the
right-hand side of the sheet.
Sheet Size: D Wide
Number of Sheets: 1
Notes Area Location: Upper right-hand corner
Template Location: Packages\Structural Framing Plan\Structural Framing Plan\template.sha
Package files are stored on the SharedContent share in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Packages folder.

Main Drawing View


View Style: Structural Framing Plan View Styles (on page 623)
Orientation: Looking Plan
Scale: 1/4" = 1'0"
Convert report output to text boxes (no Excel): No

Key Plan View


View Style: Structural Framing Key Plan View Style (on page 622)
Orientation: Defined by Key Plan Style
Scale: No Scale
Convert report output to text boxes (no Excel): No

Template Example

Drawings and Reports Reference Data Guide 369


Orthographic Drawings Reference Data

Orthographic and Key Plan View Styles


Drawing view styles define how objects are resymbolized within drawing and key plan views in
drawing documents. The view styles determine what objects are included and how they display
in the drawing. In orthographic drawings, as with composed drawings or orthographic drawings
by query, you can define both orthographic view styles and key plan view styles.
 Orthographic view styles are in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\Orthographic folder.
 Key plan view styles are in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\KeyPlan folder.
 Spatial view styles are in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\Spatial folder.
The delivered view styles delivered are specific to each type of drawing. For example, you would
use the Electrical Equipment Plan view style to create electrical equipment drawings.
Similarly, if you use the Electrical Equipment Key Plan view style, you are setting the output
style for an electrical equipment key plan within your drawing document.
Graphic representation, labels, and dimensions are defined in each view style.
The delivered XML rule files are located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules folder.
 The View Style XML files are located in the Orthographic folder. Orthographic view styles
for marine mode drawings are saved to the Spatial folder.
 The Graphic Rule XML files are located in the GraphicRules folder.
 The Label Rule XML files are located in the LabelRules folder.
 The Dimension Rule XML files are located in the DimensionRules folder.
You use Tools > Define View Style in the Drawings and Reports task to manage
and create view styles. For more information, see Define View Style Command (Tools Menu)
(on page 56).

Topics
Drawing View Style Creation Process ........................................... 371
Key Plan View Styles ..................................................................... 373
Civil View Styles ............................................................................ 375
Electrical View Styles ..................................................................... 398
Equipment View Styles .................................................................. 459
HngSup View Styles ...................................................................... 489
HVAC View Styles ......................................................................... 498
Instrument View Styles .................................................................. 517
Nozzle View Styles ........................................................................ 560
Pipe Supports View Styles ............................................................. 564
Piping View Styles ......................................................................... 566

Drawings and Reports Reference Data Guide 370


Orthographic Drawings Reference Data

Drawing View Style Creation Process


View Styles produce different results based on the filters and rules that are included. The filters
that are used, and the order they are used in, determine the output of the drawing view.
Below is an example of how a drawing view is created from the view style. In this example, the
Piping Plan view style illustrates the drawing creation process.
The last row in the view style takes precedence.
The delivered view styles match the logical order found in the Select Filter object hierarchy.
From first to last, the view style rows follow the same hierarchy. For example, Piping Parts
precedes Pipes in the object filter hierarchy. Therefore, the view style includes the Piping Parts
filters before the Pipes filters because of the object hierarchy.
If a child filter is placed above a parent filter, the child filter is overwritten in the drawing. The
filters must follow the same logical order as the object filter hierarchy.
The following graphic compares the object hierarchy in the Select Filter dialog box to the
Filters in the View Style Properties dialog box.

 When inserting filters in the view style, be sure they match the order of the objects in the
Select Filter dialog box. For example, be sure to place Pipes filters under any existing
Piping Parts filters.

Drawings and Reports Reference Data Guide 371


Orthographic Drawings Reference Data

Examples
The following example is the default Piping Plan view style. The highlighted piping segment has
a 2-inch diameter.

The following example is a modified Piping Plan view style. A row has been inserted beneath
the original Piping filters to resymbolize all pipes equal to or less than 2 inches as a single line.

Drawings and Reports Reference Data Guide 372


Orthographic Drawings Reference Data

The following example shows the order of the Piping filters in the modified view style. The filter
that resymbolizes all pipes that are less than or equal to 2 inches is last because it is further
down in the hierarchy.

See Also
Orthographic and Key Plan View Styles (on page 370) in the Drawings and Reports Reference
Create an Orthographic Drawing View Style (on page 87) in the Drawings and Reports
Reference

Key Plan View Styles


Key plan view styles are used to place key plan views on orthographic drawings. These
drawings show nearby and adjacent volumes in relation to the main view in the drawing, which
is also known as the focus element.
The key plan view style XML files are delivered in the SharedContent share [Reference Data
Product Folder]\SharedContent\Drawings\Catalog\Rules\KeyPlan folder.
There are several requirements for key plan drawings to function properly. For a list of
these requirements, see Key Plan Drawing Requirements (on page 375).

Civil Key Plan


Refers to the orthographic Civil Key Plan view style. For more information, see Civil Key Plan
View Style (on page 383).

Drawings and Reports Reference Data Guide 373


Orthographic Drawings Reference Data

Default
The default key plan view style displays the focus element with a thick line style and displays the
surrounding adjacent elements with a normal view style. The focus element is labeled with the
volume name from the model. See the following graphic for an example.

Electrical Cable Tray Key Plan


Refers to the orthographic Electrical Cable Tray Key Plan view style. For more information, see
Electrical CableTray Key Plan View Style (on page 416).

Electrical Equipment Key Plan


Refers to the orthographic Electrical Equipment Key Plan view style. For more information, see
Electrical Equipment Key Plan View Style (on page 437).

HVAC Key Plan


Refers to the orthographic HVAC Key Plan view style. For more information, see HVAC Key
Plan View Style (on page 501).

Instrument Key Plan


Refers to the orthographic Instrument Key Plan view style. For more information, see Instrument
Key Plan View Style (on page 540).

Piping Isometric Key


Refers to the orthographic Piping Isometric Key view style. For more information, see Piping
Isometric Key View Style (on page 586).

Piping Key Plan


Refers to the orthographic Piping Key Plan view style. For more information, see Piping Key
Plan View Style (on page 587).

Drawings and Reports Reference Data Guide 374


Orthographic Drawings Reference Data

Structural Key Plan


Refers to the orthographic Structural Framing Key Plan view style. For more information, see
Structural Framing Key Plan View Style (on page 622).
See Also
Orthographic and Key Plan View Styles (on page 370)

Key Plan Drawing Requirements


The list below describes the requirements for the key plan drawing volumes to display
successfully.
 The volume must be associated to a view within the parent component node.
 The view style must be that of the parent view.
 The volumes in the key plan must be associated to graphic views of the same type. Graphic
view types include main views, detail views, section views, and snapshot views.
 The view direction must be along the same axis as the associated view.
 The Up direction for the view must be along the same axis or perpendicular to the
associated view's Up direction.
See Also
Create a Key Plan View Style (on page 88)
Key Plan Style Dialog Box (on page 140)

Civil View Styles


Topics
Civil Elevation View Style .............................................................. 375
Civil Isometric View Style ............................................................... 376
Civil Key Plan View Style ............................................................... 383
Civil Overall Key Plan View Style .................................................. 385
Civil Plan View Style ...................................................................... 390

Civil Elevation View Style


Name: Civil Elevation
Description: Drawing layout designed for elevation views that focuses on civil objects and
includes other objects that are important to the discipline. Draws trench parts and the centerlines
of trench features.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).

Drawings and Reports Reference Data Guide 375


Orthographic Drawings Reference Data

 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).
 The Civil Plan graphic preparation rule for this view style uses the Make Drawable Simple
(on page 1006) custom graphic module for labeling of trench features and the Trench Parts
Ports (on page 1040) custom graphic module to draw accurate trench part geometry.
 To prevent duplicate geometry, the Civil Plan_Trenches graphic rule uses the Centerline
aspect (with Show aspect selected), but does not use the Simple Physical aspect (with
Show aspect cleared). For more information, see Graphic Rule - VHL Dialog Box (on page
71).

Filter Orientation Clipping Graphic Rule Label Rule Dimension


Rule

Trench Feature Civil Civil_TrenchFeature.xml


Elevation_Trenches.xml

Trench Parts Civil


Elevation_TrenchParts.xml

Civil Isometric View Style


Name: Civil Isometric
Description: Drawing layout designed for isometric views that focuses on Civil objects and
includes other objects that are important to the discipline. Draws trench parts and the centerlines
of trench features.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).
 The Civil Plan graphic preparation rule for this view style uses the Make Drawable Simple
(on page 1006) custom graphic module for labeling of trench features and the Trench Parts
Ports (on page 1040) custom graphic module to draw accurate trench part geometry.
 To prevent duplicate geometry, the Civil Plan_Trenches graphic rule uses the Centerline
aspect (with Show aspect selected), but does not use the Simple Physical aspect (with
Show aspect cleared). For more information, see Graphic Rule - VHL Dialog Box (on page
71).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Civilc_Columns.xml Civil


Isometric_Equipment
_Name.xml

Control Point Civil_Control Point Civil

Drawings and Reports Reference Data Guide 376


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


Structure Structure.xml Isometric_Control
Point
Structure_North-East
Coordinate.xml

Pier and Slab Civil_Foundation.xml Civil


Footing Isometric_Equipment
_Name.xml

Footing Pier Civil_Foundation.xml Civil


Isometric_Equipment
_Name.xml

Beams Civil_Beams.xml

Hose Rack Civil_Reference.xml

Trench Civil_Reference.xml

Grid Line Civil_Grid Line.xml


Elevation 0

Block Civil_Foundation.xml
Foundation

Trench Feature Civil Isometric_ Civil_


Trenches.xml TrenchFeature.xml

Trench Parts Civil Isometric_


TrenchParts.xml

Drawings and Reports Reference Data Guide 377


Orthographic Drawings Reference Data

Example

Drawings and Reports Reference Data Guide 378


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a column in an isometric drawing.

Label Rule
Each column is labeled with the name from the model. The label is placed on the center of the
column.

Graphic Rule
This is an example of the graphic representation of a pier and slab footing in an isometric view.

Label Rule
Each pier and slab footing is labeled with a name label that reports the object name from the
model.

Drawings and Reports Reference Data Guide 379


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a footing pier in an isometric view.

Label Rule
Each footing pier is labeled in the center with a name label that reports the name of the object in
the model.

Graphic Rule
This is an example of the graphic representation of a beam in an isometric view.

Drawings and Reports Reference Data Guide 380


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a hose rack in an isometric view.

Graphic Rule
This is an example of the graphic representation of a control point with a coordinate label in a
plan drawing.

Drawings and Reports Reference Data Guide 381


Orthographic Drawings Reference Data

Label Rule
Control points are resymbolized and are labeled with a North-East coordinate label, which
indicates the position of the control point in the model.

Graphic Rule
The elevation grid lines are included in the view. The grid lines are represented as lines drawn
with the Double Chain line style.

Drawings and Reports Reference Data Guide 382


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of block foundations in isometric views.

Graphic Rule
This is an example of the graphic representation of a trench in an isometric view.

Civil Key Plan View Style


Name: Civil Key Plan
Description: Drawing layout designed to place a Key Plan view of all grid systems in the model
and identifies the particular volume displayed in the drawing.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None

Drawings and Reports Reference Data Guide 383


Orthographic Drawings Reference Data

Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Grid Civil_Reference.xml
Systems

KEY_PLAN_ Civil_Focus.xml Civil Key


FOCUS_ Plan_Focus_Name.xml
ELEMENT

KEY_PLAN_ Civil_Reference.xml
ADJACENT_
ELEMENT

Example

Drawings and Reports Reference Data Guide 384


Orthographic Drawings Reference Data

Civil Overall Key Plan View Style


Name: Civil Overall Key Plan
Description: Drawing layout designed for key plan views that focuses on volumes and
equipment and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: True
Intersection Edges: Off
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Beams Civil_Reference.xml

Braces Civil_Reference.xml

Columns Civil_Reference.xml

Equipment Civil_Equipment.xml

Slabs Civil_Reference.xml

Control Point Civil_Control Point.xml CtrlPtCoord_None_


Foundation CA.xml

Civil Plan Civil_Volumes.xml Civil Overall Key


Volumes Plan_Volume_Name
.xml

Drawings and Reports Reference Data Guide 385


Orthographic Drawings Reference Data

Example

Graphic Rule
This is an example of the graphic representation of a beam in a drawing.

Drawings and Reports Reference Data Guide 386


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of braces in a drawing.

Graphic Rule
This is an example of the graphic representation of a Column in a drawing.

Drawings and Reports Reference Data Guide 387


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of equipment in a plan drawing.

Graphic Rule
This is an example of the graphic representation of piping plan volumes in a drawing.

Label Rule
All drawing key plan volumes are labeled with their 3D model name. By default, the label is
placed in the upper left corner of the volume in the drawing. For an example, see the above
graphic.

Drawings and Reports Reference Data Guide 388


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of slabs in a drawing. The slab boundaries are
drawn with a gray line. Openings in the slab are also represented with a gray line.

Graphic Rule
This is an example of the graphic representation of a control point with a coordinate label in a
plan drawing.

Label Rule
Control points are resymbolized and are labeled with a North-East coordinate label, which
indicates the position in the model.

Drawings and Reports Reference Data Guide 389


Orthographic Drawings Reference Data

Civil Plan View Style


Name: Civil Plan
Description: Drawing layout designed for plan views that focuses on Civil objects and includes
other objects that are important to the discipline. Draws trench parts and the centerlines of
trench features.
Filter Behavior: Spatial
Preserve Z Order: True
Intersection Edges: Off
View Rule: Type1.xml
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).
 The Civil Plan graphic preparation rule for this view style uses the Make Drawable Simple
(on page 1006) custom graphic module for labeling of trench features and the Trench Parts
Ports (on page 1040) custom graphic module to draw accurate trench part geometry.
 To prevent duplicate geometry, the Civil Plan_Trenches graphic rule uses the Centerline
aspect (with Show aspect selected), but does not use the Simple Physical aspect (with
Show aspect cleared). For more information, see Graphic Rule - VHL Dialog Box (on page
71).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Civil_Columns.xml Civil


Plan_Columns_Anchor_
Horizontal.xml

Columns Civil_Columns.xml Civil


Plan_Columns_Anchor_
Vertical.xml

Columns Civil_Columns.xml Civil


Plan_Columns_Horizont
al.xml

Columns Civil_Columns.xml Civil


Plan_Columns_Vertical.
xml

Control Civil_Control Point.xml CtrlPtCoord_None_


Point CA.xml
Foundation

Footing Pier Civil_Foundation.xml Civil Civil


Plan_Equipment_Na Plan_Columns_Horizont
me.xml al.xml

Footing Pier Civil_Foundation.xml Civil

Drawings and Reports Reference Data Guide 390


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Plan_Columns_Vertical.
xml

Hose Rack Civil_Reference.xml

Trench Civil_Reference.xml

Grid Line Parallel, Civil_Grid Line.xml Civil Plan_Grid


vertical Line_X Name.xml

Grid Line Parallel, Civil_Grid Line.xml Civil Plan_Grid


horizontal Line_Y.xml

Block Civil_Foundation.xml
Foundation

Trench Civil Plan_Trenches.xml Civil_


Feature TrenchFeature.xml

Trench Civil
Parts Plan_TrenchParts.xml

Drawings and Reports Reference Data Guide 391


Orthographic Drawings Reference Data

Example

Graphic Rule
This is an example of the graphic representation of a hose rack in a plan drawing.

Drawings and Reports Reference Data Guide 392


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a trench in a plan drawing.

Graphic Rule
This is an example of the graphic representation of grid lines in a drawing.

Drawings and Reports Reference Data Guide 393


Orthographic Drawings Reference Data

Label Rule
Each grid line is labeled. Horizontal grid lines are labeled vertically, while vertical grid lines are
labeled horizontally. The label reports the name of the grids in the model.

X-axis grids Y-axis grids

Graphic Rule
This is an example of the graphic representation of an equipment foundation in a plan drawing.

Graphic Rule
This is an example of the graphic representation of a Column in a drawing.

Dimension Rule
Dimensions all vertical and horizontal columns. Columns are dimensioned as anchors, which
means they are only dimensioned when they are in close proximity to a group of dimensioned
objects. If a column is not close enough to a group of dimensioned objects in a particular
quadrant, it is not dimensioned. Also, if the column is inline with another column that is already
dimensioned, it is not dimensioned.
In the example below, notice how the top left column is not dimensioned because the bottom left
column is dimensioned. Also, the middle columns are not dimensioned because they line up
with the outer columns.

Drawings and Reports Reference Data Guide 394


Orthographic Drawings Reference Data

The left portion of this drawing has been cropped due to size constraints.

Drawings and Reports Reference Data Guide 395


Orthographic Drawings Reference Data

Footing Piers in Plan View Styles

Graphic Rule
This is an example of the graphic representation of a footing pier in a plan drawing.

Label Rule
Labeled with the name of the footing pier in the model. The label is placed on the center of the
footing pier.

Drawings and Reports Reference Data Guide 396


Orthographic Drawings Reference Data

Dimension Rule
Vertical and horizontal dimensions are placed on the footing pier. The footing pier is only
dimensioned with nearby columns. The point of dimensioning is the center of the footing pier.

 This image has been cropped due to size constraints.


 Only the horizontal dimension is displayed in the example above.

Drawings and Reports Reference Data Guide 397


Orthographic Drawings Reference Data

Electrical View Styles


Topics
Electrical CableTray Elevation View Style ..................................... 398
Electrical CableTray Isometric View Style ..................................... 409
Electrical CableTray Key Plan View Style ..................................... 416
Electrical CableTray Overall Key Plan View Style ......................... 417
Electrical CableTray Plan View Style............................................. 420
Electrical Equipment Elevation View Style .................................... 431
Electrical Equipment Isometric View Style .................................... 435
Electrical Equipment Key Plan View Style ..................................... 437
Electrical Equipment Overall Key Plan View Style ........................ 438
Electrical Equipment Plan View Style ............................................ 440
Electrical Instrument Plan View Style ............................................ 444
Electrical Lighting Plan View Style ................................................ 453
SM_Electrical_Cable_Tray_Plan View Style ................................. 455
SM_Electrical_Cable_Tray_Elevation View Style ......................... 457
SM_Lighting_Plan View Style ........................................................ 458

Electrical CableTray Elevation View Style


Name: Electrical CableTray Elevation
Description: Drawing layout designed for elevation views that focuses on electrical cabletray
objects and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Electrical Electrical CableTray


CableTray_Reference.xml Elevation_Columns_Ancho
r_Horizontal.xml

Columns Electrical Electrical CableTray


CableTray_Reference.xml Elevation_Columns_Horizo
ntal.xml

Electrical Electrical Electrical CableTray


Equipment CableTray_Equipment.xml Elevation_Equipment_Na
me.xml

Drawings and Reports Reference Data Guide 398


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Cableway Parts Electrical


CableTray_Cableways.xml

Cableway Parts Electrical Electrical CableTray


CableTray_Cableways.xml Elevation_LineNumber_L
ongest Segment.xml

Cableway Parts Clipped Electrical Electrical CableTray


CableTray_Cableways.xml Elevation_LineNumber_Cl
ipped.xml

Cable Trays Parallel Electrical Electrical CableTray


CableTray_Cableways.xml Elevation_Cable
Trays_Name-Elevation-W
idth.xml

Cable Trays Parallel, Electrical Electrical CableTray


horizontal CableTray_Cableways.xml Elevation_CableTray_Verti
cal.xml

Cable Trays Parallel, Electrical Electrical CableTray


vertical CableTray_Cableways.xml Elevation_CableTray_Hori
zontal.xml

Cable Trays Normal Electrical Electrical CableTray


CableTray_Cableways.xml Elevation_Horizontal.xml

Cable Trays Normal Electrical Electrical CableTray


CableTray_Cableways.xml Elevation_Vertical.xml

Grid Plane Electrical CableTray_Grid Electrical CableTray


Plane.xml Elevation_Grid
Plane_Name.xml

Grid Line Electrical CableTray_Grid Electrical CableTray Electrical CableTray


Line.xml Elevation_Grid Elevation_Grid
Line_TOS.xml Line_Anchor_Vertical.xml

Beams Electrical
CableTray_Reference.xml

Handrails Electrical_Handrail.xml

Stairs Electrical
CableTray_Stairs_Centerline.
xml

Ladders Electrical
CableTray_Ladders.xml

Process Electrical Electrical CableTray


Equipment CableTray_Equipment.xml Elevation_Equipment_Na
me.xml

Drawings and Reports Reference Data Guide 399


Orthographic Drawings Reference Data

Examples

Drawings and Reports Reference Data Guide 400


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a Column in an elevation drawing.

Drawings and Reports Reference Data Guide 401


Orthographic Drawings Reference Data

Dimension Rule
Horizontal dimensions are placed between each column. The dimensions are grouped with the
equipment dimensions that are in the same quadrant.

Graphic Rule
This is an example of the graphic representation of electrical equipment in an elevation view.

Label Rule
Each object is labeled with the corresponding name from the model. See the above graphic for
an example.

Drawings and Reports Reference Data Guide 402


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of cableway parts in an elevation view.

Label Rule
Each cableway part is labeled with the corresponding name from the model.

Drawings and Reports Reference Data Guide 403


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of cable trays in an elevation view.

Label Rule
Each cable tray is labeled with the corresponding name from the model. See the graphic above
for an example.

Dimension Rule
Horizontal cable trays are dimensioned with vertical dimensions, while vertical cable trays are
dimensioned with horizontal dimensions.

Drawings and Reports Reference Data Guide 404


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a grid plane in a drawing.

Label Rule
The y-axis of the grid plane is labeled with the name of the grid in the model. For example, see
the above graphic.

Graphic Rule
This is an example of the graphic representation of a handrail in an elevation drawing.

Drawings and Reports Reference Data Guide 405


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of grid lines in an elevation drawing.

Label Rule
All elevation grid lines are labeled with the grid name and elevation distance. For an example,
see the above graphic.

Dimension Rule
All elevation grid lines are dimensioned with other dimensioned objects in the drawing. The
elevation grid line dimensions are anchored and must be dimensioned with other objects, such
as pipes and columns.

Drawings and Reports Reference Data Guide 406


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a beam in an elevation drawing.

Graphic Rule
This is an example of the graphic representation of stairs in an elevation drawing.

Stairs that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Drawings and Reports Reference Data Guide 407


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a ladder in an elevation drawing.

Ladders that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Drawings and Reports Reference Data Guide 408


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of equipment in an elevation view.

Label Rule
Each equipment object is labeled with the corresponding name from the model. If there is not
enough white space inside of the equipment, the label is placed in nearby white space with a
jogged leader. For an example, see the above graphic.

Electrical CableTray Isometric View Style


Name: Electrical CableTray Isometric
Description: Drawing layout designed for isometric views that focuses on electrical cabletray
objects and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Cableway Parts Electrical


CableTray_Cableway.xml

Cable Trays Electrical Electrical CableTray


CableTray_Cableway.xml Isometric_Cable
Trays_Name-Elevation-Wi
dth.xml

Cable Tray Electrical CableTray_Cable Tray Electrical CableTray


Supports Supports.xml Isometric_Cable Tray
Supports_Name.xml

Columns Electrical

Drawings and Reports Reference Data Guide 409


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


CableTray_Reference.xml

Beams Electrical
CableTray_Reference.xml

Braces Electrical
CableTray_Reference.xml

Vertical Brace Electrical


CableTray_Reference.xml

Equipment Electrical
Foundation CableTray_Reference.xml

Footings Electrical CableTray_Footing.xml

Example

Drawings and Reports Reference Data Guide 410


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of cableways in an isometric view.

Graphic Rule
This is an example of the graphic representation of cable trays in an isometric view.

Drawings and Reports Reference Data Guide 411


Orthographic Drawings Reference Data

Label Rule
Each cable tray is labeled with the corresponding name from the model. For an example, see
the above graphic.

Graphic Rule
This is an example of the graphic representation of a cable tray support in an isometric view.

Label Rule
Each cable tray support is labeled with the corresponding name from the model.

Drawings and Reports Reference Data Guide 412


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of braces in an isometric view.

Graphic Rule
This is an example of the graphic representation of a column in an isometric drawing.

Label Rule
Each column is labeled with the name from the model. The label is placed on the center of the
column.

Drawings and Reports Reference Data Guide 413


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a beam in an isometric view.

Graphic Rule
This is an example of the graphic representation of equipment foundations in an isometric
drawing.

Drawings and Reports Reference Data Guide 414


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of footings in an isometric drawing.

Drawings and Reports Reference Data Guide 415


Orthographic Drawings Reference Data

Electrical CableTray Key Plan View Style


Name: Electrical CableTray Key Plan
Description: Drawing layout designed to place a Key Plan view of all grid systems in the model
and identifies the particular volume displayed in the drawing.
Filter Behavior: Spatial
Preserve Z Order: True
Intersection Edges: Off
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Grid Electrical
Systems CableTray_Reference.xml

KEY_PLAN_ Electrical Electrical CableTray Key


FOCUS_ CableTray_Focus.xml Plan_Focus_Name.xml
ELEMENT

KEY_PLAN_ Electrical
ADJACENT_ CableTray_Reference.xml
ELEMENT

Example

Drawings and Reports Reference Data Guide 416


Orthographic Drawings Reference Data

Electrical CableTray Overall Key Plan View Style


Name: Electrical CableTray Overall Key Plan
Description: Drawing layout designed for key plan views that focuses on volumes and
equipment and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Beams Parallel Electrical


CableTray_Reference.xml

Braces Parallel Electrical


CableTray_Reference.xml

Columns Electrical
CableTray_Reference.xml

Equipment Electrical
CableTray_Equipment.xml

Electrical Electrical Electrical CableTray Overall


CableTray Plan CableTray_Volumes.xml Key Plan_Volume_Name.xml
Volumes

Slabs Electrical
CableTray_Reference.xml

Control Point Electrical CtrlPtCoord_None_CA.xml


Mechanical CableTray_ControlPoint.xml
Equipment

Control Point Electrical CtrlPtCoord_None_CA.xml


Process Equipment CableTray_ControlPoint.xml

Drawings and Reports Reference Data Guide 417


Orthographic Drawings Reference Data

Example

Graphic Rule
This is an example of the graphic representation of braces in a drawing.

Drawings and Reports Reference Data Guide 418


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a Column in a drawing.

Graphic Rule
This is an example of the graphic representation of equipment in a plan drawing.

Graphic Rule
This is an example of the graphic representation of piping plan volumes in a drawing.

Drawings and Reports Reference Data Guide 419


Orthographic Drawings Reference Data

Label Rule
All drawing key plan volumes are labeled with their 3D model name. By default, the label is
placed in the upper left corner of the volume in the drawing. For an example, see the above
graphic.

Graphic Rule
This is an example of the graphic representation of slabs in a drawing. The slab boundaries are
drawn with a gray line. Openings in the slab are also represented with a gray line.

Electrical CableTray Plan View Style


Name: Electrical CableTray Plan
Description: Drawing layout designed for plan views that focuses on electrical cabletray objects
and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Electrical Electrical CableTray


CableTray_Reference.xml Plan_Columns_Anchor_
Vertical.xml

Columns Electrical Electrical CableTray


CableTray_Reference.xml Plan_Columns_Anchor_
Horizontal.xml

Drawings and Reports Reference Data Guide 420


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Electrical Electrical CableTray


CableTray_Reference.xml Plan_Columns_Vertical.
xml

Columns Electrical Electrical CableTray


CableTray_Reference.xml Plan_Columns_Horizont
al.xml

Beams Electrical
CableTray_Reference.xml

Cableway Electrical CableTray


Parts Plan_Cable Trays.xml

Cableway Electrical CableTray Electrical


Parts Plan_Cable Trays.xml CableTray
Plan_LineNumb
er_Longest
Segment.xml

Cableway Clipped Electrical CableTray Electrical


Parts Plan_Cable Trays.xml CableTray
Plan_LineNumb
er_Clipped.xml

Cable Trays Parallel Electrical CableTray Electrical


Plan_Cable Trays.xml CableTray
Plan_Cable
Trays_Name-Ele
vation-Width.xml

Cable Trays Parallel, Electrical CableTray Electrical CableTray


vertical Plan_Cable Trays.xml Plan_Cable
Trays_Horizontal.xml

Cable Trays Parallel, Electrical CableTray Electrical CableTray


horizontal Plan_Cable Trays.xml Plan_Cable
Trays_Vertical.xml

Cable Trays Normal Electrical CableTray Electrical CableTray


Plan_Cable Trays.xml Plan_Cable
Trays_Horizontal.xml

Cable Trays Normal Electrical CableTray Electrical CableTray


Plan_Cable Trays.xml Plan_Cable
Trays_Vertical.xml

Cable Tray Electrical CableTray_Cable Electrical


Supports Tray Supports.xml CableTray
Plan_Cable Tray
Supports_Name.
xml

Conduit Electrical
CableTray_Conduit.xml

Grid Line Parallel, Electrical CableTray_Grid Electrical


CableTray

Drawings and Reports Reference Data Guide 421


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


vertical Line.xml Plan_Grid
Line_X
Name.xml

Grid Line Parallel, Electrical CableTray_Grid Electrical


horizontal Line.xml CableTray
Plan_Grid
Line_Y
Name.xml

Process Electrical Electrical


Equipment CableTray_Reference.xml CableTray
Plan_Equipment
_Name.xml

Road Electrical Electrical


CableTray_Reference.xml CableTray
Plan_Road_Nam
e.xml

Cabling Electrical
CableTray_Cabling.xml

Foundation Electrical
Pedestal CableTray_Reference.xml

Railroad Electrical
CableTray_Reference.xml

Sump Electrical
CableTray_Reference.xml

Trench Electrical
CableTray_Reference.xml

Control Point Electrical CtrlPtCoord_Non


Mechanical CableTray_ControlPoint.x e_CA.xml
Equipment ml

Control Point Electrical CtrlPtCoord_Non


Process CableTray_ControlPoint.x e_CA.xml
Equipment ml

Drawings and Reports Reference Data Guide 422


Orthographic Drawings Reference Data

Example

Drawings and Reports Reference Data Guide 423


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a motor in a plan view.

Label Rule
Each motor object is labeled with the corresponding name from the model. For an example, see
the above graphic.

Graphic Rule
This is an example of the graphic representation of a trench in a plan drawing.

Drawings and Reports Reference Data Guide 424


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of electrical equipment in plan views.

Label Rule
Electrical equipment is labeled with the corresponding name from the model. For an example,
see the above graphic.

Graphic Rule
This is an example of the graphic representation of grid lines in a drawing.

Drawings and Reports Reference Data Guide 425


Orthographic Drawings Reference Data

Label Rule
Each grid line is labeled. Horizontal grid lines are labeled vertically, while vertical grid lines are
labeled horizontally. The label reports the name of the grids in the model.

X-axis grids Y-axis grids

Graphic Rule
This is an example of the graphic representation of an Equipment component in a drawing.

Label Rule
Every piece of equipment is labeled. The label is placed in the center of the equipment, unless
there is an object already in the center or there is insufficient white space for the label. If the
label cannot be placed on the center of the object, it is placed with a jogged leader. In the
example below, the label from the above graphic is magnified to show the details of the
equipment label.

Drawings and Reports Reference Data Guide 426


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of cableway parts in a plan drawing.

Label Rule
Each cableway part is labeled with the corresponding name from the model.

Drawings and Reports Reference Data Guide 427


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of cable trays in plan drawings.

Label Rule
Each cable tray is labeled with the corresponding name and elevation value from the model. For
an example, see the above graphic.

Dimension Rule
Horizontal dimensions are placed on vertical cable trays, while vertical dimensions are placed
on horizontal cable trays. The cable trays are dimensioned to nearby columns. For an example,
see the above graphic.

Drawings and Reports Reference Data Guide 428


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a beam in a drawing.

Graphic Rule
This is an example of the graphic representation of a Column in a drawing.

Dimension Rule
Dimensions all vertical and horizontal columns. Columns are dimensioned as anchors, which
means they are only dimensioned when they are in close proximity to a group of dimensioned
objects. If a column is not close enough to a group of dimensioned objects in a particular
quadrant, it is not dimensioned. Also, if the column is inline with another column that is already
dimensioned, it is not dimensioned.
In the example below, notice how the top left column is not dimensioned because the bottom left
column is dimensioned. Also, the middle columns are not dimensioned because they line up
with the outer columns.

Drawings and Reports Reference Data Guide 429


Orthographic Drawings Reference Data

The left portion of this drawing has been cropped due to size constraints.

Graphic Rule
This is an example of the graphic representation of a cable tray support in a plan view.

Label Rule
Each cable tray support is labeled with the corresponding name from the model. For an
example, see the above graphic.

Drawings and Reports Reference Data Guide 430


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of conduits in a plan view.

Electrical Equipment Elevation View Style


Name: Electrical Equipment Elevation
Description: Drawing layout designed for elevation views that focuses on electrical equipment
objects and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Electrical Electrical Equipment


Equipment_Reference. Elevation_Columns_Anch
xml or_Horizontal.xml

Columns Electrical Electrical Equipment


Equipment_Reference. Elevation_Columns_Horiz
xml ontal.xml

Electrical Electrical Electrical Equipment


Equipment Equipment_Electrical Elevation_Equipment_
Equipment.xml Name.xml

Cableway Electrical
Parts Equipment_Cableways
.xml

Drawings and Reports Reference Data Guide 431


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Cableway Electrical Electrical Equipment


Parts Equipment_Cableways Elevation_LineNumber
.xml _Longest Segment.xml

Cableway Clipped Electrical Electrical Equipment


Parts Equipment_Cableways Elevation_LineNumber
.xml _Clipped.xml

Cable Trays Parallel Electrical


Equipment_Cableways
.xml

Cable Trays Parallel, Electrical Electrical Equipment


horizontal Equipment_Cableways Elevation_CableTray_Ver
.xml tical.xml

Cable Trays Parallel, Electrical Electrical Equipment


vertical Equipment_Cableways Elevation_CableTray_Hor
.xml izontal.xml

Cable Trays Normal Electrical Electrical Equipment


Equipment_Cableways Elevation_CableTray_Hor
.xml izontal.xml

Cable Trays Normal Electrical Electrical Equipment


Equipment_Cableways Elevation_CableTray_Ver
.xml tical.xml

Grid Plane Electrical Electrical Equipment


Equipment_Grid Elevation_Grid
Plane.xml Plane_Name.xml

Grid Line Electrical Electrical Equipment Electrical Equipment


Equipment_Grid Elevation_Grid Elevation_Grid
Line.xml Line_TOS.xml Line_Anchor_Vertical.xml

Beams Electrical
Equipment_Reference.
xml

Handrails Electrical_Handrail.xml

Stairs Electrical
Equipment_Stairs_Cen
terline.xml

Ladders Electrical
Equipment_Ladders.x
ml

Electrical Electrical Electrical Equipment Electrical Equipment


Equipment Equipment_Equipment. Elevation_Equipment_ Elevation_CableTray_Hor
xml Name.xml izontal.xml

Drawings and Reports Reference Data Guide 432


Orthographic Drawings Reference Data

Example

Drawings and Reports Reference Data Guide 433


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of electrical equipment in an elevation view.

Label Rule
Each electrical equipment object is labeled with the corresponding name from the model. For an
example, see the above graphic.

Drawings and Reports Reference Data Guide 434


Orthographic Drawings Reference Data

Dimension Rule
Horizontal and vertical dimensions are placed on all electrical equipment objects. The
dimensions are grouped with the cable tray dimensions. For an example, see the above graphic.

Electrical Equipment Isometric View Style


Name: Electrical Equipment Isometric
Description: Drawing layout designed for isometric views that focuses on electrical equipment
objects and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Cableway Parts Electrical Equipment_Cableway.xml Electrical Equipment


Isometric_LineNumber
_LongestSegment.xml

Cable Trays Electrical Equipment_Cableway.xml

Cable Tray Electrical Equipment_Cable Tray


Supports Supports.xml

Columns Electrical Equipment_Reference.xml

Beams Electrical Equipment_Reference.xml

Braces Electrical Equipment_Reference.xml

Vertical Brace Electrical Equipment_Reference.xml

Equipment Electrical Equipment_Reference.xml


Foundation

Footings Electrical Equipment_Footing.xml

Electrical Electrical Electrical Equipment


Equipment Equipment_Equipment.xml Isometric_Equipment_
Name.xml

Drawings and Reports Reference Data Guide 435


Orthographic Drawings Reference Data

Example

Graphic Rule
This is an example of electrical equipment in an isometric view.

Drawings and Reports Reference Data Guide 436


Orthographic Drawings Reference Data

Label Rule
All electrical equipment objects are labeled with the corresponding name from the model.

Electrical Equipment Key Plan View Style


Name: Electrical Equipment Key Plan
Description: Drawing layout designed to place a Key Plan view of all grid systems in the model
and identifies the particular volume displayed in the drawing.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Grid Systems Electrical


Equipment_Reference.xml

KEY_PLAN_FOCUS_ Electrical Electrical Equipment


ELEMENT Equipment_Focus.xml Key
Plan_Focus_Name.xml

KEY_PLAN_ADJACEN Electrical
T_ELEMENT Equipment_Reference.xml

Drawings and Reports Reference Data Guide 437


Orthographic Drawings Reference Data

Example

Electrical Equipment Overall Key Plan View Style


Name: Electrical Equipment Overall Key Plan
Description: Drawing layout designed for key plan views that focuses on volumes and
equipment and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: True
Intersection Edges: Off
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Beams Parallel Electrical


Equipment_Reference.xml

Braces Parallel Electrical


Equipment_Reference.xml

Columns Electrical
Equipment_Reference.xml

Electrical Electrical
Equipment Equipment_Equipment.xml

Slabs Electrical
Equipment_Reference.xml

Drawings and Reports Reference Data Guide 438


Orthographic Drawings Reference Data

Electrical Electrical Electrical Equipment Overall


Equipment Plan Equipment_Volumes.xml Key Plan_Volume_Name.xml
Volumes

Control Point Electrical CtrlPtCoord_None_CA.xml


Mechanical Equipment_Control
Equipment Point.xml

Control Point Electrical CtrlPtCoord_None_CA.xml


Process Equipment_Control
Equipment Point.xml

Example

Drawings and Reports Reference Data Guide 439


Orthographic Drawings Reference Data

Electrical Equipment Plan View Style


Name: Electrical Equipment Plan
Description: Drawing layout designed for plan views that focuses on electrical equipment
objects and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Electrical Electrical Equipment


Equipment_Reference.xml Plan_Columns_Anchor
_Vertical.xml

Columns Electrical Electrical Equipment


Equipment_Reference.xml Plan_Columns_Anchor
_Horizontal.xml

Columns Electrical Electrical Equipment


Equipment_Reference.xml Plan_Columns_Vertical
.xml

Columns Electrical Electrical Equipment


Equipment_Reference.xml Plan_Columns_Horizo
ntal.xml

Beams Electrical
Equipment_Reference.xml

Cableway Parts Electrical Equipment


Plan_Cable Trays.xml

Cableway Parts Electrical Equipment Electrical Equipment


Plan_Cable Trays.xml Plan_LineNumber_Longest
Segment.xml

Cableway Parts Clipped Electrical Equipment Electrical Equipment


Plan_Cable Trays.xml Plan_LineNumber_Clipped.x
ml

Cable Trays Parallel Electrical Equipment


Plan_Cable Trays.xml

Cable Trays Parallel, Electrical Equipment Electrical Equipment


vertical Plan_Cable Trays.xml Plan_Cable

Drawings and Reports Reference Data Guide 440


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


Trays_Horizontal.xml

Cable Trays Parallel, Electrical Equipment Electrical Equipment


horizontal Plan_Cable Trays.xml Plan_Cable
Trays_Vertical.xml

Cable Trays Normal Electrical Equipment Electrical Equipment


Plan_Cable Trays.xml Plan_Cable
Trays_Horizontal.xml

Cable Trays Normal Electrical Equipment Electrical Equipment


Plan_Cable Trays.xml Plan_Cable
Trays_Vertical.xml

Cable Tray Electrical Electrical Equipment


Supports Equipment_Cable Tray Plan_Cable Tray
Supports.xml Supports_Name.xml

Conduit Electrical
Equipment_Conduit.xml

Grid Line Parallel, Electrical Equipment_Grid Electrical Equipment


vertical Line.xml Plan_Grid Line_X Name.xml

Grid Line Parallel, Electrical Equipment_Grid Electrical Equipment


horizontal Line.xml Plan_Grid Line_Y Name.xml

Electrical Electrical Electrical Equipment Electrical Equipment


Equipment Equipment_Equipment.xml Plan_Equipment_Name.xml Plan_Columns
Horizontal.xml

Electrical Electrical Electrical Equipment


Equipment Equipment_Equipment.xml Plan_Columns_Vertical
.xml

Road Electrical Electrical Equipment


Equipment_Reference.xml Plan_Road_Name.xml

Cabling Electrical
Equipment_Cabling.xml

Foundation Electrical
Pedestal Equipment_Reference.xml

Railroad Electrical
Equipment_Reference.xml

Sump Electrical
Equipment_Reference.xml

Trench Electrical
Equipment_Reference.xml

Control Point Electrical CtrlPtCoord_None_CA.xml


Mechanical Equipment_Control
Equipment Point.xml

Drawings and Reports Reference Data Guide 441


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Control Point Electrical CtrlPtCoord_None_CA.xml


Process Equipment_Control
Equipment Point.xml

Example

Drawings and Reports Reference Data Guide 442


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of electrical equipment in a plan view.

Label Rule
Each electrical equipment object is labeled with the appropriate name from the model. If there is
not enough white space for the label on the equipment object, the label is placed in nearby white
space with a jogged leader.

Dimension Rule
Horizontal and vertical dimensions are placed on each electrical equipment object. The
dimensions are grouped in with the column dimensions. For an example, see the graphic above.

Drawings and Reports Reference Data Guide 443


Orthographic Drawings Reference Data

Electrical Instrument Plan View Style


Name: Electrical Instrument Plan
Description: Drawing layout designed for plan views that focuses on electrical instruments and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Electrical
Instrument_Reference
.xml

Columns Electrical
Instrument_Reference
.xml

Columns Electrical
Instrument_Reference
.xml

Columns Electrical
Instrument_Reference
.xml

Piping Parts Electrical


Instrument_Piping.xml

Pipes Normal Front Electrical


Instrument_Normal
Pipe.xml

Pipe Supports Electrical


Instrument_Piping.xml

Piping Electrical Electrical Instrument


Instruments Instrument_Instrumen Plan_Instrument_Na
ts.xml me.xml

Grid Line Parallel, Electrical Electrical Instrument


horizontal Instrument_Grid Plan_Grid Line_Y
Line.xml Name.xml

Grid Line Parallel, Electrical Electrical Instrument


Instrument_Grid Plan_Grid Line_X

Drawings and Reports Reference Data Guide 444


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


vertical Line.xml Name.xml

Cableway Electrical
Parts Instrument_Cableway
s.xml

Cable Trays Parallel, Electrical


vertical Instrument_Cableway
s.xml

Cable Trays Parallel, Electrical


horizontal Instrument_Cableway
s.xml

Conduit Parts Electrical


Instrument_Conduit.x
ml

Conduits Parallel, Electrical


vertical Instrument_Conduit_
SingleLine.xml

Conduits Parallel, Electrical


horizontal Instrument_Conduit_
SingleLine.xml

Beams Electrical
Instrument_Reference
.xml

Stairs Electrical
Instrument_Stair.xml

Ladders Electrical
Instrument_Ladder.x
ml

Control Point Electrical CtrlPtCoord_None_C


Mechanical Instrument_Control A.xml
Equipment Point.xml

Control Point Electrical CtrlPtCoord_None_C


Process Instrument_Control A.xml
Equipment Point.xml

Equipment Electrical Electrical Instrument


Except Instrument_Equipmen Plan_Equipment_Na
Junction Box t.xml me.xml

Junction Box Electrical Electrical Instrument


Instrument_Junction Plan_Junction
Box.xml Box_Name.xml

Drawings and Reports Reference Data Guide 445


Orthographic Drawings Reference Data

Example

Drawings and Reports Reference Data Guide 446


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping instruments in a plan view.

Label Rule
Piping instruments are labeled with the corresponding name from the model. A relative elevation
label is also placed on each piping instrument. For an example, see the above graphic.

Drawings and Reports Reference Data Guide 447


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of cable trays in a plan view.

Drawings and Reports Reference Data Guide 448


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping parts in a plan view.

Drawings and Reports Reference Data Guide 449


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping in a drawing.

Drawings and Reports Reference Data Guide 450


Orthographic Drawings Reference Data

Pipes that are clipped by a volume are labeled differently than other pipes and pipe parts that
appear inside the volume. Clipped pipes that are directly parallel to the look direction are
resymbolized.

Graphic Rule
This is an example of the graphic representation of pipe supports in a plan view.

Graphic Rule
This is an example of the graphic representation of conduit parts in a plan view.

Drawings and Reports Reference Data Guide 451


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of stairs in a drawing.

Stairs that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Graphic Rule
This is an example of the graphic representation of a ladder in a drawing.

Ladders that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Drawings and Reports Reference Data Guide 452


Orthographic Drawings Reference Data

Electrical Lighting Plan View Style


Name: Electrical Lighting Plan
Description: Drawing layout designed for plan views that focuses on lighting and includes other
objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Structure Electrical
Lighting_Reference.xm
l

Process Electrical Electrical Lighting


Equipment Lighting_Reference.xm Plan_Equipment_Nam
l e.xml

Grid Line Parallel, Electrical Electrical Lighting


vertical Lighting_Reference.xm Plan_Grid Line_X
l Name.xml

Grid Line Parallel, Electrical Electrical Lighting


horizontal Lighting_Reference.xm Plan_Grid Line_Y
l Name.xml

Lighting Electrical Lighting


Fixtures Plan_Light_Symbol_Nu
mber.xml

Ceiling Light Electrical Electrical Lighting


Lighting_Light_Ceiling. Plan_Light_Name.xml
xml

Fluorescent Electrical Electrical Lighting


Light Lighting_Light_Fluores Plan_Light_Name.xml
cent.xml

Stancion Light Electrical Electrical Lighting


Lighting_Light_Stancio Plan_Light_Name.xml
n.xml

Wall Light Electrical Electrical Lighting


Lighting_Light_Wall.xm Plan_Light_Name.xml
l

Drawings and Reports Reference Data Guide 453


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Control Point Electrical CtrlPtCoord_None_CA.


Mechanical Lighting_Control xml
Equipment point.xml

Control Point Electrical CtrlPtCoord_None_CA.


Process Lighting_Control xml
Equipment point.xml

Example

Drawings and Reports Reference Data Guide 454


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of structure in a plan view.

Graphic Rule
This is an example of the graphic representation of lights in a plan drawing.

Label Rule
Lights are labeled with the corresponding name from the model. A coordinate label is also
placed on the light object. For an example, see the above graphic.

SM_Electrical_Cable_Tray_Plan View Style


Name: SM_Electrical_Cable_Tray_Plan
Description: Plan views that focus on cable tray objects and include background Model.
Intersection Edges: Off
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Drawings and Reports Reference Data Guide 455


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Grid Line Parallel, vertical SM_ SM_ SM_Electrical_Plan_


ElectricalCableTray_ ElectricalCable Grid_Anchor_
Plan_GridLine Tray_Plan_ Horizontal
GridLineX_Name

Grid Line Parallel, SM_ SM_ SM_Electrical_Plan_


horizontal ElectricalCableTray_ ElectricalCable Grid_Anchor_
Plan_GridLine Tray_Plan_ Vertical
GridLineY_Name

Equipment SM_
and ElectricalCableTray_
Furnishing Plan_Equipment

Cableway SM_
ElectricalCableTray_
Plan_Instrumentation

Cableway SM_
ElectricalCableTray_
Plan_Others

Cableway SM_
ElectricalCableTray_
Plan_Power

Cableway Parallel, vertical SM_ SM_Electrical_Plan_


Parts ElectricalCableTray_ CableTray_Horizontal
Plan_Invisible

Cableway Parallel, SM_ SM_Electrical_Plan_


Parts horizontal ElectricalCableTray_ CableTray_Vertical
Plan_Invisible

Cableway SM_ SM_


Parts ElectricalCableTray_ ElectricalCable
Plan_Invisible Tray_Plan_
LineNumberBOT_
LongestSegment

Cableway Normal SM_ SM_Electrical_Plan_


Parts ElectricalCableTray_ CableTray_Horizontal
Plan_Invisible

Cableway Normal SM_ SM_Electrical_Plan_


Parts ElectricalCableTray_ CableTray_Vertical
Plan_Invisible

Drawings and Reports Reference Data Guide 456


Orthographic Drawings Reference Data

SM_Electrical_Cable_Tray_Elevation View Style


Name: SM_Electrical_Cable_Tray_Elevation
Description: Elevation views that focus on cable tray objects and include background Model.
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: NorthArrow

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Grid Plane Parallel, SM_ SM_ SM_


Elevation horizontal ElectricalCableTray_ ElectricalCableTray_ Electrical_Elevation_
Elevation_GridLine Elevation_ Grid_Anchor_
GridPlane_Name Horizontal

Hull_BHD_ SM_
long_root ElectricalCableTray_
Elevation_BHD

Hull_BHD_ SM_
trans_root ElectricalCableTray_
Elevation_BHD

Hull_DECK_ SM_
root ElectricalCableTray_
Elevation_Deck

Hull_profile_ SM_
root ElectricalCableTray_
Elevation_Profiles

Equipment and SM_


Furnishing ElectricalCableTray_
Elevation_Equipment

CableWay_ SM_
Instrumentation ElectricalCableTray_
Elevation_
Instrumentation

CableWay_ SM_
Others ElectricalCableTray_
Elevation_Others

Cableway SM_
ElectricalCableTray_
Elevation_Power

Drawings and Reports Reference Data Guide 457


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Cableway Parts Parallel, SM_


vertical ElectricalCableTray_
Elevation_Invisible

Cableway Parts Parallel, SM_ SM_Electrical_Elevation


ElectricalCableTray_ _CableTray_Vertical
horizontal Elevation_Invisible

Cableway Parts SM_ SM_Electrical_Elevation


ElectricalCableTray_ _CableTray_Vertical
Elevation_Invisible

Cableway SM_
Name_Elevation_
None_JL

SM_Lighting_Plan View Style


Name: SM_Lighting_Plan
Description: Plan views that focus on lighting objects and include background Model.
Intersection Edges: Off
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Beam and SM_Lighting_Plan_


Profile Edge Profiles
Reinforcement
Root Systems

Grid Line Parallel, vertical SM_Lighting_Plan_ SM_Lighting_Plan_ SM_Lighting_Plan_Grid_


GridLine GridLineX_Name Anchor_Horizontal

Grid Line Parallel, SM_Lighting_Plan_ SM_Lighting_Plan_ SM_Lighting_Plan_Grid_


horizontal GridLine GridLineY_Name Anchor_Vertical

Root SM_Lighting_Plan_BH
Longitudinal D
Bulkhead
Plate Systems

Drawings and Reports Reference Data Guide 458


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Root SM_Lighting_Plan_BH
Transverse D
Bulkhead
Plate Systems

Root Deck SM_Lighting_Plan_Dec


Plate Systems k

Equipment SM_Lighting_Plan_
Except Equipment
Lighting

Junction Box SM_Lighting_Plan_ SM_Lighting_Plan_


JunctionBox Light_Name

Junction Box SM_Lighting_Plan_


Light_Description

Fluorescent SM_Lighting_Plan_ SM_Lighting_Plan_


Light Fluorescent Light_Name_Vert

Fluorescent SM_Lighting_Plan_
Light Light_Description_
Vert

Lighting SM_Lighting_Plan_ SM_Lighting_Plan_


Fixtures Flushmount Light_Name

Lighting SM_Lighting_Plan_
Fixtures Light_Description

Equipment View Styles


Topics
Equipment Elevation View Style .................................................... 460
Equipment Isometric View Style .................................................... 468
Equipment Key Plan View Style .................................................... 473
Equipment Overall Key Plan View Style ........................................ 474
Equipment Plan View Style ............................................................ 477

Drawings and Reports Reference Data Guide 459


Orthographic Drawings Reference Data

Equipment Elevation View Style


Name: Equipment Elevation
Description: Drawing layout designed for elevation views that focuses on equipment objects
and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Equipment_Referenc Equipment


e.xml Elevation_Columns_Anc
hor_Horizontal.xml

Equipment Equipment_Process Equipment Equipment


Equipment.xml Elevation_Equipment_ Elevation_Equipment_H
elevation.xml orizontal.xml

Equipment Equipment_Process Equipment


Equipment.xml Elevation_Equipment_
Name.xml

Grid Plane Equipment_Grid Equipment


Line.xml Elevation_Grid
Plane_Name.xml

Grid Line Equipment_Grid Equipment


Line.xml Elevation_Grid
Line_TOS.xml

Beams Equipment_Referenc
e.xml

Handrails Equipment_Handrail.x
ml

Stairs Equipment_Stairs_Ce
nterline.xml

Ladders Equipment_Ladders.x
ml

Footings Equipment_Referenc
e.xml

Drawings and Reports Reference Data Guide 460


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Pipe Nozzle Equipment_Pipe


Nozzle.xml

Example

Drawings and Reports Reference Data Guide 461


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a grid plane in a drawing.

Label Rule
The y-axis of the grid plane is labeled with the name of the grid in the model. For example, see
the above graphic.

Graphic Rule
This is an example of the graphic representation of grid lines in an elevation drawing.

Drawings and Reports Reference Data Guide 462


Orthographic Drawings Reference Data

Label Rule
All elevation grid lines are labeled with the grid name and elevation distance. For an example,
see the above graphic.

Graphic Rule
This is an example of the graphic representation of a Column in an elevation drawing.

Dimension Rule
Horizontal dimensions are placed between each column. The dimensions are grouped with the
equipment dimensions that are in the same quadrant.

Drawings and Reports Reference Data Guide 463


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of equipment in an elevation drawing.

Label Rule
Every piece of equipment is labeled with a name label and a north-east coordinate label. The
name label is placed in the center of the equipment, unless there is an object already in the
center, or if there is not sufficient white space for the label. If the label cannot be placed on the
center of the object, it is placed with a jogged leader. The coordinate label is placed on the
object origin, unless there is insufficient space, in which case it will find the necessary white
space. See the above graphic for an example of the labels.

Drawings and Reports Reference Data Guide 464


Orthographic Drawings Reference Data

Dimension Rule
Horizontal dimensions are placed on each equipment object. The point of dimensioning is the
object origin. Nearby columns are also dimensioned with the equipment objects.

Graphic Rule
This is an example of the graphic representation of a beam in an elevation drawing.

Graphic Rule
This is an example of the graphic representation of a handrail in an elevation drawing.

Drawings and Reports Reference Data Guide 465


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of stairs in an elevation drawing.

Stairs that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Drawings and Reports Reference Data Guide 466


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a ladder in an elevation drawing.

Ladders that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Drawings and Reports Reference Data Guide 467


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a footing in an elevation drawing.

Equipment Isometric View Style


Name: Equipment Isometric
Description: Drawing layout designed for isometric views that focuses on Equipment objects
and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Equipment Equipment_Pipe
Nozzle.xml

Members Equipment_Referenc
e.xml

Equipment Equipment_Referenc
Foundations e.xml

Footings Equipment_Referenc
e.xml

Pipe Nozzle Equipment_Pipe


Nozzle.xml

Drawings and Reports Reference Data Guide 468


Orthographic Drawings Reference Data

Example

Drawings and Reports Reference Data Guide 469


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of equipment foundations in an isometric
drawing.

Graphic Rule
This is an example of the graphic representation of an Equipment component in an isometric
drawing.

Drawings and Reports Reference Data Guide 470


Orthographic Drawings Reference Data

Label Rule
Every piece of equipment is labeled. The label is placed in the center of the equipment, unless
there is an object already in the center or there is insufficient white space for the label. If the
label cannot be placed on the center of the object, it is placed with a jogged leader. In the
example below, the label is placed inside the object without a leader.

Graphic Rule
This is an example of the graphic representation of footings in an isometric drawing.

Drawings and Reports Reference Data Guide 471


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of members in an isometric drawing.

Drawings and Reports Reference Data Guide 472


Orthographic Drawings Reference Data

Equipment Key Plan View Style


Name: Equipment Key Plan
Description: Drawing layout designed to place a Key Plan view of all grid systems in the model
and identifies the particular volume displayed in the drawing.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Grid Equipment_Reference.xm
Systems l

KEY_PLAN_ Equipment_Focus.xml Equipment Key


FOCUS_ Plan_Volume_Name.x
ELEMENT ml

KEY_PLAN_ Equipment_Reference.xm
ADJACENT_ l
ELEMENT

Example

Drawings and Reports Reference Data Guide 473


Orthographic Drawings Reference Data

Equipment Overall Key Plan View Style


Name: Equipment Overall Key Plan
Description: Drawing layout designed for key plan views that focuses on volumes and
equipment and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: True
Intersection Edges: Off
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Beams Parallel Equipment_Referenc


e.xml

Braces Parallel Equipment_Referenc


e.xml

Columns Equipment_Referenc
e.xml

Equipment Equipment_Equipmen
t.xml

Slabs Equipment_Referenc
e.xml

Equipment Equipmen_Volumes.x Equipment Overall


Plan Volumes ml Key
Plan_Volume_Name.
xml

Control Point Equipment_Control CtrlPtCoord_None_C


Mechanical Point.xml A.xml
Equipment

Control Point Equipment_Control CtrlPtCoord_None_C


Process Point.xml A.xml
Equipment

Drawings and Reports Reference Data Guide 474


Orthographic Drawings Reference Data

Example

Graphic Rule
This is an example of the graphic representation of piping plan volumes in a drawing.

Drawings and Reports Reference Data Guide 475


Orthographic Drawings Reference Data

Label Rule
All drawing key plan volumes are labeled with their 3D model name. By default, the label is
placed in the upper left corner of the volume in the drawing. For an example, see the above
graphic.

Graphic Rule
This is an example of the graphic representation of equipment in a plan drawing.

Graphic Rule
This is an example of the graphic representation of slabs in a drawing. The slab boundaries are
drawn with a gray line. Openings in the slab are also represented with a gray line.

Drawings and Reports Reference Data Guide 476


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of braces in a drawing.

Graphic Rule
This is an example of the graphic representation of a Column in a drawing.

Equipment Plan View Style


Name: Equipment Plan
Description: Drawing layout designed for plan views that focuses on Equipment objects and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).

Drawings and Reports Reference Data Guide 477


Orthographic Drawings Reference Data

 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Equipment_Columns.xml Equipment


Plan_Columns_Anchor_Horizon
tal.xml

Columns Equipment_Columns.xml Equipment


Plan_Columns_Anchor_Vertical
.xml

Columns Equipment_Columns.xml Equipment


Plan_Columns_Horizontal.xml

Columns Equipment_Columns.xml Equipment


Plan_Columns_Vertical.xml

Equipment Equipment_Process Equipment


Equipment.xml Plan_Equipment_Name.xml

Equipment Equipment_Process Equipment Plan_Process


Equipment.xml Equipment_Horizontal.xml

Equipment Equipment_Process Equipment Plan_Process


Equipment.xml Equipment_Vertical.xml

Beams Equipment_Columns.xml

Footings Equipment_Reference.xml

Ladders Equipment_Ladders.xml

Hose Rack Equipment_Reference.xml

Lighting Equipment_Reference.xml
Fixtures

Trench Equipment_Reference.xml

Panels and Equipment_Reference.xml


Cabinets

Grid Line Parallel, Equipment_Grid Line.xml Equipment Plan_Grid Line_X


vertical Name.xml

Grid Line Parallel, Equipment_Grid Line.xml Equipment Plan_Grid Line_Y


horizontal Name.xml

Stairs Equipment_Stairs.xml

Pipe Nozzle Equipment_Pipe Nozzle.xml

Drawings and Reports Reference Data Guide 478


Orthographic Drawings Reference Data

Example

Drawings and Reports Reference Data Guide 479


Orthographic Drawings Reference Data

Detailed View

Graphic Rule
This is an example of the graphic representation of a beam in a drawing.

Graphic Rule
This is an example of the graphic representation of a Column in a drawing.

Drawings and Reports Reference Data Guide 480


Orthographic Drawings Reference Data

Dimension Rule
Dimensions all vertical and horizontal columns. Columns are dimensioned as anchors, which
means they are only dimensioned when they are in close proximity to a group of dimensioned
objects. If a column is not close enough to a group of dimensioned objects in a particular
quadrant, it is not dimensioned. Also, if the column is inline with another column that is already
dimensioned, it is not dimensioned.
In the example below, notice how the top left column is not dimensioned because the bottom left
column is dimensioned. Also, the middle columns are not dimensioned because they line up
with the outer columns.
The left portion of this drawing has been cropped due to size constraints.

Drawings and Reports Reference Data Guide 481


Orthographic Drawings Reference Data

SM_Equipment_Plan View Style


Name: SM_Equipment_Plan
Description: Plan views that focus on equipment objects and include background Model.
Intersection Edges: Off
View Rule: None
Matchline: Matchline_Dimension_Anchor.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Grid Line Parallel, vertical SM_HVAC_Equipment SM_Equipment_ SM_Equipment_Plan_


_ Plan_ Grid_Anchor_
GridLine GridLineX_Name Horizontal

Grid Line Parallel, SM_HVAC_Equipment SM_Equipment_ SM_Equipment_Plan_


horizontal _ Plan_ Grid_Anchor_
GridLine GridLineY_Name Vertical

Root SM_Equipment_Plan_
Longitudinal BHD
Bulkhead
Plate Systems

Root SM_Equipment_Plan_
Transverse BHD
Bulkhead
Plate Systems

Root Deck SM_Equipment_Plan_


Plate Systems Deck

Beam and SM_Equipment_Plan_


Profile Edge Profiles
Reinforcement
Root Systems

Equipment SM_Equipment_ SM_Equipment_ SM_Equipment_Plan_\


and Plan_Equipment Plan_Equipment_ Equipment_Horizontal
Furnishing Name

Equipment SM_Equipment_Plan_\
and Equipment_Vertical
Furnishing

Ladders SM_Equipment_Plan_
Ladders

Drawings and Reports Reference Data Guide 482


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Stairs SM_Equipment_Plan_
Stairs

Graphic Rule
This is an example of the graphic representation of a control point in a drawing.

Label Rule
Each control point is resymbolized and labeled with its name from the model.

Graphic Rule
This is an example of the graphic representation of an Equipment component in a drawing.

Drawings and Reports Reference Data Guide 483


Orthographic Drawings Reference Data

Label Rule
Every piece of equipment is labeled with a name label and a north-east coordinate label. The
name label is placed in the center of the equipment, unless there is an object already in the
center or there is insufficient white space for the label. If the label cannot be placed on the
center of the object, it is placed with a jogged leader. The coordinate label is placed on the
object origin, unless there is insufficient space, in which case it will find the necessary white
space. See the above graphic for an example of the labels.

Dimension Rule
Vertical and horizontal dimensions are placed on the equipment components. The point of
dimensioning is the object origin.

Drawings and Reports Reference Data Guide 484


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of footings in a drawing.

Graphic Rule
This is an example of the graphic representation of grid lines in a drawing.

Drawings and Reports Reference Data Guide 485


Orthographic Drawings Reference Data

Label Rule
Each grid line is labeled. Horizontal grid lines are labeled vertically, while vertical grid lines are
labeled horizontally. The label reports the name of the grids in the model.

X-axis grids Y-axis grids

Graphic Rule
This is an example of the graphic representation of a hose rack in a plan drawing.

Graphic Rule
This is an example of the graphic representation of a ladder in a drawing.

Drawings and Reports Reference Data Guide 486


Orthographic Drawings Reference Data

Ladders that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Graphic Rule
This is an example of the graphic representation of a lighting fixture in a plan drawing.

Graphic Rule
This is an example of the graphic representation of Panels and Cabinets in a plan drawing.

Graphic Rule
This is an example of the graphic representation of stairs in a drawing.

Stairs that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Drawings and Reports Reference Data Guide 487


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a trench in a plan drawing.

Drawings and Reports Reference Data Guide 488


Orthographic Drawings Reference Data

HngSup View Styles


Topics
HngSup - Cad Details View Style .................................................. 489
HngSup - End View Style .............................................................. 489
HngSup - End Style2 View Style ................................................... 491
HngSup - ISO View Style ............................................................... 493
HngSup - Key Plan View Style ...................................................... 494
HngSup - Side View Style .............................................................. 494
HngSup - Side Style2 View Style................................................... 496

HngSup - Cad Details View Style


Name: HngSup - Cad Details
Description: Drawing layout designed to contain CAD details of support assemblies.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Control Point HngSup_CAD HngSup Cad


CAD Detail Detail.xml Details_Cad Detail.xml

HngSup - End View Style


Name: HngSup - End
Description: Drawing layout designed for plan views that focuses on hangers and supports and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: High Resolution
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).

Drawings and Reports Reference Data Guide 489


Orthographic Drawings Reference Data

 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Hangers and HngSup


Supports End_Structure
Supporting Reference.xml
Objects

Control Point HngSup_Control


Structure Point Structure.xml

Piping HngSup End_Piping


Reference.xml

Piping Parts HngSup End_Piping HngSup


Reference.xml End_Diamond_M_L.xml

Support HngSup
Components End_Components
Blue.xml

Pipes Normal HngSup_Pipe


End.xml

Conduit HngSup End_Piping HngSup


Parts Reference.xml End_Diamond_M_L.xml

Conduit Normal HngSup


Parts End_Conduit
End.xml

HVAC Parts Normal HngSup End_SQ HngSup


HVAC End.xml End_Diamond_M_L.xml

Cableway Normal HngSup HngSup


Parts End_CableTray End_Diamond_M_L.xml
End.xml

Support HngSup HgrSup


Assembly End_Support End_Support
Assembly.xml Assembly
Horizontal.xml

Support HngSup HgrSup


Assembly End_Support End_Support
Assembly.xml Assembly
Vertical.xml

Control Point HngSup_Transparen HngSup


Elevation t.xml End_Elevation_Label.xml
Callout

Weld HngSup_Weld HngSup End_Weld.xml


Component Blue.xml

Control point HngSup_Transparen HngSup


Ad Hoc Note t.xml End_AdHoc_Label.xml

Drawings and Reports Reference Data Guide 490


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Support and HngSup


Hanger End_Components
Structure Blue.xml

HngSup - End Style2 View Style


Name: HngSup - End Style2
Description: Drawing layout designed for plan views that focuses on hangers and supports and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: High Resolution
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).
 The dimPerimterOffset value is defined by the view style’s grid label rule, if available.
 If there is no grid label rule, this view style uses the dimPerimeterOffset value as defined
by the label rule closest to the right and bottom side of the drawing view. Generate and open
the drawing to see which label rule is in the rightmost and bottommost position, and edit that
label rule’s .xml file to use its dimPerimeterOffset value. If this label rule has dimension
set to 0, and if dimPerimeterOffset is not defined, the dimPerimeterOffset value is defined
as half of the perimeterOffset value.

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Hangers and HngSup


Supports End_Structure
Supporting Reference.xml
Objects

Control Point HngSup_Control HngSup


Structure Point Structure.xml End_Control Point
Structure_North-Eas
t.xml

Piping HngSup End_Piping


Reference.xml

Piping Parts HngSup End_Piping HngSup


Reference.xml End_Diamond_M_L.
xml

Drawings and Reports Reference Data Guide 491


Orthographic Drawings Reference Data

Support HngSup
Components End_Components
Blue.xml

Pipes Normal HngSup_Pipe


End.xml

Conduit Parts HngSup End_Piping HngSup


Reference.xml End_Diamond_M_L.
xml

Conduit Parts Normal HngSup End_Conduit


End.xml

HVAC Parts Normal HngSup End_SQ HngSup


HVAC End.xml End_Diamond_M_L.
xml

Cableway Parts Normal HngSup HngSup


End_CableTray End_Diamond_M_L.
End.xml xml

Support HngSup End_Support HgrSup


Assembly Assembly.xml End_Support
Assembly Horizontal
Style2.xml

Support HngSup End_Support HgrSup


Assembly Assembly.xml End_Support
Assembly Vertical
Style2.xml

Support HngSup_Transparent. HgrSup


Dimension xml End_Support
Points Dimension Points
Horizontal
Style2.xml

Support HngSup_Transparent. HgrSup


Dimension xml End_Support
Points Dimension Points
Vertical Style2.xml

Support HngSup End_Support HgrSup


Assembly Assembly.xml End_Support
Assembly
KeyPoint_Anchor_H
orizontal.xml

Support HngSup End_Support HgrSup


Assembly Assembly.xml End_Support
Assembly
KeyPoint_Anchor_V
ertical.xml

Control Point HngSup_Transparent. HngSup


Elevation xml End_Elevation_Labe
Callout l.xml

Drawings and Reports Reference Data Guide 492


Orthographic Drawings Reference Data

Weld HngSup_Weld HngSup


Component Blue.xml End_Weld.xml

Control Point HngSup_Transparent. HngSup


Ad Hoc Note xml End_AdHoc_Label.x
ml

Support and HngSup


Hanger End_Components
Structure Blue.xml

HngSup - ISO View Style


Name: HngSup - ISO
Description: Drawing layout designed for isometric views that focuses on hangers and supports
and also includes other objects important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: High Resolution
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Support and HngSup HngSup


Structure ISO_Components ISO_Reference_Circle_
Blue.xml CA_L.xml

Fabrication HngSup HngSup ISO_Note.xml


Note ISO_Components
Blue.xml

Standard HngSup
Component ISO_Components
Blue.xml

Piping HngSup ISO_Piping


Reference.xml

Support HngSup ISO_Support HngSup


Assembly Assembly.xml ISO_KeyPlan_Coordinat
e.xml

HVAC Parts HngSup ISO_HVAC


Reference.xml

Drawings and Reports Reference Data Guide 493


Orthographic Drawings Reference Data

Cableway HngSup
Parts ISO_CableTray
Reference.xml

Conduit Parts HngSup ISO_Conduit


Reference.xml

HngSup - Key Plan View Style


Name: HngSup - Key Plan
Description: Drawing layout designed to contain hanger key plan location of hanger support
assemblies.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: HngSup_SupportNotes.xml
Matchline: None
North Arrow: NorthArrow_HngSup.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Support HngSup_Key HngSup KeyPlan.xml


Assembly Plan.xml

HngSup - Side View Style


Name: HngSup - Side
Description: Drawing layout designed for elevation views that focuses on hangers and supports
and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: High Resolution
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Drawings and Reports Reference Data Guide 494


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Hangers and HngSup HngSup


Supports Side_Structure Side_Reference_Circl
Supporting Reference.xml e_CA_L.xml
Objects

Control Point HngSup_Control


Structure Point Structure.xml

Piping HngSup Side_Piping


Reference.xml

Piping Parts HngSup Side_Piping


Reference.xml

Support HngSup
Components Side_Components
Blue.xml

Pipes Normal HngSup_Pipe


End.xml

Conduit HngSup Side_Conduit


Parts Reference.xml

Conduit Normal HngSup Side_Conduit


Parts End.xml

HVAC Parts HngSup Side_HVAC


Reference.xml

HVAC Parts Normal HngSup Side_SQ


HVAC End.xml

Cableway HngSup
Parts Side_CableTray
Reference.xml

Cableway Normal HngSup


Parts Side_CableTray
End.xml

Support HgrSup Side_Support HgrSup Side_Support


Assembly Assembly.xml Assembly Horizontal.xml

Support HgrSup Side_Support HgrSup Side_Support


Assembly Assembly.xml Assembly Vertical.xml

Weld HngSup Side_Weld


Component Blue.xml

Support and HngSup


Hanger Side_Components
Structure Blue.xml

Drawings and Reports Reference Data Guide 495


Orthographic Drawings Reference Data

HngSup - Side Style2 View Style


Name: HngSup - Side Style2
Description: Drawing layout designed for elevation views that focuses on hangers and supports
and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: High Resolution
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).
 The dimPerimterOffset value is defined by the view style’s grid label rule, if available.
 If there is no grid label rule, this view style uses the dimPerimeterOffset value as defined
by the label rule closest to the right and bottom side of the drawing view. Generate and open
the drawing to see which label rule is in the rightmost and bottommost position, and edit that
label rule’s .xml file to use its dimPerimeterOffset value. If this label rule has dimension
set to 0, and if dimPerimeterOffset is not defined, the dimPerimeterOffset value is defined
as half of the perimeterOffset value.

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Hangers and HngSup HngSup


Supports Side_Structure Side_Reference_Circl
Supporting Reference.xml e_CA_L.xml
Objects

Control Point HngSup_Control HngSup Side_Control


Structure Point Structure.xml Point
Structure_North-East
Coordinate.xml

Piping HngSup Side_Piping


Reference.xml

Piping Parts HngSup Side_Piping


Reference.xml

Support HngSup
Components Side_Components
Blue.xml

Pipes Normal HngSup_Pipe HgrSup_Pipes_Horizon


End.xml tal.xml

Conduit HngSup Side_Conduit


Parts Reference.xml

Drawings and Reports Reference Data Guide 496


Orthographic Drawings Reference Data

Conduit Normal HngSup Side_Conduit


Parts End.xml

HVAC Parts HngSup Side_HVAC


Reference.xml

HVAC Parts Normal HngSup Side_SQ


HVAC End.xml

Cableway HngSup
Parts Side_CableTray
Reference.xml

Cableway Normal HngSup


Parts Side_CableTray
End.xml

Support HngSup HgrSup Side_Support


Assembly Side_Support Assembly Horizontal
Assembly.xml Style2.xml

Support HngSup HgrSup Side_Support


Assembly Side_Support Assembly Vertical
Assembly.xml Style2.xml

Support HngSup_Transparent. HgrSup Side_Support


Dimension xml Dimension Points
Points Horizontal Style2.xml

Support HngSup_Transparent. HgrSup Side_Support


Dimension xml Dimension Points
Points Vertical Style2.xml

Support HngSup HgrSup Side_Support


Assembly Side_Support Assembly
Assembly.xml KeyPoint_Horizontal.x
ml

Support HngSup HgrSup Side_Support


Assembly Side_Support Assembly
Assembly.xml KeyPoint_Vertical.xml

Weld HngSup_Weld
Component Blue.xml

Support and HngSup


Hanger Side_Components
Structure Blue.xml

Drawings and Reports Reference Data Guide 497


Orthographic Drawings Reference Data

HVAC View Styles


Topics
HVAC Elevation View Style ........................................................... 498
HVAC Isometric View Style ........................................................... 500
HVAC Key Plan View Style ............................................................ 501
HVAC Overall Key Plan View Style ............................................... 502
HVAC Plan View Style ................................................................... 505
SM_HVAC_Plan View Style .......................................................... 515
SM_HVAC_Elevation View Style ................................................... 516

HVAC Elevation View Style


Name: HVAC Elevation
Description: Drawing layout designed for elevation views that focuses on HVAC objects and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns HVAC_Reference.xml HVAC


Elevation_Columns_Hori
zontal.xml

Columns HVAC_Reference.xml HVAC


Elevation_Columns_Anc
hor_Horizontal.xml

HVAC Parts HVAC_HVAC.xml

HVAC Parts HVAC_HVAC.xml HVAC


Elevation_LineNumbe
r_Longest
Segment.xml

HVAC Parts Clipped HVAC_HVAC.xml HVAC


Elevation_LineNumbe
r_Clipped.xml

Drawings and Reports Reference Data Guide 498


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Ducts Parallel HVAC_HVAC.xml HVAC


Elevation_Linear Duct
Cross Section
Size.xml

Ducts Parallel, HVAC_HVAC.xml HVAC


horizontal Elevation_Ducts_Vertica
l.xml

Ducts Parallel, HVAC_HVAC.xml HVAC


vertical Elevation_Ducts_Horizo
ntal.xml

HVAC HVAC_HVAC.xml
Components

HVAC Parallel, HVAC_HVAC.xml HVAC


Components horizontal Elevation_Ducts_Horizo
ntal.xml

HVAC Parallel, HVAC_HVAC.xml HVAC


Components vertical Elevation_Ducts_Vertica
l.xml

Ducts Normal HVAC_HVAC.xml HVAC


Elevation_Ducts_Horizo
ntal.xml

Ducts Normal HVAC_HVAC.xml HVAC


Elevation_Ducts_Vertica
l.xml

Duct Supports HVAC_Duct HVAC Elevation_Pipe


Supports.xml Support_Name.xml

Grid Plane HVAC_Grid Plane.xml HVAC Elevation_Grid


Plane_Name.xml

Grid Line HVAC_Grid Line.xml HVAC Elevation_Grid HVAC Elevation_Grid


Line_TOS.xml Line_Anchor_Vertical.x
ml

Beams HVAC_Reference.xml

Handrails HVAC_Handrail.xml

Stairs HVAC_Stairs_Centerlin
e.xml

Ladders HVAC_Ladders.xml

Drawings and Reports Reference Data Guide 499


Orthographic Drawings Reference Data

HVAC Isometric View Style


Name: HVAC Isometric
Description: Drawing layout designed for isometric views that focuses on HVAC objects and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

HVAC Parts HVAC_HVAC


Parts.xml

Ducts HVAC_Ducts.xml HVAC Isometric_Linear


Duct Cross Section
Size.xml

HVAC Runs HVAC_Ducts.xml HVAC


Isometric_Run_Name.x
ml

Duct HVAC_Duct HVAC Isometric_Pipe


Supports Supports.xml Support_Name.xml

Members HVAC_Reference.xml

Footings HVAC_Footings.xml

Ladders HVAC_Ladder.xml

Handrails HVAC_Handrail.xml

Stairs HVAC_Stairs_Centerli
ne.xml

Drawings and Reports Reference Data Guide 500


Orthographic Drawings Reference Data

HVAC Key Plan View Style


Name: HVAC Key Plan
Description: Drawing layout designed to place a key plan view of all grid systems in the model
and identifies the particular volume displayed in the drawing.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Grid HVAC_Reference.xml
Systems

KEY_PLAN_ HVAC_Focus.xml HVAC Key


FOCUS_ Plan_Focus_Name.xml
ELEMENT

KEY_PLAN_ HVAC_Reference.xml
ADJACENT_
ELEMENT

Example

Drawings and Reports Reference Data Guide 501


Orthographic Drawings Reference Data

HVAC Overall Key Plan View Style


Name: HVAC Overall Key Plan
Description: Drawing layout designed for a key plan view that focuses on volumes and
equipment and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: True
Intersection Edges: Off
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Beams Parallel HVAC_Reference.xml

Braces Parallel HVAC_Reference.xml

Columns HVAC_Reference.xml

Slabs HVAC_Reference.xml

Equipment HVAC_Equipment.xm
l

HVAC Plan HVAC_Volumes.xml HVAC Overall Key


Volumes Plan_Volume_Name.x
ml

Drawings and Reports Reference Data Guide 502


Orthographic Drawings Reference Data

Example

Graphic Rule
This is an example of the graphic representation of piping plan volumes in a drawing.

Drawings and Reports Reference Data Guide 503


Orthographic Drawings Reference Data

Label Rule
All drawing key plan volumes are labeled with their 3D model name. By default, the label is
placed in the upper left corner of the volume in the drawing. For an example, see the above
graphic.

Graphic Rule
This is an example of the graphic representation of braces in a drawing.

Graphic Rule
This is an example of the graphic representation of slabs in a drawing. The slab boundaries are
drawn with a gray line. Openings in the slab are also represented with a gray line.

Drawings and Reports Reference Data Guide 504


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of equipment in a plan drawing.

HVAC Plan View Style


Name: HVAC Plan
Description: Drawing layout designed for plan views that focuses on HVAC objects and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns HVAC_Columns.x HVAC


ml Plan_Columns_Horizo
ntal.xml

Columns HVAC_Columns.x HVAC


ml Plan_Columns_Vertical
.xml

Columns HVAC_Columns.x HVAC


ml Plan_Columns_Anchor
_Horizontal.xml

Columns HVAC_Columns.x HVAC

Drawings and Reports Reference Data Guide 505


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


ml Plan_Columns_Anchor
_Vertical.xml

HVAC Parts HVAC_HVAC.xml

HVAC Parts HVAC_HVAC.xml HVAC


Plan_LineNumber_L
ongest Segment.xml

HVAC Parts Normal Clipped HVAC_Normal HVAC


Duct.xml Plan_LineNumber_C
lipped.xml

Ducts Parallel HVAC_HVAC.xml HVAC Plan_Linear


Duct Cross Section
Size.xml

Ducts Parallel, vertical HVAC_HVAC.xml HVAC


Plan_Ducts_Horizontal.
xml

Ducts Parallel, HVAC_HVAC.xml HVAC


horizontal Plan_Ducts_Vertical.x
ml

HVAC HVAC_HVAC.xml
Components

HVAC Parallel, vertical HVAC_HVAC.xml HVAC


Components Plan_Ducts_Horizontal.
xml

HVAC Parallel, HVAC_HVAC.xml HVAC


Components horizontal Plan_Ducts_Vertical.x
ml

Ducts Normal HVAC_HVAC.xml HVAC


Plan_Ducts_Horizontal.
xml

Ducts Normal HVAC_HVAC.xml HVAC


Plan_Ducts_Vertical.x
ml

Duct Supports HVAC_Duct HVAC Plan_Pipe


Supports.xml Support_Name.xml

Grid Line Parallel, vertical HVAC_Grid HVAC Plan_Grid


Line.xml Line_X Name.xml

Grid Line Parallel, HVAC_Grid HVAC Plan_Grid


horizontal Line.xml Line_Y Name.xml

Beams HVAC_Columns.x
ml

Stairs HVAC_Stairs.xml

Drawings and Reports Reference Data Guide 506


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Handrails HVAC_Handrail.xm
l

Graphic Rule
This is an example of the graphic representation of a Column in a drawing.

Dimension Rule
Dimensions all vertical and horizontal columns. Columns are dimensioned as anchors, which
means they are only dimensioned when they are in close proximity to a group of dimensioned
objects. If a column is not close enough to a group of dimensioned objects in a particular
quadrant, it is not dimensioned. Also, if the column is inline with another column that is already
dimensioned, it is not dimensioned.
In the example below, notice how the top left column is not dimensioned because the bottom left
column is dimensioned. Also, the middle columns are not dimensioned because they line up
with the outer columns.

Drawings and Reports Reference Data Guide 507


Orthographic Drawings Reference Data

The left portion of this drawing has been cropped due to size constraints.

Graphic Rule
This is an example of the graphic representation of a Duct with a parallel orientation in a
drawing.

Drawings and Reports Reference Data Guide 508


Orthographic Drawings Reference Data

Label Rule
Each duct is labeled with the cross section size from the model.

Dimension Rule
Horizontal and vertical ducts with Parallel orientations (horizontal and vertical) are dimensioned
to each other. The dimensions are placed in white space on each side of the drawing. Horizontal
ducts are dimensioned vertically, and vertical ducts are dimensioned horizontally. When the
drawing updates, the duct dimensions also dimension to nearby columns, because the columns
are anchored.

Drawings and Reports Reference Data Guide 509


Orthographic Drawings Reference Data

Ducts in HVAC View Styles (Normal Orientation)

Graphic Rule
This is an example of the graphic representation of Ducts with a Normal orientation in a drawing.

Dimension Rule
Ducts that are Normal orientation are dimensioned with the parallel ducts and anchored
columns.

Graphic Rule
This is an example of the graphic representation of HVAC Components in a drawing.

Dimension Rule
The HVAC Components use the same dimension rules as the ducts.

Drawings and Reports Reference Data Guide 510


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of HVAC parts in a drawing.

Label Rule
The longest segment of each HVAC run is labeled. If a HVAC part is clipped, it is labeled with a
leader. None of the HVAC components are labeled. For example, surface mounted and in-line
components are not labeled.

Drawings and Reports Reference Data Guide 511


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of handrails in a plan drawing.

Graphic Rule
This is an example of the graphic representation of a beam in a drawing.

Graphic Rule
This is an example of the graphic representation of stairs in a drawing.

Stairs that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Drawings and Reports Reference Data Guide 512


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of grid lines in a drawing.

Label Rule
Each grid line is labeled. Horizontal grid lines are labeled vertically, while vertical grid lines are
labeled horizontally. The label reports the name of the grids in the model.

X-axis grids Y-axis grids

HVAC and Cable Tray objects that are clipped by a volume are labeled differently than similar
objects that appear inside the volume. Depending on the direction of the HVAC or Cable Tray
objects and the Look Direction of the view, the objects are either labeled on the outside of the
view with a leader, or it is resymbolized. Clipped ducts and cable trays that run perpendicular to
the look direction are resymbolized.

Drawings and Reports Reference Data Guide 513


Orthographic Drawings Reference Data

Front

Clipped

Drawings and Reports Reference Data Guide 514


Orthographic Drawings Reference Data

SM_HVAC_Plan View Style


Name: SM_HVAC_Plan
Description: Plan views that focus on HVAC objects and include background Model.
Intersection Edges: Off
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Grid Line Parallel, vertical SM_HVAC_Plan_ SM_HVAC_Plan_ SM_HVAC_Plan_Grid_


GridLine GridLineX_Name Anchor_Horizontal

Grid Line Parallel, SM_HVAC_Plan_ SM_HVAC_Plan_ SM_HVAC_Plan_Grid_


horizontal GridLine GridLineY_Name Anchor_Vertical

Root SM_HVAC_Plan_BHD
Longitudinal
Bulkhead
Plate Systems

Root SM_HVAC_Plan_BHD
Transverse
Bulkhead
Plate Systems

Root Deck SM_HVAC_Plan_Deck


Plate Systems

Beam and SM_HVAC_Plan_


Profile Edge Profiles
Reinforcement
Root Systems

Equipment SM_HVAC_Plan_Equi
and pment
Furnishing

Ladders SM_HVAC_Plan_
Ladders

Stairs SM_HVAC_Plan_
Stairs

HVAC SM_HVAC_Plan_
HVAC

Drawings and Reports Reference Data Guide 515


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

HVAC Runs SM_HVAC_Plan_


Run_Name

Ducts SM_HVAC_Plan_Duct_
Horizontal

Ducts SM_HVAC_ SM_HVAC_Plan_Duct_


LinearDuct_ Vertical
CrossSectionSize

SM_HVAC_Elevation View Style


Name: SM_HVAC_Elevation
Description: Elevation views that focus on HVAC objects and include background Model
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Grid Line Normal SM_HVAC_Elevation SM_HVAC_Elevation_ SM_HVAC_Elevation_


_ GridLineX_Name Grid_Anchor_
GridLine Horizontal

Grid Plane Parallel, SM_HVAC_Elevation SM_HVAC_Elevation_ SM_HVAC_Elevation_


Horizontal _ GridPlane_Name Grid_Anchor_
GridLine Vertical

Root SM_HVAC_
Longitudinal Elevation_BHD
Bulkhead Plate
Systems

Root Transverse SM_HVAC_


Bulkhead Plate
Systems Elevation_BHD

Root Deck Plate SM_HVAC_


Systems
Elevation_Deck

All Root Profile SM_HVAC_


Systems
Elevation_Profiles

Drawings and Reports Reference Data Guide 516


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Ladders SM_HVAC_Elevation
_
Ladders

Stairs SM_HVAC_Elevation
_
Stairs

HVAC SM_HVAC_Elevation
_
HVAC

HVAC Runs SM_HVAC_Elevation_ SM_HVAC_Elevation_


Run_Name Duct_Horizontal

HVAC Runs SM_HVAC_Elevation_


Duct_Vertical

Ducts SM_HVAC_
LinearDuct_
CrossSectionSize

Instrument View Styles


Topics
Instrument Elevation View Style .................................................... 517
Instrument Isometric View Style .................................................... 534
Instrument Key Plan View Style..................................................... 540
Instrument Overall Key Plan View Style ........................................ 541
Instrument Plan View Style ............................................................ 545

Instrument Elevation View Style


Name: Instrument Elevation
Description: Drawing layout designed for elevation views that focuses on equipment objects
and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Drawings and Reports Reference Data Guide 517


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Instrument_Referenc Instrument


e.xml Elevation_Columns_Horizo
ntal.xml

Columns Instrument_Referenc Instrument


e.xml Elevation_Columns_Ancho
r_Horizontal.xml

Piping Instrument_Instrume Instrument Instrument


Instruments nts.xml Elevation_Piping Elevation_Instruments_Hor
Instruments_Name. izontal.xml
xml

Piping Instrument_Instrume Instrument


Instruments nts.xml Elevation_Instruments_Ver
tical.xml

Piping Instrument_Instrume Instrument


Instruments nts.xml Elevation_Instruments_An
chor_Vertical.xml

Piping Instrument_Instrume Instrument


Instruments nts.xml Elevation_Instruments_An
chor_Horizontal.xml

Piping Parts Instrument


Elevation_Piping.xml

Pipe Supports Instrument_Pipe


Supports.xml

Equipment Instrument_Equipme Instrument


nt.xml Elevation_Equipme
nt_Name.xml

Grid Plane Instrument_Grid Instrument


Line.xml Elevation_Grid
Plane_Name.xml

Grid Line Instrument_Grid Instrument Instrument Elevation_Grid


Line.xml Elevation_Grid Line_Anchor_Vertical.xml
Line_TOS.xml

Beams Instrument_Referenc
e.xml

Stairs Instrument_Stair_Ce
nterline.xml

Ladders Instrument_Ladder.x
ml

Handrails Instrument_Handrail.
xml

Pipes Normal Front Instrument_Normal


Pipe.xml

Drawings and Reports Reference Data Guide 518


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Cable Trays Normal Instrument_CableTr Instrument


ay.xml Elevation_Instruments_An
chor_Horizontal.xml

Cable Trays Normal Instrument_CableTr Instrument


ay.xml Elevation_Instruments_An
chor_Vertical.xml

Cable Trays Parallel, Instrument_CableTr Instrument


vertical ay.xml Elevation_Instruments_An
chor_Horizontal.xml

Cable Trays Parallel, Instrument_CableTr Instrument


horizontal ay.xml Elevation_Instruments_An
chor_Vertical.xml

Conduits Normal Instrument_Normal Instrument


Conduit.xml Elevation_Instruments_An
chor_Horizontal.xml

Conduits Normal Front Instrument_Normal Instrument


Conduit.xml Elevation_Instruments_An
chor_Vertical.xml

Conduits Parallel, Instrument_Conduit_ Instrument


vertical SingleLine.xml Elevation_Instruments_An
chor_Horizontal.xml

Conduits Parallel, Instrument_Conduit_ Instrument


horizontal SingleLine.xml Elevation_Instruments_An
chor_Vertical.xml

Drawings and Reports Reference Data Guide 519


Orthographic Drawings Reference Data

Example

Drawings and Reports Reference Data Guide 520


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of cable trays in an elevation view.

Drawings and Reports Reference Data Guide 521


Orthographic Drawings Reference Data

Dimension Rule
Horizontal cable trays are dimensioned with vertical dimensions, while vertical cable trays are
dimensioned with horizontal dimensions. Cable trays are only dimensioned as anchors, which
means they are only dimensioned when they are in close proximity to a group of dimensioned
objects. If a cable tray is not close enough to a group of dimensioned objects in a particular
quadrant, it is not dimensioned.

Drawings and Reports Reference Data Guide 522


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a conduit in an elevation view.

Drawings and Reports Reference Data Guide 523


Orthographic Drawings Reference Data

Dimension Rule
Horizontal conduits are dimensioned with vertical dimensions, while vertical conduits are
dimensioned with horizontal dimensions. Conduits are only dimensioned as anchors, which
means they are only dimensioned when they are in close proximity to a group of dimensioned
objects. If a conduit is not close enough to a group of dimensioned objects in a particular
quadrant, it is not dimensioned.

Graphic Rule
This is an example of the graphic representation of pipe supports in an elevation view.

Drawings and Reports Reference Data Guide 524


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping instruments in an elevation view.

Label Rule
Every piping instrument is labeled with the corresponding name from the model. If there is not
enough white space for the label, it is placed offset from the piping instrument with a jogged
leader. For an example of the label rule, see the above graphic.

Drawings and Reports Reference Data Guide 525


Orthographic Drawings Reference Data

Dimension Rule
Horizontal and vertical dimensions are placed on all piping instruments. Piping instruments are
also dimensioned as anchors, which means they are dimensioned to other nearby objects. If a
piping instrument is not close enough to a group of dimensioned objects in a particular quadrant,
it is not dimensioned to that group of objects.

Drawings and Reports Reference Data Guide 526


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping parts in an elevation view.

Graphic Rule
This is an example of the graphic representation of a Column in an elevation drawing.

Drawings and Reports Reference Data Guide 527


Orthographic Drawings Reference Data

Dimension Rule
Horizontal dimensions are placed between each column. The dimensions are grouped with the
equipment dimensions that are in the same quadrant.

Graphic Rule
This is an example of the graphic representation of an equipment piece in an elevation drawing.

Label Rule
Every piece of equipment is labeled. The label is placed in the center of the equipment, unless
there is an object already in the center or there is insufficient white space for the label. If the
label cannot be placed on the center of the object, it is placed with a jogged leader.

Drawings and Reports Reference Data Guide 528


Orthographic Drawings Reference Data

Dimension Rule
Dimensions all columns, pipes, and grid lines. Equipment parts are only dimensioned as
anchors, which means they are only dimensioned when they are in close proximity to a group of
dimensioned objects. If an equipment part is not close enough to a group of dimensioned
objects in a particular quadrant, it is not dimensioned.

Drawings and Reports Reference Data Guide 529


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a grid plane in a drawing.

Label Rule
The y-axis of the grid plane is labeled with the name of the grid in the model. For example, see
the above graphic.

Graphic Rule
This is an example of the graphic representation of a handrail in an elevation drawing.

Drawings and Reports Reference Data Guide 530


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of grid lines in an elevation drawing.

Label Rule
All elevation grid lines are labeled with the grid name and elevation distance. For an example,
see the above graphic.

Dimension Rule
All elevation grid lines are dimensioned with other dimensioned objects in the drawing. The
elevation grid line dimensions are anchored and must be dimensioned with other objects, such
as pipes and columns.

Drawings and Reports Reference Data Guide 531


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a beam in an elevation drawing.

Graphic Rule
This is an example of the graphic representation of a ladder in an elevation drawing.

Ladders that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Drawings and Reports Reference Data Guide 532


Orthographic Drawings Reference Data

Graphic Rule
Conduits that are clipped by a volume are labeled differently than other conduits that appear
inside the volume. Clipped conduit features that are directly parallel to the look direction are
resymbolized.

Graphic Rule
This is an example of the graphic representation of stairs in an elevation drawing.

Stairs that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Drawings and Reports Reference Data Guide 533


Orthographic Drawings Reference Data

Instrument Isometric View Style


Name: Instrument Isometric
Description: Drawing layout designed for isometric views that focuses on Instruments and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Equipment Instrument_Equipmen Instrument


t.xml Isometric_Equipment
_Name.xml

Piping Parts Instrument_Piping.xml

Piping Instrument_Piping.xml Instrument


Instruments Isometric_Piping
Instruments_Name.x
ml

Pipe Supports Instrument_Piping.xml

Structure Instrument_Reference
.xml

Cableway Instrument_Reference
.xml

Drawings and Reports Reference Data Guide 534


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of an Equipment component in an isometric
drawing.

Drawings and Reports Reference Data Guide 535


Orthographic Drawings Reference Data

Label Rule
Every piece of equipment is labeled. The label is placed in the center of the equipment, unless
there is an object already in the center or there is insufficient white space for the label. If the
label cannot be placed on the center of the object, it is placed with a jogged leader. In the
example below, the label is placed inside the object without a leader.

Drawings and Reports Reference Data Guide 536


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of structure in an isometric view.

Drawings and Reports Reference Data Guide 537


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping instruments in an isometric view.

Label Rule
Each piping instrument is labeled with the corresponding name from the model.

Graphic Rule
This is an example of the graphic representation of piping parts in an isometric view.

Drawings and Reports Reference Data Guide 538


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of cableway in an isometric view.

Graphic Rule
This is an example of the graphic representation of pipe supports in an isometric view.

Drawings and Reports Reference Data Guide 539


Orthographic Drawings Reference Data

Instrument Key Plan View Style


Name: Instrument Key Plan
Description: Drawing layout designed to place a Key Plan view of all grid systems in the model
and identifies the particular volume displayed in the drawing.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Grid Instrument_Reference
Systems .xml

KEY_PLAN_ Instrument_Focus.xml Instrument Key


FOCUS_ Plan_Focus_Name.x
ELEMENT ml

KEY_PLAN_ Instrument_Reference
ADJACENT_ .xml
ELEMENT

Example

Drawings and Reports Reference Data Guide 540


Orthographic Drawings Reference Data

Instrument Overall Key Plan View Style


Name: Instruments Overall Key Plan
Description: Drawing layout designed for key plan views that focuses on volumes and
equipment and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: True
Intersection Edges: Off
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Beams Parallel Instrument_Reference.


xml

Braces Parallel Instrument_Reference.


xml

Columns Instrument_Reference.
xml

Slabs Instrument_Reference.
xml

Equipment Instrument_Equipment.
xml

Instrument Plan Instrument_Volumes.x Instrument Overall


Volumes ml Key
Plan_Volume_Name
.xml

Control Point Instrument_Control CtrlPtCoord_None_


Mechanical Point.xml CA.xml
Equipment

Control Point Instrument_Control CtrlPtCoord_None_


Process Point.xml CA.xml
Equipment

Drawings and Reports Reference Data Guide 541


Orthographic Drawings Reference Data

Example

Graphic Rule
This is an example of the graphic representation of a beam in a drawing.

Drawings and Reports Reference Data Guide 542


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of braces in a drawing.

Graphic Rule
This is an example of the graphic representation of a Column in a drawing.

Drawings and Reports Reference Data Guide 543


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of slabs in a drawing. The slab boundaries are
drawn with a gray line. Openings in the slab are also represented with a gray line.

Graphic Rule
This is an example of the graphic representation of equipment in a plan drawing.

Drawings and Reports Reference Data Guide 544


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping plan volumes in a drawing.

Label Rule
All drawing key plan volumes are labeled with their 3D model name. By default, the label is
placed in the upper left corner of the volume in the drawing. For an example, see the above
graphic.

Instrument Plan View Style


Name: Instrument Plan
Description: Drawing layout designed for plan views that focuses on Instruments and includes
other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
View Rule: Type1.xml
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Instrument_Reference Instrument


.xml Plan_Columns_Horiz
ontal.xml

Columns Instrument_Reference Instrument


.xml Plan_Columns_Vertic
al.xml

Drawings and Reports Reference Data Guide 545


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Instrument_Reference Instrument


.xml Plan_Columns_Ancho
r_Horizontal.xml

Columns Instrument_Reference Instrument


.xml Plan_Columns_Ancho
r_Vertical.xml

Piping Parts Instrument


Plan_Piping.xml

Pipes Normal Front Instrument_Normal


Pipe.xml

Pipe Instrument
Supports Plan_Piping.xml

Piping Instrument_Instrumen Instrument Instrument


Instruments ts.xml Plan_Piping Plan_Instruments_Ho
Instruments_Name. rizontal.xml
xml

Piping Instrument_Instrumen Instrument


Instruments ts.xml Plan_Instruments_Ver
tical.xml

Equipment Instrument_Equipmen Instrument


t.xml Plan_Equipment_N
ame.xml

Grid Line Parallel, Instrument_Grid Instrument


horizontal Line.xml Plan_Grid Line_Y
Name.xml

Grid Line Parallel, Instrument_Grid Instrument


vertical Line.xml Plan_Grid Line_X
Name.xml

Cableway Instrument_Cableway
Parts s.xml

Cable Trays Parallel, Instrument_Cableway Instrument Instrument


vertical s.xml Plan_Cable Plan_Instruments_Ho
Trays_Name-Eleva rizontal.xml
tion-Width.xml

Cable Trays Parallel, Instrument_Cableway Instrument


horizontal s.xml Plan_Instruments_Ver
tical.xml

Conduit Instrument_Conduit.x
Parts ml

Conduits Parallel, Instrument_Conduit_ Instrument


vertical SingleLine.xml Plan_Instruments_Ho
rizontal.xml

Drawings and Reports Reference Data Guide 546


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Conduits Parallel, Instrument_Conduit_ Instrument


horizontal SingleLine.xml Plan_Instruments_Ver
tical.xml

Beams Instrument_Reference
.xml

Stairs Instrument_Stair.xml

Ladders Instrument_Ladder.x
ml

Control Point Instrument_Control CtrlPtCoord_None_


Mechanical Point.xml CA.xml
Equipment

Control Point Instrument_Control CtrlPtCoord_None_


Process Point.xml CA.xml
Equipment

Drawings and Reports Reference Data Guide 547


Orthographic Drawings Reference Data

Example

Graphic Rule
This is an example of the graphic representation of a Column in a drawing.

Dimension Rule
Dimensions all vertical and horizontal columns. Columns are dimensioned as anchors, which
means they are only dimensioned when they are in close proximity to a group of dimensioned

Drawings and Reports Reference Data Guide 548


Orthographic Drawings Reference Data

objects. If a column is not close enough to a group of dimensioned objects in a particular


quadrant, it is not dimensioned. Also, if the column is inline with another column that is already
dimensioned, it is not dimensioned.
In the example below, notice how the top left column is not dimensioned because the bottom left
column is dimensioned. Also, the middle columns are not dimensioned because they line up
with the outer columns.
The left portion of this drawing has been cropped due to size constraints.

Drawings and Reports Reference Data Guide 549


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of stairs in a drawing.

Stairs that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Graphic Rule
This is an example of the graphic representation of a ladder in a drawing.

Ladders that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Drawings and Reports Reference Data Guide 550


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of grid lines in a drawing.

Label Rule
Each grid line is labeled. Horizontal grid lines are labeled vertically, while vertical grid lines are
labeled horizontally. The label reports the name of the grids in the model.

X-axis grids Y-axis grids

Graphic Rule
This is an example of the graphic representation of an Equipment component in a drawing.

Drawings and Reports Reference Data Guide 551


Orthographic Drawings Reference Data

Label Rule
Every piece of equipment is labeled. The label is placed in the center of the equipment, unless
there is an object already in the center or there is insufficient white space for the label. If the
label cannot be placed on the center of the object, it is placed with a jogged leader. In the
example below, the label from the above graphic is magnified to show the details of the
equipment label.

Pipes that are clipped by a volume are labeled differently than other pipes and pipe parts that
appear inside the volume. Depending on the direction of the pipe and the Look Direction of the
view, a pipe is either labeled on the outside of the view with a leader, or it is resymbolized.
Clipped pipes that run perpendicular to the look direction are labeled with a jogged leader
outside of the drawing volume. Clipped pipes that are directly parallel to the look direction are
resymbolized.

Clipped

Drawings and Reports Reference Data Guide 552


Orthographic Drawings Reference Data

Example of clipping labels fanning out to find white space:

Front

Drawings and Reports Reference Data Guide 553


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a beam in a drawing.

Drawings and Reports Reference Data Guide 554


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of cable trays in a plan view.

Label Rule
Each cable tray is labeled with the corresponding name and elevation value from the model. For
an example, see the above graphic.

Drawings and Reports Reference Data Guide 555


Orthographic Drawings Reference Data

Dimension Rule
Horizontal dimensions are placed on vertical cable trays, while vertical dimensions are placed
on horizontal cable trays. The cable trays are dimensioned to nearby columns. For an example,
see the above graphic.

Pipes that are clipped by a volume are labeled differently than other pipes and pipe parts that
appear inside the volume. Clipped pipes that are directly parallel to the look direction are
resymbolized.

Graphic Rule
This is an example of the graphic representation of cableway parts in a plan view.

Drawings and Reports Reference Data Guide 556


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of conduit parts in a plan view.

Graphic Rule
This is an example of the graphic representation of conduits in a plan view. Conduit straight
features are resymbolized as a solid line.

Drawings and Reports Reference Data Guide 557


Orthographic Drawings Reference Data

Dimension Rule
Horizontal dimensions are placed on vertical conduit features, while vertical dimensions are
placed on horizontal conduit features. Conduits are dimensioned with piping instruments, cable
trays, and columns.

Graphic Rule
This is an example of the graphic representation of pipe supports in a plan view.

Graphic Rule
Pipes with a Normal orientation are included in the view and are resymbolized.

Drawings and Reports Reference Data Guide 558


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping instruments in a plan view.

Label Rule
Each piping instrument is labeled with the corresponding name from the model.

Dimension Rule
Vertical and horizontal dimensions are placed on piping instruments. Piping instruments are also
dimensioned with columns, cable trays, and conduits.

Drawings and Reports Reference Data Guide 559


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping parts in a plan view.

Nozzle View Styles


Name: Nozzle Orientation Plan
Description: Drawing layout designed for plan views that focus on nozzle parts of equipment
objects.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Equipment Nozzle
Orientation_Equipme
nt.xml

Drawings and Reports Reference Data Guide 560


Orthographic Drawings Reference Data

Beams Nozzle
Orientation_Beams.x
ml

Stairs Nozzle
Orientation_Stairs.xml

Handrails Nozzle
Orientation_Handrail.
xml

Ladders Nozzle
Orientation_Ladders.x
ml

Slabs Nozzle
Orientation_Slab.xml

Pipe Nozzle Nozzle Nozzle Orientation


Orientation_Nozzle.x Plan_NozzleLabel.xml
ml

Pipe Nozzle Normal, Nozzle Nozzle Orientation


toward you Orientation_Nozzle.x Plan_Nozzle_TOP_N
ml ame.xml

Pipe Nozzle Normal, away Nozzle Nozzle Orientation


from you Orientation_Nozzle.x Plan_Nozzle_BTM_N
ml ame.xml

Pipe Nozzle Nozzle Nozzle Orientation


Orientation_Nozzle.x Plan_NozzleAngleLab
ml el.xml

Drawings and Reports Reference Data Guide 561


Orthographic Drawings Reference Data

Example

Drawings and Reports Reference Data Guide 562


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of pipe nozzles in a plan view.

Label Rule
Each nozzle is labeled with the corresponding name from the model. The leader line is labeled
with the nozzle orientation angle. For an example, see the above graphic.

Drawings and Reports Reference Data Guide 563


Orthographic Drawings Reference Data

Pipe Supports View Styles


Topics
Pipe Supports - Components View Style ....................................... 564
Pipe Supports - Piping View Style ................................................. 564
Pipe Supports - Structure View Style............................................. 565

Pipe Supports - Components View Style


Name: Pipe Supports - Components
Description: Drawing layout that focuses on support components.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: High Resolution
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Support Pipe Pipe Supports -


Components Supports_Compone Components_Referen
nts.xml ce_Circle_CA_L.xml

Pipe Supports - Piping View Style


Name: Pipe Supports - Piping
Description: Drawing layout that focuses on piping supports and other objects that are
important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Drawings and Reports Reference Data Guide 564


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Structure Pipe
Supports_Structure.x
ml

Control Point Pipe Support_Control Pipe Supports -


Structure Point.xml Piping_Control Point
Structure_North-East
Coordinate.xml

Piping Parts Pipe Pipe Supports -


Supports_Piping.xml Piping_Reference_Circ
le_CA_L.xml

Piping Pipe
Supports_Piping.xml

Supports Pipe
Support_Components
.xml

Pipe Supports - Structure View Style


Name: Pipe Supports - Structure
Description: Drawing layout that focuses on piping supports and other objects that are
important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Structure Pipe Pipe Supports -


Supports_Structure.x Structure_Reference_
ml Circle_CA_L.xml

Control Point Pipe Pipe Supports -


Structure Supports_Control Structure_Control Point
Point.xml Structure_North-East
Coordinate.xml

Piping Pipe
Supports_Reference.
xml

Drawings and Reports Reference Data Guide 565


Orthographic Drawings Reference Data

Supports Pipe
Supports_Component
s.xml

Piping View Styles


Topics
Piping Elevation View Style ........................................................... 566
Piping Elevation Style2 View Style ................................................ 577
Piping Isometric View Style ........................................................... 579
Piping Isometric Detail View Style ................................................. 585
Piping Isometric Key View Style .................................................... 586
Piping Key Plan View Style ............................................................ 587
Piping Overall Key Plan View Style ............................................... 588
Piping Plan View Style ................................................................... 591
Piping Plan Style2 View Style ........................................................ 606
SM_Piping_Plan View Style .......................................................... 607
SM_Piping_Elevation View Style ................................................... 609

Piping Elevation View Style


Name: Piping Elevation
Description: Drawing layout designed for elevation views that focuses on Piping objects and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Piping_Reference.x Piping


ml Elevation_Columns_Ho
rizontal.xml

Columns Piping_Reference.x Piping


ml Elevation_Columns_An
chor_Horizontal.xml

Equipment Piping_Equipment.x Piping


ml Elevation_Equipment

Drawings and Reports Reference Data Guide 566


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


_Name.xml

Equipment Piping_Equipment.x Piping


ml Elevation_Equipment_
Anchor_Horizontal.xml

Equipment Piping_Equipment.x Piping


ml Elevation_Equipment_
Anchor_Vertical.xml

Piping Parts Piping_Piping.xml

Piping Parts Clipped Piping_Piping.xml Piping


Elevation_LineNumbe
r_Clipped.xml

Pipes Parallel, Piping_Piping.xml Piping


vertical Elevation_Pipes_Horiz
ontal.xml

Pipes Parallel, Piping_Piping.xml Piping


horizontal Elevation_Pipes_Vertic
al.xml

Pipes Piping_Piping.xml Piping


Elevation_LineNumbe
r_Longest
Segment.xml

Pipes Normal Piping_Piping.xml Piping


Elevation_Pipes_Horiz
ontal.xml

Pipes Normal Piping_Piping.xml Piping


Elevation_Pipes_Vertic
al.xml

Pipes Normal Front Piping_Normal


Pipe.xml

Grid Plane Piping_Grid Piping Elevation_Grid


Plane.xml Plane_Name.xml

Grid Line Piping_Grid Line.xml Piping Elevation_Grid


Line_TOS.xml

Grid Line Piping_Grid Line.xml Piping Elevation_Grid


Line_Anchor_Vertical.x
ml

Beams Piping_Reference.x
ml

Handrails Piping_Handrail.xml

Ladders Piping_Ladders.xml

Drawings and Reports Reference Data Guide 567


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Stairs Piping_Stairs_Cente
rline.xml

Pipe Nozzle Piping_Equipment


Pipe Nozzle.xml

Example

Drawings and Reports Reference Data Guide 568


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of stairs in an elevation drawing.

Stairs that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Graphic Rule
This is an example of the graphic representation of a Column in an elevation drawing.

Drawings and Reports Reference Data Guide 569


Orthographic Drawings Reference Data

Dimension Rule
Horizontal dimensions are placed between each column. The dimensions are grouped with the
equipment dimensions that are in the same quadrant.

Graphic Rule
This is an example of the graphic representation of an equipment piece in an elevation drawing.

Label Rule
Every piece of equipment is labeled. The label is placed in the center of the equipment, unless
there is an object already in the center or there is insufficient white space for the label. If the
label cannot be placed on the center of the object, it is placed with a jogged leader.

Drawings and Reports Reference Data Guide 570


Orthographic Drawings Reference Data

Dimension Rule
Dimensions all columns, pipes, and grid lines. Equipment parts are only dimensioned as
anchors, which means they are only dimensioned when they are in close proximity to a group of
dimensioned objects. If an equipment part is not close enough to a group of dimensioned
objects in a particular quadrant, it is not dimensioned.

Drawings and Reports Reference Data Guide 571


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of grid lines in an elevation drawing.

Label Rule
All elevation grid lines are labeled with the grid name and elevation distance. For an example,
see the above graphic.

Dimension Rule
All elevation grid lines are dimensioned with other dimensioned objects in the drawing. The
elevation grid line dimensions are anchored and must be dimensioned with other objects, such
as pipes and columns.

Drawings and Reports Reference Data Guide 572


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a grid plane in a drawing.

Label Rule
The y-axis of the grid plane is labeled with the name of the grid in the model. For example, see
the above graphic.

Graphic Rule
This is an example of the graphic representation of a beam in an elevation drawing.

Graphic Rule
This is an example of the graphic representation of a handrail in an elevation drawing.

Drawings and Reports Reference Data Guide 573


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a ladder in an elevation drawing.

Ladders that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Drawings and Reports Reference Data Guide 574


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of pipes in an elevation drawing. Elbows and
surface-mounted components are not included in the delivered Pipes filter.

Dimension Rule
Horizontal and vertical pipes are dimensioned to each other, as well as the piping parts and
other objects in the drawing. The dimensions are placed in white space on each side of the
drawing. Horizontal pipes are dimensioned vertically, and vertical pipes are dimensioned
horizontally. For example, see the above graphic.

Drawings and Reports Reference Data Guide 575


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping parts in an elevation drawing.

Label Rule
The longest segment of each pipe run is labeled. If a pipe is clipped, it is labeled with a leader.
None of the piping components (except for the pipes) are labeled. For example, surface
mounted components and elbows are not labeled.

Drawings and Reports Reference Data Guide 576


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of stairs in an elevation drawing.

Stairs that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Piping Elevation Style2 View Style


Name: Piping Elevation Style2
Description: Drawing layout designed for elevation views that focuses on Piping objects and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Drawings and Reports Reference Data Guide 577


Orthographic Drawings Reference Data

 The dimPerimterOffset value is defined by the view style’s grid label rule, if available.
 If there is no grid label rule, this view style uses the dimPerimeterOffset value as defined
by the label rule closest to the right and bottom side of the drawing view. Generate and open
the drawing to see which label rule is in the rightmost and bottommost position, and edit that
label rule’s .xml file to use its dimPerimeterOffset value. If this label rule has dimension
set to 0, and if dimPerimeterOffset is not defined, the dimPerimeterOffset value is defined
as half of the perimeterOffset value.

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Piping_Reference.xml

Columns Piping_Reference.xml

Equipment Piping_Equipment.xml Piping


Elevation_Equipment
_Name Style2.xml

Equipment Piping_Equipment.xml

Equipment Piping_Equipment.xml

Piping Parts Piping_Piping.xml

Piping Parts Clipped Piping_Piping.xml Piping


Elevation_LineNumbe
r_Clipped Style2.xml

Pipes Parallel, Piping_Piping.xml Piping


vertical Elevation_LineNumbe
r_Style2.xml

Pipes Parallel, Piping_Piping.xml Piping


horizontal Elevation_LineNumbe
r_Style2.xml

Pipes Normal Front Piping_Normal Pipe.xml Piping


Plan_LineNumber_Cli
pped Style2.xml

Grid Plane Piping_Grid Plane.xml Piping Elevation_Grid


Plane_Name
Style2.xml

Grid Line Piping_Grid Line.xml Piping Elevation_Grid


Line_TOS Style2.xml

Beams Piping_Reference.xml

Handrails Piping_Reference.xml

Ladders Piping_Ladders.xml

Stairs Piping_Stairs_Centerline
.xml

Drawings and Reports Reference Data Guide 578


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Pipe Nozzle Piping_Equipment Pipe


Nozzle.xml

Piping Isometric View Style


Name: Piping Isometric
Description: Drawing layout designed for isometric views that focuses on Piping objects and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Equipment Piping_Equipment.xml Piping


Isometric_Equipment
_Name.xml

Piping Parts Piping_Piping.xml

Piping Parts Piping_Piping.xml Piping


Isometric_LineNumbe
r_Longest
Segment.xml

Members Piping_Members.xml

Equipment Piping_Foundations.xm
Foundations l

Footings Piping_Foundations.xm
l

Pipe Nozzle Piping_Equipment Pipe


Nozzle.xml

Drawings and Reports Reference Data Guide 579


Orthographic Drawings Reference Data

Example

Drawings and Reports Reference Data Guide 580


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of equipment foundations in an isometric
drawing.

Graphic Rule
This is an example of the graphic representation of an Equipment component in an isometric
drawing.

Drawings and Reports Reference Data Guide 581


Orthographic Drawings Reference Data

Label Rule
Every piece of equipment is labeled. The label is placed in the center of the equipment, unless
there is an object already in the center or there is insufficient white space for the label. If the
label cannot be placed on the center of the object, it is placed with a jogged leader. In the
example below, the label is placed inside the object without a leader.

Drawings and Reports Reference Data Guide 582


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of members in an isometric drawing.

Drawings and Reports Reference Data Guide 583


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping parts in an isometric drawing.

Label Rule
The longest segment of each pipe run is labeled. If a pipe is clipped, it is labeled with a leader.
None of the piping components (except for the pipes) are labeled. For example,
surface-mounted components and elbows are not labeled.

Drawings and Reports Reference Data Guide 584


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of footings in an isometric drawing.

Piping Isometric Detail View Style


Name: Piping Isometric Detail
Description:
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Equipment Piping_Equipment.xm Piping Isometric


l Detail_Equipment_Na
me.xml

Piping Parts Piping_Piping.xml

Piping Parts Piping_Small


equal to or Pipe_SingleLine.xml
less than 2in
NPD

Piping Parts Piping_Small


equal to or Components.xml
less than 2in
NPD-2

Members Piping_Members.xml

Drawings and Reports Reference Data Guide 585


Orthographic Drawings Reference Data

Equipment Piping_Foundations.x
Foundations ml

Footings Piping_Foundations.x
ml

Piping Isometric Key View Style


Name: Piping Isometric Key
Description: Orthographic view style used with the Piping Isometric Key Plan view style.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None
This view style is used exclusively with the Piping Isometric Key key plan view style.
For more information, see Key Plan View Styles (on page 373).
For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Beams Piping_Members_Lin
e.xml

Columns Piping_Members_Lin
e.xml

Process Piping_Process
Vessel Vessel.xml

Key Plan Piping_Focus.xml Piping Isometric


Focus Key_Focus_Name.xml
Element

Drawings and Reports Reference Data Guide 586


Orthographic Drawings Reference Data

Piping Key Plan View Style


Name: Piping Key Plan
Description: Drawing layout designed to place a Key Plan view of all grid systems in the model
and identifies the particular volume displayed in the drawing.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Grid Piping_Reference.xml
Systems

KEY_PLAN_ Piping_Focus.xml Piping Key


FOCUS_ Plan_Focus_Name.xml
ELEMENT

KEY_PLAN_ Piping_Reference.xml
ADJACENT_
ELEMENT

Example

Drawings and Reports Reference Data Guide 587


Orthographic Drawings Reference Data

Piping Overall Key Plan View Style


Name: Piping Overall Key Plan
Description: Drawing layout designed for a key plan view that focuses on volumes and
equipment and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: True
Intersection Edges: Off
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Beams Parallel Piping_Reference.x


ml

Braces Parallel Piping_Reference.x


ml

Columns Piping_Reference.x
ml

Equipment Piping_Equipment.x
ml

Piping Plan Piping_Volumes.xml Piping Overall Key


Volumes Plan_Volume_Name.xml

Slabs Piping_Reference.x
ml

Control Point Piping_Control CtrlPtCoord_None_CA.x


Mechanical Point.xml ml
Equipment

Control Point Piping_Control CtrlPtCoord_None_CA.x


Process Point.xml ml
Equipment

Drawings and Reports Reference Data Guide 588


Orthographic Drawings Reference Data

Example

Graphic Rule
This is an example of the graphic representation of equipment in a plan drawing.

Drawings and Reports Reference Data Guide 589


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping plan volumes in a drawing.

Label Rule
All drawing key plan volumes are labeled with their 3D model name. By default, the label is
placed in the upper left corner of the volume in the drawing. For an example, see the above
graphic.

Graphic Rule
This is an example of the graphic representation of slabs in a drawing. The slab boundaries are
drawn with a gray line. Openings in the slab are also represented with a gray line.

Drawings and Reports Reference Data Guide 590


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a Column in a drawing.

Piping Plan View Style


Name: Piping Plan
Description: Drawing layout designed for plan views that focuses on Piping objects and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type2.xml
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Piping_Reference.xml Piping


Plan_Columns_Anchor_H
orizontal.xml

Columns Piping_Reference.xml Piping


Plan_Columns_Anchor_V
ertical.xml

Columns Piping Piping


Plan_Reference.xml Plan_Columns_Vertical.x
ml

Columns Piping_Reference.xml Piping


Plan_Columns_Horizontal
.xml

Equipment Piping_Equipment.xml Piping Plan


Equipment
Name.xml

Equipment Piping_Equipment.xml Piping

Drawings and Reports Reference Data Guide 591


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


Plan_Equipment_Anchor
_Horizontal.xml

Equipment Piping_Equipment.xml Piping


Plan_Equipment_Anchor
_Vertical.xml

Piping Parts Piping_Piping.xml

Piping Parts Not Piping_Piping.xml Piping


Clipped Plan_LineNumber
_Longest
Segment.xml

Piping Parts Clipped Piping_Piping.xml Piping


Plan_LineNumber
_Clipped.xml

Pipes Parallel, Piping_Piping.xml Piping


vertical Plan_Pipes_Horizontal.x
ml

Pipes Parallel, Piping_Piping.xml Piping


horizontal Plan_Pipes_Vertical.xml

Pipes Normal Piping_Piping.xml Piping


Plan_Pipes_Horizontal.x
ml

Pipes Normal Piping_Piping.xml Piping


Plan_Pipes_Vertical.xml

Pipes Normal Front Piping_Normal Pipe.xml

Grid Line Parallel, Piping_Grid Line.xml Piping Plan_Grid


horizontal Line_Y Name.xml

Grid Line Parallel, Piping_Grid Line.xml Piping Plan_Grid


vertical Line_X Name.xml

Beams Piping_Beams.xml

Stairs Piping_Stairs.xml

Ladders Piping_Ladders.xml

Drawings and Reports Reference Data Guide 592


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Control Point Piping_Control Point.xml CtrlPtCoord_None


Mechanical _CA.xml
Equipment

Control Point Piping_Control Point.xml CtrlPtCoord_None


Process _CA.xml
Equipment

Support Piping_Reference.xml Piping Plan_Pipe


Assembly Support_Name.x
ml

Piping Piping_Instruments.xml Electrical


Instruments Instrument
Plan_Instrument_
Name.xml

Pipe Nozzle Piping_Equipment Pipe


Nozzle.xml

Drawings and Reports Reference Data Guide 593


Orthographic Drawings Reference Data

Example

Drawings and Reports Reference Data Guide 594


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a beam in a drawing.

Graphic Rule
This is an example of the graphic representation of a Column in a drawing.

Drawings and Reports Reference Data Guide 595


Orthographic Drawings Reference Data

Dimension Rule
Vertical and horizontal dimensions are placed between each beam.

Graphic Rule
This is an example of the graphic representation of an Equipment component in a drawing.

Drawings and Reports Reference Data Guide 596


Orthographic Drawings Reference Data

Label Rule
Every piece of equipment is labeled. The label is placed in the center of the equipment, unless
there is an object already in the center or there is insufficient white space for the label. If the
label cannot be placed on the center of the object, it is placed with a jogged leader. In the
example below, the label from the above graphic is magnified to show the details of the
equipment label.

Drawings and Reports Reference Data Guide 597


Orthographic Drawings Reference Data

Dimension Rule
Vertical and horizontal dimensions are placed on the equipment components. The equipment is
also dimensioned to nearby columns in the volume.

Drawings and Reports Reference Data Guide 598


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of grid lines in a drawing.

Label Rule
Each grid line is labeled. Horizontal grid lines are labeled vertically, while vertical grid lines are
labeled horizontally. The label reports the name of the grids in the model.

X-axis grids Y-axis grids

Drawings and Reports Reference Data Guide 599


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a ladder in a drawing.

Ladders that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Graphic Rule
This is an example of the graphic representation of pipes in a drawing. Elbows and
surface-mounted components are not included in the delivered Pipes filter.

Drawings and Reports Reference Data Guide 600


Orthographic Drawings Reference Data

Left portion of the sample drawing:

Drawings and Reports Reference Data Guide 601


Orthographic Drawings Reference Data

Right portion of the sample drawing:

Dimension Rule
Horizontal and vertical pipes are dimensioned to each other, as well as the piping parts and
other objects in the drawing. The dimensions are placed in white space on each side of the
drawing. Horizontal pipes are dimensioned vertically, and vertical pipes are dimensioned
horizontally. For examples, see the above graphics.

Drawings and Reports Reference Data Guide 602


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of piping parts in a drawing.

Drawings and Reports Reference Data Guide 603


Orthographic Drawings Reference Data

Label Rule
The longest segment of each pipe run is labeled. If a pipe is clipped, it is labeled with a leader.
None of the piping components (except for the pipes) are labeled. For example,
surface-mounted components and elbows are not labeled.

Graphic Rule
This is an example of the graphic representation of stairs in a drawing.

Stairs that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Pipes that are clipped by a volume are labeled differently than other pipes and pipe parts that
appear inside the volume. Depending on the direction of the pipe and the Look Direction of the
view, a pipe is either labeled on the outside of the view with a leader, or it is resymbolized.
Clipped pipes that run perpendicular to the look direction are labeled with a jogged leader
outside of the drawing volume. Clipped pipes that are directly parallel to the look direction are
resymbolized.

Clipped

Drawings and Reports Reference Data Guide 604


Orthographic Drawings Reference Data

Example of clipping labels fanning out to find white space:

Front

Drawings and Reports Reference Data Guide 605


Orthographic Drawings Reference Data

Piping Plan Style2 View Style


Name: Piping Plan Style2
Description: Drawing layout designed for plan views that focuses on Piping objects and
includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).
 The dimPerimterOffset value is defined by the view style’s grid label rule, if available.
 If there is no grid label rule, this view style uses the dimPerimeterOffset value as defined
by the label rule closest to the right and bottom side of the drawing view. Generate and open
the drawing to see which label rule is in the rightmost and bottommost position, and edit that
label rule’s .xml file to use its dimPerimeterOffset value. If this label rule has dimension
set to 0, and if dimPerimeterOffset is not defined, the dimPerimeterOffset value is defined
as half of the perimeterOffset value.

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Piping_Reference.xml

Equipment Piping_Equipment.xml Piping


Plan_Equipment_Na
me_Style2_North-Eas
t Coordinate.xml

Equipment Piping_Equipment.xml Piping


Plan_Equipment_Styl
e2_North-East
Coordinate.xml

Piping Parts Piping_Piping.xml

Piping Parts Clipped Piping_Piping.xml Piping


Plan_LineNumber_Cli
pped Style2.xml

Pipes Parallel, Piping_Piping.xml Piping


vertical Plan_LineNumber_St
yle2.xml

Drawings and Reports Reference Data Guide 606


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Pipes Parallel, Piping_Piping.xml Piping


horizontal Plan_LineNumber_St
yle2.xml

Pipes Normal Front Piping_Normal


Pipe.xml

Grid Line Parallel, Piping_Grid Line.xml Piping Plan_Grid


horizontal Line_Y Name
Style2.xml

Grid Line Parallel, Piping_Grid Line.xml Piping Plan_Grid


vertical Line_X Name
Style2.xml

Beams Piping_Beams.xml

Stairs Piping_Stairs.xml

Ladders Piping_Ladders.xml

Control Point Piping_Control CtrlPtCoord_None_C


Mechanical Point.xml A.xml
Equipment

Control Point Piping_Control CtrlPtCoord_None_C


Process Point.xml A.xml
Equipment

Support Piping_Reference.xml Piping Plan_Pipe


Assembly Support_Name.xml

Piping Piping_Instruments.xml Electrical Instrument


Instruments Plan_Instrument_Na
me.xml

Pipe Nozzle Piping_Equipment Pipe


Nozzle.xml

SM_Piping_Plan View Style


Name: SM_Piping_Plan
Description: Plan views that focus on piping objects and include background Model.
Intersection Edges: High Resolution
View Rule: None
Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).

Drawings and Reports Reference Data Guide 607


Orthographic Drawings Reference Data

 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Grid Line Parallel, vertical SM_Piping_Plan_ SM_Piping_Plan_ SM_Piping_Plan_Grid_


GridLine GridLineX_Name Anchor_Horizontal

Grid Line Parallel, SM_Piping_Plan_ SM_Piping_Plan_ SM_Piping_Plan_Grid_


horizontal GridLine GridLineY_Name Anchor_Vertical

Root SM_Piping_Plan_BHD
Longitudinal
Bulkhead
Plate Systems

Root SM_Piping_Plan_BHD
Transverse
Bulkhead
Plate Systems

Root Deck SM_Piping_Plan_Deck


Plate Systems

Beam and Parallel, vertical SM_Piping_Plan_


Profile Edge Profiles
Reinforcement
Root Systems

Equipment SM_Piping_Plan_
and Equipment
Furnishing

Piping SM_Piping_Plan_
Piping

Pipes Normal Front SM_Piping


Plan_Normal Pipe

Pipes Sloped Clipped SM_Piping


Plan_Normal Pipe

Pipes Parallel, vertical SM_Piping_Plan_Pipes_


Horizontal

Pipes Parallel, SM_Piping_Plan_Pipes_


horizontal Vertical

Drawings and Reports Reference Data Guide 608


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Pipes Normal SM_Piping_Plan_Pipes_


Horizontal

Pipes Normal SM_Piping_Plan_Pipes_


Vertical

Piping Parts Parallel, vertical SM_Piping_Plan_ SM_Piping_Plan_


Piping PipingParts_
RunNameBOP_
LongestSegment

Piping Parts Parallel, SM_Piping_Plan_ SM_Piping_Plan_


horizontal Piping PipingParts_
RunNameBOP_
LongestSegment

Piping Parts Normal SM_Piping_Plan_ SM_Piping_Plan_


Piping PipingParts_
RunNameBOP_
LongestSegment

Piping Parts Sloped SM_Piping_Plan_ SM_Piping_Plan_


Piping PipingParts_
RunNameBOP_
LongestSegment

SM_Piping_Elevation View Style


Name: SM_Piping_Elevation
Description: Elevation views that focus on piping objects and include background Model
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Grid Plane SM_Piping_ SM_Piping_Elevation_ SM_Piping_Elevation_


Elevation Elevation_GridLine GridPlane_Name Grid_
Anchor_Horizontal

Drawings and Reports Reference Data Guide 609


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Root SM_Piping_
Longitudinal Elevation_BHD
Bulkhead Plate
Systems

Root Transverse SM_Piping_


Bulkhead Plate
Systems Elevation_BHD

Root Deck Plate SM_Piping_


Systems
Elevation_Deck

All Root Profile SM_Piping_


Systems
Elevation_Profiles

Equipment and SM_Piping_Elevation


Furnishing _Equipment

Piping SM_Piping_Elevation
_
Piping

Pipes Normal Front SM_Piping Elevation_


Normal Pipe

Pipes Sloped Clipped

Pipes Parallel, SM_Piping_


vertical Elevation_Pipes_
Horizontal

Pipes Parallel, SM_Piping_


horizontal Elevation_Pipes_
Vertical

Pipes Normal SM_Piping_


Elevation_Pipes_
Vertical

Piping Parts Parallel, SM_Piping_ SM_Piping_Elevation_


vertical Elevation_Piping PipingParts_
RunName_
LongestSegment

Drawings and Reports Reference Data Guide 610


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule


(.xml) (.xml) (.xml)

Piping Parts Parallel, SM_Piping_ SM_Piping_Elevation_


horizontal Elevation_Piping PipingParts_
RunName_
LongestSegment

Piping Parts Normal SM_Piping_ SM_Piping_Elevation_


Elevation_Piping PipingParts_
RunName_
LongestSegment

Piping Parts Sloped SM_Piping_ SM_Piping_Elevation_


Elevation_Piping PipingParts_
RunName_
LongestSegment

Piping Parts SM_Piping_ SM_Piping_Elevation_


Elevation_Piping PipingParts_
RunName_
LongestSegment

Topics
Structural Framing Elevation View Style ....................................... 611
Structural Framing Isometric View Style ........................................ 621
Structural Framing Key Plan View Style ........................................ 622
Structural Framing Plan View Styles ............................................. 623

Structural Framing Elevation View Style


Name: Structural Framing Elevation
Description: Drawing layout designed for elevation views that focuses on Structural Framing
objects and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: True
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Structural Structural Framing


Framing_Columns_Line- Elevation_Columns_Se
Widget.xml ction Size.xml

Drawings and Reports Reference Data Guide 611


Orthographic Drawings Reference Data

Columns Structural Structural Framing


Framing_Columns_Line- Elevation_Columns_Ho
Widget.xml rizontal.xml

Beams Parallel, Structural Structural Framing


horizontal Framing_Beams_Line- Elevation_Beams_Sect
Widget.xml ion Size.xml

Braces Parallel Structural Structural Framing


Framing_Braces_Line- Elevation_Braces_Sect
Widget.xml ion Size.xml

Grid Plane Structural Framing_Grid Structural Framing


Plane.xml Elevation_Grid
Plane_Name.xml

Grid Line Structural Framing_Grid Structural Framing


Line.xml Elevation_Grid
Line_TOS.xml

Footings Structural
Framing_Footings

Ladders Structural Structural Framing


Framing_Ladders.xml Elevation_Ladder_Nam
e.xml

Stairs Structural Structural Framing


Framing_Stairs Elevation_Stair_Name.
xml

Grid Plane Structural Framing_Grid Structural Framing


Plane.xml Elevation_Grid
Plane_Name.xml

Drawings and Reports Reference Data Guide 612


Orthographic Drawings Reference Data

Example

Drawings and Reports Reference Data Guide 613


Orthographic Drawings Reference Data

Graphic Rule
Columns are resymbolized as single lines with widgets. The widget rule draws a portion of the
graphic column to show the shape, direction, and thickness. 30 percent of the column's length is
drawn, while 100 percent of the column's height is drawn. The remaining 70 percent of the
column's length is displayed as a single line.
The graphic portion of the column is drawn according to the cardinal point and in relation to the
single line representation of the column. The solid line is always centered, and the graphic
portion aligns accordingly. Also, the graphic representation begins at the origin of the column,
not the center of the column. For example, if a column was modeled from the ground up, the
graphic representation in the model would begin at the bottom of the single line representation.
Hidden lines are drawn with the Dashed style in order to display the orientation of the column.
For an example of the graphic rule, see the example below.

Detailed view of the graphic representation of the column. In this example, the column web
is perpendicular to the looking direction, while the column flanges are parallel. The lines are
drawn to denote the thickness, shape, and orientation of the column.

The graphic is cropped and does not represent the entire solid line style
represented in the original drawing.

Drawings and Reports Reference Data Guide 614


Orthographic Drawings Reference Data

Detail view of hidden line style. In the following example, the column web is parallel to the
looking direction and is hidden by the column flanges. The column web is drawn with a dashed
line style to indicate that it is hidden behind the column flange.

The graphic is cropped and does not represent the entire solid line style
represented in the original drawing.

Label Rule
Each column is labeled with the section size value from the model. The label is placed in the
center of the column offset from the line.

Dimension Rule
Horizontal columns are dimensioned individually and as a group. Each column is dimensioned
to the column next to it, and the chain of dimensions is dimensioned. For an example of column
dimensions, see the example below.

The graphic is cropped and does not represent the entire solid line style
represented in the original drawing.

Drawings and Reports Reference Data Guide 615


Orthographic Drawings Reference Data

Graphic Rule
Beams are resymbolized as single lines with widgets. The widget rule draws a portion of the
graphic beam to show the shape, direction, and thickness. Thirty percent of the beam length is
drawn, 100 percent of the beam height is drawn, and the graphic representation is placed in the
center of the solid line representation. The remaining 70 percent of the beam length is
resymbolized as a single line.
The graphic portion of the beam is drawn according to the cardinal point and in relation to the
single line representation of the beam. The solid line is always centered, and the graphic portion
aligns accordingly.
Hidden lines are drawn with the Dashed line style in order to display the orientation of the beam.
Detailed view of the graphic representation of the beam. In this example, the beam web is
perpendicular to the looking direction, while the beam flanges are parallel. The lines are drawn
to denote the thickness, shape, and orientation of the beam.

Detailed view of hidden line style. In the following example, the beam web is parallel to the
looking direction and is hidden by the beam flanges. The beam web is drawn with a dashed line
style to indicate that it is hidden behind the beam flange.

The graphic is cropped and does not represent the entire solid line style
represented in the original drawing.

Label Rule
Each beam is labeled with the section size from the corresponding model object. The label is
centered and offset from the solid line. See the above graphic for an example of the label rule.
If a beam is fireproofed, a fireproofing spec name follows the section size in the label. If more
than one fireproofing spec has been placed on the beam, the subsequent fireproofing specs are
listed after the first.

Drawings and Reports Reference Data Guide 616


Orthographic Drawings Reference Data

Graphic Rule
Braces are represented as a single line with a widget. The widget rule draws a portion of the
graphic brace to show the shape, direction, and thickness of the brace in the model. Thirty
percent of the brace length is drawn, 100 percent of the brace height is drawn, and the graphic
representation is placed in the center of the solid line representation. The remaining 70 percent
of the brace length is resymbolized as a single line.
The graphic portion of the brace is drawn according to the cardinal point and in relation to the
single line representation of the brace. The solid line is always centered, and the graphic portion
aligns accordingly.
Hidden lines are drawn with the Dashed line style in order to display the orientation of the brace.

Drawings and Reports Reference Data Guide 617


Orthographic Drawings Reference Data

Label Rule
Each brace is labeled with the section size from the corresponding model object. The label is
centered and offset from the solid line. See the above graphic for an example of the label rule.
If a brace has been fireproofed, the fireproofing spec name follows the section size in the label.
If more than one fireproofing spec has been placed on the brace, the subsequent fireproofing
specs are listed after the first.

Graphic Rule
This is an example of the graphic representation of a grid plane in a drawing.

Drawings and Reports Reference Data Guide 618


Orthographic Drawings Reference Data

Label Rule
The y-axis of the grid plane is labeled with the name of the grid in the model. For example, see
the above graphic.

Graphic Rule
This is an example of the graphic representation of grid lines in an elevation drawing.

Label Rule
All elevation grid lines are labeled with the grid name and elevation distance. For an example,
see the above graphic.

Graphic Rule
This is an example of the graphic representation of a footing in a drawing.

Drawings and Reports Reference Data Guide 619


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a ladder in an elevation view.

Ladders that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Label Rule
Stairs are labeled with the name from the model. For an example, see the above graphic.

Graphic Rule
This is an example of the graphic representation of stairs in an elevation drawing.

Stairs that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Label Rule
Stairs are labeled with the name from the model. For an example, see the above graphic.

Drawings and Reports Reference Data Guide 620


Orthographic Drawings Reference Data

Structural Framing Isometric View Style


Name: Structural Framing Isometric
Description: Drawing layout designed for isometric views that focuses on Structural Framing
objects and includes other objects that are important to the discipline.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: Type1.xml
Matchline: None
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Structure Structural
Framing_Reference.xml

Drawings and Reports Reference Data Guide 621


Orthographic Drawings Reference Data

Graphic Rule Example

Structural Framing Key Plan View Style


Name: Structural Framing Key Plan
Description: Drawing layout designed to place a Key Plan view of all grid systems in the model
and identifies the particular volume displayed in the drawing.
Filter Behavior: Spatial
Preserve Z Order: False
Intersection Edges: Off
View Rule: None

Drawings and Reports Reference Data Guide 622


Orthographic Drawings Reference Data

Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Grid Structural
Systems Framing_Reference.
xml

KEY_PLAN_ Structural Structural Framing Key


FOCUS_ Framing_Focus.xml Plan_Focus_Name.xml
ELEMENT

KEY_PLAN_ Structural
ADJACENT_ Framing_Reference.
ELEMENT xml

Example

Structural Framing Plan View Styles


Name: Structural Framing Plan
Description: Drawing layout designed for plan views that focuses on Structural Framing objects
and includes other objects that are important to the discipline.
Intersection Edges: Off
Filter Behavior: Spatial
Preserve Z Order: True
View Rule: Type2.xml

Drawings and Reports Reference Data Guide 623


Orthographic Drawings Reference Data

Matchline: Matchline_None_A.xml
North Arrow: NorthArrow.xml

 For a list of where the delivered XML rule files are located, see Orthographic and Key Plan
View Styles (on page 370).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Columns Structural Structural Framing


Framing_Columns.xml Plan_Columns_Anchor_
Horizontal.xml

Columns Structural Structural Framing


Framing_Columns.xml Plan_Columns_Anchor_
Vertical.xml

Columns Structural Structural Framing


Framing_Columns.xml Plan_Columns_Horizont
al.xml

Columns Structural Structural Framing


Framing_Columns.xml Plan_Columns_Vertical.
xml

Beams Parallel Structural Structural Framing


Framing_Beams_Line. Plan_Beams_Section
xml Size.xml

Beams Parallel, Structural Structural Framing


vertical Framing_Beams_Line. Plan_Beams_Horizontal.
xml xml

Beams Parallel, Structural Structural Framing


horizontal Framing_Beams_Line. Plan_Beams_Vertical.x
xml ml

Braces Parallel Structural Structural Framing


Framing_Braces_Line- Plan_Braces_Section
Widget.xml Size.xml

Braces Parallel, Structural Structural Framing


vertical Framing_Braces_Line- Plan_Braces_Horizontal.
Widget.xml xml

Braces Parallel, Structural Structural Framing


horizontal Framing_Braces_Line- Plan_Braces_Vertical.x
Widget.xml ml

Grid Line Parallel, Structural Structural Framing


vertical Framing_Grid Line.xml Plan_Grid Line_X
Name.xml

Grid Line Parallel, Structural Structural Framing


horizontal Framing_Grid Line.xml Plan_Grid Line_Y
Name.xml

Drawings and Reports Reference Data Guide 624


Orthographic Drawings Reference Data

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Openings Structural
Framing_Openings.xml

Control Structural Structural Framing


Point Framing_Control Plan_Process
Process Point.xml Equipment_North-Eas
Equipment t Coordinate.xml

Equipment Structural
Foundation Framing_Foundation.x
ml

Footings Structural
Framing_Foundation.x
ml

Ladders Structural
Framing_Ladders.xml

Stairs Structural
Framing_Stairs.xml

Equipment Structural Structural Framing Structural Framing


Framing_Process Plan_Process Plan_Equipment_Ancho
Equipment.xml Equipment_North-Eas r_Horizontal.xml
t Coordinate.xml

Equipment Structural Structural Framing


Framing_Process Plan_Equipment_Ancho
Equipment.xml r_Vertical.xml

Control Structural CtrlPtCoord_None_C


Point Framing_Control A.xml
Structure Point.xml

Drawings and Reports Reference Data Guide 625


Orthographic Drawings Reference Data

Example

Drawings and Reports Reference Data Guide 626


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a Column in a drawing.

Dimension Rule
Vertical and horizontal dimensions are placed on all columns. The columns are used as anchors
to other dimension objects, but they are also dimensioned independently. The anchored
dimensions are included in the chains that include braces, beams, and equipment object
dimensions. For an example of column dimensions anchored with other dimensions, see the
example below.

Drawings and Reports Reference Data Guide 627


Orthographic Drawings Reference Data

There are two types of independent dimensions for the columns. First, the columns are
dimensioned to the surrounding columns, giving you a distance between each adjacent column.
Second, the overall distance between the chain of column dimensions is dimensioned. For an
example of the two independent dimension types, see the example below.

Graphic Rule
Beams are represented graphically with a solid line.

Label Rule
Each beam is labeled with the section size of the beam from the model. The label is placed
parallel to the center of the line and is also offset from the line.

Drawings and Reports Reference Data Guide 628


Orthographic Drawings Reference Data

If the beam is fireproofed, the fireproofing spec is listed after the section size. If more than one
fireproofing spec has been placed on the beam, the subsequent fireproofing specs are listed
after the first.

Dimension Rule
Dimensions each horizontal and vertical beam parallel to the looking direction. The dimensions
are grouped into chains in each quadrant of the drawing view.

Graphic Rule
Braces are represented as a single line with a widget. The widget rule draws a portion of the
graphic brace to show the shape, direction, and thickness of the brace in the model. 30 percent
of the brace length is drawn, 100 percent of the brace height is drawn, and the graphic
representation is placed in the center of the solid line representation. The remaining 70 percent
of the brace length is resymbolized as a single line.
The graphic portion of the brace is drawn according to the cardinal point and in relation to the
single line representation of the brace. The solid line is always centered, and the graphic portion
aligns accordingly.
Hidden lines are drawn with the Dashed line style in order to display the orientation of the brace.

Label Rule
Each brace is labeled with the section size from the corresponding model object.

Drawings and Reports Reference Data Guide 629


Orthographic Drawings Reference Data

If a brace has been fireproofed, a fireproofing spec name follows the section size in the label. If
more than one fireproofing spec has been placed on the brace, the subsequent fireproofing
specs are listed after the first.

Dimension Rule
Braces are dimensioned horizontally and vertically. The dimensions are chained to the
surrounding column, grid line, and beam dimensions.

Graphic Rule
This is an example of the graphic representation of grid lines in a drawing.

Label Rule
Each grid line is labeled. Horizontal grid lines are labeled vertically, while vertical grid lines are
labeled horizontally. The label reports the name of the grids in the model.

Drawings and Reports Reference Data Guide 630


Orthographic Drawings Reference Data

X-axis grids Y-axis grids

Graphic Rule
This is an example of the graphic representation of an opening in a plan drawing.

Drawings and Reports Reference Data Guide 631


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a control point with a coordinate label in a
plan drawing.

Label Rule
Control points are resymbolized and are labeled with a North-East coordinate label, which
indicates the position in the model.

Graphic Rule
This is an example of the graphic representation of a footing in a plan drawing.

Drawings and Reports Reference Data Guide 632


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of equipment in a plan drawing.

Label Rule
Equipment control points (typically the origin) are resymbolized and are labeled with a
coordinate North-East label.

Graphic Rule
This is an example of the graphic representation of an equipment foundation in a plan drawing.

Drawings and Reports Reference Data Guide 633


Orthographic Drawings Reference Data

Graphic Rule
This is an example of the graphic representation of a ladder in a drawing.

Ladders that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Graphic Rule
This is an example of the graphic representation of stairs in a drawing.

Stairs that are partially included in a volume are not clipped. The entire object is
included in the drawing unless you set the Clipping property.

Drawings and Reports Reference Data Guide 634


Orthographic Drawings Reference Data

Layout Style Rules in Orthographic Drawings


Layout style rules define how the number of views per region in an orthographic drawing
document. You use Tools > Define Layout Template in the Drawings and Reports task to
create new layout styles. You also specify layout styles when you place regions using Place
Region in SmartSketch Drawing Editor. For more information on using these commands,
see the Orthographic Drawings User's Guide and the SmartSketch Drawing Editor Help.
The software populates the views within a region from bottom-to-top and left-to-right across the
region.

Layout Styles Purpose

Eight View

Five View A

Five View B

Four View A

Four View B

Drawings and Reports Reference Data Guide 635


Orthographic Drawings Reference Data

Four View C

Four View D

Seven View A

Seven View B

Single View

Six View A

Six View B

Drawings and Reports Reference Data Guide 636


Orthographic Drawings Reference Data

Six View C

Six View D

Ten View

Three View A

Three View B

Two View A

Drawings and Reports Reference Data Guide 637


Orthographic Drawings Reference Data

Two View B

Layout styles use a processor DLL that defines how the rule behaves within the software. For
orthographic drawings, the delivered DefaultLayoutProcessor.dll is the only processor used.
This processor allows you to choose a predefined arrangement of views to be aligned and
managed inside a region. Some of the delivered examples are four views arranged in a
checkerboard fashion, four tall views aligned vertically, and four wide views aligned horizontally.
Other delivered examples increase the number of views, using similar arrangements. If you
define the region to have a layout style for four views, but you attempt to place six views within
the region, the software moves the extra drawing views to an unmanaged area of the drawing
sheet, outside the region.
See Also
Orthographic Drawings Reference Data (on page 321)

Drawings and Reports Reference Data Guide 638


SECTION 5

Isogen Isometric Drawings Reference


Data
Reference data defines various extraction settings for each isometric drawing style. The
reference data also allows you to specify the locations for the style option database files,
backing sheets, and Intergraph option files.

Bulkloading
The BulkLoadIsoKeys.xls workbook contains the reference data for isometric drawings within
the Drawings and Reports task. The sheets that are unique to BulkLoadIsoKeys.xls are
described below. For more information on common sheets, see the Reference Data Guide.
PipeMfgRules Sheet
This sheet lists isometric drawing extraction styles and drawing output locations. This sheet
contains information about the databases and XML files that store the isometric drawing
options. For more information, see PipeMfgRules Sheet (on page 642).
PipeMfgMapSymbol Sheet
In previous versions, this sheet mapped the symbol key information between ISOGEN and
Smart 3D. You map the symbol keys using the Isometric Style Options Browser in the
software. For more information, see PipeMfgMapSymbol Sheet (on page 642).
PipeMfgSpoolRule Sheet
You set these options when you run the spooling commands in the Piping task. For more
information, see PipeMfgSpoolRule Sheet (on page 643).

Customizable Piping Isometric Deliverables


You can customize your Isogen isometric drawings by understanding and modifying the
delivered packages, components, and Isometric styles. For more information on setting up
Isogen isometric drawings, see the Isogen Isometric Drawing User's Guide.

Isometric Drawing Styles


Isometric drawing styles control several aspects of the isometric drawing output, including the
output location and the type of object used for drawing creation. Each drawing style is also
associated with a set of options and a backing sheet.
To customize the isometric drawing styles for your company, you can copy and then modify the
delivered isometric drawing styles.
The delivered isometric drawing styles are Iso_Pipeline, Iso_Piperun, Iso_Spool,
Iso_PenSpool, Iso_WBS, Iso_Stress, Iso_System, Iso_HVAC, and Iso_Cableway. Each
delivered style has an associated XML file and IGR file. The XML file contains the isometric
options, and the IGR file is the backing sheet for the isometric drawing. They are delivered on
the [Reference Data Folder]\SharedContent\PmfgIsoStyleData folder.

Drawings and Reports Reference Data Guide 639


Isogen Isometric Drawings Reference Data

 Iso_Pipeline - Creates a final isometric drawing used to construct the plant. This style
creates one drawing per pipeline system. This drawing style is an example of a potential
configuration for a fabrication isometric. It includes a material list.
 Iso_Piperun - Creates a draft of an isometric drawing for checking against project
guidelines. This style creates one drawing per pipe run. This drawing style is an example of
a drawing configuration used for checking pipeline designs prior to extracting the fabrication
isometric.
 Iso_Spool - Creates an isometric drawing used in the fabrication shop to manufacture the
pipe. This style uses piping spools. You can create spools using the Generate Spools
command in the Piping task. Like the final isometric style, it includes a material list.
 Iso_PenSpool - Creates an isometric drawing that documents penetration spools that
consist of a penetration plate and several piping spools. This style creates one drawing per
penetration spools. You can create penetration spools using the Create Penetration
Spools command in the Piping task.
 Iso_WBS - Creates an isometric drawing that documents a collection of parts that are
assigned to one Work Breakdown Structure (WBS) item of the type Group Iso Drawing.
This style creates one drawing per WBS item.
 Iso_Stress - Creates a Piping Component File (PCF) that can be output to the CAESAR II
pipe stress analysis software. No drawing is created. To save the PCF file, use the Save As
command. For more information, see Create a piping component file (PCF) in the Isogen
Isometric Drawings User's Guide, accessible from the Help > Printable Guides command.
 Iso_System - Creates an isometric drawing that documents a system, typically a piping
system of connected pipelines. This drawing style creates one drawing for each system.
Each pipeline change is called out on the drawing.
 Iso_HVAC - Creates an isometric drawing that documents duct systems within the model. A
duct system organizes a collection of duct runs.
 Iso_Cabletray - Creates an isometric drawing that documents cableway.
You can create other isometric drawing styles, such as a Bid style for construction contractors to
bid on a project.

Extraction Rules
 Pipeline Extraction Rule - In the PipeLineIso extraction rule, RuleProgID is set to
PMfgIsoExtractionRule.PipeLineIso. This creates a drawing based on a pipeline.
 PipeRun Extraction Rule - In the PipeRunIso extraction rule, RuleProgID is set to
PMfgIsoExtractionRule.PipeRunIso. This creates a drawing based on a pipe run.
 Spool Extraction Rule - In the SpoolIso extraction rule, RuleProgID is set to
PMfgIsoExtractionRule.SpoolIso. This creates a drawing based on a spool.
 PenSpool Extraction Rule - In the PenspoolIso extraction rule, RuleProgID is set to
PMfgIsoExtractionRule.PenspoolIso. This creates a drawing based on a penetration
spool.
To get the right drawing output, the S3D.Drawing.DrawingClass style setting
must be set to Penetration.
 WBS Extraction Rule - In the WBS extraction rule, RuleProgID is set to
PMfgIsoExtractionRule.WBS. This creates a drawing based on a WBS item.

Drawings and Reports Reference Data Guide 640


Isogen Isometric Drawings Reference Data

 System Extraction Rule - In the SystemIso extraction rule, RuleProgID is set to


PMfgIsoExtractionRule.SystemIso. This creates a drawing based on a system (typically a
pipeline system).
 Assembly Extraction Rule - In the AssemblyExtractionRule extraction rule, RuleProgID
is set to AssemblyExtractionRule.AssemblyExtractionRule. This rule creates a drawing
based on an assembly package.

Packages
The delivered Isogen Isometric Drawing packages are located on the SharedContent share in
the [Reference Data Folder]\SharedContent\Drawings\Catalog\Packages folder. You can use
these packages to jump start your Isogen isometric drawing configurations. For more
information, see Isogen Isometric Drawing by Query Packages (on page 645).

Labels, Symbols, and Dimensions


Labels, symbols, and dimensions are used within the Isometric Style and defined as part of the
Edit Options command on the Isogen Isometric Drawing component shortcut menu.

In This Section
Bulkload Files ................................................................................ 641
Isogen Isometric Drawing by Query Packages.............................. 645
Modify an Existing Border File ....................................................... 645
Create a new isometric drawing style ............................................ 646
Import an Existing MicroStation DGN Border ................................ 648
Edit an Isometric Backing Sheet .................................................... 649
Place Piping Isometric Drawings Surface-mounted Components . 649

Bulkload Files
Bulkload files are used to add reference data to the catalog. The reference data includes
codelist values, rule progIDs, symbol file locations, and default values for rule and symbol
parameters. The relationships between different types of reference data are also established.
Each bulkload file is delivered with default values that can be customized. For more information
about bulkloading, see the Reference Data Guide.

Topics
PipeMfgRules Sheet ...................................................................... 642
PipeMfgMapSymbol Sheet ............................................................ 642
PipeMfgSpoolRule Sheet ............................................................... 643
HS_Property_Interface Sheet ........................................................ 644

Drawings and Reports Reference Data Guide 641


Isogen Isometric Drawings Reference Data

PipeMfgRules Sheet
The PipeMfgRules sheet in the BulkLoadIsoKeys.xls workbook shows the isometric drawing
styles defined for the project. It also defines the paths for the isometric drawing output and other
files associated with isometric drawing extraction. The workbook is delivered to the [Product
Folder]\CatalogData\BulkLoad\DataFiles folder and is bulkloaded into the catalog.
IsoNames
Specifies the different isometric drawing styles. The delivered styles are Iso_Pipeline,
Iso_Piperun, Iso_Spool, Iso_PenSpool, Iso_WBS, Iso_Stress, Iso_System, Iso_HVAC, and
Iso_Cableway.
RuleType
Specifies the type of drawing extraction rule applied within the style. To bulkload cable tray
and HVAC isometric drawing types, use the HVAC and CableTray keywords.
RuleProgID
Displays a unique identifier for the drawing extraction rule. Each rule is associated with an
isometric drawing style. For example, the Iso_Pipeline style is associated with the
PMfgIsoExtractionRule.PipeLineIso rule ProgID.
The ProgID is analogous to the Line ID Definition in PDS.
Description
Displays a text description of the rule action.
IsoBackingSheet
Specifies the UNC path to the location for the backing sheet documents.
IngrOption
Specifies the UNC path to the location for the XML files that control the Intergraph options.
See Also
Isogen Isometric Drawings Reference Data (on page 639)

PipeMfgMapSymbol Sheet
The PipeMfgMapSymbol sheet in the BulkLoadIsoKeys.xls workbook shows the symbol
mapping between the application and ISOGEN, which is the third-party software used to create
isometric drawings. The workbook is delivered to the [Product
Folder]\CatalogData\BulkLoad\DataFiles folder and is bulkloaded into the catalog.
MapType
Identifies the map type referenced from the Map Type codelist. For more information, see
the Reference Data Guide available from Help > Printable Guides.
CodeList
Specifies the End Prep Code associated with the Part Class Name.
PartClassName
Identifies the Part Class Name.
SKEY

Drawings and Reports Reference Data Guide 642


Isogen Isometric Drawings Reference Data

Identifies the ISOGEN symbol key.


PCFComponentID
Specifies the Piping Component File (PCF) identification text for the piping component. This
ID must be a valid ISOGEN Component Type Identifier. For more information, see ISOGEN
Symbol Key (SKEY) Definitions.
See Also
Isogen Isometric Drawings Reference Data (on page 639)

PipeMfgSpoolRule Sheet
The PipeMfgSpoolRule sheet in the BulkLoadIsoKeys.xls workbook specifies how the
software breaks pipes into spools. The workbook is delivered to the [Product
Folder]\CatalogData\BulkLoad\DataFiles folder and is bulkloaded into the catalog.
You can also use the spooling commands in the Piping task to specify these rules,
but the changes are not saved to the Catalog or the session file.
Name
Specifies the naming rule for spools.
BreakatUnion
Specifies that the software breaks the spools at unions.
IncludeStubIn
Specifies that a spool can include the stub-in pipe and all the parts of this stub-in branch
until the first spool breaking component is encountered.
IncludeWeldedParts
Includes welded objects, such as pipe hanger or support parts, in the same spool as the
components to which they are welded.
InSituON
Not used.
Updation
Specifies whether or not existing spools are deleted.
The Updation option should always be set to on. It prevents the loss of
existing spools during re-spooling operations. You should only override this option using the
interactive options provided with the commands available in the Piping task.
MaxLength
Provides the maximum length of a spool for oversizing calculation purposes. You should use
ft (feet) for the units. If you specify units other than feet, the software uses meters as the
units.
MaxWidth
Provides the maximum width of a spool for oversizing calculations purposes. You should
use ft (feet) for the units. If you specify units other than feet, the software uses meters as
the units.

Drawings and Reports Reference Data Guide 643


Isogen Isometric Drawings Reference Data

MaxHeight
Provides the maximum height of a spool for oversizing calculation purposes. You should use
ft (feet) for the units. If you specify units other than feet, the software uses meters as the
units.
SequencingType
Not used.
SpoolingBasis
Controls the user interface displayed when spooling operations run. If set to Pipeline, the
software user interface is set to pipeline spooling within the system hierarchy. If set to
Block, the software user interface is set to block spooling within the assembly hierarchy.
The SpoolingBasis option should be set at the beginning of a project and
not changed for the duration of the project.
IgnoreBoundaries
When set to False, the software will not cross the boundary of the pipeline or block. When
set to True, the software will cross the boundary of the pipeline or block for spool generation
until an intrinsic spool break is found. This feature is intended for use when pooling by block.
SpoolBreakByControlPoint
Specifies if spools should break at control points. You can place control points using the
Insert Control Point command in the Piping task. You must set the control point Subtype
to Spool Break in order to use the control point with this option. Select Ignore Control
Points to ignore the control points during spooling. Select Break at Control Points to break
spools at the normal intrinsic line breaks and at control points. Select Break Only at
Control Points to break spools only at control points.
For more information, see Set Isometric break control points for drawings in the Isogen Isometric
Drawings User's Guide.
See Also
Isogen Isometric Drawings Reference Data (on page 639)

HS_Property_Interface Sheet
The HS_Property_Interface sheet in the HS_Property_Interface workbook specifies how the
software loads drawing view overrides. The workbook is delivered to the [Product
Folder]\CatalogData\BulkLoad\DataFiles folder and is bulkloaded into the catalog. The software
loads the following hanger support objects.
 Pipe hanger supports
 Duct hanger supports
 Conduit hanger supports
 Cabletray hanger supports
 Combined hanger supports
 Design hanger supports
Package Name
Specifies the name of the package.

Drawings and Reports Reference Data Guide 644


Isogen Isometric Drawings Reference Data

View _<number>
Specifies the view override. The sheet defines eight overrides. If you need to add overrides,
you must use the same naming rule.
The values from this sheet display on the Drawings tab of the Support Properties
dialog box. You can use this dialog box to specify how drawing by query views display in the
drawing. For more information, see Drawing Tab (Support Properties Dialog Box) in the Hangers
and Supports User's Guide.

Isogen Isometric Drawing by Query Packages


Packages contain definition information for one or more components, plus template and style
definitions. You can create new packages or modify existing packages. Drawing documents are
not saved as part of the package. When you save a package using the Save Package
command in the Drawings and Reports task, you specify where it is saved. You can save the
package on a single drawing, an entire folder, or even the entire root. You can also create your
own tab when you save your packages. The tab displays in the Add Component dialog box of
the New command.
Packages are saved in the [Reference Data Folder]\SharedContent\Drawings\Catalog\Packages
folder. A sub-folder exists for each type of delivered package. When you use the New command
to add a package to the Management Console, each tab of the Add Component dialog box
represents a sub-folder showing the available packages for each drawing type. For example,
you find piping isometric packages on the Isometrics (by Query) tab.
There are several delivered piping isometric drawing by query packages that display on the
Isometrics (by Query) tab:
Iso PenSpool Package (on page 357)
Iso Pipeline Package (on page 357)
Iso Pipeline Manager Package (on page 357)
Iso Spool Package (on page 357)
Iso Spool Manager Package (on page 357)
Iso Stress Package (on page 358)
For more information on adding drawing packages or on customizing isometric styles used with
drawing packages, see the Isogen Isometric Drawings User's Guide.
See Also
Isogen Isometric Drawings Reference Data (on page 639)

Modify an Existing Border File


You can create an isometric drawing border from scratch using SmartSketch Drawing Editor.
You use the commands available within SmartSketch Drawing Editor to place graphics and
create appropriate layers.
You should name new border files with the name of the needed isometric style, such as
Iso_Pipeline or Iso_Piperun.
1. Navigate to [Reference Data Folder]\SharedContent\PmfgIsoStyleData folder, and copy the
appropriate existing border igr file to the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Templates folder. You can create a subfolder for
the new file.

Drawings and Reports Reference Data Guide 645


Isogen Isometric Drawings Reference Data

2. Rename the copied file with the .sha extension.


3. Open the copied .sha files with SmartSketch Drawing Editor.
4. Fit the view.
5. Select Tools > Layers.
The Layer ribbon displays.
6. Select Tools > Display Manager. On the Layers tab, scroll down to see the values
currently set in the .sha file. These are the color, line type, and width values for the named
layers.
7. Make changes as needed, save the file, and exit SmartSketch Drawing Editor. The next time
you use this .sha file as your drawing border template, the graphics will show the changes
you made.

Create a new isometric drawing style


You might require different isometric styles for different types of isometric drawings. You can
add new isometric styles to the delivered BulkLoadIsoKeys.xls and bulk load the changes into
the catalog data for use in Isogen isometric drawings. For more information on the
BulkLoadIsoKeys.xls file, see the Drawings and Reports Reference Data Guide.

Add a New Style to the BulkLoadIsoKeys Spreadsheet


1. In Excel, open the BulkLoadIsoKeys.xls file located in [Product
Folder]\CatalogData\BulkLoad\DataFiles folder.
2. On the PipeMfgRules sheet, select a style row to use as a starting point for your new style.
Right-click the row, and select Copy.
3. Select the End row. Right-click the row, and select Insert Copied Cells.
For example, you might want to create a variation of the existing Iso_Pipeline style called
Iso_Pipeline2. You would select the row containing the delivered Iso_Pipeline style to
copy. In the graphic below, the Iso_Pipeline style entry (Row 6) is copied and modified as
Iso_Pipeline2 (Row 12).

The OutputIsoDrawingLocation column in this spreadsheet is no longer used,


and modifying its values has no effect on the Isogen isometric drawings.
4. Add the letter A to column A for this row. This tells the software to add the row when the file
is bulkloaded.
5. Change the IsoNames entry for your new style. For example, in the previous example, the
name is changed to Iso_Pipeline2.

Drawings and Reports Reference Data Guide 646


Isogen Isometric Drawings Reference Data

6. Change the value in the IsoBackingSheet column for your new style to the location of the
backing sheet to be used with this style. For example, your backing sheet can be specified
as PmfgIsoStyleData\Iso_Pipeline2.sha.
The name of the backing sheet file should match the name of the
IsoNames entry for the new style. As you can see in the example above, the backing sheet
.sha file name matches the IsoNames entry.
7. Change the IngrOption value to the location of the style XML file. For example, your new
style XML file can be specified as pmfgIsoStyleData\Iso_Pipeline2.xml.
As with the IsoBackingSheet entry, the IngrOption style XML file should
use the IsoNames entry as its basename. In this example, the XML file name is
Iso_Pipeline2.xml.
8. Save the BulkLoadIsoKeys.xls file, and close Excel.

Create the Backing Sheet and the Iso Style XML


You must create your backing sheet file for the isometric style and store it in the [Reference
Data Folder]\SharedContent\PmfgIsoStyleData folder.
1. If the new style uses the same backing sheet as another style, you can copy and rename
the existing backing sheet file. In the previous example, if the backing sheets for
Iso_Pipeline and Iso_Pipeline2 are the same, go to the [Reference Data
Folder]\SharedContent\PmfgIsoStyleData folder, and make a copy of Iso_Pipeline.igr.
Rename it to Iso_Pipeline2.igr.
To edit this file, follow the instructions in Edit an Isometric Backing Sheet (on page 649).
2. To create a new Iso Style XML, right-click any Isogen isometric drawing folder in the
Console, and select Edit Options on the shortcut menu. The Isometric Options Browser
displays.
3. Select the top node in the Style hierarchy (the style name), then click Import Data From
File , as shown below:

4. On the Select File to Import dialog box, browse to the [Reference Data
Folder]\SharedContent\PmfgIsoStyleData folder. For example, you could select the
Iso_Pipeline.xml file. Make any changes necessary to the style options shown in the
Isometric Options Browser for the new Iso Style XML. When you are finished, click Save
Style XML File , and save the Iso Style XML to a different name in the [Reference Data
Folder]\SharedContent\PmfgIsoStyleData folder. For example, for the workflow
demonstrated previously, you would save the file as Iso_Pipeline2.xml.
5. After completing the tasks shown above, bulk load the BulkLoadIsoKeys.xls file to update
the model data. Make sure you bulk load using Add/Modify/Delete mode.

Drawings and Reports Reference Data Guide 647


Isogen Isometric Drawings Reference Data

6. To test the new isometric style, switch to the Drawings and Reports task. The new style
should be available when you add a style to an Isometric Piping drawing type.

 For more information on bulk loading files, see the Reference Data Guide.
 It is not recommended to edit XML files in a text editor. However, if you plan to do so,
contact Intergraph Support Services. You can find support information on our web site
http://support.intergraph.com (http://support.intergraph.com/).

Import an Existing MicroStation DGN Border


If you have an existing MicroStation DGN file that is being used as a seed file for a border, you
can re-use it for your isometric drawings.
You should name new border files with the name of the isometric style, such as
Iso_Piperun or Iso_Pipeline.
1. Using MicroStation tools, merge the seed and border file into a single DGN file.
2. Find the size for the required .sha file. For example, you require a C-size to match your
DGN file.
3. Navigate to the [Product Folder]\Common2D\Template folder, and locate the Normal.sha
file.
4. Right-click the file, and select Properties. Remove the read-only flag from the file.
5. Open the Normal.sha file in SmartSketch Drawing Editor.
6. Click File > Sheet Setup, and change the size of the file to match the size of the DGN file.
7. Save and close the file.
8. Open SmartSketch Drawing Editor form the Start menu.
9. Click File > Open, and open the DGN file.
10. Click Edit > Select All to select all the DGN graphics.
11. Click Edit > Cut to remove the DGN graphics from the working sheet.
12. Click View > Background Sheets.
13. Click Edit > Paste to paste the DGN graphics on the background sheet.
14. Remove all extra layers using cmddeletelayer.dll, which is located in the [Product
Folder]\Common2D\Symbol2D\Bin folder. Add this as a custom command. For more
information, see Run a Custom Command in SmartSketch Drawing Editor Help.
15. If needed, change the background color using Tools > Options. Make other changes as
needed.
16. Select View > Working Sheets.
17. Create a layer in the working sheet. For example, you can create a layer named
UserAnnotationLayer.
18. Save the file as a border template .sha file. The MicroStation graphics are saved as part of
the new border template file to be used in the Drawings and Reports task.

Drawings and Reports Reference Data Guide 648


Isogen Isometric Drawings Reference Data

Edit an Isometric Backing Sheet


Personal Isogen requires isometric backing sheets as a starting block for an isometric drawing.
The backing sheet files are SmartSketch Drawing Editor documents. Only use the SmartSketch
Drawing Editor to create or edit the isometric backing sheet files.
When you bulk load an isometric backing sheet file, specify its name with the
extension IGR (.igr). For more information, see Create a new isometric drawing style (on page
646).
The following procedure steps you through creating a new isometric backing sheet from an
existing one.
1. In the [Reference Data Folder]\SharedContent\PmfgIsoStyleData folder, copy an existing
isometric backing sheet file. Rename the copied file using the name of the new style as its
base name. Give the new backing sheet file a .sha extension. For example, if you create a
backing sheet for a style called Iso_Pipeline2, rename the copied backing sheet file
Iso_Pipeline2.sha.
The backing sheet name should always match the name of the isometric style.
2. Open the new backing sheet file using SmartSketch Drawing Editor.
3. Edit the backing sheet as needed, then exit using File > Save.
Do not use File > Save As to save the backing sheet file.
4. Rename the saved file, changing only its file extension to .igr. For example,
Iso_Pipeline2.sha renames to Iso_Pipeline2.igr.
5. Make sure the new backing sheet IGR file is located in the SmartSketch Drawing Editor,
because this is its reference when you bulkload the new isometric style.

Place Piping Isometric Drawings Surface-mounted


Components
Surface-mounted components, such as an ultrasonic flow meter instrument, wrap around a
pipeline instead of splitting the pipeline to insert the component. You can only place a
surface-mounted component on a straight feature, and that feature must be long enough to
allow placement of the component. If it is not, the insertion operation fails.
Because the instrument wraps around the pipeline using banding or bolted clamps, the pipeline
is not shortened or distorted in any way, and it is not reflected as an actual piping connection.
Instead, the software shows the placement point of these instruments with a label or symbol and
its dimensions.
To place a surface-mounted component (an instrument), follow these steps:
1. Bulk load the Sample Data for Surface Mounted Components.xls spreadsheet to the
Catalog. The workbook is delivered to the [Product
Folder]\CatalogData\BulkLoad\SampleDataFiles folder. For information on bulkloading data
to the catalog, see the Reference Data Guide.
2. In the Piping task of the software, click Insert Component .
3. Select a piping feature.

Drawings and Reports Reference Data Guide 649


Isogen Isometric Drawings Reference Data

The Piping ribbons displays.


4. In the Type field, select <Specify Component Tag>.
5. In the Specify Component Tag dialog box, type a tag name for the component.
6. Click Finish to place the component.
The surface-mounted instrument has been attached to the pipe feature.

Drawings and Reports Reference Data Guide 650


SECTION 6

Reports Reference Data


The reports reference data includes a list of the templates associated with reporting in the
software. These templates include label templates, query templates, query parameters
templates, formatting templates, and reports templates.
In the Catalog task, you can view a hierarchy of folders containing the report and label templates
and components.

The hierarchy is derived from the Reports.xls workbook that contains the report reference data.
The workbook is delivered to the [Product Folder]\CatalogData\BulkLoad\DataFiles folder and is
bulkloaded into the catalog.
The Reports\Components category includes the baseline, display, formatting, and query
templates. The Reports\Templates category groups the report templates by discipline.
The Labels category contains the templates for catalog labels, isometric drawing labels, Icarus
cost-estimation labels, and ToolTip labels. For more information on drawing labels, see Labels
(on page 740).

Drawings and Reports Reference Data Guide 651


Reports Reference Data

The report and label templates are available in the [Reference Data
Folder]\SharedContent\Reports folder.
The Reports.xls workbook contains the reference data for reports and labels. The following
sheets in the Reports.xls workbook are used to modify the Reports and Label reference data:
 Reports sheet - Defines the locations of the report and label templates. For more
information, see Report Sheet (on page 652).
 R-Hierachy sheet - Maps parent and child relationships between folders in the Catalog
Reports hierarchy. For more information, see Reference Data Guide.
For more information on modifying sheets, see the Reference Data Guide.

 For information about setting up the reporting databases, see the Intergraph SmartTM 3D
Installation Guide. For more information about running reports while in a 3D task, see the
Common User's Guide.
 The catalog reports hierarchy also controls the display of the Catalog Reports tab on the
Tools > Run Report command in the Common task.
 If you add new part classes after creating the Reports databases, you must re-create the
Reports databases in order to report on the new part classes.
 For more information on using and defining reports, see the Reports User's Guide.

Report Sheet
The Report sheet in the Reports.xls workbook defines the locations for the report and label
templates. The workbook is delivered to the [Product Folder]\CatalogData\BulkLoad\DataFiles
folder and is bulkloaded into the catalog.
The upper portion of this sheet lists the valid report and label templates and descriptions. This
portion is commented out with ! characters at the beginning of each row, so the Bulkload utility
does not read this information.
The left-most column (column A) of the sheet specifies the bulkload action taken with regard to
the row. For example, an A in the column indicates the report or label template is being added;
the letter D specifies the template is deleted; the letter M indicates the template is modified. A !
symbol specifies that the row is ignored during bulkloading.
Name (Column B)
Specifies the report or label template name. This name appears in the XML for the template.
This name must match the name specified on the R-Hierarchy sheet.
Type (Column C)
Specifies the type of template. The types include label templates, query templates, query
parameters templates, report templates, and formatting templates.
Description (Column D)
Provides some descriptive text about the template.
Filename (Column E)
Shows the path to the template.

Drawings and Reports Reference Data Guide 652


Reports Reference Data

The Name column (Column B) includes the hierarchy folders shown in the Catalog task. You
add new report or label templates based on where you want them to be stored within the
hierarchy. To help make the hierarchy easier to read, the Report section of the sheet has a
yellow background, while the Label Template section has a green background.

 For more information on modifying the Reports.xml workbook, refer to the Reference Data
Guide.
 All files must be located in the SharedContent folder for bulkloading to be successful.

Run Time Query Options


In any report query (RQE) file, the following RUN_TIME element displays with ProgID, Action,
and Arg attributes:
<RUN_TIME
Progid=="SP3DRuntimeQuery.CFilterAndDelegate"
Action="ByCommodityClass"
Arg="5"/>
The following ProgIDs are delivered with Smart 3D:
(None) indicates that the software does not support any actions or arguments. The
report ignores any text in these fields.
CDesignedHandrail
A query to extract the Children MemberPart data. There can be multiple children. This
query can also extract other structural data if they are defined in the COM query.
Reports - Structure\Designed Handrails Detailed Properties
Action - (None)
Argument -
CFilterAndDelegate
A query interpreter for filtering pipe parts by commodity class.
Reports - Instrumentation\Control Valves Sorted by Name
Piping\Fittings and Welds Sorted by NPD
Piping\Fittings Material Take-Off in WBS Project
Piping\Insulated Pipe Sorted by Insulation Class
Piping\Nipple Spools Sorted by NPD
Piping\Valves Material Take-Off in WBS Project
Piping\Valves Sorted by NPD
Action - BYCOMMODITYCLASS (default)
Argument - Class codelist values separated by commas
Example - 15,20,25
Action - BYCOMMODITYSUBCLASS
Argument - Subclass codelist values separated by commas
Example - 85,90,95,105,110
Action - BYCOMMODITYCLASSORSUBCLASS
Argument - Class codelist values separated by commas:Subclass codelist values
separated by commas

Drawings and Reports Reference Data Guide 653


Reports Reference Data

Example - 15,20,25:85,90,95,105,110
Action - IFCPART
Argument - A or B
Example - A
Action - BYINSULATEDFEATURE
Argument - (None)
Action - BYINSTRUMENTFUNCTIONALSUBCLASS
Argument - Subclass codelist values separated by commas
Example -
10,45,50,69,75,99,101,105,109,145,147,159,165,168,192,252,258,315,340,345,370
CMATPipingMTO
Reports - SPMaterialMTO\SPMAT Pipe MTO
Action - (None)
Argument -
CPipingMTOInterpreter
A predefined query for piping material take off that extracts all of the properties for the
report. This query eliminates the need to maintain a current list of interfaces in a multi-path
xml definition.
Reports - Piping\Material Take-Off
Action - (None)
Argument -
CQIDistribPartPipePort
A predefined query to extract equipment and related nozzle data for the Equipment Nozzle
Sorted by Nozzle Name report. This query retrieves name and location for objects that
implement IJDistribPartOccur, as well as the associated nozzle locations and orientation.
Reports - Equipment\Nozzle Sorted by Equipment
Action - (None)
Argument -
CQueryInterpreter
This is the default query interpreter.
Reports - All except for those specifically noted elsewhere.
Action - (None)
Argument -
CToDoListEntries
A predefined query to extract the To Do List query of the Diagnostic To Do List Entries
report.
Reports - Diagnostic\3D To Do List Entries
Action - (None) (default)
Argument -
Reports - Diagnostic\3D To Do List Entries Grouped
Action - GROUP
Argument - (None)

Drawings and Reports Reference Data Guide 654


Reports Reference Data

IcarusFittingsData
A predefined query to extract information for the Icarus Fittings report.
Reports - Piping\Fittings - Export to Icarus
Action - (None)
Argument -
WeldData
A predefined query to extract weld information for the Fittings and Welds report.
Reports - Piping\Fittings and Welds Sorted by NPD
Action - (None)
Argument -

Add a Report Template


You can also use this procedure to add label templates.
1. In Excel, open the Reports.xls workbook.
2. Select the Report sheet.
3. Select a row after the Start keyword and within the appropriate hierarchy division, and click
Insert > Rows.
4. In column A, type A to indicate a new report template will be added during the next bulkload.
The left-most column (column A) of the sheet specifies the bulkload action taken
with regard to the row. For example, an A in the column indicates the report or label
template is being added; the letter D specifies the template is deleted; the letter M indicates
the template is modified. A ! symbol specifies that the row is ignored during bulkloading.
5. In the Name column (Column B), type a name for the new report template. Make sure the
name is unique.
6. In the Type column (Column C), specify the type of template. The types include label
templates, query templates, query parameters templates, report templates, and formatting
templates.
7. Include a description for the report or label in the Description column (Column D).
8. Specify the report or label filename and location in the Filename column (Column E).
9. Select the R-Hierarchy sheet.
10. Specify a parent name and child name. The RelationSource name must match the name
specified on the Report sheet.
11. Save the Reports.xls workbook.
12. Bulk load the updated Report.xls workbook.

 All files must be located in the correct SharedContent share for bulkloading to be successful.
 If you add new part classes after creating the reports databases, you must re-create the
reports databases in order to report on the new part classes.

Drawings and Reports Reference Data Guide 655


Reports Reference Data

Create a filter-based report that uses the DrawingMAP


table
It is often necessary to report the name of a drawing that contains equipment in an equipment
location report. The following example query returns the names of all equipment and the
drawings they are contained in. This query can be used in a SQL report.
select
j4.Itemname 'Equipment',j3.Itemname 'Drawing' from
XDrawingMAP X1
join XSheetHasViews x2 on X1.oidorigin = x2.oidorigin
join JDDwgSheet j2 on j2.oid = x2.oiddestination
join JNamedItem j3 on j3.oid = j2.oid
join JNamedItem j4 on j4.oid = X1.oiddestination
where j4.OID in (select oid from JSmartEquipment)
order by Equipment, Drawing

Drawings and Reports Reference Data Guide 656


SECTION 7

Material Handling Drawing View Styles


The material handling mode uses drawings by rule and orthographic drawing reference data, but
also uses material handling-specific view styles. These view styles determine what objects are
included in drawings and how they appear in the drawing. Graphic representation, labels, and
dimensions are used in each view style.
The delivered Material Handling XML rule files are located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules folder.
 The Material Handling-specific view style XML files are located in the MHE_Orthographic
folder.
 The Graphic Rule XML files are located in the GraphicRules folder.
 The Label Rule XML files are located in the LabelRules folder.
 The Dimension Rule XML files are located in the DimensionRules folder.
These view styles use material handling mode specific drawing component XML files located in
the [Reference Data Folder]\SharedContent\Drawings\Catalog folder.
The delivered view styles are customized for the default Drawings and
Reports catalog. If you are using the Smart 3D catalog, you must create filters to suit the
delivered marine view styles or customize the view styles to suit your needed filters. For more
information, see Select Filter Dialog Box (on page 143).
For more information on view style creation, see Drawing View Style Creation Process (on page
371).

In This Section
MHE Plate-Openings View Style ................................................... 658
MHE_Chute System Details .......................................................... 658
MHE_Chute System Isometric View Style ..................................... 659
MHE_InclinedPlateDimensions View Style ................................... 660
MHE_Incremental and Normal Dimensions View Style ................ 661
MHE_Member Openings ............................................................... 661
MHE_Plate Details View Style ....................................................... 662
MHE_Plot Plan View Style ............................................................. 663
MHE_Profile Details View Style ..................................................... 664
MHE_ProfileAndData View Style ................................................... 665
MHE_ProfileAndData_IdlersNormalToBelt View Style .................. 667
MHE_ProfileAssembly_Isometric View Style ................................ 675
MHE_ProfileAssembly_M View Style ............................................ 676
MHE_SketchedFeatures ................................................................ 677
MHE_Site Plan View Style ............................................................. 678

Drawings and Reports Reference Data Guide 657


Material Handling Drawing View Styles

MHE Plate-Openings View Style


Name: MHE Plate-Openings
Description: Drawing layout designed for views that focus on plate openings.
Intersection Edges: Low
Custom Graphic Rule: MHE_Plate Details.xml
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML Rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Plate Parts Parallel, MHE_PlateParts.xml Name_Capsule_CA_JL. MHE_PlateDetails


vertical xml Dimensions.xml

Plate Parts Parallel, MHE_PlateParts.xml Name_Capsule_CA_JL. MHE_PlateDetails


horizontal xml Dimensions.xml

All Openings MHE_Openings.xml NameOpenings_HoleAn MHE_PlateDetails


dSlot.xml Dimensions.xml

MHE_Chute System Details


Name: MHE_Chute System Details
Description: Drawing layout designed for detail views that focus on chute system objects and
includes other objects that are important to the discipline.
Intersection Edges: Low
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML Rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Drawings and Reports Reference Data Guide 658


Material Handling Drawing View Styles

Filter Orientation Clipping Graphic Label Dimension


Rule Rule Rule

Plate Parts MHE_PlateParts.x MHE_PlateDetails


ml Dimensions.xml

Profile Parts MHE_Stiffener.xml ALR_CA_Penetration


Plate.xml

All Openings MHE_Openings.xm


l

Profile Edge MHE_PlateParts.x


Reinforceme ml
nt Parts

Plate Parts Parallel, MHE_PlateParts.x ALR_CA_Penetration


horizontal ml Plate.xml

MHE_Chute System Isometric View Style


Name: MHE_Chute System Isometric
Description: Drawing layout designed for isometric views that focus on chute system objects.
Intersection Edges: Low
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML Rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Plate Parts MHE_Isometric


Profile parts.xml

Profile MHE_Isometric
Parts Profile parts.xml

Collar Parts MHE_Isometric


Profile parts.xml

Drawings and Reports Reference Data Guide 659


Material Handling Drawing View Styles

MHE_InclinedPlateDimensions View Style


Name: MHE_InclinedPlateDimensions
Description: Inclined Dimensions for the Plate.
Intersection Edges: Low Resolution
Graphic Preparation Rules: MHE_Plate Details.xml
View Rule: None
Matchline Rule: None
North Arrow Rule: None

 For a list of where the delivered XML Rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Label Dimension


Rule Rule Rule

Plate Parts Parallel, MHE_Plate MHE_InclinedPlat


vertical Parts.xml e
Details
Dimensions.xml

Plate Parts Parallel, MHE_Plate MHE_InclinedPlat


horizontal Parts.xml e
Details
Dimensions.xml

Plate Parts MHE_Hole


Positioning.xml

All MHE_ NameOpenings


Openings Openings.xml _
HoleAndSlot.xml

Drawings and Reports Reference Data Guide 660


Material Handling Drawing View Styles

MHE_Incremental and Normal Dimensions View Style


Name: MHE_Incremental and Normal Dimensions
Description: Drawing layout designed for plan views that focus on incremental and normal view
dimensions.
Intersection Edges: Low
View Rule: None
Custom Graphic Rule: MHE_Plate Details.xml
Matchline: None
North Arrow: None

 For a list of where the delivered XML Rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Label Dimension


Rule Rule Rule

Plate Parts MHE_Plate MHE_PlateDetails


Parts.xml Dimensions.xml

Plate Parts MHE_Plate MHE_Plate


Parts.xml Incremental
Dimensions.xml

MHE_Member Openings
Name: MHE_Member Openings
Description: Drawing layout designed for views that focus on member openings.
Intersection Edges: Low
Custom Graphic Rule: MHE_Member Details.xml
View Rule: None
Matchline: None
North Arrow: None

 For more information on the location of delivered XML rule files, see Material Handling
Drawing View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Beam Parallel, Structural MHE_PlateDetailsDimensions.xml


vertical Framing_Beam.xml

Beam Parallel, Structural MHE_PlateDetailsDimensions.xml


horizontal Framing_Beam.xml

Drawings and Reports Reference Data Guide 661


Material Handling Drawing View Styles

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Column Parallel, MHE_Structural MHE_PlateDetailsDimensions.xml


vertical Framing_
Columns.xml

Column Parallel, MHE_Structural MHE_PlateDetailsDimensions.xml


horizontal Framing_
Columns.xml

MHE_Plate Details View Style


Name: MHE_Plate Details
Description: Drawing layout designed for detail views that focus on plate objects.
Intersection Edges: Low
Custom Graphic Rule: MHE_Plate Details.xml
View Rule: DefaultViewRule.xml
Matchline: None
North Arrow: None

 For a list of where the delivered XML Rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Plate Parts Parallel, MHE_PlateParts. MHName_Corn MHE_PlateDetails


vertical xml erCut.xml Dimensions.xml

Plate Parts Parallel, MHE_PlateParts. MHName_Corn MHE_PlateDetails


horizontal xml erCut.xml Dimensions.xml

All NameOpenings MHE_PlateDetails


Openings _HoleAndSlot.x Dimensions.xml
ml

Plate Parts MHE_PlateParts. Name_Capsule_


xml CA_JL.xml

Drawings and Reports Reference Data Guide 662


Material Handling Drawing View Styles

MHE_Plot Plan View Style


Name: MHE_Plot Plan
Description: Drawing layout designed for plan views that focus on plot objects.
Intersection Edges: Low
Custom Graphic Rule: Control Point.xml
View Rule: DefaultViewRule
Matchline: None
North Arrow: None

 For a list of where the delivered XML Rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Conveyor Structural_Wall_El
Belt evation.xml

Control ControlPoint.xml Name-Part_None Linear_CA_HV.x


Point _CA_JL.xml ml
Mechanical
Equipment

Equipment MHE-Equipment.x
ml

Column Structural Framing


Elevation_Column
s.xml

Beam Structural Framing


Plan_Beams_Line
.xml

Brace Structural Framing


Plan_Brace_Line.
xml

MHEBelt MHE_Belt Single


Line.xml

Openings Structural Framing


Plan_Openings.x
ml

Drawings and Reports Reference Data Guide 663


Material Handling Drawing View Styles

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Plate Parts MHE_Plate


Details.xml

MHE_Profile Details View Style


Name: MHE_Profile Details
Description: Drawing layout designed for detail views that focus on profile objects.
Intersection Edges: Low
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML Rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Label Dimension


Rule Rule Rule

Profile Parts Parallel, MHE_Stiffner.x Name_Capsule ALR_CA_


vertical ml _ PenetrationPlate.x
CA_JL.xml ml

Profile Parts Parallel, MHE_Stiffner.x ALR_CA_


horizontal ml PenetrationPlate.x
ml

Profile Edge MHE_Stiffner.x ALR_CA_


Reinforceme ml PenetrationPlate.x
nt Parts ml

All Openings MHE_


Openings.xml

Drawings and Reports Reference Data Guide 664


Material Handling Drawing View Styles

MHE_ProfileAndData View Style


Name: MHE_ProfileAndData
Description: Drawing layout that focus on profile data.
Intersection Edges: Low
Custom Graphic Rule: MHE_PDR Elevation.xml
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML Rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Conveyor Structural_Wall_
Belt Elevation.xml

Drive Pulley.xml Elevation.xml


Pulley
Assembly

Drive Pulley.xml Name-Part_Non


Pulley e_CA_JL.xml
Assembly

Dual Three Dual Three Roll


Roll Idler Idler.xml

MHEBelt MHE_Belt Single


Line.xml

Non Drive Pulley.xml Elevation.xml


Pulley
Assembly

Non Drive Pulley.xml Name-Part_Non


Pulley e_CA_JL.xml
Assembly

Single Roll Single Roll Carry


Carry Idler Idler.xml

Single Roll Single Roll


Return Idler Return Idler.xml

Drawings and Reports Reference Data Guide 665


Material Handling Drawing View Styles

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Single Roll Single Roll


Trainer Trainer Return
Return Idler Idler.xml

Three Roll Three Roll Inline


Inline Carry Carry Idler.xml
Idler

Three Roll Three Roll Inline


Inline Trainer Idler.xml
Trainer
Idler

Three Roll Three Roll Offset


Offset Carry Idler.xml
Carry Idler

Three Roll Three Roll Offset


Offset Trainer Idler.xml
Trainer
Idler

Three Roll Three Roll


Suspended Suspended Carry
Carry Idler Idler.xml

Two Roll Two Roll Flat


Flat Return Return Idler.xml
Idler

Two Roll Two Roll Inverted


Inverted Vee Return
Vee Idler Idler.xml

Two Roll Two Roll


Suspended Suspended Vee
Vee Return Return Idler.xml
Idler

Two Roll Two Roll Vee


Vee Return Return Idler.xml
Idler

Plummer Control Point.xml


Block

Drawings and Reports Reference Data Guide 666


Material Handling Drawing View Styles

MHE_ProfileAndData_IdlersNormalToBelt View Style


Name: MHE_ProfileAndData_IdlersNormalToBelt
Description: Drawing layout that focuses on profile data with idlers normal to the belt.
Intersection Edges: Low
Custom Graphic Rule: MHE_PDR Elevation.xml
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML Rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Primary Secondary Graphic Dimension


Filter Orientation Orientation Clipping Rule Label Rule Rule

MHEBelt MHE_Belt
Single Line

Conveyor Structural_
Belt Wall_Eleva
tion.xml

Drive Pulley Head Name-Part_N


Assembly Pulley.xml one_CA_JL.x
ml

Non Drive Tail Name-Part_N


Pulley Pulley.xml one_CA_JL.x
Assembly ml

Dual Three Normal, Dual Three


Roll Idler toward you Roll
Idler.xml

Dual Three Normal, Dual Three


Roll Idler away from Roll Idler-
you LO.xml

Three Roll Normal, Three Roll


Inline Carry toward you Inline Carry
Idler Idler.xml

Drawings and Reports Reference Data Guide 667


Material Handling Drawing View Styles

Primary Secondary Graphic Dimension


Filter Orientation Orientation Clipping Rule Label Rule Rule

Three Roll Normal, Three Roll


Inline Carry away from Inline Carry
Idler you Idler-
LO.xml

Single Roll Normal, Single Roll


Return Idler toward you Return
Idler.xml

Single Roll Normal, Single Roll


Return Idler away from Return
you Idler-
LO.xml

Single Roll Normal, Single Roll


Carry Idler toward you Carry
Idler.xml

Single Roll Normal, Single Roll


Carry Idler away from Carry
you Idler-LO.xm
l

Drive Pulley Head Elevation.xml


Assembly Pulley.xml

Non Drive Tail Elevation.xml


Pulley Pulley.xml
Assembly

Three Roll Normal, Three Roll


Offset Carry toward you Offset
Idler Carry
Idler.xml

Three Roll Normal, Three Roll


Offset Carry away from Offset
Idler you Carry Idler-
LO.xml

Three Roll Normal, Three Roll


Suspended toward you Suspended
Carry Idler Carry
Idler.xml

Drawings and Reports Reference Data Guide 668


Material Handling Drawing View Styles

Primary Secondary Graphic Dimension


Filter Orientation Orientation Clipping Rule Label Rule Rule

Three Roll Normal, Three Roll


Suspended away from Suspended
Carry Idler you Carry
Idler-LO.xm
l

Single Roll Normal, Single Roll


Trainer toward you Trainer
Return Idler Return
Idler.xml

Single Roll Normal, Single Roll


Trainer away from Trainer
Return Idler you Return
Idler-
LO.xml

Two Roll Normal, Two Roll


Flat Return toward you Flat Return
Idler Idle.xml

Two Roll Normal, Two Roll


Flat Return away from Flat Return
Idler you Idle-LO.xml

Two Roll Normal, Two Roll


Inverted Vee toward you Inverted
Idler Vee
Idler.xml

Two Roll Normal, Two Roll


Inverted Vee away from Inverted
Idler you Vee
Idler-LO.xm
l

Two Roll Normal, Two Roll


Suspended toward you Suspended
Vee Return Vee Return
Idler Idler.xml

Two Roll Normal, Two Roll


Suspended away from Suspended
Vee Return you Vee Return
Idler Idler-LO.xm
l

Drawings and Reports Reference Data Guide 669


Material Handling Drawing View Styles

Primary Secondary Graphic Dimension


Filter Orientation Orientation Clipping Rule Label Rule Rule

Two Roll Normal, Two Roll


Vee Return toward you Vee Return
Idler Idler.xml

Two Roll Normal, Two Roll


Vee Return away from Vee Return
Idler you Idler-LO.xm
l

Three Roll Normal, Three Roll


Inline toward you Inline
Trainer Idler Trainer
Idle.xml

Three Roll Normal, Three Roll


Inline away from Inline
Trainer Idle you Trainer
Idle-LO.xml

Three Roll Normal, Three Roll


Offset toward you Offset
Trainer Idler Trainer
Idler.xml

Three Roll Normal, Three Roll


Offset away from Offset
Trainer Idler you Trainer
Idler-LO.xm
l

Five Roll Normal, Five Roll


Impact toward you Offset
Offset Idler Impact
Idler.xml

Five Roll Normal, Five Roll


Impact away from Offset
Offset Idler you Impact
Idler_LO.x
ml

Three Roll Normal, Three Roll


Offset toward you Offset
Impact Idler Impact
Idler.xml

Drawings and Reports Reference Data Guide 670


Material Handling Drawing View Styles

Primary Secondary Graphic Dimension


Filter Orientation Orientation Clipping Rule Label Rule Rule

Three Roll Normal, Three Roll


Offset away from Offset
Impact Idler you Impact
Idler_
LO.xml

Three Roll Normal, Three Roll


Suspended toward you Suspended
Carry Idler Carry Idler
Type 2 Type 2.xml

Three Roll Normal, Three Roll


Suspended away from Suspended
Carry Idler you Carry Idler
Type 2 Type
2_LO.xml

Three Roll Normal, Three Roll


Transition toward you Transition
Carry Idler Carry
Idler.xml

Three Roll Normal, Three Roll


Transition away from Transition
Carry Idler you Carry
Idler_LO.x
ml

Two Roll Normal, Two Roll


Flat Carry toward you Flat Carry
Idler Idler.xml

Two Roll Normal, Two Roll


Flat Carry away from Flat Carry
Idler you Idler_LO.x
ml

Three Roll Normal, Three Roll


Heavy Duty toward you Heavy Duty
Suspended Suspended
Carry Idler Carry
Idler.xml

Drawings and Reports Reference Data Guide 671


Material Handling Drawing View Styles

Primary Secondary Graphic Dimension


Filter Orientation Orientation Clipping Rule Label Rule Rule

Three Roll Normal, Three Roll


Heavy Duty away from Heavy Duty
Suspended you Suspended
Carry Idler Carry
Idler_LO.x
ml

Three Roll Normal, Three Roll


Rigid toward you Rigid
Suspended Suspended
Carry Idler Carry
Idler.xml

Three Roll Normal, Three Roll


Rigid away from Rigid
Suspended you Suspended
Carry Idler Carry
Idler_LO.x
ml

Two Roll V Normal, Two Roll V


Return Idler toward you Return Idler
Type 2 Type 2.xml

Two Roll V Normal, Two Roll V


Return Idler away from Return Idler
Type 2 you Type
2_LO.xml

Two Roll V Normal, Two Roll V


Return Idler toward you Return Idler
Type 3 Type 3.xml

Two Roll V Normal, Two Roll V


Return Idler away from Return Idler
Type 3 you Type
3_LO.xml

Single Roll Normal, Single Roll


Return Idler toward you Return Idler
Type 2 Type 2.xml

Single Roll Normal, Single Roll


Return Idler away from Return Idler
Type 2 you Type
2_LO.xml

Drawings and Reports Reference Data Guide 672


Material Handling Drawing View Styles

Primary Secondary Graphic Dimension


Filter Orientation Orientation Clipping Rule Label Rule Rule

Single Roll Normal, Single Roll


Return Idler toward you Return Idler
Type 3 Type 3.xml

Single Roll Normal, Single Roll


Return Idler away from Return Idler
Type 3 you Type
3_LO.xml

Two Roll Normal, Two Roll


Fixed V Top toward you Fixed V
Mount Top Mount
Return Idler Return
Idler.xml

Two Roll Normal, Two Roll


Fixed V Top toward you Fixed V
Mount Top Mount
Return Idler Return
Idler.xml

Two Roll Normal, Two Roll


Fixed V away from Fixed V
Bottom you Bottom
Mount Mount
Return Idler Return
Idler_LO.x
ml

Two Roll Normal, Two Roll


Fixed V away from Fixed V
Bottom you Bottom
Mount Mount
Return Idler Return
Idler_LO.x
ml

Two Roll Normal, Two Roll


Training toward you Training
Return Idler Return
Idler.xml

Two Roll Normal, Two Roll


Training away from Training
Return Idler you Return
Idler_LO.x
ml

Drawings and Reports Reference Data Guide 673


Material Handling Drawing View Styles

Primary Secondary Graphic Dimension


Filter Orientation Orientation Clipping Rule Label Rule Rule

Three Roll Normal, Three Roll


Flat Reeling toward you Flat
Idler Reeling
Idler.xml

Three Roll Normal, Three Roll


Flat Reeling away from Flat
Idler you Reeling
Idler_
LO.xml

Two Roll Normal, Two Roll


Flat Reeling toward you Flat
Idler Reeling
Idler.xml

Two Roll Normal, Two Roll


Flat Reeling away from Flat
Idler you Reeling
Idler_
LO.xml

Three Roll Normal, Three Roll


Inline Impact toward you Inline
Idler Impact
Idler.xml

Three Roll Normal, Three Roll


Inline Impact away from Inline
Idler you Impact
Idler_
LO.xml

Plumber Control
Block Point.xml

Drawings and Reports Reference Data Guide 674


Material Handling Drawing View Styles

MHE_ProfileAssembly_Isometric View Style


Name: MHE_ProfileAssembly Isometric
Description: Drawing layout designed for isometric views that focus on profile assembly
objects.
Intersection Edges: Off
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML Rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Plate Parts MHE_Isometric


Profile parts.xml

Collar Parts MHE_Isometric


Profile parts.xml

Profile MHE_Isometric
Parts Profile parts.xml

Drawings and Reports Reference Data Guide 675


Material Handling Drawing View Styles

MHE_ProfileAssembly_M View Style


Name: MHE_ProfileAssembly_M
Description: Drawing layout designed for views that focus on profile assembly objects.
Intersection Edges: Low
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML Rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Profile MHE_Stiffner.xml Name-Part_ ALR_CA_


Parts None_CA_JL.x Penetration
ml Plate.xml

Profile MHE_Profile ALR_CA_


Edge parts.xml Penetration
Reinforcem Plate.xml
ent Parts

Collar Parts MHE_Profile


parts.xml

All MHE_ ALR_CA_


Openings Openings.xml Penetration
Plate.xml

Drawings and Reports Reference Data Guide 676


Material Handling Drawing View Styles

MHE_SketchedFeatures
Name: MHE_SketchedFeatures
Description: Drawing layout that focuses on sketched features
Intersection Edges: Low
Custom Graphic Rule: MHE_SketchFeature Details.xml
View Rule: None
Matchline: None
North Arrow: None

 For a list of where the delivered XML rule files are located, see Material Handling Drawing
View Styles (on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Primary Secondary Graphic Label Dimension


Filter Orientation Orientation Clipping Rule Rule Rule

Plate Parts Parallel, MHE_Plat MHE_Plate


vertical eParts Details
Dimensions

Plate Parts Parallel, MHE_Plat MHE_Plate


horizontal eParts Details
Dimensions

Profile Parts Parallel, MHE_ MHE_Plate


Detailed vertical Profile Details
parts Dimensions

Profile Parts Parallel, MHE_ MHE_Plate


Detailed horizontal Profile Details
parts Dimensions

Profile Edge Parallel, MHE_ MHE_Plate


Reinforcement vertical Profile Details
parts parts Dimensions
(Detailed)

Profile Edge Parallel, MHE_ MHE_Plate


Reinforcement horizontal Profile Details
parts parts Dimensions
(Detailed)

Drawings and Reports Reference Data Guide 677


Material Handling Drawing View Styles

Primary Secondary Graphic Label Dimension


Filter Orientation Orientation Clipping Rule Rule Rule

All Sketched MHE_ MHLabe


Features Sketched l
Feature Sketche
d
Feature

MHE_Site Plan View Style


Name: MHE_Site Plan
Description: Drawing layout designed for plan views that focus on site objects.
Intersection Edges: Low
Custom Graphic Rule: MHE_Site Plan.xml
View Rule: None
Matchline: None
North Arrow: MHE_Site Layout_North Arrow.xml

 For a list of delivered XML Rule files locations, see Material Handling Drawing View Styles
(on page 657).
 For more information on the order of the view style filters, see Drawing View Style Creation
Process (on page 371).

Filter Orientation Clipping Graphic Rule Label Rule Dimension Rule

Areas MHE- Name-Part_


Equipment.xml None_CA_JL.x
ml

Conveyor Structural_Wall_
Belt Elevation.xml

MHEBelt MHE_Belt Single


Line.xml

MHE X MHE_Grid MHHorizGrid


Grid Lines Line.xml Coordinate
Label.xml

MHE Y MHE_Grid MHVertGrid


Grid Lines Line.xml Coordinate
Label.xml

Shapes MHE-Shapes.xml Name-Part_


None_CA_
JL.xml

Drawings and Reports Reference Data Guide 678


SECTION 8

Dimensions
In orthographic drawings, dimension rules control the placement of dimensions while dimension
styles control the appearance and the units of measure. However, the rules and styles interact in
complex ways. For more information, see Edit Dimension Styles in the Orthographic Drawings
User's Guide.
In previous versions of Smart 3D, you manually edited an .xml file to modify a dimension rule or
template. The software now provides the Dimension Rule Manager, a graphical user interface
that allows you to edit the available properties for a dimension template. Depending on your
settings for modules and properties in the Dimension Rule Manager, the list of available
properties can change. The Dimension Rule Manager does not save or display properties and
modules that are unavailable for the template you are modifying. For more information, see
Dimension Rule Manager (on page 1503).
There are some dimension rules and templates that the Dimension Rule Manager
does not support. To make changes to these unsupported rules and templates, you must
manually edit the associated .xml file. The .xml files for dimension rules and dimension
templates are delivered in the following locations:
 Dimension rules - [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DimensionRules folder. For more
information, see Dimension Rules (on page 680).
 2D dimension templates - [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates folder. For more
information, see Dimension Templates Overview (on page 694).
 3D manual dimension templates - [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\3D folder. For more information, see
3D Dimensions.
There are two methods you can use to display dimensions in drawings: automatic dimensioning
and manual dimensioning. For automatic dimensioning, the view style controls whether or not
dimensions are placed. For manual dimensioning, you edit an existing drawing and place
dimensions manually.
Assigning dimension units is different for each method. For more information, see Automatic
Dimensioning and Manual Dimensioning in the Smart 3D Orthographic Drawings User's Guide.

 Isometric drawings use the isometric options settings within their style to determine the
dimension appearance, placement, and units. For more information, see Isometric Drawing
Styles in the Smart 3D Piping Isometric Drawings User's Guide.
 The Save As command saves drawings from the database to files and presents additional
considerations about dimensions. The files created by the Save As command can be native
format or a foreign format such as MicroStation or AutoCAD. With the Save As command,
the software attempts to replicate dimensions as they are shown within a drawing. For more
information, see Save As MicroStation or AutoCAD Format in the Smart 3D Orthographic
Drawings User's Guide.

Drawings and Reports Reference Data Guide 679


Dimensions

See Also
Define View Style Command (Tools Menu) (on page 56)
View Style Rules (on page 57)

Dimension Rules
Dimension rules control the appearance and behavior of dimensions as well as their placement
on drawings. You can use the Dimension Rule Manager to edit the delivered dimension rules.
For more information, see Dimension Rule Manager (on page 1503).
You assign dimension rules as part of the drawing view style with the Tools > Define View
Style command in the Drawings and Reports task. For more information, see Define View Style
Command (Tools Menu) (on page 56).
Dimension rules are delivered in the SharedContent folder in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DimensionRules folder.
Each dimension rule uses one or more dimension templates. For more information, see
Dimension Templates Overview (on page 694).
You can use these dimension rules as dimension anchors. For more information, see
Appendix: Migrating Dimension Rules (on page 1722).
The following dimension rules are delivered:

Dimension Rule (.xml) Dimension Templates used in Rule (.xml)

ALR_CA_PenetrationPlate ALR_CA_PenetrationPlate

Civil Plan_Columns_Anchor_Horizontal Civil Plan_Columns_Anchor_Horizontal

Civil Plan_Columns_Anchor_Vertical Civil Plan_Columns_Anchor_Vertical

Civil Plan_Columns_Horizontal Civil Plan_Columns_Horizontal

Civil Plan_Columns_Vertical Civil Plan_Columns_Vertical

Electrical Above Ground Plan_Cable Electrical Above Ground Plan_Cable


Trays_Horizontal Trays_Horizontal

Electrical Above Ground Plan_Cable Electrical Above Ground Plan_Cable


Trays_Vertical Trays_Vertical

Electrical Above Ground Electrical Above Ground


Plan_Columns_Anchor_Horizontal Plan_Columns_Anchor_Horizontal

Electrical Above Ground Electrical Above Ground


Plan_Columns_Anchor_Vertical Plan_Columns_Anchor_Vertical

Electrical Above Ground Electrical Above Ground


Plan_Columns_Horizontal Plan_Columns_Horizontal

Electrical Above Ground Plan_Columns_Vertical Electrical Above Ground

Drawings and Reports Reference Data Guide 680


Dimensions

Dimension Rule (.xml) Dimension Templates used in Rule (.xml)


Plan_Columns_Vertical

Electrical CableTray Electrical CableTray


Elevation_CableTray_Horizontal Elevation_CableTray_Horizontal

Electrical CableTray Electrical CableTray


Elevation_CableTray_Vertical Elevation_CableTray_Vertical

Electrical CableTray Electrical CableTray


Elevation_Columns_Anchor_Horizontal Elevation_Columns_Anchor_Horizontal

Electrical CableTray Electrical CableTray


Elevation_Columns_Horizontal Elevation_Columns_Horizontal

Electrical CableTray Elevation_Grid Electrical CableTray Elevation_Grid


Line_Anchor_Vertical Line_Anchor_Vertical

Electrical CableTray Electrical CableTray


Plan_Beams_Anchor_Vertical Plan_Beams_Anchor_Vertical

Electrical CableTray Plan_Beams_Vertical Electrical CableTray Plan_Beams_Vertical

Electrical CableTray Plan_Cable Electrical CableTray Plan_Cable


Trays_Horizontal Trays_Horizontal

Electrical CableTray Plan_Cable Trays_Vertical Electrical CableTray Plan_Cable


Trays_Vertical

Electrical CableTray Electrical CableTray


Plan_Columns_Anchor_Horizontal Plan_Columns_Anchor_Horizontal

Electrical CableTray Electrical CableTray


Plan_Columns_Anchor_Vertical Plan_Columns_Anchor_Vertical

Electrical CableTray Plan_Columns_Horizontal Electrical CableTray


Plan_Columns_Horizontal

Electrical CableTray Plan_Columns_Vertical Electrical CableTray Plan_Columns_Vertical

Electrical Electrical
Elevation_CableTray_Anchor_Horizontal Elevation_CableTray_Anchor_Horizontal

Electrical Elevation_CableTray_Anchor_Vertical Electrical


Elevation_CableTray_Anchor_Vertical

Electrical Elevation_CableTray_Horizontal Electrical Elevation_CableTray_Horizontal

Electrical Elevation_CableTray_Vertical Electrical Elevation_CableTray_Vertical

Drawings and Reports Reference Data Guide 681


Dimensions

Dimension Rule (.xml) Dimension Templates used in Rule (.xml)

Electrical Elevation_Columns_Anchor_Horizontal Electrical


Elevation_Columns_Anchor_Horizontal

Electrical Elevation_Columns_Horizontal Electrical Elevation_Columns_Horizontal

Electrical Elevation_Grid Line_Anchor_Vertical Electrical Elevation_Grid


Line_Anchor_Vertical

Electrical Equipment Electrical Equipment


Elevation_CableTray_Horizontal Elevation_CableTray_Horizontal

Electrical Equipment Electrical Equipment


Elevation_CableTray_Vertical Elevation_CableTray_Vertical

Electrical Equipment Electrical Equipment


Elevation_Columns_Anchor_Horizontal Elevation_Columns_Anchor_Horizontal

Electrical Equipment Electrical Equipment


Elevation_Columns_Horizontal Elevation_Columns_Horizontal

Electrical Equipment Elevation_Grid Electrical Equipment Elevation_Grid


Line_Anchor_Vertical Line_Anchor_Vertical

Electrical Equipment Plan_Cable Electrical Equipment Plan_Cable


Trays_Horizontal Trays_Horizontal

Electrical Equipment Plan_Cable Trays_Vertical Electrical Equipment Plan_Cable


Trays_Vertical

Electrical Equipment Electrical Equipment


Plan_Columns_Anchor_Horizontal Plan_Columns_Anchor_Horizontal

Electrical Equipment Electrical Equipment


Plan_Columns_Anchor_Vertical Plan_Columns_Anchor_Vertical

Electrical Equipment Plan_Columns_Horizontal Electrical Equipment


Plan_Columns_Horizontal

Electrical Equipment Plan_Columns_Vertical Electrical Equipment Plan_Columns_Vertical

Electrical Raceway Plan_Beams_Anchor_Vertical Electrical Raceway


Plan_Beams_Anchor_Vertical

Electrical Raceway Plan_Beams_Vertical Electrical Raceway Plan_Beams_Vertical

Electrical Raceway Plan_Cable Trays_Horizontal Electrical Raceway Plan_Cable


Trays_Horizontal

Drawings and Reports Reference Data Guide 682


Dimensions

Dimension Rule (.xml) Dimension Templates used in Rule (.xml)

Electrical Raceway Plan_Cable Trays_Vertical Electrical Raceway Plan_Cable


Trays_Vertical

Electrical Raceway Electrical Raceway


Plan_Columns_Anchor_Horizontal Plan_Columns_Anchor_Horizontal

Electrical Raceway Electrical Raceway


Plan_Columns_Anchor_Vertical Plan_Columns_Anchor_Vertical

Electrical Raceway Plan_Columns_Horizontal Electrical Raceway


Plan_Columns_Horizontal

Electrical Raceway Plan_Columns_Vertical Electrical Raceway Plan_Columns_Vertical

Equipment Equipment
Elevation_Columns_Anchor_Horizontal Elevation_Columns_Anchor_Horizontal

Equipment Elevation_Columns_Horizontal Equipment Elevation_Columns_Horizontal

Equipment Equipment
Elevation_Equipment_Anchor_Horizontal Elevation_Equipment_Anchor_Horizontal

Equipment Equipment
Elevation_Equipment_Anchor_Vertical Elevation_Equipment_Anchor_Vertical

Equipment Elevation_Equipment_Horizontal Equipment Elevation_Equipment_Horizontal

Equipment Elevation_Equipment_Vertical Equipment Elevation_Equipment_Vertical

Equipment Elevation_Grid Line_Anchor_Vertical Equipment Elevation_Grid


Line_Anchor_Vertical

Equipment Plan_Columns_Anchor_Horizontal Equipment


Plan_Columns_Anchor_Horizontal

Equipment Plan_Columns_Anchor_Vertical Equipment Plan_Columns_Anchor_Vertical

Equipment Plan_Columns_Horizontal Equipment Plan_Columns_Horizontal

Equipment Plan_Columns_Vertical Equipment Plan_Columns_Vertical

Equipment Plan_Process Equipment_Horizontal Equipment Plan_Process


Equipment_Horizontal

Equipment Plan_Process Equipment_Vertical Equipment Plan_Process


Equipment_Vertical

HgrSup End_Support Assembly Horizontal Style2 HgrSup End_Support Assembly Horizontal

Drawings and Reports Reference Data Guide 683


Dimensions

Dimension Rule (.xml) Dimension Templates used in Rule (.xml)


Style2

HgrSup End_Support Assembly Horizontal HgrSup End_Support Assembly Horizontal


Style2_CP Style2_CP

HgrSup End_Support Assembly Horizontal HgrSup End_Support Assembly Horizontal

HgrSup End_Support Assembly HgrSup End_Support Assembly


KeyPoint_Anchor_Horizontal KeyPoint_Anchor_Horizontal

HgrSup End_Support Assembly HgrSup End_Support Assembly


KeyPoint_Anchor_Vertical KeyPoint_Anchor_Vertical

HgrSup End_Support Assembly Vertical Style2 HgrSup End_Support Assembly Vertical


Style2

HgrSup End_Support Assembly Vertical HgrSup End_Support Assembly Vertical


Style2_CP Style2_CP

HgrSup End_Support Assembly Vertical HgrSup End_Support Assembly Vertical

HgrSup End_Support Component Horizontal HgrSup End_Support Component Horizontal

HgrSup End_Support Component Vertical HgrSup End_Support Component Vertical

HgrSup End_Support Dimension Points HgrSup End_Support Dimension Points


Horizontal Style2 Horizontal Style2

HgrSup End_Support Dimension Points Vertical HgrSup End_Support Dimension Points


Style2 Vertical Style2

HgrSup Side_Support Assembly Horizontal HgrSup Side_Support Assembly Horizontal


Style2 Style2

HgrSup Side_Support Assembly Horizontal HgrSup Side_Support Assembly Horizontal


Style2_CP Style2_CP

HgrSup Side_Support Assembly Horizontal HgrSup Side_Support Assembly Horizontal

HgrSup Side_Support Assembly HgrSup Side_Support Assembly


KeyPoint_Horizontal KeyPoint_Horizontal

HgrSup Side_Support Assembly HgrSup Side_Support Assembly


KeyPoint_Vertical KeyPoint_Vertical

HgrSup Side_Support Assembly Vertical Style2 HgrSup Side_Support Assembly Vertical


Style2

HgrSup Side_Support Assembly Vertical HgrSup Side_Support Assembly Vertical

Drawings and Reports Reference Data Guide 684


Dimensions

Dimension Rule (.xml) Dimension Templates used in Rule (.xml)


Style2_CP Style2_CP

HgrSup Side_Support Assembly Vertical HgrSup Side_Support Assembly Vertical

HgrSup Side_Support Component Horizontal HgrSup Side_Support Component


Horizontal

HgrSup Side_Support Component Vertical HgrSup Side_Support Component Vertical

HgrSup Side_Support Dimension Points HgrSup Side_Support Dimension Points


Horizontal Style2 Horizontal Style2

HgrSup Side_Support Dimension Points Vertical HgrSup Side_Support Dimension Points


Style2 Vertical Style2

HVAC Elevation_Columns_Anchor_Horizontal HVAC


Elevation_Columns_Anchor_Horizontal

HVAC Elevation_Columns_Horizontal HVAC Elevation_Columns_Horizontal

HVAC Elevation_Ducts_Anchor_Horizontal HVAC Elevation_Ducts_Anchor_Horizontal

HVAC Elevation_Ducts_Anchor_Vertical HVAC Elevation_Ducts_Anchor_Vertical

HVAC Elevation_Ducts_Horizontal HVAC Elevation_Ducts_Horizontal

HVAC Elevation_Ducts_Vertical HVAC Elevation_Ducts_Vertical

HVAC Elevation_Grid Line_Anchor_Vertical HVAC Elevation_Grid Line_Anchor_Vertical

HVAC Plan_Columns_Anchor_Horizontal HVAC Plan_Columns_Anchor_Horizontal

HVAC Plan_Columns_Anchor_Vertical HVAC Plan_Columns_Anchor_Vertical

HVAC Plan_Columns_Horizontal HVAC Plan_Columns_Horizontal

HVAC Plan_Columns_Vertical HVAC Plan_Columns_Vertical

HVAC Plan_Ducts_Horizontal HVAC Plan_Ducts_Horizontal

HVAC Plan_Ducts_Vertical HVAC Plan_Ducts_Vertical

Instrument Instrument
Elevation_Columns_Anchor_Horizontal Elevation_Columns_Anchor_Horizontal

Instrument Elevation_Columns_Horizontal Instrument Elevation_Columns_Horizontal

Instrument Elevation_Grid Line_Anchor_Vertical Instrument Elevation_Grid

Drawings and Reports Reference Data Guide 685


Dimensions

Dimension Rule (.xml) Dimension Templates used in Rule (.xml)


Line_Anchor_Vertical

Instrument Instrument
Elevation_Instruments_Anchor_Horizontal Elevation_Instruments_Anchor_Horizontal

Instrument Instrument
Elevation_Instruments_Anchor_Vertical Elevation_Instruments_Anchor_Vertical

Instrument Elevation_Instruments_Horizontal Instrument


Elevation_Instruments_Horizontal

Instrument Elevation_Instruments_Vertical Instrument Elevation_Instruments_Vertical

Instrument Plan_Columns_Anchor_Horizontal Instrument


Plan_Columns_Anchor_Horizontal

Instrument Plan_Columns_Anchor_Vertical Instrument Plan_Columns_Anchor_Vertical

Instrument Plan_Columns_Horizontal Instrument Plan_Columns_Horizontal

Instrument Plan_Columns_Vertical Instrument Plan_Columns_Vertical

Instrument Plan_Instruments_Horizontal Instrument Plan_Instruments_Horizontal

Instrument Plan_Instruments_Vertical Instrument Plan_Instruments_Vertical

Instrumentation Instrumentation
Elevation_Columns_Anchor_Horizontal Elevation_Columns_Anchor_Horizontal

Instrumentation Elevation_Columns_Horizontal Instrumentation


Elevation_Columns_Horizontal

Instrumentation Elevation_Grid Instrumentation Elevation_Grid


Line_Anchor_Vertical Line_Anchor_Vertical

Instrumentation Instrumentation
Elevation_Instruments_Anchor_Horizontal Elevation_Instruments_Anchor_Horizontal

Instrumentation Instrumentation
Elevation_Instruments_Anchor_Vertical Elevation_Instruments_Anchor_Vertical

Instrumentation Instrumentation
Elevation_Instruments_Horizontal Elevation_Instruments_Horizontal

Instrumentation Elevation_Instruments_Vertical Instrumentation


Elevation_Instruments_Vertical

Instrumentation Instrumentation
Plan_Columns_Anchor_Horizontal Plan_Columns_Anchor_Horizontal

Drawings and Reports Reference Data Guide 686


Dimensions

Dimension Rule (.xml) Dimension Templates used in Rule (.xml)

Instrumentation Plan_Columns_Anchor_Vertical Instrumentation


Plan_Columns_Anchor_Vertical

Instrumentation Plan_Columns_Horizontal Instrumentation Plan_Columns_Horizontal

Instrumentation Plan_Columns_Vertical Instrumentation Plan_Columns_Vertical

Instrumentation Plan_Instruments_Horizontal Instrumentation


Plan_Instruments_Horizontal

Instrumentation Plan_Instruments_Vertical Instrumentation Plan_Instruments_Vertical

IS_ProfileSketch_FeatureDistance IS_ProfileSketch_FeatureDistance

IS_ProfileSketch_ProfileLength IS_ProfileSketch_ProfileLength

IS_ProfileSketch_TopFlangeLength IS_ProfileSketch_TopFlangeLength

Linear_A_HV Linear_A_HV

Linear_CA_A_PipeSegs Linear_CA_A_PipeSegs

Linear_CA_HV Linear_CA_HV

Linear_CA_HV_TowardClosestMargin Linear_CA_HV_TowardClosestMargin

Linear_CA_H_VLE Linear_CA_H_VLE

Linear_CA_V_HLE Linear_CA_V_HLE

Linear_M_HV Linear_M_HV

Piping Elevation_Columns_Anchor_Horizontal Piping


Elevation_Columns_Anchor_Horizontal

Piping Elevation_Columns_Horizontal Piping Elevation_Columns_Horizontal

Piping Elevation_Equipment_Anchor_Horizontal Piping


Elevation_Equipment_Anchor_Horizontal

Piping Elevation_Equipment_Anchor_Vertical Piping


Elevation_Equipment_Anchor_Vertical

Piping Elevation_Grid Line_Anchor_Vertical Piping Elevation_Grid Line_Anchor_Vertical

Piping Elevation_Pipes_Horizontal Piping Elevation_Pipes_Horizontal

Piping Elevation_Pipes_Vertical Piping Elevation_Pipes_Vertical

Drawings and Reports Reference Data Guide 687


Dimensions

Dimension Rule (.xml) Dimension Templates used in Rule (.xml)

Piping Plan_Columns_Anchor_Horizontal Piping Plan_Columns_Anchor_Horizontal

Piping Plan_Columns_Anchor_Vertical Piping Plan_Columns_Anchor_Vertical

Piping Plan_Columns_Horizontal Piping Plan_Columns_Horizontal

Piping Plan_Columns_Vertical Piping Plan_Columns_Vertical

Piping Plan_Equipment_Anchor_Horizontal Piping Plan_Equipment_Anchor_Horizontal

Piping Plan_Equipment_Anchor_Vertical Piping Plan_Equipment_Anchor_Vertical

Piping Plan_Pipes_Horizontal Piping Plan_Pipes_Horizontal

Piping Plan_Pipes_Vertical Piping Plan_Pipes_Vertical

Ruleset_ Linear_CA_HV Ruleset_ Linear_CA_HV

Structural Elevation_Beams_Anchor_Vertical Structural


Elevation_Beams_Anchor_Vertical

Structural Elevation_Braces_Anchor_Horizontal Structural


Elevation_Braces_Anchor_Horizontal

Structural Elevation_Braces_Horizontal Structural Elevation_Braces_Horizontal

Structural Elevation_Columns_Anchor_Horizontal Structural


Elevation_Columns_Anchor_Horizontal

Structural Elevation_Columns_Horizontal Structural Elevation_Columns_Horizontal

Structural Elevation_Grid Line_Anchor_Vertical Structural Elevation_Grid


Line_Anchor_Vertical

Structural Elevation_Grid Line_Vertical Structural Elevation_Grid Line_Vertical

Structural Elevation_GridLine_Vertical Structural Elevation_GridLine_Vertical

Structural Framing Structural Framing


Elevation_Beams_Anchor_Vertical Elevation_Beams_Anchor_Vertical

Structural Framing Structural Framing


Elevation_Braces_Anchor_Horizontal Elevation_Braces_Anchor_Horizontal

Structural Framing Elevation_Braces_Horizontal Structural Framing


Elevation_Braces_Horizontal

Structural Framing Structural Framing

Drawings and Reports Reference Data Guide 688


Dimensions

Dimension Rule (.xml) Dimension Templates used in Rule (.xml)


Elevation_Columns_Anchor_Horizontal Elevation_Columns_Anchor_Horizontal

Structural Framing Elevation_Columns_ Structural Framing Elevation_Columns_


Horizontal Horizontal

Structural Framing Elevation_Grid Structural Framing Elevation_Grid


Line_Anchor_Vertical Line_Anchor_Vertical

Structural Framing Elevation_Grid Line_Vertical Structural Framing Elevation_Grid


Line_Vertical

Structural Framing Plan_Beams_Horizontal Structural Framing Plan_Beams_Horizontal

Structural Framing Plan_Beams_Vertical Structural Framing Plan_Beams_Vertical

Structural Framing Plan_Braces_Horizontal Structural Framing Plan_Braces_Horizontal

Structural Framing Plan_Braces_Vertical Structural Framing Plan_Braces_Vertical

Structural Framing Structural Framing


Plan_Columns_Anchor_Horizontal Plan_Columns_Anchor_Horizontal

Structural Framing Structural Framing


Plan_Columns_Anchor_Vertical Plan_Columns_Anchor_Vertical

Structural Framing Plan_Columns_Horizontal Structural Framing


Plan_Columns_Horizontal

Structural Framing Plan_Columns_Vertical Structural Framing Plan_Columns_Vertical

Structural Framing Plan_Equipment_Anchor_ Structural Framing


Horizontal Plan_Equipment_Anchor_Horizontal

Structural Framing Structural Framing


Plan_Equipment_Anchor_Vertical Plan_Equipment_Anchor_Vertical

Structural Framing Plan_Equipment_Horizontal Structural Framing


Plan_Equipment_Horizontal

Structural Framing Plan_Equipment_Vertical Structural Framing Plan_Equipment_Vertical

Drawings and Reports Reference Data Guide 689


Dimensions

Dimension Anchors
Dimension anchoring allows you to add objects (such as pieces of equipment) to a dimension
chain to add spatial reference to the objects in that chain.
The main dimension template is anchored to one or more anchor templates. When you open a
main rule whose template has another template anchored to it, the Dimension Rule Manager
displays the name of the anchor template in the Anchor text box. You can replace the anchor
template with another template, or add more anchor templates to the main template. For more
information, see Anchor (dimensionAnchor value) (on page 1518).
Your drawing view style must contain the dimension rules for both the main
and anchor templates.

 The geometric analyzer module in the anchor template must be set to Dummy
(DummyGeomAnalyzer) (on page 1540).
 You can anchor multiple anchor templates to the main rule template.

Marine Dimension Rules


You can use the Dimension Rule Manager to edit the delivered dimension rules. For more
information, see Dimension Rule Manager (on page 1503).
The following marine mode dimension rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DimensionRules folder:

Dimension Rule (.xml) Dimension Templates Used in Rule (.xml)

IS_ProfileSketch_FeatureDistance IS_ProfileSketch_FeatureDistance

IS_ProfileSketch_ProfileLength IS_ProfileSketch_ProfileLength

IS_ProfileSketch_TopFlangeLength IS_ProfileSketch_TopFlangeLength

SM_Electrical_Elevation_CableTray_ SM_Electrical_Elevation_CableTray_Horizontal
Horizontal

SM_Electrical_Elevation_CableTray_Vertical SM_Electrical_Elevation_CableTray_Vertical

SM_Electrical_Elevation_Grid_Anchor_ SM_Electrical_Elevation_Grid_Anchor_
Horizontal Horizontal

SM_Electrical_Elevation_Grid_Anchor_Vertical SM_Electrical_Elevation_Grid_Anchor_Vertical

SM_Electrical_Plan_CableTray_Horizontal SM_Electrical_Plan_CableTray_Horizontal

SM_Electrical_Plan_CableTray_Vertical SM_Electrical_Plan_CableTray_Vertical

SM_Electrical_Plan_Grid_Anchor_Horizontal SM_Electrical_Plan_Grid_Anchor_Horizontal

Drawings and Reports Reference Data Guide 690


Dimensions

Dimension Rule (.xml) Dimension Templates Used in Rule (.xml)

SM_Electrical_Plan_Grid_Anchor_Vertical SM_Electrical_Plan_Grid_Anchor_Vertical

SM_Electrical_Section_CableTray_Horizontal SM_Electrical_Section_CableTray_Horizontal

SM_Electrical_Section_CableTray_Vertical SM_Electrical_Section_CableTray_Vertical

SM_Electrical_Section_Grid_Anchor_Horizontal SM_Electrical_Section_Grid_Anchor_Horizontal

SM_Electrical_Section_Grid_Anchor_Vertical SM_Electrical_Section_Grid_Anchor_Vertical

SM_Equipment Elevation_Grid_Anchor_ SM_Equipment


Horizontal Elevation_Grid_Anchor_Horizontal

SM_Equipment SM_Equipment Elevation_Grid_Anchor_Vertical


Elevation_Grid_Anchor_Vertical

SM_Equipment_Elevation_Equipment_ SM_Equipment_Elevation_Equipment_
Horizontal Horizontal

SM_Equipment_Elevation_Equipment_Vertical SM_Equipment_Elevation_Equipment_Vertical

SM_Equipment_Plan_Equipment_Horizontal SM_Equipment_Plan_Equipment_Horizontal

SM_Equipment_Plan_Equipment_Vertical SM_Equipment_Plan_Equipment_Vertical

SM_Equipment_Plan_Grid_Anchor_Horizontal SM_Equipment_Plan_Grid_Anchor_Horizontal

SM_Equipment_Plan_Grid_Anchor_Vertical SM_Equipment_Plan_Grid_Anchor_Vertical

SM_Equipment_Section_Equipment_Horizontal SM_Equipment_Section_Equipment_Horizontal

SM_Equipment_Section_Equipment_Vertical SM_Equipment_Section_Equipment_Vertical

SM_Equipment_Section_Grid_Anchor_Horizont SM_Equipment_Section_Grid_Anchor_Horizonta
al l

SM_Equipment_Section_Grid_Anchor_Vertical SM_Equipment_Section_Grid_Anchor_Vertical

SM_HVAC_Elevation_Duct_Horizontal SM_HVAC_Elevation_Duct_Horizontal

SM_HVAC_Elevation_Duct_Vertical SM_HVAC_Elevation_Duct_Vertical

SM_HVAC_Elevation_Grid_Anchor_Horizontal SM_HVAC_Elevation_Grid_Anchor_Horizontal

SM_HVAC_Elevation_Grid_Anchor_Vertical SM_HVAC_Elevation_Grid_Anchor_Vertical

SM_HVAC_Plan_Duct_Horizontal SM_HVAC_Plan_Duct_Horizontal

Drawings and Reports Reference Data Guide 691


Dimensions

Dimension Rule (.xml) Dimension Templates Used in Rule (.xml)

SM_HVAC_Plan_Duct_Vertical SM_HVAC_Plan_Duct_Vertical

SM_HVAC_Plan_Grid_Anchor_Horizontal SM_HVAC_Plan_Grid_Anchor_Horizontal

SM_HVAC_Plan_Grid_Anchor_Vertical SM_HVAC_Plan_Grid_Anchor_Vertical

SM_HVAC_Section_Duct_Horizontal SM_HVAC_Section_Duct_Horizontal

SM_HVAC_Section_Duct_Vertical SM_HVAC_Section_Duct_Vertical

SM_HVAC_Section_Grid_Anchor_Horizontal SM_HVAC_Section_Grid_Anchor_Horizontal

SM_HVAC_Section_Grid_Anchor_Vertical SM_HVAC_Section_Grid_Anchor_Vertical

SM_Lighting_Plan_Grid_Anchor_Horizontal SM_Lighting_Plan_Grid_Anchor_Horizontal

SM_Lighting_Plan_Grid_Anchor_Vertical SM_Lighting_Plan_Grid_Anchor_Vertical

SM_Piping_Elevation_Grid_Anchor_Horizontal SM_Piping_Elevation_Grid_Anchor_Horizontal

SM_Piping_Elevation_Grid_Anchor_Vertical SM_Piping_Elevation_Grid_Anchor_Vertical

SM_Piping_Elevation_Pipes_Horizontal SM_Piping_Elevation_Pipes_Horizontal

SM_Piping_Elevation_Pipes_Vertical SM_Piping_Elevation_Pipes_Vertical

SM_Piping_Plan_Grid_Anchor_Horizontal SM_Piping_Plan_Grid_Anchor_Horizontal

SM_Piping_Plan_Grid_Anchor_Vertical SM_Piping_Plan_Grid_Anchor_Vertical

SM_Piping_Plan_Pipes_Horizontal SM_Piping_Plan_Pipes_Horizontal

SM_Piping_Plan_Pipes_Vertical SM_Piping_Plan_Pipes_Vertical

SM_Piping_Section_Grid_Anchor_Horizontal SM_Piping_Section_Grid_Anchor_Horizontal

SM_Piping_Section_Grid_Anchor_Vertical SM_Piping_Section_Grid_Anchor_Vertical

SM_Piping_Section_Pipes_Horizontal SM_Piping_Section_Pipes_Horizontal

SM_Piping_Section_Pipes_Vertical SM_Piping_Section_Pipes_Vertical

StrMfg PinJig IntersectionPoint_To_NearestPin StrMfg PinJig IntersectionPoint_To_NearestPin

StrMfg PinJig Pin_Spacing_M StrMfg PinJig Pin_Spacing_M

StrMfg PinJig_Contour_Corners Straight StrMfg PinJig_Contour_Corners Straight


Distance Distance

Drawings and Reports Reference Data Guide 692


Dimensions

Dimension Rule (.xml) Dimension Templates Used in Rule (.xml)

StrMfg ProfileSketch StrMfg ProfileSketch ERPlateThicknessLocMark


ERPlateThicknessLocMark

StrMfg ProfileSketch Feature Dimensions StrMfg ProfileSketch Feature Dimensions

StrMfg ProfileSketch Feature Dimensions_R StrMfg ProfileSketch Feature Dimensions_R

StrMfg ProfileSketch WebThicknessLocMark StrMfg ProfileSketch WebThicknessLocMark

StrMfg Sketch Feature Contour Dimensions StrMfg Sketch Feature Contour Dimensions

StrMfg Sketch Feature Dimensions StrMfg Sketch Feature Dimensions

StrMfg Sketch Feature Location StrMfg Sketch Feature Location

StrMfg Template Offset_Distance StrMfg Template Offset_Distance

StrMfg Template Offset_Height StrMfg Template Offset_Height

StrMfg TemplateSet ChordHeight StrMfg TemplateSet ChordHeight

StrMfg TemplateSet GirthLength StrMfg TemplateSet GirthLength

Manufacturing Dimension Rules


You can use the Dimension Rule Manager to edit the delivered dimension rules. For more
information, see Dimension Rule Manager (on page 1503).
The following manufacturing mode dimension rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DimensionRules folder:

Dimension Rule (.xml) Dimension Templates used in Rule (.xml)

MHE_HolePositioning MHE_HolePositioning

MHE_InclinedPlateDetailsDimensions MHE_InclinedPlateDetailsDimensions

MHE_PlateDetailsDimensions MHE_PlateDetailsDimensions

MHE_PlateIncrementalDimensions MHE_PlateIncrementalDimensions

Drawings and Reports Reference Data Guide 693


Dimensions

Dimension Templates Overview


Dimension templates with metric units of measure are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates folder. This is the default
folder used by the software. Dimension templates with metric units of measure have the
dimension style ISO.
Dimension templates with imperial units of measure are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates - Imperial folder. Each
dimension rule uses one or more dimension templates. Dimension templates with imperial units
of measure have the dimension style ANSI.
To use the dimension templates with imperial units of measure as the default values,
rename the Dimensions\Template folder. For example, you can rename the default folder to
Dimensions\Template - Metric. Then, rename the Dimensions\Template - Imperial folder to
Dimensions\Template.
Templates for 3D manual dimensions are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\3D folder.

Topics
Common Dimension Template Properties ..................................... 694
Generic Horizontal Dimensions ..................................................... 698
Generic Vertical Dimensions ......................................................... 700
Hangers and Supports Dimensions ............................................... 701
Horizontal and Vertical Cable Trays .............................................. 704
Horizontal Structure Dimensions ................................................... 705
Miscellaneous Dimensions ............................................................ 707
Structure Margin Dimensions ........................................................ 710
Vertical Routable Dimensions........................................................ 711
Vertical Structure Dimensions ....................................................... 712
Marine Dimension Templates ........................................................ 715

Common Dimension Template Properties


The Dimension Rule Manager allows you to customize the behavior and appearance of
dimensions. The Dimension Rule Manager displays the annotation modules for the selected
template, and allows you to edit the properties that each module uses.
Annotation modules are used within dimension rules to analyze, place, and position dimensions.
The software processes annotation modules in dimension templates according to the type of the
annotation module. For more information on the different types of annotation modules and how
the software processes them, see Annotation Modules (on page 1728).

 The modules that display depend on the template that you have selected for editing.
 Depending on the template you open, the module you select, and your settings for
properties in the Dimension Rule Manager, the list of available properties can change.
 The Dimension Rule Manager does not display properties and modules that are
unavailable for the template you are modifying.

Drawings and Reports Reference Data Guide 694


Dimensions

Dimension rules and the properties that define them are organized into the following categories:
Content Module
Gathers the information to display within a label or dimension. Additionally, a content
module specifies dimension styles.
Annotation Control Generator
Creates an annotation control object, either as a label control object or dimension control
object, which the system uses to represent each individual label or dimension. The
annotation control object then manages the list of positioning modules that can use that
particular annotation and keeps track of the annotation's current position at any point in
time.
Point Generator
Gathers data from the 3D geometry and places points on 2D objects that need labels,
dimensions, or matchlines.
Geometric Analyzer
Evaluates the points placed by the point generator module. The selected module groups or
deletes points as needed. This module does not create any annotations.
Positioning Module
Determines the position of a dimension.
The lists below contain some of the common properties for the corresponding module type:

Content Module Properties


For information about content modules, see Content Module (Properties tab) (on
page 1508).
Dimension Layer (dimLayer) (on page 1536)
Represents the SmartSketch drawing layer on which the software places the dimensions for
the selected template.
Preserve Text Orientation (preserveTextOrientation) (on page 1587)
Determines whether or not text always uses the dimension style setting in the label template
.xml file.
Style (dimStyle) (on page 1595)
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.

Annotation Control Generator Module Properties


For more information, see Annotation Control Generator Module (Properties tab) (on
page 1107).
Align (align) (on page 1517)
Aligns dimension chains that have matching projection angles if the alignment does not
overlap another element, such as a label or a model graphic.
Display Horizontal (horiz) (on page 1537)

Drawings and Reports Reference Data Guide 695


Dimensions

Places dimensions that measure horizontal distances on the drawing sheet.


Display Vertical (vert) (on page 1539)
Places dimensions that measure vertical distances on the drawing sheet.
Priority (priority) (on page 1589)
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.
Range (range) (on page 1593)
Displays the Internal Dimension, External Dimension, Range Offset, and Trim Witness
properties.
Range Offset (rangeOffset) (on page 1594)
Determines the inward distance from the matchline for the boundary between objects meant
for internal (inside the view) and external (margin) dimensioning.

Point Generator Properties


For information about point generation modules, see Point Generator Module
(Properties tab) (on page 1509).
Offset from Range (overall) (on page 1574)
Determines whether to offset the dimension value from points placed for the profile sketch
dimension, or to offset the dimension from the edge of the range.
Point Location (pointLocation) (on page 1585)
Indicates the position of dimension points placed by the Horizontal Routable Object
(DrawingPGRoutableObjHoriz) point generator module. Select Top, Center, or Bottom.

Geometric Analyzer Properties


For more information about geometric analyzer modules, see Geometric Analyzer
Module (Properties tab) (on page 1510).
Display Overall Dimensions (overall) (on page 1538)
Places an additional dimension over each dimension chain cluster identified by the rule.
External Dimension (externalDimension) (on page 1541)
Place dimensions connecting to points outside of a certain inward distance from the
matchline, as specified by Range Offset.
Internal Dimension (internalDimension) (on page 1552)
Places dimensions connecting to points inside a certain inward distance from the matchline,
as specified by Range Offset.
Keep Left or Right Duplicate (keepLeftOrRightDup) (on page 1556)
Eliminates points from dimensioning consideration when multiple pairs of points are aligned
at identical Y positions along a horizontal axis.
Keep Top or Bottom Duplicate (keepTopOrBottomDup) (on page 1557)
Eliminates points from dimensioning consideration when multiple pairs of points are aligned
at identical X positions along a vertical axis.

Drawings and Reports Reference Data Guide 696


Dimensions

Maximum Dimension Offset (maxDimOffset) (on page 1563)


Determines the maximum linear paper space distance between consecutive witness lines in
a linear distance dimension group.
Maximum Witness Length (maxWitnessLength) (on page 1566)
Controls the length of witness lines so that you can determine how far across the drawing
the line is drawn. Points that fall outside the maximum witness length are eliminated from
consideration.
Minimum Dimension Distance (minimumDimension) (on page 1568)
Determines a minimum dimension distance. If a dimension is less than the specified
distance, then the software does not place a dimension in the drawing. If a dimension is less
than the specified distance and is part of a dimension chain, then the software absorbs that
dimension into the larger dimension.
Orientation (orientation) (on page 1576)
Specifies the positional orientation of the dimension with respect to the dimensioned object.
Overall Offset (overallOffset) (on page 1578)
Determines the offset for the overall dimension from the dimension chain.
Trim Witness (trimWitness) (on page 1599)
Determines whether or not a dimension witness line extends into the drawing view to the
dimensioned object or stops at the drawing view.

Positioning Module Properties


For information about positioning modules, see Positioning Module (Properties tab)
(on page 1510).
Granularity (granularity) (on page 1543)
Specifies a portion of the height of a dimension value as the basis for the increment used to
find clear space in which to position the dimension.
Maximum Offset (maxOffset) (on page 1564)
Specifies the maximum distance from the dimension line to the nearest point in the
dimension chain.
Minimum Offset (minOffset) (on page 1569)
Specifies the minimum distance from the dimension line to the nearest point in the
dimension chain.
Perimeter Offset (perimeterOffset) (on page 1423)
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

Drawings and Reports Reference Data Guide 697


Dimensions

Generic Horizontal Dimensions


Description: Horizontal dimensions that use the default annotation modules.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: Dummy (DummyGeomAnalyzer) (on page 1540)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
(on page 1546)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name

Civil Plan_Columns_Anchor_Horizontal

Electrical Above Ground Plan_Columns_Anchor_Horizontal

Electrical Elevation_CableTray_Anchor_Horizontal

Electrical Equipment Elevation_Columns_Anchor_Horizontal

Electrical Equipment Plan_Columns_Anchor_Horizontal

Electrical Raceway Plan_Columns_Anchor_Horizontal

Electrical Raceway Plan_Columns_Anchor_Vertical

Electrical Raceway Plan_Columns_Horizontal

Electrical Raceway Plan_Columns_Vertical

Equipment Elevation_Equipment_Anchor_Horizontal

Equipment Elevation_Equipment_Anchor_Vertical

Equipment Elevation_Equipment_Vertical

Equipment Plan_Columns_Anchor_Horizontal

HVAC Elevation_Ducts_Anchor_Horizontal

HVAC Elevation_Ducts_Anchor_Vertical

HVAC Elevation_Grid Line_Anchor_Vertical

HVAC Plan_Columns_Anchor_Horizontal

Drawings and Reports Reference Data Guide 698


Dimensions

Dimension Template Name

HVAC Plan_Columns_Anchor_Vertical

HVAC Plan_Equipment_Anchor_Horizontal

Instrument Elevation_Columns_Anchor_Horizontal

Instrument Elevation_Instruments_Anchor_Horizontal

Instrument Plan_Columns_Anchor_Horizontal

Instrumentation Elevation_Columns_Anchor_Horizontal

Instrumentation Elevation_Columns_Horizontal

Instrumentation Elevation_Grid Line_Anchor_Vertical

Instrumentation Elevation_Instruments_Anchor_Horizontal

Instrumentation Elevation_Instruments_Anchor_Vertical

Instrumentation Elevation_Instruments_Horizontal

Instrumentation Elevation_Instruments_Vertical

Instrumentation Plan_Columns_Anchor_Horizontal

Instrumentation Plan_Columns_Anchor_Vertical

Instrumentation Plan_Columns_Horizontal

Instrumentation Plan_Columns_Vertical

Instrumentation Plan_Instruments_Horizontal

Instrumentation Plan_Instruments_Vertical

Piping Elevation_Equipment_Anchor_Horizontal

Piping Plan_Columns_Anchor_Horizontal

Piping Plan_Equipment_Anchor_Horizontal

Structural Elevation_Braces_Anchor_Horizontal

Structural Elevation_Grid Line_Anchor_Vertical

Structural Framing Elevation_Braces_Anchor_Horizontal

Drawings and Reports Reference Data Guide 699


Dimensions

Dimension Template Name

Structural Framing Elevation_Grid Line_Anchor_Vertical

Structural Framing Plan_Columns_Anchor_Horizontal

Structural Framing Plan_Equipment_Anchor_Horizontal

Generic Vertical Dimensions


Description: Vertical dimensions that use the default annotation modules.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\\[Dimension Template
Name].xml
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: Dummy (DummyGeomAnalyzer) (on page 1540)
Annotation Control Generator: Vertical Linear Dimensions (DrawingDimContLinVNoReplace)
(on page 1601)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name

Civil Plan_Columns_Anchor_Vertical

Electrical Above Ground Plan_Columns_Anchor_Vertical

Electrical CableTray Plan_Beams_Anchor_Vertical

Electrical CableTray Plan_Beams_Vertical

Electrical Elevation_CableTray_Anchor_Vertical

Electrical Equipment Plan_Columns_Anchor_Vertical

Electrical Raceway Plan_Beams_Anchor_Vertical

Electrical Raceway Plan_Beams_Vertical

Equipment Elevation_Columns_Anchor_Horizontal

Equipment Plan_Columns_Anchor_Vertical

HVAC Plan_Equipment_Anchor_Vertical

Instrument Elevation_Grid Line_Anchor_Vertical

Drawings and Reports Reference Data Guide 700


Dimensions

Dimension Template Name

Instrument Plan_Columns_Anchor_Vertical

Piping Elevation_Equipment_Anchor_Vertical

Piping Plan_Columns_Anchor_Vertical

Piping Plan_Equipment_Anchor_Vertical

Structural Elevation_Beams_Anchor_Vertical

Structural Elevation_Columns_Anchor_Horizontal

Structural Framing Elevation_Beams_Anchor_Vertical

Structural Framing Elevation_Columns_Anchor_Horizontal

Structural Framing Plan_Columns_Anchor_Vertical

Structural Framing Plan_Equipment_Anchor_Vertical

Hangers and Supports Dimensions


Horizontal and Vertical Style2 Hangers and Supports Dimensions
Description: Margin dimensions that are used with the Style2 view style.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Note (DrawingPGByNote) (on page 1572)
Geometric Analyzer: Margin (DrawingGAMarginOnly) (on page 1559)
Annotation Control Generator: Coordinate (DrawingCoordDimGenerator) (on page 1532)
Horizontal Content Module: Horizontal Coordinate Dimensions
(DrawingCoordDimContLinHNoReplace) (on page 1545)
Vertical Content Module: Vertical Coordinate Dimensions
(DrawingCoordDimContLinVNoReplace) (on page 1600)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name Dimension Anchor

HgrSup End_Support Assembly Horizontal HgrSup End_Support Assembly


Style2 KeyPoint_Anchor_Horizontal

HgrSup End_Support Assembly Vertical HgrSup End_Support Assembly


Style2 KeyPoint_Anchor_Vertical

HgrSup Side_Support Assembly Horizontal HgrSup End_Support Assembly


Style2 KeyPoint_Anchor_Horizontal

Drawings and Reports Reference Data Guide 701


Dimensions

Dimension Template Name Dimension Anchor

HgrSup Side_Support Assembly Vertical HgrSup End_Support Assembly


Style2 KeyPoint_Anchor_Vertical

Horizontal and Vertical Key Point Hangers and Supports Dimensions


Description: Margin dimensions that are placed on the latest Key Plan Callout control point
subtype.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Hanger Key Plan Control Point then Support Location
(DrawingPGKeyPlanControlPoint) (on page 1544)
Geometric Analyzer: Margin (DrawingGAMarginOnly) (on page 1559)
Annotation Control Generator: Coordinate (DrawingCoordDimGenerator) (on page 1532)
Horizontal Content Module: Horizontal Coordinate Dimensions
(DrawingCoordDimContLinHNoReplace) (on page 1545)
Vertical Content Module: Vertical Coordinate Dimensions
(DrawingCoordDimContLinVNoReplace) (on page 1600)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name

HgrSup End_Support Assembly KeyPoint_Anchor_Horizontal

HgrSup End_Support Assembly KeyPoint_Anchor_Vertical

HgrSup Side_Support Assembly KeyPoint_Horizontal

HgrSup Side_Support Assembly KeyPoint_Vertical

Horizontal and Vertical Hangers and Supports Component Dimensions


Description: Margin dimensions that use the object range and anchor to the matchlines.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Object Corners (DrawingPGObjectCorners) (on page 1573)
Geometric Analyzer: Margin (DrawingGAMarginOnly) (on page 1559)
Annotation Control Generator: Coordinate (DrawingCoordDimGenerator) (on page 1532)
Horizontal Content Module: Horizontal Coordinate Dimensions
(DrawingCoordDimContLinHNoReplace) (on page 1545)
Vertical Content Module: Vertical Coordinate Dimensions
(DrawingCoordDimContLinVNoReplace) (on page 1600)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name Dimension Anchor

HgrSup End_Support Component HgrSup End_Support Assembly


Horizontal KeyPoint_Anchor_Horizontal

Drawings and Reports Reference Data Guide 702


Dimensions

Dimension Template Name Dimension Anchor

HgrSup End_Support Component Vertical HgrSup End_Support Assembly


KeyPoint_Anchor_Vertical

HgrSup Side_Support Component HgrSup Side_Support Assembly


Horizontal KeyPoint_Horizontal

HgrSup Side_Support Component Vertical HgrSup Side_Support Assembly


KeyPoint_Vertical

Horizontal Hangers and Supports Assembly Dimensions


Description: Horizontal margin dimensions that use vertical assembly points.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Note (DrawingPGByNote) (on page 1572)
Geometric Analyzer: Margin (DrawingGAMarginOnly) (on page 1559)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
(on page 1546)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name

HgrSup End_Support Assembly Horizontal

HgrSup Side_Support Assembly Horizontal

Vertical Hangers and Supports Assembly Dimensions


Description: Vertical margin dimensions that use horizontal assembly points.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Note (DrawingPGByNote) (on page 1572)
Geometric Analyzer: Default (DrawingGeometricAnalyzer) (on page 1534)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Absolute Dimension Offset (DrawingDimAbsolutePos) (on page 1514)

Dimension Template Name

HgrSup End_Support Assembly Vertical

HgrSup Side_Support Assembly Vertical

Drawings and Reports Reference Data Guide 703


Dimensions

Horizontal and Vertical Cable Trays


Horizontal Cable Trays
Description: Vertical dimensions that use horizontal cable trays.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Vertical Linear Object Endpoints (DrawingPGStructVert) (on page 1603)
Geometric Analyzer: Default (DrawingGeometricAnalyzer) (on page 1534)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions with Value Replacement
(DrawingDimContentLinearH) (on page 1547)
Vertical Content Module: Vertical Linear Dimensions with Value Replacement
(DrawingDimContentLinearV) (on page 1602)
Positioning Modules: Clear Space Horizontal Bottom (DrawingDimHorizBottomCS) (on page
1523), Clear Space Horizontal Top (DrawingDimHorizTopCS) (on page 1525), Absolute
Dimension Offset (DrawingDimAbsolutePos) (on page 1514)

Dimension Template Name

Electrical CableTray Plan_Cable Trays_Horizontal

Electrical Equipment Plan_Cable Trays_Horizontal

Vertical Cable Trays


Description: Horizontal dimensions that use vertical cable trays.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Horizontal Linear Object Endpoints (DrawingPGStructHoriz) (on page 1547)
Geometric Analyzer: Default (DrawingGeometricAnalyzer) (on page 1534)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions with Value Replacement
(DrawingDimContentLinearH) (on page 1547)
Vertical Content Module: Vertical Linear Dimensions with Value Replacement
(DrawingDimContentLinearV) (on page 1602)
Positioning Modules: Clear Space Horizontal Top (DrawingDimHorizTopCS) (on page 1525),
Clear Space Horizontal Bottom (DrawingDimHorizBottomCS) (on page 1523), Absolute
Dimension Offset (DrawingDimAbsolutePos) (on page 1514),Clear Space Vertical Right
(DrawingDimVertRightCS) (on page 1528), Clear Space Vertical Left (DrawingDimVertLeftCS)
(on page 1527)

Dimension Template Name

Electrical CableTray Plan_Cable Trays_Vertical

Electrical Equipment Plan_Cable Trays_Vertical

Drawings and Reports Reference Data Guide 704


Dimensions

Dimension Template Name

Electrical Raceway Plan_Cable Trays_Vertical

Horizontal Structure Dimensions


Horizontal Structure Dimensions
Description: Vertical dimensions that use horizontal structure objects.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Horizontal Linear Object Endpoints (DrawingPGStructHoriz) (on page 1547)
Geometric Analyzer: Margin (DrawingGAMarginOnly) (on page 1559)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name Dimension Anchor

Civil Plan_Columns_Vertical Civil Plan_Columns_Anchor_Vertical

Electrical Above Ground Electrical Above Ground


Plan_Columns_Vertical Plan_Columns_Anchor_Vertical

Electrical CableTray Plan_Columns_Vertical Electrical CableTray


Plan_Columns_Anchor_Vertical

Electrical Elevation_CableTray_Vertical Electrical Elevation_Grid Line_Anchor_Vertical

Electrical Equipment Electrical Equipment Elevation_Grid


Elevation_CableTray_Vertical Line_Anchor_Vertical

Electrical Equipment Plan_Columns_Vertical Electrical Equipment


Plan_Columns_Anchor_Vertical

Equipment Plan_Columns_Vertical Equipment Plan_Columns_Anchor_Vertical

HVAC Plan_Columns_Vertical HVAC Plan_Columns_Anchor_Vertical

HVAC Plan_Ducts_Vertical HVAC Plan_Columns_Anchor_Vertical, HVAC


Plan_Equipment_Anchor_Vertical

Instrument Elevation_Instruments_Vertical Instrument


Elevation_Instruments_Anchor_Vertical

Instrument Plan_Columns_Vertical Instrument Plan_Columns_Anchor_Vertical

Drawings and Reports Reference Data Guide 705


Dimensions

Dimension Template Name Dimension Anchor

Instrument Plan_Instruments_Vertical Instrument Plan_Columns_Anchor_Vertical

Piping Plan_Columns_Vertical Piping Plan_Columns_Anchor_Vertical

Piping Plan_Pipes_Vertical Piping Plan_Columns_Anchor_Vertical, Piping


Plan_Equipment_Anchor_Vertical

Structural Elevation_Grid Line_Vertical Structural Elevation_Grid Line_Anchor_Vertical

Structural Framing Elevation_Grid Structural Framing Elevation_Grid


LIne_Vertical Line_Anchor_Vertical

Structural Framing Plan_Beams_Vertical Structural Framing


Plan_Columns_Anchor_Vertical, Structural
Framing Plan_Equipment_Anchor_Vertical

Structural Framing Plan_Braces_Vertical Structural Framing


Plan_Columns_Anchor_Horizontal, Structural
Framing Plan_Equipment_Anchor_Horizontal

Structural Framing Plan_Columns_Vertical

Vertical Grid Line Dimensions


Description: Vertical dimensions that use vertical grid lines.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Horizontal Linear Object Endpoints (DrawingPGStructHoriz) (on page 1547)
Geometric Analyzer: Dummy (DummyGeomAnalyzer) (on page 1540)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name

Electrical CableTray Elevation_Grid Line_Anchor_Vertical

Electrical Elevation_Grid Line_Anchor_Vertical

Electrical Equipment Elevation_Grid Line_Anchor_Vertical

Equipment Elevation_Grid Line_Anchor_Vertical

Piping Elevation_Grid Line_Anchor_Vertical

Drawings and Reports Reference Data Guide 706


Dimensions

Miscellaneous Dimensions
All dimension template files are in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\ folder. Dimension template
filenames match the file name for the corresponding dimension rule. For example, the Electrical
Above Ground Plan_Cable Trays_Horizontal dimension rule uses the Electrical Above Ground
Plan_Cable Trays_Horizontal dimension template.

 Dimension templates and dimension rules have an .xml file extension.


 Dimension rules are in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DimensionRules folder.

Electrical Above Ground Cable Tray Dimensions


Point Generator: 3D Object Center (DrawingPointGenerator) (on page 1514)
Geometric Analyzer: Default (DrawingGeometricAnalyzer) (on page 1534)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
(on page 1546)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name Dimension Anchor

Electrical Above Ground Plan_Cable Electrical Above Ground


Trays_Horizontal Plan_Columns_Anchor_Horizontal

Electrical Above Ground Plan_Cable Electrical Above Ground


Trays_Vertical Plan_Columns_Anchor_Vertical

Miscellaneous Dimensions
For more information on the annotation modules used by the following dimension rules, see
Annotation Modules (on page 1728).
Name: ALR_CA_PenetrationPlate.xml
Point Generator: Penetration Plate (PenPlatePointGenerator) (on page 1580)
Geometric Analyzer: Dummy (DummyGeomAnalyzer) (on page 1540)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
(on page 1546)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Absolute Dimension Offset (DrawingDimAbsolutePos) (on page 1514),
Clear Space Quadrant 1 (DrawingQuadOne) (on page 1224), Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229), Clear Space Quadrant 3 (DrawingQuadThree) (on page
1234), Clear Space Quadrant 4 (DrawingQuadFour) (on page 1240)
Name: Electrical Raceway Plan_Cable Trays_Horizontal.xml
Point Generator: Vertical Linear Object Endpoints (DrawingPGStructVert) (on page 1603)

Drawings and Reports Reference Data Guide 707


Dimensions

Geometric Analyzer: Default (DrawingGeometricAnalyzer) (on page 1534)


Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions with Value Replacement
(DrawingDimContentLinearH) (on page 1547)
Vertical Content Module: Vertical Linear Dimensions with Value Replacement
(DrawingDimContentLinearV) (on page 1602)
Dimension Anchor: All Columns
Positioning Module: Clear Space Horizontal Top (DrawingDimHorizTopCS) (on page 1525),
Clear Space Horizontal Bottom (DrawingDimHorizBottomCS) (on page 1523), Absolute
Dimension Offset (DrawingDimAbsolutePos) (on page 1514), Clear Space Vertical Right
(DrawingDimVertRightCS) (on page 1528), Clear Space Vertical Left (DrawingDimVertLeftCS)
(on page 1527)
Name: Electrical Raceway Plan_Column_Horizontal-Vertical.xml
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: Default (DrawingGeometricAnalyzer) (on page 1534)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions with Value Replacement
(DrawingDimContentLinearH) (on page 1547)
Vertical Content Module: Vertical Linear Dimensions with Value Replacement
(DrawingDimContentLinearV) (on page 1602)
Positioning Module: Clear Space Horizontal Top (DrawingDimHorizTopCS) (on page 1525),
Absolute Dimension Offset (DrawingDimAbsolutePos) (on page 1514), Clear Space Vertical Left
(DrawingDimVertLeftCS) (on page 1527)
Name: Linear_A_HV.xml
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: Default (DrawingGeometricAnalyzer) (on page 1534)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
(on page 1546)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Absolute Dimension Offset (DrawingDimAbsolutePos) (on page 1514),
Absolute Dimension Offset (DrawingDimAbsolutePos) (on page 1514)
Name: Linear_CA_A_PipeSegs.xml
Point Generator: DrawingPGPipeSegments
Geometric Analyzer: Pipe Segments (DrawingGAPipeSegments) (on page 1582)
Annotation Control Generator: Pipe Segments (DrawingPipeSegmentsCG) (on page 1583)
Positioning Module: Clear Space Pipe Segments (DrawingDimPipeSegPos) (on page 1526)
Name: Linear_CA_HV.xml
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: Default (DrawingGeometricAnalyzer) (on page 1534)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
(on page 1546)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Clear Space Horizontal Top (DrawingDimHorizTopCS) (on page 1525),
Clear Space Horizontal Bottom (DrawingDimHorizBottomCS) (on page 1523), Absolute

Drawings and Reports Reference Data Guide 708


Dimensions

Dimension Offset (DrawingDimAbsolutePos) (on page 1514), Clear Space Vertical Right
(DrawingDimVertRightCS) (on page 1528), Clear Space Vertical Left (DrawingDimVertLeftCS)
(on page 1527), Absolute Dimension Offset (DrawingDimAbsolutePos) (on page 1514)
Name: Linear_CA_HV_TowardClosestMargin.xml
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: Margin (DrawingGAMarginOnly) (on page 1559)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
(on page 1546)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Clear Space Horizontal Bottom (DrawingDimHorizBottomCS) (on page
1523), Absolute Dimension Offset (DrawingDimAbsolutePos) (on page 1514), Clear Space
Vertical Right (DrawingDimVertRightCS) (on page 1528), Clear Space Vertical Left
(DrawingDimVertLeftCS) (on page 1527), Absolute Dimension Offset (DrawingDimAbsolutePos)
(on page 1514), Clear Space Horizontal Top (DrawingDimHorizTopCS) (on page 1525),
Absolute Dimension Offset (DrawingDimAbsolutePos) (on page 1514)
Name: Linear_CA_H_VLE.xml
Point Generator: Vertical Linear Object Endpoints (DrawingPGStructVert) (on page 1603)
Geometric Analyzer: Default (DrawingGeometricAnalyzer) (on page 1534)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
(on page 1546)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Dimension Anchor: All Columns
Positioning Module: Clear Space Horizontal Top (DrawingDimHorizTopCS) (on page 1525),
Clear Space Horizontal Bottom (DrawingDimHorizBottomCS) (on page 1523), Absolute
Dimension Offset (DrawingDimAbsolutePos) (on page 1514), Clear Space Vertical Right
(DrawingDimVertRightCS) (on page 1528), Clear Space Vertical Left (DrawingDimVertLeftCS)
(on page 1527), Absolute Dimension Offset (DrawingDimAbsolutePos) (on page 1514)
Name: Linear_CA_V_HLE.xml
Point Generator: Horizontal Linear Object Endpoints (DrawingPGStructHoriz) (on page 1547)
Geometric Analyzer: Default (DrawingGeometricAnalyzer) (on page 1534)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
(on page 1546)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Dimension Anchor: All Columns
Positioning Module: Clear Space Horizontal Top (DrawingDimHorizTopCS) (on page 1525),
Clear Space Horizontal Bottom (DrawingDimHorizBottomCS) (on page 1523), Absolute
Dimension Offset (DrawingDimAbsolutePos) (on page 1514), Clear Space Vertical Right
(DrawingDimVertRightCS) (on page 1528), Clear Space Vertical Left (DrawingDimVertLeftCS)
(on page 1527), Absolute Dimension Offset (DrawingDimAbsolutePos) (on page 1514)
Name: Linear_M_HV.xml
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: Margin (DrawingGAMarginOnly) (on page 1559)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)

Drawings and Reports Reference Data Guide 709


Dimensions

Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)


(on page 1546)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516), Absolute
Margin (DrawingDimMarginPos) (on page 1516)
Name: Matchline_Anchor_Horizontal.xml
Point Generator: Object Corners (DrawingPGObjectCorners) (on page 1573)
Geometric Analyzer: Dummy (DummyGeomAnalyzer) (on page 1540)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
(on page 1546)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)
Name: Matchline_Anchor_Vertical.xml
Point Generator: Object Corners (DrawingPGObjectCorners) (on page 1573)
Geometric Analyzer: Dummy (DummyGeomAnalyzer) (on page 1540)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Structure Margin Dimensions


All dimension template files are in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\ folder. Dimension template
filenames match the file name for the corresponding dimension rule. For example, the Structural
Framing Plan_Equipment_Vertical dimension rule uses the Structural Framing
Plan_Equipment_Vertical dimension template.

Vertical Structure Margin Dimensions


Description: Horizontal margin dimensions that use vertical structure objects.
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: Margin (DrawingGAMarginOnly) (on page 1559)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name Dimension Anchor

Structural Framing Plan_Equipment_Vertical Equipment


Plan_Columns_Anchor_Horizontal

Horizontal Structure Margin Dimensions


Description: Vertical margin dimensions that use horizontal structure objects.
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: Margin (DrawingGAMarginOnly) (on page 1559)

Drawings and Reports Reference Data Guide 710


Dimensions

Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)


Vertical Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace) (on
page 1546)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name Dimension Anchor

Equipment Elevation_Equipment_Horizontal Equipment


Elevation_Columns_Anchor_Horizontal

Equipment Plan_Process Equipment


Equipment_Horizontal Plan_Columns_Anchor_Horizontal

Structural Framing Equipment


Plan_Equipment_Horizontal Plan_Columns_Anchor_Horizontal

Structural Framing Equipment


Plan_Equipment_Vertical Plan_Columns_Anchor_Horizontal

Vertical Routable Dimensions


Description: Vertical dimensions that use horizontal route objects.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Horizontal Routable Object (DrawingPGRoutableObjHoriz) (on page 1549)
Geometric Analyzer: Margin (DrawingGAMarginOnly) (on page 1559)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Vertical Content Module: Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on
page 1601)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name Dimension Anchor

Electrical CableTray Electrical CableTray Elevation_Grid


Elevation_CableTray_Vertical Line_Anchor_Vertical, Electrical CableTray
Elevation_CableTray_Vertical,
Matchline_Anchor_Vertical

HVAC Elevation_Ducts_Vertical HVAC Elevation_Grid Line_Anchor_Vertical,


HVAC Elevation_Ducts_Vertical,
Matchline_Anchor_Vertical

Instrument Elevation_Instruments_Vertical Instrument


Elevation_Instruments_Anchor_Vertical

Piping Elevation_Pipes_Vertical Piping Elevation_Grid Line_Anchor_Vertical,


Piping
Elevation_Equipment_Anchor_Vertical

Drawings and Reports Reference Data Guide 711


Dimensions

Vertical Structure Dimensions


Description: Horizontal dimensions that use vertical structure objects.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Vertical Linear Object Endpoints (DrawingPGStructVert) (on page 1603)
Geometric Analyzer: Margin (DrawingGAMarginOnly) (on page 1559)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
(on page 1546)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name Dimension Anchor

Civil Plan_Columns_Horizontal Civil Plan_Columns_Anchor_Horizontal

Electrical Above Ground Electrical Above Ground


Plan_Columns_Horizontal Plan_Columns_Anchor_Horizontal

Electrical CableTray Electrical CableTray


Elevation_CableTray_Horizontal Elevation_Columns_Anchor_Horizontal

Electrical CableTray Electrical CableTray


Elevation_Columns_Horizontal Elevation_Columns_Anchor_Horizontal

Electrical CableTray Plan_Columns_Horizontal Electrical CableTray


Plan_Columns_Anchor_Horizontal

Electrical Elevation_CableTray_Horizontal Electrical


Elevation_CableTray_Anchor_Horizontal

Electrical Elevation_Columns_Horizontal Electrical


Elevation_Columns_Anchor_Horizontal

Electrical Equipment
Elevation_CableTray_Horizontal

Electrical Equipment
Elevation_CableTray_Vertical

Electrical Equipment Electrical Equipment


Elevation_Columns_Horizontal Elevation_Columns_Anchor_Horizontal

Electrical Equipment Electrical Equipment


Plan_Columns_Horizontal Plan_Columns_Anchor_Horizontal

Drawings and Reports Reference Data Guide 712


Dimensions

Dimension Template Name Dimension Anchor

Equipment Elevation_Columns_Horizontal Electrical


Elevation_Columns_Anchor_Horizontal

Equipment Plan_Columns_Horizontal Equipment Plan_Columns_Anchor_Horizontal

HVAC Elevation_Columns_Horizontal

HVAC Elevation_Ducts_Horizontal HVAC


Elevation_Columns_Anchor_Horizontal,
HVAC
Elevation_Equipment_Anchor_Horizontal

HVAC Plan_Columns_Horizontal

HVAC Plan_Ducts_Horizontal HVAC Plan_Columns_Anchor_Horizontal,


HVAC Plan_Equipment_Anchor_Horizontal

Instrument Elevation_Columns_Horizontal Instrument


Elevation_Columns_Anchor_Horizontal

Instrument Elevation_Instruments_Horizontal Instrument


Elevation_Instruments_Anchor_Horizontal

Instrument Plan_Columns_Horizontal Instrument Plan_Columns_Anchor_Horizontal

Instrument Plan_Instruments_Horizontal Instrument Plan_Columns_Anchor_Horizontal

Piping Elevation_Columns_Horizontal Piping Elevation_Columns_Anchor_Horizontal

Piping Elevation_Pipes_Horizontal Piping


Elevation_Columns_Anchor_Horizontal,
Piping
Elevation_Equipment_Anchor_Horizontal

Piping Plan_Columns_Horizontal Piping Plan_Columns_Anchor_Horizontal

Piping Plan_Pipes_Horizontal Piping Plan_Columns_Anchor_Horizontal,


Piping Plan_Equipment_Anchor_Horizontal

Drawings and Reports Reference Data Guide 713


Dimensions

Dimension Template Name Dimension Anchor

Structural Elevation_Braces_Horizontal Structural Framing


Plan_Columns_Anchor_Horizontal, Structural
Framing Plan_Equipment_Anchor_Horizontal

Structural Elevation_Columns_Horizontal Structural


Elevation_Columns_Anchor_Horizontal

Structural Framing Structural Framing


Elevation_Braces_Horizontal Elevation_Columns_Anchor_Horizontal,
Structural Framing
Elevation_Equipment_Anchor_Horizontal

Structural Framing Structural Framing


Elevation_Columns_Horizontal Elevation_Columns_Anchor_Horizontal

Structural Framing Plan_Beams_Horizontal Structural Framing


Plan_Columns_Anchor_Horizontal, Structural
Framing Plan_Equipment_Anchor_Horizontal

Structural Framing Plan_Braces_Horizontal Structural Framing


Plan_Columns_Anchor_Horizontal, Structural
Framing Plan_Equipment_Anchor_Horizontal

Structural Framing Plan_Columns_Horizontal Structural Framing


Plan_Columns_Anchor_Horizontal

Description: Horizontal dimensions that use vertical structure objects.


XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\[Dimension Template
Name].xml
Point Generator: Vertical Linear Object Endpoints (DrawingPGStructVert) (on page 1603)
Geometric Analyzer: Dummy (DummyGeomAnalyzer) (on page 1540)
Annotation Control Generator: Default (DrawingDimGenerator) (on page 1533)
Horizontal Content Module: Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
(on page 1546)
Positioning Module: Absolute Margin (DrawingDimMarginPos) (on page 1516)

Dimension Template Name

Electrical CableTray Elevation_Columns_Anchor_Horizontal

Electrical CableTray Plan_Columns_Anchor_Horizontal

Electrical CableTray Plan_Columns_Anchor_Vertical

Electrical Elevation_Columns_Anchor_Horizontal

Drawings and Reports Reference Data Guide 714


Dimensions

Dimension Template Name

Electrical Elevation_Columns_Horizontal

HVAC Elevation_Columns_Anchor_Horizontal

Piping Elevation_Columns_Anchor_Horizontal

Marine Dimension Templates


The following marine mode dimension templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates folder:

Dimension Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

IS_ProfileSketch None Between Points


_FeatureDistance (ISDimensionBtwPointsPG) (on page
1753)
Convert to Coordinate Dimension
(SMDwgConvertToCoordDimGA) (on page
1531)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

IS_ProfileSketch None Between Points


_FeatureDistance_Top (ISDimensionBtwPointsPG) (on page
1753)
Convert to Coordinate Dimension
(SMDwgConvertToCoordDimGA) (on page
1531)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

Drawings and Reports Reference Data Guide 715


Dimensions

Dimension Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

IS_ProfileSketch None Between Points


_FeatureDistance (ISDimensionBtwPointsPG) (on page
1753)
Convert to Coordinate Dimension
(SMDwgConvertToCoordDimGA) (on page
1531)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

IS_ProfileSketch None Between Points


_ProfileLength (ISDimensionBtwPointsPG) (on page
1753)
Default (DrawingGeometricAnalyzer)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

IS_ProfileSketch None Between Points


_TopFlangeLength (ISDimensionBtwPointsPG) (on page
1753)
Default (DrawingGeometricAnalyzer)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

Drawings and Reports Reference Data Guide 716


Dimensions

Dimension Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

IS_ProfileSketch None Between Points


_FeatureDistance (ISDimensionBtwPointsPG) (on page
1753)
Convert to Coordinate Dimension
(SMDwgConvertToCoordDimGA) (on page
1531)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

StrMfg PinJig None Nearest Pin (ISPinJigPointsOnNearestPin)


IntersectionPoint_To_ (on page 1760)
NearestPin
Dummy (DummyGeomAnalyzer) (on page
1285)
Default (DrawingDimGenerator)
Horizontal Linear Dimensions
(DrawingDimContLinHNoReplace) (on
page 1888)
Vertical Linear Dimensions
(DrawingDimContLinVNoReplace) (on
page 1889)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)
Clear Space Horizontal Bottom
(DrawingDimHorizBottomCS)
Clear Space Horizontal Top
(DrawingDimHorizTopCS)
Clear Space Vertical Left
(DrawingDimVertLeftCS)
Clear Space Vertical Right
(DrawingDimVertRightCS)

Drawings and Reports Reference Data Guide 717


Dimensions

Dimension Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

IS_ProfileSketch None Between Points


_FeatureDistance (ISDimensionBtwPointsPG) (on page
1753)
Convert to Coordinate Dimension
(SMDwgConvertToCoordDimGA) (on page
1531)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

StrMfg PinJig None MidPoint (ISMidPointLabelPG) (on page


Pin_Spacing_M 1389)
Default (DrawingGeometricAnalyzer)
Default (DrawingDimGenerator)
Horizontal Linear Dimensions with Value
Replacement
(DrawingDimContentLinearH) (on page
1885)
DrawingDimContentLinearV (see "Vertical
Linear Dimensions with Value
Replacement
(DrawingDimContentLinearV)" on page
1886)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)
Clear Space Horizontal Bottom
(DrawingDimHorizBottomCS)
Clear Space Horizontal Top
(DrawingDimHorizTopCS)
Clear Space Vertical Left
(DrawingDimVertLeftCS)
Clear Space Vertical Right
(DrawingDimVertRightCS)

Drawings and Reports Reference Data Guide 718


Dimensions

Dimension Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

IS_ProfileSketch None Between Points


_FeatureDistance (ISDimensionBtwPointsPG) (on page
1753)
Convert to Coordinate Dimension
(SMDwgConvertToCoordDimGA) (on page
1531)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

StrMfg None Pin Jig Corners


PinJig_Contour_Corne (SMDwgPinJigCornersDistancePG) (on
rs Straight Distance page 1581)
Dummy (DummyGeomAnalyzer) (on page
1285)
Default (DrawingDimGenerator)
Marine Linear
(SMDrawingDimContentLinear) (on page
1866)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)
Clear Space Horizontal Bottom
(DrawingDimHorizBottomCS)
Clear Space Horizontal Top
(DrawingDimHorizTopCS)
Clear Space Vertical Left
(DrawingDimVertLeftCS)
Clear Space Vertical Right
(DrawingDimVertRightCS)

Drawings and Reports Reference Data Guide 719


Dimensions

Dimension Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

IS_ProfileSketch None Between Points


_FeatureDistance (ISDimensionBtwPointsPG) (on page
1753)
Convert to Coordinate Dimension
(SMDwgConvertToCoordDimGA) (on page
1531)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

StrMfg ProfileSketch None Profile Sketch Linear Feature


Feature_Linear (ISProfileSketchFeatureLinearDimPG) (on
page 1760)
Between Points
(ISDimensionBetweenPointsGA) (on page
1788)
Default (DrawingDimGenerator)
Profile Sketch Linear Feature
(ISProfileSketchFeatureLinearDimCM)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

StrMfg ProfileSketch None Profile Sketch Linear Feature


Feature_Linear_R (ISProfileSketchFeatureLinearDimPG) (on
page 1760)
Between Points
(ISDimensionBetweenPointsGA) (on page
1788)
Default (DrawingDimGenerator)
Profile Sketch Linear Feature
(ISProfileSketchFeatureLinearDimCM)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

Drawings and Reports Reference Data Guide 720


Dimensions

Dimension Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

IS_ProfileSketch None Between Points


_FeatureDistance (ISDimensionBtwPointsPG) (on page
1753)
Convert to Coordinate Dimension
(SMDwgConvertToCoordDimGA) (on page
1531)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

StrMfg ProfileSketch None Profile Sketch Radial Feature


Feature_Radial (ISProfileSketchFeatureRadialDimPG) (on
page 1761)
Between Points
(ISDimensionBetweenPointsGA) (on page
1788)
Default (DrawingDimGenerator)
Profile Sketch Radial Feature
(ISProfileSketchFeatureRadialDimCM)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

StrMfg ProfileSketch None Profile Sketch Label


Labels (SMDwgProfileSketchLabelsContent) (on
page 1447)

Drawings and Reports Reference Data Guide 721


Dimensions

Dimension Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

IS_ProfileSketch None Between Points


_FeatureDistance (ISDimensionBtwPointsPG) (on page
1753)
Convert to Coordinate Dimension
(SMDwgConvertToCoordDimGA) (on page
1531)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

StrMfg ProfileSketch None Between Points


WebThicknessLocMar (ISDimensionBtwPointsPG) (on page
k 1753)
Convert to Coordinate Dimension
(SMDwgConvertToCoordDimGA) (on page
1531)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

StrMfg Template None Template Offset


Offset_Distance (StrMfgTemplateOffsetPG)
Default (DrawingGeometricAnalyzer)
Default (DrawingDimGenerator)
Horizontal Linear Dimensions with Value
Replacement
(DrawingDimContentLinearH) (on page
1885)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

Drawings and Reports Reference Data Guide 722


Dimensions

Dimension Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

IS_ProfileSketch None Between Points


_FeatureDistance (ISDimensionBtwPointsPG) (on page
1753)
Convert to Coordinate Dimension
(SMDwgConvertToCoordDimGA) (on page
1531)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

StrMfg Template None Template Offset


Offset_Height (StrMfgTemplateOffsetPG)
Default (DrawingGeometricAnalyzer)
Default (DrawingDimGenerator)
DrawingDimContentLinearV (see "Vertical
Linear Dimensions with Value
Replacement
(DrawingDimContentLinearV)" on page
1886)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)
Clear Space Vertical Left
(DrawingDimVertLeftCS)

StrMfg TemplateSet None Template Offset


ChordHeight (StrMfgTemplateOffsetPG)
Default (DrawingGeometricAnalyzer)
Default (DrawingDimGenerator)
DrawingDimContentLinearV (see "Vertical
Linear Dimensions with Value
Replacement
(DrawingDimContentLinearV)" on page
1886)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)
Clear Space Vertical Left
(DrawingDimVertLeftCS)

Drawings and Reports Reference Data Guide 723


Dimensions

Dimension Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

IS_ProfileSketch None Between Points


_FeatureDistance (ISDimensionBtwPointsPG) (on page
1753)
Convert to Coordinate Dimension
(SMDwgConvertToCoordDimGA) (on page
1531)
Default (DrawingDimGenerator)
Override (ISDimensionContentOverride)
(on page 1844)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)

StrMfg TemplateSet None Template Offset


GirthLength (StrMfgTemplateOffsetPG)
Default (DrawingGeometricAnalyzer)
Default (DrawingDimGenerator)
Horizontal Linear Dimensions with Value
Replacement
(DrawingDimContentLinearH) (on page
1885)
Absolute Dimension Offset
(DrawingDimAbsolutePos) (on page 1973)
Clear Space Horizontal Bottom
(DrawingDimHorizBottomCS)
Clear Space Horizontal Top
(DrawingDimHorizTopCS)

StrMfg ProfileSketch None SMDwgMfgProfilePlateLocSymContent


ERPlateThicknessLoc
ProfileSketchDetailNameContent
Mark

Drawings and Reports Reference Data Guide 724


SECTION 9

Graphic Rules
Graphic rules in plant drawings control the representation of the model graphics on drawings.
Each filter in the view style can have its own graphic rule. For example, you can represent pipe
runs as single lines, while representing equipment as control point symbols. You can also
resymbolize structural members as single lines with detailed widgets placed along the lines.
You specify graphic rules when you edit an existing view style or create a new view style with
Tools > Define View Style.
For plant drawings, in the Graphic Rule box on the View Style Properties dialog box, select
More to display the Select Graphic Rule dialog box.
View Style Properties Dialog Box (on page 59)
Select Graphic Rule Dialog Box (on page 68)
Graphic rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\GraphicRules folder.
You have several types of rules available, such as then following examples.

Graphic rules use custom graphic modules to achieve the needed resymbolization. For more
information Custom Graphic Modules (on page 972)

Graphic Rules in Drawings by Rule


Marine mode graphic rules control the appearance of objects in a drawing view, including the
following:
 Handling of visible and hidden lines

Drawings and Reports Reference Data Guide 725


Graphic Rules

 Assigning line type, thickness, and color


 Resymbolizing
 Assigning custom graphic modules
 Clipping the drawing of objects that fall outside of the volume.
You assign a graphic rule and its properties as part of a drawings by rule view style with Tools >
Define View Style. In the Graphic Rule box on the Edit Ruleset View Style dialog box, select
Edit Custom to display the Graphic Style dialog box.
Actions Tab (Edit Ruleset View Style Dialog Box) (on page 119)
Graphic Tab (Graphic Style Dialog Box) (on page 126)
Graphic rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\GraphicRules folder. You can also create
customized marine graphic rules. For more information, see Customized Graphic Rules (on
page 726).
If an object is filtered in more than one row of the view style, the graphic rule in the
bottommost row applies to the object.
See Also
View Style Rules (on page 57)

Customized Graphic Rules


You can create customized marine mode graphic rules that use the graphic modules and
properties needed for your drawings. Customized rules must be located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DBRRules\MetaGraphicRules folder. Each
graphic rule has a subfolder containing an XML file and a resource DLL. You must customize
the XML file and compile the resource DLL from customized source code.
After you create a customized graphic rule, it is available for any generic source selected using
the Select Object Type option in the Source box of the Edit Ruleset View Style dialog box.
The customized rule then displays as an option for Graphic Rule Type in the Graphic tab of the
Graphic Style dialog box. For more information, see Actions Tab (Edit Ruleset View Style
Dialog Box) (on page 119) and Graphic Tab (Graphic Style Dialog Box) (on page 126).
Landing Curve with End Cuts (on page 729) is delivered as an example graphic rule
using this structure.

Cutting Surface Intersection


This rule draws an object at its intersection with a surface defined by the selected cutting
surface rule. This graphic rule is typically used when the object to be drawn is non-planar and
the result of its intersection at a cutting surface is needed instead of its full projection.

Properties
Graphic Module
Specifies the graphic module used to draw the intersected object. Select any delivered
graphic module. For more information, see Custom Graphic Modules (on page 972).

Drawings and Reports Reference Data Guide 726


Graphic Rules

Cutting Surface Definition


Specifies the method of defining the cutting surface.
 Expansion Surface - The target expansion surface is used as the cutting surface.
 Generic Cutting Surface - Extends profile landing curve, seam, and reference
curve geometry to obtain an intersection with the cutting surface.
 Generic Plate Cutting Surface - Determines the appropriate cutting surface to use
for plates based on bound and intersection conditions between target and
non-target surfaces.
 Surface from Targets - The surfaces of the target objects are used as the cutting
surface. Non-target objects are the intersected objects and are cut at this surface.
For example, a knuckled deck is the target, and is bounded to a curved hull. The
cutting surface follows the deck surfaces, and the hull is cut at the intersection with
the cutting surface.

Additional cutting surface rules can be created and added to [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DBRRules\CuttingDefinitions.
Visible Line Style
Specifies the line style for visible edges of objects and for centerlines in the Centerline
aspect.
Hidden Line Style
Specifies the line style for edges of an object hidden by the surface of other objects and for
centerlines in the Centerline aspect. The line style is shown as dashed red in the example
below.

Drawings and Reports Reference Data Guide 727


Graphic Rules

Occluded Line Style


Specifies a line style when the line is aligned with and completely hidden by edges of
another object. For example, you may use this style when you have two objects that are
aligned but at different elevations. The line style is shown as dashed red behind the solid
black visible line in the example below.

Occluded lines are drawn but are frequently not visible because the visible line
style dominates.
Layer
Specifies the drawing layer on which the graphic is placed. For example, type
LinesAndSymbols in the value field to place your line graphics on the LinesAndSymbols
layer of your drawing. If the layer does not already exist in the template you are using to
create drawings, the software creates the layer automatically.
Clipping
Indicates whether or not the graphics are clipped within the drawing. For example, in plan
views, certain objects such as stairs or ladders are best represented unclipped by the
drawing volume. You would specify a filter row in the view style for stairs or ladders and set
this option to unclipped to achieve the needed graphic representation.
Z Order
Sets the top-down display order of object graphics along the z-axis (that is, in and out of the
view plane). Higher values have higher priority. For example, grid lines have lower priority
than plates and should be assigned lower values.

Draw 2D Graphics
This rule reads XML-based data and converts it to two-dimensional vector graphics.

Properties
Geometry Transformation
Specifies how the XML data is converted to geometry. Select Default to convert to all data,
including features, to their actual geometry. Select Feature To Line to convert all data
except features to their actual geometry. Each feature, regardless of actual geometry, is

Drawings and Reports Reference Data Guide 728


Graphic Rules

drawn as a line. This is useful when the feature is represented by a symbol.


Line Style
Specifies the style for all vectors.
Layer
Specifies the drawing layer on which the graphic is placed. For example, type
LinesAndSymbols in the value field to place your line graphics on the LinesAndSymbols
layer of your drawing. If the layer does not already exist in the template you are using to
create drawings, the software creates the layer automatically.
Z Order
Sets the top-down display order of object graphics along the z-axis (that is, in and out of the
view plane). Higher values have higher priority. For example, grid lines have lower priority
than plates and should be assigned lower values.

Landing Curve with End Cuts


This rule replaces a profile part with a landing curve and embedded end cut symbols.

Graphic Module
Specifies a module that allows you to customize the landing curve graphics. For more
information, see Custom Graphic Modules (on page 972).
End Cut Rule
Specifies the end cut embedded symbol rule.
When using the steel order rule set (ISSteelOrderRuleSet.Default), the default value is
ProfilePartEndCut. For more information, see End Cut Embedded Symbols (Steel Order
Rule Set) (on page 1045).
When using the generic rule set (DBRGenericRuleSet.GenericRuleSet), you can select
Molded Form Rule or Structural Detailing Rule. For more information, see End Cut
Embedded Symbols (Generic Rule Set) (on page 1053).
Visible Line Style
Specifies the line style for the landing curve.

Drawings and Reports Reference Data Guide 729


Graphic Rules

Hidden Line Style


Specifies the line style for edges of an object hidden by the surface of other objects and for
centerlines in the Centerline aspect. The line style is shown as dashed red in the example
below.

Occluded Line Style


Specifies a line style when the line is aligned with and completely hidden by edges of
another object. For example, you may use this style when you have two objects that are
aligned but at different elevations. The line style is shown as dashed red behind the solid
black visible line in the example below.

Occluded lines are drawn but are frequently not visible because the visible line
style dominates.
Layer
Specifies the drawing layer on which the graphic is placed. For example, type
LinesAndSymbols in the value field to place your line graphics on the LinesAndSymbols
layer of your drawing. If the layer does not already exist in the template you are using to
create drawings, the software creates the layer automatically.
Clipping
Indicates whether or not the graphics are clipped within the drawing. For example, in plan
views, certain objects such as stairs or ladders are best represented unclipped by the
drawing volume. You would specify a filter row in the view style for stairs or ladders and set
this option to unclipped to achieve the needed graphic representation.
Z Order
Sets the top-down display order of object graphics along the z-axis (that is, in and out of the
view plane). Higher values have higher priority. For example, grid lines have lower priority
than plates and should be assigned lower values.

Not Drawn
Stops all object processing, including drawing, labeling, and dimensioning.

Drawings and Reports Reference Data Guide 730


Graphic Rules

Replace Intersection Seam with Slot Symbol


When a profile part intersects a plate part, and one or both of the parts are not detailed, this rule
replaces the intersection seam with a slot symbol.

When the intersecting profile part and the intersected plate part are both detailed, the
software creates the slot in the model, and the slot is drawn using the Visible/Hidden Edges
(VHL) (on page 734) graphic rule.
Slot Rule
Specifies the slot embedded symbol rule. The default value is Default Slot. For more
information, see Slot Embedded Symbols (on page 1056).
Hidden Line Style
Specifies the line style for edges of an object hidden by the surface of other objects and for
centerlines in the Centerline aspect. The line style is shown as dashed red in the example
below.

Occluded Line Style


Specifies a line style when the line is aligned with and completely hidden by edges of
another object. For example, you may use this style when you have two objects that are
aligned but at different elevations. The line style is shown as dashed red behind the solid
black visible line in the example below.

Occluded lines are drawn but are frequently not visible because the visible line
style dominates.

Drawings and Reports Reference Data Guide 731


Graphic Rules

Hidden by Self Line Style


Specifies the line style for edges of an object that are hidden by the surface of the same
object and for centerlines in the Centerline aspect. The line style is shown as dashed red in
the example below.

Clipped Line Style


Specifies a line style for an object that is clipped by the drawing view. You can use this style
to distinguish between different clipped objects. For example, the following image shows a
clipped object with a Zig-Zag line style:

Layer
Specifies the drawing layer on which the graphic is placed. For example, type
LinesAndSymbols in the value field to place your line graphics on the LinesAndSymbols
layer of your drawing. If the layer does not already exist in the template you are using to
create drawings, the software creates the layer automatically.
Z Order
Sets the top-down display order of object graphics along the z-axis (that is, in and out of the
view plane). Higher values have higher priority. For example, grid lines have lower priority
than plates and should be assigned lower values.

Replace Objects with Line


This rule replaces linear objects in the graphic view, such members, with single lines. If possible,
the centerline of the object is used.

Properties
Graphic Module
Specifies a module that allows you to customize the graphics included in your graphic rule.

Drawings and Reports Reference Data Guide 732


Graphic Rules

For more information, see Custom Graphic Modules (on page 972).
For orthographic drawings, this module affects only those items that meet the
criteria of the filter on the selected row of the table in the View Style Properties dialog box.
To apply a module to all items in the view style, choose a Graphic Preparation Rule on the
View Style Properties dialog box.
Visible Line Style
Specifies the line style for visible edges of objects and for centerlines in the Centerline
aspect.
Hidden Line Style
Specifies the line style for edges of an object hidden by the surface of other objects and for
centerlines in the Centerline aspect. The line style is shown as dashed red in the example
below.

Occluded Line Style


Specifies a line style when the line is aligned with and completely hidden by edges of
another object. For example, you may use this style when you have two objects that are
aligned but at different elevations. The line style is shown as dashed red behind the solid
black visible line in the example below.

Occluded lines are drawn but are frequently not visible because the visible line
style dominates.
Layer
Specifies the drawing layer (or level, if saving to a MicroStation file) on which the graphic is
placed. For example, type LinesAndSymbols in the value field to place your line graphics
on the LinesAndSymbols layer of your drawing. If the layer does not already exist in the
template you are using to create drawings, the software creates the layer automatically.
For graphic rules used in the conversion to MicroStation files, the software
only recognizes whole numbers between 1 and 63, inclusive, in the Layer field. Other
values are ignored, and the object is placed on level 1 in the DGN file.
Z Order
Sets the top-down display order of object graphics along the z-axis (that is, in and out of the
view plane). Higher values have higher priority. For example, grid lines have lower priority
than plates and should be assigned lower values.

 All of the line styles in the pull-down lists are found in the Styles.sha and ISStyles.sha files,
located in the SharedContent share in the [Reference Data Product

Drawings and Reports Reference Data Guide 733


Graphic Rules

Folder]\SharedContent\Drawings\Catalog\Templates folder. You can add new line styles to


the files.
 Drawing view styles work in a top-to-bottom priority order. If an object finds its match in
several different filters, the last graphic rule applied (bottommost row) is used.

Resymbolized by Rule Set


This is the default value for graphic rules and uses the object resymbolization defined in the
selected rule set. You can customize other properties such as line type, thickness, and color.

Visible/Hidden Edges (VHL)


This rule creates a wireframe representation of objects and allows visible and hidden lines to
have different styles.

Properties
Graphic Module
Specifies a module that allows you to customize the graphics included in your graphic rule.
For more information, see Custom Graphic Modules (on page 972).
For orthographic drawings, this module affects only those items that meet the
criteria of the filter on the selected row of the table in the View Style Properties dialog box.
To apply a module to all items in the view style, choose a Graphic Preparation Rule on the
View Style Properties dialog box.
Visible Line Style
Specifies the line style for visible edges of objects and for centerlines in the Centerline
aspect.
Hidden Line Style
Specifies the line style for edges of an object hidden by the surface of other objects and for
centerlines in the Centerline aspect. The line style is shown as dashed red in the example
below.

Hidden By Self Line Style


Specifies the line style for edges of an object that are hidden by the surface of the same

Drawings and Reports Reference Data Guide 734


Graphic Rules

object and for centerlines in the Centerline aspect. The line style is shown as dashed red in
the example below.

Occluded Line Style


Specifies a line style when the line is aligned with and completely hidden by edges of
another object. For example, you may use this style when you have two objects that are
aligned but at different elevations. The line style is shown as dashed red behind the solid
black visible line in the example below.

Occluded lines are drawn but are frequently not visible because the visible line
style dominates.
Clipped Line Style
Specifies a line style for an object that is clipped by the drawing view. You can use this style
to distinguish between different clipped objects. For example, the following image shows a
clipped object with a Zig-Zag line style:

Layer
Specifies the drawing layer (or level, if saving to a MicroStation file) on which the graphic is
placed. For example, type LinesAndSymbols in the value field to place your VHL graphics
on the LinesAndSymbols layer of your drawing. If the layer does not already exist in the
template you are using to create drawings, the software creates the layer automatically.
For graphic rules used in the conversion to MicroStation files, the software
only recognizes whole numbers between 1 and 63, inclusive, in the Layer field. Other
values are ignored, and the object is placed on level 1 in the DGN file.

Drawings and Reports Reference Data Guide 735


Graphic Rules

Visible Fill Style


Specifies the fill style for visible surfaces of objects within the clipped area of the view. Every
face of every instance of the objects matching the applied filter in the view style will have the
selected fill style. For an example workflow showing how fill styles can be applied, see Apply
a Visible Fill Style to a Drawing (on page 98). In the following graphic, everything that is a
slab (everything except the two barrels and the wall piece) has a Hexagon fill style applied.

Clipped Solid Fill Style


Specifies the fill style for clipped faces of objects that match the applied filter in the view
style. For more information, see Apply a Clipped Solid Fill Style to a Drawing (on page 101).
For example, the following graphic shows where a clipped wall surface is filled with a
Honeycomb fill style, while the underlying slab surfaces (also clipped) are not filled.

Make Clipped Solid Monolithic


When set to Yes, specifies that all solid objects assigned with this graphic rule are based on
the view style tests they passed (Filter, Orientation, Clipping) and that all of the objects in
each group are merged into a transient object. The software finds the intersection body or
contour of the transient object with the drawing volume. Only the intersection contour is
drawn and filled on the top of the constructing objects, masking out their common internal
edges. For more information, see Use the Make Clipped Solid Monolithic Option (on page
109).
Aspect (Multi-Select)
Specifies the envelope around the objects for VHL processing. Examples are maintenance
or insulation envelopes. You can select multiple aspects by holding the CTRL or SHIFT
keys. This setting is currently not supported.

Drawings and Reports Reference Data Guide 736


Graphic Rules

Show Centerline
Specifies whether the centerline displays in addition to the 3D graphics. If you reset this
property to No, the Centerline Visible Line Style, Centerline Hidden Line Style, and
Centerline Extension boxes display <Not Drawn>.
Centerline Visible Line Style
Specifies the line style for a visible centerline.
Centerline Hidden Line Style
Specifies the line style for a hidden centerline.
Centerline Extension
Specifies the length of the extension at the ends of a centerline.

 Centerlines are only drawn on the appropriate types of geometry on equipment, such as
revolved surfaces, tori, cones, ruled surfaces with elliptical top and base curves, and
projections.
 Centerlines are drawn for all straight pipe, bent pipe, pipe nozzles, and HVAC nozzles.
Clipping
Indicates whether or not the graphics are clipped within the drawing. For example, in plan
views, certain objects such as stairs or ladders are best represented unclipped by the
drawing volume. You would specify a filter row in the view style for stairs or ladders and set
this option to unclipped to achieve the needed graphic representation.
Make Transparent
Specifies how transparency is applied to an aspect:

Drawings and Reports Reference Data Guide 737


Graphic Rules

 No - The aspect will not be transparent.

 For all objects in view - Full transparency. The aspect of the object is transparent for
all other objects and all aspects of the same object (that is, it does not hide other objects
or aspects of the same object).

 For other aspects of same objects - Relative transparency between objects. The
aspect of the object is transparent only for other aspects of the same object (that is, the
given aspect does not hide other aspects for the same object, such as the flanges and
web of a built-up member, but hides other objects).

In orthographic view styles, the Make Transparent option is especially useful when you
need to show objects beneath another object. In drawings by rule view styles, the Make
Transparent option is only available for members. For example workflows, see Apply
Transparency to an Orthographic View Style (on page 103).
Tangent Edge Visible Line Style
Specifies the line style for visible tangent edges of objects.
There is not currently a separate property for specifying the line style of hidden
tangent edges. Smart 3D uses this property for any visible, hidden, occluded, or
self-occluded tangent edges.
Hidden Fill Style
Specifies the fill style for hidden surfaces of objects within the clipped area of the view.
Every face of every instance of the objects matching the applied filter in the view style will
have the selected fill style.
Boundary Overlap Fill Style
Specifies a fill style for the boundary overlap, where the object extends past the view
boundary.

Drawings and Reports Reference Data Guide 738


Graphic Rules

Z Order
Sets the top-down display order of object graphics along the z-axis (that is, in and out of the
view plane). Higher values have higher priority. For example, grid lines have lower priority
than plates and should be assigned lower values.

 All of the line styles in the pull down lists are found in the Styles.sha and ISStyles.sha files,
located in the SharedContent share in the [Reference Data Product
Folder]\SharedContent\Drawings\Catalog\Templates folder. You can add new line styles to
the files.
 Drawing view styles work in a top-to-bottom priority order. If an object finds its match in
several different filters, the last graphic rule applied (bottommost row) is used.
 You can create new line styles to use with the properties on this dialog box. For more
information, see Create Line Styles to Use in Drawing View Styles (on page 89).

Drawings and Reports Reference Data Guide 739


SECTION 10

Labels
Drawing labels provide information about the objects inside a drawing view, such as properties
from a database report, text, or graphics (such as a north arrow). The following illustration
shows three label examples:

1 - Elevation label
2 - Text label with border and leader
3 - North arrow

Labels are added to drawings either automatically through label rules, or manually using the
Place a Label command when the drawing is open in the SmartSketch Drawing Editor. For
more information on manually placing labels, see Place a Manual Label in the Orthographic
Drawings User's Guide, available from Help > Printable Guides.
Drawing labels are automatically added to drawings using a multi-tiered approach. A label rule
places one or more labels. Each label uses a label template. Each template uses the necessary
annotation modules, symbols, and reports to format the label, control its appearance, and place
the label on a drawing.

Drawings and Reports Reference Data Guide 740


Labels

The flowchart below illustrates label structure.

In previous versions of Smart 3D, you manually edited an XML file to modify a label rule or
template. The software now provides the Label Rule Manager, a graphical user interface that
allows you to edit the available properties for a label template. Depending on your settings for
modules and properties in the Label Rule Manager, the list of available properties can change.
The Label Rule Manager does not save or display properties and modules that are unavailable
for the template you are modifying. For more information, see Label Rule Manager (on page
1099).

 There are some label rules and templates that the Label Rule Manager does not support.
To make changes to these unsupported rules and templates, you must manually edit the
associated XML file.
 Label rule and label template XML files are delivered in the following folders:
 Label rules - [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\LabelRules
 Label templates and symbols used by the label rules - [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates

Drawings and Reports Reference Data Guide 741


Labels

You can create label rules that automatically place labels with or without text box borders and
leader lines. You can even specify that the labels find clear space on the drawing, as shown
below.

The delivered rules include several rule types, such as control point labels, grid line labels,
name labels, name and part labels, and piping labels. Assign label rules as part of the drawing
view style with the Tools > Define View Style command in the Drawings and Reports task. For
more information, see the Orthographic Drawings User's Guide.
Most labels are managed by and bulkloaded from the Reports.xls file. This workbook contains
the reference data for labels. For additional information, see Reports Reference Data (on page
651). Labels specific to marine mode drawings by rule are not managed by the Reports.xls file.
For more information, see Label Rules in Drawings by Rule (on page 852).
Many label rules place only one label, so the rule uses only one label template. The
rule and template XML files frequently have the same file name but are located in different
folders.
To manually relocate or reorganize the labels folder structure, edit each associated label rule
XML file. After each <name> tag of the XML file, type the correct relative path and name for the
template files, as in the example below.
Delivered path

Modified path

Drawings and Reports Reference Data Guide 742


Labels

Layering Labels
You can specify the 2D layer on which your annotation labels display in the drawing using the
Label Layer property in the Label Rule Manager. If the layer does not already exist in the
template you are using to create drawings, the software creates the layer automatically. For
more information, see Label Layer (labelLayer) (on page 1339).
In previous versions of Smart 3D, you added a <labelLayerSettings> definition using
the <labelLayer> tag as shown in the example below:

Prioritizing Labels
When placing clear space labels (that is, labels that do not overlap other graphics or labels), you
can use the Priority property in the Label Rule Manager to dictate which labels in the drawing
have a higher chance of being placed at their preferred positions, as specified by the positioning
module.
The software attempts to place an annotation (such as a label or a dimension) in clear
space as close as possible to that object's Connect Point. Multiple annotations do not
overlap. The Priority property allows you to assign a priority to each annotation, with 1
being the highest priority. The software places the annotation with the highest priority
closest to that object's Connect Point. Additional annotations with lower priorities are
placed further away from the corresponding object's Connect Point.
To define the priority, type a positive integer in the Priority text box.

1 - Equipment labels placed with Priority set to 1


2 - Structure label placed with Priority set to 2

Drawings and Reports Reference Data Guide 743


Labels

1 - Equipment label placed with Priority set to 2


2 - Structure label placed with Priority set to 1

Labels that have the same priority number do not overlap in the drawing if there is sufficient
clear space, but neither label receives preferential treatment for placement.
See Also
Label Rules in Drawings by Rule (on page 852)
Label Templates in Drawings by Rule (on page 859)
Symbol Definition for Drawings by Rule (on page 916)
Report Template (on page 1452)
Annotation Modules (on page 1728)
View Style Rules (on page 57)

Compound Labels
Labels can be combined within a label rule or a template to produce a compound label. Benefits
to using a compound label include:
 Reducing the number of label rules in a view style
 Applying different formats to the various parts of a label
 Eliminating the requirement for a query interpreter
 Reducing a label footprint so that less open space can be used to place the label
 Using different placement modules for the various parts of a label
The component parts of compound labels behave differently depending on how you create the
compound label. You can create compound labels using the methods described below:
 Combine label components in a label rule. The software places the component parts
automatically, and you can move the component parts independently of each other. For
more information, see Create a Compound Label Using Label Rules (on page 745).
 Combine label components in a label template. The software produces a single independent
symbol that contains two labels. If you reposition one of the labels, the software

Drawings and Reports Reference Data Guide 744


Labels

automatically repositions the second label. For more information, see Create a Compound
Label with a Combined Symbol (on page 748).
 Add multiple label templates to a content module. The software produces two independent
labels that you manually place. You can move the component parts independently of each
other. For more information, see Create a Compound Label Using the Content Module (on
page 750).

Create a Compound Label Using Label Rules


Some label rules only use one label template, but you can create a custom compound label by
adding multiple templates to a label rule. For example, the delivered Equipment Plan_Process
Equipment_North-East Coordinate label rule uses three different label templates to create a
compound label.

 You must have write permission to the SharedContent folder.


 This method produces two independent labels on a drawing. These labels cannot be placed
in the same position, and behave as independent labels. For information on combining
labels into one symbol, see Create a Compound Label with a Combined Symbol (on page
748).
 Compound labels produced with this method can only be used in automatic placement. You
cannot manually place a compound label created from label rules.
 You must have already defined the view style type and the View Style Properties dialog
box must be displayed. For more information, see Define View Style Dialog Box (on page
58) and View Style Properties Dialog Box (on page 59).

Create a compound label for the name and elevation of a piece of equipment:
1. Select Equipment Elevation_Equipment_Name in the Select Label Rule dialog box, as
shown below:

2. Click Copy.
The Copy Label Rule dialog box displays.
For information on selecting a label rule, see Select Label Rule Dialog Box (on
page 84).
3. Select the label rule name in the Change Rule Name text box and type New Equipment
Label, and then click Copy.

Drawings and Reports Reference Data Guide 745


Labels

The Copy Label Rule dialog box closes. New Equipment Label displays in the Select
Label Rule dialog box. The software creates the following files using New Equipment
Label for the name:
New Equipment Label.sym symbol file
New Equipment Label.xml label rule template
New Equipment Label.rpt report template
New Equipment Label.rqe query file
New Equipment Label.rfm formatting file
4. With New Equipment Label still selected, click Properties on the Select Label Rule dialog
box.
The Label Rule Manager opens the New Equipment Label rule, as shown below.

5. Click Add a template to this rule ( on the right side of the Template List box).
The software displays a list of view styles affected by the rule change, and prompts you to
confirm the action.
6. Click Yes to confirm.
The Select Templates dialog box displays.
7. Press CTRL + to select the two templates listed below, and then click Open:
 Equipment Elevation_Equipment_Elevation
 Equipment Elevation_Equipment_Elevation_Symbol
The Select Templates dialog box closes. The two templates you added display in the Label
Rule Manager Template List.
8. Click Save & Close.
The Label Rule Manager closes.

Drawings and Reports Reference Data Guide 746


Labels

9. Add the new compound label to the appropriate view style. For more information on adding
a label rule to a view style, see View Style Properties Dialog Box (on page 59).
In this example, the software creates a new compound label called New Equipment Label.

Examples
The following illustration shows a piece of equipment in an elevation drawing that uses the
original Equipment Elevation_Equipment_Name label rule:

1 - Equipment label with default leader and breakline

The following illustration shows the annotations placed by the New Equipment Label
compound label:

1 - Elevation symbol
2 - Elevation label
3 - Equipment label with default leader and breakline

See Also
Compound Labels (on page 744)
Select Label Rule Dialog Box (on page 84)

Drawings and Reports Reference Data Guide 747


Labels

Create a Compound Label with a Combined Symbol


To create a custom compound label with combined symbols, modify the label .xml and label
.sym files. Compound labels with combined symbols are always positioned together. To place a
compound label that creates two independent symbols, see Create a Compound Label Using
Label Rules (on page 745).

 You must have write permission to the SharedContent folder.


 Smart 3D delivers label templates and symbol files in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder.
 Label rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\LabelRules folder.
 This method produces a single independent symbol that contains two labels. If you
reposition one of the labels, the software automatically repositions the second label.
 You must have already defined the view style type and the View Style Properties dialog
box must be displayed. For more information, see Define View Style Dialog Box (on page
58) and View Style Properties Dialog Box (on page 59).
 This procedure must be done manually. You cannot use the Label Rule Manager to create
a compound label.

Create a compound label rule


1. Select BopPipePort1_CA_JL.xml in the Select Label Rule dialog box, as shown below.

2. Click Copy.
The Copy Label Rule dialog box displays.
3. Select the label rule name in the Change Rule Name text box and type
BopPipePort1_CA_JL_Custom. Click Copy.
The Copy Label Rule dialog box closes. BopPipePort1_CA_JL_Custom displays in the
Select Label Rule dialog box. The software creates the following files using
BopPipePort1_CA_JL_Custom for the name:

Drawings and Reports Reference Data Guide 748


Labels

BopPipePort1_CA_JL_Custom.sym symbol file


BopPipePort1_CA_JL_Custom.xml label rule template
BopPipePort1_CA_JL_Custom.rpt report template
BopPipePort1_CA_JL_Custom.rqe query file
BopPipePort1_CA_JL_Custom.rfm formatting file
4. Using Windows Explorer, browse to the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder and open
BopPipePort1_CA_JL_Custom.xml in a text editor or a third-party .xml document editor.
5. Add a label to the resulting symbol as shown in the following modified .xml example:
Original

<content>
<contentModule value="DrawingLabelHelper"/>
<ID attributeName="BopPipePort1">BopPipePort1.rtp</ID>
</content>
Modified

<content>
<contentModule value="DrawingLabelHelper"/>
<ID attributeName="BopPipePort1">BopPipePort1.rtp</ID>
<ID attributeName="Piping Plan_LineNumber_Longest Segment">Piping
Plan_LineNumber_Longest Segment.rtp</ID>
</content>
6. Repeat the previous step to add more labels to the symbol.
7. Save the changes, and then close the file.

Customize the symbol file and add it to the compound label rule
1. Browse to the [Reference Data Folder]\SharedContent\Drawings\Catalog\Labels\Templates
folder, and then open BopPipePort1_CA_JL_Custom.sym in SmartSketch Drawing Editor.

2. Click Text Box .


3. Click to place the text box, and then position it relative to the existing symbol.
4. Type some text into the text box field (for example, type Test).

5. Click Select Tool and right-click the text box you created. Select Properties.
The Text Box Properties dialog box displays.
6. Click the User tab, and then type ID in the Name text box.
7. Type Piping Plan_LineNumber_Longest Segment in the Value text box. Click Add, and
then click OK.
The Text Box Properties dialog box closes.

 The text you entered into the Value text box is the name of the report template (.rtp) that
you added when you created the compound label rule.
 In most cases, the name you type in the Value box is identical to the .rtp file name.

Drawings and Reports Reference Data Guide 749


Labels

 The .rtp name is also listed inside the ID attributeName tag in the label template .xml
file.
8. Insert a dummy text box between the two labels, as shown in the following example:

1 - Text box manually placed between two custom labels

Smart 3D connects a leader to the last text box placed in the symbol file. Adding
a dummy text box in the SmartSketch Drawing Editor allows you to control where the leader
connects to the compound label.
9. Save the changes and exit SmartSketch Drawing Editor.
10. Add the new compound label to the appropriate view style. For more information on adding
a label rule to a view style, see View Style Properties Dialog Box (on page 59).
In this example, the software creates a new compound label called
BopPipePort1_CA_JL_Custom.
See Also
Compound Labels (on page 744)
Select Label Rule Dialog Box (on page 84)
Create a Compound Label Using Label Rules (on page 745)

Create a Compound Label Using the Content Module


Although some label rules only use one label template in an .xml file, you can call multiple label
templates in an .xml file to create a compound label with independent, manually placed
components.

 This procedure must be done manually. You cannot use the Label Rule Manager to create
a compound label.
 You must have write permission to the SharedContent folder.
 Smart 3D delivers label templates and symbol files in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder.
 This method produces two independent labels on a drawing. The software does not always
place the labels in the same position, and the labels behave as independent labels. For
information on combining labels into one symbol, see Create a Compound Label with a
Combined Symbol (on page 748).

Drawings and Reports Reference Data Guide 750


Labels

 The software places these compound labels with a single origin point, as opposed to
separate origins for each symbol. For information on creating a compound label with
individual origin points, see Create a Compound Label Using Label Rules (on page 745).
 Compound labels created from content modules must be placed manually. You cannot add
these labels to a view style for automatic placement.

Create a new compound label


1. Browse to the [Reference Data Folder]\SharedContent\Drawings\Catalog\Labels\Templates
folder, and create a new .xml label template called Instrument Name_Elevation.
To create a new .xml label template, right-click in the \Templates folder and select
New > Text Document. Rename New Text Document.txt to Instrument
Name_Elevation.xml, and then click Yes when the software prompts you to confirm the file
extension change.
-OR-
Create a new file called Instrument Name_Elevation.xml using a text editor or a third-party
.xml document editor.
2. Open Instrument Name_Elevation.xml in a text editor or a third-party .xml document
editor, and add the following .xml code:
<?xml version="1.0" encoding="UTF-8"?>
<label>
<content>
<contentModule value="DrawingLabelHelper" />
<embeddedLabel>Instrument
Elevation_Equipment_Name</embeddedLabel>
<embeddedLabel>SP3DCoordinate_CA_JL</embeddedLabel>
</content>
</label>
3. Save the changes, and then close the file.

Create a new .sym file


1. Make a copy of Instrument Name_Elevation.sym in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder. Rename the copy to
Instrument Elevation_Equipment_Name.sym.
2. Open Instrument Elevation_Equipment_Name.sym in the SmartSketch Drawing Editor, and
delete any existing symbols or graphics.

3. Open Symbol Explorer , and drag Instrument Elevation_Equipment_Name.sym and


SP3DCoordinate_CA_JL.sym to the active sheet.
4. Right-click the Instrument Elevation_Equipment_Name symbol, and select Properties.
The Symbol Properties dialog box displays.
5. On the User tab, type EmbeddedLabel in the Name box, and then type Instrument
Elevation_Equipment_Name in the Value box.
6. Click Add, and then click OK.
The Text Box Properties dialog box closes.

Drawings and Reports Reference Data Guide 751


Labels

7. Right-click the SP3DCoordinate_JA_CL symbol, and then select Properties.


The Symbol Properties dialog box displays.
8. On the User tab, type EmbeddedLabel in the Name box.
9. Type SP3DCoordinate_JA_CL in the Value box. Click Add, and then click OK.
The Symbol Properties dialog box closes.
10. Save the changes, and then exit the SmartSketch Drawing Editor.
11. Add the new compound label to the appropriate view style. For more information on adding
a label rule to a view style, see View Style Properties Dialog Box (on page 59).
In this example, the software creates a new compound label called Instrument
Elevation_Equipment_Name.

Example
The following illustration shows a compound label that combines the Instrument
Elevation_Equipment_Name and SP3DCoordinate_JA_CL symbols.

1 - Name component
2 - Elevation component

Drawings and Reports Reference Data Guide 752


Labels

Group Labels
The software delivers Name_None_CA_JL as an example label rule that places
single or group labels. See your administrator for other customized group label rules that may be
in your catalog.
A group label allows selection of multiple objects and groups the labels for the objects.
Optionally, the group label also places leaders and bubble labels.

1 - Group label
2 - Leaders
3 - Bubble labels
You can add a group label as an option to any manually placed label. The Place a Label
command places a single label when you select one object or a group label when you select
multiple objects. You can find the Name_None_CA_JL.xml file in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder.

Defining a group label


You must have already defined the view style type and the View Style Properties
dialog box must be displayed. For more information, see Define View Style Dialog Box (on page
58) and View Style Properties Dialog Box (on page 59).
1. Select Name_None_CA_JL in the Select Label Rule dialog box, as shown below.

Drawings and Reports Reference Data Guide 753


Labels

2. Click Properties.
The Label Rule Manager opens the Name_None_CA_JL template, as shown below.

3. To change the distance between grouped labels, type a new value in the Group Label
Clearance box.
4. To suppress the bubble the software draws around grouped labels, select NONE from the
Group Bubble Label list.
5. Click Save & Close to exit the Label Rule Manager.
Group Bubble Label
Defines the bubble label template and symbol used by the group label. If you select NONE,
then the software places the group labels without bubble labels.

Drawings and Reports Reference Data Guide 754


Labels

Group Label Clearance


Specifies the distance between labels in the group.

Leaders
Leaders jog as needed based on the position of the label group to the objects, as shown in the
following examples.
Group label with horizontal leader

Group label with vertical leader

Group label with fanned leader

Drawings and Reports Reference Data Guide 755


Labels

Group label with no leader

Sorting and Alignment


The software sorts the labels according to the relative location of the objects (as defined by the
object center points) and the type of leaders.

Leader Type Sorting

Horizontal Left to right

Vertical Top to bottom

Fanned To minimize crossing of leaders

None Top to bottom or left to right

Drawings and Reports Reference Data Guide 756


Labels

Labels align to the leader connection side.


Right side alignment

Left side alignment

Selecting multiple objects for the group label


Use one of the following methods to select objects in the SmartSketch Drawing Editor.
 Press CTRL and select each object individually in a drawing view.
 Click and drag in a drawing view to create a selection window. The software selects all
objects completely within the selection window.
 Press CTRL and then click and drag in a drawing view to create a line selection. The
software selects all objects overlapping the line.

Moving a label in a group


You can select and move a label to separate it from the group label.

Drawings and Reports Reference Data Guide 757


Labels

Deleting a label in a group


You can select and delete a label. The software also deletes the leader and bubble labels, but
the remaining bubble labels are not renumbered.

Limitations
Group labels have the following label parameter limitations:
 Orientation / is ignored. Group label text is always horizontal.

 Boundary / is ignored.
 Tolerance Zone is ignored.
The following values for Shape cannot be used as the label border: Cloud , Pentagon ,
Triangle Up , and Triangle Down .

Generic Name Labels


Description: Labels contain object name from the model
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Quadrant 1 (DrawingQuadOne) (on page 1224), Clear
Space Quadrant 2 (DrawingQuadTwo) (on page 1229), Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234), Clear Space Quadrant 4 (DrawingQuadFour) (on page
1240), Absolute XY Offset (DrawingAbsolute) (on page 1130)

Drawings and Reports Reference Data Guide 758


Labels

Example

For more information on name labels used in view styles, see Equipment in Equipment View
Styles (on page 483).

Label Template Name Returned Properties

BopPipePort1_CA_JL1 Name

Civil Isometric_Equipment_Name Name

Civil Plan_Equipment_Name Name

Electrical Above Ground Plan_Cable Trays_Name Name

Electrical Above Ground Plan_Equipment_Name Name

Electrical CableTray Elevation_Equipment_Name Name

Electrical CableTray Isometric_Cable Tray Supports_Name Name

Electrical CableTray Layout Plan_Cable Trays_Name Name

Electrical CableTray Layout Plan_Equipment_Name Name

Electrical CableTray Length Name

Electrical CableTray Plan_Bus_Name Name

Electrical CableTray Plan_Cable Tray Components_Name Name

Electrical CableTray Plan_Cable Tray Supports_Name Name

Electrical CableTray Plan_Cable Trays_Name Name

Electrical CableTray Plan_Cableways_Name Name

Drawings and Reports Reference Data Guide 759


Labels

Label Template Name Returned Properties

Electrical CableTray Plan_Control Station_Name Name

Electrical CableTray Plan_Equipment_Name Name

Electrical CableTray Plan_Junction Box_Name Name

Electrical CableTray Plan_Motor_Name-Elevation Name

Electrical CableTray Plan_Panel_Name Name

Electrical CableTray Plan_Road_Name Name

Electrical CableTray Plan_Run_Name Name

Electrical CableTray Plan_Small Motor_Name-Elevation Name

Electrical CableTray Plan_Switchgear_Name Name

Electrical Equipment Elevation_Equipment_Name Name

Electrical Equipment Isometric_Equipment_Name Name

Electrical Equipment Plan_Bus_Name Name

Electrical Equipment Plan_Cable Trays_Name Name

Electrical Equipment Plan_Control Station_Name Name

Electrical Equipment Plan_Equipment_Name Name

Electrical Equipment Plan_Junction Box_Name Name

Electrical Equipment Plan_Motor_Name-Elevation Name

Electrical Equipment Plan_Panel_Name Name

Electrical Equipment Plan_Road_Name Name

Electrical Equipment Plan_Small Motor_Name-Elevation Name

Electrical Equipment Plan_Switchgear_Name Name

Electrical Instrument Plan_Equipment_Name Name

Electrical Instrument Plan_Instrument_Name Name

Electrical Instrument Plan_Junction Box_Name Name

Drawings and Reports Reference Data Guide 760


Labels

Label Template Name Returned Properties

Electrical Lighting Plan_Equipment_Name Name

Electrical Lighting Plan_Light_Name Name

Electrical Raceway Plan_Bus_Name Name

Electrical Raceway Plan_Cable Tray Components_Name Name

Electrical Raceway Plan_Cable Tray Supports_Name Name

Electrical Raceway Plan_Cable Trays_Name Name

Electrical Raceway Plan_Cableways_Name Name

Electrical Raceway Plan_Control Station_Name Name

Electrical Raceway Plan_Equipment_Name Name

Electrical Raceway Plan_Junction Box_Name Name

Electrical Raceway Plan_Motor_Name-Elevation Name

Electrical Raceway Plan_Panel_Name Name

Electrical Raceway Plan_Road_Name Name

Electrical Raceway Plan_Run_Name Name

Electrical Raceway Plan_Small Motor_Name-Elevation Name

Electrical Raceway Plan_Switchgear_Name Name

Equipment Elevation_Equipment_Name Name

Equipment Isometric_Equipment_Name Name

Equipment Plan_Equipment_Name Name

Equipment Plan_Pipe Support_Name Name

Equipment Plan_Support Assembly_Name Name

Generic Distance to Nearest Coordinate System_CA_JL Name


(Marine mode only)

HngSup End_KeyPlan_Coordinate None

Drawings and Reports Reference Data Guide 761


Labels

Label Template Name Returned Properties

HngSup ISO_Note Name

HngSup_Note Name

HngSup_Piping_Properties Name

HVAC Elevation_Linear Duct Cross Section Size Name

HVAC Elevation_Pipe Support_Name Name

HVAC Isometric_Linear Duct Cross Section Size Name

HVAC Isometric_Pipe Support_Name Name

HVAC Isometric_Run_Name Name

HVAC Linear Duct Cross Section Size Name

HVAC Plan_Equipment_Name Name

HVAC Plan_HVAC Straight_Height-Width Name

HVAC Plan_Linear Duct Cross Section Size Name

HVAC Plan_Pipe Support_Name Name

HVAC Plan_Run_Name Name

Instrument Elevation_Equipment_Name Name

Instrument Elevation_Piping Instruments_Name Name

Instrument Isometric_Equipment_Name Name

Instrument Isometric_Piping Instruments_Name Name

Instrument Key Plan_Focus_Name Name

Instrument Plan_Equipment_Name Name

Instrument Plan_Junction Box_Name Name

Instrument Plan_Pipe Supports_Name Name

Instrument Plan_Piping Instruments_Name Name

Name-Part_Circle_CA_L Name

Drawings and Reports Reference Data Guide 762


Labels

Label Template Name Returned Properties

Name-Part_None_CA_JL Name

Name-Part_Rect_CA_JL Name

Name_Capsule_CA_JL Name

Name_Capsule_CA_L Name

Name_Circle_CA_JL Name

Name_Circle_CA_L Name

Name_Line_CA_JL Name

Name_None_CA_JL Single and group name


labels. For more
information, see Group
Labels (on page 753).

Name_None_CA_JL_Bubble Bubble labels

Name_None_CM_JL Name

Name_Rect_CA_JL Name

Note_Rect_CA_JL Name

PipeComponent_None_CA_JL Name

PipeWeld_None_CA_JL Name

Piping Elevation_Equipment_Name Name

Piping Fire Protection Plan_Equipment_Name Name

Piping Isometric Detail_Equipment_Name Name

Piping Isometric Key_Focus_Name Name

Piping Isometric_Equipment_Name Name

Piping Plan_Equipment_Name Name

Piping Plan_Pipe Support_Name Name

Piping Plan_Pipes_BOP Elev Name

Drawings and Reports Reference Data Guide 763


Labels

Label Template Name Returned Properties

Piping Safety Shower Plan_Equipment_Name Name

Piping Utility Station Plan_Equipment_Name Name

Structural Framing Elevation_Ladder_Name Name

Structural Framing Elevation_Stair_Name Name

Structural Framing Plan_Beams_Section Size_Index-Clearspace Name

Structural Framing Plan_Beams_Section Size_Index Name

Structural Framing Plan_Columns_Section Size Name

Structural Framing Plan_Opening_Name Name

Label Rules
Label rules control the appearance of annotation labels as well as their automatic placement on
drawings. For example, you can create label rules that place labels with or without borders and
leader lines. You can even specify that the labels find clear space on the drawing. Use the
Label Rule Manager to customize labels.
You assign label rules as part of the drawing view style with the Tools > Define View Style
command in the Drawings and Reports task. You can use these rules for many purposes. The
delivered sample rules include several types of rules, such as material and grade labels, profile
cross-section labels, and part name labels. For more information, see the Orthographic
Drawings User's Guide.
Label rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\LabelRules folder.
Each label rule uses one or more label templates. For more information, see Label Templates
(on page 786).
The following label rules are delivered:

Label Rule (.xml) Label Template Used in Rule (.xml)

Assembly NonWeld Symbol Assembly NonWeld Symbol

BopPipePort1_CA_JL BopPipePort1_CA_JL

Civil Isometric_Equipment_Name Civil Isometric_Equipment_Name

Civil Key Plan_Focus_Name Civil Key Plan_Focus_Name

Civil Overall Key Plan_Volume_Name Civil Overall Key Plan_Volume_Name

Drawings and Reports Reference Data Guide 764


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Civil Plan_Equipment_Name Civil Plan_Equipment_Name

Civil Plan_Grid Line_X Name Civil Plan_Grid Line_X Name

Civil Plan_Grid Line_Y Name Civil Plan_Grid Line_Y Name

Civil_TrenchFeature Civil_TrenchFeature

Classification Profile Thickness Symbol Classification Profile Thickness Symbol

CtrlPtCoord_None_CA CtrlPtCoordSym_None_A_NL,
CtrlPtECoord_None_CA_L,
CtrlPtNCoord_None_CA_L

CtrlPtOnlyCoord_None_CA CtrlPtOnlyCoordSym_None_A_NL,
CtrlPtOnlyECoord_None_CA_L,
CtrlPtOnlyNCoord_None_CA_L

DrawingVolume_Name_Rect_A_NL DrawingVolume_Name_Rect_A_NL

Electrical CableTray Elevation_Cable Electrical CableTray Elevation_Cable


Trays_Name-Elevation-Width Trays_Name-Elevation-Width

Electrical CableTray Electrical CableTray


Elevation_Equipment_Name Elevation_Equipment_Name

Electrical CableTray Elevation_Grid Line_TOS Electrical CableTray Elevation_Grid Line_TOS

Electrical CableTray Elevation_Grid Electrical CableTray Elevation_Grid


Plane_Name Plane_Name

Electrical CableTray Electrical CableTray


Elevation_LineNumber_Clipped Elevation_LineNumber_Clipped

Electrical CableTray Electrical CableTray


Elevation_LineNumber_Longest Segment Elevation_LineNumber_Longest Segment

Electrical CableTray Isometric_Cable Tray Electrical CableTray Isometric_Cable Tray


Supports_Name Supports_Name

Electrical CableTray Isometric_Cable Electrical CableTray Isometric_Cable


Trays_Name-Elevation-Width Trays_Name-Elevation-Width

Electrical CableTray Key Plan_Focus_Name Electrical CableTray Key Plan_Focus_Name

Electrical CableTray Layout Plan_Cable Electrical CableTray Layout Plan_Cable


Trays_Name Trays_Name

Drawings and Reports Reference Data Guide 765


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Electrical CableTray Layout Electrical CableTray Layout


Plan_Equipment_Name Plan_Equipment_Name

Electrical CableTray Layout Plan_Grid Line_X Electrical CableTray Layout Plan_Grid Line_X
Name Name

Electrical CableTray Layout Plan_Grid Line_Y Electrical CableTray Layout Plan_Grid Line_Y
Name Name

Electrical CableTray Length Electrical CableTray Length

Electrical CableTray Overall Key Electrical CableTray Overall Key


Plan_Volume_Name Plan_Volume_Name

Electrical CableTray Plan_Bus_Name Electrical CableTray Plan_Bus_Name

Electrical CableTray Plan_Cable Tray Electrical CableTray Plan_Cable Tray


Components_Name Components_Name

Electrical CableTray Plan_Cable Tray Electrical CableTray Plan_Cable Tray


Supports_Name Supports_Name

Electrical CableTray Plan_Cable Electrical CableTray Plan_Cable


Trays_Name-Elevation-Width Trays_Name-Elevation-Width

Electrical CableTray Plan_Cable Trays_Name Electrical CableTray Plan_Cable Trays_Name

Electrical CableTray Plan_Cableways_Name Electrical CableTray Plan_Cableways_Name

Electrical CableTray Plan_Control Electrical CableTray Plan_Control


Station_Name Station_Name

Electrical CableTray Plan_Equipment_Name Electrical CableTray Plan_Equipment_Name

Electrical CableTray Plan_Grid Line_X Name Electrical CableTray Plan_Grid Line_X Name

Electrical CableTray Plan_Grid Line_Y Name Electrical CableTray Plan_Grid Line_Y Name

Electrical CableTray Plan_Junction Box_Name Electrical CableTray Plan_Junction Box_Name

Electrical CableTray Plan_LineNumber_Clipped Electrical CableTray Plan_LineNumber_Clipped

Electrical CableTray Electrical CableTray


Plan_LineNumber_Longest Segment Plan_LineNumber_Longest Segment

Electrical CableTray Electrical CableTray


Plan_Motor_Name-Elevation Plan_Motor_Name-Elevation

Drawings and Reports Reference Data Guide 766


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Electrical CableTray Plan_Panel_Name Electrical CableTray Plan_Panel_Name

Electrical CableTray Plan_Road_Name Electrical CableTray Plan_Road_Name

Electrical CableTray Plan_Run_Name Electrical CableTray Plan_Run_Name

Electrical CableTray Plan_Small Electrical CableTray Plan_Small


Motor_Name-Elevation Motor_Name-Elevation

Electrical CableTray Plan_Switchgear_Name Electrical CableTray Plan_Switchgear_Name

Electrical Equipment Electrical Equipment


Elevation_Equipment_Name Elevation_Equipment_Name

Electrical Equipment Elevation_Grid Line_TOS Electrical Equipment Elevation_Grid Line_TOS

Electrical Equipment Elevation_Grid Electrical Equipment Elevation_Grid


Plane_Name Plane_Name

Electrical Equipment Electrical Equipment


Elevation_LineNumber_Clipped Elevation_LineNumber_Clipped

Electrical Equipment Electrical Equipment


Elevation_LineNumber_Longest Segment Elevation_LineNumber_Longest Segment

Electrical Equipment Electrical Equipment


Isometric_Equipment_Name Isometric_Equipment_Name

Electrical Equipment Electrical Equipment


Isometric_LineNumber_Longest Segment Isometric_LineNumber_Longest Segment

Electrical Equipment Key Plan_Focus_Name Electrical Equipment Key Plan_Focus_Name

Electrical Equipment Overall Key Electrical Equipment Overall Key


Plan_Volume_Name Plan_Volume_Name

Electrical Equipment Plan_Bus_Name Electrical Equipment Plan_Bus_Name

Electrical Equipment Plan_Cable Tray Electrical Equipment Plan_Cable Tray


Supports_Name Supports_Name

Electrical Equipment Plan_Control Electrical Equipment Plan_Control


Station_Name Station_Name

Electrical Equipment Plan_Equipment_Name Electrical Equipment Plan_Equipment_Name

Electrical Equipment Plan_Grid Line_X Name Electrical Equipment Plan_Grid Line_X Name

Drawings and Reports Reference Data Guide 767


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Electrical Equipment Plan_Grid Line_Y Name Electrical Equipment Plan_Grid Line_Y Name

Electrical Equipment Plan_Junction Box_Name Electrical Equipment Plan_Junction Box_Name

Electrical Equipment Electrical Equipment


Plan_LineNumber_Clipped Plan_LineNumber_Clipped

Electrical Equipment Electrical Equipment


Plan_LineNumber_Longest Segment Plan_LineNumber_Longest Segment

Electrical Equipment Electrical Equipment


Plan_Motor_Name-Elevation Plan_Motor_Name-Elevation

Electrical Equipment Plan_Panel_Name Electrical Equipment Plan_Panel_Name

Electrical Equipment Plan_Road_Name Electrical Equipment Plan_Road_Name

Electrical Equipment Plan_Small Electrical Equipment Plan_Small


Motor_Name-Elevation Motor_Name-Elevation

Electrical Equipment Plan_Switchgear_Name Electrical Equipment Plan_Switchgear_Name

Electrical Instrument Plan_Equipment_Name Electrical Instrument Plan_Equipment_Name

Electrical Instrument Plan_Grid Line_X Name Electrical Instrument Plan_Grid Line_X Name

Electrical Instrument Plan_Grid Line_Y Name Electrical Instrument Plan_Grid Line_Y Name

Electrical Instrument Plan_Instrument_Name Electrical Instrument Plan_Instrument_Name

Electrical Instrument Plan_Junction Box_Name Electrical Instrument Plan_Junction Box_Name

Electrical Lighting Plan_Equipment_Name Electrical Lighting Plan_Equipment_Name

Electrical Lighting Plan_Grid Line_X Name Electrical Lighting Plan_Grid Line_X Name

Electrical Lighting Plan_Grid Line_Y Name Electrical Lighting Plan_Grid Line_Y Name

Electrical Lighting Plan_Light_Name Electrical Lighting Plan_Light_Name

Electrical Lighting Plan_Light_Symbol_Number Electrical Lighting Plan_Light_Symbol_Number

Elevation Elevation

EndOfPipeSegment_None_CM_JL EndOfPipeSegment_None_CM_JL

Drawings and Reports Reference Data Guide 768


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Equipment Elevation_Equipment_Elevation Equipment


Elevation_Equipment_Elevation_Symbol,
Equipment Elevation_Equipment_Elevation

Equipment Elevation_Equipment_Name Equipment Elevation_Equipment_Name

Equipment Elevation_Grid Line_TOS Equipment Elevation_Grid Line_TOS

Equipment Elevation_Grid Plane_Name Equipment Elevation_Grid Plane_Name

Equipment Elevation_Process Equipment Elevation_Process


Equipment_North-East Coordinate Equipment_Symbol, Equipment
Elevation_Process Equipment_East
Coordinate, Equipment Elevation_Process
Equipment_North Coordinate

Equipment Isometric_Equipment_Name Equipment Isometric_Equipment_Name

Equipment Key Plan_Volume_Name Equipment Key Plan_Volume_Name

Equipment Overall Key Plan_Volume_Name Equipment Overall Key Plan_Volume_Name

Equipment Plan_Equipment_Name Equipment Plan_Equipment_Name

Equipment Plan_Grid Line_X Name Equipment Plan_Grid Line_X Name

Equipment Plan_Grid Line_Y Name Equipment Plan_Grid Line_Y Name

Equipment Plan_Pipe Support_Name Equipment Plan_Pipe Support_Name

Equipment Plan_Process Equipment Plan_Process Equipment_Symbol,


Equipment_North-East Coordinate Equipment Plan_Process Equipment_East
Coordinate, Equipment Plan_Process
Equipment_North Coordinate

Equipment Plan_Support Assembly_Name Equipment Plan_Support Assembly_Name

Generic Distance To Nearest Coordinate Generic Distance To Nearest Coordinate


System_CA_JL System_CA_JL

Generic_Name Generic_Name

Generic_Name_A_NL Generic_Name_A_NL

Generic_Name_L Generic_Name_L

Generic_Name_RC Generic_Name_RC

Drawings and Reports Reference Data Guide 769


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Generic_Name_RC_L Generic_Name_RC_L

Grid Axis Grid Axis

Grid Axis_No Spacing Grid Axis_No Spacing

Grid Line Name Grid Line Name

Grid Line Name_M_L Grid Line Name_M_L

Grid Line Name_S Grid Line Name_S

GridHorizCoordinateLabel GridHorizCoordinateLabel

GridLineX_Circle_A_L GridLineX_Circle_A_L

GridLineX_Circle_CM_L GridLineX_Circle_CM_L

GridLineX_Circle_CS_JL GridLineX_Circle_CS_JL

GridLineY_Circle_A_L GridLineY_Circle_A_L

GridLineY_Circle_CM_L GridLineY_Circle_CM_L

GridLineY_Circle_CS_JL GridLineY_Circle_CS_JL

GridPlane_Name GridPlane_Name

GridVertCoordinateLabel GridVertCoordinateLabel

HngSup Cad Details_Cad Detail HngSup Cad Details_Cad Detail

HngSup End_AdHoc_Label HngSup End_AdHoc_Label

HngSup End_Diamond_M_L HngSup End_Diamond_M_L

HngSup End_Elevation_Label HngSup End_Elevation_Label

HngSup End_KeyPlan_Coordinate HngSup End_KeyPlan_Coordinate

HngSup End_KeyPlan_Coordinate_KPLabel HngSup End_KeyPlan_Coordinate_KPLabel

HngSup End_Weld HngSup End_Weld

HngSup ISO_KeyPlan_Coordinate HngSup ISO_KeyPlan_Coordinate

HngSup ISO_Note HngSup ISO_Note

Drawings and Reports Reference Data Guide 770


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

HngSup ISO_Reference_Circle_CA_L HngSup ISO_Reference_Circle_CA_L

HngSup KeyPlan HngSup KeyPlan

HngSup Side_AdHoc_Label HngSup Side_AdHoc_Label

HngSup Side_Elevation_Label HngSup Side_Elevation_Label

HngSup Side_KeyPlan_Coordinate HngSup Side_KeyPlan_Coordinate

HngSup Side_Reference_Circle_CA_L HngSup Side_Reference_Circle_CA_L

HngSup Side_Weld HngSup Side_Weld

HngSup_Diamond_M_L HngSup_Diamond_M_L

HngSup_Note HngSup_Note

HngSup_Piping_Properties HngSup_Piping_Properties

Hull Lines Default Seam Symbol Hull Lines Default Seam Symbol

Hull Lines Erection Seam Symbol Hull Lines Erection Seam Symbol

Hull Lines_Name Hull Lines_Name

HVAC Diffuser HVAC Diffuser

HVAC Elevation_Grid Line_TOS HVAC Elevation_Grid Line_TOS

HVAC Elevation_Grid Plane_Name HVAC Elevation_Grid Plane_Name

HVAC Elevation_Linear Duct Cross Section HVAC Elevation_Linear Duct Cross Section
Size Size

HVAC Elevation_LineNumber_Clipped HVAC Elevation_LineNumber_Clipped

HVAC Elevation_LineNumber_Longest HVAC Elevation_LineNumber_Longest


Segment Segment

HVAC Elevation_Pipe Support_Name HVAC Elevation_Pipe Support_Name

HVAC Isometric_Linear Duct Cross Section HVAC Isometric_Linear Duct Cross Section
Size Size

HVAC Isometric_Pipe Support_Name HVAC Isometric_Pipe Support_Name

HVAC Isometric_Run_Name HVAC Isometric_Run_Name

Drawings and Reports Reference Data Guide 771


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

HVAC Key Plan_Focus_Name HVAC Key Plan_Focus_Name

HVAC Linear Duct Cross Section Size HVAC Linear Duct Cross Section Size

HVAC Overall Key Plan_Volume_Name HVAC Overall Key Plan_Volume_Name

HVAC Plan_Equipment_Name HVAC Plan_Equipment_Name

HVAC Plan_Grid Line_X Name HVAC Plan_Grid Line_X Name

HVAC Plan_Grid Line_Y Name HVAC Plan_Grid Line_Y Name

HVAC Plan_HVAC Straight_Height-Width HVAC Plan_HVAC Straight_Height-Width

HVAC Plan_Linear Duct Cross Section Size HVAC Plan_Linear Duct Cross Section Size

HVAC Plan_LineNumber_Clipped HVAC Plan_LineNumber_Clipped

HVAC Plan_LineNumber_Longest Segment HVAC Plan_LineNumber_Longest Segment

HVAC Plan_Pipe Support_Name HVAC Plan_Pipe Support_Name

HVAC Plan_Run_Name HVAC Plan_Run_Name

Instrument Elevation_Equipment_Name Instrument Elevation_Equipment_Name

Instrument Elevation_Grid Line_TOS Instrument Elevation_Grid Line_TOS

Instrument Elevation_Grid Plane_Name Instrument Elevation_Grid Plane_Name

Instrument Elevation_Piping Instruments_Name Instrument Elevation_Piping Instruments_Name

Instrument Isometric_Equipment_Name Instrument Isometric_Equipment_Name

Instrument Isometric_Piping Instruments_Name Instrument Isometric_Piping Instruments_Name

Instrument Key Plan_Focus_Name Instrument Key Plan_Focus_Name

Instrument Overall Key Plan_Volume_Name Instrument Overall Key Plan_Volume_Name

Instrument Plan_Cable Instrument Plan_Cable


Trays_Name-Elevation-Width Trays_Name-Elevation-Width

Instrument Plan_Equipment_Name Instrument Plan_Equipment_Name

Instrument Plan_Grid Line_X Name Instrument Plan_Grid Line_X Name

Instrument Plan_Grid Line_Y Name Instrument Plan_Grid Line_Y Name

Drawings and Reports Reference Data Guide 772


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Instrument Plan_Junction Box_Name Instrument Plan_Junction Box_Name

Instrument Plan_Pipe Supports_Name Instrument Plan_Pipe Supports_Name

Instrument Plan_Piping Instruments_Name Instrument Plan_Piping Instruments_Name

IS_ProfileSketch_Arial_2.5mm IS_ProfileSketch_Arial_2.5mm

KeyPlanVolume_Name_Rect_A_NL KeyPlanVolume_Name_Rect_A_NL

Mfg Profile Margin_Value Mfg Profile Margin_Value

Mfg Scantling Margin_Value Mfg Scantling Margin_Value

Mfg Scantling MarkingLine_Name Mfg Scantling MarkingLine_Name

Mfg Scantling Shrinkage_Value Mfg Scantling Shrinkage_Value

MFG_PinJig Remarking_GirthLength MFG_PinJig Remarking_GirthLength

MFG_Pinjig_Contour_Name MFG_Pinjig_Contour_Name

MFG_Pinjig_PinHeight MFG_Pinjig_PinHeight

MFG_Pinjig_Plate_Name MFG_Pinjig_Plate_Name

MFG_Pinjig_Remarking_Name MFG_Pinjig_Remarking_Name

MFG_Pinjig_Remarking_Name_T MFG_Pinjig_Remarking_Name_T

MHHorizGridCoordinateLabel MHHorizGridCoordinateLabel

MHLabelSketchedFeature MHLabelSketchedFeature

MHName_CornerCut MHName_CornerCut

MHVertGridCoordinateLabel MHVertGridCoordinateLabel

Name-Part_Circle_CA_L Name-Part_Circle_CA_L

Name-Part_None_CA_JL Name-Part_None_CA_JL

Name-Part_Rect_CA_JL Name-Part_Rect_CA_JL

NameOpenings_HoleAndSlot NameOpenings_HoleAndSlot

Name_Capsule_CA_JL Name_Capsule_CA_JL

Drawings and Reports Reference Data Guide 773


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Name_Capsule_CA_L Name_Capsule_CA_L

Name_Circle_CA_JL Name_Circle_CA_JL

Name_Circle_CA_L Name_Circle_CA_L

Name_Line_A_NL Name_Line_A_NL

Name_Line_CA_JL Name_Line_CA_JL

Name_None_APO_NL Name_None_APO_NL

Name_None_AV_NL Name_None_AV_NL

Name_None_A_JL Name_None_A_JL

Name_None_A_NL Name_None_A_NL

Name_None_CA_JL Name_None_CA_JL

Name_None_CA_JL_Bubble Name_None_CA_JL_Bubble

Name_None_CM_JL Name_None_CM_JL

Name_None_CPM_JL Name_None_CPM_JL

Name_None_M_JL Name_None_M_JL

Name_Rect_A_NL Name_Rect_A_NL

Name_Rect_CA_JL Name_Rect_CA_JL

Note_Rect_CA_JL Note_Rect_CA_JL

Nozzle Orientation Plan_NozzleAngleLabel Nozzle Orientation Plan_NozzleAngleLabel

Nozzle Orientation Plan_NozzleLabel Nozzle Orientation Plan_NozzleLabel

Nozzle Orientation Plan_Nozzle_BTM_Name Nozzle Orientation Plan_Nozzle_BTM_Name

Nozzle Orientation Plan_Nozzle_TOP_Name Nozzle Orientation Plan_Nozzle_TOP_Name

Opening Opening

Pipe Supports - Pipe Supports -


Components_Reference_Circle_CA_L Components_Reference_Circle_CA_L

Drawings and Reports Reference Data Guide 774


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Pipe Supports - Piping_Control Point Pipe Supports - Piping_Control Point


Structure_North-East Coordinate Structure_Symbol, Pipe Supports - Piping
Control Point Structure - East Coordinate, Pipe
Supports - Piping_Control Point
Structure_North Coordinate

Pipe Supports - Pipe Supports -


Piping_Reference_Circle_CA_L Piping_Reference_Circle_CA_L

Pipe Supports - Structure_Control Point Pipe Supports - Structure_Control Point


Structure_North-East Coordinate Structure_Symbol, Pipe Supports -
Structure_Control Point Structure_East
Coordinate, Pipe Supports - Structure_Control
Point Structure_North Coordinate

Pipe Supports - Pipe Supports -


Structure_Reference_Circle_CA_L Structure_Reference_Circle_CA_L

Pipe Supports_Control Point Pipe Supports_Control Point Structure_Symbol,


Structure_North-East Coordinate Pipe Supports_Control Point Structure_East
Coordinate, Pipe Supports_Control Point
Structure_North Coordinate

PipeComponent_None_CA_JL PipeComponent_None_CA_JL

PipeWeld_None_CA_JL PipeWeld_None_CA_JL

Piping Elevation_Equipment_Name Style2 Piping Elevation_Equipment_Name Style2

Piping Elevation_Equipment_Name Piping Elevation_Equipment_Name

Piping Elevation_Grid Line_TOS Style2 Piping Elevation_Grid Line_TOS Style2

Piping Elevation_Grid Line_TOS Piping Elevation_Grid Line_TOS

Piping Elevation_Grid Plane_Name Style2 Piping Elevation_Grid Plane_Name Style2

Piping Elevation_Grid Plane_Name Piping Elevation_Grid Plane_Name

Piping Elevation_LineNumber_Clipped Style2 Piping Elevation_LineNumber_Clipped Style2

Piping Elevation_LineNumber_Clipped Piping Elevation_LineNumber_Clipped

Piping Elevation_LineNumber_Longest Piping Elevation_LineNumber_Longest


Segment Segment

Piping Elevation_LineNumber_Longest Piping Elevation_LineNumber_Longest


Segment_Style2 Segment_Style2

Drawings and Reports Reference Data Guide 775


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Piping Elevation_LineNumber_Style2 Piping Elevation_LineNumber_Style2

Piping Isometric Detail_Equipment_Name Piping Isometric Detail_Equipment_Name

Piping Isometric Key_Focus_Name Piping Isometric Key_Focus_Name

Piping Isometric_Equipment_Name Piping Isometric_Equipment_Name

Piping Isometric_LineNumber_Longest Piping Isometric_LineNumber_Longest


Segment Segment

Piping Key Plan_Focus_Name Piping Key Plan_Focus_Name

Piping Overall Key Plan_Volume_Name Piping Overall Key Plan_Volume_Name

Piping Plan_Equipment_Name Style2 Piping Plan_Equipment_Name Style2

Piping Plan_Equipment_Name Piping Plan_Equipment_Name

Piping Piping Plan_Equipment_Name_Style2_North


Plan_Equipment_Name_Style2_North-East Coordinate
Coordinate

Piping Plan_Equipment_Style2_North-East Piping Plan_Equipment_Style2_North


Coordinate Coordinate

Piping Plan_FlowArrow_By Part Piping Plan_FlowArrow_By Part

Piping Plan_FlowArrow_Longest Segment Piping Plan_FlowArrow_Longest Segment

Piping Plan_Grid Line_X Name Style2 Piping Plan_Grid Line_X Name Style2

Piping Plan_Grid Line_X Name Piping Plan_Grid Line_X Name

Piping Plan_Grid Line_Y Name Style2 Piping Plan_Grid Line_Y Name Style2

Piping Plan_Grid Line_Y Name Piping Plan_Grid Line_Y Name

Piping Plan_LineNumber_Clipped Style2 Piping Plan_LineNumber_Clipped Style2

Piping Plan_LineNumber_Clipped Piping Plan_LineNumber_Clipped

Piping Plan_LineNumber_Longest Segment Piping Plan_LineNumber_Longest Segment

Piping Plan_LineNumber_Longest Piping Plan_LineNumber_Longest


Segment_Style2 Segment_Style2

Piping Plan_LineNumber_Style2 Piping Plan_LineNumber_Style2

Drawings and Reports Reference Data Guide 776


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Piping Plan_Pipe Support_Name Piping Plan_Pipe Support_Name

Piping Plan_Pipes_BOP Elev Piping Plan_Pipes_BOP Elev

Piping Plan_Piping Parts_RunName Piping Plan_Piping Parts_RunName

Piping Plan_Piping Parts_RunName_Longest Piping Plan_Piping Parts_RunName_Longest


Segment Segment

Piping Plan_Process Equipment_North-East Piping Plan_Process Equipment_Symbol,


Coordinate Piping Plan_Process Equipment_East
Coordinate, Piping Plan_Process
Equipment_North Coordinate

Piping Plan_Routable_Center Elev Piping Plan_Routable_Center Elev

Piping Plan_Routable_INV Elev Piping Plan_Routable_INV Elev

Piping Plan_Routable_WPBOP Elev Piping Plan_Routable_WPBOP Elev

Reference_Circle_CA_L Reference_Circle_CA_L

Ruleset_Name Ruleset_Name

Scantling Connection Intersection Symbol Scantling Connection Intersection Symbol

Scantling Connection Penetration Symbol Scantling Connection Penetration Symbol

Scantling Knuckle Line Label Scantling Knuckle Line Label

Scantling Knuckle Line Label_CP_L Scantling Knuckle Line Label_CP_L

Scantling Knuckle Line Symbol Scantling Knuckle Line Symbol

Scantling Knuckle Point Label_CA_L Scantling Knuckle Point Label_CA_L

Scantling Knuckle Point Symbol Scantling Knuckle Point Symbol

Scantling Knuckle Sloping Dir Symbol Scantling Knuckle Sloping Dir Symbol

Scantling Knuckle Sloping Direction Symbol Scantling Knuckle Sloping Direction Symbol

Scantling Knuckle Surface Angle Scantling Knuckle Surface Angle

Scantling Non-Target Seam Symbol Scantling Non-Target Seam Symbol

Scantling NS or FS Symbol Scantling NS or FS Symbol

Drawings and Reports Reference Data Guide 777


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Scantling Plate Mounting Angle Scantling Plate Mounting Angle

Scantling Plate Thickness Symbol Scantling Plate Thickness Symbol

Scantling Profile Mounting Angle Scantling Profile Mounting Angle

Scantling Profile Seam Symbol Scantling Profile Seam Symbol

Scantling Profile Thickness Symbol Scantling Profile Thickness Symbol

Scantling Shell Profile Weld Label Scantling Shell Profile Weld Label

Scantling Target Seam Symbol Scantling Target Seam Symbol

SectionSize_None_APO_NL SectionSize_None_APO_NL

Ship Structure Plate GridPlane_Name Ship Structure Plate GridPlane_Name

Ship Structure Plate Material Type Grade Ship Structure Plate Material Type Grade
Thickness by COM Thickness by COM

Ship Structure Plate Material Type Grade Ship Structure Plate Material Type Grade
Thickness Thickness

Ship Structure Plate Short Name Ship Structure Plate Short Name

Ship Structure Plate Thickness Grade by COM Ship Structure Plate Thickness Grade by COM

Ship Structure Plate Thickness Grade Typical Ship Structure Plate Thickness Grade Typical

Ship Structure Plate Thickness Grade Ship Structure Plate Thickness Grade

Ship Structure Profile Cross-section by COM Ship Structure Profile Cross-section by COM

Ship Structure Profile Cross-section Material Ship Structure Profile Cross-section Material
Type Grade by COM Type Grade by COM

Ship Structure Profile Cross-section Material Ship Structure Profile Cross-section Material
Type Grade Type Grade

Ship Structure Profile Cross-section Ship Structure Profile Cross-section

Ship Structure Profile Name Cross-section Ship Structure Profile Name Cross-section
Material Type Grade_L Material Type Grade_L

Ship Structure Profile Short Name Ship Structure Profile Short Name

Ship Structure Profile System Short Name Ship Structure Profile System Short Name

Drawings and Reports Reference Data Guide 778


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

SM_ElectricalCableTray_Elevation_GridPlane_ SM_ElectricalCableTray_Elevation_GridPlane_
Name Name

SM_ElectricalCableTray_Plan_GridLineX_Nam SM_ElectricalCableTray_Plan_GridLineX_Nam
e e

SM_ElectricalCableTray_Plan_GridLineY_Nam SM_ElectricalCableTray_Plan_GridLineY_Nam
e e

SM_ElectricalCableTray_Plan_LineNumberBO SM_ElectricalCableTray_Plan_LineNumberBO
T_LongestSegment T_LongestSegment

SM_ElectricalCableTray_Plan_Tray_BOT_Elev SM_ElectricalCableTray_Plan_Tray_BOT_Elev

SM_ElectricalCableTray_Section_LineNumber_ SM_ElectricalCableTray_Section_LineNumber_
LongestSegment LongestSegment

SM_Equipment_Elevation_Equipment_Name SM_Equipment_Elevation_Equipment_Name

SM_Equipment_Elevation_GridLineX_Name SM_Equipment_Elevation_GridLineX_Name

SM_Equipment_Elevation_GridPlane_Name SM_Equipment_Elevation_GridPlane_Name

SM_Equipment_Plan_Equipment_Name SM_Equipment_Plan_Equipment_Name

SM_Equipment_Plan_GridLineX_Name SM_Equipment_Plan_GridLineX_Name

SM_Equipment_Plan_GridLineY_Name SM_Equipment_Plan_GridLineY_Name

SM_Equipment_Section_Equipment_Name SM_Equipment_Section_Equipment_Name

SM_Equipment_Section_GridPlane_Name SM_Equipment_Section_GridPlane_Name

SM_HVAC_Elevation_GridLineX_Name SM_HVAC_Elevation_GridLineX_Name

SM_HVAC_Elevation_GridPlane_Name SM_HVAC_Elevation_GridPlane_Name

SM_HVAC_Elevation_Run_Name SM_HVAC_Elevation_Run_Name

SM_HVAC_LinearDuct_CrossSectionSize SM_HVAC_LinearDuct_CrossSectionSize

SM_HVAC_Plan_GridLineX_Name SM_HVAC_Plan_GridLineX_Name

SM_HVAC_Plan_GridLineY_Name SM_HVAC_Plan_GridLineY_Name

SM_HVAC_Plan_Run_Name SM_HVAC_Plan_Run_Name

SM_HVAC_Section_GridLineX_Name SM_HVAC_Section_GridLineX_Name

Drawings and Reports Reference Data Guide 779


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

SM_HVAC_Section_GridPlane_Name SM_HVAC_Section_GridPlane_Name

SM_HVAC_Section_Run_Name SM_HVAC_Section_Run_Name

SM_Lighting_Plan_GridLineX_Name SM_Lighting_Plan_GridLineX_Name

SM_Lighting_Plan_GridLineY_Name SM_Lighting_Plan_GridLineY_Name

SM_Lighting_Plan_Light_Desccription_Ver SM_Lighting_Plan_Light_Desccription_Ver

SM_Lighting_Plan_Light_Description SM_Lighting_Plan_Light_Description

SM_Lighting_Plan_Light_Name SM_Lighting_Plan_Light_Name

SM_Lighting_Plan_Light_Name_Vert SM_Lighting_Plan_Light_Name_Vert

SM_Name_Elevation_None_M_JL SM_Name_Elevation_None_M_JL

SM_Piping_Elevation_GridPlane_Name SM_Piping_Elevation_GridPlane_Name

SM_Piping_Elevation_Pipes_BOP Elev SM_Piping_Elevation_Pipes_BOP Elev

SM_Piping_Elevation_PipingParts_RunNameB SM_Piping_Elevation_PipingParts_RunNameB
OP_LongestSegment OP_LongestSegment

SM_Piping_Elevation_PipingParts_RunName_ SM_Piping_Elevation_PipingParts_RunName_
LongestSegment LongestSegment

SM_Piping_Plan_GridLineX_Name SM_Piping_Plan_GridLineX_Name

SM_Piping_Plan_GridLineY_Name SM_Piping_Plan_GridLineY_Name

SM_Piping_Plan_Pipes_BOP Elev SM_Piping_Plan_Pipes_BOP Elev

SM_Piping_Plan_PipingParts_RunNameBOP_ SM_Piping_Plan_PipingParts_RunNameBOP_
LongestSegment LongestSegment

SM_Piping_Plan_PipingParts_RunName_Long SM_Piping_Plan_PipingParts_RunName_Long
estSegment estSegment

SM_Piping_Section_Pipes_BOP Elev SM_Piping_Section_Pipes_BOP Elev

SM_Piping_Section_PipingParts_RunNameBO SM_Piping_Section_PipingParts_RunNameBO
P_LongestSegment P_LongestSegment

SM_Piping_Section_PipingParts_RunName_Lo SM_Piping_Section_PipingParts_RunName_Lo
ngestSegment ngestSegment

Drawings and Reports Reference Data Guide 780


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

SP3DCoordinate_BottomLeft_CA_JL SP3DCoordinate_BottomLeft_CA_JL

SP3DCoordinate_CA_JL SP3DCoordinate_CA_JL

SP3DCoordinate_TopRight_CA_JL SP3DCoordinate_TopRight_CA_JL

StrMfg PinJig CornerPoint StrMfg PinJig CornerPoint

StrMfg PinJig Horizontal_GirthLength StrMfg PinJig Horizontal_GirthLength

StrMfg PinJig Parent RemarkLine_GirthLength StrMfg PinJig Parent RemarkLine_GirthLength

StrMfg PinJig PinHeight StrMfg PinJig PinHeight

StrMfg PinJig Pin_Column_Name StrMfg PinJig Pin_Column_Name

StrMfg PinJig Pin_Name StrMfg PinJig Pin_Name

StrMfg PinJig Pin_Row_Name StrMfg PinJig Pin_Row_Name

StrMfg PinJig Plate Material Type Grade StrMfg PinJig Plate Material Type Grade
Thickness Thickness

StrMfg PinJig RemarkingLine_Name StrMfg PinJig RemarkingLine_Name

StrMfg PinJig Seam Point Symbol StrMfg PinJig Seam Point Symbol

StrMfg PinJig Seam_Name StrMfg PinJig Seam_Name

StrMfg PinJig Vertical_GirthLength StrMfg PinJig Vertical_GirthLength

StrMfg ProfileSketch Bevel Shape 1mm StrMfg ProfileSketch Bevel Shape 1mm

StrMfg ProfileSketch Bevel Shape 2mm StrMfg ProfileSketch Bevel Shape 2mm

StrMfg ProfileSketch Bevel Symbol StrMfg ProfileSketch Bevel Symbol

StrMfg ProfileSketch Detail Name StrMfg ProfileSketch Detail Name

StrMfg ProfileSketch Detail Name_V StrMfg ProfileSketch Detail Name_V

StrMfg ProfileSketch Detail Name_Voffset StrMfg ProfileSketch Detail Name_Voffset

StrMfg ProfileSketch Feature Name StrMfg ProfileSketch Feature Name

StrMfg ProfileSketch Knuckle Label StrMfg ProfileSketch Knuckle Label

StrMfg ProfileSketch Labels StrMfg ProfileSketch Labels

Drawings and Reports Reference Data Guide 781


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

StrMfg ProfileSketch Plate Location Symbol StrMfg ProfileSketch Plate Location Symbol

StrMfg ProfileSketch Seam Label StrMfg ProfileSketch Seam Label

StrMfg ProfileSketch WebThickness StrMfg ProfileSketch WebThickness

StrMfg Sketch Bevel Symbol StrMfg Sketch Bevel Symbol

StrMfg Sketch Feature Label StrMfg Sketch Feature Label

StrMfg Sketch Feature Symbol StrMfg Sketch Feature Symbol

StrMfg Sketch Margin Symbol StrMfg Sketch Margin Symbol

StrMfg Template Seam_Symbol StrMfg Template Seam_Symbol

StrMfg Templateset MidLine Symbol StrMfg Templateset MidLine Symbol

StrMfg Templateset Seam Point Symbol StrMfg Templateset Seam Point Symbol

StrMfg TemplateSet Seam_Symbol StrMfg TemplateSet Seam_Symbol

StrMfg Templateset Tangent Point Symbol StrMfg Templateset Tangent Point Symbol

Structural Framing Elevation_Beams_Section Structural Framing Elevation_Beams_Section


Size Size

Structural Framing Elevation_Braces_Section Structural Framing Elevation_Braces_Section


Size Size

Structural Framing Elevation_BU_Section Size Structural Framing Elevation_BU_Section Size

Structural Framing Elevation_Columns_Section Structural Framing Elevation_Columns_Section


Size Size

Structural Framing Elevation_Grid Line_TOS Structural Framing Elevation_Grid Line_TOS

Structural Framing Elevation_Grid Plane_Name Structural Framing Elevation_Grid Plane_Name

Structural Framing Elevation_Ladder_Name Structural Framing Elevation_Ladder_Name

Structural Framing Elevation_Stair_Name Structural Framing Elevation_Stair_Name

Structural Framing Key Plan_Focus_Name Structural Framing Key Plan_Focus_Name

Structural Framing Plan_Beams_Section Size Structural Framing Plan_Beams_Section Size

Drawings and Reports Reference Data Guide 782


Labels

Label Rule (.xml) Label Template Used in Rule (.xml)

Structural Framing Plan_Beams_Section Structural Framing Plan_Beams_Section


Size_Index Size_Index

Structural Framing Plan_Beams_Section Structural Framing Plan_Beams_Section


Size_Relative Elevation Size_Relative Elevation

Structural Framing Plan_Braces_Section Size Structural Framing Plan_Braces_Section Size

Structural Framing Plan_Braces_Section Structural Framing Plan_Braces_Section


Size_Relative Elevation Size_Relative Elevation

Structural Framing Plan_BU_Section Size Structural Framing Plan_BU_Section Size

Structural Framing Plan_Columns_Section Size Structural Framing Plan_Columns_Section Size

Structural Framing Plan_Grid Line_X Name Structural Framing Plan_Grid Line_X Name

Structural Framing Plan_Grid Line_Y Name Structural Framing Plan_Grid Line_Y Name

Structural Framing Plan_Grid Plane_X Name Structural Framing Plan_Grid Plane_X Name

Structural Framing Plan_Opening_Name Structural Framing Plan_Opening_Name

Structural Framing Plan_Process Structural Framing Plan_Process


Equipment_North-East Coordinate Equipment_Symbol, Structural Framing
Plan_Process Equipment_East Coordinate,
Structural Framing Plan_Process
Equipment_North Coordinate

Structural Instrument Plan_Grid Line_X Name Structural Instrument Plan_Grid Line_X Name

Structural Instrument Plan_Grid Line_Y Name Structural Instrument Plan_Grid Line_Y Name

Structural Key Plan_Focus_Name Structural Key Plan_Focus_Name

Structure_Name Structure_Name

Structure_Weld Structure_Weld

System-FluidCode-Seq-Insul_None_CPM_JL System-FluidCode-Seq-Insul_None_CPM_JL

TemplateSet_Seam_Symbol TemplateSet_Seam_Symbol

TOS_Line_A_L TOS_Line_A_L

WeldLabel WeldLabel

WeldSymbols WeldSymbols

Drawings and Reports Reference Data Guide 783


Labels

See Also
Labels (on page 740)
North-East Coordinate Labels (on page 784)
Label Rules in Drawings by Rule (on page 852) (Marine mode only)
Drawings by Rule Labels, Symbols, and Dimensions (on page 910) (Marine mode only)

North-East Coordinate Labels


Description: The North-East Coordinate labels are compound labels that incorporate a symbol,
north coordinate, and east coordinate. For more information on how these labels work and how
to create your own label, see Create a Compound Label Using Label Rules (on page 745).
Each North-East Coordinate label uses the corresponding Symbol, East Coordinate, and North
Coordinate label template file from the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder.
Template File Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\LabelRules\[Label Template Name].xml
Open a North-East Coordinate label in the Label Rule Manager, and then select a label
template from the Template List, shown below:

Example:

The table below lists the North-East Coordinate labels.

Label Rule Name

Civil Isometric_Control Point Structure_North-East Coordinate

Civil Overall Key Plan_Control Point Structure_North-East Coordinate

Civil Plan_Control Point Structure_North-East Coordinate

Drawings and Reports Reference Data Guide 784


Labels

Label Rule Name

Equipment Elevation_Process Equipment_North-East Coordinate

Equipment Plan_Control Point Mechanical Equipment_North-East Coordinate

Equipment Plan_Control Point Process Equipment_North-East Coordinate

Equipment Plan_Control Point Structure_North-East Coordinate

Equipment Plan_Process Equipment_North-East Coordinate

HngSup End_Control Point Structure_North-East Coordinate

HngSup Side_Control Point Structure_North-East Coordinate

Pipe Supports - Piping_Control Point Structure_North-East Coordinate

Pipe Supports - Structure_Control Point Structure_North-East Coordinate

Pipe Supports_Control Point Structure_North-East Coordinate

Piping Fire Protection Plan_Control Point Structure_North-East Coordinate

Piping Plan_Control Point Structure_North-East Coordinate

Piping Plan_Equipment_Name_Style2_North-East Coordinate

Piping Plan_Equipment_Style2_North-East Coordinate

Piping Plan_Process Equipment_North-East Coordinate

Piping Safety Shower Plan_Control Point Structure_North-East Coordinate

Piping Utility Station Plan_Control Point Structure_North-East Coordinate

Structural Framing Plan_Process Equipment_North-East Coordinate

Drawings and Reports Reference Data Guide 785


Labels

Label Templates
Label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder. To use the label templates
with imperial units of measure, rename the Drawings_UOM.rfp file. For example, you can
rename the default folder to Drawings_UOM_Metric.rfp. Then, rename the
Drawings_UOM_Imperial.rfp folder to Drawings_UOM.rfp.

Topics
Label Templates Overview ............................................................ 786
Clipped Labels ............................................................................... 822
Coordinate and Control Point Labels ............................................. 823
Coordinate Labels .......................................................................... 826
Grid Labels..................................................................................... 829
Longest Segment Labels ............................................................... 833
Miscellaneous Labels .................................................................... 834
Name Labels (DrawingAbsolute) ................................................... 841
Name Labels (DwgLinearAbsPos) ................................................ 845
Name Labels (Name-Elevation-Width) .......................................... 847
Nozzle Orientation Labels.............................................................. 848
Reference Labels ........................................................................... 850
Section Size Labels ....................................................................... 851

Label Templates Overview


Quadrants and Granularity
When a label is placed automatically, the software looks for the best place to position the label.
In order to rationalize this process, the software breaks a view into four quadrants. If the
software looks through quadrant one and is unable to find enough clear space for the label, it
will move to quadrant two, and so forth. If the software is unable to find enough clear space
based on your specifications, it will place the label at an absolute position, which you also
specify. In many cases, this absolute position could be the object origin or control point. These
settings are configured in the Granularity property in the Label Rule Manager.

Drawings and Reports Reference Data Guide 786


Labels

The amount of granularity also determines the quadrant that a label is placed in. There are three
granularity settings that allow you to change the proximity of one label to another when being
placed in a drawing view. A granularity setting of Coarse (shown in the illustration below) will
reach out at full text box height increments. Medium (shown in red in the illustration below)
setting will reach out in increments of one half of the text box height. A Fine (shown in green in
the illustration below) setting will reach out in increments of one third of the text box height.
Based on these settings, you can change the number of labels that will fit inside a quadrant. A
Coarse granularity setting will allow the labels to spread out and be more legible. A Fine setting
will fit more labels in a quadrant but will be more difficult to read.

 The Granularity property is in the Positioning Common section in the Label Rule
Manager.
 Click the Granularity property to display the gallery of available settings, as shown below:

Coarse Medium Fine

 In the label XML templates, a granularity setting of 0 is Coarse, 1 is Medium, and 2 is Fine.
The example below shows a medium setting in an XML template:

Drawings and Reports Reference Data Guide 787


Labels

<labelSettings>
<granularity>1</granularity>
</labelSettings>

Positioning Settings
You can specify the starting position of a label or the leader label (also referred to as the
terminator) using the Connect Point and Positioning Point positioning properties in the Label
Rule Manager.
These positioning properties are only available for templates that use the Key Point
(DefaultLabelPointGenerator) module. For more information on this point generator module,
see Key Point (DefaultLabelPointGenerator) (on page 1338).
Connect Point
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point. The example below shows the available Connect Point property
settings. For more information, see Connect Point (on page 1257).

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

Drawings and Reports Reference Data Guide 788


Labels

Positioning Point
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label. The example below shows the available Positioning Point property settings.
For more information, see Positioning Point (on page 1440).

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The properties available for the Clear Space Radial from Object Center with Clustering
(DrawingCentroid) (on page 1247) positioning module are listed below.
This positioning module must be used with the Nozzle
(DrawingPGNozzleandBrace) (on page 1401) point generator module.

Drawings and Reports Reference Data Guide 789


Labels

From Matchline
Determines the inside or outside placement of a label with respect to the matchline
boundary. For more information, see From Matchline (on page 1301). Select True to place
the label outside of the matchline boundary as shown in the example below.

1 - Matchline

Drawings and Reports Reference Data Guide 790


Labels

Select False to place the label inside of the matchline boundary as shown in the example
below.

1 - Matchline

Drawings and Reports Reference Data Guide 791


Labels

Label Type
Specifies whether the label is a Nozzle, Top of Equipment/Bottom of Equipment, or
Angle label. For more information, see Label Type (on page 1345). The example below
shows the different label types.

1 - Nozzle
2 - Top of Equipment/Bottom of Equipment
3 - Angle

The following options are available for manually editing the .xml file.
 Type 0 to place a Nozzle label.
 Type 1 to place a TOP or BTM label.
 Type 2 to place an Angle label.

Drawings and Reports Reference Data Guide 792


Labels

Radius Offset
Determines the distance between a nozzle port and the label annotating the port. For more
information, see Radius Offset (on page 1449). The example below shows the radial offset
when the From Matchline property is set to True.

1 - Radius Offset with From Matchline property set to True

Drawings and Reports Reference Data Guide 793


Labels

Rotation
Determines the angular orientation of the labels. The labels can be aligned horizontally,
irrespective of the orientation of the nozzle orientation angle, or the labels can be rotated to
match the nozzle orientation angle. For more information, see Rotation (on page 1453).
Select True to rotate all labels to match the respective nozzle orientation angles as shown in
the example below:

Drawings and Reports Reference Data Guide 794


Labels

Select False to force horizontal labels as shown in the example below:

The properties available for the Clear Space Margin with Dimensions
(DwgMatchlineWithDim) (on page 1191) positioning module are listed below.
Dimension Style
Defines the appearance of dimensions placed by the label rule. For more information, see
Dimension Style (on page 1278).
Dimension Text Rotate Clearance
Rotates the text of a dimension line 90 degrees when insufficient space exists for the text
between the projection lines.
Specify the minimum clearance between the beginning or end of the dimension line text and
the corresponding projection line. If the actual distance between the text and the projection
line is less than the specified value, the software rotates the text 90 degrees relative to the
dimension line.
The value you type in the Dimension Text Rotate Clearance text box determines the
threshold at which the dimension text is aligned perpendicular to the dimension line. For
example, if the clear space on either side of the dimension text is less than 1 mm, the
dimension text rotates.
In the image below, the clearance between the end of the dimension line text and the

Drawings and Reports Reference Data Guide 795


Labels

projection line is 0.01 m. Because the distance between the end of the dimension line text
and the projection line is not at least 0.01 m, the text is rotated.

Clearance of 0.01 m

In the image below, the clearance between the end of the dimension line text and the
projection line is 0.002 m. Because the distance between the end of the dimension line text
and the projection line is not at least 0.002 m, the text is rotated.

Clearance of 0.002 m

For more information, see Dimension Text Rotate Clearance (on page 1280).

Drawings and Reports Reference Data Guide 796


Labels

Display Dimension
Specifies whether to place dimensions as part of the label rule.
Click On to place dimensions as shown in the graphic below.

Click Off to suppress dimensions as shown in the graphic below.

Drawings and Reports Reference Data Guide 797


Labels

Justification
Determines whether to align labels inside or outside the available clear space. Select a
position from the Justification list. For more information, see Justification (on page 1330).
The following example demonstrates a label as well as the text positioned inside clear
space.

The next example shows the result when the label and text are positioned outside clear
space.

Drawings and Reports Reference Data Guide 798


Labels

Move Dimension Text to Outside


Controls the placement of dimension text values for margin dimensions in the right and
bottom margins. For more information, see Move Dimension Text to Outside (on page
1397).
Click True to place the dimension outside of the dimension line relative to the view, as
shown in the graphic below.

1 - View border
2 - Dimension text value

Click False to place the dimension inside of the dimension line, as shown in the graphic
below.

1 - View border
2 - Dimension text value

Drawings and Reports Reference Data Guide 799


Labels

Angle
Controls the vertical, horizontal, or absolute angle of a label.

 To use the Angle property with the Clear Space Margin with Dimensions positioning
module:
1. Select either Top or Bottom from the Orientation list. Otherwise, the Angle property is
not available.
2. Select either Vertical or Horizontal from the Angle list.
 To use the Angle property with the Absolute XY Offset positioning module, type a
value in the Angle text box.
The example below shows a horizontal label.

1 - Horizontally placed label

The example below shows a vertical label.

Drawings and Reports Reference Data Guide 800


Labels

1 - Vertically placed label

Inside/Outside Shape and Leader Jogs


Leaders will automatically position inside or outside of the equipment object being labeled. For
example, if you select the object origin and place the label outside of the object, the leader will
simply point toward the origin from outside the object without crossing the object boundaries. If
you place the same label within the object boundaries, the leader will point directly to the object
origin.

Drawings and Reports Reference Data Guide 801


Labels

Below is an example of the label being placed on the outside of an object. Note that the leader
stops at the object boundary and points to the origin.

When the label is moved closer to the terminator, the leader adjusts.

The Leader section in the Label Rule Manager allows you to change the behavior of the label
leaders.
Click Leader Module to display a gallery of leader modules, and then select a leader
module. The Style list allows you to choose a style for the leaders.
Display Breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.
Select On to display the breakline.

Drawings and Reports Reference Data Guide 802


Labels

Select Off to suppress the breakline so that the leader line connects directly to the label.

You cannot place breaklines with acute leader jog angles when automatically
generating labels. However, you can manually place breaklines with acute leader jog angles
within SmartSketch by updating the view, then selecting a leader and clicking BreakLine .
Jog Segment Offset
Allows you to specify the offset from the first leader segment connected to the object to the
next jog segment in the leader line.
Jog Segment Offset 1
Allows you to specify the offset from the end of the second jog segment to the start of the
next jog segment in a leader line.

Drawings and Reports Reference Data Guide 803


Labels

Jog Segment Offset 2


Allows you to specify the offset from Jog Segment Offset 1 to the remaining portion of the
leader line. The jog segment to which this property applies connects to the leader line that
connects directly to the label.

Drawings and Reports Reference Data Guide 804


Labels

1 - Leader Offset
2 - Leader Length
3 - Jog Segment Offset
4 - Jog Segment Offset 1
5 - Jog Segment Offset 2
6 - Perimeter Offset (under Positioning Common)

Breakline Length
Allows you to set the length of the jog segment in a leader line that connects to the label.
Type the length in the text box.

1 - Breakline Length

Drawings and Reports Reference Data Guide 805


Labels

Leader Offset
Specifies the distance outside of the matchline at which you want the leader line to
terminate. By default, this value is 0.005 m.
The following example shows a Leader Offset of 0.04 m.

1 - 0.04 m Leader Offset

In the next example, the Leader Offset is set to 0.055 m.

1 - 0.055 m leaderOffset

Drawings and Reports Reference Data Guide 806


Labels

Leader Length
Sets the distance from the matchline to the first jog in the leader line of a label when the
leader line contains multiple segments. This property can be applied only if the leader line
uses a breakline.
The following two examples show the Leader Length property applied according to different
specified distances from the matchline to the first jog in the respective leader lines.

1 - Matchline
2 - 0.03 m Leader Length
3 - Leader line

1 - Matchline
2 - 0.05 Leader Length
3 - Leader line

To manually edit the .xml file, type the distance that you want the leader to extend from the
matchline to the first jog in the leader line.

Drawings and Reports Reference Data Guide 807


Labels

Leaders as Clear Space


Renders the leader line of a label virtually invisible or invisible to other annotations.
Select True to allow the leader lines and other annotations to intersect.

Select False to render the leader line visible to other annotations. The software then
attempts to place the leader lines in clear space.

Drawings and Reports Reference Data Guide 808


Labels

To use the Leaders as Clear Space property in an .xml template, add the
ignoreLeaderCrossings tag to the leaderSettings section. Type -1 to allow leader lines to
intersect. Type 0 to prevent leader line and annotation intersection.

1 - Matchline
2 - 0.03 m Leader Length
3 - Leader line

1 - Matchline
2 - 0.05 Leader Length
3 - Leader line

To manually edit the .xml file, type the distance that you want the leader to extend from the
matchline to the first jog in the leader line.

Drawings and Reports Reference Data Guide 809


Labels

Label Settings
You can customize the automatic behavior of the labels in the Positioning Common section of
the Label Rule Manager.
Label Offset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.
Granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Coarse - the software searches an increment of exactly one width and height of the
existing label in order to find clear space in which to place the new label.
 Medium - the software searches an increment of exactly one-half the width and height
of the existing label.
 Fine - the software searches an increment of exactly one-third the width and height of
the existing label.

Drawings and Reports Reference Data Guide 810


Labels

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 811


Labels

Priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.

1 - Equipment labels placed with Priority set to 1


2 - Structure label placed with Priority set to 2

1 - Equipment label placed with Priority set to 2


2 - Structure label placed with Priority set to 1

To manually edit the .xml file, specify a positive integer to assign as a priority number for
each annotation.

Drawings and Reports Reference Data Guide 812


Labels

Subpriority
Provides a second priority on labels in order to resolve more specific conflicts among
multiple labels searching for clear space. As with the Priority property, the lower the
number, the higher the priority. For example, 1 is a higher priority than 3. A value of 0
indicates that the Subpriority property is turned off.
Perimeter Offset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

1 - Perimeter offset distance


2 - Dimension

Drawings and Reports Reference Data Guide 813


Labels

Dimension Perimeter Offset


Determines the offset distance from the dimension to the matchline.

1 - Dimension Perimeter Offset

maxFactor
Determines the maximum scale factor for the text size. The software defines this value in
meters.
<maxFactor>1</maxFactor>
minFactor
Determines the minimum scale factor for the text size. The software defines this value in
meters.
<minFactor>1</minFactor>

Drawings and Reports Reference Data Guide 814


Labels

Maximum Offset
Defines the maximum distance from a connection point that you can place a label.

1 – Maximum Offset
2 – Perimeter Offset

Drawings and Reports Reference Data Guide 815


Labels

Minimum Offset
Defines the minimum distance from a connection point that you can place a label.

1 - Maximum Offset in X direction


2 - Maximum Offset in Y direction
3 - Minimum Offset

Drawings and Reports Reference Data Guide 816


Labels

White Object Layer


Allows you to specify one or more 2D layers in the drawing to serve as white object layers
for a label placed in clear space. Graphical objects set on these layers are rendered invisible
to this label, allowing placement of the label on top of these objects.

1 - Pipe within a White Object Layer


2 - Equipment label overlapping pipes

If this filter is set to "*" during label placement, then the system ignores all objects that
are not labels or leaders.

Drawings and Reports Reference Data Guide 817


Labels

Geometric Analyzer Settings


You can customize the automatic behavior of the geometric analyzer in the Geometric
Analysis section of the template.
Place Lines
Controls line placement through the coordinate label points along aligned objects. Use this
property to include a single label in the drawing that specifies a common elevation for
aligned objects.
Select On to place lines. Select Off to suppress labels.
In the following image, Place Lines is set to On, and the software has placed a line
connecting the equipment objects and a single label for the common Northing coordinate.

Control Point Label Type


Controls the orientation of the coordinate label.

1 - Equipment object
2 - Vertical label
3 - Static control point coordinate label symbol
4 - Horizontal text label

 Symbol - Places a static control point coordinate label.


 Horizontal - Places a horizontal text label.
 Vertical - Places a vertical text label.

Drawings and Reports Reference Data Guide 818


Labels

Honor View Direction


Determines whether or not the software considers the view direction when updating a
drawing. This setting is useful when placing an elevation coordinate label on a plan view.
Clear the Honor View Direction check box if you want the software to ignore the view
direction.

1 - Equipment object
2 - Elevation label
3 - Static control point

Select Honor View Direction if you want the software to consider the view direction. The
software honors the view direction by default.

1 - Equipment object
2 - Elevation label
3 - Static control point

Symbol Settings
The label symbols can be modified in SmartSketch Drawing Editor. For more information on the
specific attributes available for modification, see the SmartSketch Drawing Editor User's Guide.
The following attributes can be changed from the Symbols tab in the Properties Dialog Box of
SmartSketch Drawing Editor.
 Text shape
 Text background
 Symbol handles
 Extra graphics

Drawings and Reports Reference Data Guide 819


Labels

 Text formatting
 Type of property
 Value for the symbol
 Attributes

Generic Shape Tracing


The software automatically hides the leader when it intersects the boundaries of an object. In
the example below, the dotted segment of the leader would be hidden, because it is placed over
the equipment object boundaries.

Drawings and Reports Reference Data Guide 820


Labels

Generic Text Shape Leader Shift


The leader will automatically switch sides when being repositioned. By default, the leader origin
is in the middle of the label. When being repositioned, the leader will find the shortest distance
from the label to the object.

If a label with a jogged leader is placed, the jog will position on the left or right side depending
on which side is closest to the point being labeled.

If an unsymmetrical text shape label is placed with a jogged leader, the direction of the label will
change with the jog position.

Drawings and Reports Reference Data Guide 821


Labels

Label Rules
Label rules control automatic label placement on drawings. For more information, see Label
Rules. You can customize these label rules by editing the XML and/or SYM files. For more
information on customizing label rules, see Create a Compound Label Using Label Rules (on
page 745).
You can also create new label rules. Before creating a new label rule, you must first create the
label query using the Define Label command in the Catalog task.
See Also
Labels (on page 740)
Label Rules (on page 764)

Clipped Labels
Description: Labels are positioned at the end of a pipe segment when clipped by a volume
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Linear Pipe Endpoints (DrawingPGPipeSegments) (on page 1357)
Geometric Analyzer: End of Segment (DrawingGAEndOfSegment) (on page 1292)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Clipped (DwgClippedPositioning) (on page 1166), Clear
Space End of Linear Object (DwgLblEndOfSegmentPos) (on page 1172), Clear Space Margin
(DrawingMarginOnly) (on page 1189)
Example

For more information on clipped pipes in view styles, see Clipping in Piping View Styles (on
page 552).

Label Template Name Returned Properties

Electrical CableTray Elevation_LineNumber_Clipped Name

Electrical CableTray Plan_LineNumber_Clipped Name

Drawings and Reports Reference Data Guide 822


Labels

Label Template Name Returned Properties

Electrical Cableway Plan_LineNumber_Clipped Name

Electrical Equipment Elevation_LineNumber_Clipped Name

Electrical Equipment Plan_LineNumber_Clipped Name

HVAC Elevation_LineNumber_Clipped Name

HVAC Plan_LineNumber_Clipped Name

Piping Elevation_LineNumber_Clipped NPD, NPDUnitType, Fluid Type,


Sequence Number, Spec Name

Piping Plan_LineNumber_Clipped NPD, NPDUnitType, Fluid Type,


Sequence Number, Spec Name

Piping Plan_Piping Parts_RunName Name, PrimarySize,


PriSizeNPDUnits, Insulation
Purpose, PipeSpec, FluidCode

Coordinate and Control Point Labels


Description: Places the appropriate control point symbol
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Absolute XY Offset (DrawingAbsolute) (on page 1130)
Example

For more information on these labels, see Control Points in Plan View Styles (on page 483).

Label Template Name Returned Properties

Civil Isometric_Process Equipment_Symbol None

Civil Overall Key Plan_Process Equipment_Symbol None

Civil Plan_Process Equipment_Symbol None

Drawings and Reports Reference Data Guide 823


Labels

Label Template Name Returned Properties

Equipment Elevation_Process Equipment_Symbol None

Equipment Plan_Process Equipment_Symbol None

Pipe Supports - Piping_Control Point Structure_Symbol None

Pipe Supports - Structure_Control Point Structure_Symbol None

Pipe Supports_Control Point Structure_Symbol None

Piping Plan_Process Equipment_Symbol None

Structural Framing Plan_Process Equipment_Symbol None

Description: Labels contain coordinate values and/or control point name from the model
Type: COM
XML Location: [Reference Data Product
Folder]\CatalogData\Symbols\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: DrawingPGControlPoint
Geometric Analyzer: DrawingGALabelInline
Annotation Control Generator: DefaultLabelControlGenerator
Content Module: DrawingLabelHelper
Positioning Module: DrawingCoordLblPosMod, DrawingAbsolute
Example

For more information, see Control Points in Plan View Styles (on page 483).
The returned properties X, Y, and Z refer to the coordinates of the control point, while
the returned properties X1, Y1, and Z1 refer to the coordinates of the origin.

Drawings and Reports Reference Data Guide 824


Labels

Label Template Name Returned Properties

Equipment Elevation_Process Equipment_East Coordinate X1, Y1, Z1, X, Y, Z

Equipment Elevation_Process Equipment_North Coordinate X1, Y1, Z1, X, Y, Z

Equipment Plan_Process Equipment_East Coordinate X1, Y1, Z1, X, Y, Z

Equipment Plan_Process Equipment_North Coordinate X1, Y1, Z1, X, Y, Z

Pipe Supports - Piping_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

Pipe Supports - Piping_Control Point Structure_North Coordinate X1, Y1, Z1, X, Y, Z

Pipe Supports - Structure_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

Pipe Supports - Structure_Control Point Structure_North X1, Y1, Z1, X, Y, Z


Coordinate

Pipe Supports_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

Pipe Supports_Control Point Structure_North Coordinate X1, Y1, Z1, X, Y, Z

Piping Plan_Process Equipment_East Coordinate X1, Y1, Z1, X, Y, Z

Piping Plan_Process Equipment_North Coordinate X1, Y1, Z1, X, Y, Z

Structural Framing Plan_Process Equipment_East Coordinate X1, Y1, Z1, X, Y, Z

Structural Framing Plan_Process Equipment_North Coordinate X1, Y1, Z1, X, Y, Z

Drawings and Reports Reference Data Guide 825


Labels

Coordinate Labels
Description: Label contains coordinate information of object from the model
Type: COM
XML Location:[Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: Aligned Objects (DrawingGALabelInline) (on page 1135)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Coordinate (DrawingCoordLblPosMod) (on page 1167),
Absolute XY Offset (DrawingAbsolute) (on page 1130)
Leader Module: Coordinate (DrawingCoordLeaderControl) (on page 1262)
Example

The returned properties X, Y, and Z refer to the coordinates of the control point, while
the returned properties X1, Y1, and Z1 refer to the coordinates of the origin.

Label Template Name Returned Properties

Civil Isometric_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

Civil Isometric_Control Point Structure_North Coordinate X1, Y1, Z1, X, Y, Z

Civil Overall Key Plan_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

Civil Overall Key Plan_Control Point Structure_North Coordinate X1, Y1, Z1, X, Y, Z

Civil Plan_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

Civil Plan_Control Point Structure_North Coordinate X1, Y1, Z1, X, Y, Z

CtrlPtECoord_None_CA_L X1, Y1, Z1, X, Y, Z

CtrlPtNCoord_None_CA_L X1, Y1, Z1, X, Y, Z

CtrlPtOnlyECoord_None_CA_L X1, Y1, Z1, X, Y, Z

CtrlPtOnlyNCoord_None_CA_L X1, Y1, Z1, X, Y, Z

Equipment Elevation_Process Equipment_East Coordinate X1, Y1, Z1, X, Y, Z

Equipment Elevation_Process Equipment_North Coordinate X1, Y1, Z1, X, Y, Z

Equipment Plan_Control Point Mechanical Equipment_East X1, Y1, Z1, X, Y, Z


Coordinate

Drawings and Reports Reference Data Guide 826


Labels

Label Template Name Returned Properties

Equipment Plan_Control Point Mechanical Equipment_North X1, Y1, Z1, X, Y, Z


Coordinate

Equipment Plan_Control Point Process Equipment_East X1, Y1, Z1, X, Y, Z


Coordinate

Equipment Plan_Control Point Process Equipment_North X1, Y1, Z1, X, Y, Z


Coordinate

Equipment Plan_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

Equipment Plan_Control Point Structure_North Coordinate X1, Y1, Z1, X, Y, Z

Equipment Plan_Process Equipment_East Coordinate X1, Y1, Z1, X, Y, Z

Equipment Plan_Process Equipment_North Coordinate X1, Y1, Z1, X, Y, Z

HngSup End_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

HngSup End_Control Point Structure_North Coordinate X1, Y1, Z1, X, Y, Z

HngSup Side_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

HngSup Side_Control Point Structure_North Coordinate X1, Y1, Z1, X, Y, Z

Pipe Supports - Piping_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

Pipe Supports - Piping_Control Point Structure_North Coordinate X1, Y1, Z1, X, Y, Z

Pipe Supports - Structure_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

Pipe Supports - Structure_Control Point Structure_North X1, Y1, Z1, X, Y, Z


Coordinate

Pipe Supports_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

Pipe Supports_Control Point Structure_North Coordinate X1, Y1, Z1, X, Y, Z

Piping Fire Protection Plan_Control Point Structure_East X1, Y1, Z1, X, Y, Z


Coordinate

Piping Fire Protection Plan_Control Point Structure_North X1, Y1, Z1, X, Y, Z


Coordinate

Piping Plan_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

Piping Plan_Control Point Structure_North Coordinate X1, Y1, Z1, X, Y, Z

Drawings and Reports Reference Data Guide 827


Labels

Label Template Name Returned Properties

Piping Plan_Equipment_Name_Style2_East Coordinate X1, Y1, Z1, X, Y, Z


Displays the equipment name with the coordinate:

Piping Plan_Equipment_Name_Style2_North Coordinate X1, Y1, Z1, X, Y, Z


Displays the equipment name with the coordinate:

Piping Plan_Equipment_Style2_East Coordinate X1, Y1, Z1, X, Y, Z


Displays the equipment coordinate:

Piping Plan_Equipment_Style2_North Coordinate X1, Y1, Z1, X, Y, Z


Displays the equipment coordinate:

Piping Plan_Process Equipment_East Coordinate X1, Y1, Z1, X, Y, Z

Piping Plan_Process Equipment_North Coordinate X1, Y1, Z1, X, Y, Z

Piping Safety Shower Plan_Control Point Structure_East X1, Y1, Z1, X, Y, Z


Coordinate

Piping Safety Shower Plan_Control Point Structure_North X1, Y1, Z1, X, Y, Z


Coordinate

Piping Utility Station Plan_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z

Piping Utility Station Plan_Control Point Structure_North X1, Y1, Z1, X, Y, Z


Coordinate

Structural Framing Plan_Process Equipment_East Coordinate X1, Y1, Z1, X, Y, Z

Structural Framing Plan_Process Equipment_North Coordinate X1, Y1, Z1, X, Y, Z

Drawings and Reports Reference Data Guide 828


Labels

Grid Labels
Description: Labels contain grid names from the model
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Grid Margin (DrawingGridLblMarginOnly) (on page 1180),
Absolute Grid Margin (DrawingGridLblMgnAbsPos) (on page 1118)
Example

X-axis grids Y-axis grids

For more information on grid labels in view styles, see Grid Lines in Plan View Styles (on page
393).

Label Template Name Returned Properties

Civil Plan_Grid Line_X Name Name

Civil Plan_Grid Line_Y Name Name

Electrical Above Ground Plan_Grid Line_X Name Name

Electrical Above Ground Plan_Grid Line_Y Name Name

Electrical CableTray Layout Plan_Grid Line_X Name Name

Electrical CableTray Layout Plan_Grid Line_Y Name Name

Electrical CableTray Plan_Grid Line_X Name Name

Electrical CableTray Plan_Grid Line_Y Name Name

Electrical Equipment Plan_Grid Line_X Name Name

Electrical Equipment Plan_Grid Line_Y Name Name

Electrical Instrument Plan_Grid Line_X Name Name

Drawings and Reports Reference Data Guide 829


Labels

Label Template Name Returned Properties

Electrical Instrument Plan_Grid Line_Y Name Name

Electrical Lighting Plan_Grid Line_X Name Name

Electrical Lighting Plan_Grid Line_Y Name Name

Electrical Raceway Plan_Grid Line_X Name Name

Electrical Raceway Plan_Grid Line_Y Name Name

Equipment Plan_Grid Line_X Name Name

Equipment Plan_Grid Line_Y Name Name

GridLineX_Circle_CM_L Name

GridLineY_Circle_CM_L Name

GridLineX_Circle_CS_JL Name
Also uses the DrawingGridLblVert positioning module.

GridLineY_Circle_CS_JL Name
Also use the DrawingGridLblHoriz positioning module.

HVAC Plan_Grid Line_X Name Name

HVAC Plan_Grid Line_Y Name Name

Instrument Plan_Grid Line_X Name Name

Instrument Plan_Grid Line_Y Name Name

Piping Fire Protection Plan_Grid Line_X Name Name

Piping Fire Protection Plan_Grid Line_Y Name Name

Piping Plan_Grid Line_X Name Name

Piping Plan_Grid Line_Y Name Name

Piping Safety Shower Plan_Grid Line_X Name Name

Piping Safety Shower Plan_Grid Line_Y Name Name

Piping Utility Station Plan_Grid Line_X Name Name

Drawings and Reports Reference Data Guide 830


Labels

Label Template Name Returned Properties

Piping Utility Station Plan_Grid Line_Y Name Name

Structural Framing Plan_Grid Line_X Name Name

Structural Framing Plan_Grid Line_Y Name Name

Structural Instrument Plan_Grid Line_X Name Name

Structural Instrument Plan_Grid Line_Y Name Name

Description: Labels contain top of steel measurements or grid plane names from the model
Type: COM
XML Location: [Reference Data Product
Folder]\CatalogData\Symbols\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: DrawingAbsolute
TOS Example

Drawings and Reports Reference Data Guide 831


Labels

Grid Plane Example

Label Template Name Returned Properties

Electrical CableTray Elevation_Grid Line_TOS Name, X, Y, Elevation, Type

Electrical CableTray Elevation_Grid Plane_Name Name

Electrical Equipment Elevation_Grid Line_TOS Name, X, Y, Elevation, Type

Electrical Equipment Elevation_Grid Plane_Name Name

Equipment Elevation_Grid Line_TOS Name, X, Y, Elevation, Type

Equipment Elevation_Grid Plane_Name Name

GridHorizCoordinateLabel PositionX, PositionY, Axis

GridLineX_Circle_A_L Name

GridLineY_Circle_A_L Name

GridPlane_Name Name

GridVertCoordinateLabel PositionX, PositionY, Axis

HVAC Elevation_Grid Line_TOS Name, X, Y, Elevation, Type

HVAC Elevation_Grid Plane_Name Name

Instrument Elevation_Grid Line_TOS Name, X, Y, Elevation, Type

Drawings and Reports Reference Data Guide 832


Labels

Label Template Name Returned Properties

Instrument Elevation_Grid Plane_Name Name

Piping Elevation_Grid Line_TOS Name, X, Y, Elevation, Type

Piping Elevation_Grid Plane_Name Name

Structural Framing Elevation_Grid Line_TOS Name, X, Y, Elevation, Type

Structural Framing Elevation_Grid Plane_Name Name

Structural Framing Plan_Grid Plane_X Name Name

Structural Framing Plan_Grid Plane_Y Name Name

TOS_Line_A_L Name, X, Y, Elevation, Type

Longest Segment Labels


Description: Longest segment of object within a view is labeled
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Linear Pipe Endpoints (DrawingPGPipeSegments) (on page 1357)
Geometric Analyzer: Longest Segment (DrawingGALongestSegment) (on page 1366)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Center Then Above (DrawingCenterThenAbove) (on page
1159)
Example

For more information on the longest segment rule in view styles, see Piping Parts in Piping View
Styles (on page 603).

Label Template Name Returned Properties

BopPipePort1_CA_JL Name

Electrical CableTray Elevation_LineNumber_Longest Segment Name

Electrical CableTray Plan_LineNumber_Longest Segment Name

Drawings and Reports Reference Data Guide 833


Labels

Label Template Name Returned Properties

Electrical Equipment Elevation_LineNumber_Longest Segment Name

Electrical Equipment Isometric_LineNumber_Longest Segment Name

Electrical Equipment Plan_LineNumber_Longest Segment Name

HVAC Elevation_LineNumber_Longest Segment Name

HVAC Plan_LineNumber_Longest Segment Name

Piping Elevation_LineNumber_Longest Segment Name

Piping Isometric_LineNumber_Longest Segment Name

Piping Plan_FlowArrow_Longest Segment Name

Piping Plan_LineNumber_Longest Segment Name

Piping Plan_Piping Parts_RunName_Longest Segment Name

SP3DCoordinate_CA_JL Name

Miscellaneous Labels
Topics
CtrlPtCoordSym_None_A_NL ....................................................... 834
CtrlPtECoord_None_CA_L ............................................................ 835
CtrlPtNCoord_None_CA_L ............................................................ 835
CtrlPtOnlyCoordSym_None_A_NL ................................................ 835
CtrlPtOnlyECoord_None_CA_L ..................................................... 836
CtrlPtOnlyNCoord_None_CA_L .................................................... 836
HngSup End_KeyPlan_Coordinate Label ..................................... 836
HngSup End_KeyPlan_Coordinate_KPLabel Label ...................... 837
Name_None_AV_NL ..................................................................... 839
Name_None_CPM_JL ................................................................... 840
Name_None_M_JL ........................................................................ 840
System-FluidCode-Seq-Insul_None_CPM_JL .............................. 840

CtrlPtCoordSym_None_A_NL
Description: Label contains coordinate information of object from the model
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on

Drawings and Reports Reference Data Guide 834


Labels

page 1261)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Absolute XY Offset (DrawingAbsolute) (on page 1130)

CtrlPtECoord_None_CA_L
Description: Label contains coordinate information of object from the model
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: Aligned Objects (DrawingGALabelInline) (on page 1135)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Coordinate (DrawingCoordLblPosMod) (on page 1167),
Absolute XY Offset (DrawingAbsolute) (on page 1130)
Leader Module: Coordinate (DrawingCoordLeaderControl) (on page 1262)

CtrlPtNCoord_None_CA_L
Description: Label contains coordinate information of object from the model
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on
page 1261)
Geometric Analyzer: Aligned Objects (DrawingGALabelInline) (on page 1135)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Coordinate (DrawingCoordLblPosMod) (on page 1167),
Absolute XY Offset (DrawingAbsolute) (on page 1130)
Leader Module: Coordinate (DrawingCoordLeaderControl) (on page 1262)

CtrlPtOnlyCoordSym_None_A_NL
Description: Label contains coordinate information of object from the model
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Control Point Only (DrawingPGCPThenNone) (on page 1260)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Absolute XY Offset (DrawingAbsolute) (on page 1130)

Drawings and Reports Reference Data Guide 835


Labels

CtrlPtOnlyECoord_None_CA_L
Description: Label contains coordinate information of object from the model
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Control Point Only (DrawingPGCPThenNone) (on page 1260)
Geometric Analyzer: Aligned Objects (DrawingGALabelInline) (on page 1135)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Coordinate (DrawingCoordLblPosMod) (on page 1167),
Absolute XY Offset (DrawingAbsolute) (on page 1130)
Leader Module: Coordinate (DrawingCoordLeaderControl) (on page 1262)

CtrlPtOnlyNCoord_None_CA_L
Description: Label contains coordinate information of object from the model
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Control Point Only (DrawingPGCPThenNone) (on page 1260)
Geometric Analyzer: Aligned Objects (DrawingGALabelInline) (on page 1135)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Coordinate (DrawingCoordLblPosMod) (on page 1167),
Absolute XY Offset (DrawingAbsolute) (on page 1130)
Leader Module: Coordinate (DrawingCoordLeaderControl) (on page 1262)

HngSup End_KeyPlan_Coordinate Label


Description: Labels the origin or control point of a hanger assembly with coordinate information
from the model and is used by the HngSup3View Package (on page 358) drawing by query
package.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: DrawingPGKeyPlanControlPoint
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Quadrant 1 (DrawingQuadOne) (on page 1224), Clear
Space Quadrant 2 (DrawingQuadTwo) (on page 1229), Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234), Clear Space Quadrant 4 (DrawingQuadFour) (on page
1240), Absolute XY Offset (DrawingAbsolute) (on page 1130)

 This label is found in the HngSup - End View Style (on page 489).
 This label can be replaced by the HngSup End_KeyPlan_Coordinate_KPLabel label rule in
order to display a "KP" label instead of the key point coordinate location. For more
information, see HngSup End_KeyPlan_Coordinate_KPLabel Label (on page 837).

Drawings and Reports Reference Data Guide 836


Labels

Example

See Also
Compound Labels (on page 744)

HngSup End_KeyPlan_Coordinate_KPLabel Label


Description: Labels the origin or control point of a hanger assembly with a key point symbol.
This label is delivered, but is not used by any view styles. It can replace the HngSup
End_KeyPlan_Coordinate Label (on page 836) in order to display a KP symbol instead of the
key point coordinate location.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: DrawingPGKeyPlanControlPoint
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Quadrant 1 (DrawingQuadOne) (on page 1224), Clear
Space Quadrant 2 (DrawingQuadTwo) (on page 1229), Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234), Clear Space Quadrant 4 (DrawingQuadFour) (on page
1240), Absolute XY Offset (DrawingAbsolute) (on page 1130)
This label can be used in the HngSup - End View Style (on page 489) to replace the
delivered HngSup End_KeyPlan_Coordinate label.

Drawings and Reports Reference Data Guide 837


Labels

Example

Description: Label contains key point coordinate location information. This label consists of five
labels that return the Y offset, X offset, Y grid plane, X grid plane, and elevation. A symbol is
also used to label the key point location.
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: DrawingHangerLabelContent
Positioning Module: Absolute XY Offset (DrawingAbsolute) (on page 1130)

 This label is found in the HngSup - Key Plan View Style (on page 494) view style.
 If no coordinate system is defined, or the hanger assembly key point is more than one meter
outside of the first or last x/y grid plane or elevation plane in the specified coordinate system,
the software defaults to the global coordinate system and the grid label bubbles are left
blank.
 Key Point location - Indicates the location of the hanger key point with a symbol. The
key point location symbol is placed relative to where the coordinate system is in model
space. In the example below, the key point is located in the upper right-hand portion of
the grid system.
 Y Offset - Distance between the key point and nearest Y grid plane or global origin on
the y-axis.
 Y Grid Plane - Name of the nearest Y grid plane. If no coordinate system is specified in
the drawing sheet properties, the software defaults to the global coordinate system and
the bubble is left blank.
 X Offset - Distance between key point and nearest X grid plane or global origin on the
x-axis.

Drawings and Reports Reference Data Guide 838


Labels

 X Grid Plane - Name of the nearest X grid plane. If no coordinate system is specified in
the drawing sheet properties, the software defaults to the global coordinate system and
the bubble is left blank.
 Elevation Value - Distance between key point and coordinate system origin or global
origin on the z-axis. If no coordinate system is specified in the drawing sheet properties,
the software defaults to the global coordinate system origin.

Examples

The example below is using the global coordinate system, which means the grid label bubbles
are blank.

Name_None_AV_NL
Description: Places a name label at an absolute position relative to a vector from the center of
the view and aligned to the object
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Absolute Radial from View Center (DrawingVectorAbsolute) (on page
1129)

Drawings and Reports Reference Data Guide 839


Labels

Name_None_CPM_JL
Description: Places name label on object and checks whether or not the object is clipped. If the
object is clipped, the label is placed in the margin.
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Clipped (DwgClippedPositioning) (on page 1166), Clear
Space Along Linear Object (DwgLinearPositioning) (on page 1159), DrawingMarginOnly
Leader Module: Default (DwgLeaderControl) (on page 1271)

Name_None_M_JL
Description: Places name label on object and checks whether or not the object is clipped. If the
object is clipped, the label is placed in the margin.
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Clipped (DwgClippedPositioning) (on page 1166),
DrawingMarginOnly
Leader Module: Default (DwgLeaderControl) (on page 1271)

System-FluidCode-Seq-Insul_None_CPM_JL
Description: Places name label on object and checks whether or not the object is clipped. If the
object is clipped, the label is placed in the margin.
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: DrawingPGPipeSegments
Geometric Analyzer: DrawingGAEndOfSegment
Annotation Control Generator: DefaultLabelControlGenerator
Content Module: DrawingLabelHelper
Positioning Module: DwgClippedPositioning, DwgLblEndOfSegmentPos, DrawingMarginOnly
Leader Module: DwgLeaderControl

Drawings and Reports Reference Data Guide 840


Labels

Name Labels (DrawingAbsolute)


Description: Labels contain object name from the model
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Absolute XY Offset (DrawingAbsolute) (on page 1130)
Example

For more information on volume names in view styles, see Civil Key Plan View Style (on page
383).

Label Template Name Returned Properties

Civil Key Plan_Focus_Name Name

Civil Overall Key Plan_Volume_Name Name

DrawingVolume_Name_Rect_A_NL Name

Electrical CableTray Key Plan_Focus_Name Name

Electrical CableTray Overall Key Plan_Volume_Name Name

Electrical Equipment Key Plan_Focus_Name Name

Electrical Equipment Overall Key Plan_Volume_Name Name

Drawings and Reports Reference Data Guide 841


Labels

Label Template Name Returned Properties

Electrical Lighting Plan_Light_Symbol_Number None

Equipment Key Plan_Volume_Name Name

Equipment Overall Key Plan_Volume_Name Name

HVAC Diffuser Name

HVAC Key Plan_Focus_Name Name

HVAC Overall Key Plan_Volume_Name Name

Instrument Overall Key Plan_Volume_Name Name

KeyPlanVolume_Name_Rect_A_NL Name

Name_Line_A_NL Name

Name_None_A_JL Name

Name_None_A_NL Name

Name_Rect_A_NL Name

Piping Key Plan_Focus_Name Name

Piping Overall Key Plan_Volume_Name Name

SP3DCoordinate_BottomLeft_CA_JL (on page 843) BOS

SP3DCoordinate_TopRight_CA_JL (on page 844) TOS

Structural Framing Key Plan_Focus_Name Name

Structural Key Plan_Focus_Name Name

Drawings and Reports Reference Data Guide 842


Labels

SP3DCoordinate_BottomLeft_CA_JL
Description: Labels bottom-left of a structure member with bottom of steel measurement. This
label must be used in elevation views.
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Absolute XY Offset (DrawingAbsolute) (on page 1130)
Example

When used with the SP3DCoordinate_BottomLeft_CA_JL label, the member is labeled with both
TOS and BOS values.

Drawings and Reports Reference Data Guide 843


Labels

SP3DCoordinate_TopRight_CA_JL
Description: Labels top-right of a structure member with top of steel measurement. This label
must be used in elevation views.
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Absolute XY Offset (DrawingAbsolute) (on page 1130)
Examples

When used with the SP3DCoordinate_BottomLeft_CA_JL label, the member is labeled with both
TOS and BOS values.

Drawings and Reports Reference Data Guide 844


Labels

Name Labels (DwgLinearAbsPos)


Description: Labels contain object name from the model. The section size labels contain the
object name and section size from the model.
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Absolute Along Linear Object (DwgLinearAbsPos) (on page 1113)
Examples

Vertical Segment

For more information on these labels, see HVAC Parts in HVAC View Styles (on page 511).

Drawings and Reports Reference Data Guide 845


Labels

Section Size

For more information on these labels, see Structural Framing Plan View Styles (on page 623).

Label Template Name Returned Properties

Name_None_APO_NL Name

SectionSize_None_APO_NL Name, Section Size

Structural Framing Plan_Beams_Section Size_Index-Aligned Name, Section Size

Structural Framing Plan_Braces_Section Size_Relative Elevation Name, Section Size

Structural Framing Plan_Columns_Section Size1 Name, Section Size

Drawings and Reports Reference Data Guide 846


Labels

Name Labels (Name-Elevation-Width)


Description: Labels contain object name from the model
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Quadrant 1 (DrawingQuadOne) (on page 1224), Clear
Space Quadrant 2 (DrawingQuadTwo) (on page 1229), Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234), Clear Space Quadrant 4 (DrawingQuadFour) (on page
1240), Absolute XY Offset (DrawingAbsolute) (on page 1130)
Example

For more information on name labels used in view styles, see Cable Trays in Elevation View
Styles (on page 404).

Label Template Name Returned Properties

Electrical CableTray Elevation_Cable Trays_Name-Elevation-Width Name, SysName, Shape


Width

Electrical CableTray Isometric_Cable Trays_Name-Elevation-Width Name, SysName, Shape


Width

Electrical CableTray Plan_Cable Trays_Name-Elevation-Width Name, SysName, Shape

Drawings and Reports Reference Data Guide 847


Labels

Label Template Name Returned Properties


Width

Electrical Raceway Plan_Cable Trays_Name-Elevation-Width Name, SysName, Shape


Width

Instrument Plan_Cable Trays_Name-Elevation-Width Name, SysName, Shape


Width

Nozzle Orientation Labels


Description: Labels contain nozzle name and angle from the model.
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Nozzle (DrawingPGNozzleandBrace) (on page 1401)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Clear Space Radial from Object Center with Clustering (DrawingCentroid)
(on page 1247)
Leader Module: Stacked Labels (DwgStackLabelLeader) (on page 1466)
The nozzle orientation labels receive nozzle angle information from the
SP3DDrawingLabelQuery content module. For more information, see
SP3DDrawingLabelQuery (on page 1897).

Drawings and Reports Reference Data Guide 848


Labels

Example

For more information on nozzle orientation labels in view styles, see Nozzle View Styles (on
page 560).

Label Template Name Returned Properties

Nozzle Orientation Plan_Nozzle_BTM_Name Name

Nozzle Orientation Plan_Nozzle_TOP_Name Name

Nozzle Orientation Plan_Nozzle_NozzleAngleLabel Angle

Nozzle Orientation Plan_NozzleLabel Name

Drawings and Reports Reference Data Guide 849


Labels

Reference Labels
Description: Labels the object with the item number from the embedded report
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Reference (DrawingReferenceLabelContent) (on page 1451)
Positioning Module: Clear Space Quadrant 1 (DrawingQuadOne) (on page 1224), Clear
Space Quadrant 2 (DrawingQuadTwo) (on page 1229), Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234), Clear Space Quadrant 4 (DrawingQuadFour) (on page
1240), Absolute XY Offset (DrawingAbsolute) (on page 1130)

Label Template Name Returned Properties

HngSup ISO_Reference_Circle_CA_L None

HngSup Side_Reference_Circle_CA_L None

Pipe Supports - Components_Reference_Circle_CA_L None

Pipe Supports - Piping_Reference_Circle_CA_L None

Pipe Supports - Structure_Reference_Circle_CA_L None

Reference_Circle_CA_L None

Description: Labels the object with the item number from the embedded report
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Key Point (DefaultLabelPointGenerator) (on page 1338)
Geometric Analyzer: No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on
page 1398)
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Reference (DrawingReferenceLabelContent) (on page 1451)
Positioning Module: Clear Space Grid Margin (DrawingGridLblMarginOnly) (on page 1180),
Absolute Grid Margin (DrawingGridLblMgnAbsPos) (on page 1118)

Label Template Name Returned Properties

HngSup_End_Diamond_M_L None

HngSup_Diamond_M_L None

Drawings and Reports Reference Data Guide 850


Labels

Section Size Labels


Description: Labels contain section size of structure from the model
Type: COM
XML Location: [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\[Label Template Name].xml
Point Generator: Linear Object Endpoints (DrawingPGLinear) (on page 1357)
Geometric Analyzer: DrawingGAByOppositePoints
Annotation Control Generator: Default (DefaultLabelControlGenerator) (on page 1265)
Content Module: Default (DrawingLabelHelper) (on page 1268)
Positioning Module: Absolute Along Linear Object (DwgLinearAbsPos) (on page 1113)
Example

For more information on section size labels, see Structural Framing Elevation View Style (on
page 611).

Label Template Name Returned Properties

Structural Framing Elevation_Beams_Section Size SectionName

Structural Framing Elevation_Braces_Section Size SectionName

Structural Framing Elevation_Columns_Section Size SectionName

Structural Framing Plan_Beams_Section Size SectionName

Structural Framing Plan_Beams_Section Size_Relative Elevation SectionName


This label
template has a property,
BaselineElevation,
which populates the label
text with the baseline
elevation value. The
value is calculated by
subtracting the elevation
value of a structure
member in a drawing
volume from the global
Z-coordinate value.

Structural Framing Plan_Braces_Section Size SectionName

Drawings and Reports Reference Data Guide 851


Labels

Label Template Name Returned Properties

Structural Framing Plan_Braces_Section Size_Relative Elevation SectionName


This label
template has a property,
BaselineElevation,
which populates the label
text with the baseline
elevation value. The
value is calculated by
subtracting the elevation
value of a structure
member in a drawing
volume from the global
Z-coordinate value.

Label Rules in Drawings by Rule


Marine mode provides additional label rules that control the appearance of annotation labels as
well as their automatic placement on drawings.

Topics
General Label Rules ...................................................................... 852
Scantling Label Rules .................................................................... 853
Hull Lines and Manufacturing Label Rules .................................... 856
North Arrow Label Rules ................................................................ 858

General Label Rules


The following structure label rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\LabelRules folder:

Label Rule Label Templates used in Rule


(.xml) (.xml)

Assembly NonWeld Symbol Assembly NonWeld Symbol

Classification Profile Thickness Symbol Classification Profile Thickness Symbol

Generic Distance To Nearest Coordinate Generic Distance To Nearest Coordinate


System_CA_JL System_CA_JL

Generic_Name Generic_Name

Generic_Name _L Generic_Name _L

Generic_Name _RC Generic_Name _RC

Generic_Name _RC_L Generic_Name _RC_L

Drawings and Reports Reference Data Guide 852


Labels

Label Rule Label Templates used in Rule


(.xml) (.xml)

Grid Axis Grid Axis

Grid Axis_No Spacing Grid Axis_No Spacing

Grid Line Name Grid Line Name

Grid Line Name_M_L Grid Line Name_M_L

Grid Line Name_S Grid Line Name_S

Reference_Circle_CA_L Reference_Circle_CA_L

Ruleset_Name Ruleset_Name

Structure_Name Structure_Name

StrMfg PinJig Seam Point Symbol StrMfg PinJig Seam Point Symbol

StrMfg ProfileSketch WebThickness StrMfg ProfileSketch WebThickness

Scantling Label Rules


The following label rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\LabelRules folder:

Label Rule Label Templates used in Rule


(.xml) (.xml)

Opening Scantlings\Steel Order\Opening (see "Steel


Order Templates" on page 898)

Scantling Connection Intersection Symbol Scantling Connection Intersection Symbol (see


"Label Templates: Scantling" on page 872)

Scantling Connection Penetration Symbol Scantling Connection Penetration Symbol (see


"Label Templates: Scantling" on page 872)

Scantling Knuckle Line Label Scantling Knuckle Line Label

Scantling Knuckle Line Label_CA_L Scantling Knuckle Line Label_CA_L (see "Label
Templates: Scantling" on page 872)

Scantling Knuckle Line Label_CP_L Scantling Knuckle Line Label_CP_L (see "Label
Templates: Scantling" on page 872)

Drawings and Reports Reference Data Guide 853


Labels

Label Rule Label Templates used in Rule


(.xml) (.xml)

Scantling Knuckle Line Symbol Scantling Knuckle Line Symbol (see "Label
Templates: Scantling" on page 872)

Scantling Knuckle Point Symbol Scantling Knuckle Point Symbol (see "Label
Templates: Scantling" on page 872)

Scantling Knuckle Sloping Direction Symbol Scantling Knuckle Sloping Direction Symbol
(see "Label Templates: Scantling" on page 872)

Scantling Knuckle Surface Angle Scantling Knuckle Surface Angle (see "Label
Templates: Scantling" on page 872)

Scantling Non-Target Seam Symbol Scantling Non-Target Seam Symbol (see "Label
Templates: Scantling" on page 872)

Scantling Plate Mounting Angle Scantling Plate Mounting Angle (see "Label
Templates: Scantling" on page 872)

Scantling Plate Thickness Symbol Scantling Plate Thickness Symbol (see "Label
Templates: Scantling" on page 872)

Scantling Profile Mounting Angle Scantling Profile Mounting Angle (see "Label
Templates: Scantling" on page 872)

Scantling Profile Seam Symbol Scantling Profile Seam Symbol (see "Label
Templates: Scantling" on page 872)

Scantling Profile Thickness Symbol Scantling Profile Thickness Symbol (see "Label
Templates: Scantling" on page 872)

Scantling Shell Profile Weld Label Scantling Shell Profile Weld Label (see "Label
Templates: Scantling" on page 872)

Scantling Target Seam Symbol Scantling Target Seam Symbol (see "Label
Templates: Scantling" on page 872)

Ship Structure Plate GridPlane_Name Ship Structure Plate GridPlane_Name (see


"Label Templates: Ship Structure Plate" on
page 880)

Ship Structure Plate Material Type Grade Ship Structure Plate Material Type Grade
Thickness by COM Thickness by COM (see "Label Templates: Ship
Structure Plate" on page 880)

Ship Structure Plate Material Type Grade Ship Structure Plate Material Type Grade
Thickness Thickness (see "Label Templates: Ship
Structure Plate" on page 880)

Drawings and Reports Reference Data Guide 854


Labels

Label Rule Label Templates used in Rule


(.xml) (.xml)

Ship Structure Plate Short Name Plate Short Name

Ship Structure Plate Thickness Grade by COM Ship Structure Plate Thickness Grade by COM
(see "Label Templates: Ship Structure Plate" on
page 880)

Ship Structure Plate Thickness Grade Typical Ship Structure Plate Thickness Material Grade
Typical (see "Label Templates: Ship Structure
Plate" on page 880)

Ship Structure Plate Thickness Grade Ship Structure Plate Thickness Grade (see
"Label Templates: Ship Structure Plate" on
page 880)

Ship Structure Profile Cross-section by COM Ship Structure Profile Cross-section by COM
(see "Label Templates: Ship Structure Profile"
on page 883)

Ship Structure Profile Cross-section Material Ship Structure Profile Cross-section Material
Type Grade by COM Type Grade by COM (see "Label Templates:
Ship Structure Profile" on page 883)

Ship Structure Profile Cross-section Material Ship Structure Profile Cross-section Material
Type Grade Type Grade (see "Label Templates: Ship
Structure Profile" on page 883)

Ship Structure Profile Cross-section Ship Structure Profile Cross-section (see "Label
Templates: Ship Structure Profile" on page 883)

Ship Structure Profile Name Cross-section Ship Structure Profile Name Cross-section
Material Type Grade_L Material Type Grade_L (see "Label Templates:
Ship Structure Profile" on page 883)

Ship Structure Profile Short Name Ship Structure Profile Typical Cross-section
(see "Label Templates: Ship Structure Profile"
on page 883)
Scantlings\Steel Order\Profile Short Name (see
"Steel Order Templates" on page 898)

Ship Structure Profile System Short Name Ship Structure Profile Typical Cross-section
(see "Label Templates: Ship Structure Profile"
on page 883)
Scantlings\Steel Order\Profile System Short
Name (see "Steel Order Templates" on page
898)

Drawings and Reports Reference Data Guide 855


Labels

Label Rule Label Templates used in Rule


(.xml) (.xml)

Structure_Weld Structure_Weld (see "Label Templates: StrMfg -


W" on page 886)

WeldLabel WeldLabel (see "Label Templates: Ship


Structure Profile" on page 883)

WeldSymbols WeldSymbols

Hull Lines and Manufacturing Label Rules


The following label rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\LabelRules folder:

Hull Lines
Label Rule Label Templates used in Rule
(.xml) (.xml)

Hull Lines Default Seam Symbol Hull Lines Default Seam Symbol

Hull Lines Erection Seam Symbol Hull Lines Erection Seam Symbol

Hull Lines_Name Hull Lines_Name (see "Label Templates: H - L"


on page 865)

Manufacturing
Label Rule Label Templates used in Rule
(.xml) (.xml)

IS_ProfileSketch_Arial_2.5mm IS_ProfileSketch_Arial_2.5mm (see "Label


Templates: H - L" on page 865)

MFG_PinJig Remarking_Horizontal MFG_PinJig Remarking_Horizontal GirthLength


GirthLength (see "Label Templates: Mfg - R" on page 867)

MFG_PinJig Remarking_Vertical GirthLength MFG_PinJig Remarking_Vertical GirthLength


(see "Label Templates: Mfg - R" on page 867)

Mfg Scantling Margin_Value Mfg Scantling Margin_Value (see "Label


Templates: Mfg - R" on page 867)

StrMfg PinJig Seam Point Symbol StrMfg PinJig Seam Point Symbol

StrMfg ProfileSketch Bevel Shape 1mm StrMfg ProfileSketch Bevel Shape 1mm (see

Drawings and Reports Reference Data Guide 856


Labels

Label Rule Label Templates used in Rule


(.xml) (.xml)

"Label Templates: StrMfg - W" on page 886)

StrMfg ProfileSketch Bevel Shape 2mm StrMfg ProfileSketch Bevel Shape 2mm (see
"Label Templates: StrMfg - W" on page 886)

StrMfg ProfileSketch Bevel Symbol StrMfg ProfileSketch Bevel Symbol (see "Label
Templates: StrMfg - W" on page 886)

StrMfg ProfileSketch Detail Name StrMfg ProfileSketch Detail Name (see "Label
Templates: StrMfg - W" on page 886)

StrMfg ProfileSketch Detail Name_V StrMfg ProfileSketch Detail Name_V (see


"Label Templates: StrMfg - W" on page 886)

StrMfg ProfileSketch Feature Name StrMfg ProfileSketch Feature Name (see "Label
Templates: StrMfg - W" on page 886)

StrMfg ProfileSketch Knuckle Label StrMfg ProfileSketch Knuckle Label (see "Label
Templates: StrMfg - W" on page 886)

StrMfg ProfileSketch Labels StrMfg ProfileSketch Labels

StrMfg ProfileSketch Seam Label StrMfg ProfileSketch Seam Label (see "Label
Templates: StrMfg - W" on page 886)

StrMfg Sketch Bevel Symbol StrMfg Sketch Bevel Symbol (see "Label
Templates: StrMfg - W" on page 886)

StrMfg Sketch Feature Label StrMfg Sketch Feature Label (see "Label
Templates: StrMfg - W" on page 886)

StrMfg Sketch Feature Symbol StrMfg Sketch Feature Symbol (see "Label
Templates: StrMfg - W" on page 886)

StrMfg Templateset MidLine Symbol StrMfg Templateset MidLine Symbol (see


"Label Templates: StrMfg - W" on page 886)

StrMfg Templateset Seam Point Symbol StrMfg Templateset Seam Point Symbol (see
"Label Templates: StrMfg - W" on page 886)

StrMfg Templateset Tangent Point Symbol StrMfg Templateset Tangent Point Symbol (see
"Label Templates: StrMfg - W" on page 886)

TemplateSet_Seam_Symbol TemplateSet_Seam_Symbol

Drawings and Reports Reference Data Guide 857


Labels

Label Rule Label Templates used in Rule


(.xml) (.xml)

StrMfg ProfileSketch Plate Location Symbol StrMfg ProfileSketch Plate Location Symbol
(see "Label Templates: StrMfg - W" on page
886)

StrMfg ProfileSketch Detail Name_Voffset StrMfg ProfileSketch Detail Name_Voffset (see


"Label Templates: StrMfg - W" on page 886)

North Arrow Label Rules


The following label rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\NorthArrowRules folder:

Label Rule Label Templates used in Rule


(.xml) (.xml)

Mfg Profile DirectionRule NorthArrows\MfgProfile Direction (see "North


Arrow Templates" on page 894)

MfgTemplatesetFullScaleDirectionRule Right NorthArrows\


MfgTemplatesetFullScaleDirection Right (see
"North Arrow Templates" on page 894)

NorthArrow NorthArrows\NorthArrow

ShipDirectionRule Right Up NorthArrows\ShipDirection Up (see "North


Arrow Templates" on page 894)
NorthArrows\ShipDirection Right (see "North
Arrow Templates" on page 894)

ShipDirectionRule NorthArrows\ShipDirection Up (see "North


Arrow Templates" on page 894)
NorthArrows\ShipDirection Down (see "North
Arrow Templates" on page 894)
NorthArrows\ShipDirection Left (see "North
Arrow Templates" on page 894)
NorthArrows\ShipDirection Right (see "North
Arrow Templates" on page 894)

Structural NorthArrow.xml NorthArrows\Structural NorthArrow

Drawings and Reports Reference Data Guide 858


Labels

Label Templates in Drawings by Rule


Each marine mode label rule uses one or more label templates. Each template uses one or
more symbols and report templates. Label templates, symbols, and report templates are
delivered in the in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder.
Each label template also uses one or more annotation modules. For more information, see
Annotation Modules (on page 1728).

Topics
Label Templates: A - G .................................................................. 859
Label Templates: H - L .................................................................. 865
Label Templates: Mfg - R .............................................................. 867
Label Templates: Scantling ........................................................... 872
Label Templates: Ship Structure Plate .......................................... 880
Label Templates: Ship Structure Profile ........................................ 883
Label Templates: StrMfg - W ......................................................... 886
North Arrow Templates .................................................................. 894
View Templates ............................................................................. 897
Steel Order Templates ................................................................... 898

Label Templates: A - G
The following label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder:

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Assembly NonWeld Assembly NonWeld MidPoint (ISMidPointLabelPG) (on page


Symbol Symbol.sym 1389)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Drawings and Reports Reference Data Guide 859


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Classification Profile Scantling Thickness Points Along 2D Curve


Thickness Symbol Direction Up.sym (ISDwgPointsAlongCurve2D) (on page
1433)
Scantling Thickness
Direction Down.sym No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
Scantling Thickness
1398)
Direction Centered.sym
Default (DefaultLabelControlGenerator) (on
Scantling Thickness
page 1265)
Direction Unknown.sym
Profile System Thickness Symbol
Generic_Error.sym
(ISProfileSysThicknessSymbolContent) (on
page 1855)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Generic Distance To Generic Distance To No Grouping or Filtering (Default)


Nearest Coordinate Nearest Coordinate (DefaultLabelGeometricAnalyzer) (on page
System_CA_JL System_CA_J.sym 1398)
Generic Distance To Default (DefaultLabelControlGenerator) (on
Nearest Coordinate page 1265)
System.rtp
Default (DrawingLabelHelper) (on page
1268)
Default (DwgLeaderControl) (on page
1271)

Generic_Name Generic_Name.sym Points Along 2D Curve


(ISDwgPointsAlongCurve2D) (on page
Name.rtp
1433)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page

Drawings and Reports Reference Data Guide 860


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
1203)
Clear Space Position by 2D Curve at
Margin
(ISDwgPositionByCurve2DAtMargin) (on
page 1211)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Generic_Name _L Generic_Name _L.sym Points Along 2D Curve


(ISDwgPointsAlongCurve2D) (on page
Name.rtp
1433)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Clear Space Position by 2D Curve at
Margin
(ISDwgPositionByCurve2DAtMargin) (on
page 1211)
Default (DwgLeaderControl) (on page
1271)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Drawings and Reports Reference Data Guide 861


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Generic_Name _RC Generic_Name _RC.sym MidPoint (ISMidPointLabelPG) (on page


1389)
Name.rtp
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Generic_Name Generic_Name _RC_L.sym MidPoint (ISMidPointLabelPG) (on page


_RC_L 1389)
Name.rtp
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on

Drawings and Reports Reference Data Guide 862


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
page 1130)
Default (DwgLeaderControl) (on page
1271)

Grid Axis Points Along 2D Curve


(ISDwgPointsAlongCurve2D) (on page
1433)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Ruler Axis (SMRulerAxisSymbolContent)
(on page 1455)
Absolute Axis Position
(SMDwgPositionAxis) (on page 1117)

Grid Axis_No Points Along 2D Curve


Spacing (ISDwgPointsAlongCurve2D) (on page
1433)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Ruler Axis (SMRulerAxisSymbolContent)
(on page 1455)
Absolute Axis Position
(SMDwgPositionAxis) (on page 1117)

Grid Line Name Grid Line Name.sym Points Along 2D Curve


(ISDwgPointsAlongCurve2D) (on page
Structure_Name.rtp
1433)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve

Drawings and Reports Reference Data Guide 863


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
(ISDwgPositionByCurve2D) (on page
1203)
Clear Space Position by 2D Curve at
Margin
(ISDwgPositionByCurve2DAtMargin) (on
page 1211)
Clear Space Position by 2D Curve at
Margin
(ISDwgPositionByCurve2DAtMargin) (on
page 1211)

Grid Line Name_M_L Grid Line Name_M_L.sym Points Along 2D Curve


(ISDwgPointsAlongCurve2D) (on page
Structure_Name.rtp
1433)
Group by Axis (SMDwgGroupByAxisGA)
(on page 1307)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Absolute Position by 2D Curve at Axis
(SMDwgPositionByCurve2DAtAxis) (on
page 1124)

Grid Line Name_S Grid Line Name_S.sym Points Along 2D Curve


(ISDwgPointsAlongCurve2D) (on page
1433)
Group by Axis (SMDwgGroupByAxisGA)
(on page 1307)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Absolute Position by 2D Curve at Axis
(SMDwgPositionByCurve2DAtAxis) (on
page 1124)

Drawings and Reports Reference Data Guide 864


Labels

Label Templates: H - L
The following label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder:

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Hull Lines Default Hull Lines Default Seam Points Along 2D Curve
Seam Symbol Symbol.sym (ISDwgPointsAlongCurve2D) (on page
1433)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Hull Lines Erection Hull Lines Erection Seam Points Along 2D Curve
Seam Symbol Symbol.sym (ISDwgPointsAlongCurve2D) (on page
1433)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Drawings and Reports Reference Data Guide 865


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Hull Lines_Name Hull Lines_Name.sym Points Along 2D Curve


(ISDwgPointsAlongCurve2D) (on page
Name.rtp
1433)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

IS_ProfileSketch_ IS_ProfileSketch_ Absolute Points (ISAbsolutePointLabelPG)


Arial_2.5mm Arial_2.5mm.sym (on page 1120)
Default Marine Label Text
(ISRulesetLabelAnalyzer) (on page 1276)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default Marine Label
(ISRulesetLabelContent) (on page 1275)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Drawings and Reports Reference Data Guide 866


Labels

Label Templates: Mfg - R


The following label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder:

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

MFG_Pinjig_Pin MFG_Pinjig_Pin MidPoint (ISMidPointLabelPG) (on page


Height Height.sym 1389)
StrMfg PinJig PinHeight.rtp
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Manufacturing Pin Height Label
(SMDwgMfgPinHeightLabelContent) (on
page 1369)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

MFG_PinJig MFG_PinJig Point on Remarking Curve along Girth


Remarking_Horizonta Remarking_Horizontal (SM3DDwgRemarkingGirthLengthPG) (on
l GirthLength GirthLength.sym page 1432)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Remarking Girth Length Label
(SM3DDwgRemarkingGirthLengthCM) (on
page 1452)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Drawings and Reports Reference Data Guide 867


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

MFG_PinJig MFG_PinJig Point on Remarking Curve along Girth


Remarking_Vertical Remarking_Vertical (SM3DDwgRemarkingGirthLengthPG) (on
GirthLength GirthLength.sym page 1432)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Remarking Girth Length Label
(SM3DDwgRemarkingGirthLengthCM) (on
page 1452)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

MFG_PinJig MFG_PinJig SideView_ MidPoint (ISMidPointLabelPG) (on page


SideView_ SeamOffsetfromChord 1389)
SeamOffsetfromChor -Left.sym
No Grouping or Filtering (Default)
d
(DefaultLabelGeometricAnalyzer) (on page
-Left
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
SMDPinJigSeamOffsetCM
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

MFG_PinJig MFG_PinJig SideView_ MidPoint (ISMidPointLabelPG) (on page


SideView_ SeamOffsetfromChord 1389)
SeamOffsetfromChor -Right.sym
No Grouping or Filtering (Default)
d
(DefaultLabelGeometricAnalyzer) (on page
-Right
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
SMDPinJigSeamOffsetCM
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Drawings and Reports Reference Data Guide 868


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Mfg Profile Mfg Profile Points Along 2D Curve


Margin_Value Margin_Value.sym (ISDwgPointsAlongCurve2D) (on page
1433)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Manufacturing Profile Margin Symbol
(SMDwgMfgProfileMarginSymContent) (on
page 1370)

Mfg Scantling Mfg Scantling Points Along 2D Curve


Margin_Value Margin_Value.sym (ISDwgPointsAlongCurve2D) (on page
1433)
MfgMarginValue.rtp
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Manufacturing Margin Symbol
(ISMfgMarginSymbolContent) (on page
1369)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Drawings and Reports Reference Data Guide 869


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Mfg port.sym Points Along 2D Curve


TemplatesetFullScale starboard.sym (ISDwgPointsAlongCurve2D) (on page
Direction Right aft.sym 1433)
forward.sym No Grouping or Filtering (Default)
up.sym (DefaultLabelGeometricAnalyzer) (on page
down.sym 1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Template Set Full Scale Direction Symbol
(SMTemplatesetFullScaleDirSymbolConte
nt) (on page 1475)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Drawings and Reports Reference Data Guide 870


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Reference_Circle_CA Reference_Circle_CA_L.sy Key Point (DefaultLabelPointGenerator)


_L m (on page 1338)
ItemTag.rtp No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
DrawingReferenceLabelContent
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)
Default (DwgLeaderControl) (on page
1271)

Ruleset_Name Ruleset_Name.sym Default Marine Point


(ISRulesetPointGenerator) (on page 1276)
Ruleset_Name.rtp
Default Marine Label Text
(ISRulesetLabelAnalyzer) (on page 1276)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default Marine Label
(ISRulesetLabelContent) (on page 1275)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on

Drawings and Reports Reference Data Guide 871


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
page 1130)
Default (DwgLeaderControl) (on page
1271)

Label Templates: Scantling


The following label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder:

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Scantling Connection Scantling Connection Points Along 2D Curve


Intersection Symbol Intersection Symbol.sym (ISDwgPointsAlongCurve2D) (on page
1433)
Eliminate Overlapping Labels
(ISGAEliminateOverlappingLabels) (on
page 1289)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Drawings and Reports Reference Data Guide 872


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Scantling Connection Scantling Connection Points Along 2D Curve


Penetration Symbol Penetration Symbol.sym (ISDwgPointsAlongCurve2D) (on page
1433)
Eliminate Overlapping Labels
(ISGAEliminateOverlappingLabels) (on
page 1289)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Scantling Knuckle Scantling_Knuckle_Line_La Points Along 2D Curve


Line Label_CP_L bel_CP_L.sym: (ISDwgPointsAlongCurve2D) (on page
1433)
Default (DefaultLabelControlGenerator) (on
Scantling_Knuckle_Line_La page 1265)
bel_CP_L.rtp
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)
Default (DwgLeaderControl) (on page
1271)

Drawings and Reports Reference Data Guide 873


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Scantling Knuckle Scantling_Knuckle_Point_L Points Along 2D Curve


Line Label_CA_L abel_CA_L.sym: (ISDwgPointsAlongCurve2D) (on page
1433)
Default (DefaultLabelControlGenerator) (on
Scantling_Knuckle_Point_L page 1265)
abel_CA_L.rtp
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)
Default (DwgLeaderControl) (on page
1271)

Scantling Knuckle Scantling Knuckle Line Points Along 2D Curve


Line Symbol Symbol.sym (ISDwgPointsAlongCurve2D) (on page
1433)
Structure_Name.rtp
Default (DefaultLabelControlGenerator) (on
page 1265)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Drawings and Reports Reference Data Guide 874


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Scantling Knuckle Scantling Knuckle Point Points Along 2D Curve


Point Symbol Symbol.sym (ISDwgPointsAlongCurve2D) (on page
1433)
Generic_Error.sym
Default (DefaultLabelControlGenerator) (on
Structure_Name.rtp
page 1265)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Knuckle Point Symbol
(ISKnucklePointSymbolContent) (on page
1848)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Scantling Knuckle Scantling Knuckle Plate Points Along 2D Curve


Sloping Direction Sloping Symbol.sym: (ISDwgPointsAlongCurve2D) (on page
Symbol 1433)
Default (DefaultLabelControlGenerator) (on
page 1265)
Scantling Knuckle Plate No Grouping or Filtering (Default)
Sloping Bothsides (DefaultLabelGeometricAnalyzer) (on page
Symbol.sym: 1398)
Knuckle Sloping Direction Symbol
(ISKnuckleSlopingDirectionSymbolContent
) (on page 1849)
Generic_Error.sym Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Drawings and Reports Reference Data Guide 875


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Scantling Knuckle Scantling Knuckle Surface Points Along 2D Curve


Surface Angle Angle.sym (ISDwgPointsAlongCurve2D) (on page
1433)
Scantling Knuckle Surface
Angle.rtp Default Marine Label Text
(ISRulesetLabelAnalyzer) (on page 1276)
Default (DefaultLabelControlGenerator) (on
page 1265)
Knuckle Angle Symbol
(ISKnuckleAngleSymbolContent) (on page
1338)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Scantling Non-Target Scantling Design Seam Points by 2D Shape Type


Seam Symbol Symbol.sym (SMDwgPointsByType) (on page 1438)
Scantling Block Seam Default (DefaultLabelControlGenerator) (on
Symbol.sym page 1265)
Scantling Unknown Seam No Grouping or Filtering (Default)
Symbol.sym (DefaultLabelGeometricAnalyzer) (on page
1398)
Generic_Error.sym
Seam Symbol (ISSeamSymbolContent)
(on page 1856)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Scantling Plate Scantling Plate Mounting Points Along 2D Curve


Mounting Angle Angle.sym (ISDwgPointsAlongCurve2D) (on page
1433)
Scantling Plate Mounting
Angle.rtp Default Marine Label Text
(ISRulesetLabelAnalyzer) (on page 1276)
Default (DefaultLabelControlGenerator) (on
page 1265)
Plate Angle Symbol
(ISPlateAngleSymbolContent) (on page
1427)
Clear Space Position by 2D Curve

Drawings and Reports Reference Data Guide 876


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Scantling Plate Scantlings\ISO Plate Points Along 2D Curve


Thickness Symbol Thickness Direction Up.sym (ISDwgPointsAlongCurve2D) (on page
1433)
Scantlings\ISO Plate
Thickness Direction Eliminate Overlapping Labels
Down.sym (ISGAEliminateOverlappingLabels) (on
page 1289)
Scantlings\ISO Plate
Thickness Direction Default (DefaultLabelControlGenerator) (on
Centered.sym page 1265)
Scantlings\ISO Plate Plate Thickness Symbol
Thickness Direction (ISPlateThicknessSymbolContent) (on
Unknown.sym page 1851)
Generic_Error.sym Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Scantling Profile Scantling Profile Mounting Points Along 2D Curve


Mounting Angle Angle.sym (ISDwgPointsAlongCurve2D) (on page
1433)
Scantling Profile Mounting
Angle.rtp Default Marine Label Text
(ISRulesetLabelAnalyzer) (on page 1276)
Default (DefaultLabelControlGenerator) (on
page 1265)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Drawings and Reports Reference Data Guide 877


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Scantling Profile Scantling Block Seam Points Along 2D Curve


Seam Symbol Symbol.sym (ISDwgPointsAlongCurve2D) (on page
1433)
Scantling Unknown Seam
Symbol.sym No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
Scantling Unknown Seam
1398)
Symbol.sym
Default (DefaultLabelControlGenerator) (on
page 1265)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)
Profile Seam Symbol
(SMProfileSeamSymbolContent) (on page
1870)

Scantling Profile Multiple ISO Profile Points Along 2D Curve


Thickness Symbol [cross-section type] (ISDwgPointsAlongCurve2D) (on page
Thickness [flange 1433)
direction].sym files within
Default (DefaultLabelControlGenerator) (on
the Scantlings folder
page 1265)
Generic_Error.sym
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
ISProfilePartThicknessSymbolContent (on
page 1853)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Drawings and Reports Reference Data Guide 878


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Scantling Shell Profile Scantling Profile Profile Weld Points


Weld Label (on page Weld_IButt.sym (SMDwgProfileWeldsPG) (on page 1448)
938)
Scantling Profile No Grouping or Filtering (Default)
Weld_VButt.sym (DefaultLabelGeometricAnalyzer) (on page
1398)
Scantling Profile
Weld_XButt.sym Default (DefaultLabelControlGenerator) (on
page 1265)
Scantling Profile
Weld_YButt.sym Scantling Weld Symbol
(DwgScantlingWeld) (on page 1842)
Scantling Profile
Weld_IVButt.sym Absolute XY Offset (DrawingAbsolute) (on
page 1130)
Scantling Profile
Weld_IXButt.sym
Scantling Profile
Weld_XButtSM.sym
Demarcation.sym

Scantling Target Scantling Design Seam Default (DefaultLabelControlGenerator) (on


Seam Symbol Symbol.sym page 1265)
Scantling Block Seam No Grouping or Filtering (Default)
Symbol.sym (DefaultLabelGeometricAnalyzer) (on page
1398)
Scantling Unknown Seam
Symbol.sym Points by 2D Shape Type
(SMDwgPointsByType) (on page 1438)
Generic_Error.sym
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)
Seam Symbol (ISSeamSymbolContent)
(on page 1856)

Drawings and Reports Reference Data Guide 879


Labels

Label Templates: Ship Structure Plate


The following label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder:

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

ShipParentBlockAnd ShipParentBlockAndPartNa Points for View (ISDwgPointsForView) (on


PartName me.sym page 1440)
ViewName.rtp No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
ShipName.rtp
1398)
ParentBlockName.rtp
Default (DefaultLabelControlGenerator) (on
PartName.rtp page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Ship Structure Plate Ship Structure Plate Default (DefaultLabelControlGenerator) (on


GridPlane_Name GridPlane_Name.sym page 1265)
Ship Structure Plate No Grouping or Filtering (Default)
GridPlane_Name.rtp (DefaultLabelGeometricAnalyzer) (on page
1398)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)
Points Along 2D Curve
(ISDwgPointsAlongCurve2D) (on page
1433)
Plate Grid Name Label
(SMDwgPlateGridNameLabelContent) (on
page 1428)

Drawings and Reports Reference Data Guide 880


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Ship Structure Plate Ship Structure Plate Inside or Along 2D Curve


Material Type Grade Material Type Grade (InsideOrAlongCurve2D) (on page 1321)
Thickness by COM Thickness by COM.sym
No Grouping or Filtering (Default)
Ship Structure Plate (DefaultLabelGeometricAnalyzer) (on page
Material Type Grade 1398)
Thickness by COM.rtp
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Ship Structure Plate Ship Structure Plate Inside or Along 2D Curve


Material Type Grade Material Type Grade (InsideOrAlongCurve2D) (on page 1321)
Thickness Thickness.sym
No Grouping or Filtering (Default)
Ship Structure Plate (DefaultLabelGeometricAnalyzer) (on page
Material Type Grade 1398)
Thickness.rtp
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Ship Structure Plate Ship Structure Plate Inside or Along 2D Curve


Thickness Grade by Thickness Grade by (InsideOrAlongCurve2D) (on page 1321)
COM COM.sym
No Grouping or Filtering (Default)
Ship Structure Plate (DefaultLabelGeometricAnalyzer) (on page
Thickness Grade by 1398)
COM.rtp
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page

Drawings and Reports Reference Data Guide 881


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Ship Structure Plate Ship Structure Plate Inside or Along 2D Curve


Thickness Grade Thickness Grade.sym (InsideOrAlongCurve2D) (on page 1321)
Ship Structure Plate No Grouping or Filtering (Default)
Thickness Grade.rtp (DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Ship Structure Plate Ship Structure Plate Points Along 2D Curve


Thickness Material Thickness Material Grade (ISDwgPointsAlongCurve2D) (on page
Grade Typical Typical.sym 1433)
Ship Structure Plate Eliminate Most Common Labels
Thickness Material Grade (ISGAEliminateMostCommonLabels) (on
by COM.rtp page 1287)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)

Drawings and Reports Reference Data Guide 882


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Label Templates: Ship Structure Profile


The following label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder:

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Ship Structure Profile Ship Structure Profile Points Along 2D Curve


Cross-section by Cross-section by COM.sym (ISDwgPointsAlongCurve2D) (on page
COM 1433)
Ship Structure Profile
Cross-section by COM.rtp No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Drawings and Reports Reference Data Guide 883


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Ship Structure Profile Ship Structure Profile Points Along 2D Curve


Cross-section Cross-section Material (ISDwgPointsAlongCurve2D) (on page
Material Type Grade Type Grade by COM.sym 1433)
by COM
Ship Structure Profile No Grouping or Filtering (Default)
Cross-section Material (DefaultLabelGeometricAnalyzer) (on page
Type Grade by COM.rtp 1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Ship Structure Profile Ship Structure Profile Points Along 2D Curve


Cross-section Cross-section Material (ISDwgPointsAlongCurve2D) (on page
Material Type Grade Type Grade.sym 1433)
Ship Structure Profile No Grouping or Filtering (Default)
Cross-section Material (DefaultLabelGeometricAnalyzer) (on page
Type Grade.rtp 1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Ship Structure Profile Ship Structure Profile Points Along 2D Curve


Cross-section Cross-section.sym (ISDwgPointsAlongCurve2D) (on page
1433)
Ship Structure Profile
Cross-section.rtp No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on

Drawings and Reports Reference Data Guide 884


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Ship Structure Profile Ship Structure Profile Name Points Along 2D Curve
Name Cross-section Cross-section Material (ISDwgPointsAlongCurve2D) (on page
Material Type Type Grade_L.sym 1433)
Grade_L
Ship Structure Profile Name No Grouping or Filtering (Default)
Cross-section Material (DefaultLabelGeometricAnalyzer) (on page
Type Grade_L.rtp 1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)
Default (DwgLeaderControl) (on page
1271)

Ship Structure Profile Ship Structure Profile Points Along 2D Curve


Typical Cross-section Cross-section by COM.rtp (ISDwgPointsAlongCurve2D) (on page
1433)
Eliminate Most Common Labels
(ISGAEliminateMostCommonLabels) (on
page 1287)
Default (DefaultLabelControlGenerator) (on

Drawings and Reports Reference Data Guide 885


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
page 1265)
No Label Content (DrawingNoContent) (on
page 1399)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Label Templates: StrMfg - W


The following label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder:

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

StrMfg PinJig Seam StrMfg PinJig Seam Point Points by Associated Object ID
Point Symbol Symbol.sym (SMPointsByAssociateObjectID) (on page
1439)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Drawings and Reports Reference Data Guide 886


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

StrMfg ProfileSketch StrMfg ProfileSketch Bevel Points Along 2D Curve


Bevel Symbol Symbol.sym (ISDwgPointsAlongCurve2D) (on page
1433)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Profile Sketch Bevel Symbol
(SMProfileSketchBevelSymbolCM) (on
page 1446)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

StrMfg ProfileSketch StrMfg ProfileSketch Bevel Point for Profile Sketch Bevel Shape
Bevel Shape 1mm Shape 1mm.sym (SMProfileSketchBevelShapeLabelsPG)
(on page 1431)
Default Marine Label Text
(ISRulesetLabelAnalyzer) (on page 1276)
Default (DefaultLabelControlGenerator) (on
page 1265)
SMProfileSketchBevelShapeLabelsCM
(see "Profile Sketch Bevel Shape Label
(SMProfileSketchBevelShapeLabelsCM)"
on page 1445)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

StrMfg ProfileSketch StrMfg ProfileSketch Bevel Point for Profile Sketch Bevel Shape
Bevel Shape 2mm Shape 2mm.sym (SMProfileSketchBevelShapeLabelsPG)
(on page 1431)
Default Marine Label Text
(ISRulesetLabelAnalyzer) (on page 1276)
Default (DefaultLabelControlGenerator) (on
page 1265)
SMProfileSketchBevelShapeLabelsCM
(see "Profile Sketch Bevel Shape Label
(SMProfileSketchBevelShapeLabelsCM)"
on page 1445)
Absolute XY Offset (DrawingAbsolute) (on

Drawings and Reports Reference Data Guide 887


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
page 1130)

StrMfg ProfileSketch StrMfg ProfileSketch Detail Absolute Points (ISAbsolutePointLabelPG)


Detail Name Name.sym (on page 1120)
Default Marine Label Text
(ISRulesetLabelAnalyzer) (on page 1276)
Default (DefaultLabelControlGenerator) (on
page 1265)
SMDwgProfileSketchDetailNameLabelCont
ent
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

StrMfg ProfileSketch StrMfg ProfileSketch Detail Absolute Points (ISAbsolutePointLabelPG)


Detail Name_V Name_V.sym (on page 1120)
Default Marine Label Text
(ISRulesetLabelAnalyzer) (on page 1276)
Default (DefaultLabelControlGenerator) (on
page 1265)
SMDwgProfileSketchDetailNameLabelCont
ent

StrMfg ProfileSketch StrMfg ProfileSketch Detail Absolute Points (ISAbsolutePointLabelPG)


Detail Name_Voffset Name_Voffset.sym (on page 1120)
ProfileSketchDetailNameContent

StrMfg ProfileSketch StrMfg ProfileSketch Absolute Points (ISAbsolutePointLabelPG)


Feature Name Feature Name.sym (on page 1120)
Default Marine Label Text
(ISRulesetLabelAnalyzer) (on page 1276)
Default (DefaultLabelControlGenerator) (on
page 1265)
SMDwgProfileSketchDetailNameLabelCont
ent

Drawings and Reports Reference Data Guide 888


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

StrMfg ProfileSketch StrMfg ProfileSketch Absolute Points (ISAbsolutePointLabelPG)


Knuckle Label Knuckle Label.sym (on page 1120)
Default Marine Label Text
(ISRulesetLabelAnalyzer) (on page 1276)
Default (DefaultLabelControlGenerator) (on
page 1265)
SMDwgProfileSketchKnuckleLabelContent
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

StrMfg ProfileSketch None Profile Sketch Label


Labels (SMDwgProfileSketchLabelsContent) (on
page 1447)

StrMfg ProfileSketch StrMfg ProfileSketch Plate SMDwgMfgProfilePlateLocSymContent


Plate Location Location Symbol
ProfileSketchDetailNameContent
Symbol Centered.sym
StrMfg ProfileSketch Plate
Location Symbol Centered
Hidden.sym
StrMfg ProfileSketch Plate
Location Symbol.sym
StrMfg ProfileSketch Plate
Location Symbol
Hidden.sym

StrMfg ProfileSketch StrMfg ProfileSketch Seam Absolute Points (ISAbsolutePointLabelPG)


Seam Label Label.sym (on page 1120)
Default Marine Label Text
(ISRulesetLabelAnalyzer) (on page 1276)
Default (DefaultLabelControlGenerator) (on
page 1265)
SMDwgProfileSketchDetailNameLabelCont
ent

StrMfg ProfileSketch StrMfg ProfleSketch Points Along 2D Curve


WebThickness WebThickness_Up.sym (ISDwgPointsAlongCurve2D) (on page
1433)
StrMfg ProfileSketch
WebThickness_Down.sym Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Drawings and Reports Reference Data Guide 889


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
SMPSWebThicknessContent (see "Profile
Sketch Web Thickness Symbol
(SMPSWebThicknessContent)" on page
1881)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

StrMfg Sketch Bevel StrMfg Sketch Bevel Points at Manufacturing Sketch


Symbol Symbol.sym Coordinates (MfgSketchPG) (on page
1437)
StrMfg Sketch Bevel
Symbol_Angle Label.sym No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
StrMfg Sketch Bevel
1398)
Symbol_Depth Label.sym
Default (DefaultLabelControlGenerator) (on
page 1265)
Manufacturing Sketch (MfgSketchContent)
(on page 1371)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)

StrMfg Sketch Points at Manufacturing Sketch


Feature Label Coordinates (MfgSketchPG) (on page
1437)
MfgSketchNameFeaturesGA (on page
1389)
Default (DefaultLabelControlGenerator) (on
page 1265)
Manufacturing Sketch (MfgSketchContent)
(on page 1371)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Drawings and Reports Reference Data Guide 890


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

StrMfg Sketch Points at Manufacturing Sketch


Feature Symbol Coordinates (MfgSketchPG) (on page
1437)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

StrMfg Templateset StrMfg Templateset SMPointsByAssociateObjectID


MidLine Symbol MidLine Symbol.sym
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

StrMfg Templateset StrMfgTemplateset Seam Points by Associated Object ID


Seam Point Symbol Point Symbol.sym (SMPointsByAssociateObjectID) (on page
1439)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Drawings and Reports Reference Data Guide 891


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

StrMfg Templateset StrMfg Templateset Points by Associated Object ID


Tangent Point Tangent Point Symbol.sym (SMPointsByAssociateObjectID) (on page
Symbol 1439)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Structure_Name Structure_Name.sym MidPoint (ISMidPointLabelPG) (on page


1389)
Structure_Name.rtp
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)
Default (DwgLeaderControl) (on page
1271)

Structure_Weld (on Structure_Weld.rtp No Grouping or Filtering (Default)


page 942) (DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on

Drawings and Reports Reference Data Guide 892


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
page 1265)
Weld (DrawingWeldSymbols) (on page
1492)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)
DrawingWeldLeader

WeldLabel (on page Structure_Weld_IButt.sym Weld Point (DrawingPGWelds) (on page


949) 1494)
Structure_Weld_YButt.sym
Weld Label Text (DrawingGAWelds) (on
Structure_Weld_XButt.sym
page 1493)
Structure_Weld_VButt.sym
Default (DefaultLabelControlGenerator) (on
Structure_Weld_Tee1.sym page 1265)
Structure_Weld_Tee2.sym Scantling Weld Symbol
(DwgScantlingWeld) (on page 1842)
Structure_Weld_Tee3sym
Absolute XY Offset (DrawingAbsolute) (on
Structure_Weld_Tee4.sym
page 1130)
Structure_Weld_Tee5.sym
Structure_Weld_Tee6sym
Structure_Weld_Tee7.sym
Demarcation.sym

Drawings and Reports Reference Data Guide 893


Labels

North Arrow Templates


The following label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\NorthArrows folder:

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

MfgProfile Direction MfgProfile Direction.rtp Points for View (ISDwgPointsForView) (on


page 1440)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Mfg Profile Up MfgProfile Up Direction.sym Points for View (ISDwgPointsForView) (on


Direction MfgProfile Up Direction.rtp page 1440)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

MfgTemplateset aft.sym Points for View (ISDwgPointsForView) (on


FullScaleDirection page 1440)
down.sym
Right
No Grouping or Filtering (Default)
forward.sym
(DefaultLabelGeometricAnalyzer) (on page
port.sym 1398)
starboard.sym Default (DefaultLabelControlGenerator) (on
page 1265)
up.sym
Template Set Full Scale Direction Symbol
(SMTemplatesetFullScaleDirSymbolConte
nt) (on page 1475)
Clear Space Quadrant 1

Drawings and Reports Reference Data Guide 894


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

ShipDirection Down aft.sym Points for View (ISDwgPointsForView) (on


page 1440)
down.sym
No Grouping or Filtering (Default)
forward.sym
(DefaultLabelGeometricAnalyzer) (on page
port.sym 1398)
starboard.sym Default (DefaultLabelControlGenerator) (on
page 1265)
up.sym
ISShipDirectionSymbolContent (see "Ship
Direction Symbol
(ISShipDirectionSymbolContent)" on page
1463)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

ShipDirection Left aft.sym Points for View (ISDwgPointsForView) (on


page 1440)
down.sym
No Grouping or Filtering (Default)
forward.sym
(DefaultLabelGeometricAnalyzer) (on page
port.sym 1398)
starboard.sym Default (DefaultLabelControlGenerator) (on
page 1265)
up.sym
ISShipDirectionSymbolContent (see "Ship

Drawings and Reports Reference Data Guide 895


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
Direction Symbol
(ISShipDirectionSymbolContent)" on page
1463)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

ShipDirection Right aft.sym Points for View (ISDwgPointsForView) (on


page 1440)
down.sym
No Grouping or Filtering (Default)
forward.sym
(DefaultLabelGeometricAnalyzer) (on page
port.sym 1398)
starboard.sym Default (DefaultLabelControlGenerator) (on
page 1265)
up.sym
ISShipDirectionSymbolContent (see "Ship
Direction Symbol
(ISShipDirectionSymbolContent)" on page
1463)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Drawings and Reports Reference Data Guide 896


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

ShipDirection Up aft.sym Points for View (ISDwgPointsForView) (on


page 1440)
down.sym
No Grouping or Filtering (Default)
forward.sym
(DefaultLabelGeometricAnalyzer) (on page
port.sym 1398)
starboard.sym Default (DefaultLabelControlGenerator) (on
page 1265)
up.sym
ISShipDirectionSymbolContent (see "Ship
Direction Symbol
(ISShipDirectionSymbolContent)" on page
1463)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

View Templates
The following label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\Views folder:

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

ShipParentBlock ShipParentBlock Points for View (ISDwgPointsForView) (on


AndPartName AndPartName.sym page 1440)
ViewName.rtp No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
ShipName.rtp
1398)
ParentBlockName.rtp
Default (DefaultLabelControlGenerator) (on
PartName.rtp page 1265)
Default (DrawingLabelHelper) (on page
1268)

Drawings and Reports Reference Data Guide 897


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)

Steel Order Templates


The following label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\Scantlings\Steel Order folder:

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

ISO Thickness Multiple ISO Profile Points Along 2D Curve


Symbol [cross-section type] (ISDwgPointsAlongCurve2D) (on page
Thickness [flange 1433)
direction].sym files within
Eliminate Overlapping Labels
the Scantlings folder
(ISGAEliminateOverlappingLabels) (on
Generic_Error.sym page 1289)
Default (DefaultLabelControlGenerator) (on
page 1265)
Thickness Direction Symbol
(ThicknessSymContent) (on page 1879)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Drawings and Reports Reference Data Guide 898


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Opening Opening.sym Key Point (DefaultLabelPointGenerator)


(on page 1338)
Opening.rtp
Eliminate Most Common Labels
OpeningEquivalenceLabel.f
(ISGAEliminateMostCommonLabels) (on
tp
page 1287)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Center Then Rotate
(DrawingCenterThenRotate) (on page
1164)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)
Default (DwgLeaderControl) (on page
1271)

Plate Stiffeners Plate Stiffeners Key Point (DefaultLabelPointGenerator)


Summary (see "Plate Summary.sym (on page 1338)
Stiffeners Summary
Plate Stiffeners No Grouping or Filtering (Default)
Label Template" on
Summary.rtp (DefaultLabelGeometricAnalyzer) (on page
page 903)
1398)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4

Drawings and Reports Reference Data Guide 899


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)
Default (DwgLeaderControl) (on page
1271)
DwgPartNameQI

Profile Short Name Profile Short Name.sym Points Along 2D Curve


(ISDwgPointsAlongCurve2D) (on page
Profile Short Name.rtp
1433)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)

Profile System Short Profile System Short Points Along 2D Curve


Name Name.sym (ISDwgPointsAlongCurve2D) (on page
1433)
Profile System Short
Name.rtp Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)
No Grouping or Filtering (Default)
(DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)

Drawings and Reports Reference Data Guide 900


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Scantling NS or FS aft.sym Points Along 2D Curve


Direction (ISDwgPointsAlongCurve2D) (on page
fore.sym
1433)
starboard.sym
Eliminate Overlapping Labels
port.sym (ISGAEliminateOverlappingLabels) (on
page 1289)
up.sym
Default (DefaultLabelControlGenerator) (on
down.sym
page 1265)
Scantling Near Side or Far Side Direction
Symbol
(SMDwgScantlingNSorFSDirectionContent
) (on page 1461)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Scantling NS or FS NearSide.sym Points Along 2D Curve


Symbol (ISDwgPointsAlongCurve2D) (on page
FarSide.sym
1433)
Eliminate Overlapping Labels
(ISGAEliminateOverlappingLabels) (on
page 1289)
Default (DefaultLabelControlGenerator) (on
page 1265)
Scantling Near Side or Far Side Symbol
(SMDwgScantlingNSorFSContent) (on
page 1869)
Clear Space Position by 2D Curve
(ISDwgPositionByCurve2D) (on page
1203)
Absolute Position by 2D Curve
(ISDwgAbsolutePositionByCurve2D) (on
page 1120)

Drawings and Reports Reference Data Guide 901


Labels

Label Template Symbols (.sym) Annotation Modules


(.xml) and/or used
Report Templates (.rtp)
used

Sibling Plates Sibling Plates Stiffeners Key Point (DefaultLabelPointGenerator)


Stiffeners Summary Summary.sym (on page 1338)
Label Template (on
Sibling Plates Stiffeners No Grouping or Filtering (Default)
page 903)
Summary.rtp (DefaultLabelGeometricAnalyzer) (on page
1398)
Default (DefaultLabelControlGenerator) (on
page 1265)
Default (DrawingLabelHelper) (on page
1268)
Clear Space Quadrant 1
(DrawingQuadOne) (on page 1224)
Clear Space Quadrant 2
(DrawingQuadTwo) (on page 1229)
Clear Space Quadrant 3
(DrawingQuadThree) (on page 1234)
Clear Space Quadrant 4
(DrawingQuadFour) (on page 1240)
Absolute XY Offset (DrawingAbsolute) (on
page 1130)
Default (DwgLeaderControl) (on page
1271)
DwgPartNameQI

Drawings and Reports Reference Data Guide 902


Labels

Plate Stiffeners Summary Label Template


Plate Stiffeners Summary.xml is delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\Scantlings\Steel Order folder. It is
typically used when the ViewNameDirectionScale View Label Template (on page 921) is also
used.
Generates a label for any profile exceptions that do not match the typical. Any profile parts that
are related to the selected plate system and differ from the typical profile view label will be
included in the label for that plate system. The position index number is used for the profile
name in order to save space. For example, if profile parts 8, 9, and 10 have different attributes
from the typical profile, the label includes these profile parts and lists the attribute that sets them
apart from the typical. In this example, profile parts 9, 11, and 18 have differing section sizes.
Because 9 and 11 are the same, they are grouped together with a comma. Profile part 18 is
listed below 9 and 11 because it also has a differing section size from the typical and from
profile parts 9 and 11. Values in a range are separated by a dash, while multiple values not in a
range are separated with a comma. For example, 9-11, 13-16.

The stiffener summary is compiled by a report called in the label template XML:
<content>
<contentModule value="DrawingLabelHelper" />
<ID attributeName="Plate Stiffeners Summary">Plate Stiffeners
Summary.rtp</ID>
</content>
The Plate Stiffeners Summary.rtp report then calls Plate Stiffeners Summary.rqe. This file uses
the DwgPartNameQI content module to create the summary of non-typical plate stiffener parts.
For a list of all annotation modules used by Plate Stiffener Summary.xml, see Steel Order
Templates (on page 898).

 If the selected plate does not contain any related profile parts, the label displays as a
question mark (?). A question mark also displays if you do not select a plate system when
placing the label.
 Planar plates are the only supported plate types for this label.

Sibling Plates Stiffeners Summary Label Template


Sibling Plates Stiffeners Summary.xml is delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\Scantlings\Steel Order folder. It is
typically used when the ViewNameDirectionScale View Label Template (on page 921) is also
used.
Generates a label for any profile exceptions that do not match the typical. Any profile parts that
are related to the selected plate system and differ from the typical profile view label will be
included in the label for that plate system and all sibling plate systems that have the same

Drawings and Reports Reference Data Guide 903


Labels

orientation in that block. The position index number is used for the profile name in order to save
space. For example, if profile parts 9, 10 and 11 have different attributes from the typical profile,
the label includes these profile parts and lists the attribute that sets them apart from the typical.
In this example, profile parts 9, 11, and 18 have differing section sizes. Because 9 and 11 are
the same, they are grouped together with a comma. Profile part 18 is listed below 9 and 11
because it also has a differing section size from the typical and from profile parts 9 and 11.
Values in a range are separated by a dash, while multiple values not in a range are separated
with a comma. For example, 9-11, 13-16.

The stiffener summary is compiled by a report called in the label template XML:
<content>
<contentModule value="DrawingLabelHelper" />
<ID attributeName="Sibling Plates Stiffeners Summary">Sibling
Plates Stiffeners Summary.rtp</ID>
</content>
The Sibling Plates Stiffeners Summary.rtp report then calls Sibling Plates Stiffeners
Summary.rqe. This file uses the DwgPartNameQI content module to create the summary of
non-typical plate stiffener parts.
For a list of all annotation modules used by Plates Stiffeners Summary.xml, see Steel Order
Templates (on page 898).

 If the selected plate does not contain any related profile parts, the label displays as a
question mark (?). A question mark also displays if you do not select a plate system when
placing the label.
 Planar plates are the only supported plate types for this label.
 If a sibling plate part is non-planar, it is skipped.

Drawings and Reports Reference Data Guide 904


Labels

Label Rules in Offshore Drawings


SM_ElectricalCableTray_Elevation_GridPlane_Name.xml
SM_ElectricalCableTray_Plan_GridLineX_Name.xml
SM_ElectricalCableTray_Plan_GridLineY_Name.xml
SM_ElectricalCableTray_Plan_LineNumberBOT_LongestSegment.xml
SM_ElectricalCableTray_Plan_Tray_BOT_Elev.xml
SM_ElectricalCableTray_Section_LineNumber_LongestSegment.xml
SM_Equipment_Elevation_Equipment_Name.xml
SM_Equipment_Elevation_GridLineX_Name.xml
SM_Equipment_Elevation_GridPlane_Name.xml
SM_Equipment_Plan_Equipment_Name.xml
SM_Equipment_Plan_GridLineX_Name.xml
SM_Equipment_Plan_GridLineY_Name.xml
SM_Equipment_Section_Equipment_Name.xml
SM_Equipment_Section_GridPlane_Name.xml
SM_HVAC_Elevation_GridLineX_Name.xml
SM_HVAC_Elevation_GridPlane_Name.xml
SM_HVAC_Elevation_Run_Name.xml
SM_HVAC_LinearDuct_CrossSectionSize.xml
SM_HVAC_Plan_GridLineX_Name.xml
SM_HVAC_Plan_GridLineY_Name.xml
SM_HVAC_Plan_Run_Name.xml
SM_HVAC_Section_GridLineX_Name.xml
SM_HVAC_Section_GridPlane_Name.xml
SM_HVAC_Section_Run_Name.xml
SM_Lighting_Plan_GridLineX_Name.xml
SM_Lighting_Plan_GridLineY_Name.xml
SM_Lighting_Plan_Light_Desccription_Ver.xml
SM_Lighting_Plan_Light_Description.xml
SM_Lighting_Plan_Light_Name.xml
SM_Lighting_Plan_Light_Name_Vert.xml
SM_Name_Elevation_None_M_JL.xml
SM_Piping_Elevation_GridPlane_Name.xml
SM_Piping_Elevation_Pipes_BOP Elev.xml

Drawings and Reports Reference Data Guide 905


Labels

SM_Piping_Elevation_PipingParts_RunName_LongestSegment.xml
SM_Piping_Elevation_PipingParts_RunNameBOP_LongestSegment.xml
SM_Piping_Plan_GridLineX_Name.xml
SM_Piping_Plan_GridLineY_Name.xml
SM_Piping_Plan_Pipes_BOP Elev.xml
SM_Piping_Plan_PipingParts_RunName_LongestSegment.xml
SM_Piping_Plan_PipingParts_RunNameBOP_LongestSegment.xml
SM_Piping_Section_Pipes_BOP Elev.xml
SM_Piping_Section_PipingParts_RunName_LongestSegment.xml
SM_Piping_Section_PipingParts_RunNameBOP_LongestSegment.xml
See Also
Drawings by Rule Labels, Symbols, and Dimensions (on page 910)

Symbols in Orthographic Drawings


You can use symbols as part of the view style for your orthographic drawings. The symbols can
appear as part of the drawing view, replacing graphic objects to simplify drawing output. You
can also place symbols on a drawing as a label in paper space.
Using Tools > Define View Style, you define symbols through the properties on the view style.
When defined as part of a graphic rule in the view style, the symbol takes the place of an object
included in the drawing view. Depending on how you created the symbol, the symbol can scale
to match the drawing view contents. For more information, see Graphic Rule - Symbol Dialog
Box (on page 82).
If you are using a label to place a symbol in the paper space of the drawing, the symbol will not
scale. For more information, see Labels (on page 740).
You create symbols in SmartSketch Drawing Editor. For more information, see Create a Custom
Symbol for Drawings (on page 906).
See Also
Create a Custom Symbol for Drawings (on page 906)

Create a Custom Symbol for Drawings


The software provides sample symbols to use in your drawings. Some of these symbols resize
based on the size of the object they are replacing. You can create your own symbols or modify
copies of existing ones to suit your needs. It is not necessary to have administrator privileges on
the computer on which you perform this procedure. However, it is necessary to have at least
write permissions to the SharedContent share on the server computer.
1. Open SmartSketch Drawing Editor by browsing to the [Product
Folder]\Common2D\Shape2D\Bin folder and double-clicking shape2dserver.exe.
2. Draw your symbol using the various commands and tools in the software.

3. Use the Select Tool to draw a fence around the symbol graphics.
4. Click Create Symbol .

Drawings and Reports Reference Data Guide 906


Labels

If the Create Symbol icon is not visible, click Tools > Customize, and drag the
Create Symbol icon (from the Catalogs category) into the application window.
5. Click to define the origin of the new symbol.
6. On the Save As Symbol dialog box, browse to the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Symbols folder under the SharedContent share,
name the symbol, and save it.
7. Exit SmartSketch Drawing Editor without saving the document.
You can incorporate your custom symbol into a graphic rule for a view style for use in
any orthographic drawings. For more information, see Graphic Rule - Symbol Dialog Box (on
page 82).
See Also
View Style Rules (on page 57)
Create an Orthographic Drawing View Style (on page 87)
Symbols in Orthographic Drawings (on page 906)

Create a Custom Cutting Plane Symbol


The following procedure steps you through the workflow for creating a new cutting plane symbol
and editing the properties of its behavior. The software provides sample symbols to use in your
drawings. It is not necessary to have administrator privileges on the computer on which you
perform this procedure. However, it is necessary to have at least write permissions to the
SharedContent share on the server computer. For more information on using SmartSketch
Drawing Editor, see Working with SmartSketch Drawing Editor in any of the Smart 3D Drawings
user's guides.

Working in the Labels Folder


In the SharedContent folder of your database, locate the cutting plane reference symbols. The
default location for these files is [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\Views. There are 14 files delivered
in this folder, making up the complete cutting plane symbol: two RFM files, two RQE files, two
RTP files, four SYM files, and four XML documents.

Copy Existing Cutting Plane Arrow Symbols


1. Select the four Scantling_SectionArrow1 and Scantling_SectionArrow2 files (.xml and
.sym), and copy them within the same folder.
2. Rename each set of files. For example, rename the Scantling_SectionArrow1 files to
Type3_Arrow1, and rename the Scantling_SectionArrow2 files to Type3_Arrow2.
3. Each individual file needs to be modified using the new naming convention.
Before proceeding, consider downloading a third-party XML document editor to
make it easier to read and modify the .xml files.
4. Open the .sym Arrow files and make any necessary adjustments to the arrow symbols with
the SmartSketch Drawing Editor. For more information on using SmartSketch Drawing
Editor, see Working with SmartSketch Drawing Editor in any of the Smart 3D Drawings
user's guides.
5. Save the files, and exit SmartSketch Drawing Editor.

Drawings and Reports Reference Data Guide 907


Labels

6. Open the first .xml file (either with Notepad or a third-party XML editor), and change any
occurrences of Scantling_SectionArrow1 to Type3_Arrow1.
Be sure to preserve any file name extensions.
7. Repeat the above step for the second arrow .xml file. For example, in the
Scantling_SectionArrow2 file, make sure that all occurrences of
Scantling_SectionArrow2 are changed to Type3_Arrow2.
8. Save the files, and exit the XML editor.

Copy Existing Cutting Plane Reference Files


1. Select the 10 Scantling_SectionReference1 and Scantling_SectionReference2 files, and
copy them within the same folder.
2. Rename each set of files. For example, rename the Scantling_SectionReference1 files to
Type3_Reference1, and rename the Scantling_SectionReference2 files to
Type3_Reference2.
3. Each individual file needs to be modified using the new naming convention.
XML Files
1. Open the first XML file (either with Notepad or a third-party XML editor), and change any
occurrences of Scantling_SectionReference1 to Type3_Reference1.
2. In the second XML file, change any occurrences of Scantling_SectionReference2 to
Type3_Reference2.
3. Save the files and exit.
RTP Files
1. Open the first RTP file (either with Notepad or a third-party XML editor), and change any
occurrences of Scantling_SectionReference1 to Type3_Reference1.
2. In the second RTP file, rename Scantling_SectionReference2 to Type3_Reference2.
3. Save the files and exit.
RQE Files
1. Open the first RQE file (either with Notepad or a third party XML editor), and change any
occurrences of Scantling_SectionReference1 to Type3_Reference1.
2. In the second RQE file, rename Scantling_SectionReference2 to Type3_Reference2.
3. Save the files and exit.
RFM Files
1. Open the first RFM file (either with Notepad or a third-party XML editor), and change any
occurrences of Scantling_SectionReference1 to Type3_Reference1.
2. In the second RFM file, change any occurrences of Scantling_SectionReference2 to
Type3_Reference2.
3. Save the files and exit.
SYM Files
1. Open the first Reference SYM file in SmartSketch Drawing Editor.

Drawings and Reports Reference Data Guide 908


Labels

2. Right-click on the text-box in the symbol, and select Properties.


3. On the User tab, type a new Value property. For example, replace
Scantling_SectionReference1 with Type3_Reference1.
4. Click OK.
If you want to alter the origin of the symbol, follow these steps:

1. On the Symbol Authoring Tools ribbon, select Symbol Origin.


2. Locate the center of the label or the point you want as the origin, and place the origin.

3. Save the file and exit.


4. Repeat the above steps for the second XML file.

Working in the Rules Folder


The file that contains all of the rules for a cutting plane symbol is in the SharedContent folder of
your database; the default location for these files is [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\ViewRules. A new XML file must be created in
order to use your new cutting plane symbols.
1. Select a delivered View Rule. For example, select
SteelOrderSectionandDetailViewRule.xml.
2. Right-click on the view rule, and select Copy. Paste the file in the same folder as the
delivered view rule.
3. Rename the new file with an appropriate name; for example, Type3.
4. Open the new view rule file with Notepad (or a third-party XML editor).
5. As in the previous steps, when working in the Labels folder, you need to replace the names
of existing label files with the names you gave the new label files. For example, change
Scantling_SectionReference1 to Type3_Reference1, and so forth.
6. After renaming all of the appropriate files, save the file and exit.

Use the Custom Cutting Plane Symbol


After creating the new symbol, you need to specify the new rule within a particular view style.
For more information on plant mode view styles, see View Style Properties Dialog Box (on page
59) and View Rules (on page 935). For more information on marine mode drawings by rule view
styles, see Labels Tab (Edit Ruleset View Style Dialog Box) (on page 132).
See Also
Create a Custom Symbol for Drawings (on page 906)
Create Line Styles to Use in Drawing View Styles (on page 89)

Drawings and Reports Reference Data Guide 909


Labels

Drawings by Rule Labels, Symbols, and Dimensions


In marine mode drawings by rule, labels can be used for text, symbols, and dimensions. The
label definition can have multiple components, assigning a text box, symbols, or both. You can
also assign different labels to the same object type in a drawing. You define labels when you
define the rule set view style using Tools > Define View Style in the Drawings and Reports
task.
Delivered labels rules are located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder. The properties available for
label rules are taken from the objects in the model. The label rules assign formatting and display
the property value on the drawing.
When creating labels, it is recommended that you start with a basic tooltip definition,
then add formatting to make the label more specific to drawing output.
Drawings by rule labels have three components:
 Property labels generated through the Catalog - Used to find existing properties on
objects. You can also write SQL labels to calculate properties that are not exposed to the
end user in the model.
 SYM file - Used to control placement on the drawing. The SYM file can contain a text box or
a graphical symbol.
 XML file - Used to format the label and populate the symbol.
The following table shows the delivered labels and dimensions that are applicable to drawings
by rule. For more information on using symbols, see Symbol Definition for Drawings by Rule (on
page 916).

Drawing Type Label Rules To Use

Scantling Drawings, including the following For Labels, Symbols, and Dimensions:
delivered packages: Steel Order by Block or Generic_Name
Assembly, Steel Order (Expansion) IS_Scantling_Name
Structure_Name
RuleSet_Name

Manufacturing Profile Sketch Drawings, For Labels:


including the following delivered packages: Mfg Generic_Name
Profile Sketch and Mfg Profile Sketch (Multiple) IS_ProfileSketch_Arial_2.5mm
Structure_Name
RuleSet_Name
StrMfg ProfileSketch Plate Location Symbol
For Dimensions:
IS_ProfileSketch_FeatureDistance
IS_ProfileSketch_FeatureDistance_Top
IS_ProfileSketch_ProfileLength
IS_ProfileSketch_TopFlangeLength
StrMrfg ProfileSketch WebThicknessLocMark
StrMfg ProfileSketch
ERPlateThicknessLocMark

Drawings and Reports Reference Data Guide 910


Labels

Manufacturing Template Drawings, including the For Labels:


following delivered packages: Mfg Template and Generic_Name
Mfg Template Set Structure_Name
RuleSet_Name
ShipDirectionRule Right Up
For Dimensions:
IS_Templateset_Offset_Distance

Manufacturing Templateset Full Scale Drawing, For Labels:


including the following delivered package: Mfg Generic_Name_A_NL
Templateset (Full Scale) For Symbols:
StrMfg Templateset Seam Point Symbol
StrMfg Templateset Tangent Point Symbol
StrMfg Templateset Midline Symbol
MfgTemplatesetFullScaleDirection Right

Manufacturing PinJig Drawings, including the For Labels:


following delivered packages: Mfg PinJig Generic_Name
IS_PinJig_Arial_1mm
Structure_Name
RuleSet_Name
For Symbols:
Pin
XPoint
XPoint_Cusp
XPoint_Origin

Hull Lines Drawings, including the following For Labels:


delivered packages: Hull Lines Generic_Name
Structure_Name
RuleSet_Name
For Symbols:
Hull Lines Default Seam Symbol
Hull Lines Erection Seam Symbol

Assembly Drawings, including the following For Labels, Symbols, and Dimensions:
delivered packages: Assembly Method and Generic_Name
Assembly Sequence
This label places the Object Name
IGNamedItem along the curve at the mid-point
by default, if no offset is specified. If the object
is non- linear, the label is placed at the
mid-range, as in the case of an assembly or
parts.

See Also
Label Definition for Drawings by Rule (on page 912)
Concatenated Labels for Drawings by Rule (on page 915)

Drawings and Reports Reference Data Guide 911


Labels

Label Definition for Drawings by Rule


You define labels for drawings by rule in the Catalog task. The labels are associated with an
object property, then the label files are moved to the [Reference Data
Folder]\SharedContent\Drawings folder. The SYM and XML files used to control placement and
format for the label are created in the Drawings folder as well. Finally, the new label is added to
a view style definition using the Tools > Define View Style command in the Drawings and
Reports task.
If you need to combine multiple simple labels to create a single concatenated label,
follow the steps below to create the simple labels, then see Concatenated Labels for Drawings
by Rule (on page 915) for instructions on combining the labels.
The following procedures step you through defining a new label.

Define the Label in the Catalog Task


1. Go to the Catalog task, and select Tools > Define Label.
2. Click New Folder to create a new folder in the label hierarchy. Rename the folder if
necessary.
3. Select the new folder, and click New COM Label to create the label.

4. On the Label Editor dialog box, click Add to define a new property for the label.

5. On the Select Properties dialog box, specify an object type, then select the property from
those available for the object type. Click OK to return to the Label Editor.

Drawings and Reports Reference Data Guide 912


Labels

6. In the Layout section, set up the formatting of the label and insert the property as needed.

7. Click OK to complete the label creation and save it to the catalog.


The label definition creates files on the SharedContent share in the \Labels\Types of Labels
folder. If you create a new folder while in the Label Editor, the files for the new label are in the
new folder. The label files include the RFM file for format definition, the RFP file for formatting
parameters, the RQE file for the report query definition, and the RTP file, which is the label
template file.
For more information, see Label Editor.

Define the Label as a Drawing Label


In addition to the files created by the Define Label command, drawing labels also require a
symbol file (SYM) and a format file (XML).
1. Create a new folder in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder, and copy the new label
files to this new folder. Now you are ready to define the SYM and XML files as needed.
2. Copy existing .sym and .xml files to the new folder, and rename them to match the names of
the new label files.
3. Go to [Program Folder]\Common2D\Shape2D\Bin and run shape2dserver.exe to start
SmartSketch Drawing Editor.
4. Select File > Open, and browse to the new folder. Select the .sym file to open it.
5. Update the .sym file to be used with drawings. Highlight the label text box, right-click, and
select Properties.

Drawings and Reports Reference Data Guide 913


Labels

6. On the Text Box Properties dialog box, go to the User tab, and modify the Attributes for
the text box.

7. Close SmartSketch Drawing Editor, saving your changes to the .sym file.
8. Open the .xml file and modify the code to point to the new label name. For example:

9. Exit the .xml file, saving your changes.

Define a View Style to Use the New Label


You are now ready to define a view style to use the new label you created. For more information
on defining view styles, see the Orthographic Drawings User's Guide.
1. In the Drawings and Reports task, select Tools > Define View Style. Change the View
Style Type to Ruleset View Style. You can create a new rule set view style or select an
existing one.
2. Select a rule set view style, and click Properties to display the Edit Ruleset View Style
dialog box.
3. In the Label field for a definition row, specify the new label you created.

4. Save the view style definition to use when creating drawings.


See Also
Drawings by Rule Labels, Symbols, and Dimensions (on page 910)

Drawings and Reports Reference Data Guide 914


Labels

Concatenated Labels for Drawings by Rule


Concatenated labels are multiple simple labels combined into a single label. For example, you
can create two simple labels, one for Plate Thickness and another for Material Type. The two
simple labels can be combined into one label that provides the information from both simple
labels.
1. Create the simple labels you want to concatenate using the steps provided in Label
Definition for Drawings by Rule (on page 912).
2. Modify the ShipDwgReports.xls file. You want to add the new labels with their RTP files to
the Reports tab of the workbook. For more information on this workbook sheet, see Ship
Drawing Reports Workbook.

3. Go to the R-Hierarchy tab of the workbook, and add the labels to the correct location in the
Catalog. For more information, see Reference Data Guide.

4. Save and close the ShipDwgReports workbook, and bulk load the workbook. You bulk load
using the Bulkload Reference Data utility delivered on the Start menu for the product.
5. After bulkloading the workbook, go to the Catalog task to make sure the new labels are
included in the Labels hierarchy.

Drawings and Reports Reference Data Guide 915


Labels

6. To create the concatenated label, combine multiple simple labels within the label RQE file
(the query file for the label).

7. Modify the label RFM file (for formatting) to ensure that the combined labels display correctly
together. In particular, make sure the ToParse property is set to yes to enable recursive
expansion of embedded labels.

When you define a rule set view style to use the concatenated label, the drawings will show the
combination of the two simple labels.

See Also
Drawings by Rule Labels, Symbols, and Dimensions (on page 910)

Symbol Definition for Drawings by Rule


Drawings by rule symbols are placed as labels or as embedded symbols. 2D symbols are used
to create the drawing symbols. There are two types of drawings by rule symbols available:
 Standard symbols - Used for symbol placement that should scale with the drawing. You
can use whitespace management to find a clear location.
 Embedded symbols - Used in cases where the symbol should be attached to a specific
point on the drawing object. Currently, the only supported symbols of this type are for slots
and end cuts.
Drawings by rule labels have three components:
 Label rule - Overall rule definition that contains one or more label templates.
 Label template - Defines the position and format of standard symbols. For embedded
symbols, the template controls the mapping between the model objects and the symbol file.

Drawings and Reports Reference Data Guide 916


Labels

 Symbol file - Defines the geometry of the symbol.


Label templates and symbol files must be located in the same folder in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder. Label rules are located in the
[Reference Data Folder]\SharedContent\Drawings\Catalog\Rules\LabelRules folder.

Use Standard Symbols


2D symbols defined as a label in the rule set view style are referred to as Standard Symbols.
Standard symbols are attached to model geometry shown on the drawing. You place standard
symbols in paper space.
To create a new 2D symbol, copy an existing rule and use the Label Rule Manager to change
the symbol formatting and geometry.
You must have already defined the view style type and the View Style Properties
dialog box must be displayed. For more information, see Define View Style Dialog Box (on page
58) and View Style Properties Dialog Box (on page 59).
1. Select Scantling Profile Seam Symbol in the Select Label Rule dialog box, and then click
Copy.
The Copy Label Rule dialog box displays.
2. Select the label rule name in the Change Rule Name text box and type TestSeamSymbol.
Click Copy.
The Copy Label Rule dialog box closes. TestSeamSymbol displays in the Select Label
Rule dialog box. The software creates the corresponding template and symbol files.
3. With TestSeamSymbol still selected, click Properties on the Select Label Rule dialog box.
The Label Rule Manager opens the TestSeamEquipment rule.
4. To change the symbol formatting, modify the properties in the Label Rule Manager.

5. To change the symbol geometry, click Launch SmartSketch next to the Label Symbol
File box in the Label Rule Manager. Make any modifications to the symbol geometry in the
SmartSketch Drawing Editor, and then save and close the symbol file.
Before you save the symbol, make sure that it is not grouped or constrained in
any way. To check for grouping, hover over each line in the symbol, and verify that
QuickPick does not display. More than one object detected could mean a group exists.
Click Ungroup to remove the grouping. To check constraints, turn on Tools > Relationship
Handles. If the symbol is constrained, you will see relationships when this toggle is turned
on.
6. Click Save & Close.
The Label Rule Manager closes.
7. Add the new label to the appropriate view style.
The standard symbol label is ready for use in a rule set view style. In the Drawings and
Reports task, use Tools > Define View Style to edit the properties of a rule set view style.
For the Label rule on the appropriate row, set the value as the new standard symbol label.
For more information on defining a rule set view style, see Edit Ruleset View Style Dialog
Box (on page 118).

Drawings and Reports Reference Data Guide 917


Labels

Use Embedded Symbols


Graphic rules for embedded symbols are specified as part of the rule set view style definition
using the Tools > Define View Style command in the Drawings and Reports task. The number
and type of rules available depends on the view style selected on the Define View Style dialog
box and the source selected in the view style properties. For more information, see Embedded
Symbol Rules (on page 1043).
See Also
Drawings by Rule Labels, Symbols, and Dimensions (on page 910)
Label Rule Manager (on page 1099)
Select Label Rule Dialog Box (on page 84)

View Label Rules in Drawings


View label rules control the appearance of view labels, their placement on views, and the
appearance and types of annotations within the views. Assign view labels as part of the drawing
view style with the Tools > Define View Style command in the Drawings and Reports task.
The view label rules are delivered in the [Reference Data
Folder]\SharedContentDrawings\Catalog\Rules\ViewRules folder.
In the table below, the Description column shows the contents of the DESCRIPTION tag in the
XML file.

Rule Name (.xml) Description

DefaultViewRule Label for View Name

DetailAndSectionViewRule View Label Rule for Detail and Section views

HngSup_SupportNotes Direction and Scale, Section 2 References

ShipParentBlockAndPartNameRule Label for Ship Name, ParentBlockName, and PartName

SteelOrderSectionandDetailViewRule View Label Rule for Section and Detail Views (ISO 128)

Type1 Direction and Scale, Section 2 References

Type2 Direction and Scale, Section 2 References

ViewNameAndScaleFitToScaleRule Label for View Name

ViewNameDirectionScaleRule Label for View Name

ViewNameScaleRule View Label Rule for Section and Detail Views (ISO 128)

Drawings and Reports Reference Data Guide 918


Labels

DetailSimpleReference
Name: DetailSimpleReference
Description: Example of Format used for labels on instantiated objects
Type: COM
Is Recursive: No
Conditional Formatting: No
Design Time Prog ID:
Run Time Prog ID: SP3DLabelsFormat.FormatLabel
Returned Properties: Reference
SQL Query:

Hanger and Support Piping Properties


Name: Hanger and Support Piping Properties
Description: Properties from the supported pipe run
Type: COM
Is Recursive: No
Conditional Formatting: No
Design Time Prog ID: SP3DLabelFormatDesigner.RTFLabel
Run Time Prog ID: SP3DLabelsFormat.FormatLabel
Returned Properties: NPD
NPDUnitType
IsInsulated
Thickness
MaterialGrade
Pressure
Temperature
SQL Query:

PartOccTestCOMLabelFormat
Name: PartOccTestCOMLabelFormat
Description: Example of Format used for labels on instantiated objects
Type: COM
Is Recursive: No
Conditional Formatting: No
Design Time Prog ID:
Run Time Prog ID: SP3DLabelsFormat.FormatLabel
Returned Properties: Name
SQL Query:

Drawings and Reports Reference Data Guide 919


Labels

SectionSimpleReference1
Name: SectionSimpleReference1
Description: Example of Format used for labels on instantiated objects
Type: COM
Is Recursive: No
Conditional Formatting: No
Design Time Prog ID:
Run Time Prog ID: SP3DLabelsFormat.FormatLabel
Returned Properties: Reference1
SQL Query:

SectionSimpleReference2
Name: SectionSimpleReference2
Description: Example of Format used for labels on instantiated objects
Type: COM
Is Recursive: No
Conditional Formatting: No
Design Time Prog ID:
Run Time Prog ID: SP3DLabelsFormat.FormatLabel
Returned Properties: Reference2
SQL Query:

View Label Rules in Drawings by Rule


Marine mode view label rules control the appearance of view labels, their placement on views,
and the appearance and types of annotations within the views. You assign view labels as part of
the drawing view style with the Tools > Define View Style command in the Drawings and
Reports task.
View label rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\ViewRules folder.
The view label rules also use the following:
 Templates delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\Views folder. For more
information, see Drawings by Rule Labels, Symbols, and Dimensions (on page 910)
 View naming rules. For more information, see View Naming Rules in Drawings by Rule (on
page 317).
The following view label rules are delivered with the software:

Default View
Displays the name of the view naming rule. For example:
LONGITUDINAL L-2

Drawings and Reports Reference Data Guide 920


Labels

View Name Direction Scale


Displays the name from the view naming rule, the view direction, and the view scale. For
example:
LONGITUDINAL L-2
LKG PORT
(SCALE: 1:50 mm)

View Name Scale


Displays the name from the view naming rule and the view scale. For example:
SHELL EXPANSION - PORT
(SCALE: 1:100 mm)

Detail and Section View


Displays the view type, the view direction, and the view scale. This rule uses the
ViewTypeDirectionAndScale template.
Steel Order
Looking Up
SCALE: 1:50 mm

Steel Order Section and Detail View


Displays the View Name Direction Scale view name. Also defines section and detail-specific
annotations, such as the section arrow and cutting plane style. This rule uses the
ViewNameDirectionScale View Label Template (on page 921).

Ship Parent Block And Part Name


Displays the View Name, Ship Name, Parent Block Name and Part Name for a drawing view.
This rule uses the ShipParentBlockAndPartName View Label Template (on page 922).

ShipDirectionRule Right Up
Displays the Right and Up directions of the profile. This rule uses the ShipDirectionRule Right
Up View Label Template.

ViewNameDirectionScale View Label Template


Places a label on the view of a Steel Order drawing that includes typical information on profiles,
as well as view direction, scale, and drawing name. In the example below, the typical profile
name is BF 120x35. The 120x35 refers to the section size of the typical profile part.

In order to view the non-typical profile parts, manually place the Plate Stiffeners Summary or
Sibling Plates Stiffeners Summary label. These labels will annotate any profile parts that are

Drawings and Reports Reference Data Guide 921


Labels

different from the typical profile part for a particular plate system. For more information, see
Plate Stiffeners Summary Label Template (on page 903) and Sibling Plates Stiffeners Summary
Label Template (on page 903).

ShipParentBlockAndPartName View Label Template


Places a label on the view of a drawing that includes information on the following:
 View Name
 Ship Name
 Parent Block Name
 Part Name
In the following example, the block name is BO.1-6.1-3, and the part name is
TB0.1-6.1-3-1_1-1.The DWG_ATP_India refers to the ship name

Label Editor
Edits or creates a label. This dialog box is accessible from Tools > Define Label in the Catalog
task dialog box; it displays when you click New COM Label , New SQL Label , or
Properties on the horizontal toolbar.

 In the Common task, the Label Editor displays when you select a Tooltip on the
OptionsToolTips tab and then click Edit Label. You can edit the formatting for the selected
label, and the changes are saved to the session file. Edits made to the label are not saved to
the Catalog. For more information, see the Common User's Guide.
 In the Drawings and Reports task, the Label Editor displays when you select New Format in
the Name list on the Labels tab of the Item Properties dialog box when using Design
Layout to format a report. You can create a new label format to use within your report. For
more information, see the Reports User's Guide and the Drawings and Reports Reference
Data Guide.
Name
Displays a default name for the label. You can type a name, or click More to select an
existing label definition. In the Common task, this box is not available.
Description
Displays a text description of the label.

Drawings and Reports Reference Data Guide 922


Labels

Properties
Displays properties associated with the label. The options available are different depending on
the type of label--either COM or SQL Query. If you are working with a COM Label, you can add
or delete property rows as needed:
Add
Opens the Select Properties dialog box, from which you can select an object type and
corresponding property. For more information about this dialog box, see the section about
managing sessions in the Common User's Guide available from the Help > Printable
Guides command in the software.
Remove
Discards a selected property in the Properties grid.
Edit Label
Opens the Select Properties Dialog Box to apply object properties to the label definition.
Property Name
Specifies the name of the property.
Alias Name
Specifies an alias for the property. You can type user-defined text in this box.
If you are working with an SQL Query Label, the definition provides the following
capabilities:
 Show Results - Adds a results pane to the Properties section. The results update
when you execute the query.
 Execute Query - Runs the query as specified. If the Results pane is shown, the
results display.
 Properties - Displays the Select Properties dialog box.
 Name - Specifies a name for the query.

Layout
Provides a text field for entering text and fields to be used in the label. The options available are
described as follows:

Rich Text Format


Displays the Font dialog box so that you can specify font, font style, font size, and font
special effects to be used in the label.

Block Definition
Displays the Block dialog box so that you can define condition criteria.
Field Formatting
Displays the Field Formatting dialog box so that you can define specific formatting for a
selected field. This button is disabled unless a field is selected in the Layout text box.

Drawings and Reports Reference Data Guide 923


Labels

Unit Formatting
Displays the Select Rule dialog box for specifying a Unit of Measure formatting rule. This
button is disabled unless a unit of measure field is selected in the Layout text box.

Position Definition
Displays the Position Definition dialog box for defining the displays of the positional
information in the label. This button is disabled unless a positional field is selected in the
Layout text box.

Orientation Definition
Not available in this version.
For more information on these commands, see the Smart 3D Catalog User's Guide.

Format Field Dialog Box (Label Editor)


Defines the format for the selected field. The Format Field dialog displays when you select a
field in the Layout text box on the Label Editor and click Format Field . The dialog box is
similar to the Microsoft Excel Format Cell command.
Category
Specifies the type of the formatting to assign to the field. The category controls the definition
controls displays on the dialog box.
Sample
Shows a sample of the selected format.

Select Rule Dialog Box (Label Editor - Unit of Measure)


Lists the available unit of measure rules. You can open this dialog box when you select a single
field in the Layout text box on the Label Editor box and click Format Unit .
Rule Name
Lists the names of available unit of measure rules.
Description
Lists the descriptions of the rules.

New
Displays the Unit of Measure dialog box for creating a new unit of measure rule.
Delete
Deletes the selected rule.
Rename
Renames the selected rule.
Properties
Displays the Unit of Measure dialog box to review or edit the selected rule.

Drawings and Reports Reference Data Guide 924


Labels

Unit of Measure Dialog Box (Label Editor)


Specifies properties for a new unit of measure rule. This dialog box displays when you click New
on the Select Rule dialog box. The properties displayed are inherited from the context in
which the unit of measure label is created (that is, Session, Report, or Drawing).
Rule Name
Specifies a name for the unit of measure rule.
Description
Describes the unit of measure rule.
Inherit from Session, Reports, Drawing
Indicates that the parameter should use the same units used in the session, the report, or
the drawing. This option is selected by default, which makes the Properties read-only.
To change the existing values, clear this option. You can then define a value for the
Unit Delimiter property.

Properties
Unit
Displays the type of unit, such as distance.
Primary
Specifies the primary unit of measure, such as yards in yards, feet, or inches.
Secondary
Specifies the secondary unit of measure, such as feet in yards, feet, or inches.
Tertiary
Specifies the tertiary unit of measure, such as inches in yards, feet, or inches.
Displayed Unit
Turns the display of the units on and off.
Precision Type
Specifies Decimal, Fractional, or Scientific. Your selection in this box determines the
availability of the remaining boxes on this dialog box.
Decimal Precision
Specifies the number of places after the decimal point. This value can be 0 or greater.
Leading Zero
Places a zero before the decimal point, if applicable.
Trailing Zeros
Places zeros after the last significant digit, if applicable.
Fractional Precision
Specifies a fraction for the precision. The highest value that you can specify is 1/2. This box
is available only if you select Fractional in the Precision Type box.

Drawings and Reports Reference Data Guide 925


Labels

Reduce Fraction
Reduces the fraction. For example, displays 3/4 instead of 6/8. This box is available only if
you select Fractional in the Precision Type box.
Unit Delimiter
Specifies the unit delimiter that you want to add between primary and secondary units in a
report label. For example, 4'-3 3/4". This box is disabled if you leave the secondary unit as
<BLANK> or if Inherit from Session, Reports, Drawing option is selected.

 If you do not set the unit delimiter value, the software places two space characters
between the primary and secondary units.
 You can define one unit delimiter value.
 If you want spaces between the units and the unit delimiter, add spaces to the unit
delimiter value, such as "-".

Block Definition Dialog Box (Label Editor)


Displays several options that allow you to apply condition criteria to new or existing labels. A
conditional label only appears if the conditions are met based on the values specified in the
Block Definition dialog box.

Selected block text


Displays the selected block of text from the Layout section of the Label Editor command. For
more information, see Label Editor.

Block type
Repeat the fields in the block for each occurrence
Allows you to repeat certain fields in the block as many times as they occur in the label. Text
in this box cannot be edited. For example, most label blocks are separated by a return in the
label, but the repeat option places all of the conditional blocks on the same line in the label.

Conditions
Match all
All conditions must match.
Match any
Any conditions can match.
True
Condition must be true.
False
Condition must be false.
Delete
Removes the selected row from the list of conditions.

Drawings and Reports Reference Data Guide 926


Labels

Property
Specifies the properties available from the Layout field in the Label Editor.
Operator
Specifies the operator value. Possible values are: =, >, >=, <, <=, <>, Between, and Not
Between.
Value
Specifies the properties available for comparison based on the properties list.
If Boolean or codelist values exist, they are also listed for comparison.
State of value
Specifies the format, which can be Raw, Post-formatted, and Pre-formatted.
Value 2
Specifies the second value condition if the Operator is set to Between or Not Between.

Position Definition Dialog Box


Defines position information for a new label field. This dialog box displays when you select a
positional field in the Layout text box on the Label Editor and click Define Position .
Properties
Displays a list of the properties currently assigned to the positional field. For example, you
select the label text field <F>CGx</F> and you want to represent the value as 5.45m
GlobalCS East. You would need to define the coordinate system, the name of the +/- axes,
and the read-out order for the values.
The Matrix Rule property provides a dropdown list of the last 10 selected rules. Selecting
Create New Rule in the dropdown allows you to create a new positional definition rule. For
more information on creating a new positional rule, see Matrix Rule Dialog Box. Selecting
More in the dropdown displays a Browse dialog to select an existing rule. For more
information on selecting an existing rule, see Select Rule Dialog Box (Label Editor - Position
Definition).
The Readout property has a dropdown that contains all of the possible
combinations for value, coordinate system, and axis, including cases where you might want
to omit one of the read-out options.

Select Rule Dialog Box (Label Editor - Position Definition)


Lists the available position matrix rules. You can open this dialog box when you select More in
the Matrix Rule list on the Position Definition dialog box.
Rule Name
Lists the names of available position matrix rules.
Description
Lists the descriptions of the rules.

Drawings and Reports Reference Data Guide 927


Labels

New
Displays the Matrix Rule dialog box for creating a position matrix rule. For more information,
see Matrix Rule Dialog Box.
Delete
Deletes the selected rule.
Rename
Renames the selected rule.
Properties
Displays the Unit of Measure dialog box to review or edit the selected rule.

Matrix Rule Dialog Box


Specifies properties for a position matrix rule. This dialog box displays when you click New
on the Select Rule dialog box.
Rule Name
Specifies a name for the unit of measure rule.
Description
Describes the unit of measure rule.

Select Rule Dialog Box (Label Editor - Unit of Measure)


Lists the available unit of measure rules. You can open this dialog box when you select a single
field in the Layout text box on the Label Editor box and click Format Unit .
Rule Name
Lists the names of available unit of measure rules.
Description
Lists the descriptions of the rules.

New
Displays the Unit of Measure dialog box for creating a new unit of measure rule.
Delete
Deletes the selected rule.
Rename
Renames the selected rule.
Properties
Displays the Unit of Measure dialog box to review or edit the selected rule.

Drawings and Reports Reference Data Guide 928


Labels

Create a Label
1. In the Catalog task, click Tools > Define Label.
2. On the Define Label dialog box, select the type of label you want to create - New COM
Label or New SQL Label .
3. In the Label Editor, type a name in the Name box, if necessary.
4. Type a new description in the Description box, if necessary.
5. For property-based labels, add properties to the label by clicking Add and selecting the
object type and properties you want to include in the label in the Select Properties dialog
box.
6. Select rows in the Properties table, and click Insert a field to layout to place them in the
Text region.
7. To change the font style for a property, select a field in the Text box, and click Rich Text
Formatting .
8. To change the format of a property, select a field in the Text box, and click Field
Formatting .
9. To change the format of the units of measure, select a field in the Text box, and click Unit
of Measure . For more information, see Define the Unit of Measure section.
10. For SQL-based labels, make changes to the SQL statements in the Properties box. You
can click Show Results Pane to open a lower window that displays the results of the
SQL query. Test the query by clicking Execute Query .
11. When you are finished, click OK.

Define the Unit of Measure


1. In the Label Editor dialog box, select the label text in the Layout box and click Unit of
Measure .
The Select Rule dialog box displays.
2. Click New or Properties .
The Unit of Measure dialog box displays.
3. Clear Inherit from Session, Reports, Drawings check box, if you want to change the
existing values and to type in a unit delimiter value.
4. Define values for Primary and Secondary units.
5. Type a value in the Unit Delimiter box. For more information, see Unit of Measure Dialog
Box (Label Editor) in the Label Editor Command section.
6. Click OK.
If you define a label with a unit delimiter, then you can find the .rfp file of the
respective label template in the [Product Folder]\3DRefData\SharedContent\Labels\Types of
Labels folder. For example, if you change the UOM (unit of measure) setting of Structure Linear
Member Length, then the .rfp file of Structure Linear Member Length is changed. Every label
has its own .rfp file.

Drawings and Reports Reference Data Guide 929


Labels

Modify Label Symbol File


This workflow demonstrates the ability to further modify a label by creating the symbol file.
1. Using Windows Explorer, browse to the location that you saved the label created with the
Label Editor.
The default location is [Product Folder]\SharedContent\Labels\Drawing Labels.
2. Copy all of the files associated to the new label you created. There are four files with
different extensions: RFM, RFP, RQE, and RTP.
3. Browse to [Product Folder]\SharedContent\Drawings\Catalog\Labels\Templates, and paste
the files.
4. In the Templates folder, perform a copy and paste operation of an existing SYM file. For
example, copy and paste SectionSize_None_APO_NL.sym in the same folder.
5. Rename the copied file to match the files you created earlier in the Label Editor.
6. Double-click the new SYM file to open it.
7. Change the text in the Text box to match the label name.
8. Right-click the text box, and select Properties.
9. On the User tab, change the Value field to the name of your label.

For more information on editing other symbol properties, see the Orthographic Drawings
User's Guide.
10. Click Add to add the label ID to the symbol properties.
11. Click OK.
The symbol file is associated to the new label you created in the Label Editor.

Drawings and Reports Reference Data Guide 930


Labels

Modify Label XML File


This workflow demonstrates the ability to further modify a label by editing the associated XML
file.
1. Browse to the [Product Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder.
2. In the Templates folder, perform a copy and paste operation on an existing XML file. For
example, copy and paste SectionSize_None_APO_NL.xml in the same folder.
3. Rename the copied file to match the files you created earlier in the Label Editor.
Before proceeding, consider downloading a third-party XML document editor to
make it easier to read and modify the .xml files.
4. Double-click the new XML file to open it in Notepad or a third-party XML document editor.
5. Rename any instances of SectionSize_None_APO_NL to your new label name. For
example, rename SectionSize_None_APO_NL to MyNewLabel.
When renaming these instances, remember to keep file extensions if they are
present in the original name.
6. Save the file and exit.
In order to use your new label in a drawing, you need to create a label rule. For
more information on creating a new label rule, see Create a New Label Rule (on page 931).
See Also
Modify Label Symbol File (on page 930)

Create a New Label Rule


This workflow demonstrates the ability to create a new label rule that can be used to place a
custom label that you have created.
1. Browse to the [Product Folder]\SharedContent\Catalog\Rules\LabelRules folder, and
perform a copy and paste operation on an existing XML file. For example, copy and paste
the SectionSize_None_APO_NL.xml file within the same folder.
2. Rename the copied XML file to the name of the label you created in previous steps.
3. Open the file using Notepad or a third-party XML document editor.
4. Change any occurrences of SectionSize_None_APO_NL to your label name. For example,
change SectionSize_None_APO_NL to MyNewLabel.
There should only be one file name to change in this XML file.
5. Save the file and exit.
6. In order to use your new label in a drawing, you need to specify the new rule within a
particular view style. For more information, see the Orthographic Drawings User's Guide.
See Also
Modify Label Symbol File (on page 930)
Modify Label XML File (on page 931)
Create a Custom Cutting Plane Symbol (on page 907)

Drawings and Reports Reference Data Guide 931


Labels

Matchline Rules
Matchline rules are used to label adjoining volumes on drawings. Use the Matchline Rule
Manager to customize matchline rules and templates.
The matchline rules are saved in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\MatchlineRules folder. The rules have
corresponding templates and symbols in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\Matchline folder. For more
information, you can open the rule and template XML files to view the comments in the code.

View Style Properties Dialog Box (on page 59)


To add matchline labels to a specific layer:
1. Select Matchline_None_A from the Matchline Rule list on the View Style Properties
dialog box and then press F12.
The Matchline Rule Manager opens the template.
2. Type MATCHLINE_LABELS in the Label Layer text box, and then click Save & Close.
The software places all labels created with the Matchline_None_A template on a layer called
MATCHLINE_LABELS. If the layer does not already exist, the software automatically
creates it.
MATCHLINE_LABELS can be any name you want, including an existing layer. If
the layer name that you enter does not already exist, then it will be created.

Working with Volumes that Share a Common Surface


If you require matchline labels for drawings that share common surfaces as in the graphic
below, all of the drawings must be part of the same component.

Drawings and Reports Reference Data Guide 932


Labels

In the example below, the drawings produced by the three separate components in the
MatchlinesSeparate folder do not have matchline labels applied. The three drawings created
by the single MatchlinesTogether component have matchline labels placed on them.

See Also
View Style Rules (on page 57)
Matchline Rule Manager (on page 1606)
Matchline Drawing Requirements (on page 933)
Label Layer (labelLayer) (on page 1339)

Matchline Drawing Requirements


The list below describes the requirements for matchline labels to display successfully.
 The volumes must be adjacent to each other.
 The volumes must be associated to a view within the parent component node.
 The view styles of the volumes must be that of the parent view.
 The volumes must be associated to graphic views of the same type. Graphic view types
include main views, detail views, section views, and snapshot views.
 The volumes associated with the views must have adjoining edges or sides that overlap by
at least 33%.

Drawings and Reports Reference Data Guide 933


Labels

In the example below, the view associated with Drawing Volume 2 will only have
matchline labels for the views associated to Drawing Volume 1 and Drawing Volume 4.
Drawing Volume 3 does not overlap Drawing Volume 2 by at least 33%, so no matchline
label referencing the view associated with Drawing Volume 3 is placed.

 The view direction must be along the same axis as the associated view.
 The Up direction for the view must be along the same axis or perpendicular to the
associated view's Up direction.
See Also
Matchline Rules (on page 932)

North Arrow Rules


North arrow rules place a label that points toward Global North on drawings. Use the North
Arrow Rule Manager to customize north arrow rules and templates.
The north arrow rules are saved in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\NorthArrowRules folder. The rules have
corresponding templates and symbols in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\NorthArrows folder. For more
information, you can open the rule and template XML files to view the comments in the code.
For more information, see Select Label Rule Dialog Box (on page 84).
See Also
View Style Rules (on page 57)
North Arrow Rule Manager (on page 1633)

Drawings and Reports Reference Data Guide 934


SECTION 11

View Rules
View rules specify how view frames display in the drawing document. You can use delivered
view rules or create and modify your own rules that enable you to incorporate custom symbols
and labels into your drawings.
The view rules are saved in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\ViewRules folder. For more information, you
can open the rule XML file to view the comments in the code.

Select View Rule Dialog Box (on page 936)


For more information on including detail and section views in your drawings, see Place a
Section View or Place a Detail View in the Orthographic Drawings User's Guide.
See Also
View Style Rules (on page 57)
Create a Custom Cutting Plane Symbol (on page 907)

View Label Rules in Drawings


View label rules control the appearance of view labels, their placement on views, and the
appearance and types of annotations within the views. You assign view labels as part of the
drawing view style with the Tools > Define View Style command in the Drawings and Reports
task.
View label rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\ViewRules folder.
The view labels also use the following:
 Templates delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\Views folder.
 View naming rules.
 Section mark rules.
The following view label rules are delivered with the software:

Type1
Displays the view direction and view scale. For example:
Looking North
SCALE: Fit To Scale

Drawings and Reports Reference Data Guide 935


View Rules

The Type1 view rule uses the SectionBubbleArrow for all cutting plane section mark arrows.

Type2
Displays the view direction and view scale. For example:
Looking North
SCALE: Fit To Scale
The Type2 view rule uses the Type2_Arrow for all cutting plane section mark arrows.

For more information on creating your own cutting plane section marks, see Create a Custom
Cutting Plane Symbol (on page 907).
See Also
Orthographic and Key Plan View Styles (on page 370)

Select View Rule Dialog Box


Lists the available view rules. You can open this dialog box by clicking More in the View Rule
field on the View Style Properties dialog box.
Views
Switches the view from List to Details. When you choose the List mode, descriptions of
each rule do not display.
Rule Name
Lists the names of the rules.
Description
Lists the descriptions of the rules.
New
Opens the View Frame Rule dialog box so you can create a new view rule. For more
information, see View Frame Rule Dialog Box (on page 937).
Rename
Renames the selected rule.
Delete
Deletes the selected rule.

Drawings and Reports Reference Data Guide 936


View Rules

Properties
Opens the View Frame Rule dialog box so you can edit the properties for the selected view
rule.
See Also
View Style Properties Dialog Box (on page 59)
View Rules (on page 935)

View Frame Rule Dialog Box


Sets options for a view rule.
Rule Name
Specifies the name of the view frame rule.
Description
Describes the rule.
Property
Identifies the properties available for the view frame rule definition.
Value
Specifies the value for the selected property

Properties Available Values

View Caption Label DetailSimpleReference


Section Reference 1 SectionBubbleArrow
Section Arrow 1 SectionSimpleArrow
Section Reference 2 SectionSimpleReference1
Section Arrow 2 SectionSimpleReference2
Detail Reference ViewTypeDirectionAndScale

Section Cutting Plane Style Select from a list of line styles available for the cutting plane
Detail Envelope Style or detail envelope frame.

Section Cutting Plane Layer Specify the layer on which the cutting plane or detail envelope
Detail Envelope Layer frame resides.

See Also
View Style Properties Dialog Box (on page 59)

Drawings and Reports Reference Data Guide 937


SECTION 12

Weld Labels
Weld labels are used in marine mode drawings.

In This Section
Scantling Shell Profile Weld Label ................................................. 938
Structure_Weld .............................................................................. 942
WeldLabel ...................................................................................... 949

Scantling Shell Profile Weld Label


The Scantling Shell Profile Weld Label.xml file is located on the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder. This section contains labels
in Scantling Shell Profile Weld Label.xml that are used for shell profiles in steel order rule set
styles and other structural styles.

Topics
Scantling Profile Weld_IButt .......................................................... 938
Scantling Profile Weld_IVButt ........................................................ 939
Scantling Profile Weld_IXButt ........................................................ 939
Scantling Profile Weld_VButt ......................................................... 940
Scantling Profile Weld_XButt ......................................................... 940
Scantling Profile Weld_XButtSM ................................................... 941
Scantling Profile Weld_YButt ......................................................... 941

Scantling Profile Weld_IButt


Description: Weld symbol for I butt weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeld1, ButtWeldI, Butt-I

Symbol Joint

1 - Gap

Drawings and Reports Reference Data Guide 938


Weld Labels

Scantling Profile Weld_IVButt


Description: Weld symbol for IV butt weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeldIV

Symbol Joint

Scantling Profile Weld_IXButt


Description: Weld symbol for IX butt weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeldIX

Symbol Joint

1 - Bevel angle
2 - Molded side

Drawings and Reports Reference Data Guide 939


Weld Labels

Scantling Profile Weld_VButt


Description: Weld symbol for V butt weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeld4, ButtWeldV

Symbol Joint

Scantling Profile Weld_XButt


Description: Weld symbol for X butt weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeld3, ButtWeldK

Symbol Joint

1 - Reference part
2 - Root gap
3 - Non-reference root gap
4 - Nose

Drawings and Reports Reference Data Guide 940


Weld Labels

Scantling Profile Weld_XButtSM


Description: Weld symbol for X butt weld without a nose
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeldX

Symbol Joint

Scantling Profile Weld_YButt


Description: Weld symbol for Y butt weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeld2, ButtWeldY

Symbol Joint

1 - Reference part
2 - Root gap
3 - Non-reference root gap
4 - Nose

Drawings and Reports Reference Data Guide 941


Weld Labels

Structure_Weld
AWS welds are constructed with the Structure_Weld.xml file located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder. Weld symbols created using
this XML are assembled from smaller symbols in the [Reference Data
Folder]\SharedContent\DrawingsCatalog\Labels\Templates\WeldSymbols folder and flipped as
needed to accommodate the view. These processes are handled internally by the
DrawingWeldSymbols content module and the DrawingWeldLeader leader module.

Weld Label Flip Behavior


The weld label flips the view direction based on the local coordinate system. There are five
different weld flipping behaviors.
Type 1
The physical connection is the target object, which means the local coordinate system
z-vector and the view direction z-vector are parallel. If the boundary is closed, the primary
and secondary side has a weld point that the leader terminator end point. If the boundary is
open, the primary and secondary weld points are at the same position.

Type 2
The physical connection primary side is in the front, which means the local coordinate
system y-vector and the view direction z-vector are parallel. In this case, all 2D graphics are
on the primary side. Only left-flip is possible.
Type 3
The physical connection secondary side is in the front, which means the local coordinate
system y-vector and the view direction z-vector directions are opposing. In this case, all 2D
graphics are displayed on the secondary side. Only left-flip is possible.
Type 4

Drawings and Reports Reference Data Guide 942


Weld Labels

The physical connection primary and secondary sides are parallel to the view direction,
which means the local coordinate system x-vector and view direction z-vector are parallel. In
this case, the physical connection is a simple line, and the primary and secondary sides are
located at the ends of the simple line.

Type 5
The physical connection is in a looking isometric view. This case is very similar to Type 1.

Additional examples of the weld label flipping behavior


If the flipping type is 1 or 4, the weld label symbols invert across the reference line in the label.
See the following graphic for an example.

Drawings and Reports Reference Data Guide 943


Weld Labels

If the flipping type is 2 or 3, the weld label symbol does not change when it flips sides. See the
following graphic for an example.

Weld Label Tolerance Angle for Perpendicular or Collinear Reference Lines


According to AWS standards, arrow lines are not perpendicular to the reference weld reference
line. Therefore, a default 5 degree shift is added to automatically placed weld labels.

If you attempt to place a weld label perpendicular or collinear to the reference line, the arrow line
is not accepted. You can control this value as an option in the XML file. For more information,
see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 944


Weld Labels

Examples
If the angle of the arrow line is 87, the angle of the arrow line shifts to the 90 degree tolerance
angle, which is 85 degrees. See the graphic below for an example.

If the angle of the arrow line is 3 degrees, the angle of the arrow line shifts to a default 5
degrees. See the graphic below for an example.

There are two unique XML tags in this file that allow you to control the tolerance angle of the
arrow line in two different situations. These tags are located under the leaderSettings section of
the file.
toleranceAngle

Drawings and Reports Reference Data Guide 945


Weld Labels

Specifies the tolerance range angle in degrees. If the angle of the arrow line is within the
range of this option, the arrow line is shifted by the number of degrees specified. The default
setting is 5 degrees.

toleranceAngleForSingleBevelJWeld
Specifies the permissible range of the leader line in degrees. If the arrow line is out of the
range, the angle of the leader line must be 90 - the tolerance angle specified. The default
setting is 15.

 This option is only compatible when labeling a single-bevel butt weld, a single-bevel butt
weld with a broad root face, or a single-J butt weld.
 If you delete this tag, the weld is labeled straight on without a jog.
 If this option is set to 0, the leader line is placed perpendicular to the arrow line.

Drawings and Reports Reference Data Guide 946


Weld Labels

 The leaders created by the Structure_Weld.xml label are genuine leader objects that are
controlled by delivered leader modules.
 You can use the ALT key while clicking to manually jog the leader.

Representation Arrow Line Pointing at Prepared Edge Line


Single-bevel butt welds, single-bevel butt welds with broad root faces, and single J butt welds
are not labeled with the arrow line pointing at the prepared edge. Instead, they are labeled with
the perpendicular arrow line pointing at the vertex of the angle. The position of the arrow line
with respect to the weld is generally not significant. In the case of single-bevel butt welds,
single-bevel butt welds with broad root faces, and single J butt welds, the arrow line points
toward the prepared plate. This option is controlled in the XML file through the
toleranceAngleForSingleBevelJWeld tag, which you can delete if you want the arrow line to
point directly to the prepared edge.
toleranceAngleForSingleBevelJWeld tag enabled

toleranceAngleForSingleBevelJWeld tag disabled

Example
The angle A, is the permissible range of the leader line. If the arrow line is out of the range, the
angle of the leader line is 90 - A. The leader line shifts according to the option.
If the option is set to 0, the angle of the leader line is 90 degrees based on the arrow line.

Drawings and Reports Reference Data Guide 947


Weld Labels

For more information, see Structure_Weld (on page 942).

Representation Terminator Movement


The terminator moves if there are better positions on the connection label based on the clear
space position of the label. Below is an example of the automatically placed label positioning
behavior.

If the label is moved to the other side, the terminator is moved with the label. The red line in the
example signifies the physical connection. Also, the label inverts depending on its relation to the
physical connection location. See the example below.

If the physical connection is open, meaning it is symbolized as a single line, the


position of the terminator is retained.
See Also
AWS Standards in Drawings (on page 34)

Drawings and Reports Reference Data Guide 948


Weld Labels

WeldLabel
The WeldLabel.xml file is located on the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder. This section contains labels
in WeldLabel.xml that are used in Steel Order rule set styles and other structural styles.

Topics
Structure_Weld_Fillet .................................................................... 949
Structure_Weld_IButt ..................................................................... 950
Structure_Weld_IVButt .................................................................. 950
Structure_Weld_IXButt .................................................................. 950
Structure_Weld_VButt ................................................................... 951
Structure_Weld_XButt ................................................................... 951
Structure_Weld_YButt ................................................................... 952
Structure_Weld_Tee1 .................................................................... 952
Structure_Weld_Tee2 .................................................................... 953
Structure_Weld_Tee3 .................................................................... 953
Structure_Weld_Tee4 .................................................................... 954
Structure_Weld_Tee5 .................................................................... 954
Structure_Weld_Tee6 .................................................................... 955
Structure_Weld_Tee7 .................................................................... 955
Structure_Weld_TeeK ................................................................... 956
Structure_Weld_TeeV ................................................................... 956
Structure_Weld_TeeX ................................................................... 957
Structure_Weld_TeeY ................................................................... 957
ViewTypeDirectionAndScale ......................................................... 958
WeldSymbol ................................................................................... 958

Structure_Weld_Fillet
Description: Weld symbol for Fillet weld
Type: Graphical
Returned Properties: Leg size
Weld Type: FilletWeld1, FilletWeld2

Symbol Joint

1 - Leg
2 - Molded side

Drawings and Reports Reference Data Guide 949


Weld Labels

Structure_Weld_IButt
Description: Weld symbol for I butt weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeld1, ButtWeldI

Symbol Joint

1 - Gap

Structure_Weld_IVButt
Description: Weld symbol for IV butt weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeldIV

Symbol Joint

Structure_Weld_IXButt
Description: Weld symbol for IX butt weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeldIX

Symbol Joint

1 - Bevel angle
2 - Molded side

Drawings and Reports Reference Data Guide 950


Weld Labels

Structure_Weld_VButt
Description: Weld symbol for V butt weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeld4, ButtWeldV

Symbol Joint

Structure_Weld_XButt
Description: Weld symbol for X butt weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeld3, ButtWeldX, ButtWeldK

Symbol Joint

1 - Reference part
2 - Root gap
3 - Non-reference root gap
4 - Nose

Drawings and Reports Reference Data Guide 951


Weld Labels

Structure_Weld_YButt
Description: Weld symbol for Y butt weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: ButtWeld2, ButtWeldY

Symbol Joint

1 - Reference part
2 - Root gap
3 - Non-reference root gap
4 - Nose

Structure_Weld_Tee1
Description: Weld symbol for Tee1 weld
Type: Graphical
Returned Properties: Throat size
Weld Type: TeeWeld1

Symbol Joint

Drawings and Reports Reference Data Guide 952


Weld Labels

Structure_Weld_Tee2
Description: Weld symbol for Tee2 weld
Type: Graphical
Returned Properties: Throat size
Weld Type: TeeWeld2

Symbol Joint

Structure_Weld_Tee3
Description: Weld symbol for Tee3 weld
Type: Graphical
Returned Properties: Throat size
Weld Type: TeeWeld3

Symbol Joint

Drawings and Reports Reference Data Guide 953


Weld Labels

Structure_Weld_Tee4
Description: Weld symbol for Tee4 weld
Type: Graphical
Returned Properties: Throat size
Weld Type: TeeWeld4

Symbol Joint

Structure_Weld_Tee5
Description: Weld symbol for Tee5 weld
Type: Graphical
Returned Properties: Throat size
Weld Type: TeeWeld5

Symbol Joint

Drawings and Reports Reference Data Guide 954


Weld Labels

Structure_Weld_Tee6
Description: Weld symbol for Tee6 weld
Type: Graphical
Returned Properties: Throat size
Weld Type: TeeWeld6

Symbol Joint

Structure_Weld_Tee7
Description: Weld symbol for Tee7 weld
Type: Graphical
Returned Properties: Throat size
Weld Type: TeeWeld7

Symbol Joint

Drawings and Reports Reference Data Guide 955


Weld Labels

Structure_Weld_TeeK
Description: Weld symbol for K tee weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: TeeWeldK

Symbol Joint

1 - Reference side bevel depth


2 - Anti-reference side bevel depth
3 - Nose
4 - Reference side bevel angle
5 - Anti-reference side bevel angle

Structure_Weld_TeeV
Description: Weld symbol for V tee weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: TeeWeldV

Symbol Joint

1 - Reference side bevel depth


2 - Reference side bevel angle

Drawings and Reports Reference Data Guide 956


Weld Labels

Structure_Weld_TeeX
Description: Weld symbol for X tee weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: TeeWeldX

Symbol Joint

1 - Reference side bevel depth


2 - Anti-reference side bevel depth
3 - Reference side bevel angle
4 - Anti-reference side bevel angle

Structure_Weld_TeeY
Description: Weld symbol for Y tee weld
Type: Graphical
Returned Properties: Global direction of weld: Aft, Fwd, Stbd, Port, Low, Up
Weld Type: TeeWeldY

Symbol Joint

1 - Reference side bevel angle


2 - Nose

Drawings and Reports Reference Data Guide 957


Weld Labels

ViewTypeDirectionAndScale
Description: Example of Format used for labels on instantiated objects
Type: COM
Is Recursive: No
Conditional Formatting: No
Design Time Prog ID:
Run Time Prog ID: SP3DLabelsFormat.FormatLabel
Returned Properties: BaselineElevation
Tag2
Tag1
Caption
Tag
ViewCS
Scale
Direction
Type
ViewName
SQL Query:

WeldSymbol
Description: Example of Format used for labels on instantiated objects
Type: COM
Is Recursive: No
Conditional Formatting: No
Design Time Prog ID:
Run Time Prog ID: SP3DLabelsFormat.FormatLabel
Returned Properties: WeldSymbol
SQL Query:

Drawings and Reports Reference Data Guide 958


SECTION 13

Graphic Preparation Rules


Graphic preparation rules determine the display of objects passing the view style tests. You can
use the Select Graphic Preparation Rule dialog box to include graphic preparation rules in the
view style definition. For more information, see Select Graphic Preparation Rule Dialog Box (on
page 67).
Graphic preparation rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\WrapperReplacementRules folder.
For examples on adding graphic preparation rules to view styles, see Create a View Style with
Single Line Pipes (on page 977) and Create a View Style with Resymbolized Normal Pipes (on
page 974).
Graphic preparation rules use custom graphic modules to define the display parameters. For
more information, see Custom Graphic Modules (on page 972).
The following graphic preparation rules do not use custom graphic modules:
 Civil Isometric
 Civil Key Plan
 Electrical CableTray Isometric
 Electrical CableTray Key Plan
 Electrical Equipment Isometric
 Electrical Equipment Plan
 Electrical Instrument Plan
 Electrical Lighting Plan
 Equipment Isometric
 Equipment Key Plan
 HVAC Key Plan
 Instrument Isometric
 Instrument Key Plan
 Instrument Plan
 Piping Isometric Key
 Piping Isometric
 Piping Key Plan
 Piping Plan
 Structural Framing Isometric
 Structural Framing Key Plan

Drawings and Reports Reference Data Guide 959


Graphic Preparation Rules

In This Section
Civil Elevation ................................................................................ 961
Civil Overall Key Plan .................................................................... 961
Civil Plan ........................................................................................ 961
Electrical Above Ground Plan ........................................................ 961
Electrical CableTray Elevation ....................................................... 961
Electrical CableTray Layout Plan .................................................. 962
Electrical CableTray Overall Key Plan ........................................... 962
Electrical CableTray Plan .............................................................. 962
Electrical Equipment Elevation ...................................................... 962
Electrical Equipment Key Plan ...................................................... 962
Electrical Equipment Overall Key Plan .......................................... 963
Electrical Raceway Plan ................................................................ 963
Equipment Elevation ...................................................................... 963
Equipment Overall Key Plan .......................................................... 963
Equipment Plan ............................................................................. 963
HngSup - CAD Detail ..................................................................... 964
HngSup - End ................................................................................ 964
HngSup - End Style2 ..................................................................... 964
HngSup - Key Plan ........................................................................ 964
HngSup - Side Style2 .................................................................... 965
HVAC Elevation ............................................................................. 965
HVAC Isometric ............................................................................. 965
HVAC Overall Key Plan ................................................................. 965
HVAC Plan ..................................................................................... 966
Instrument Elevation ...................................................................... 966
Instrument Overall Key Plan .......................................................... 966
MHE_Member Details .................................................................... 966
Pipe Supports ................................................................................ 967
Piping Elevation ............................................................................. 967
Piping Fire Protection Plan ............................................................ 967
Piping Isometric Detail ................................................................... 967
Piping Overall Key Plan ................................................................. 967
Piping Safety Shower Plan ............................................................ 968
Piping Utility Station Plan............................................................... 968
SM_Electrical_Cable_Tray_Elevation ........................................... 968
SM_Electrical_Cable_Tray_Plan ................................................... 968
SM_Equipment_Plan ..................................................................... 969
SM_HVAC_Elevation..................................................................... 969
SM_HVAC_Plan ............................................................................ 970
SM_Lighting_Plan .......................................................................... 970
SM_Piping_Elevation ..................................................................... 970
SM_Piping_Plan ............................................................................ 971
Structural Framing Elevation ......................................................... 971
Structural Framing Plan ................................................................. 971

Drawings and Reports Reference Data Guide 960


Graphic Preparation Rules

Civil Elevation
Filter Name Custom Module

Control Point Structure Make Drawable (on page


1004)

Civil Overall Key Plan


Filter Name Custom Module

Civil Plan Volumes Volume Wire Frame (on


page 1041)

Civil Plan
Filter Name Custom Module

Control Point Structure Make Drawable (on page


1004)

Electrical Above Ground Plan


Filter Name Custom Module

Cable Tray Supports Make Drawable (on


page 1004)
Cabling

Electrical CableTray Elevation


Filter Name Custom Module

Grid Plane Elevation Grid Line (on page 1004)

Cable Tray Supports Make Drawable (on page 1004)

Drawings and Reports Reference Data Guide 961


Graphic Preparation Rules

Electrical CableTray Layout Plan


Filter Name Custom Module

Cable Tray Supports Make Drawable (on


page 1004)
Cabling

Electrical CableTray Overall Key Plan


Filter Name Custom Module

Electrical CableTray Plan Volumes Volume Wire Frame (on


page 1041)

Electrical CableTray Plan


Filter Name Custom Module

Cable Tray Supports Make Drawable (on


page 1004)
Cabling

Electrical Equipment Elevation


Filter Name Custom Module

Grid Plane Elevation Grid Line (on page 1004)

Electrical Equipment Key Plan


Filter Name Custom Module

Drawing Volumes Volume Wire Frame (on


page 1041)

Drawings and Reports Reference Data Guide 962


Graphic Preparation Rules

Electrical Equipment Overall Key Plan


Filter Name Custom Module

Electrical Equipment Plan Volumes Volume Wire Frame (on


page 1041)

Electrical Raceway Plan


Filter Name Custom Module

Cableways Make Drawable (on


page 1004)

Equipment Elevation
Filter Name Custom Module

Grid Plane Elevation Grid Line (on page 1004)

Equipment Overall Key Plan


Filter Name Custom Module

Equipment Plan Volumes Volume Wire Frame (on


page 1041)

Equipment Plan
Filter Name Custom Module

Control Point Process Equipment Make Drawable (on


page 1004)
Control Point Structure

Control Point Mechanical Equipment

Drawings and Reports Reference Data Guide 963


Graphic Preparation Rules

HngSup - CAD Detail


Filter Name Custom Module

Control Point CAD Detail Make Drawable (on


page 1004)

HngSup - End
Filter Name Custom Module

Support Assembly Make Drawable (on


page 1004)

Control Point Elevation Callout Replace With Point


(on page 1024)
Control point Ad Hoc Note

Control Point Structure

HngSup - End Style2


Filter Name Custom Module

Support Assembly Make Drawable (on


page 1004)
Control Point Elevation Callout

Control point Ad Hoc Note

Support Dimension Points

HngSup - Key Plan


Filter Name Custom Module

Support Assembly Replace With Point (on


page 1024)

Drawings and Reports Reference Data Guide 964


Graphic Preparation Rules

HngSup - Side Style2


Filter Name Custom Module

Support Assembly Make Drawable (on


page 1004)
Control Point Elevation Callout

Control point Ad Hoc Note

Support Dimension Points

HVAC Elevation
Filter Name Custom Module

Grid Plane Elevation Grid Line (on page 1004)

Duct Supports Make Drawable (on page 1004)

HVAC Isometric
Filter Name Custom Module

Duct Supports Make Drawable (on


page 1004)
HVAC Runs

HVAC Overall Key Plan


Filter Name Custom Module

HVAC Plan Volumes Volume Wire Frame (on


page 1041)

Drawings and Reports Reference Data Guide 965


Graphic Preparation Rules

HVAC Plan
Filter Name Custom Module

HVAC Runs Make Drawable (on


page 1004)

Instrument Elevation
Filter Name Custom Module

Pipe Supports Make Drawable (on page 1004)

Grid Plane Elevation Grid Line (on page 1004)

Instrument Overall Key Plan


Filter Name Custom Module

Instrument Plan Volumes Volume Wire Frame (on


page 1041)

MHE_Member Details
This custom graphic rule is only available when you are using the material handling
mode.

Filter Name Custom Module

Member Part Prismatic Make Drawable (on page 1004)

Drawings and Reports Reference Data Guide 966


Graphic Preparation Rules

Pipe Supports
Filter Name Custom Module

Control Point Structure Replace With Point


(on page 1024)

Support Assembly Make Drawable (on


page 1004)

Piping Elevation
Filter Name Custom Module

Grid Plane Elevation Grid Line (on page 1004)

Piping Fire Protection Plan


Filter Name Custom Module

Control Point Structure Make Drawable (on


page 1004)

Piping Isometric Detail


Filter Name Custom Module

Piping Parts equal to or less than 4in NPD-2 Elbow To Arc (on
page 987)

Piping Overall Key Plan


Filter Name Custom Module

Piping Plan Volumes Volume Wire Frame (on


page 1041)

Drawings and Reports Reference Data Guide 967


Graphic Preparation Rules

Piping Safety Shower Plan


Filter Name Custom Module

Control Point Structure Make Drawable (on


page 1004)

Piping Utility Station Plan


Filter Name Custom Module

Control Point Structure Make Drawable (on


page 1004)

SM_Electrical_Cable_Tray_Elevation
Filter Name Custom Module

Root Longitudinal Bulkhead Plate Make Drawable (on page 1004)


Systems

Root Transverse Bulkhead Plate Systems Make Drawable (on page 1004)

Root Deck Plate Systems Make Drawable (on page 1004)

All Root Profile System Make Drawable (on page 1004)

Cableway Make Drawable (on page 1004)

Grid Plane Elevation Plane Geometry (on page 1011)

SM_Electrical_Cable_Tray_Plan
Filter Name Custom Module

Root Longitudinal Bulkhead Plate Make Drawable (on page 1004)


Systems

Root Transverse Bulkhead Plate Systems Make Drawable (on page 1004)

Root Deck Plate Systems Make Drawable (on page 1004)

All Root Profile Systems Make Drawable (on page 1004)

Cableway Make Drawable (on page 1004)

Drawings and Reports Reference Data Guide 968


Graphic Preparation Rules

SM_Equipment_Plan
Filter Name Custom Module

Root Longitudinal Bulkhead Plate Systems Make Drawable (on page 1004)

Root Transverse Bulkhead Plate Systems Make Drawable (on page 1004)

Root Deck Plate Systems Make Drawable (on page 1004)

All Root Profile Systems Make Drawable (on page 1004)

SM_HVAC_Elevation
Filter Name Custom Module

Root Longitudinal Bulkhead Plate Make Drawable (on page 1004)


Systems

Root Transverse Bulkhead Plate Make Drawable (on page 1004)


Systems

Root Deck Plate Systems Make Drawable (on page 1004)

All Root Profile Systems Make Drawable (on page 1004)

HVAC Runs Make Drawable (on page 1004)

Grid Plane Elevation Plane Geometry (on page 1011)

Drawings and Reports Reference Data Guide 969


Graphic Preparation Rules

SM_HVAC_Plan
Filter Name Custom Module

Root Longitudinal Bulkhead Plate Systems Make Drawable (on page 1004)

Root Transverse Bulkhead Plate Systems Make Drawable (on page 1004)

Root Deck Plate Systems Make Drawable (on page 1004)

All Root Profile Systems Make Drawable (on page 1004)

HVAC Runs Make Drawable (on page 1004)

SM_Lighting_Plan
Filter Name Custom Module

Root Longitudinal Bulkhead Plate Systems Make Drawable (on page 1004)

Root Transverse Bulkhead Plate Systems Make Drawable (on page 1004)

Root Deck Plate Systems Make Drawable (on page 1004)

All Root Profile Systems Make Drawable (on page 1004)

SM_Piping_Elevation
Filter Name Custom Module

Root Longitudinal Bulkhead Plate Make Drawable (on page 1004)


Systems

Root Transverse Bulkhead Plate Make Drawable (on page 1004)


Systems

Root Deck Plate Systems Make Drawable (on page 1004)

All Root Profile Systems Make Drawable (on page 1004)

Piping Runs Make Drawable (on page 1004)

Grid Plane Elevation Plane Geometry (on page 1011)

Drawings and Reports Reference Data Guide 970


Graphic Preparation Rules

SM_Piping_Plan
Filter Name Custom Module

Root Longitudinal Bulkhead Plate Systems Make Drawable (on page 1004)

Root Transverse Bulkhead Plate Systems Make Drawable (on page 1004)

Root Deck Plate Systems Make Drawable (on page 1004)

All Root Profile Systems Make Drawable (on page 1004)

Piping Runs Make Drawable (on page 1004)

Structural Framing Elevation


Filter Name Custom Module

Grid Plane Elevation Grid Line (on page 1004)

Structural Framing Plan


Filter Name Custom Module

Openings Make Drawable (on page 1004)

Slabs Volume Wire Frame (on page 1041)

Control Point Structure Make Drawable (on page 1004)

Drawings and Reports Reference Data Guide 971


SECTION 14

Custom Graphic Modules


Graphic preparation rules use custom graphic rule modules to determine the display of objects
passing the view style tests. Objects can be displayed as Vector Hidden Line (VHL) or
resymbolized. You specify graphic modules within graphic rules as part of the view style
definition. For more information, see Custom Graphic Rule Dialog Box (on page 68).

Subfilters
Subfilters are included with some of the delivered custom graphic modules. The subfilters allow
you to customize the graphic representation of objects at a granular level. You can apply a
subfilter by first specifying a normal filter in the Define View Style dialog box. After specifying a
filter, you use the following syntax to define a subfilter:
<Filter Name>::<Subfilter Name>
Subfilters are not compatible with all custom graphic rule modules.

In This Section
Create a View Style with Resymbolized Normal Pipes ................. 974
Create a View Style with Single Line Pipes ................................... 977
Actual 3D Geometry ...................................................................... 982
Beam Part ...................................................................................... 982
Bracket with Flange ....................................................................... 982
Built-up Member To Parts .............................................................. 984
Capped Normal Pipe ..................................................................... 984
Clipped Geometry With Volume .................................................... 985
Default Graphics ............................................................................ 985
Design Equipment Part Separator ................................................. 986
Drawable Default Graphics ............................................................ 987
Elbow To Arc ................................................................................. 987
Elbow To Single Arc ...................................................................... 988
Enumerate Equipment Graphic Children ....................................... 988
Enumerate Hanger Graphic Children ............................................ 990
Equipment Nozzle Separator ......................................................... 992
Exclude .......................................................................................... 993
Extended Structure Geometry ....................................................... 996
Generic Line .................................................................................. 996
Generic Plate Anti-Molded Side .................................................... 997
Generic Plate Anti-Molded Side Without Features ........................ 997
Generic Plate Both Sides Without Features .................................. 997
Generic Plate Molded Side ............................................................ 997
Generic Plate Molded Side Without Features ............................... 998
Generic Stiffener Extended Geometry........................................... 998
Generic Stiffener Landing Curve ................................................... 998
Generic Stiffener Web Left ............................................................ 999
Generic Stiffener with Flange ........................................................ 999
Grid Line ........................................................................................ 1004
Grid Plane ...................................................................................... 1004

Drawings and Reports Reference Data Guide 972


Custom Graphic Modules

Logical Connection to Intersection Seam ...................................... 1004


Make Drawable .............................................................................. 1004
Make Drawable Assembly ............................................................. 1005
Make Drawable Simple .................................................................. 1006
Manufacturing Margin .................................................................... 1006
Manufacturing Shrinkage ............................................................... 1006
Member Centerline ........................................................................ 1007
Opening ......................................................................................... 1007
Opening To X ................................................................................. 1008
Pipe Turn Feature To Arc .............................................................. 1010
Plane Geometry ............................................................................. 1011
Plate Anti-Molded Side .................................................................. 1011
Plate Anti-Molded Side Without Features ...................................... 1011
Plate Both Sides Without Features ................................................ 1011
Plate Contour ................................................................................. 1012
Plate Molded Side .......................................................................... 1013
Plate Molded Side Without Features ............................................. 1013
Plate Molded Surface .................................................................... 1013
Plate Outer Contour ....................................................................... 1014
Plate Part ....................................................................................... 1015
Plate System .................................................................................. 1016
Ports Separator .............................................................................. 1017
Profile Cross Section ..................................................................... 1018
Profile Knuckle As Curve ............................................................... 1019
Profile Part ..................................................................................... 1019
Profile System ................................................................................ 1020
Profile System Cross Section ........................................................ 1021
Range Center ................................................................................ 1022
Replace Sloped Pipe On Hanger .................................................. 1022
Replace With Point ........................................................................ 1024
Route Component Centerline ........................................................ 1025
Rulers – Axis .................................................................................. 1026
Rulers – Reference Plane.............................................................. 1026
Seam .............................................................................................. 1026
Simple Volume To X ...................................................................... 1027
Sloped Pipe With Arc Symbol ........................................................ 1027
Std Member With Flange ............................................................... 1028
Std Member With Web................................................................... 1028
Stiffener With Flange ..................................................................... 1029
Structural Transient Ports .............................................................. 1040
Trench Parts Ports ......................................................................... 1040
Trim Pipe Surface .......................................................................... 1041
Volume Wire Frame ....................................................................... 1041
Weld To Line .................................................................................. 1042

Drawings and Reports Reference Data Guide 973


Custom Graphic Modules

Create a View Style with Resymbolized Normal Pipes


Several of the delivered drawing view styles resymbolize pipes that are oriented normal to the
view. When creating custom view styles, you can also apply the resymbolization graphic rule to
these normal pipes.
The following model and volume is used as an example in this workflow to produce a drawing
that resymbolizes pipes that are oriented normal to the view.

Create a New View Style


1. In the Drawings and Reports task, click Tools > Define View Style.
2. In the Define View Style dialog box, click New Style .
3. Enter a name for the new view style. In this example, the view style name is Piping Normal
Resymbolize.
4. Edit the view style by either double-clicking it or click Properties .
5. In the Filter Behavior box, select Filters determine which objects are process (Volume).
6. In the Intersection Edges box, select Off.
In this example, only piping parts are included in the view style. There is no limit to
the number of filters you can add to a view style, but the ordering of the filters is important. For
more information on the order of filters in a view style, see Drawing View Style Creation Process
(on page 371).

Drawings and Reports Reference Data Guide 974


Custom Graphic Modules

Configure the View Style Filters and Graphic Rules


1. In the first row, select the Piping\Piping Parts filter and apply the Piping Plan_Piping
graphic rule.
2. In the second row, select the Piping\Piping Features\Piping Straight filter and select
Normal for the Primary Orientation.
3. In the Graphic Rule box, click More.
a. In the Select Graphic Rule dialog box, select Replace Object(s) with Symbol in the
Graphic Rule Type box.
b. Click New.
The Graphic Rule - Symbol dialog box displays.
c. Type a name for the new graphic rule in the Rule Name box. In this example, the
graphic rule is named Piping Plan_Normal Pipe Front.
d. Select FrontClipPipe1.sym for the Symbol.
e. In the Orientation box, select Orients as Replaced Object Did, and click OK.
f. Select the new graphic rule in the Select Graphic Rule dialog box, and click OK.
4. In the third row, select the Piping\Piping Parts\Piping Components filter and type ::Ports
after the filter name.
5. Select the graphic rule created in step 3 from the Graphic Rule box. If it is not displayed,
select More and navigate to the graphic rule in the Select Graphic Rule dialog box.
Refer to the graphic below for an example of the finished Tests and Actions for the
view style.

Create a New Graphic Preparation Rule


1. In the Graphic Preparation Rules box, select More.
2. In the Select Graphic Preparation Rule dialog box, click New.
3. Type text in the Rule Name box. In this example, Piping Normal is used.
4. In the first row, select the Piping\Piping Parts\Piping Components filter in the Filter
Name box.
5. In the Custom Module box, select PortsSeparator.dll.
6. In the second row, select More in the Filter Name box.

a. In the Select Filter dialog box, click New SQL Filter .


b. Type text in the Name box of the New SQL Filter Properties dialog box. In this
example, Piping Ports is used.
c. On the General tab, enter select oid from JDPipePort in the Text of SQL query box.
d. Click OK.
e. Select the Piping Ports filter from the <IndustryType> Filters section, and click OK.
7. In the Custom Module box, select MakeDrawable.dll.

Drawings and Reports Reference Data Guide 975


Custom Graphic Modules

8. In the third row, select the Piping\Piping Features\Piping Straight filter in the Filter Name
box.
9. In the Custom Module box, select MakeDrawable.dll, and click OK.
10. Select the Piping Normal rule in the Select Graphic Preparation Rule dialog box, and
click OK.
11. Click OK on the View Style Properties dialog box.
Below is a graphic of the finished view style.

After creating and updating a drawing that uses the Piping Normal Resymbolize view style, the
drawing output is similar to the graphic below.

See Also
View Style Rules (on page 57)
Define View Style Command (Tools Menu) (on page 56)
Custom Graphic Rule Dialog Box (on page 68)
Custom Graphic Modules (on page 972)

Drawings and Reports Reference Data Guide 976


Custom Graphic Modules

Create a View Style with Single Line Pipes


Using graphic rules to resymbolize objects in a drawing saves paper space and improves
readability of drawings. In the case of piping, you can resymbolize piping parts into single lines,
discs, and arcs.
The following model is used as an example in this workflow to produce a drawing that
resymbolizes pipes of a certain size into single lines.

To create a view style that resymbolizes pipes of a particular diameter into single lines, follow
the four procedures provided below.

Create a New View Style


1. In the Drawings and Reports task, click Tools > Define View Style.
2. In the Define View Style dialog box, click New Style .
3. Type a name for the new view style. In this example, the view style name is Single Line
Piping.
4. Edit the Single Line Piping view style by either double-clicking it or clicking the Properties
.
5. In the Filter Behavior box, select the Filters determine which objects are processed
(Volume).
6. In the Intersection Edges box, select Off.

Drawings and Reports Reference Data Guide 977


Custom Graphic Modules

7. Check Preserve Z Order.


In this example, only equipment objects and piping parts are included in the view
style. There is no limit to the number of filters you can add to a view style, but the order of
the filters is important. For more information on the order of filters in a view style, see
Drawing View Style Creation Process (on page 371).

Configure the View Style Filters and Graphic Rules


1. In the first row, select the Piping\Piping Parts filter and apply the Piping Plan_Piping
graphic rule.
2. In the second row, select the Piping\Piping Parts equal to or less than 50mm NPD filter
and click More in the graphic rule.
a. In the Select Graphic Rule dialog box, select Replace Object(s) with Line in the
Graphic Rule Type box, and click New.
b. In the Graphic Rule - Line dialog box, type a name for the new rule in the Rule Name
box. In this example, the graphic rule is named Piping Plan_Small Pipe_SingleLine.
c. Select a Visible Line Style for the graphic rule. In this example, the Visible Line Style
is Mask Blue.
d. Click OK.
e. Select the new graphic rule in the Select Graphic Rule dialog box and click OK.
3. In the third row, select the Piping\Piping Parts equal to or less than 50mm NPD filter and
select Sloped for the Primary Orientation.
This view style row changes the color of pipes that are sloped to indicate pipe
slope in plan views.
a. In the Graphic Rule box, select More.
b. In the Select Graphic Rule dialog box, select Piping Plan_Piping and click
Properties.
c. In the Graphic Rule - VHL dialog box, type a new name for the graphic rule. In this
example, the new graphic rule is named Piping Plan_Piping Red.
d. Select Simple physical in the Aspect box and check Show aspect.
e. In the Graphic Module box, select SlopedPipeWArcSymbol.dll.
f. Select Normal Red for the Visible Line Style.
g. Make sure the Hidden, Hidden By Self, and Occluded Line Styles are Not Drawn.
h. Click OK.
i. Select the Piping Plan_Piping Red graphic rule in the Select Graphic Rule dialog box,
and click OK.
4. In the fourth row, select the Piping\Piping Parts filter and type ::Discs after the filter name.
The Discs subfilter selects the discs used to resymbolize the ports on piping
elbows.
a. Select More in the Graphic Rule box.

Drawings and Reports Reference Data Guide 978


Custom Graphic Modules

b. In the Select Graphic Rule box, select the Piping Plan_Piping Red filter that you
created earlier.
c. In the Graphic Rule - VHL dialog box, type a new name for the filter in the Name box.
In this example, Piping Plan_Piping Discs is used.
d. Select Normal Green for the Visible Line Style and click OK.
e. Select the Piping Plan_Piping Discs graphic rule in the Select Graphic Rule dialog
box, and click OK.
5. In the fifth row, select the Piping\Piping Parts filter and enter ::Arc after the filter name.
The Arc subfilter selects the arc used to resymbolize the bend in a piping elbow.
a. Select More in the Graphic Rule box.
b. In the Select Graphic Rule box, select the Piping Plan_Piping Red filter that you
created earlier.
c. In the Graphic Rule - VHL dialog box, type a new name for the filter in the Name box.
In this example, Piping Plan_Piping Arc is used.
d. Select Normal Blue for the Visible Line Style, and click OK.
e. Select the Piping Plan_Piping Discs graphic rule in the Select Graphic Rule dialog
box and click OK.
Refer to the graphic below for an example of the finished Tests and Actions for the
view style.

Create a New Graphic Preparation Rule


1. In the Graphic Preparation Rules box, select More.
2. In the Select Graphic Preparation Rule dialog box, click New.
3. Type a new name in the Rule Name box. In this example, Single Line Piping is used.
4. Select the Piping\Piping Parts filter in the Filter Name box.
5. In the Custom Module box, select ElbowToArc.dll.
6. Click OK.
7. Select the Single Line Piping rule in the Select Graphic Preparation Rule dialog box and
click OK.
8. Click OK on the View Style Properties dialog box.
When finished, the graphic preparation rule should like the following example:

Drawings and Reports Reference Data Guide 979


Custom Graphic Modules

Below is a graphic of the finished view style.

Create a Drawing Using the Single Line Piping View Style


1. Create a Composed drawing of a volume that contains piping that is less than or equal to
50mm NPD. Be sure to use the Single Line Piping view style for the drawing view.
2. Update the drawing view.
Only pipes, pipe bends, and pipe elbows that are equal to or less than 50mm are
resymbolized. Piping components, reducers, etc. are not resymbolized.
The following examples show single line piping drawings that includes the Plan, Elevation, and
Isometric view directions.

Plan

Drawings and Reports Reference Data Guide 980


Custom Graphic Modules

Elevation

Isometric

Elbows are resymbolized into a pair of discs connected by an arc. In plan views, a pipe with a
normal orientation is represented as a flat disc (a circle) with the top pipe extending into the
middle of the disc. See the example below.

See Also
View Style Rules (on page 57)
Define View Style Command (Tools Menu) (on page 56)
Custom Graphic Rule Dialog Box (on page 68)
Custom Graphic Modules (on page 972)

Drawings and Reports Reference Data Guide 981


Custom Graphic Modules

Actual 3D Geometry
Orthographic graphic module: GetActual3DGeometry.dll
Rule set graphic module: Actual 3D Geometry
Returns the actual geometry of an object by referring to the original model object for all
geometry. For example, you can use this module to disable the default representation of welds.
By default, welds are represented as a single line. This custom graphic module graphically
represents the welds as they display in the model.

Beam Part
Orthographic graphic module: BeamPartDrawingWrapperEntity.dll
Rule set graphic module: Beam Part
Replaces beams with single lines at the beam centerlines.

Bracket with Flange


Orthographic graphic module: GenericStiffenerWrapper.dll
Rule set graphic module: Bracket with Flange
Extracts the flange of a flanged bracket and customizes the way it is resymbolized in a drawing.
The delivered parameters are defined in the Bracket with Flange.xml file, located in the
[Reference Data Folder]\SharedContent\Drawings\Catalog\Rules\DBRRules\Resymbolization
folder.

Drawings and Reports Reference Data Guide 982


Custom Graphic Modules

You can define location offset with respect to the tangent edge on the flanged bracket.

Referenced from Edges


The XML is in the following format:
<?xml version="1.0" encoding="UTF-8"?>
<WRAPPERS>
<WRAPPER type="GRAPHICWRAPPER">
<DESCRIPTION>Graphic wrapper that extracts a Bracket's
flange</DESCRIPTION>
<SOURCE>GenericStiffenerWrapper.dll</SOURCE>
<CUSTOM>
<COMPONENTS>
<GRAPHIC Location="0.01"></GRAPHIC>
</COMPONENTS>
</CUSTOM>
</WRAPPER>
</WRAPPERS>
Location
Indicates the relative location (along the length of the geometry) on which to draw the flange
line. In the example below, flange line is sloped and is drawn at 0.01 from its original
location (represented in red), away from the top edge.

Drawings and Reports Reference Data Guide 983


Custom Graphic Modules

<GRAPHIC Location="0.01"></GRAPHIC>

Built-up Member To Parts


Orthographic graphic module: BUPMemberToPartsWrapperEntity.dll
Rule set graphic module: Built-up Member To Parts
Separates a built-up members into its web and flange plate parts. This module is automatically
used when the VHL graphic rule draws the simple physical aspect of a built-up member part. For
more information, see Visible/Hidden Edges (VHL) (on page 734).

Capped Normal Pipe


Orthographic graphic module: CappedNormalPipe.dll
Rule set graphic module: Capped Normal Pipe
Replaces the straight pipes positioned "normal to the view" with a cylindrical cap in the center of
the length of the pipe. You can use this graphic rule if the open (unclipped) ends of the pipe
should be replaced with a symbol.
This graphic module is typically used in a view style that uses Piping Components as the filter.

Piping Elevation View Style

Drawings and Reports Reference Data Guide 984


Custom Graphic Modules

Piping Elevation View Style with CappedNormalPipe Custom Graphic Rule

Clipped Geometry With Volume


Orthographic graphic module: GetClippedGeometryWithVolume.dll
Rule set graphic module: Clipped Geometry With Volume
Extracts the geometry of an object and clips it with the volume of the view.

Default Graphics
Orthographic graphic module: DefaultGraphics.dll
Rule set graphic module: Default Graphics
Prevents the following issues that can occur with manually-placed dimensions:
 During view update, the dimensions are sometimes deleted or move to a different location.
 The update of a view takes longer than it should.
You can apply this custom graphic module to an object type that exhibits these behaviors. When
you update the view, manual dimensions associated to the object type lose associations to the
type and do not move. The manual dimension maintain associations to other object types.
You can also use Default Graphics to gain an improvement in view update performance when
there are no manual dimensions.

Background
The software assigns a unique identifier to every graphic element in a view. For some elements,
the software does not always assign the same identifier when a view is updated. For manual
dimensions to properly update, these identifiers cannot change. If all identifiers for a dimension
cannot be found on a newly updated view, the dimension is deleted. If an identifier is placed on
a different graphic, the dimension moves.

Drawings and Reports Reference Data Guide 985


Custom Graphic Modules

Design Equipment Part Separator


Orthographic graphic module: DesignEquipmentPartSeparator.dll
Rule set graphic module: Design Equipment Part Separator
Separates design equipment into body (first shape placed), shapes, nozzles, and parts (child
components). You can use this module to label and symbolize nozzles on design equipment.
To use this module, apply it to the graphic preparation rules in a view style that uses Design
Equipment as the filter. After this is done, you can add a row to the view style to filter specifically
for Pipe Nozzles.
The graphic below shows the difference between the default view style and one using the
graphic rule:

For a graphic rule that performs the same operation for general equipment, use Equipment
Nozzle Separator (on page 992).

Subfilters
To change the graphic representation of shapes, nozzles, or parts when this custom graphic rule
is applied, you can apply subfilters to the individual parts.
Shapes
Use this subfilter to apply a graphic rule (line style, color, etc.) to the shapes of process
equipment. Use this syntax: <Filter Name>::Shapes.
Nozzles
Use this subfilter to apply a graphic rule (line style, color, etc.) to the nozzles on process
equipment. Use this syntax: <Filter Name>::Nozzles.
Parts
Use this subfilter to apply a graphic rule (line style, color, etc.) to the parts on process
equipment. Use this syntax: <Filter Name>::Parts.

Drawings and Reports Reference Data Guide 986


Custom Graphic Modules

Drawable Default Graphics


Orthographic graphic module: None
Rule set graphic module: Drawable Default Graphics
Uses the Default Graphics (on page 985) graphic module to prevent the deletion or moving of
manual dimensions after a view update.
Additionally, Drawable Default Graphics provides a method to label an entire assembly instead
of the individual assembly components, similar to the method used by Make Drawable Simple
(on page 1006).

Elbow To Arc
Orthographic graphic module: ElbowtoArc.dll
Rule set graphic module: Elbow To Arc
Replaces 3D elbows with arcs for the body and discs for the two ports. You use this graphic
module when piping elbows should be represented as a single line, but the ends of the piping
need to be shown.
To use this module, apply it as a graphic preparation rule to a view style that uses Piping
Components as the filter.

Subfilters
To change the graphic representation of the arcs and discs, you can apply subfilters.
Arc
Use this subfilter to apply a graphic rule (line style, color, etc.) to the arcs in a drawing. Use
this syntax: <Piping Parts filter>::Arc.
Discs
Use this subfilter to apply a graphic rule (line style, color, etc.) to the discs in a drawing. Use
this syntax: <Piping Parts filter>::Discs.
The graphic below shows how the graphic rule impacts the drawing:

Drawings and Reports Reference Data Guide 987


Custom Graphic Modules

Elbow To Single Arc


Orthographic graphic module: ElbowtoSingleArc.dll
Rule set graphic module: Elbow To Single Arc
Replaces 3D elbows with arcs. You use this graphic module when piping elbows should be
represented as a single line.
To use this module, apply it as a graphic preparation rule to view style that uses Piping
Components as the filter.
The graphic below shows how the graphic rule impacts the drawing:

Enumerate Equipment Graphic Children


Orthographic graphic module: EnumerateEquipmentGraphicChildren.dll
Rule set graphic module: Enumerate Equipment Graphic Children
Includes all of the children of the Equipment System in the drawing. This graphic module applies
to Equipment objects.
1. Create a view style and apply a Graphic Preparation Rule against Equipment objects.
2. On the View Style Properties dialog box, select More in the Graphic Preparation Rule
box to display the Select Custom Rule dialog box.

Drawings and Reports Reference Data Guide 988


Custom Graphic Modules

3. Click New to create a new EnumerateEquipmentGraphicChildren rule.

Then, in the Tests section of the View Style Properties dialog box, apply filter rows for the
objects required in the drawing. For example, you could filter for Pipe Nozzles, Foundation
Ports, and Shapes, with an additional Piping filter to include piping attached to the nozzles:

The drawing output would resemble the following graphic:

The graphics output by the view style in the drawing depend on the filters you specify and the
graphic rules applied.

Subfilters
To change the graphic representation of individual objects that make up a piece of equipment
when the EnumerateEquipmentGraphicChildren custom graphic module is applied, you can
apply subfilters to the individual parts.

Drawings and Reports Reference Data Guide 989


Custom Graphic Modules

ForeignChildren
Use this subfilter to apply a graphic rule (line style, color, etc.) to foreign children in
equipment. Use this syntax: <Filter Name>::ForeignChildren.
Equipment
Use this subfilter to apply a graphic rule (line style, color, etc.) to equipment. Use this
syntax: <Filter Name>::Equipment.
Shapes
Use this subfilter to apply a graphic rule (line style, color, etc.) to shapes. Use this syntax:
<Filter Name>::Shapes.
FoundationPorts
Use this subfilter to apply a graphic rule (line style, color, etc.) to equipment foundation
ports. Use this syntax: <Filter Name>::FoundationPorts.
PipeNozzles
Use this subfilter to apply a graphic rule (line style, color, etc.) to equipment pipe nozzles.
Use this syntax: <Filter Name>::PipeNozzles.
ConduitNozzles
Use this subfilter to apply a graphic rule (line style, color, etc.) to equipment conduit nozzles.
Use this syntax: <Filter Name>::ConduitNozzles.
HvacNozzles
Use this subfilter to apply a graphic rule (line style, color, etc.) to equipment HVAC nozzles.
Use this syntax: <Filter Name>::HvacNozzles.
CableNozzles
Use this subfilter to apply a graphic rule (line style, color, etc.) to equipment cable nozzles.
Use this syntax: <Filter Name>::CableNozzles.
CableTrayNozzles
Use this subfilter to apply a graphic rule (line style, color, etc.) to equipment cabletray
nozzles. Use this syntax: <Filter Name>::CableTrayNozzles.

Enumerate Hanger Graphic Children


Orthographic graphic module: EnumerateHgrSupGraphicChildren.dll
Rule set graphic module: Enumerate Hanger Graphic Children
Includes all of the children of the Supports System in the drawing. This graphic module applies
to Support objects.
1. Create a view style and apply a Graphic Preparation Rule against Support objects.
2. On the View Style Properties dialog box, select More in the Graphic Preparation Rule
box to display the Select Custom Rule dialog box.

Drawings and Reports Reference Data Guide 990


Custom Graphic Modules

3. Click New to create a new EnumerateHgrSupGraphicChildren rule.

Then, in the Tests section of the View Style Properties dialog box, apply filter rows for the
objects required in the drawing. For example, you could filter for Pipe Supports, with an
additional Piping filter to include piping attached to the supports:

The drawing output would resemble the following graphic:

The graphics output by the view style in the drawing depend on the filters you specify and the
graphic rules applied.

Drawings and Reports Reference Data Guide 991


Custom Graphic Modules

Equipment Nozzle Separator


Orthographic graphic module: EquipmentNozzleSeparator.dll
Rule set graphic module: Equipment Nozzle Separator
Separates equipment into body (first shape placed), shapes, nozzles, and parts (child
components). You can use this graphic rule to label and symbolize nozzles on equipment.
To use this module, apply it as a graphic preparation rule to a view style that uses Equipment as
the filter. After this is done, you can add a row to the view style to filter specifically for Pipe
Nozzles.
The graphic below shows the difference between the default view style and one using the
graphic rule:

For a graphic module that performs the same operation for design equipment, use Design
Equipment Part Separator (on page 986).

Subfilters
To change the graphic representation of the body or nozzles of equipment, you can apply
subfilters to the individual parts.
Body
Use this subfilter to apply a graphic rule (line style, color, etc.) to the body of equipment. Use
this syntax: <Filter Name>::Body.
Nozzles
Use this subfilter to apply a graphic rule (line style, color, etc.) to equipment nozzles. Use
this syntax: <Filter Name>::Nozzles.

Drawings and Reports Reference Data Guide 992


Custom Graphic Modules

Exclude
Orthographic graphic module: Exclude.dll
Rule set graphic module: Exclude
Excludes objects to which it is applied from view style processing. The example below shows
how you can use this graphic module in a view style.

In the example view style definition, the Piping Components are excluded from the drawing by
creating a Graphic Preparation Rule that calls the module.

The view style filters for Piping in general.

Drawings and Reports Reference Data Guide 993


Custom Graphic Modules

The output of this drawing excludes the elbows and in-line piping components:

Exclude with Not Drawn Rule


The Exclude custom graphic rule excludes objects to which it is applied from view style
processing. If you create a graphic rule to make certain components not drawn, they could hide
other objects in the drawing view. The following example shows how you can use the Exclude
in combination with Not Drawn in a view style.
The example uses the following volume of data:

In the View Style Properties dialog box below, Piping is selected as the filter, but another filter
specifies Not Drawn for Piping Components.

Drawings and Reports Reference Data Guide 994


Custom Graphic Modules

The Not Drawn graphic rule is a rule that states nothing that applies to this rule is drawn using
this view style. On the Graphic Rule - VHL dialog box, you would set all the values accordingly.

The output of this drawing displays as follows:

However, you can use the Exclude custom graphic rule to exclude the Piping Component
objects. On the Custom Graphic Rule dialog box, you could create a custom graphic
preparation rule called Exclude components.

Drawings and Reports Reference Data Guide 995


Custom Graphic Modules

When using the Exclude to customize the view style, the output displays as follows:

Notice that the elbows turning away from the view are drawn using Exclude and not drawn by
the Not Drawn graphic rule because they were hidden.

Extended Structure Geometry


Orthographic graphic module: StructExtendedGeometryWrapperEntity.dll
Rule set graphic module: Extended Structure Geometry
Extracts the extended geometry of a structural object.

Generic Line
Orthographic graphic module: GenericLineWrapperEntity.dll
Rule set graphic module: Generic Line
Replaces linear objects in the graphic view, such members, with single lines. If possible, the
centerline of the object is used.
This module works similarly to Replace Objects with Line (on page 732).

Drawings and Reports Reference Data Guide 996


Custom Graphic Modules

Generic Plate Anti-Molded Side


Orthographic graphic module: None
Rule set graphic module: Generic Plate Anti-Molded Side
Replaces a plate part with its anti-molded side.
For a description of plate sides, see Molded Conventions for Plate Parts (on page
240).

Generic Plate Anti-Molded Side Without Features


Orthographic graphic module: None
Rule set graphic module: Generic Plate Anti-Molded Side Without Features
Replaces a plate part with its anti-molded side. Features on the plate are not included.
For a description of plate sides, see Molded Conventions for Plate Parts (on page
240).

Generic Plate Both Sides Without Features


Orthographic graphic module: None
Rule set graphic module: Generic Plate Both Sides Without Features
Replaces a plate part with its molded and anti-molded sides. Features on the plate are not
included.
For a description of plate sides, see Molded Conventions for Plate Parts (on page
240).

Generic Plate Molded Side


Orthographic graphic module: None
Rule set graphic module: Generic Plate Molded Side
Replaces a plate part with its molded side.
For a description of plate sides, see Molded Conventions for Plate Parts (on page
240).

Drawings and Reports Reference Data Guide 997


Custom Graphic Modules

Generic Plate Molded Side Without Features


Orthographic graphic module: None
Rule set graphic module: Generic Plate Molded Side Without Features
Replaces a plate part with its molded side. Features on the plate are not included.
For a description of plate sides, see Molded Conventions for Plate Parts (on page
240).

Generic Stiffener Extended Geometry


Orthographic graphic module: None
Rule set graphic module: Generic Stiffener Extended Geometry
Extracts the extended geometry of a profile part. The software extends profile geometry to
determine intersections and end cuts.

Generic Stiffener Landing Curve


Orthographic graphic module: None
Rule set graphic module: Generic Stiffener Landing Curve
Extracts the profile part landing curve and sends the geometry to the drawing view.
You can add the AddSolidForVHL flag to prevent landing curves from hiding other landing
curves when they are drawn.
The XML is in the following format:
<SECTION Type="*" AddSolidForVHL="FALSE">
<COMPONENTS>
<!-- the aspect for landing curve is not bulkloaded -->
<ASPECT Number="15" VHLOffset="0.2"></ASPECT>
</COMPONENTS>
</SECTION>
For example, in the model, the profile is below the plate:

Drawings and Reports Reference Data Guide 998


Custom Graphic Modules

On the drawing view, the landing curve of the profile part is drawn:

Generic Stiffener Web Left


Orthographic graphic module: None
Rule set graphic module: Generic Stiffener Web Left
Replaces a profile part with its web left geometry.

Generic Stiffener with Flange


Orthographic graphic module: None
Rule set graphic module: Generic Stiffener With Flange
Extracts the web and flange of a profile part and customizes their resymbolization in a drawing.
Parameters for resymbolization can be defined for each cross-section type. The delivered
parameters are defined in Generic Stiffener With Flange.xml, located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DBRRules\Resymbolization folder.
You can define parameters with respect to edges on the profile cross-section or by a geometry
aspect type.

Referenced from Edges


The XML is in the following format:
<SECTION Type="UA">
<COMPONENTS>
<!-- web -->
<GRAPHIC Geometry="WEB_LEFT" Extend="FALSE" NTSReference=""
NTSOffset="0.0"></GRAPHIC>
<!-- flanges -->
<GRAPHIC Geometry="TOP_FLANGE_RIGHT_BOTTOM" Extend="FALSE"
Location="0.25" NTSReference="WEB_LEFT"
NTSOffset="0.1"></GRAPHIC>
</COMPONENTS>
</SECTION>

Drawings and Reports Reference Data Guide 999


Custom Graphic Modules

Geometry
Specifies the edge name of the profile geometry from which other parameters are
referenced. For more information on the available edge names, see Cross-Section Edge
Names (on page 1034). The most commonly used edge names are shown in the following
example.

Extend
If True, specifies the extension of the geometry to the limits of the cross-section. In the
example below, WEB_LEFT extends to TOP and BOTTOM. If Extend is not specified, the
default value is False.

Location
Indicates the relative location (along the length of the geometry) on which to draw the
geometry. In the example below, Geometry TOP_FLANGE_RIGHT_BOTTOM is sloped
and is drawn at 0.25 along its length.
<GRAPHIC Geometry="TOP_FLANGE_RIGHT_BOTTOM" Extend="FALSE"

Drawings and Reports Reference Data Guide 1000


Custom Graphic Modules

Location="0.25"></GRAPHIC>

This is an optional value and should not be included when it is not needed to avoid
unnecessary calculations in the software.
NTSReference
Specifies the reference geometry acting as an axis along which the NTSOffset value is
measured.
NTSOffset
Specifies the relative amount to offset the geometry along the reference geometry defined
by NTSReference. The relative amount is a value between 0 (located at the geometry) and
1 (located at the limits of the cross-section in the direction of the reference geometry). As a
result, the drawn geometry is not-to-scale but is easier to see. In the example below,
NTSReference is WEB_LEFT and NTSOffset draws Geometry
TOP_FLANGE_RIGHT_BOTTOM at a value of 0.01.
<GRAPHIC Geometry="TOP_FLANGE_RIGHT_BOTTOM" Extend="FALSE"
Location="0.25" NTSReference="WEB_LEFT" NTSOffset="0.1"></GRAPHIC>

NTSReference and NTSOffset are always used together. If neither is required,


then they do not need to be included. For example:
<GRAPHIC Geometry="TOP_FLANGE_RIGHT_BOTTOM" Extend="FALSE"
Location="0.25" NTSReference="" NTSOffset="0.0"></GRAPHIC>
and
<GRAPHIC Geometry="TOP_FLANGE_RIGHT_BOTTOM" Extend="FALSE"
Location="0.25"></GRAPHIC>
give the same result.

Drawings and Reports Reference Data Guide 1001


Custom Graphic Modules

Aspects
Aspects are most often used for cross-sections, such as tubes and pipes, with a limited number
of edges. The XML is in the following format:
<SECTION Type="HalfR">
<COMPONENTS>
<ASPECT Aspect="Simple physical"></ASPECT>
</COMPONENTS>
</SECTION>
Aspect
Specifies the type of geometry used to draw the profile. Each aspect has a different level of
detail.
 Simple physical - Includes primitive shapes. This aspect creates a less cluttered view
of the object, showing only the body of equipment or a simplified cross-section for
structure, as shown below.

 Detailed physical - Provides a more detailed view of an object. This aspect shows all
the graphical details associated with the equipment or structure. For example, certain
types of equipment may include legs and lugs. For marine structure, this aspect uses all
geometry in the cross-section, as shown below.

 Insulation - Shows an area around a piece of equipment indicating the presence of


insulation. This aspect is also used to display structural fireproofing insulation. For
example, a 4-inch pipe with insulation might look like an 8-inch pipe when this aspect is
used.

Drawings and Reports Reference Data Guide 1002


Custom Graphic Modules

 Operation - Includes the area or space around the object required for operation of the
object. This space shows in the model but not in drawings. For example, this aspect
leaves enough space around a motor for a person to operate the motor or the overhead
space needed for someone to walk up a stairway.

 Maintenance - Includes the area or space around the object required to perform
maintenance on the object. This space may appear in the model but not in drawings.
For example, this aspect leaves enough space around a motor to perform maintenance
on a motor, including space to remove the motor.

 Reference Geometry - Allows you to construct or add graphical objects that do not
participate in interference checking. For example, a reference geometry object could be
a spherical control or the obstruction volume for a door. For marine structure, this
aspect allows you to control the display of landing curves for design seams, profile
systems, reference curves, and knuckle curves.
 Centerline - Displays objects as a single line representation. For example, this aspect is
useful for when you want to display handrails or structural members as a single-line on
drawings. For structure, the centerline is determined from the cardinal point used to
place the member. That cardinal point is not always the center of the object.

 Molded Forms - Displays plate, profile, and beam systems for marine structure.
 Equipment Hole - Displays holes for marine structure created in the Hole Management
task.
 * - Matches all cross-sections.

Drawings and Reports Reference Data Guide 1003


Custom Graphic Modules

Aspects are defined on the AspectCode worksheet in AllCodeLists.xls, located


in the [Product Folder]\CatalogData\BulkLoad\DataFiles folder. If you customize aspects,
then the ShortDescription value in the worksheet is used in the XML for the Stiffener With
Flange module.

Grid Line
Orthographic graphic module: GridlinesDrawingWrapperEntity.dll
Rule set graphic module: Grid Line
Draws vertical gridlines at the intersection of X planes and Y planes (on the X-Z and Y-Z axes).
This graphic module applies to grid planes in the model. You can use this module in elevation
and isometric views when drawings need to show vertical lines at grid intersections.
For an example workflow using this graphic rule, see Apply Grid Labels to Elevation Views (on
page 92).

Grid Plane
Orthographic graphic module: GridPlaneDrawingWrapperEntity.dll
Rule set graphic module: Grid Plane
Extracts grid planes.

Logical Connection to Intersection Seam


Orthographic graphic module: None
Rule set graphic module: Logical Connection to Intersection Seam
Replaces a logical connection with the intersection seam that created it.

Make Drawable
Orthographic graphic module: MakeDrawable.dll
Rule set graphic module: Make Drawable
Makes it possible to draw objects that are not displayable in 3D (and therefore not normally
drawable in 2D). This graphic module applies to all graphical objects. Use this module when you
need to label or display objects such as features, runs, systems, or pipe support assemblies.

Drawings and Reports Reference Data Guide 1004


Custom Graphic Modules

To use this module, apply it as a graphic preparation rule to a view style that filters for objects
that are to be made drawable. In the following example, the view style filters for Piping Runs and
Support Assemblies:

The drawing below shows how the view style impacts the drawing:

Make Drawable tells the software to go through the entire business object tree,
setting all graphics to drawable. You might decide to use Make Drawable Simple to save time
when working with compound graphics. With Make Drawable Simple, the software only sets
the top level business object to drawable. For more information, see Make Drawable Simple (on
page 1006).

Make Drawable Assembly


Orthographic graphic module: MakeDrawableAssembly.dll
Rule set graphic module: Make Drawable Assembly
Provides a method to draw all objects in the assembly. This module is similar to Make
Drawable, with the added ability to draw planning assemblies.

Drawings and Reports Reference Data Guide 1005


Custom Graphic Modules

Make Drawable Simple


Orthographic graphic module: MakeDrawableSimple.dll
Rule set graphic module: Make Drawable Simple
Provides a method to label an entire assembly instead of the individual assembly components.
Using Make Drawable Simple can save time when working with compound graphics. You can
use this graphic module in the place of Make Drawable to simplify the labeling in a drawing. For
example, you can use Make Drawable Simple when the entire support assembly in the drawing
needs to be labeled. Without applying this graphic module, only the individual components can
be labeled.
With Make Drawable Simple, the software only sets the top level business object to drawable.
In contrast, Make Drawable tells the software to go through the entire business object tree,
setting all graphics to drawable.

Manufacturing Margin
Orthographic graphic module: None
Rule set graphic module: Manufacturing Margin
Finds the geometry of the plate side port or profile face port on which to place the margin. By
default, the software does not display the geometry, but uses it for label placement.
If you want to display the geometry, select a visible line style. The default line style is
Fully Transparent.

Manufacturing Shrinkage
Orthographic graphic module: None
Rule set graphic module: Manufacturing Shrinkage
Finds the center point of the part clipped range on which to place shrinkage. By default, the
software does not display the geometry, but uses it for shrinkage label placement.
If you want to display the geometry, select a visible line style. The default line style is
Fully Transparent.

Drawings and Reports Reference Data Guide 1006


Custom Graphic Modules

Member Centerline
Orthographic graphic module: MemberCenterLineWrapperEntity.dll
Rule set graphic module: Member Centerline
Replaces linear objects in the graphic view, such as members, with single lines at the object
centerline.

Opening
Orthographic graphic module: OpeningDrawingWrapperEntity.dll
Rule set graphic module: Opening
Sends the geometry of plate system openings to the drawing view.
For example, in the model, openings are on the plate:

Drawings and Reports Reference Data Guide 1007


Custom Graphic Modules

On the drawing view:

Opening To X
Orthographic graphic module: StructOpenToX.dll
Rule set graphic module: Opening To X
Resymbolizes the depressions (non-through openings) in a structure object with an X filler. This
module works for all rectangular and most L-shaped depressions.
You can use the delivered Openings filter when creating the Graphic Preparation Rule that
uses this module.

When drawings are created, the openings are resymbolized with the X filler.

Drawings and Reports Reference Data Guide 1008


Custom Graphic Modules

Example Showing Use of a Subfilter


You can also use the Opening To X to apply a subfilter for an opening/depression symbol. This
example creates a plan view drawing that applies a different line style (Red) to the
opening/depression symbols. The model shown below is used in the example:

When creating the view style, select only the opening/depression symbols using a subfilter:
<Name of Opening filter>::Symbol. Specify a graphic rule that uses a red line style.

You should apply Opening To X to the Openings objects in the model.

Drawings and Reports Reference Data Guide 1009


Custom Graphic Modules

When the plan drawing is updated with the view style, the depression symbols are shown in red:

Subfilters
To change the graphic representation of opening contours and depression symbols, you can
apply subfilters to the individual parts.
Contour
Use this subfilter to apply a graphic rule (line style, color, etc.) to the contour of an opening.
Use this syntax: <Filter Name>::Contour.
Symbol
Use this subfilter to apply a graphic rule (line style, color, etc.) to the depression symbol of
an opening. Use this syntax: <Filter Name>::Symbol.
To get a label for opening, you must define the Contour and Symbol subfilters in the
view style and apply a label rule in one of the subfilters.

Pipe Turn Feature To Arc


Orthographic graphic module: PipeTurnFeattoArc.dll
Rule set graphic module: Pipe Turn Feature To Arc
Makes the piping turn features drawable and replaces them with a single arc. You can use this
graphic rule when pipe bends should be shown as single lines in a drawing.
To use this module, apply it as a graphic preparation rule to a view style that filters for Piping
Turn Features.
The graphic below shows how the graphic rule impacts the drawing graphics:

Drawings and Reports Reference Data Guide 1010


Custom Graphic Modules

Plane Geometry
Orthographic graphic module: PlaneGeometryDrawingWrapperEntity.dll
Rule set graphic module: Plane Geometry
Draws plane geometry onto a drawing by generating a finite plane and passing it on to the
drawing generator. For example, use this graphic rule to create a plan or elevation grid plane on
a drawing in order to label it.

Plate Anti-Molded Side


Orthographic graphic module: None
Rule set graphic module: Plate Anti-Molded Side
Replaces a plate part with its anti-molded side.

 For a description of plate sides, see Molded Conventions for Plate Parts (on page 240).
 This module uses a custom surface value for
StructNamedSurfaceGeometryWrapperEntity.dll. For the default value, see Plate Molded
Side (on page 1013).

Plate Anti-Molded Side Without Features


Orthographic graphic module: None
Rule set graphic module: Plate Anti-Molded Side Without Features
Replaces a plate part with its anti-molded side. Features on the plate are not included.

 For a description of plate sides, see Molded Conventions for Plate Parts (on page 240).
 This module uses a custom surface value for
StructNamedSurfaceGeometryWrapperEntity.dll. For the default value, see Plate Molded
Side (on page 1013).

Plate Both Sides Without Features


Orthographic graphic module: None
Rule set graphic module: Plate Both Sides Without Features
Replaces a plate part with its molded and anti-molded sides. Features on the plate are not
included.

 For a description of plate sides, see Molded Conventions for Plate Parts (on page 240).

Drawings and Reports Reference Data Guide 1011


Custom Graphic Modules

 This module uses a custom surface value for


StructNamedSurfaceGeometryWrapperEntity.dll. For the default value, see Plate Molded
Side (on page 1013).

Plate Contour
Orthographic graphic module: PlateContourDrawingWrapperEntity.dll
Rule set graphic module: Plate Contour
Extracts plate part outer and inner edges on the plate thickness side and sends the geometry to
the drawing view.
For example, in the model, the plate parts are in cyan:

On the drawing view, the outer edges of the three plate parts and the inner edges of the
openings are drawn:

Drawings and Reports Reference Data Guide 1012


Custom Graphic Modules

Plate Molded Side


Orthographic graphic module: StructNamedSurfaceGeometryWrapperEntity.dll
Rule set graphic module: Plate Molded Side
Replaces a plate part with its molded side.
For a description of plate sides, see Molded Conventions for Plate Parts (on page
240).

Plate Molded Side Without Features


Orthographic graphic module: None
Rule set graphic module: Plate Molded Side Without Features
Replaces a plate part with its molded side. Features on the plate are not included.

 For a description of plate sides, see Molded Conventions for Plate Parts (on page 240).
 This module uses a custom surface value for
StructNamedSurfaceGeometryWrapperEntity.dll. For the default value, see Plate Molded
Side (on page 1013).

Plate Molded Surface


Orthographic graphic module: None
Rule set graphic module: Plate Molded Surface
Replaces a plate part with the molded surface of its parent plate system.

 For a description of plate sides and the molded surface, see Molded Conventions for Plate
Parts (on page 240).
 This module uses a custom surface value for
StructNamedSurfaceGeometryWrapperEntity.dll. For the default value, see Plate Molded
Side (on page 1013).

Drawings and Reports Reference Data Guide 1013


Custom Graphic Modules

Plate Outer Contour


Orthographic graphic module: PlateOuterContourDrawingWrapperEntity.dll
Rule set graphic module: Plate Outer Contour
Extracts plate part outer edges and sends the geometry to the drawing view.
For example, in the model, the plate parts are in cyan:

On the drawing view, the outer edges of the three plate parts are drawn, but the inner edges of
the openings are not drawn:

This module is frequently used with the Opening (on page 1007) module when
different properties for opening geometry are needed.

Drawings and Reports Reference Data Guide 1014


Custom Graphic Modules

Plate Part
Orthographic graphic module: PlatePartDrawingWrapperEntity.dll
Rule set graphic module: Plate Part
Extracts plate part outer and inner edges on the molded side of the plate and sends the
geometry to the drawing view.
For example, in the model, the plate parts are in cyan:

On the drawing view, the outer edges of the three plate parts and the inner edges of the
openings are drawn:

Drawings and Reports Reference Data Guide 1015


Custom Graphic Modules

Plate System
Orthographic graphic module: PlateSystemDrawingWrapperEntity.dll
Rule set graphic module: Plate System
Extracts plate system boundaries and sends the geometry to the drawing view.
For example, in the model, the plate system is in cyan:

On the drawing view, the plate system is drawn:

 This module is frequently used with the Opening (on page 1007) module when opening
geometry also needs to be drawn.
 Use a plate part graphic module, such as Plate Outer Contour (on page 1014), to draw the
boundaries of individual plate parts.

Drawings and Reports Reference Data Guide 1016


Custom Graphic Modules

Ports Separator
Orthographic graphic module: PortsSeparator.dll
Rule set graphic module: Ports Separator
Separates piping component ports from the components and makes the ports drawable. This
graphic rule applies to piping components in the model. You can use this graphic rule when the
open end of an elbow should be replaced by a symbol in a drawing.
To use this module, apply it as a graphic preparation rule to a view style that filters for piping
components. To apply a symbol graphic to the ports, create another row in the view style grid to
filter for Ports and apply the appropriate symbol graphic rule.

Subfilters
To change the graphic representation of piping parts and ports, you can apply subfilters to the
individual parts.
Part
Use this subfilter to apply a graphic rule (line style, color, etc.) to the piping parts. Use this
syntax: <Filter Name>::Part.
Ports
Use this subfilter to apply a graphic rule (line style, color, etc.) to the piping ports. Use this
syntax: <Filter Name>::Ports.

Drawings and Reports Reference Data Guide 1017


Custom Graphic Modules

Profile Cross Section


Orthographic graphic module: ProfileCSDrawingWrapperEntity.dll
Rule set graphic module: Profile Cross Section
Extracts the profile part cross-section and sends the geometry to the drawing view.
For example, in the model, the profile is in green below the plate:

On the drawing view, the cross-section of the profile part is drawn at the starting point of the
profile landing curve:

Drawings and Reports Reference Data Guide 1018


Custom Graphic Modules

Profile Knuckle As Curve


Orthographic graphic module: ProfileKnuckleAsCurve.dl
Rule set graphic module: Profile Knuckle As Curve
Sends knuckle line geometry to the drawing view as a curve (usually a line).

Profile Part
Orthographic graphic module: ProfilePartDrawingWrapperEntity.dll
Rule set graphic module: Profile Part
Extracts the profile part landing curve and sends the geometry to the drawing view.
For example, in the model, the profile is in green below the plate:

On the drawing view, the landing curve of the profile part is drawn:

Drawings and Reports Reference Data Guide 1019


Custom Graphic Modules

Profile System
Orthographic graphic module: ProfileSystemWrapperEntity.dll
Rule set graphic module: Profile System
Extracts the profile system landing curve and sends the geometry to the drawing view.
For example, in the model, the profile is in green below the plate:

On the drawing view, the landing curve of the profile system is drawn:

Drawings and Reports Reference Data Guide 1020


Custom Graphic Modules

Profile System Cross Section


Orthographic graphic module: ProfileSystemCSDrawingWrapperEntity.dll
Rule set graphic module: Profile System Cross Section
Extracts the profile system cross-section and sends the geometry to the drawing view.
For example, in the model, the profile is in green below the plate:

On the drawing view, the cross-section of the profile system is drawn at the starting point of the
profile landing curve:

Drawings and Reports Reference Data Guide 1021


Custom Graphic Modules

Range Center
Orthographic graphic module: None
Rule set graphic module: Range Center
Finds the center point of the part clipped range. By default, the software does not display the
geometry, but uses it for label placement.
If you want to display the geometry, select a visible line style. The default line style is
Fully Transparent.

Replace Sloped Pipe On Hanger


Orthographic graphic module: ReplaceSlopedPipeOnHgr.dll
Rule set graphic module: Replace Sloped Pipe On Hanger
Looks at pipes being collected by the view style and checks to see if they are connected to the
hanger being drawn. If the pipe is connected to the hanger, and if the pipe tangent at the
connection point is within 45 degrees of the viewing angle, the pipe is replaced with a point (the
connection point), and displays in the drawing as normal to the view. All other objects collected
by the view style are ignored by the graphic rule. This graphic rule only applies to drawing
created using a Drawings by Query component.
To use this module, apply it as a graphic preparation rule to a view style that collects pipes. For
example, in the following graphic, the HgrSup - Side view style is shown. It is currently using
the graphic preparation rule Copy of Pipe Supports.

Drawings and Reports Reference Data Guide 1022


Custom Graphic Modules

You can modify the graphic preparation rule by selecting More in the Graphic Preparation
Rule dropdown. The Select Custom Rule dialog box displays. Select the graphic rule to be
modified, then click Properties. On the Custom Graphic Rule dialog box, specify a filter to
collect the objects to be modified (for example, Pipelines) and select the
ReplaceSlopedPipeOnHgr.dll from the Custom Module dropdown field.

When you create a hanger drawing using this view style, any sloped pipe connected to the
drawn hanger is replaced in the drawing by a point symbol (the connection point).

Drawings and Reports Reference Data Guide 1023


Custom Graphic Modules

Replace With Point


Orthographic graphic module: ReplaceWPoint.dll
Rule set graphic module: Replace With Point
Replaces the 3D geometry of the specified object with a tiny sphere at the center of the range of
the object. You can apply this graphic rule to any graphical object. For example, you could use
this graphic rule when you need to label an object but do not want the object to participate in the
VHL and potentially hide other objects behind it.
To use this module, apply it as a graphic preparation rule to a view style that filters for the
objects to be replaced with the point symbol.

Piping Plan

Piping Plan with ReplaceWPoint Graphic Preparation Rule

Drawings and Reports Reference Data Guide 1024


Custom Graphic Modules

Route Component Centerline


Orthographic graphic module: RteComponentsCtrLine.dll
Rule set graphic module: Route Component Centerline
Shows centerlines for pipe components in addition to pipes. You can use this graphic rule in
piping plan, piping elevation, and piping section when drawings need to show centerlines for
piping components. For example, you can use this graphic rule when you need to place a
centerline of an elbow or tee.
To use this module, apply it as a graphic preparation rule to a view style using the Piping
Components filter. The graphic below shows how the graphic rule impacts the drawing:

Piping Plan

Piping Plan with RteComponentsCtrLine Custom Graphic Rule

Drawings and Reports Reference Data Guide 1025


Custom Graphic Modules

Rulers – Axis
Orthographic graphic module: None
Rule set graphic module: Rulers - Axis
Creates a short line that indicates the axis direction. By default, the software does not display
the geometry, but uses it for axis ruler placement.
If you want to display the geometry, select a visible line style. The default line style is
Fully Transparent.

Rulers – Reference Plane


Orthographic graphic module: None
Rule set graphic module: Rulers - Reference Plane
Finds a clipped plane at the reference plane location. By default, the software does not display
the geometry, but uses it for placement of a ruler tick mark at the reference plane.
If you want to display the geometry, select a visible line style. The default line style is
Fully Transparent.

Seam
Orthographic graphic module: SeamDrawingWrapperEntity.dll
Rule set graphic module: Seam
Sends seam geometry to the drawing view.
For example, in the model, the seams are in white on the plate:

Drawings and Reports Reference Data Guide 1026


Custom Graphic Modules

On the drawing view:

Simple Volume To X
Orthographic graphic module: SimpleVolumeToX.dll
Rule set graphic module: Simple Volume To X
Places an X symbol in empty volumes. You can use this graphic rule only for plan and section
views. The X symbol is not displayed in the isometric view.

Sloped Pipe With Arc Symbol


Orthographic graphic module: SlopedPipeWArcSymbol.dll
Rule set graphic module: Sloped Pipe With Arc Symbol
Replaces a straight pipe with its centerline and a series of arcs representing the slope. You can
apply this graphic module to sloped straight pipe.

Drawings and Reports Reference Data Guide 1027


Custom Graphic Modules

You can use this graphic module when sloped pipe should be represented on a plan drawing.

Looking North

Looking Plan Normal

Looking Plan with SlopedPipeWArcSymbol Custom Graphic Rule

Std Member With Flange


Orthographic graphic module: StiffenerWrapperEntity.dll
Rule set graphic module: Std Member With Flange
Extracts the web and flange of a standard member part and customizes the way that a primary
orientation view is resymbolized in a drawing. Parameters for resymbolization can be defined for
each cross-section type. The delivered parameters are defined in Std Member With
Flange.xml, located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DBRRules\Resymbolization folder.
Parameters are defined with respect to edges on the member cross-section or by a geometry
aspect type. The parameters for Std Member With Flange are the same as Stiffener With
Flange. For more information, see Stiffener With Flange (on page 1029).

Std Member With Web


Orthographic graphic module: StiffenerWrapperEntity.dll
Rule set graphic module: Std Member With Web
Extracts the web and flange of a standard member part and customizes the way that a
secondary orientation view is resymbolized in a drawing. Parameters for resymbolization can be
defined for each cross-section type. The delivered parameters are defined in Std Member With
Flange.xml, located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DBRRules\Resymbolization folder.
Parameters are defined with respect to edges on the member cross-section or by a geometry
aspect type. The parameters for Std Member With Flange are the same as Stiffener With
Flange. For more information, see Stiffener With Flange (on page 1029).

Drawings and Reports Reference Data Guide 1028


Custom Graphic Modules

Stiffener With Flange


Orthographic graphic module: StiffenerWrapperEntity.dll
Rule set graphic module: Stiffener With Flange
Extracts the web and flange of a profile part and customizes the way they are resymbolized in a
drawing. Parameters for resymbolization can be defined for each cross-section type. The
delivered parameters are defined in Stiffener With Flange.xml, located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DBRRules\Resymbolization folder.
Parameters are defined with respect to edges on the profile cross-section or by a geometry
aspect type.

Referenced from Edges


The XML is in the following format:
<SECTION Type="UA">
<COMPONENTS>
<!-- web -->
<GRAPHIC Geometry="WEB_LEFT" Extend="FALSE" NTSReference=""
NTSOffset="0.0"></GRAPHIC>
<!-- flanges -->
<GRAPHIC Geometry="TOP_FLANGE_RIGHT_BOTTOM" Extend="FALSE"
Location="0.25" NTSReference="WEB_LEFT"
NTSOffset="0.1"></GRAPHIC>
</COMPONENTS>
</SECTION>
Geometry
Specifies the edge name of the profile geometry from which other parameters are
referenced. For more information on the available edge names, see Cross-Section Edge
Names (on page 1034). The most commonly used edge names are shown below.

Drawings and Reports Reference Data Guide 1029


Custom Graphic Modules

Extend
If True, specifies the extension of the geometry to the limits of the cross-section. In the
example below, WEB_LEFT extends to TOP and BOTTOM. If Extend is not specified, the
default value is False.

Location
Indicates the relative location (along the length of the geometry) on which to draw the
geometry. In the example below, Geometry TOP_FLANGE_RIGHT_BOTTOM is sloped
and is drawn at 0.25 along its length.
<GRAPHIC Geometry="TOP_FLANGE_RIGHT_BOTTOM" Extend="FALSE"
Location="0.25"></GRAPHIC>

This is an optional value and should not be included when it is not needed to avoid
unnecessary calculations in the software.
NTSReference
Specifies the reference geometry acting as an axis along which the NTSOffset value is
measured.
NTSOffset
Specifies the relative amount to offset the geometry along the reference geometry defined
by NTSReference. The relative amount is a value between 0 (located at the geometry) and
1 (located at the limits of the cross-section in the direction of the reference geometry). As a
result, the drawn geometry is not-to-scale but is easier to see. In the example below,
NTSReference is WEB_LEFT and NTSOffset draws Geometry
TOP_FLANGE_RIGHT_BOTTOM at a value of 0.01.

Drawings and Reports Reference Data Guide 1030


Custom Graphic Modules

<GRAPHIC Geometry="TOP_FLANGE_RIGHT_BOTTOM" Extend="FALSE"


Location="0.25" NTSReference="WEB_LEFT" NTSOffset="0.1"></GRAPHIC>

NTSReference and NTSOffset are always used together. If neither is required,


then they do not need to be included. For example:
<GRAPHIC Geometry="TOP_FLANGE_RIGHT_BOTTOM" Extend="FALSE"
Location="0.25" NTSReference="" NTSOffset="0.0"></GRAPHIC>
and
<GRAPHIC Geometry="TOP_FLANGE_RIGHT_BOTTOM" Extend="FALSE"
Location="0.25"></GRAPHIC>
give the same result.

Aspects
Aspects are most often used for cross-sections, such as tubes and pipes, with a limited number
of edges. The XML is in the following format:
<SECTION Type="HalfR">
<COMPONENTS>
<ASPECT Aspect="Simple physical"></ASPECT>
</COMPONENTS>
</SECTION>
Aspect
Specifies the type of geometry used to draw the profile. Each aspect has a different level of
detail.
 Simple physical - Includes primitive shapes. This aspect creates a less cluttered view
of the object, showing only the body of equipment or a simplified cross-section for
structure, as shown below.

Drawings and Reports Reference Data Guide 1031


Custom Graphic Modules

 Detailed physical - Provides a more detailed view of an object. This aspect shows all
the graphical details associated with the equipment or structure. For example, certain
types of equipment may include legs and lugs. For marine structure, this aspect uses all
geometry in the cross-section, as shown below.

 Insulation - Shows an area around a piece of equipment indicating the presence of


insulation. This aspect is also used to display structural fireproofing insulation. For
example, a 4-inch pipe with insulation might look like an 8-inch pipe when this aspect is
used.

 Operation - Includes the area or space around the object required for operation of the
object. This space shows in the model but not in drawings. For example, this aspect
leaves enough space around a motor for a person to operate the motor or the overhead
space needed for someone to walk up a stairway.

Drawings and Reports Reference Data Guide 1032


Custom Graphic Modules

 Maintenance - Includes the area or space around the object required to perform
maintenance on the object. This space may appear in the model but not in drawings.
For example, this aspect leaves enough space around a motor to perform maintenance
on a motor, including space to remove the motor.

 Reference Geometry - Allows you to construct or add graphical objects that do not
participate in interference checking. For example, a reference geometry object could be
a spherical control or the obstruction volume for a door. For marine structure, this
aspect allows you to control the display of landing curves for design seams, profile
systems, reference curves, and knuckle curves.
 Centerline - Displays objects as a single line representation. For example, this aspect is
useful for when you want to display handrails or structural members as a single-line on
drawings. For structure, the centerline is determined from the cardinal point used to
place the member. That cardinal point is not always the center of the object.

 Molded Forms - Displays plate, profile, and beam systems for marine structure.
 Equipment Hole - Displays holes for marine structure created in the Hole Management
task.
 * - Matches all cross-sections.
Aspects are defined on the AspectCode worksheet in AllCodeLists.xls, located in
the [Product Folder]\CatalogData\BulkLoad\DataFiles folder. If you customize aspects, then the
ShortDescription value in the worksheet is used in the XML for the Stiffener With Flange
module.

Drawings and Reports Reference Data Guide 1033


Custom Graphic Modules

Cross-Section Edge Names


The geometry of a cross-section symbol consists of one or more closed contours. Each edge of
the contour has a name.
Edge names are:
 Standard for each type of symbol.
 Hard-coded values in the software.
 Defined in the symbol to correspond to the hard-coded values.
The following standard edge names are used:

A profile cross-section, with the exception of pipe and round tube, must have at least the
following four edge names defined:
 Top
 Bottom
 Web_Left

Drawings and Reports Reference Data Guide 1034


Custom Graphic Modules

 Web_Right
Within the standard names, each type of profile cross-section uses a specific subset of edge
names.

I-beams
Includes W and S types.

T
Includes W, S, and M types and fabricated T types.

Drawings and Reports Reference Data Guide 1035


Custom Graphic Modules

I-to-T

Angle
Includes equal and unequal leg angles.

Drawings and Reports Reference Data Guide 1036


Custom Graphic Modules

Fabricated angle

Channel
Includes S and M types.

Drawings and Reports Reference Data Guide 1037


Custom Graphic Modules

Channel cut

Flat bar

Drawings and Reports Reference Data Guide 1038


Custom Graphic Modules

Bulb

Bulb T

Pipe
Includes pipe, tube, and round bar.

Drawings and Reports Reference Data Guide 1039


Custom Graphic Modules

Rectangular tube

Structural Transient Ports


Orthographic graphic module: StructTransientPortsWrapperEntity.dll
Rule set graphic module: Structural Transient Ports
Draws the transient port geometry of an object instead of the object geometry. This allows
reliable dimensioning. This module is automatically used when the VHL graphic rule draws the
simple physical aspect of a plate part, profile part, or the individual plate parts of a built-up
member part. For more information, see Visible/Hidden Edges (VHL) (on page 734).

Trench Parts Ports


Orthographic graphic module: TrenchPartsPortsWrapperEntity.dll
Rule set graphic module: TrenchPartsPortsWrapperEntity
Draws the face ports of the trench part, allowing accurate dimensioning. The software
automatically uses this module when the VHL graphic rule draws the simple physical aspects of
trench parts. For more information, see Visible/Hidden Edges (VHL) (on page 734).

Drawings and Reports Reference Data Guide 1040


Custom Graphic Modules

Trim Pipe Surface


Orthographic graphic module: TrimPipeSurface.dll
Rule set graphic module: Trim Pipe Surface
Draws both the pipe and its centerline in the drawing. This graphic module applies to pipes.
To use this module, apply it as a graphic preparation rule to a view style that filters for pipes and
apply.
Do not use this module with orthographic drawings or when exporting to DGN files.
This approach only works in a 2D environment where the slicing plane is oriented parallel with
the view plane.

Volume Wire Frame


Orthographic graphic module: VolumeWireFrame.dll
Rule set graphic module: Volume Wire Frame
Replaces an object with its wireframe representation for VHL. You can apply this graphic
module to any graphical object. You could use this graphic module when you need to show
outlines of certain objects and want to keep the objects' surface from hiding other objects.
To use this module, apply it as a graphic preparation rule to a view style that filters for the
objects for which you want the wireframe representation.
The graphic below shows how the wireframe representation works in the drawing:

Drawings and Reports Reference Data Guide 1041


Custom Graphic Modules

Weld To Line
Orthographic graphic module: WeldToLine.dll
Rule set graphic module: Weld To Line
Replaces welds with centerline representations. You can use this custom graphic module to
reduce the time required to process a drawing.

Drawings and Reports Reference Data Guide 1042


SECTION 15

Embedded Symbol Rules


Graphic rules for embedded symbols are specified as part of the marine mode rule set view
style definition using the Tools > Define View Style command in the Drawings and Reports
task. The number and type of rules available depends on the view style selected on the Define
View Style dialog box, and the source selected in the view style properties. For more
information, see Graphic Style Dialog Box (on page 126).
Embedded symbols are symbols defined as a custom action within the rule set view style
definition. Embedded symbols are delivered to the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\EmbeddedSymbols folder.
Embedded symbols become part of the object in the drawing view. They are placed on the
drawing in object space, so they scale along with the object to which they are attached. The
SYM file is exactly the same as the one used for standard symbols. However, the XML file for an
embedded symbol is similar to a rule because it allows you to control which .sym to place
depending on different geometry conditions in the model.
For example, end cuts are always resymbolized on a drawing by rule. The 3D geometry is
mapped to a 2D geometry. The end cut symbol will not have parameters as inputs. The XML
specifies a 2D symbol for Steel Order drawings. Different XML examples are delivered for
embedded end cut symbols:
 ProfilePartEndCut_byCrossSection.xml - Refers only to end cuts, not to any specific
cross-section type.
 ProfilePartEndCut_byEndCutType.xml - Uses specific EndCutTypes, but any
WebCutType.
 DefaultProfileEndCut.xml - Applies a default symbol to each end of the profile.
 ProfilePartEndCut.xml - Default example; refers to SectionType, EndCutType, and
WebCutType.
The ProfilePartEndCut XML, the default example, allows you to choose how the end cuts are
resymbolized on drawings by rule:

Drawings and Reports Reference Data Guide 1043


Embedded Symbol Rules

In the End Cut XML files, different 2D symbols are placed at the start and end of the profile. The
drawing code calculates where the start and end positions are. In the XML, you specify the
symbol to use for the Start and End positions.
The ProfilePartEndCut XML, you can show welded UA profiles on the drawing:

If the condition can be made generic for the drawing, fewer sections are required in the XML
code. Any can be used to handle generic cases. For example, if all welded UA profiles receive
the same symbol on the drawing, set WebCutType to Any.

You can use annotation parameters to further control end cut symbol placement. You do not
have to modify annotation parameters, but they can be customized if needed. The annotation
parameters include: SCALE_FACTOR, ANCHOR, TARGET, LOCATION, ORIENTATION,
DIRECTION, DIRECTION, CURVE_RATIO, X_OFFSET, and Y_OFFSET.
See Also
Symbol Definition for Drawings by Rule (on page 916)
In This Section
End Cut Embedded Symbols (Steel Order Rule Set) .................... 1045
End Cut Embedded Symbols (Generic Rule Set).......................... 1053
Slot Embedded Symbols ............................................................... 1056
Marking Line Embedded Symbols ................................................. 1061
Feature Embedded Symbols ......................................................... 1064
Catalog Symbols ............................................................................ 1065

Drawings and Reports Reference Data Guide 1044


Embedded Symbol Rules

End Cut Embedded Symbols (Steel Order Rule Set)


End Cut Rules
For the steel order rule set, the following end cut embedded symbol rules are delivered in the
[Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\EmbeddedSymbols\Scantlings\End
CutRules folder:

Label Template Symbols (.sym) and/or Annotation Modules


(.xml) Report Templates (.rtp) used
used

ProfilePartEndCut Multiple endcut .sym files within ISDwgProfileEndCutSymbol (on page


the folder 1845)

ProfilePartEndCut Multiple endcut .sym files within ISDwgProfileEndCutSymbol (on page


_ByCrossSection the folder 1845)
This is a subset of
ProfilePartEndCut

ProfilePartEndCut Multiple endcut .sym files within ISDwgProfileEndCutSymbol (on page


_ByEndCutType the folder 1845)
This is a subset of
ProfilePartEndCut

End Cut Symbols


For the steel order rule set, (ISSteelOrderRuleSet.Default), end cut embedded symbols are
located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\EmbeddedSymbols\Scantlings\End
CutRules folder. You create symbols in SmartSketch Drawing Editor. For more information, see
Create a Custom Symbol for Drawings (on page 906).
The following rules and symbols are used in the default ProfilePartEndCut embedded symbol
rules. Rule selection begins with the most specific section types, endcut types, and filters.
Selection proceeds to the more general cases when matches to the specific cases are not
found.

Section Endcut Webcut Webcut, Profile Symbol Symbol


Top
Type Type Type Flangecut, Side File Graphic
and Bottom
Flangecut
Filters

BUT W WebCut_C3Right Any Start EndCut_2_Open_Off_


S.sym
T_XType C WebCut_C3Left

Drawings and Reports Reference Data Guide 1045


Embedded Symbol Rules

TSType Welded EndCut_2_Open_Off_


End
E.sym
Cutback

BUT W WebCut_W1Right Any Start EndCut_2_Open_Off_


S.sym
T_XType C WebCut_W1Left
TSType Welded
Cutback End EndCut_2_Open_Off_
E.sym

UA W WebCut_C3Right Any Start EndCut_1_Open_Off_


S.sym
EA C WebCut_C3Left
B Welded
BUTL2 Cutback End EndCut_1_Open_Off_
E.sym
BUTL3

UA W WebCut_C2Left Any Start EndCut_1_Open_Off_


S.sym
EA C
Welded
Cutback End EndCut_1_Open_Off_
E.sym

B W WebCut_C3RBulb Any Start EndCut_1_Open_Off_


S.sym
C WebCut_C2Left
Welded
Cutback End EndCut_1_Open_Off_
E.sym

BUTL2 W WebCut_W1Right Any Start EndCut_1_Open_Off_


S.sym
BUTL3 Welded WebCut_W1Left

End EndCut_1_Open_Off_
E.sym

Drawings and Reports Reference Data Guide 1046


Embedded Symbol Rules

Section Endcut Webcut Webcut, Profile Symbol Symbol


Top
Type Type Type Flangecut, Side File Graphic
and Bottom
Flangecut
Filters

BUT W WebCut_C3Right Any Start EndCut_2_Open_Off_


S.sym
T_XType C WebCut_C3Left
TSType Welded
BUT Welded
Cutback CopeBUTRight Any Start EndCut_2_Closed_
S.sym
T_XType CopeBUTLeft
TSType WebCutT_W1Right
WebCutT_W1Left End EndCut_2_Closed_
E.sym

BUT W Any Any Start EndCut_2_Closed_


S.sym
T_XType Welded
TSType
End EndCut_2_Closed_
E.sym

B Welded Cope_AngleRight Any Start EndCut_1_Closed_


S.sym
CopeBulb

End EndCut_1_Closed_
E.sym

BUTL2 Welded CopeBUTRight Any Start EndCut_1_Closed_


S.sym
BUTL3 CopeBUTLeft
WebCutT_W1Right
WebCutT_W1Left End EndCut_1_Closed_
E.sym

UA Welded Cope_AngleRight Any Start EndCut_1_Closed_


S.sym
EA

Drawings and Reports Reference Data Guide 1047


Embedded Symbol Rules

Section Endcut Webcut Webcut, Profile Symbol Symbol


Top
Type Type Type Flangecut, Side File Graphic
and Bottom
Flangecut
Filters

BUT W WebCut_C3Right Any Start EndCut_2_Open_Off_


S.sym
T_XType C WebCut_C3Left
TSType Welded
FB EndCut_1_Closed_
Cutback End
E.sym

UA W Any Any Start EndCut_1_Closed_


S.sym
EA Welded
B
BUTL2 End EndCut_1_Closed_
E.sym
BUTL3
FB

BUT C Any Any Start EndCut_2_Open_


S.sym
T_XType Cutback
TSType
End EndCut_2_Open_
E.sym

UA C Any Any Start EndCut_1_Open_


S.sym
EA Cutback
B
BUTL2 End EndCut_1_Open_
E.sym
BUTL3
FB

BUT Snip Any Any Start EndCut_2_Open_Off_


Vert_S.sym
T_XType
TSType
End EndCut_2_Open_Off_
Vert_E.sym

Drawings and Reports Reference Data Guide 1048


Embedded Symbol Rules

Section Endcut Webcut Webcut, Profile Symbol Symbol


Top
Type Type Type Flangecut, Side File Graphic
and Bottom
Flangecut
Filters

BUT W WebCut_C3Right Any Start EndCut_2_Open_Off_


S.sym
T_XType C WebCut_C3Left
TSType Welded
BUT S
Cutback Any Any Start EndCut_2_Open_Off_
Vert_S.sym
T_XType FV
TSType F
Snip End EndCut_2_Open_Off_
Vert_E.sym

B Snip Snip Any Start EndCut_1_Open_Off_


Vert_S.sym

End EndCut_1_Open_Off_
Vert_E.sym

UA Snip SnipWithFlange Any Start EndCut_1_Open_Off_


Vert_S.sym
EA
BUTL2
BUTL3 End EndCut_1_Open_Off_
Vert_E.sym

UA S Any Any Start EndCut_1_Open_Off_


Vert_S.sym
EA FV
B Snip
BUTL2 End EndCut_1_Open_Off_
Vert_E.sym
BUTL3

UA F Any Any Start EndCut_1_Open_


S.sym

Drawings and Reports Reference Data Guide 1049


Embedded Symbol Rules

Section Endcut Webcut Webcut, Profile Symbol Symbol


Top
Type Type Type Flangecut, Side File Graphic
and Bottom
Flangecut
Filters

BUT W WebCut_C3Right Any Start EndCut_2_Open_Off_


S.sym
T_XType C WebCut_C3Left
TSType Welded
Cutback End EndCut_1_Open_
E.sym

FB Snip Snip Any Start EndCut_2_Open_


S.sym

End EndCut_2_Open_

FB S Any Any Start EndCut_2_Open_S.sym

Snip

End EndCut_2_Open_E.sym

FB FV Any Any Start EndCut_1_Open_Vert_


S.sym

End EndCut_1_Open_Vert_
E.sym

FB F Any Any Start EndCut_1_Open_S.sym

Any

End EndCut_1_Open_E.sym

Drawings and Reports Reference Data Guide 1050


Embedded Symbol Rules

Section Endcut Webcut Webcut, Profile Symbol Symbol


Top
Type Type Type Flangecut, Side File Graphic
and Bottom
Flangecut
Filters

BUT W WebCut_C3Right Any Start EndCut_2_Open_Off_


S.sym
T_XType C WebCut_C3Left
TSType Welded
FB(ER) Snip
Cutback FreeEndWebCut Any Start EndCut_Default_S.sym
_F1_ER

End EndCut_Default_E.sym

FB(ER) Welded SnipTopCorner Any Start EndCut_Default_S.sym


Left_ER
SnipTopCorner
Right_ER
End EndCut_Default_E.sym

Any Welded SnipTopCornerLeft Any Start EndCut_2_Closed_


S.sym
SnipTopCornerRight
WebCutI_C3Left
WebCutI_C3Right
CopeTopCornerSnipe End EndCut_2_Closed_
E.sym
WebAndFlangeWelded
WebCut_C2Spline
Clip

Any W Any Any Start EndCut_2_Closed_


S.sym
Welded

End EndCut_2_Closed_
E.sym

Any Cutback StraightSnip Any Start EndCut_2_Open_


S.sym

Drawings and Reports Reference Data Guide 1051


Embedded Symbol Rules

Section Endcut Webcut Webcut, Profile Symbol Symbol


Top
Type Type Type Flangecut, Side File Graphic
and Bottom
Flangecut
Filters

BUT W WebCut_C3Right Any Start EndCut_2_Open_Off_


S.sym
T_XType C WebCut_C3Left
TSType Welded
Cutback End EndCut_2_Open_
E.sym

Any C Any Any Start EndCut_2_Open_


S.sym
Cutback

End EndCut_2_Open_
E.sym

Any Snip SnipNoNose Any Start EndCut_2_Open_


Off_Vert_S.sym
SnopNoNoseRadius
ShipBeyondBoundary

End EndCut_2_Open_
Off_Vert_E.sym

Any S Any Any Start EndCut_2_Open_


Off_Vert_S.sym
FV
Snip
End EndCut_2_Open_
Off_Vert_E.sym

Any Any Any Any Start EndCut_Default_S.sym

End EndCut_Default_E.sym

Drawings and Reports Reference Data Guide 1052


Embedded Symbol Rules

Section Endcut Webcut Webcut, Profile Symbol Symbol


Top
Type Type Type Flangecut, Side File Graphic
and Bottom
Flangecut
Filters

BUT W WebCut_C3Right Any Start EndCut_2_Open_Off_


S.sym
T_XType C WebCut_C3Left
TSType Welded
None Any
Cutback Any Any Any EndCut_None.sym

End Cut Embedded Symbols (Generic Rule Set)


End Cut Symbols
For the generic rule set (DBRGenericRuleSet.GenericRuleSet)), end cut embedded symbols are
located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DBRRules\MetaGraphicRules\GenericLanding
CurveWithEndCuts\EndCutRules folder. You create symbols in SmartSketch Drawing Editor.
For more information, see Create a Custom Symbol for Drawings (on page 906).
The following rules and symbols are used in the Molded Forms Rules embedded symbol rules.
Rule selection is based on section types and end cut types defined for the profile part in the
Molded Forms task.

Connection Section Primary Web Symbol File Symbol


Type Type Cut Graphic

By Rule Any Any ByRule.sym

Welded Any Any Welded.sym

Snip Any Any Snip.sym

Cutback Any Any Cutback.sym

Drawings and Reports Reference Data Guide 1053


Embedded Symbol Rules

Connection Section Primary Web Symbol File Symbol


Type Type Cut Graphic

Bracketed Any Any Bracketed.sym

Any Any Error Error.sym

The following rules and symbols are used in the default Structural Detailing Rules embedded
symbol rules. Rule selection is based on section types and end cut types defined for the detailed
profile part in the Molded Forms task.

Connection Section Primary Web Symbol File Symbol


Type Type Cut Graphic

Any Any Straight No StraightNoOffsetWebCuts.sym


Offset WebCuts

Any Any Straight Offset StraightOffsetWebCuts.sym


WebCuts

Any Any Sniped Offset SnipedOffsetWebCuts.sym


WebCuts

Any Any Sniped No SnipedNoOffsetWebCuts.sym


Offset WebCuts

By Rule Any Any ByRule.sym

Welded Any Any Welded.sym

Snip Any Any Snip.sym

Drawings and Reports Reference Data Guide 1054


Embedded Symbol Rules

Connection Section Primary Web Symbol File Symbol


Type Type Cut Graphic

Cutback Any Any Cutback.sym

Bracketed Any Any Bracketed.sym

Any Any Error Error.sym

End Cut Rules


For the generic rule set, Molded Forms Rule.xml and Structural Detailing Rule.xml are also
delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Rules\DBRRules\MetaGraphicRules\GenericLanding
CurveWithEndCuts\EndCutRules folder.
Your reference data administrator can customize the primary web cut, secondary web cut, top
flange cut, and bottom flange cut within a connection type.
<SymbolInfo>
<ProfileInfo>
<!-- Start optional -->
<SectionType>Any</SectionType>
<ConnectionType>Any</ConnectionType>
<PrimaryWebCutInfo>
<First>Web Cut Name</First>
<Top>Any</Top>
<Bottom>Any</Bottom>
</PrimaryWebCutInfo>
<TopFlangeCutInfo>
<First>Any</First>
<Top>Any</Top>
<Bottom>Any</Bottom>
</TopFlangeCutInfo>
<BottomFlangeCutInfo>
<First>Any</First>
<Top>Any</Top>
<Bottom>Any</Bottom>
</BottomFlangeCutInfo>
<SecondaryWebCutInfo>
<First>Any</First>
<Top>Any</Top>
<Bottom>Any</Bottom>
</SecondaryWebCutInfo>
<!-- End optional -->

Drawings and Reports Reference Data Guide 1055


Embedded Symbol Rules

</ProfileInfo>
<Symbol>WebCutName.sym</Symbol>
</SymbolInfo>

Slot Embedded Symbols


Slot Rules
The following slot embedded symbol rules are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\EmbeddedSymbols\Scantlings\Slot
Rules folder:

Label Template Symbols (.sym) and/or Annotation


(.xml) Report Templates (.rtp) used Modules used

DefaultSlot Multiple slot .sym files within the folder SlotSymbols (on
page 1864)

Slot Symbols
Slot embedded symbols are located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\EmbeddedSymbols\Scantlings\Slot
Rules folder. You create symbols in SmartSketch Drawing Editor. For more information, see
Create a Custom Symbol for Drawings (on page 906).
The following rules and symbols are used in the default DefaultSlot embedded symbol rules.

Section Slot is cut normal Collar Plate Seam Symbol Symbol


Type (perpendicular) to Side Tightness Filter File Graphic
the plate

FB True Any Non-Tight Any SystemSlotFC.sym

FB False Any Non-Tight Any SystemSlotFA.sym

EA True Any Non-Tight Any SystemSlotAC.sym

Drawings and Reports Reference Data Guide 1056


Embedded Symbol Rules

Section Slot is cut normal Collar Plate Seam Symbol Symbol


Type (perpendicular) to Side Tightness Filter File Graphic
the plate

EA False Any Non-Tight Any SystemSlotAA.sym

UA True Any Non-Tight Any SystemSlotAC.sym

UA False Any Non-Tight Any SystemSlotAA.sym

BUTL3 True Any Non-Tight Any SystemSlotAC.sym

BUTL3 False Any Non-Tight Any SystemSlotLA.sym

T_XTYP True Any Non-Tight Any SystemSlotTA.sym


E

T_XTYP False Any Non-Tight Any SystemSlotTA.sym


E

TSTYPE True Any Non-Tight Any SystemSlotTA.sym

Drawings and Reports Reference Data Guide 1057


Embedded Symbol Rules

Section Slot is cut normal Collar Plate Seam Symbol Symbol


Type (perpendicular) to Side Tightness Filter File Graphic
the plate

TSTYPE False Any Non-Tight Any SystemSlotTA.sym

BUT True Any Non-Tight Any SystemSlotTA.sym

BUT False Any Non-Tight Any SystemSlotTA.sym

BUTL2 True Any Non-Tight Any SystemSlotTA.sym

BUTL2 False Any Non-Tight Any SystemSlotTA.sym

B True Any Non-Tight Any SystemSlotBC.sym

B False Any Non-Tight Any SystemSlotBA.sym

C_SS True Any Non-Tight Any SystemSlotAA.sym

Drawings and Reports Reference Data Guide 1058


Embedded Symbol Rules

Section Slot is cut normal Collar Plate Seam Symbol Symbol


Type (perpendicular) to Side Tightness Filter File Graphic
the plate

C_SS False Any Non-Tight Any SystemSlotAA.sym

CSTYPE True Any Non-Tight Any SystemSlotAA.sym

CSTYPE False Any Non-Tight Any SystemSlotAA.sym

I True Any Non-Tight Any SystemSlotTA.sym

I False Any Non-Tight Any SystemSlotTA.sym

ISTYPE True Any Non-Tight Any SystemSlotTA.sym

ISTYPE False Any Non-Tight Any SystemSlotTA.sym

Any Any Any Non-Tight Any Default_CV_T.sym

Drawings and Reports Reference Data Guide 1059


Embedded Symbol Rules

Section Slot is cut normal Collar Plate Seam Symbol Symbol


Type (perpendicular) to Side Tightness Filter File Graphic
the plate

FB False Visible Tight Any SystemSlotF_CV_T.sym

FB False Hidden Tight Any SystemSlotF_CH_T.sym

FB True Visible Tight Any SystemSlotF_CV_T.sym

FB True Hidden Tight Any SystemSlotF_CH_T.sym

Any Any Visible Tight Any Default_CV_T.sym

Any Any Hidden Tight Any Default_CH_T.sym

Drawings and Reports Reference Data Guide 1060


Embedded Symbol Rules

Marking Line Embedded Symbols


The rules XML file and embedded symbols are located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\EmbeddedSymbols\StructManufact
uring\MfgProfile\Marking Line folder. You create symbols in SmartSketch Drawing Editor. For
more information, see Create a Custom Symbol for Drawings (on page 906)
The following rules and symbols are delivered for the default StructManufacturingMfgProfile
embedded symbol rules. Selection proceeds to the more general cases when matches to the
specific cases are not found.

Marking Line Type Marking Symbol File Symbol Graphic


Line
Orientation

Fitting Mark Right FittingMarkRight.sym

Fitting Mark Left FittingMarkLeft.sym

Fitting Mark Neutral FittingMark.sym

KnuckleMark Neutral KnuckleMark.sym

KnuckleMark Left KnuckleMarkLeft.sym

Drawings and Reports Reference Data Guide 1061


Embedded Symbol Rules

Marking Line Type Marking Symbol File Symbol Graphic


Line
Orientation

KnuckleMark Right KnuckleMarkRight.sym

RendMark Left RendMarkLeft.sym

RendMark Right RendMarkRight.sym

ReferencePlane Neutral ReferencePlaneMark.sym


Mark

ReferencePlane Left ReferencePlaneMarkLeft.sym


Mark

ReferencePlane Right ReferencePlaneMarkRight.sym


Mark

Drawings and Reports Reference Data Guide 1062


Embedded Symbol Rules

Marking Line Type Marking Symbol File Symbol Graphic


Line
Orientation

SeamMark Neutral SeamMark.sym

AraMarginMark Neutral AraMarginMark.sym

DefaultMark Neutral DefaultMark.sym

Drawings and Reports Reference Data Guide 1063


Embedded Symbol Rules

Feature Embedded Symbols


The rules XML file and embedded symbols are located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\EmbeddedSymbols\StructManufact
uring\MfgProfile\Feature folder. You create symbols in SmartSketch Drawing Editor. For more
information, see Create a Custom Symbol for Drawings (on page 906).
The following rules and symbols are delivered for the default StructManufacturingMfgProfile
embedded symbol rules. Selection proceeds to the more general cases when matches to the
specific cases are not found.

Feature Feature Symbol File Symbol Graphic


Type

EdgeFeature EdgeFeature.sym

WaterStop WaterStop.sym

DefaultFeature DefaultFeature.sym

Drawings and Reports Reference Data Guide 1064


Embedded Symbol Rules

Catalog Symbols
The following catalog symbols are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Symbols folder:

Symbol name (.sym) Graphic Rule Template (.xml) Symbol Graphic

SM_FluorescentFixture.sym SM_Lighting Plan_Fluorescent.xml

SM_FlushMount.sym SM_Lighting Plan_Flushmount.xml

SM_JunctionBox.sym SM_Lighting Plan_JunctionBox.xml

For more information, see Embedded Symbol Rules (on page 1043).

Drawings and Reports Reference Data Guide 1065


APPENDIX A

Appendix: Annotation Rule Manager


Customization
This appendix describes how to customize the default behavior of the rule manager user
interface (UI) for labels (including matchlines and the north arrow) and for dimensions.
The rule manager's default functionality includes module-to-module compatibility, support of
module properties, module and property definitions, and reserved .xml tags. However, as this
appendix explains, the rule manager allows you to modify the properties of Drawing labels and
dimensions.
Refer to schema upgrade procedure topics in the Smart 3D Upgrade Guide if you
customized annotation UI schema files in earlier product versions. This document is available
from Help > Printable Guides in the software.
See Also
XML Structure for Property and Property Group Definitions (on page 1073)

User Interface Schema Overview


The software uses multiple .xml files to display the list of properties and modules for each rule
manager. When you load a rule in the rule manager, the software first checks the rule and
template .xml files. Then, the software uses this information and the information in the group of
.xml files, referred to in this document as the UI Schema, to display the information in the rule
manager.
The schema organizes module and property information, reserved .xml tags, and
compatibilities between modules.

Internal versus Custom Schema


The rule manager is delivered with a default set of internal schema files. The software compiles
this internal set of files into the .dll file of the rule manager. You cannot see or edit these internal
files.
A set of custom schema files containing the same information is also delivered for dimensions
and for labels. The Custom_ prefix indicates that the file contains information that you can
modify.

 The custom schema files delivered in the


[SharedContent]\Data\Drawings\LabelUISchemaData folder are used for regular labels,
matchline labels, and north arrow labels.
 The custom schema files delivered in the
[SharedContent]\Data\Drawings\DimensionUISchemaData folder are used for dimensions.
As the rule manager loads a rule, the software first checks to see whether any custom schema
files for the selected modules and properties exist. The software also compares the

Drawings and Reports Reference Data Guide 1066


Appendix: Annotation Rule Manager Customization

SCHEMA_VERSION attribute in each custom schema file root node to the SCHEMA_VERSION
attribute in the corresponding internal schema file. If the custom schema file is outdated, the rule
manager loads the internal schema file with the default delivered settings instead of the custom
schema file.
The rule manager displays a message and records a problem in the Smart3D error log in the
following cases:
 The software cannot find a custom schema file
 A custom schema file is outdated
 The software cannot load the internal schema file
See Also
Label Rule Manager (on page 1099)
Schema File Types (on page 1067)

Schema File Types


Module Schema File
A single module schema .xml file is delivered for each drawing label annotation module (.dll file)
used in template .xml files.
Each module schema file and each corresponding .dll file share the same name, with
the exception of the Custom_ prefix and the file extension.
Module schema files contain module compatibility information organized by project type: plant
(SP3D), marine (SM3D), or mining (MHE). Within each project type, the information further
breaks down by module type, for example, point generator, geometric analyzer, and so forth.
Each module schema file also contains the names of its supported properties and property
groups, if applicable.
All non-header .xml nodes in each module schema file are descendants of the
root-level <LABEL_UI_MODULE> or <DIMENSION_UI_MODULE> node section.

Common Modules Schema File


A common modules schema file (one for regular, north arrow, and matchline labels, and one for
dimensions) contains all possible label or dimension annotation module .dll names and ProgIDs,
as well as whether each module should be written to the .xml template file as a .dll filename or a
ProgID. The file also contains the corresponding rule manager display name for each module.
The common module schema files are:
 Custom_DrawingLabelUIModulesCommon.xml - Contains all possible regular, north arrow,
and matchline label annotation modules
 Custom_DrawingDimensionUIModulesCommon.xml - Contains all possible dimension
annotation modules
Only new custom modules can use the display names contained in the common modules
schema files. Delivered modules use display names that are compiled into the rule manager .dll
file and cannot be changed.
All annotation modules in these files are broken down by project and module type.
All non-header .xml nodes in these schema files are descendants of the root-level
<LABEL_UI_MODULES_COMMON> or <DIMENSION_UI_MODULES_COMMON> node section.

Drawings and Reports Reference Data Guide 1067


Appendix: Annotation Rule Manager Customization

Common Properties Schema File


A unique common properties schema file contains definitions for all possible properties that are
used by the various modules. The common properties schema files are:
 Custom_DrawingLabelUIPropertiesCommon.xml - For labels
 Custom_DrawingDimensionUIPropertiesCommon.xml - For dimensions
All non-header .xml nodes in these schema files are descendants of the root-level
<LABEL_UI_PROPERTIES_COMMON> or <DIMENSION_UI_PROPERTIES_COMMON> node
section.

Reserved Tags Schema Files


Two reserved tags schema files are delivered: Custom_ReservedTags.xml and
Custom_ReservedSymbolTags.xml.
 Custom_ReservedTags.xml - Lists .xml template nodes that the software does not overwrite
when you click Save from within the Rule Manager. Most of the information in the reserved
tags does not display in the Rule Manager. However, because these nodes are not
overwritten, the functionality of the nodes remains guaranteed for drawing updates, even
though the Rule Manager does not recognize the nodes.
All non-header .xml nodes in this schema file are children of the root-level
<ReservedTemplateTags> node section.
 Custom_ReservedSymbolTags.xml - Lists .xml template nodes that refer to label symbol
files. You use this list to specify which symbol files the software copies when you select the
Copy Rule command. For more information, see Copy a Rule in the Drawings and Reports
Reference Data Guide.
All non-header .xml nodes in this schema file are children of the root-level
<ReservedSymbolTags> node section.
See Also
XML Structure of Supported Properties (on page 1072)
Reserved Tags (on page 1094)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
User Interface Schema Overview (on page 1066)

Module-to-Module Compatibilities
The following types of modules make automatic placement of drawing annotations possible:
 Point generators
 Geometric analyzers
 Annotation control generators
 Content modules
 Positioning modules
 Leader modules (Label Rule Manager only)
While each type of module performs a different role in placing a regular label, matchline label,
dimension, or north arrow on the drawing sheet, each module is only compatible with a certain

Drawings and Reports Reference Data Guide 1068


Appendix: Annotation Rule Manager Customization

subset of other modules. Each module schema file specifies these module-to-module
compatibilities. Additionally, you can edit these module compatibilities.
Although you can combine any modules in an .xml template, there are module code restrictions.
As a result, the drop-down list box for each module type that displays in the Rule Manager only
contains modules that are compatible with the modules currently selected.
If you combined modules in the .xml template that are incompatible according to the
schema, the software accepts the template and displays the incompatible modules in the rule
manager. However, if you change one of the incompatible modules in the rule manager, the
software automatically removes that module from the drop-down list box.
See Also
Label Rule Manager (on page 1099)
Dimension Rule Manager (on page 1503)

XML Structure of Compatible Modules


Each module schema file contains a node section called <COMPATIBLE_MODULES>. This
section may contain one or more project nodes.

Project Nodes
If a schema file for a module contains one or more of the project type node sections listed
below, then that module is compatible with other modules within those project types.
 <SP3D>…</SP3D>
 <SM3D>…</SM3D>
 <MHE>…</MHE>

Annotation Module Nodes


Each project type node section can contain any combination of the annotation module type node
sections listed below.
 <POINT_GENERATOR_MODULES>…</POINT_GENERATOR_MODULES>
 <GEOMETRIC_ANALYZER_MODULES>…</GEOMETRIC_ANALYZER_MODULES>
 <ANNOTATION_CONTROL_GENERATOR_MODULES>…
</ANNOTATION_CONTROL_GENERATOR_MODULES>
 <CONTENT_MODULES>…</CONTENT_MODULES>
 <POSITIONING_MODULES>…</POSITIONING_MODULES>
 <LEADER_MODULES>…</LEADER_MODULES>
Leader modules are used for labels, north arrows, and matchlines, but are not used
for dimensioning.
If a schema file for a module contains one or more of these annotation module type node
sections, then that module is compatible with annotation modules of those types. For example, if
the <POINT_GENERATOR_MODULES> annotation module type node section is listed under the
<SM3D> project type node section in a schema file for a module, then that module is compatible
with at least one marine point generator.
Finally, each annotation module type node section can contain any of the nodes listed below.

Drawings and Reports Reference Data Guide 1069


Appendix: Annotation Rule Manager Customization

 <POINT_GENERATOR_MODULE>ModuleSchemaFilenameWithoutExtension
</POINT_GENERATOR_MODULE>
 <GEOMETRIC_ANALYZER_MODULE>ModuleSchemaFilenameWithoutExtension
</GEOMETRIC_ANALYZER_MODULE>
 <ANNOTATION_CONTROL_GENERATOR_MODULE>
ModuleSchemaFilenameWithoutExtension
</ANNOTATION_CONTROL_GENERATOR_MODULE>
 <CONTENT_MODULE>ModuleSchemaFilenameWithoutExtension
</CONTENT_MODULE>
 <POSITIONING_MODULE>ModuleSchemaFilenameWithoutExtension
</POSITIONING_MODULE>
 <LEADER_MODULE>ModuleSchemaFilenameWithoutExtension
</LEADER_MODULE>
If any of these nodes are listed in an annotation module type node section in a module schema
file, then that module is compatible with the other modules specified in the file. For example, if a
positioning module is listed in an annotation module type node section, then the module is
compatible with that positioning module.
You can add the CONTENT_SUPPORTED attribute to <CONTENT_MODULE> nodes to control the
behavior of unsupported label content modules in the Label Rule Manager. For more
information, see CONTENT_SUPPORTED (on page 1071).
A SYMBOL_FILE attribute set to False on a <CONTENT_MODULE> node indicates that the label
content module does not use a symbol file. For more information, see SYMBOL_FILE (on page
1072).

DefaultLabelControlGenerator
The only annotation control generator module currently delivered for labels is the
DefaultLabelControlGenerator. You can use this module for regular labels, matchline labels,
and north arrows in all three environments (plant, marine, and material handling) because it is
delivered with the plant environment.
Because every delivered label must be compatible with the DefaultLabelControlGenerator,
each label module schema file except Custom_DefaultLabelControlGenerator.xml must contain
the following logical node path:
<LABEL_UI_MODULE>
<COMPATIBLE_MODULES>
<SP3D>
<ANNOTATION_CONTROL_GENERATOR_MODULES>
<ANNOTATION_CONTROL_GENERATOR_MODULE>
DefaultLabelControlGenerator
</ANNOTATION_CONTROL_GENERATOR_MODULE>

Template XML
A template can only contain one of each of the following annotation module node sections:
 Point Generator
 Geometric Analyzer

Drawings and Reports Reference Data Guide 1070


Appendix: Annotation Rule Manager Customization

 Annotation Control Generator


 Content
 Leader (Label Rule Manager only)
Because of this restriction, these five types of modules are incompatible with other modules of
the same type. For example, you cannot have a <GEOMETRIC_ANALYZER_MODULES> node
section in a geometric analyzer module schema file.
Positioning modules are the only type of annotation modules that can be compatible
with other modules of the same type. Because each label template can specify multiple
positioning modules, a positioning module schema file can contain a
<POSITIONING_MODULES> section to indicate compatibilities with other positioning modules.
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
Module-to-Module Compatibilities (on page 1068)

CONTENT_SUPPORTED
Restricts the behavior of a label content module in the Label Rule Manager.
The CONTENT_SUPPORTED attribute on the <CONTENT_MODULE> node is False for
unsupported content modules in the delivered common modules schema file. When this attribute
is False, the software treats these modules as unsupported in the Label Rule Manager. The
Label Rule Manager does not display unsupported modules in the Content Module list.

 When you load the Label Rule Manager, the Content Module list appears dimmed if the
unsupported content module is referenced in the label .xml template.
 An unsupported label content module has a dependency on one or more .xml template
nodes or attributes that do not correspond to specific properties in the label UI schema.
If you delete the CONTENT_SUPPORTED attribute or change its value to True in the common
modules schema file for an unsupported content module, the software treats the content module
as supported. Therefore, we recommend leaving the CONTENT_SUPPORTED attribute set to
False in the delivered common modules schema file to prevent the following issues from
causing problems in the Label Rule Manager and drawing updates.
 The Content Module list displays an unsupported content module even though the label UI
schema does not contain definitions for all the required .xml template properties for that
module.
 The Content Module list displays and allows you to select supported and unsupported
content modules even though the referenced label .xml template contains an unsupported
content module. Both cases can cause problems. If you select a supported content module
from the list, the software writes extra .xml nodes that correspond to unused properties of
the unsupported content module to the template. If you select another unsupported content
module from the list, the label UI schema might not have all of the necessary module
properties.
The following shows the CONTENT_SUPPORTED attribute set to False in the common modules
schema file:

Drawings and Reports Reference Data Guide 1071


Appendix: Annotation Rule Manager Customization

<CONTENT_MODULE NAME="DrawingEquipmentStyle2Content" …
CONTENT_SUPPORTED="False" … />
See Also
XML Structure of Compatible Modules (on page 1069)
Schema File Types (on page 1067)

SYMBOL_FILE
Specifies that a label, north arrow, or matchline content module does not use any symbol files.
The SYMBOL_FILE attribute on the <CONTENT_MODULE> node is False for content modules in
the delivered common modules schema file that do not use symbol files. The False setting
prevents the software from checking for symbol files when you load the Label Rule Manager.
If the SYMBOL_FILE attribute is set to True, or if the attribute is missing, the software checks
for the symbol file when you load the Rule Manager. If the symbol file is missing, the software
displays a warning message and prompts you to browse for another symbol file.
The following shows the SYMBOL_FILE attribute set to False in the common modules schema
file:
<CONTENT_MODULE NAME="DrawingNoContent" … SYMBOL_FILE="False" … />

See Also
Schema File Types (on page 1067)
XML Structure of Compatible Modules (on page 1069)

XML Structure of Supported Properties


While not a requirement, each module schema file can contain a <SUPPORTED_PROPERTIES>
node section. This section can contain one or more <PROPERTY_GROUP> nodes, as well as one
or more <PROPERTY> nodes.
A property group is a collection of one or more properties that can repeatedly appear in
a template. For example, the delivered whiteObjs property group for labels contains one
property for specifying a white object layer. However, because that property exists inside of a
group, you can specify the White Object Layer property multiple times. Therefore, a label
template can contain more than one white object layer.
Supported properties and property groups appear in the schema file as follows.
 <PROPERTY>PropertyName</PROPERTY>
 <PROPERTY_GROUP>PropertyGroupName</PROPERTY_GROUP>
If any properties in the <SUPPORTED_PROPERTIES> section have
dependency relationships, you must list the parent property first, followed by the dependent
properties.

 Property names and property groups that are used for labels, north arrows, and matchlines
are defined in the Custom_DrawingLabelUIPropertiesCommon.xml schema file.
 Property names and property groups that are used for dimensions are defined in the
Custom_DrawingDimensionUIPropertiesCommon.xml schema file.

Drawings and Reports Reference Data Guide 1072


Appendix: Annotation Rule Manager Customization

See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)

XML Structure for Property and Property Group Definitions


The Custom_DrawingLabelUIPropertiesCommon.xml schema file contains all property and
property group definitions used for labels, north arrows, and matchlines. The
Custom_DrawingDimensionUIPropertiesCommon.xml schema file contains all property and
property group definitions used for dimensions. The syntax definitions allow for multiple different
behaviors.
Each property definition exists inside of the <PROPERTY
NAME="PropertyName">...</PROPERTY> node. PropertyName is the name that is specified
in the module schema file as <PROPERTY>PropertyName.
In the same way, the <PROPERTY_GROUP
NAME="PropertyGroupName">…</PROPERTY_GROUP> node section holds each property
group definition. Here, PropertyGroupName is the name that is specified in the module schema
file as <PROPERTY_GROUP>PropertyGroupName</PROPERTY_GROUP>.
Property group definitions support an additional attribute, MIN_OCCUR, shown in the example
below.
<PROPERTY_GROUP NAME="PropertyGroupName"
MIN_OCCUR="1">…</PROPERTY_GROUP>
In this example, the MIN_OCCUR attribute is defined as 1; therefore, all of the properties in the
sample PropertyGroupName group must occur at least once in the rule manager property grid.
The structure of each property definition contained in a property group definition within the
schema is identical to non-grouped property definitions. However, all properties within a property
group are logically joined. Therefore, these properties must occur as a single unit in the rule
manager. See the location_id_targetName property group definition example below.

Drawings and Reports Reference Data Guide 1073


Appendix: Annotation Rule Manager Customization

<PROPERTY_GROUP NAME="location_id_targetName" MIN_OCCUR="1">


<PROPERTY NAME="location_id_targetName_id">
<XML_PATH>label/pointGeneratorSettings/pgModule
Settings/locations/location/@id</XML_PATH>
<DISPLAY>Location ID</DISPLAY>
<HELP_ID>170563</HELP_ID>
<CONTROL>
<TYPE>Dropdown</TYPE>
<POSSIBLE_VALUES>
<DATA_TYPE>Integer</DATA_TYPE>
<POPULATE>
<VALUE NAME="Top">7</VALUE>
<VALUE NAME="Bottom">8</VALUE>
<VALUE NAME="Middle">1</VALUE>
<DEFAULT>Middle</DEFAULT>
</POPULATE>
</POSSIBLE_VALUES>
</CONTROL>
</PROPERTY>
<PROPERTY NAME="location_id_targetName_targetName">
<XML_PATH>label/pointGeneratorSettings/
pgModuleSettings/locations/location/
@targetName</XML_PATH>
<DISPLAY>Location Target Name</DISPLAY>
<HELP_ID>170572</HELP_ID>
<CONTROL>
<TYPE>Dropdown</TYPE>
<POSSIBLE_VALUES>
<DATA_TYPE>String</DATA_TYPE>
<POPULATE>
<VALUE NAME="Web">
Profile_Web</VALUE>
<VALUE NAME="Flange">
Profile_Flange</VALUE>
<DEFAULT>Web</DEFAULT>
</POPULATE>
</POSSIBLE_VALUES>
</CONTROL>
</PROPERTY>
</PROPERTY_GROUP>
Each property in this property group is written as a value of an individual attribute of the
<location> node. The software is not required to write the properties in property groups to the
template as .xml attributes because these properties might also exist as node values in the
template .xml file.
By convention, delivered property groups use the underscore (_) character. For example, a
property group might define values that relate to the logical concept of location. The property
group might further contain three properties named A, B, and C. In this case, the property group
is named location_A_B_C.

Drawings and Reports Reference Data Guide 1074


Appendix: Annotation Rule Manager Customization

By convention, the software creates a new name for each property within the group by joining
the property group name with the property name. For example, the name for property A in the
previous example is location_A_B_C_A.

 You can give any unique name to property groups and properties that you define.
 By convention, you can append a numeral to the end of each name to prevent conflict
between almost identically named properties and property groups. For example, if you
define two properties for editing color, the convention is to name the properties color1
and color2.
Many different .xml nodes, attributes, and special characters represent each piece of a property
or property group schema definition. These nodes, attributes, and special characters are
discussed in the following sections.
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)

ATTRIBUTE and ATTRIBUTE_VALUE


The ATTRIBUTE and ATTRIBUTE_VALUE properties specify the name and value of an
attribute of an .xml property.
ATTRIBUTE and ATTRIBUTE_VALUE exist as attributes of the XML_PATH node. For more
information, see XML_PATH (on page 1092).
Use ATTRIBUTE and ATTRIBUTE_VALUE together when an XML_PATH value refers to a rule
or template node with an .xml hierarchical location that has multiple properties in the path.

Example 1
The following shows an excerpt from a matchline template file. The four ID property values are
Matchline\MatchlineNorth.rtp, Matchline\MatchlineWest.rtp, Matchline\MatchlineSouth.rtp,
and Matchline\MatchlineEast.rtp.
<label>
<content>
<contentModule value="DrawingMatchlineContent"/>
<ID attributeName="Matchline"
type="North">Matchline\MatchlineNorth.rtp</ID>
<ID attributeName="Matchline"
type="West">Matchline\MatchlineWest.rtp</ID>
<ID attributeName="Matchline"
type="South">Matchline\MatchlineSouth.rtp</ID>
<ID attributeName="Matchline"
type="East">Matchline\MatchlineEast.rtp</ID>
</content>
</label>
In the common properties schema file, if you specify the .xml location for the
Matchline\MatchlineWest.rtp property as <XML_PATH>label/content/ID</XML_PATH>, the
software does not read all of the properties at that path, and thus uses the ID node that
corresponds to the Matchline\MatchlineNorth.rtp value because it is the first node in the path.
To correct this ambiguity, use the ATTRIBUTE and ATTRIBUTE_VALUE properties in the

Drawings and Reports Reference Data Guide 1075


Appendix: Annotation Rule Manager Customization

common properties schema file to specify which ID node in the template file contains the
required .rtp file.

Example 2
The following shows how to use ATTRIBUTE and ATTRIBUTE_VALUE to specify the ID node
for the Matchline\MatchlineWest.rtp file.
<XML_PATH ATTRIBUTE="type"
ATTRIBUTE_VALUE="West">label/content/ID</XML_PATH>

Example 3
The following shows how to use ATTRIBUTE and ATTRIBUTE_VALUE to specify the
attributeName attribute for the Matchline\MatchlineWest.rtp file.
<XML_PATH ATTRIBUTE="type"
ATTRIBUTE_VALUE="West">label/content/ID/@attributeName</XML_PATH>
See Also
XML_PATH (on page 1092)

Braces
Braces {} within a property definition indicate a reference to the value of another property in the
schema, as in the following example:
<RANGE>
<MIN TYPE="Inclusive">0</MIN>
<MAX TYPE="Inclusive">{maxOffset}</MAX>
<DEFAULT>0</DEFAULT>
</RANGE>
In the above example, {maxOffset} indicates that the maximum value allowed for the
minOffset property must equal the value set for the maxOffset property. In this way, the
software makes sure that the minOffset value does not exceed the maxOffset value.
Braces act as simple text replacements for property values and therefore have many
applications in schema property definitions.
See Also
RANGE (on page 1088)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

Drawings and Reports Reference Data Guide 1076


Appendix: Annotation Rule Manager Customization

CONDITION
Allows you to specify conditional branches in the schema. You must specify at least one
attribute that defines the condition for which to test, along with the CONDITION node. The
CONDITION_DEFAULT node acts as a fallback for the condition if no conditions pass.
CONDITION nodes behave like if statements in procedural programming languages.
Likewise, CONDITION_DEFAULT nodes behave like else statements.
If multiple CONDITION statements are stacked, then each subsequent CONDITION behaves
like an else if statement. For example:
 <CONDITION case1="case1_value" case2="case2_value" …
>value_for_first_condition</CONDITION>
 <CONDITION case3="case3_value" case4="case4_value" …
>value_for_second_condition</CONDITION>
 <CONDITION_DEFAULT>fallback value</CONDITION_DEFAULT>
In the example below, the condition tests to see whether the DrawingLinearLeader module is
the chosen leader module. If it is, the condition evaluates to 0.005. However, if the chosen
leader module is not DrawingLinearLeader, the condition evaluates to 0.015.
<DEFAULT>
<CONDITION LEADER_MODULE="DrawingLinearLeader">
0.005</CONDITION>
<CONDITION_DEFAULT>0.015</CONDITION>
</DEFAULT>
In the previous example, the CONDITION and CONDITION_DEFAULT nodes fall within the
<DEFAULT> section. This means that the value evaluated for the condition applies to the default
value for the property.
Conditional statements can apply to entire properties, or to the CONTROL,
POPULATE, and DEFAULT nodes.
The following table gives additional information about conditional statements.

CONDITION APPLIES TO SCHEMA XML SYNTAX NOTES

Entire property The CONDITION node completely If the condition passes when the CONTROL
encloses the CONTROL node. As an node exists inside of a CONDITION node,
example, see the delivered dimension then the Rule Manager displays the property.
property. However, if the condition fails, then the Rule
Manager does not display the property.
CONDITION_DEFAULT is not allowed as a
conditional for an entire property.

CONTROL node The CONTROL node completely If the condition passes, then the Rule
encloses CONDITION and Manager displays a specific option, such as a
CONDITION_DEFAULT nodes. drop-down, for editing. However, if the
Currently, no delivered properties exhibit condition fails, then the software displays an
this behavior, though the schema does alternate option for editing the property, such
support it. as a text box.

POPULATE node The POPULATE node completely The property uses a specified set of stored
encloses CONDITION and display values, as well as one default value
CONDITION_DEFAULT nodes. As an for the display option, if the condition passes.

Drawings and Reports Reference Data Guide 1077


Appendix: Annotation Rule Manager Customization

example, see the delivered label However, if the condition fails, the property
property, orientation5. uses an alternate set of stored display values,
as well as an alternate default value for the
display option.

DEFAULT node The DEFAULT node completely The property uses a specified default value
encloses CONDITION and for the property if the condition passes.
CONDITION_DEFAULT nodes. See the However, if the condition fails, the property
delivered property hOffset as an uses an alternate default value for the
example. property.

Each case name in a condition is the name of a property in the


Custom_DrawingLabelUIPropertiesCommon.xml schema file and in the
Custom_DrawingDimensionUIPropertiesCommon.xml schema file. Therefore, you might see the
following conditions:
 Conditions for checking whether modules are set to certain values.
<CONDITION CONTENT_MODULE="DrawingWeldSymbols">
The .dll names of modules, not display names, appear in conditional statements.
 Conditions for checking whether module properties are set to certain values.
<CONDITION placeLines="True">
Quoted values in conditional statements are always display values and not stored
.xml values. For example, the line <CONDITION placeLines="True"> within the
placeLinesOnSheet label property definition causes the software to display the
placeLinesOnSheet property only when the placeLines property is selected in the Label Rule
Manager. However, the line cannot read <CONDITION placeLines="-1"> because -1 is a
stored value in the placeLines property definition and is not a display value.

AND/OR Syntax
The Boolean operators * (and) and | (or) allow you to join or exclude cases in a condition. The
following example shows that the test value might contain these operators for each case in a
condition.
<CONDITION case1="value1|value2|value3"
case2="value4*value5">…</CONDITION>
In this instance, the condition checks whether case1 matches value1, value2, or value3. The
condition also requires that case2 must match both value4 and value5.

 If there is more than one case for a single CONDITION statement (for example, both case1
and case2, as above), all cases in that CONDITION node must pass for the condition to
pass as a whole.
 The schema allows only one type of Boolean operator within each case string. For example,
case1="value1|value2|value3" is a valid string. On the other hand,
case1="value1|value2*value3" is an invalid string.

Drawings and Reports Reference Data Guide 1078


Appendix: Annotation Rule Manager Customization

NEGATION Syntax
The negation Boolean operator ! (exclamation point) displays as a prefix and indicates reversed
Boolean logic. For example, the following schema example demonstrates the positioning
module ISDwgPositionByCurve2D prefixed with the negation operator:
<CONDITION POSITIONING_MODULE="!ISDwgPositionByCurve2D">
The negation Boolean operator in the example above shows that the condition passes only if
you have not chosen the ISDwgPositionByCurve2D positioning module.
You can join negation Boolean operators in the same case value. For example, you
can specify the following condition:
<CONDITION case="!value1*!value2*!value3">…</CONDITION>
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

CONTROL
Refers to a high-level container node that wraps around child nodes that define actual controls.
CONTROL exists as a child node under the PROPERTY node, as in the following example:
<PROPERTY NAME="PropertyName">
<CONTROL>
The CONTROL node does not directly define the behavior of any display options.
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

DATA_TYPE
Used to establish the type of data that is stored in the .xml template for the specified property.
The node exists as a child node under the POSSIBLE_VALUES node, as follows:
<POSSIBLE_VALUES>
<DATA_TYPE>Double</DATA_TYPE>
DATA_TYPE can assume any of the following values:
 Double
 Integer
 String
When you specify a double value for DATA_TYPE, the software expects to write a floating point
decimal to the .xml file when you click Save.
When you specify an integer value for DATA_TYPE, the software expects to write an integer to
the .xml file when you click Save.

Drawings and Reports Reference Data Guide 1079


Appendix: Annotation Rule Manager Customization

When you specify a string value, the software expects to write a string of textual characters
when you click Save.
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

DEFAULT
Allows you to specify a default display value for a new or existing property. The Rule Manager
uses a default value whenever the property does not exist in the template file. For a property
that uses a text box as the editing option, you can omit the default value. As an example, see
the delivered dimLayer property for dimensions.
Schema property default values are the same as code property default values. The
modules use these code default values during a drawing update in case the properties do not
appear in the .xml template.
In the case of check box and drop-down options, DEFAULT exists as a child node under the
POPULATE node.
<POPULATE>
<VALUE NAME="True">-1</VALUE>
<VALUE NAME="False">0</VALUE>
<DEFAULT>False</DEFAULT>
As a child of POPULATE, the value for DEFAULT always reflects the value of one of the NAME
attributes of a VALUE node. In the example above, DEFAULT takes the NAME attribute, False,
and not the value 0.
In the case of text boxes, DEFAULT exists as a child node under the RANGE node.
<RANGE>
<DEFAULT>0</DEFAULT>
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

DISPLAY (Property Name)


Specifies the property's display name in the Rule Manager's property grid.
<PROPERTY NAME="PropertyName">
<DISPLAY>Property Display Name</DISPLAY>
DISPLAY is not supported by delivered properties. Instead, a localized resource file in the
software source code defines the display names for delivered properties. The software uses
DISPLAY with newly created custom properties that do not have names in the resource file.
See Also
DISPLAY (Value Range) (on page 1081)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

Drawings and Reports Reference Data Guide 1080


Appendix: Annotation Rule Manager Customization

DISPLAY (Value Range)


Specifies that the displayed value of a property must fall within a fixed numeric range that differs
from the stored label template .xml value range.
Currently, only the delivered percentageOffset label property exists as an example of DISPLAY
(Value Range). For this property, the software expects to find a decimal number in the range
[0,1] in the .xml template value. However, because percentages normally fall within the range of
0 to 100, the software translates the decimal values as shown in the table below, and displays
this property as an integer in the range [0,100].

TEMPLATE XML VALUE DISPLAY VALUE

0.0 0

0.3 30

0.5 50

1.0 100

DISPLAY (Value Range) exists as a child node of the RANGE node:


<POSSIBLE_VALUES>
<DATA_TYPE>Double</DATA_TYPE>
<RANGE>
<MIN TYPE="Inclusive">0</MIN>
<MAX TYPE="Inclusive">1</MIN>
<DEFAULT>0</DEFAULT>
<DISPLAY DATA_TYPE="Integer">
<MIN TYPE="Inclusive">0</MIN>
<MAX TYPE="Inclusive">100</MAX>
</DISPLAY>
</RANGE>
</POSSIBLE_VALUES>
<DATA_TYPE> is the data type of the property value in the .xml template. <DISPLAY
DATA_TYPE> is the data type of the property's display value in the Rule Manager.
See Also
DISPLAY (Property Name) (on page 1080)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

Drawings and Reports Reference Data Guide 1081


Appendix: Annotation Rule Manager Customization

EXTERNAL_SOURCE
Loads the data for selection options in the Rule Manager from an external source, such as a
style file.
Because it is a high-level container node, EXTERNAL_SOURCE does not convey
any information.
EXTERNAL_SOURCE exists as a child node under the POPULATE node:
<POPULATE>
<EXTERNAL_SOURCE>
See Also
POPULATE (on page 1087)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

FILE
Specifies the external file to load into the editing options for the current property.
If the FILE tag refers to Styles.sha, the software also examines ISSTYLES.sha for the
required data. The software uses styles from these files when presenting objects such as lines,
leaders, and dimensions in a drawing.
FILE exists as a child node under the EXTERNAL_SOURCE node:
<EXTERNAL_SOURCE>
<FILE>Styles.sha</FILE>

See Also
EXTERNAL_SOURCE (on page 1082)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

Drawings and Reports Reference Data Guide 1082


Appendix: Annotation Rule Manager Customization

GATHER
Specifies what data to request from the external source file to load into the drop-down options
for the current property.
Currently, GATHER supports two values:
 DimensionStyles
 LinearStyles
The software gathers the necessary styles from the style files and adds them to the drop-down
options for the current property. The drop-down options are displayed alphabetically.
GATHER exists as a child node under the EXTERNAL_SOURCE node:
<EXTERNAL_SOURCE>
<GATHER>DimensionStyles</GATHER>
See Also
EXTERNAL_SOURCE (on page 1082)
FILE (on page 1082)

HELP_ID
Specifies a numeric help ID for a property name or module type.
Each help topic exists in a separate help file. The software opens the
[Smart3DInstallDirectory]\Documentation\HTML\HELP_ID.htm file and locates the correct help
file. HELP_ID is the number defined in the schema for this module type or property. When you
click a property name or module type in the Rule Manager, the related help topic displays in the
Information pane on the right.
HELP_ID exists as a child node under the PROPERTY node:
<PROPERTY NAME="PropertyName">
<HELP_ID>123456</HELP_ID>
If a user-defined property does not have a corresponding HELP_ID, or if the software
does not find a help file, a Help File is Missing message displays in the Information pane.
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

Drawings and Reports Reference Data Guide 1083


Appendix: Annotation Rule Manager Customization

LOCATION
Allows you to specify that the software should read or write a property from a rule .xml file
instead of a template .xml file.

 If LOCATION is set to Rule, the value of the XML_PATH node is the path to the property in
the rule file.
 If LOCATION is absent, the value of the XML_PATH node is the path to the property in the
template file.
LOCATION exists as an attribute of the XML_PATH node.
In the following example, the RULE/ACTION/VALUE hierarchy exists in the rule file.
<XML_PATH LOCATION="Rule" SIBLING="CATEGORY"
SIBLING_VALUE="VHL_VisibleLineStyle">RULE/ACTION/VALUE</XML_PATH>

See Also
XML_PATH (on page 1092)

MATH
Specifies a value for the MIN or MAX properties. This value exists as a non-numeric
mathematical constant text string.

 The Rule Manager only supports two possible values for MATH:
 HalfPi, which is internally represented as 1.5707963267948966192313216916398
 NegativeHalfPi, which is internally represented as
-1.5707963267948966192313216916398
MATH exists as a child node of either the MIN node or the MAX node.
<MIN TYPE="Exclusive">
<MATH>NegativeHalfPi</MATH>
<MAX TYPE="Inclusive">
<MATH>HalfPi</MATH>

See Also
MAX (on page 1085)
MIN (on page 1085)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

Drawings and Reports Reference Data Guide 1084


Appendix: Annotation Rule Manager Customization

MAX
Specifies the maximum allowed value that you can type into a text box. You use MAX with the
TYPE attribute.
You can use MAX with the MIN property.
TYPE can take one of two values:
 Inclusive - the allowed value range includes the value specified. For example, <MAX
TYPE="Inclusive">90</MAX> means that the value of the property must be less than or
equal to 90.
 Exclusive - the allowed value range excludes the value specified. For example, <MAX
TYPE="Exclusive">90</MAX> means that the value of the property must be less than
but not equal to 90.
MAX exists as a child node of the RANGE node:
<RANGE>
<MAX TYPE="Inclusive">100</MAX>
See Also
MIN (on page 1085)
TYPE (on page 1089)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

MIN
Specifies the minimum allowed value that you can type into a text box. You use MIN with the
TYPE attribute.
You can use MIN along with the MAX property.
TYPE takes one of two values:
 Inclusive – the allowed value range includes the value specified. For example, <MIN
TYPE="Inclusive">0</MIN> indicates that the value of the property must be greater
than or equal to 0.
 Exclusive – the allowed value range excludes the value specified. For example, <MIN
TYPE="Exclusive">0</MIN> indicates that the value of the property must be greater
than but not equal to 0.
MIN exists as a child node of the RANGE node:
<RANGE>
<MIN TYPE="Inclusive">1</MIN>
See Also
MAX (on page 1085)
TYPE (on page 1089)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

Drawings and Reports Reference Data Guide 1085


Appendix: Annotation Rule Manager Customization

ORDER
Allows you to sort results gathered from an external source. You can sort these results in either
ascending or descending alphabetical order.
The software currently does not use the ORDER property.
ORDER exists as a child node under the EXTERNAL_SOURCE node:
<EXTERNAL_SOURCE>
<ORDER>Ascending</ORDER>

See Also
EXTERNAL_SOURCE (on page 1082)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

ORDINAL
Allows you to specify a drop-down option taken from an external source as a default value.
ORDINAL can take values such as First or Last, or the name of a specific drop-down option.
The software currently does not use the ORDINAL property.
ORDINAL exists as a child node under the DEFAULT node of POPULATE:
<POPULATE>
<DEFAULT>
<ORDINAL>First</ORDINAL>
See Also
DEFAULT (on page 1080)
POPULATE (on page 1087)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

PARENT
Specifies a parent-child property relationship. The child property only displays in the Rule
Manager when you assign a value to the parent property.
PARENT exists as an attribute on the PROPERTY node.
<PROPERTY NAME="PropertyName" PARENT="ParentPropertyName">

 If a label property does not belong to a property group, then any other property in the
Custom_DrawingLabelUIPropertiesCommon.xml schema file can serve as the PARENT
attribute value.
 If a dimension property does not belong to a property group, then any other property in the
Custom_DrawingDimensionUIPropertiesCommon.xml schema file can serve as the
PARENT attribute value.

Drawings and Reports Reference Data Guide 1086


Appendix: Annotation Rule Manager Customization

 If the property does belong to a property group, then any other property in the same
property group can serve as the PARENT attribute value.
See the interfaceName and propertyValue label properties as an example.
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

POPULATE
Acts as a container node that holds other nodes. The POPULATE node allows you to specify
the check box and drop-down options in the Rule Manager.
POPULATE supports MODULE_TYPE, an optional .xml attribute. This attribute specifies that
the POPULATE property is a module pseudo-property that refers to a module and not to the
property of a module. MODULE_TYPE takes one of six values:
 POINT_GENERATOR_MODULE
 GEOMETRIC_ANALYZER_MODULE
 ANNOTATION_CONTROL_GENERATOR_MODULE
 CONTENT_MODULE
 POSITIONING_MODULE
 LEADER_MODULE (Label Rule Manager only)
POPULATE exists as a child node under the POSSIBLE_VALUES node:
<POSSIBLE_VALUES>
<POPULATE MODULE_TYPE="POINT_GENERATOR_MODULE">
See Also
POSSIBLE_VALUES (on page 1087)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

POSSIBLE_VALUES
Acts as a high-level container node that holds other nodes. POSSIBLE_VALUES alone does not
define any data. Instead, the node uses descendant nodes to define data. The contents of this
node determine data limits as well as property behaviors.
POSSIBLE_VALUES exists as a child node under the CONTROL node:
<CONTROL>
<POSSIBLE_VALUES>
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

Drawings and Reports Reference Data Guide 1087


Appendix: Annotation Rule Manager Customization

PROGID
Allows you to load a property option into the Rule Manager. The PROGID node uses results
gathered from a custom external program using that program’s programmatic identifier, or
ProgID.
The software currently does not use the PROGID node.
PROGID exists as a child node under the EXTERNAL_SOURCE node:
<EXTERNAL_SOURCE>
<PROGID>Project.GetEquivalenceLabel</PROGID>
See Also
EXTERNAL_SOURCE (on page 1082)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

RANGE
Contains other nodes that specify value limits, as well as default text box options.
The RANGE property alone does not define data.
RANGE exists as a child node of the POSSIBLE_VALUES node:
<POSSIBLE_VALUES>
<RANGE>

See Also
POSSIBLE_VALUES (on page 1087)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

SIBLING and SIBLING_VALUE


The SIBLING and SIBLING_VALUE properties specify the name and value of the sibling node of
an .xml property. Sibling nodes have the same parent node.
SIBLING and SIBLING_VALUE exist as attributes of the XML_PATH node. For more
information, see XML_PATH (on page 1092).
Use SIBLING and SIBLING_VALUE together when an XML_PATH value refers to a rule or
template node with an .xml hierarchical location that has multiple properties in the path.

Example 1
The following shows an excerpt from a dimension rule file. The property names are the values of
the CATEGORY nodes VHL_VisibleLineStyle, VHL_HiddenLineStyle, and
VHL_OccludedLineStyle. Each property value is contained in the VALUE node that is a sibling
of that property's <CATEGORY> node. In the following example, the respective category
property values are Double Chain Black Matchline, Dotted, and Dashed Red.

Drawings and Reports Reference Data Guide 1088


Appendix: Annotation Rule Manager Customization

<RULE>
<ACTION>
<CATEGORY>VHL_VisibleLineStyle</CATEGORY>
<VALUE type="string">Double Chain Black Matchline</VALUE>
</ACTION>
<ACTION>
<CATEGORY>VHL_HiddenLineStyle</CATEGORY>
<VALUE type="string">Dotted</VALUE>
</ACTION>
<ACTION>
<CATEGORY>VHL_OccludedLineStyle</CATEGORY>
<VALUE type="string">Dashed Red</VALUE>
</ACTION>
</RULE>
In the common properties schema file, if you specify the .xml location for the
VHL_HiddenLineStyle property as <XML_PATH>RULE/ACTION/VALUE</XML_PATH>, the
software does not read all of the properties at that path, and thus uses the VALUE node that
corresponds to the VHL_VisibleLineStyle category because it is the first node in the path. To
correct this ambiguity, use the SIBLING and SIBLING_VALUE properties in the common
properties schema file to specify which VALUE node in the rule file contains the hidden line
style.

Example 2
The following shows how to use SIBLING and SIBLING_VALUE to specify the VALUE node
containing the hidden line style.
<XML_PATH LOCATION="Rule" SIBLING="CATEGORY"
SIBLING_VALUE="VHL_HiddenLineStyle">RULE/ACTION/VALUE</XML_PATH>
LOCATION="Rule" specifies that the CATEGORY and VALUE nodes exist in the rule
.xml file (as opposed to the template .xml file). For more information, see LOCATION (on page
1084).
See Also
XML_PATH (on page 1092)

TYPE
Specifies the type of selection options that the Rule Manager uses for a property.
Type can take one of three values:
 Checkbox
 Textbox
 Dropdown
If the TYPE value is Checkbox, you can select or clear one value for that property.
TYPE exists as a child node under the CONTROL node:

Drawings and Reports Reference Data Guide 1089


Appendix: Annotation Rule Manager Customization

<CONTROL>
<TYPE>Checkbox</TYPE>

 Some properties display as radio buttons instead of a check box. When you click a radio
button in the Rule Manager, a graphic that corresponds to that radio button displays in the
property grid.
 Acceptable text box values depend on the property that you are defining. Properties can
take textual (non-numeric) values, numeric values lacking units, or numeric values with
units.
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

UOM
Specifies the unit of measure for a text box property value. This value must match the stored
value in the .xml template. The software uses the UOM node with the TYPE attribute.
In the following example, the UOM TYPE is Length, and the value is stored as meters in the
template .xml file.
<UOM TYPE="Length">Meter</UOM>
Regardless of the UOM TYPE specified for a property in the schema, you can declare
any unit that you want in the Rule Manager. However, when you click Save, the Rule Manager
translates the value that you specify into the required unit of measure declared as the value of
the <UOM> node.
The TYPE attribute helps the software determine how to treat and display property values. For
example, if you enter a length value of 4 deg, the software determines that you specified an
incorrect unit.
The following table shows the supported UOM type and value pairs.

UOM TYPE UOM VALUE SCHEMA XML

Length Meter <UOM TYPE="Length">Meter</UOM>

Length Millimeter <UOM TYPE="Length">Millimeter</UOM>

Angle Degree <UOM TYPE="Angle">Degree</UOM>

Angle Radian <UOM TYPE="Angle">Radian</UOM>

UOM exists as a child node of the POSSIBLE_VALUES node:


<POSSIBLE_VALUES>
<UOM TYPE="Angle">Degree</UOM>

See Also
POSSIBLE_VALUES (on page 1087)
TYPE (on page 1089)
Label Rule Manager (on page 1099)

Drawings and Reports Reference Data Guide 1090


Appendix: Annotation Rule Manager Customization

Appendix: Annotation Rule Manager Customization (on page 1066)


XML Structure for Property and Property Group Definitions (on page 1073)

VALUE
Relates a specific checked option or selected drop-down option to the corresponding template
.xml value for that property.
VALUE exists as a child node under the POPULATE node. You can define multiple VALUE
nodes as shown in the following example for drop-down options:
<POPULATE>
<VALUE NAME="Top">1</VALUE>
<VALUE NAME="Bottom">2</VALUE>
<VALUE NAME="Left">3</VALUE>
<VALUE NAME="Right">4</VALUE>
If TYPE is set to Dropdown, the NAME attribute of each VALUE node displays as an option in
the drop-down menu. The Rule Manager then writes the value of this node, such as 1, 2, 3, or 4,
to the .xml file.
The NAME attribute values must match the DATA_TYPE for this property. For example, if the
DATA_TYPE is Integer, you cannot specify <VALUE NAME="RIGHT">Right</VALUE>
because Right is non-numeric.
The following example shows VALUE nodes for a check box.
<POPULATE>
<VALUE NAME="True">-1</VALUE>
<VALUE NAME="False">0</VALUE>
True and False are the only acceptable attribute values for the check box VALUE node's
NAME attribute. You can tell the software to write any appropriate values to the .xml template for
True and False, as long as the DATA_TYPE matches.
Established convention dictates that the software notates a True value as -1 and a
False value as 0. However, you can reverse this logic and specify that the software write 0 for
a True property and -1 for a False property. For an example, see the delivered
ignoreViewDirection property.
See Also
DATA_TYPE (on page 1079)
POPULATE (on page 1087)
TYPE (on page 1089)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

Drawings and Reports Reference Data Guide 1091


Appendix: Annotation Rule Manager Customization

XML_PATH
Specifies the location in the .xml template where this particular property resides.
XML_PATH exists as a child node under the PROPERTY node:
<PROPERTY NAME="PropertyName">
<XML_PATH>path/to/property/node</XML_PATH>
The XML_PATH value construct is similar to an XPath. The value always begins the root node
names of the respective template types, label/ (for labels, north arrows, or matchlines) or
/dimension (for dimensions). The path then continues to the .xml node that corresponds to the
property, as shown in the following example:
<XML_PATH>dimension/dimensionSettings/priority</XML_PATH>
The above path corresponds to the following location in the template:
<dimension>
<dimensionSettings>
<priority>1</priority>
An XML_PATH value can contain the @ character, which indicates that the property is
stored as an .xml attribute as shown in the following example:
<XML_PATH>label/content/Assembly/@value</XML_PATH>
The above path corresponds to the following location in the template:
<label>
<content>
<Assembly value="AssemblyName"/>

 XML_PATH has an intentional side effect. If the value contains labelSettings as part of
the string, then the property displays under the General section of the Label Rule Manager
because nodes in this section might apply to multiple modules or module types at the same
time.
 If the value does not contain labelSettings as part of the string, the property displays
under the corresponding parent module.
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
XML Structure for Property and Property Group Definitions (on page 1073)

Drawings and Reports Reference Data Guide 1092


Appendix: Annotation Rule Manager Customization

XML Structure of Module Definitions


The Custom_DrawingLabelUIModulesCommon.xml schema file contains all label module
definitions. The Custom_DrawingDimensionUIModulesCommon.xml schema file contains all
dimension module definitions.

Project Nodes
The common modules schema file is divided into the following project type nodes:
 SP3D (plant)
 SM3D (marine)
 MHE (material handling)

Annotation Module Nodes


Each project type section is then subdivided into the following annotation module type nodes:
 POINT_GENERATOR_MODULES
 GEOMETRIC_ANALYZER_MODULES
 ANNOTATION_CONTROL_GENERATOR_MODULES
 CONTENT_MODULES
 POSITIONING_MODULES
 LEADER_MODULES (Label Rule Manager only)

DefaultLabelPointGenerator
Each annotation module type section contains all the modules of that project and module type.
The point generator module in the example below has a .dll file named
DefaultLabelPointGenerator and a ProgID of SP3DDefaultLabelPointGenerator.Generator.
The module is written to the .xml template file as a .dll filename, and displays Key Point in the
Label Rule Manager.
<POINT_GENERATOR_MODULE NAME="DefaultLabelPointGenerator"
PROGID="SP3DDefaultLabelPointGenerator.Generator" USE_PROGID="False"
DISPLAY="Key Point"/>
If you want to display a new module in the rule manager, you must add the module to the
common modules schema file and create a corresponding module schema file. For information
on adding a new module, see Customization Examples (on page 1096).

 If the common modules schema file does not contain a particular module type, the rule
manager does not display that module.
 See the following guidelines to determine the projects that use the defined module.
 If the module resides in the <SP3D> section, then plant, marine, and material handling
projects can use the module.
 If the module resides in the <SM3D> section, then marine and material handling projects
can use the module.

Drawings and Reports Reference Data Guide 1093


Appendix: Annotation Rule Manager Customization

 If the module resides in the <MHE> section, then only material handling projects can use
the module.
 The USE_PROGID attribute specifies how the module is written to the .xml template:
 True - ProgID.
 False - .dll filename.
 If the attribute is absent, the module is written as displayed in the .xml template when
loaded by the Rule Manager.
See Also
DISPLAY (Property Name) (on page 1080)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)

Reserved Tags
The Custom_ReservedTags.xml schema file contains all template nodes and tags that do not
display in the rule manager but which must remain in the template when you click Save. After
you add a node name to this file, the node remains in all .xml templates when you click Save.
You can add, modify, and remove reserved tag definitions.
See Also
XML Structure of Reserved Tags (on page 1094)
XML Structure of Reserved Symbol Tags (on page 1095)

XML Structure of Reserved Tags


The root level <ReservedTemplateTags> section contains all nodes in the
Custom_ReservedTags.xml schema file. Each inner node takes the name of a template .xml
node that the rule manager should never delete. The value of each inner node dictates the path
to that node in the template file, as the following example shows.
<ReservedTemplateTags>
<annotationParameters>
label/content/contentModuleSettings/
annotationParameters
</annotationParameters>
</ReservedTemplateTags>
The beginning and ending node names, as well as the leaf node name in the path, must match
for every child node of <ReservedTemplateTags>.
See Also
Reserved Tags (on page 1094)
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)

Drawings and Reports Reference Data Guide 1094


Appendix: Annotation Rule Manager Customization

XML Structure of Reserved Symbol Tags


The root level <ReservedSymbolTags> section contains all nodes in the
Custom_ReservedTags.xml schema file. Each inner node takes the name of a template .xml
node whose value is the name of a symbol file that needs to be copied during the Copy Rule
process.
<ReservedSymbolTags>
<bidirectionalSymbol>
bidirectionalSymbol
</bidirectionalSymbol>
</ReservedSymbolTags
The beginning and ending node names, as well as the node value, must match for every child
node of <ReservedSymbolTags>.
See Also
Reserved Tags (on page 1094)

Rule Manager and XML Template Difference


There may be differences between the template .xml file and the properties that display in the
rule manager. Either one of the following two valid situations can arise as a result.
1. When you open a rule, the rule manager displays all possible properties for each module in
the template.
The rule manager does not display properties that are hidden with
conditional schema expressions in the Custom_DrawingLabelUIPropertiesCommon.xml
schema file or the Custom_DrawingDimensionUIPropertiesCommon.xml schema file.
The properties display regardless of whether all possible properties existed in the template
.xml file before opening in the rule manager. After you click Save or Save & Close, the
software saves the current rule and all of the templates to disk.
The software saves the rule as it exists in the rule manager. The contents of the
template .xml file grow when you add new property nodes. If you do not edit properties in
the rule manager before you click Save or Save & Close, then the software writes the
properties to the template .xml file with the default values.
2. If a template .xml file contains property nodes not currently in use, then the software does
not display the unsupported properties after the rule manager loads the parent rule for that
template because the schema does not associate these unused properties with any
currently selected module in the template.
Therefore, after you click Save or Save & Close in the rule manager, the software only
writes the valid property nodes to the template .xml file. Additionally, the software deletes all
other property nodes with the exception of any nodes located in
Custom_ReservedTags.xml.
Template .xml comments remain in the file when you save rules in the rule manager.
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)

Drawings and Reports Reference Data Guide 1095


Appendix: Annotation Rule Manager Customization

Customization Examples
When you create a new module, you must add the module to the schema to use it in the rule
manager.

Add a new module


1. Add the new module to either the Custom_DrawingLabelUIModulesCommon.xml or
Custom_DrawingDimensionUIModulesCommon.xml file under the correct project and
module type.
The new module name must be unique and cannot have the display name
of NONE.
As an example, assume that the new module is an SP3D label point generator. Thus, the
new module belongs under
LABEL_UI_MODULES_COMMON/SP3D/POINT_GENERATOR_MODULES. Add the new
module to this section as follows:
<POINT_GENERATOR_MODULE NAME="TheNewDLLName"
PROGID="ProgID.OfTheNewDLL" USE_PROGID="True or False"
DISPLAY="Human Readable Name for the New Module"/>
2. Create a new module schema file for the new module using the following format:
Custom_<ModuleNameWithoutExtension>.xml.
In this format, ModuleNameWithoutExtension is the .dll filename of the new module.
3. If the new module is for labels, save the .xml file in the
[SharedContent]\Data\Drawings\LabelUISchemaData folder. If it is for dimensions, save the
.xml file in the [SharedContent]\Data\Drawings\DimensionUISchemaData folder.
You can copy another module schema file and rename the file for this purpose.
4. Set up all the module compatibilities in this new module schema file.

 You cannot allow compatibility between modules of the same type. For example, if you
add a point generator, you cannot have a <POINT_GENERATOR_MODULES> section in
the module schema file.
 The exception to this rule is that templates can contain multiple positioning modules.
Therefore, positioning modules are compatible with each other.
5. Add references to any supported existing or new properties and groups within the new
module schema file.
New property or property group names must not clash with names that
already exist in Custom_DrawingLabelUIPropertiesCommon.xml (for labels) or
Custom_DrawingDimensionUIPropertiesCommon.xml (for dimensions).
6. Open the module schema files for all modules with which your new module is compatible.
You must add the new module to the appropriate location in each of these schema files to
properly specify all compatibilities.
Do not include the Custom_ prefix or the .xml suffix for the module names
that exist inside schema files. The affixes apply only to the module schema filename.

Drawings and Reports Reference Data Guide 1096


Appendix: Annotation Rule Manager Customization

7. Add any required new properties to Custom_DrawingLabelUIPropertiesCommon.xml (for


labels) or Custom_DrawingDimensionUIPropertiesCommon.xml (for dimensions).
8. Verify that you can select the new module in the rule manager and that any module
properties display.

Edit an Existing Property


You may find that you require other users of the rule manager to follow certain company policies
and so forth. In that case, you can force the software to display only certain property options.
Because all custom schema files reside in Shared Content, anyone who uses the rule manager
can see the effects of changes to these files. Therefore, putting general labeling restrictions in
place is as simple as editing the custom schema properties.
The rule manager reflects changes to these files only if the Smart 3D model is
connected to the Shared Content containing those files.
As an example, your company may find that a coarse or medium setting for Granularity is
sufficient for label and dimension placement. Therefore, you may want to prohibit a fine setting
for the Granularity property.

Edit the label and dimension properties


1. Locate the display name for the property that you want to limit in the
CustomLabelUIPropertiesCommon.xml and Custom_DimensionUIPropertiesCommon.xml
files. This example is for the Granularity property.
2. In each file, remove the line containing the value that you want to restrict from the
<POPULATE> section:
<VALUE NAME="Fine">2</VALUE>
3. For each file, confirm that the property does not default to the value that you want to restrict,
in this case, Fine. Then, save the files.
If the property defaults to the value you want to prohibit, you must allow this
default value as a valid choice or change the default value to one of the available choices. In
this case, the valid choices are Coarse or Medium. For example, if your company uses the
Medium granularity setting most often, and you want to always make Medium the
unconditional default value, change the DEFAULT section of the Granularity property to
always default to the Medium setting, regardless of the selected positioning module.
4. Within the rule manager, open a rule that contains the property for which you have modified
values and verify that the property only displays the allowed values.

Other Customizations
You may perform any of the following actions at any time to affect the behavior of the rule
manager.
 Add new module schema files as you introduce new modules into the rule manager
 Edit module compatibilities in module schema files to change the modules that can be used
together in a template
 Add new supported properties or property groups to module schema files to add new
behaviors to modules

Drawings and Reports Reference Data Guide 1097


Appendix: Annotation Rule Manager Customization

Module code must support these new properties and property groups.
 Remove supported properties and property groups from module schema files to remove
behaviors
 Add new modules to the common modules schema files so that the modules display in the
rule manager
 Remove modules from the common modules schema files to prevent using specific modules
in the rule manager
 Add new properties or property groups to the common properties schema files to add new
behaviors
The module code must support these new behaviors.
 Remove properties and property groups from the common properties schema files so that
these properties and property groups are unavailable in the rule manager
 Edit the reserved tags schema files to change the template .xml nodes that you do not want
the software to delete when you click Save
 Edit the reserved symbol tags schema file to change the symbols that are copied during the
Copy Rule process
After you have made schema changes, reload the rule manager to see your changes.
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)

Drawings and Reports Reference Data Guide 1098


SECTION 16

Label Rule Manager


The Label Rule Manager allows you to modify label rules and the properties of label templates.
To modify a template, first launch the Label Rule Manager (see Launch Label Rule
Manager (Orthographic Drawings) (on page 1099) for orthographic drawings; see Launch Label
Rule Manager (Drawings by Rule) (on page 1100) for ruleset templates).
To add additional templates to the rule, click the green icon that displays at the far right of
the Template List box. For more information about adding templates, see Add Template Dialog
Box (on page 1100).
Click Reset to revert the template to the initial state. This action also discards all templates that
you have added to the rule, leaving only the original template. Click Cancel to discard all
template modifications and exit the Rule Manager. Click Save to save all changes. Click Save &
Close to save all changes and exit the Rule Manager.
See Also
Properties Tab (on page 1103)
Comments Tab (on page 1112)
Relationships Tab (on page 1111)

Launch Label Rule Manager (Orthographic Drawings)


Follow these steps to launch the Label Rule Manager.
1. Click Tasks > Drawings and Reports.
2. Click Tools > Define View Style.
The Define View Style window displays.
3. Select Orthographic from the View Style Type list.

4. Select an existing view style, or click New Style to create a new view style.
5. Click Properties .
The View Style Properties dialog box displays.
6. Select More from the Label Rule list.
The Select Label window displays.
7. Select a rule, and then click Properties.
The Label Rule Manager displays.
You can access the Label Rule Manager from the Edit Ruleset View Style dialog
box. Select a template from the Label Rule menu, and then press F12 to display the Label
Rule Manager.
See Also
Label Rule Manager (on page 1099)

Drawings and Reports Reference Data Guide 1099


Label Rule Manager

Launch Label Rule Manager (Drawings by Rule)


Follow these steps to launch the Label Rule Manager for drawings by rule (marine mode only).
1. Click Tasks > Drawings and Reports.
2. Click Tools > Define View Style.
The Define View Style window displays.
3. Select RulesetStyles from the View Style Type list.

4. Select an existing view style, or click New Style to create a new view style.
5. Click Properties .
The Actions tab on the Edit Ruleset View Style dialog box displays.
6. Select More from the Label list.
If you create a new style, you must select a ruleset and a source before you click
More. For more information, see Actions Tab (Edit Ruleset View Style Dialog Box) in the
Smart 3D Drawings and Reports Reference Data Guide.
The Select Label window displays.
7. Select a rule, and then click Properties.
The Label Rule Manager displays.
You can access the Label Rule Manager from the Edit Ruleset View Style dialog
box. Select a template from the Label menu, and then press F12 to display the Label Rule
Manager.
See Also
Label Rule Manager (on page 1099)

Add Template Dialog Box


Allows you to add a template based on the existing set of templates on disk.

 You cannot add dimension rule templates.


 You must have already launched the Label Rule Manager, the Matchline Rule Manager,
or the North Arrow Rule Manager, depending on the type of template you want to add.

To add a template to the rule


1. Click Add a template to this rule ( on the right side of the Template List box).
The software calculates the impact that the rule change has on existing view styles. Then,
the software displays a list of view styles that are affected when you add a new template to
the rule, and prompts you to confirm the action.
2. Click No to return to the Rule Manager, or click Yes to proceed.
The Select Templates dialog box displays.

Drawings and Reports Reference Data Guide 1100


Label Rule Manager

3. Select the template or templates to add from the list. Alternately, you can search for a
template using the Search Templates box.
4. Click Open to add the template to the rule and return to the Rule Manager.
The software loads the selected template or templates to the rule.
5. Click the arrow next to the Template List box to display the list of templates that you
have added. Click Cancel to cancel the addition of the new template and return to the Rule
Manager without adding any new templates to the rule.
See Also
Launch Label Rule Manager (Orthographic Drawings) (on page 1099)
Launch Matchline Rule Manager (on page 1606)
Delete a Template (on page 1102)

Copy a Rule
Copy a Simple Label, North Arrow, or Dimension Rule
A simple rule only has one template, and may have a single symbol file and a single
report file.
1. In the Select [Label or Dimension] Rule dialog box, select the label, north arrow, or
dimension rule to copy.
2. Click Copy.
The Copy [Label, North Arrow, or Dimension] Rule dialog box displays.
3. Type the name for the new rule in the Change Rule Name box.
Rule names do not support any character not supported by your operating
system.
The software displays all affected files in the View Changes pane and dynamically updates
the file names as you type.
4. Click Copy.
The software returns you to the Select (Label or Dimension) Rule dialog box with the
newly copied rule selected.

Copy a Compound Label, Matchline, or North Arrow Rule


A compound rule can have multiple templates and can be associated with multiple
symbol and report files.
1. In the Select Label Rule dialog box, select the label, matchline, or north arrow rule to copy.
2. Click Copy.
The Copy [Label, Matchline, or North Arrow] Rule dialog box displays.
3. Click Add Prefix or Add Suffix.
—OR—
Select both options to add a prefix and a suffix to the rule name.
The software populates the Change Rule Name box with the existing name and positions

Drawings and Reports Reference Data Guide 1101


Label Rule Manager

the cursor according to your selection.


4. Type to add the prefix or suffix to the rule name.
Rule names do not support any character not supported by your operating
system.
The software displays all affected files in the View Changes display and dynamically
updates the file names as you type.
5. Click Copy.
The software returns you to the Select Label Rule dialog box with the newly copied rule
selected.

 You cannot copy a template if you do not have certain permissions. For example, if you do
not have write permissions to the Labels\Templates folder or the Dimensions\Templates
folder, then an error message displays, and the command exits.
 If the software cannot copy a label, matchline, north arrow, or dimension rule, an error
message displays and the command exits. Copy errors can occur in the following situations:
 The rule contains a template that is missing from disk.
 The rule contains one or more templates with XML errors.
 If you are copying a label associated with a formatting file (.rfm) that references a formatting
parameter file (.rfp), the .rfm and .rfp file prefixes must be identical. Otherwise, the software
does not copy the .rfp file, and the new label continues to reference the original .rfp file.
See Also
Label Rule Manager (on page 1099)
Dimension Rule Manager (on page 1503)

Delete a Template
Allows you to delete a template based on the existing set of templates on disk.

 You cannot delete dimension rule templates.


 You must have already launched the Label Rule Manager.

To delete a template from the selected rule


1. From within the Label Rule Manager, click the arrow on the right side of the Template
List box. The list of templates displays. Select the template that you want to delete, and
then click Delete this template from the rule ( ).
The software prompts you that deleting the template changes the definition of the rule,
affecting multiple view styles.
2. Click Yes to delete the template from the rule. Click No to keep the template in the rule and
return to the Label Rule Manager.
See Also
Launch Label Rule Manager (Orthographic Drawings) (on page 1099)
Add Template Dialog Box (on page 1100)

Drawings and Reports Reference Data Guide 1102


Label Rule Manager

Properties Tab
Displays the modules for the selected template and allows you to edit the properties that each
module uses.
Modules and properties are grouped under the following headings:
 Content (displays the content modules)
 General (displays the annotation control generator modules)
 Leader (displays the leader modules)
 Point Generation (displays the point generator modules)
 Geometric Analysis (displays the geometric analyzer modules)
 Positioning 1,2, and so forth (display the positioning modules)
The modules that display vary based on the template that you have selected for editing.
Under each heading, the module name displays first in the list of properties that each module
uses. Click the module name to display the associated Help for that module.
To expand or collapse the list of properties that each module uses, click the arrow on the far
right of each module name. The properties that each module uses display beneath the module
names. Click each property to display the associated Help for that property.
To edit the property values, type the value into the text box next to the property. For some
properties, you can select or clear a check box next to the property. For other properties, you
click an arrow next to the property, and then select a value from the list that displays.
To search for a property to edit, type the name of the property that you want to edit in the
Search box, and then press ENTER.

Drawings and Reports Reference Data Guide 1103


Label Rule Manager

In the following image, the Civil Plan_Equipment_Name template is selected for editing in the
Label Rule Manager. The modules display on the Properties tab. Underneath the Leader
heading, the Display Breakline property is selected. On the right, Help automatically displays
information about the selected property.

See Also
Relationships Tab (on page 1111)
Comments Tab (on page 1112)

Drawings and Reports Reference Data Guide 1104


Label Rule Manager

Content Module (Properties tab)


Gathers the information to display within a label or dimension. Additionally, a content module
specifies dimension styles.
Content modules are highly customizable. For labels, the system uses report label files in
addition to code in the content module in order to display the label. For dimensions, code
interacts with SmartSketch in order to place the dimension value, as well apply any changes to
the appearance of the dimension. While content modules ready annotations for placement on
the drawing view, the modules do not position the annotations.
The list of supported content modules follows. Names in parentheses are as identified in the
.xml files.
 Default (DrawingLabelHelper) (on page 1268)
 Default Marine Label (ISRulesetLabelContent) (on page 1275)
 Flow Direction (DrawingFlowDirectionContent) (on page 1298)
 Knuckle Angle Symbol (ISKnuckleAngleSymbolContent) (on page 1338)
 Manufacturing Margin Symbol (ISMfgMarginSymbolContent) (on page 1369)
 Manufacturing Pin Height Label (SMDwgMfgPinHeightLabelContent) (on page 1369)
 Manufacturing Profile Margin Symbol (SMDwgMfgProfileMarginSymContent) (on page
1370)
 No Label Content (DrawingNoContent) (on page 1399)
 North Arrow (DrawingNArrowContent) (on page 1400)
 Plate Angle Symbol (ISPlateAngleSymbolContent) (on page 1427)
 Plate Grid Name Label (SMDwgPlateGridNameLabelContent) (on page 1428)
 Pin Jig Seam Offset Label (SMDPinJigSeamOffsetCM) (on page 1424)
 Piping Elevation (DrawingBOLabelContent) (on page 1425)
 Profile Angle Symbol (ISProfileAngleSymbolContent) (on page 1444)
 Profile Sketch Bevel Shape Label (SMProfileSketchBevelShapeLabelsCM) (on page 1445)
 Profile Sketch Bevel Symbol (SMProfileSketchBevelSymbolCM) (on page 1446)
 Profile Sketch Detail Name Label (SMDwgProfileSketchDetailNameLabelContent) (on page
1446)
 Profile Sketch Knuckle Label (SMDwgProfileSketchKnuckleLabelContent) (on page 1447)
 Profile Sketch Label (SMDwgProfileSketchLabelsContent) (on page 1447)
 Reference (DrawingReferenceLabelContent) (on page 1451)
 Remarking Girth Length Label (SM3DDwgRemarkingGirthLengthCM) (on page 1452)
 Ruler Axis (SMRulerAxisSymbolContent) (on page 1455)
 Scantling Near Side or Far Side Direction Symbol
(SMDwgScantlingNSorFSDirectionContent) (on page 1461)
 Ship Direction Symbol (ISShipDirectionSymbolContent) (on page 1463)

Drawings and Reports Reference Data Guide 1105


Label Rule Manager

 Structural Widget (StructuralWidgetLabelContent) (on page 1470)


 Template Set Full Scale Direction Symbol (SMTemplatesetFullScaleDirSymbolContent) (on
page 1475)
 Trench (DrawingCivilLabelContent) (on page 1479)
If you try to select an unsupported content module, the software prompts you with the following
message.

The following content modules are unsupported. However, these modules remain valid in label
template .xml files.
 Flow Direction (DrawingFlowDirectionContent) (on page 1298)
 Generic Interoperability (SMDGenericContentInterOp) (on page 1304)
 Hanger Key Plan (DrawingHangerLabelContent) (on page 1830)
 Knuckle Point Symbol (ISKnucklePointSymbolContent) (on page 1848)
 Knuckle Sloping Direction Symbol (ISKnuckleSlopingDirectionSymbolContent) (on page
1849)
 Manufacturing Profile Plate Location Symbol (MfgProfilePlateLocSymContent) (on page
1860)
 Object Coordinates (DrawingEquipmentStyle2Content) (on page 1825)
 Plate Thickness Symbol (ISPlateThicknessSymbolContent) (on page 1851)
 ISProfilePartThicknessSymContent (on page 1444)
 Profile Seam Symbol (SMProfileSeamSymbolContent) (on page 1870)
 Profile Sketch Web Thickness Symbol (SMPSWebThicknessContent) (on page 1881)
 Profile System Thickness Symbol (ISProfileSysThicknessSymbolContent) (on page 1855)
 Scantling Near Side or Far Side Symbol (SMDwgScantlingNSorFSContent) (on page 1869)
 Scantling Weld Symbol (DwgScantlingWeld) (on page 1842)
 Seam Symbol (ISSeamSymbolContent) (on page 1856)
 Thickness Direction Symbol (ThicknessSymContent) (on page 1879)
 Weld (DrawingWeldSymbols) (on page 1492)
To use a label module, you must edit the associated symbol file in SmartSketch Drawing Editor.
Additionally, you must edit the associated label template .xml file to reference the symbol
attribute ID and the .rtp file.

Drawings and Reports Reference Data Guide 1106


Label Rule Manager

Define a new ID attribute in SmartSketch Drawing Editor to add another text box to a label
symbol file. Click Launch SmartSketch next to the Label Symbol File text box to open
SmartSketch Drawing Editor.
See Also
Annotation Control Generator Module (Properties tab) (on page 1107)
Leader Module (Properties tab) (on page 1107)
Geometric Analyzer Module (Properties tab) (on page 1109)
Point Generator Module (Properties tab) (on page 1108)
Positioning Module (Properties tab) (on page 1110)

Annotation Control Generator Module (Properties tab)


Creates an annotation control object, either as a label control object or dimension control object,
which the system uses to represent each individual label or dimension. The annotation control
object then manages the list of positioning modules that can use that particular annotation and
keeps track of the annotation's current position at any point in time.
Only the Default (DefaultLabelControlGenerator) (on page 1265) annotation control generator is
supported for labels.
The annotation control generator modules supported for dimensions are listed below:
 Anchor to Nearest Object (DrawingSepDimGenerator) (on page 1520)
 Coordinate (DrawingCoordDimGenerator) (on page 1532)
 Default (DrawingDimGenerator) (on page 1533)
 Incremental (MHIncrementalDimGenerator) (on page 1551)
 Pipe Segments (DrawingPipeSegmentsCG) (on page 1583)
See Also
Label Rule Manager (on page 1099)
Dimension Rule Manager (on page 1503)

Leader Module (Properties tab)


Creates a leader for a label and places leaders on the drawing view. Leader modules determine
the leader start and end points. Finally, the leader module determines the style of the leader line
as well as whether or not the leader line contains a jog.
The list of supported leader modules follows. Names in parentheses are as identified in the .xml
files.
 Coordinate (DrawingCoordLeaderControl) (on page 1262)
 Default (DwgLeaderControl) (on page 1271)
 Linear (DrawingLinearLeader) (on page 1352)
 Margin (DwgMarginLeaderControl) (on page 1372)
 Materials Handling Absolute (MHDrawingAbsoluteLeader) (on page 1381)
 Only Outside of Object (DwgLeaderInOutsideControl) (on page 1407)
 Stacked Labels (DwgStackLabelLeader) (on page 1466)

Drawings and Reports Reference Data Guide 1107


Label Rule Manager

 Weld (DrawingWeldLeader) (on page 1490)


See Also
Annotation Control Generator Module (Properties tab) (on page 1107)
Content Module (Properties tab) (on page 1105)
Geometric Analyzer Module (Properties tab) (on page 1109)
Point Generator Module (Properties tab) (on page 1108)
Positioning Module (Properties tab) (on page 1110)

Point Generator Module (Properties tab)


Gathers data from the 3D geometry and places points on 2D objects that need labels,
dimensions, or matchlines.
The system can generate the point on any number of object locations, depending on the point
generator module that you use. This includes, but is not limited to, the object origin, control
point, straight feature end point, and so forth. A point generator can place one or multiple points
on the same object. No annotations are created with this module.
The list of supported point generator modules follows. Names in parentheses are as identified in
the .xml files.
 Absolute Points (ISAbsolutePointLabelPG) (on page 1120)
 Control Point Only (DrawingPGCPThenNone) (on page 1260)
 Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on page 1261)
 Default Marine Point (ISRulesetPointGenerator) (on page 1276)
 Hanger Key Plan Control Point then Support Location (DrawingPGKeyPlanControlPoint) (on
page 1310)
 Inside or Along 2D Curve (InsideOrAlongCurve2D) (on page 1321)
 Key Point (DefaultLabelPointGenerator) (on page 1338)
 Linear Object Endpoints (DrawingPGLinear) (on page 1357)
 Linear Pipe Endpoints (DrawingPGPipeSegments) (on page 1357)
 Local Coordinate System Origin (DrawingPGLocalCS) (on page 1359)
 Local CS Origin with Object Axis (DrawingPGEquipmentStyle2) (on page 1360)
 MidPoint (ISMidPointLabelPG) (on page 1389)
 Nozzle (DrawingPGNozzleandBrace) (on page 1401)
 Opening Objects (DrawingPGOpeningObjects) (on page 1410)
 Point at Corner Cut (MHDrawingPGCornerCut) (on page 1428)
 Point for Profile Sketch Bevel Shape (SMProfileSketchBevelShapeLabelsPG) (on page
1431)
 Point on Remarking Curve along Girth (SM3DDwgRemarkingGirthLengthPG) (on page
1432)
 Points Along 2D Curve (ISDwgPointsAlongCurve2D) (on page 1433)
 Points Along 2D Range (ISDwgPointsAlongRange2D) (on page 1436)

Drawings and Reports Reference Data Guide 1108


Label Rule Manager

 Points at Manufacturing Sketch Coordinates (MfgSketchPG) (on page 1437)


 Points by 2D Shape Type (SMDwgPointsByType) (on page 1438)
 Points by Associated Object ID (SMPointsByAssociateObjectID) (on page 1439)
 Points for View (ISDwgPointsForView) (on page 1440)
 Profile Weld Points (SMDwgProfileWeldsPG) (on page 1448)
 Trench (CivilElevationPointGenerator) (on page 1481)
 Weld Point (DrawingPGWelds) (on page 1494)
See Also
Annotation Control Generator Module (Properties tab) (on page 1107)
Content Module (Properties tab) (on page 1105)
Geometric Analyzer Module (Properties tab) (on page 1109)
Leader Module (Properties tab) (on page 1107)

Geometric Analyzer Module (Properties tab)


Evaluates the points placed by the point generator module. The selected module groups or
deletes points as needed. This module does not create any annotations.
 Aligned Objects (DrawingGALabelInline) (on page 1135)
 Default Marine Label Text (ISRulesetLabelAnalyzer) (on page 1276)
 Dummy (DummyGeomAnalyzer) (on page 1285)
 Eliminate Labels with Missing Parents (SMDGAEliminateLabelsWithMissingParents) (on
page 1286)
 Eliminate Most Common Labels (ISGAEliminateMostCommonLabels) (on page 1287)
 Eliminate Overlapping Labels (ISGAEliminateOverlappingLabels) (on page 1289)
 End of Segment (DrawingGAEndOfSegment) (on page 1292)
 Generic Interoperability (GenericGeometricAnalyzerInterop) (on page 1303)
 Group by Axis (SMDwgGroupByAxisGA) (on page 1307)
 Linear Endpoints (DrawingGAByOppositePoints) (on page 1356)
 Longest Segment (DrawingGALongestSegment) (on page 1366)
 No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on page 1398)
 Object Axis (DrawingGAEquipmentStyle2) (on page 1401)
 Weld Label Text (DrawingGAWelds) (on page 1493)
See Also
Content Module (Properties tab) (on page 1105)
Annotation Control Generator Module (Properties tab) (on page 1107)
Leader Module (Properties tab) (on page 1107)
Point Generator Module (Properties tab) (on page 1108)
Positioning Module (Properties tab) (on page 1110)

Drawings and Reports Reference Data Guide 1109


Label Rule Manager

Positioning Module (Properties tab)


Determines the position of a label.
Some positioning modules consider clear space when readying labels for placement.
Alternately, other positioning modules determine an absolute position at which to place the label
without regard to clear space.
The list of supported positioning modules follows. Names in parentheses are as identified in the
.xml files.
 Absolute Along Linear Object (DwgLinearAbsPos) (on page 1113)
 Absolute Axis Position (SMDwgPositionAxis) (on page 1117)
 Absolute Grid Margin (DrawingGridLblMgnAbsPos) (on page 1118)
 Absolute Position by 2D Curve (ISDwgAbsolutePositionByCurve2D) (on page 1120)
 Absolute Position by 2D Curve at Axis (SMDwgPositionByCurve2DAtAxis) (on page 1124)
 Absolute Radial from View Center (DrawingVectorAbsolute) (on page 1129)
 Absolute XY Offset (DrawingAbsolute) (on page 1130)
 Clear Space Along Linear Object (DwgLinearPositioning) (on page 1159)
 Clear Space Center Then Above (DrawingCenterThenAbove) (on page 1159)
 Clear Space Center Then Above Centerline (DrawingCenterThenAboveCL) (on page 1162)
 Clear Space Center Then Rotate (DrawingCenterThenRotate) (on page 1164)
 Clear Space Clipped (DwgClippedPositioning) (on page 1166)
 Clear Space Coordinate (DrawingCoordLblPosMod) (on page 1167)
 Clear Space End of Linear Object (DwgLblEndOfSegmentPos) (on page 1172)
 Clear Space Grid Horizontal (DrawingGridLblHoriz) (on page 1175)
 Clear Space Grid Margin (DrawingGridLblMarginOnly) (on page 1180)
 Clear Space Grid Vertical (DrawingGridLblVert) (on page 1184)
 Clear Space Margin (DrawingMarginOnly) (on page 1189)
 Clear Space Margin with Dimensions (DwgMatchlineWithDim) (on page 1191)
 Clear Space Position by 2D Curve (ISDwgPositionByCurve2D) (on page 1203)
 Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin) (on page
1211)
 Clear Space Position Marine Grid Label at Margin (SMDwgPositionGridLblMarginOnly) (on
page 1219)
 Clear Space Quadrant 1 (DrawingQuadOne) (on page 1224)
 Clear Space Quadrant 2 (DrawingQuadTwo) (on page 1229)
 Clear Space Quadrant 3 (DrawingQuadThree) (on page 1234)
 Clear Space Quadrant 4 (DrawingQuadFour) (on page 1240)

Drawings and Reports Reference Data Guide 1110


Label Rule Manager

 Clear Space Radial (DrawingRadial) (on page 1246)


 Clear Space Radial from Object Center with Clustering (DrawingCentroid) (on page 1247)
 Clear Space Tiling (CAD Details) (DrawingTileInView) (on page 1255)
See Also
Annotation Control Generator Module (Properties tab) (on page 1107)
Content Module (Properties tab) (on page 1105)
Geometric Analyzer Module (Properties tab) (on page 1109)
Leader Module (Properties tab) (on page 1107)
Point Generator Module (Properties tab) (on page 1108)

Relationships Tab
Displays the name of the selected template and the list of rules that reference that template, as
well as the view styles that use those rules.
Information displayed on the Relationships tab helps you determine the impacts that changes
to the template can have on other label rules and view styles.
Click Reset to revert the template to the initial state. This action also discards all templates that
you have added to the rule, leaving only the original template. Click Cancel to discard all
template modifications and exit the Rule Manager. Click Save to save all changes. Click Save &
Close to save all changes and exit the Rule Manager.

See Also
Comments Tab (on page 1112)
Properties Tab (on page 1103)

Drawings and Reports Reference Data Guide 1111


Label Rule Manager

Comments Tab
Allows you to type notes that the system copies to the top of the .xml file.

Click Reset to revert the template to the initial state. This action also discards all templates that
you have added to the rule, leaving only the original template. Click Cancel to discard all
template modifications and exit the Rule Manager. Click Save to save all changes. Click Save &
Close to save all changes and exit the Rule Manager.
See Also
Properties Tab (on page 1103)
Relationships Tab (on page 1111)

Drawings and Reports Reference Data Guide 1112


APPENDIX B

Overview of Label Properties


This appendix contains descriptions of all the label rule properties available to apply to a label
created using the Drawings and Reports task. Label rule properties are editable either from
within the .xml template or by using the Label Rule Manager. Both methods of editing the label
rule are documented here.
For more information on the Label Rule Manager, see Label Rule Manager (on page 1099).

Absolute Along Linear Object (DwgLinearAbsPos)


Positions label at an absolute offset from a linear object, such as a structural member. This
positioning module is used with the Structural Widget (StructuralWidgetLabelContent) (on page
1470) content module.

Usage in Label Template XML


<posModules>
<posModule value="DwgLinearAbsPos">
<percentageOffset>0.50</percentageOffset>
<offsetFromMember>0.01</offsetFromMember>
<offsetFromWidget>-1</offsetFromWidget>
</posModule>
</posModules>

Customization
percentageOffset
Determines the label position along the length of a linear object, such as a structural
member.
 The following graphic illustrates the Percentage Offset property with a distance of 0.2,
or 20 percent, specified.

Drawings and Reports Reference Data Guide 1113


Overview of Label Properties

 The following graphic illustrates the Percentage Offset property with a distance of 0.5,
or 50 percent, specified.

The following options are available for manually editing the .xml file.
 Type 0 to place the label at the bottom left of the object.
 Type 1 to place the label at the top right of the object.
 Type a decimal value to place the label at a fractional point.
offsetFromMember
Specifies the perpendicular distance to offset the label away from a linear object, such as a
structural member. A positive value places the label above or left of the centerline, while a
negative value places the label below or right of the centerline.
The following graphic demonstrates the offsetFromMember property with an offset
distance from the structural member of 0.01 m specified.

Drawings and Reports Reference Data Guide 1114


Overview of Label Properties

The next graphic demonstrates the offsetFromMember property with an offset distance
from the structural member of 0.003 m specified.

offsetFromWidget
Determines the method of positioning the label offset. Type 0 to always offset the label from
the object centerline. Type -1 to offset the label from the edge of the widget when the label
and widget coincide and from the object centerline when they do not coincide. The value of
offsetFromMember is used for the offset.

Drawings and Reports Reference Data Guide 1115


Overview of Label Properties

1 - offsetFromWidget with a value of -1


2 - offsetFromWidget with a value of 0

Examples
percentageOffset is 0.5, offsetFromMember is 0.01, and offsetFromWidget is 0:

percentageOffset is 0.5, offsetFromMember is 0.01, and offsetFromWidget is -1:

Drawings and Reports Reference Data Guide 1116


Overview of Label Properties

Absolute Axis Position (SMDwgPositionAxis)


Determines the absolute position of the axis label and positions the reference plane axis line.
This module is used with the Ruler Axis (SMRulerAxisSymbolContent) (on page 1455) content
module.

Usage in Label Template XML


<posSettings>
<posModulesSets>
<posModulesSet>
<posModules>
<posModule value="SMDwgPositionAxis" />
</posModules>
</posModulesSet>
</posModulesSets>
</posSettings>

Customization
None

Example
The AddOn - Grid Axis and Lines view style adds visible coordinate system rulers, axes, and
grid lines to a rule set view style. SMDwgPositionAxis positions the axis label and line.

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1117


Overview of Label Properties

Absolute Grid Margin (DrawingGridLblMgnAbsPos)


Places a grid label at an absolute position in the margin determined by the orientation tag in the
XML file. A value of 1 places the label in the top margin, while 2 places a label in the bottom
margin, 3 places the label in the left margin, and 4 places the label in the right margin.

Usage in Label Template XML


<posModules>
<posModule value="DrawingGridLblMgnAbsPos">
<orientation>2</orientation>
<perimeterOffset>0.01</perimeterOffset>
</posModule>
</posModules>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

Drawings and Reports Reference Data Guide 1118


Overview of Label Properties

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

Drawings and Reports Reference Data Guide 1119


Overview of Label Properties

Absolute Points (ISAbsolutePointLabelPG)


Places a point on each end of straight features and members.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>ISAbsolutePointLabelPG</pgModule>
</pointGeneratorSettings>

Customization
None

Example

1 - Labels placed by the IS_ProfileSketch_Arial_2.5mm label using points created by


ISAbsolutePointLabelPG.
2 - Labels placed by the StrMfg ProfileSketch Detail Name_Voffset label using points created
by ISAbsolutePointLabelPG.

Absolute Position by 2D Curve


(ISDwgAbsolutePositionByCurve2D)
Places a label at an absolute position along the 2D curve. This is similar to the Clear Space
Position by 2D Curve (ISDwgPositionByCurve2D) (on page 1203) positioning module, but does
not use clear space. The absolute position is the point created by the point generator used in the
label template. The orientation of the label is set from the point, relative to the 2D curve, and is
controlled by the parameters.
This module can be used as the last positioning module in a label template. It will
position the label when other clear space positioning modules cannot find a location.

Usage in Label Template XML


<label>

Drawings and Reports Reference Data Guide 1120


Overview of Label Properties

<posSettings>
<posModulesSets>
<posModulesSet>
<connectPoint>4</connectPoint>
<positioningPoint>4</positioningPoint>
<posModules>
<posModule value="ISDwgAbsolutePositionByCurve2D">
<angle>0</angle>
<anchor>1</anchor>
<hOffset>0.0</hOffset>
<vOffset>0.0</vOffset>
</posModule>
</posModules>
</posModulesSet>
</posModulesSets>
</posSettings>
<\label>

Customization
angle
Orientation of the label.

XML value

Tangent 0
Tangent to a
curve

Normal Out 1
Along
outward
normal

Normal In 2
Along
inward
normal

Horizontal 3

Drawings and Reports Reference Data Guide 1121


Overview of Label Properties

Vertical 4

Default 5
Orientation

Uses the orientation from the content module

anchor
The point on the label used for positioning.

XML
value
Treat as Label 0

Uses a key point on the bounding box of the label, as specified by


the connect point property in posModulesSet (on page 2037).

Treat as Symbol 1

Uses the origin of the symbol.

Use Connect Point 2


Similar to 0 (Treat as Label) but uses a key point specified by the
connect point property defined directly in this module.

connectPoint

Drawings and Reports Reference Data Guide 1122


Overview of Label Properties

Specifies the position of the label relative to the key point on the text bounding box and used
with the anchor property. The default value is 4 (Middle Middle).

Key Points

0 Top Left

1 Top Middle

2 Top Right

3 Middle Left

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

 Use the connect point in this module in the same way that you use the positioning point
in the posModuleSet positioning module.
 You can use the value of the connect point defined in the posModulesSet positioning
module by using 0 (Treat as Label) for anchor or define the value directly in this module
by using 2 (Use Connect Point) for anchor.
 positioningPoint in the posModulesSet positioning module is not used by this module
even when you have defined that parameter.
hOffset
Horizontal distance of the label from the positioning point. This value is measured in meters.
The default value is 0.00.
vOffset
Vertical distance of the label from the positioning point. The software measures this value in
meters. The default value is 0.00.
This module also uses the minFactor and maxFactor parameters. For more
information, see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 1123


Overview of Label Properties

Examples
For the labels in the following example, Angle is 0 and Anchor is 0 (using connectPoint 4 in
posModulesSet)

The location of the profile thickness symbols change in the following examples based on the
parameters.

hOffset is 0
vOffset is 0
angle is 0 (Tangent)

hOffset is 0.01
vOffset is 0.03
angle is 0 (Tangent)

hOffset is 0
vOffset is 0
angle is 3 (Horizontal)

Although a content module creates the annotation output, this example shows how
this module affects the output.

Absolute Position by 2D Curve at Axis


(SMDwgPositionByCurve2DAtAxis)
Positions a label in clear space for a 2D curve based on a related reference plane. For example,
if a non-target plate is coplanar with a reference plane, the label for that plate can be positioned
with respect to the reference plane instead of the 2D curve for the plate.

 This module is used with the Group by Axis (SMDwgGroupByAxisGA) (on page 1307)
geometric analyzer.
 The 2D geometry of the 3D object must have one or more curves.

Drawings and Reports Reference Data Guide 1124


Overview of Label Properties

 If no reference plane is identified for an object, then no label is positioned by this module.

Usage in Label Template XML


<posSettings>
<posModulesSets>
<posModulesSet>
<connectPoint>4</connectPoint>
<positioningPoint>4</positioningPoint>
<posModules>
<posModule value="SMDwgPositionByCurve2DAtAxis">
<axisInfo>Grid Axis</axisInfo>
<top>
<offsetX>0.0</offsetX>
<offsetY>0.01</offsetY>
<angle>4</angle>
<anchor>0</anchor>
<connectPoint>3</connectPoint>
</top>
<bottom>
<offsetX>0.0</offsetX>
<offsetY>0.01</offsetY>
<angle>4</angle>
<anchor>0</anchor>
<connectPoint>3</connectPoint>
</bottom>
<left>
<offsetX>0.01</offsetX>
<offsetY>0.0</offsetY>
<angle>3</angle>
<anchor>0</anchor>
<connectPoint>5</connectPoint>
</left>
<right>
<offsetX>0.01</offsetX>
<offsetY>0.0</offsetY>
<angle>3</angle>
<anchor>0</anchor>
<connectPoint>3</connectPoint>
</right>
</posModule>
</posModules>
</posModulesSet>
</posModulesSets>
</posSettings>

Customization
axisinfo
Name of the label template .xml file that creates the reference planes. The delivered files
are Grid Axis.xml and Grid Axis_No Spacing.xml.
top, bottom, left, right

Drawings and Reports Reference Data Guide 1125


Overview of Label Properties

Sides of the curve that can be used to locate the label with respect to an axis.

1 - Top
2 - Bottom
3 - Left
4 - Right

In the example below, thickness markings are placed on the left axis for the lines in red
representing profiles.

Drawings and Reports Reference Data Guide 1126


Overview of Label Properties

offsetX, offsetY
Offset distance of the label from the 2D axis. This property is used in combination with the
defined side of the curve (top, bottom, left, or right) that can be used to locate the label.

1 - Offset from X axis


2 - Offset from Y axis

angle
Orientation of the label for the defined side (top, bottom, left, or right).

XML
valu
e

Horizontal 3

Vertical 4

anchor
The point on the label used for positioning.

XML
value
Treat as Label 0

Drawings and Reports Reference Data Guide 1127


Overview of Label Properties

Uses a key point on the bounding box of the label, as specified by


the connect point property in posModulesSet (on page 2037).

Treat as Symbol 1

Uses the origin of the symbol.

Use Connect Point 2


Similar to 0 (Treat as Label) but uses a key point specified by the
connect point property defined directly in this module.

connectPoint
Specifies the position of the label relative to the key point on the text bounding box and used
with the anchor property. The default value is 4 (Middle Middle).

Key Points

0 Top Left

1 Top Middle

2 Top Right

3 Middle Left

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

 Use the connect point in this module in the same way that you use the positioning point
in the posModuleSet positioning module.

Drawings and Reports Reference Data Guide 1128


Overview of Label Properties

 You can use the value of the connect point defined in the posModulesSet positioning
module by using 0 (Treat as Label) for anchor or define the value directly in this module
by using 2 (Use Connect Point) for anchor.
 positioningPoint in the posModulesSet positioning module is not used by this module
even when you have defined that parameter.

Example
The thickness symbol is placed on the reference plane instead of the profile geometry.

Although a content module creates the annotation output, this example shows how
this module affects the output.

Absolute Radial from View Center


(DrawingVectorAbsolute)
Places label along a vector from the center of the view with a 4 cm offset.

Usage in Label Template XML


<posModules>
<posModule value="DrawingVectorAbsolute">
</posModule>
</posModules>

Customization
None

Drawings and Reports Reference Data Guide 1129


Overview of Label Properties

Absolute XY Offset (DrawingAbsolute)


Positions labels at an absolute horizontal, vertical, or angular position, depending on view
direction.

Usage in Label Template XML


<posModules>
<posModule value="DrawingAbsolute">
<hOffset>.005</hOffset>
<vOffset>-.005</vOffset>
<angle>1</angle>
<connectPoint>4</connectPoint>
</posModule>
</posModules>

Customization
hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1130


Overview of Label Properties

angle
Controls the vertical, horizontal, or absolute angle of a label.
If you are using the Absolute XY Offset (DrawingAbsolute) positioning module, then type a
floating point number as the value. You must type a number greater than negative pi/2 and
less than or equal to positive pi/2. Additionally, you must set the value in radians, not
degrees. The default value when you use this module is 0.0.
The following example demonstrates an Absolute setting.

1 - East label
2 - North Label

If you use the Clear Space Margin with Dimensions (DwgMatchlineWithDim) positioning
module, then you can specify 0 to set a Horizontal angle or 1 to specify a Vertical angle.
The default value when you use this module is 1.
The following two examples demonstrate horizontally and vertically placed labels.

1 - Horizontally placed label

Drawings and Reports Reference Data Guide 1131


Overview of Label Properties

1 - Vertically placed label

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point. The range of options is indicated by colored dots in the following
graphic. The connectPoint is placed at the TopRight.

Drawings and Reports Reference Data Guide 1132


Overview of Label Properties

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to manually edit the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1133


Overview of Label Properties

Add Point along Horizontal Girth Length


Adds points to horizontal remarking line girth curves at the midpoints of intersection points.
 Select for on (the .xml value is 1).
 Clear for off (the .xml value is 0).

 The Point on Remarking Curve along Girth (SM3DDwgRemarkingGirthLengthPG) point


generator uses the Add Point along Horizontal Girth Length property.
 To manually edit the .xml file, enclose either of the above .xml values within the following
.xml tags.
<horizontal>1<horizontal>

Add Point along Vertical Girth Length


Adds points to vertical remarking line girth curves at the midpoints of intersection points.
 Select for on (the .xml value is 1).
 Clear for off (the .xml value is 0).

 The Point on Remarking Curve along Girth (SM3DDwgRemarkingGirthLengthPG) point


generator uses the Add Point along Vertical Girth Length property.
 To manually edit the .xml file, enclose either of the above values within the following .xml
tags.
<vertical>1</vertical>

Drawings and Reports Reference Data Guide 1134


Overview of Label Properties

Aligned Objects (DrawingGALabelInline)


Places a coordinate label between objects in a view. The coordinate line is placed on the origin
or control point given by the point generator. This module also places the line between the
objects. A placeLines value of 0 does not place a coordinate line, while a value of -1 does place
a coordinate line. For more information on other settings available for this module, see Label
Templates Overview (on page 786).

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGALabelInline</gaModule>
<placeLines>-1</placeLines>
<keepTopOrBottomDup>0</keepTopOrBottomDup>
<keepLeftOrRightDup>0</keepLeftOrRightDup>
<cpLabelType>2</cpLabelType>
<placeLinesOnSheet>-1</placeLinesOnSheet>
<lineStyle>Dash Dot Red</lineStyle>
<equivalenceLabel>"Piping
Plan_FlowArrow_LongestSegment.rtp"</equivalenceLabel>
<ignoreViewDirection>0</ignoreViewDirection>
</geometricAnalyzerSettings>

Customization
placeLines
Controls line placement through the coordinate label points along aligned objects. Use this
property to include a single label in the drawing that specifies a common elevation for
aligned objects.
In the following image, placeLines has been set to 0, and the software has placed a line
connecting the equipment objects and a single label for the common Northing coordinate.

Type -1 to place lines. Type 0 to suppress lines.

Drawings and Reports Reference Data Guide 1135


Overview of Label Properties

keepTopOrBottomDup
Allows you to place a label on either the topmost or bottommost object in a group of objects
aligned at identical X positions along a vertical axis. If the value for keepTopOrBottomDup
is 0, then only the topmost point of an aligned set of points is considered for dimensioning. If
the value is set to -1, then only the bottommost point of an aligned set of points is
considered for dimensioning.Type 0 to label only the topmost point.

1 - Equipment object
2 -Labeled East coordinate
point
3 - North coordinate point

Drawings and Reports Reference Data Guide 1136


Overview of Label Properties

Type -1 to label only the bottommost point.

1 - Equipment object
2 - Labeled East coordinate
point
3 - North coordinate point

keepLeftOrRightDup
Allows you to place a label on either the leftmost or rightmost object in a group of objects
aligned at identical Y positions along a horizontal axis. If the value for keepLeftOrRightDup
is set to 0, then only the leftmost point in a horizontally aligned set of points is considered in
dimensioning. If the value is set to -1, then only the rightmost point in a horizontally aligned
set of points is considered for dimensioning.
Type 0 to label only the leftmost point.

1 - East coordinate label


2 - North coordinate label
3 - Equipment object

Drawings and Reports Reference Data Guide 1137


Overview of Label Properties

Type -1 to label the rightmost point.

1 - East coordinate label


2 - North coordinate label
3 - Equipment object

cpLabelType

1 – Equipment object

2 – Vertical text label


3 – Static control point coordinate label symbol
4 – Horizontal text label

placeLinesOnSheet
Allows you to preserve manual changes to the line position or style options between
updates when this option is turned on. Additionally, you can delete a connecting line
between objects when this option is turned on. Type 0 to turn off this option. Type -1 to
preserve changes to the line between updates.

Drawings and Reports Reference Data Guide 1138


Overview of Label Properties

lineStyle
Allows you to specify the style of the line connecting horizontally or vertically aligned pieces
of equipment. Define this property when you have labeled equipment inside a plant with
coordinate labels.
In the following graphic, the Line Style has been defined with the Dash Dot Red style.

1 - Dash Dot Red Line Style


2 - North coordinate label

equivalenceLabel
Eliminates duplicate labels on pipelines with multiple segments.
When the Equivalence Label property is used with the End of Segment geometric analyzer
and the pipeline is clipped, the software places a label at each end of the pipe segment.
Conversely, when the Equivalence Label property is used with the Longest Segment
geometric analyzer and the pipeline is clipped, a label is placed at the end of the longest line
segment.
ignoreViewDirection
Determines whether or not the software considers the view direction when updating a
drawing. This setting is useful when placing an elevation coordinate label on a plan view.

Drawings and Reports Reference Data Guide 1139


Overview of Label Properties

Type -1 to ignore the view direction.

1 - Equipment object
2 - Elevation label
3 - Static control point

Type 0 to consider the view direction.

1 - Equipment object
2 - Elevation label
3 - Static control point

Drawings and Reports Reference Data Guide 1140


Overview of Label Properties

Examples
Drawing View:

Drawings and Reports Reference Data Guide 1141


Overview of Label Properties

Detailed view of the above drawing:

Although a content module creates the annotation output, this example shows how
this module affects the output.

Allow Acute Breakline Angle


Allows you to specify whether the software can place a label with an acute angle between the
breakline and the leader line of the label. If this option is cleared, then the angle between the
breakline and the leader line is typically obtuse.
Select Allow Acute Breakline Angle to allow acute angles.

1 - Label featuring acute breakline

Drawings and Reports Reference Data Guide 1142


Overview of Label Properties

Clear Allow Acute Breakline Angle to place a breakline with an obtuse angle.

1 - Label featuring obtuse angle breakline

The Allow Acute Breakline Angle is only visible in the Label Rule Manager if
the Display Breakline property is selected. For more information, see Display Breakline (on
page 1281).

 The Default leader module (DwgLeaderControl) uses the Allow Acute Breakline Angle.
 If the Allow Acute Breakline Angle property is not present in the label rule .xml files, then
by default, the software places only straight leader lines without breaklines.
 The following options are available for manually editing the .xml file.
 Type -1 to allow acute breakline angles.
 Type 0 to place only straight leader lines.
 Enclose either value within the following .xml tags.
<allowAcuteBreaklineAngle>-1
</allowAcuteBreaklineAngle>

Drawings and Reports Reference Data Guide 1143


Overview of Label Properties

Allow Labels Outside View


Allows you to specify whether the software can place labels outside of the view during automatic
label generation.
Select this option to allow label placement outside of the view when searching for clear space.

Clear this option to force labels to stay inside the view when searching for clear space.

 The Clear Space Radial (DrawingRadial) positioning module uses the Allow Labels
Outside View property.

Drawings and Reports Reference Data Guide 1144


Overview of Label Properties

 The following options are available for manually editing the .xml file.
 Type -1 to allow label placement outside of the view when searching for clear space.
 Type 0 to force labels to stay inside the view when searching for clear space.
 Enclose either value within the following .xml tags.
<allowLabelsOutsideView>0
</allowLabelsOutsideView>

Allow Non-Orthogonal Directions


Allows you to specify that the software places a label on objects that are non-orthogonal,
that is, neither horizontal nor vertical on the drawing sheet.
Select True to place the label.

1 - Non-orthogonal pipe with label

Drawings and Reports Reference Data Guide 1145


Overview of Label Properties

Select False to suppress the label.

1 - Unlabeled non-orthogonal pipe

 The geometric analyzer modules Longest Segment (DrawingGALongestSegment) and End


Of Segment (DrawingGAEndOfSegment) use the Allow Non-Orthogonal Directions
property.
 The following options allow you to manually edit the .xml file:
 Type -1 to place the label.
 Type 0 to suppress the label.
 Enclose either of the above values within the following .xml tags.
<allowNonOrthogonalDirections>-1
</allowNonOrthogonalDirections>

Drawings and Reports Reference Data Guide 1146


Overview of Label Properties

Allow Short Leaders


Controls the visibility of the leader line of a label when the distance from the label to the
corresponding connect point is less than half the label height.
Select True to retain the leader line regardless of label position.

1 - Label with leader line

Select False to turn off the leader line if the label is positioned within this distance.

1 - Label with no leader line

If the distance from the label to the corresponding Connect Point is equal to half the
label height, the software continues to display the leader line. For more information about
connect points, see Connect Point (on page 1257).
The following leader modules use the Allow Short Leaders property:
 Default (DwgLeaderControl)
 Margin (DwgMarginLeaderControl)
 Stacked Labels (DwgStackLabelLeader)

 The following options allow you to manually edit the .xml file:

Drawings and Reports Reference Data Guide 1147


Overview of Label Properties

 Type 0 to turn off the leader line.


 Type -1 to retain the leader line regardless of label position.
 Enclose either of the above values within the following .xml tags.
<disableAutoDelete>-1</disableAutoDelete>

Anchor
The point on the label used for positioning.

XML
value
Treat as Label 0

Uses a key point on the bounding box of the label, as specified by


the connect point property in posModulesSet (on page 2037).

Treat as Symbol 1

Uses the origin of the symbol.

Use Connect Point 2


Similar to 0 (Treat as Label) but uses a key point specified by the
connect point property defined directly in this module.

 The following positioning modules use the Anchor property.


 Absolute Position by 2D Curve (ISDwgAbsolutePositionByCurve2D)
 Clear Space Position by 2D Curve (ISDwgPositionByCurve2D)
 Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin)
 The above modules support the following .xml:
<posModule="ISDwgAbsolutePositionByCurve2D">
<anchor>1</anchor>
</posModule>
 An additional positioning module, Absolute Position by 2D Curve at Axis
(SMDwgPositionByCurve2DAtAxis), also supports the Anchor property. To manually edit the

Drawings and Reports Reference Data Guide 1148


Overview of Label Properties

.xml file when using the Absolute Position by 2D Curve at Axis module, specify top,
bottom, left, or right. Then, enclose any of the above .xml values within the following
.xml tags.
<right>
<anchor>1</anchor>
</right>

Angle
Controls the vertical, horizontal, or absolute angle of a label.
You can select from the following three values: Vertical, Horizontal, or Absolute.
Select a Vertical setting to vertically orient the label.

1 - Vertically placed label

You can place a vertical label only in the top or bottom margins of the view. The
Angle property cannot produce a vertically oriented label in the right or left margins of the view.
For labels in the top or bottom margin, a vertical orientation is assumed if you do not specify an
orientation for Angle.
 Select a Horizontal setting to vertically orient the label in the top or bottom margin.

Drawings and Reports Reference Data Guide 1149


Overview of Label Properties

1 - Horizontally placed label

 Labels in the left and right margins are always horizontal when using the Clear Space
Margin with Dimensions (DwgMatchlineWithDim) positioning module.
 The following conditions must be met in order to specify a Vertical or Horizontal value
for Angle.
 You must use the Clear Space Margin with Dimensions (DwgMatchlineWithDim)
positioning module.
 You must specify a value of Top or Bottom for Orientation. Otherwise, the
software ignores the property. For more information, see Orientation (on page
1412).
 An Absolute setting is used when the system cannot find clear space in which to place the
label. The software steps out away from the coordinate point, searching for clear space.
After the system has searched all of the available positions, if the system cannot find clear
space, the software switches to the Absolute XY Offset (DrawingAbsolute) positioning
module. The system uses the Absolute XY Offset positioning module in order to ensure that
the label is placed even when no clear space is available. The software then places the label
so that the label overlaps objects and annotations in the view.
The following graphic illustrates a setting for a 1.57 degree angle used with the Easting
component of a coordinate label.

Drawings and Reports Reference Data Guide 1150


Overview of Label Properties

1 - East label
2 - North Label

 If you do not specify an angle, the default angle is 0.


 The following positioning modules use the Angle property:
 Clear Space Margin with Dimensions (DwgMatchlineWithDim)
 Absolute XY Offset (DrawingAbsolute)
 The following options are available for manually editing the .xml file.
 If you are using the Absolute XY Offset (DrawingAbsolute) positioning module, then type
a floating point number as the value. You must type a number greater than negative pi/2
and less than or equal to positive pi/2. Additionally, you must set the value in radians,
not degrees. The default value when you use this module is 0.0.
 If you use the Clear Space Margin with Dimensions (DwgMatchlineWithDim) positioning
module, then you can specify 0 to set a Horizontal angle or 1 to specify a Vertical
angle. The default value when you use this module is 1.
 Enclose any of the above values within the following .xml tags.
<angle>1</angle>

Drawings and Reports Reference Data Guide 1151


Overview of Label Properties

Axis Angle
Orientation of the label for the defined side (top, bottom, left, or right).

XML
valu
e

Horizontal 3

Vertical 4

 The Absolute Position by 2D Curve at Axis (SMDwgPositionByCurve2DAtAxis) positioning


module uses the Axis Angle property.
 To manually edit the .xml file, specify top, bottom, left, or right. Then, enclose either
of the values in the above table between the following .xml tags.
<left>
<angle>3</angle>
</left>

Axis Connect Point


Specifies the position of the label relative to the key point on the text bounding box and used
with the anchor property. The default value is 4 (Middle Middle).

Key Points

0 Top Left

1 Top Middle

2 Top Right

3 Middle Left

Drawings and Reports Reference Data Guide 1152


Overview of Label Properties

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

 Use the connect point in this module in the same way that you use the positioning point
in the posModuleSet positioning module.
 You can use the value of the connect point defined in the posModulesSet positioning
module by using 0 (Treat as Label) for anchor or define the value directly in this module
by using 2 (Use Connect Point) for anchor.
 positioningPoint in the posModulesSet positioning module is not used by this module
even when you have defined that parameter.
To manually edit the .xml file, first, specify top, bottom, left, or right. Then, enclose any of
the above .xml values within the following .xml tags.
<top>
<connectPoint>5
</connectPoint>
</top>
 The Absolute Position by 2D Curve at Axis (SMDwgPositionByCurve2DAtAxis) positioning
module uses the Connect Point property.

Axis Definition
Name of the label template .xml file that creates the reference planes. The delivered files
are Grid Axis.xml and Grid Axis_No Spacing.xml.

 The Absolute Position by 2D Curve at Axis (SMDwgPositionByCurve2DAtAxis) positioning


module uses the Axis Definition property.
 To manually edit the .xml file, enclose either of the above values within the following .xml
tags.
<axisInfo>Grid Axis.xml
</axisInfo>

Drawings and Reports Reference Data Guide 1153


Overview of Label Properties

Axis X Offset, Axis Y Offset


Offset distance of the label from the 2D axis. This property is used in combination with the
defined side of the curve (top, bottom, left, or right) that can be used to locate the label.

1 - Offset from X axis


2 - Offset from Y axis

 The Absolute Position by 2D Curve at Axis (SMDwgPositionByCurve2DAtAxis) positioning


module uses the Axis Offset X and Axis Offset Y properties.
 Specify 0, a positive, or a negative decimal paper space distance.
 To manually edit the .xml file, specify the defined side of the curve (top, bottom, left, or
right). Then, enclose the offset distance within either of the following .xml tags.
<top>
<offsetX>0.1</offsetX>
<offsetY>0.01</offsetY>
</top>

Drawings and Reports Reference Data Guide 1154


Overview of Label Properties

Bidirectional Symbol
Specifies the symbol that the system places when the pipe permits flow to travel in both
directions.
The content module Flow Direction (DrawingFlowDirectionContent) checks the pipe to
determine in which direction or directions the flow travels. The module then selects the
corresponding flow direction symbol to place on the pipe. In this case, because flow travels in
both directions through the pipe, the software places the Bidirectional Symbol on the pipe.
The following image demonstrates flow arrows placed using the Bidirectional Symbol.

1 - Pipe
2 - Bidirectional Symbol

Breakline Length
Allows you to set the length of the jog segment in a leader line that connects to the label.
Specify the length in the text box.

1 - Breakline Length

Drawings and Reports Reference Data Guide 1155


Overview of Label Properties

 The software interprets the Breakline Length that you specify as paper space units and not
as model space units.
 You can use either metric or imperial units for this measurement.
 You must specify a positive decimal paper value for this distance.
 The following leader modules use the Breakline Length property:
 Linear (DrawingLinearLeader)
 Margin (DwgMarginLeaderControl)
 The following options allow you to manually edit the .xml file:
 Type -1 to place a jog in the leader line.
 Type 0 to suppress the jog.
 Enclose either of the above values within the following .xml tags.
<jogLength>0</jogLength>

Cardinal Point
Determines the placement of the key, or cardinal, point on a feature.
 Select Bottom Left to place the Cardinal Point at the bottom left of the feature.
 Select Bottom Center to place the Cardinal Point at the bottom center of the feature.
 Select Bottom Right to place the Cardinal Point at the bottom right of the feature.
 Select Top Left to place the Cardinal Point at the top left of the feature.
 Select Top Center to place the Cardinal Point at the top center of the feature.
 Select Top Right to place the Cardinal Point at the top right of the feature.

 The system places the Cardinal Point at the bottom center by default.
 The Cardinal Point property is used with the Trench point generator module
(CivilElevationPointGenerator).
 The following options allow you to manually edit the .xml file:
 Type 1 to place the Cardinal Point at the bottom left.
 Type 2 to place the Cardinal Point in the bottom center.
 Type 3 to place the Cardinal Point at the bottom right.
 Type 7 to place the Cardinal Point at the top left.
 Type 8 to place the Cardinal Point in the top center.
 Type 9 to place the Cardinal Point at the top right.
 Enclose any of the above values within the following .xml tags.
<cardinalPoint>2</cardinalPoint>

Drawings and Reports Reference Data Guide 1156


Overview of Label Properties

Choice
Allows you to select the trench features on which the software places points.
 Select All Features to place the points on all the features of a trench.
 Select First Feature Only to place a point on only the first feature of a trench.
 Select Last Feature Only to place a point on only the last feature of a trench.
 Select None to place no points.

 The software places points on only the last feature of a trench by default.
 The Trench (CivilElevationPointGenerator) point generator module uses the Choice
property.
 The following options allow you to manually edit the .xml file:
 Type 1 to place points on all features.
 Type 2 to place a point on the first feature only.
 Type 3 to place a point of the last feature only.
 Type 4 to place no points.
 Enclose any of the above values within the following .xml tags.
<choice>3</choice>

Drawings and Reports Reference Data Guide 1157


Overview of Label Properties

Clearance
Specifies the minimum distance separating adjacent labels.
Type the distance in the text box.

1 - Clearance

 The default distance is 0.0035 m.


 You must specify a positive double paper value for Clearance.
 The Clear Space Margin with Dimensions (DwgMatchlineWithDim) positioning module uses
the Clearance property.
 You can use either metric or imperial units for this measurement.
 If the labels in the current drawing use two separate templates that both define a Clearance,
then the software uses the larger of the two Clearance values to separate adjacent labels.
 To manually edit the .xml file, enclose the distance within the following .xml tags.
<clearance>0.003</clearance>

Drawings and Reports Reference Data Guide 1158


Overview of Label Properties

Clear Space Along Linear Object


(DwgLinearPositioning)
Aligns the label to the longest line in the 2D representation of an object.

Usage in Label Template XML


<label>
<posModules>
<posModule value="DwgLinearPositioning"/>
</posModules>
</label>

Customization
None

Clear Space Center Then Above


(DrawingCenterThenAbove)
Places a label either in the center of the linear segment or above the linear segment. The
orientation of the label and the definition of "above" is determined by the direction of the linear
segment. DwgLinearAbsPos or DrawingMarginOnly should always follow this module in the
posModules section of the XML.

Usage in Label Template XML


<label>
<posSettings>
<posModulesSets>
<posModulesSet>
<PosModules>
<posModule value="DrawingCenterThenAbove">
<granularity>1</granularity>
<labelOffset>0.04</labelOffset>
</posModule>
<posModule value="DwgLinearAbsPos">
<percentageOffset>0.50</percentageOffset>
<offsetFromMember>0.01</offsetFromMember>
</posModule>
</PosModules>
</posModulesSet>
</posModulesSets>
</posSettings>
</label>

Customization
granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear

Drawings and Reports Reference Data Guide 1159


Overview of Label Properties

space in which to position the label.


 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed. Use the Label Offset property when
you want to place the label within quadrants around the point. The point generator
calculates the point. The software starts from the point location and looks outward to the
limit of the Label Offset distance, and then begins looking for clear space within which to
place the label.

Drawings and Reports Reference Data Guide 1160


Overview of Label Properties

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.

Drawings and Reports Reference Data Guide 1161


Overview of Label Properties

Clear Space Center Then Above Centerline


(DrawingCenterThenAboveCL)
Places a label either above or on center of center line on a linear segment. "Above" is
determined by the direction of the line. If no clear space is found, the label is placed on the
longest visible segment of the center line of the linear segment. Used by Piping
Plan_FlowArrow_Longest Segment.xml.

Customization
granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

Drawings and Reports Reference Data Guide 1162


Overview of Label Properties

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed. Use the Label Offset property when
you want to place the label within quadrants around the point. The point generator
calculates the point. The software starts from the point location and looks outward to the
limit of the Label Offset distance, and then begins looking for clear space within which to
place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.

Drawings and Reports Reference Data Guide 1163


Overview of Label Properties

Clear Space Center Then Rotate


(DrawingCenterThenRotate)
Positions a label in the center of the range of an object and rotates the label 90 degrees if there
is not enough clear space in the first position.

Usage in Label Template XML


<posModules>
<posModule value="DrawingCenterThenRotate">
<hOffset>0</hOffset>
<vOffset>0</vOffset>
<connectPoint>4</connectPoint>
</posModule>
</posModules>

Customization
hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1164


Overview of Label Properties

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point.
The range of options is indicated by colored dots in the following graphic. The connectPoint
is placed at the TopRight point.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to manually edit the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1165


Overview of Label Properties

Clear Space Clipped (DwgClippedPositioning)


Positions labels of clipped objects in the adjacent margin.

Usage in Label Template XML


<posModules>
<posModule value="DwgClippedPositioning">
<perimeterOffset>0.01</perimeterOffset>
</posModule>
</posModules>

Customization
perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

1 - Perimeter offset distance


2 - Dimension

Drawings and Reports Reference Data Guide 1166


Overview of Label Properties

Clear Space Coordinate (DrawingCoordLblPosMod)


Orients coordinate labels based on the "up" direction of the drawing view. DrawingAbsolute or
DrawingMarginOnly should always follow this module in the posModules section of the XML.
This positioning module supports plan views only.

Usage in Label Template XML


<posModules>
<posModule value="DrawingCoordLblPosMod">
<orientation>1</orientation>
<granularity>1</granularity>
<positioningPoint>4</positioningPoint>
<labelOffset>0.04</labeloffset>
</posModule>
<posModule value="DrawingAbsolute">
<hOffset>-0.003</hOffset>
<vOffset>0.02</vOffset>
<angle>1.570796</angle>
</posModule>
</posModules>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Drawings and Reports Reference Data Guide 1167


Overview of Label Properties

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Drawings and Reports Reference Data Guide 1168


Overview of Label Properties

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1169


Overview of Label Properties

positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.
In the following image, the Positioning Point is shown placed in the TopRight position, and
the Connect Point is shown placed in the MiddleRight position.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.

Drawings and Reports Reference Data Guide 1170


Overview of Label Properties

 Type 3 to place the point at the middle left.


 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.
labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.

Drawings and Reports Reference Data Guide 1171


Overview of Label Properties

Clear Space End of Linear Object


(DwgLblEndOfSegmentPos)
Positions labels on the ends of linear segments. Uses information from Linear Object Endpoints
(DrawingPGLinear) (on page 1357) to determine the ends of linear segments. For more
information, see Linear Object Endpoints (DrawingPGLinear) (on page 1357).

Usage in Label Template XML


<label>
<posModule value="DwgLblEndOfSegmentPos">
<minOffset>0</minOffset>
<maxOffset>0.05</maxOffset>
<granularity>1</granularity>
</posModule>
</label>

Customization
minOffset
Defines the minimum distance from a connection point that you can place a label.

1 - Minimum Offset
2 - Maximum Offset in the X direction
3 - Maximum Offset in the Y direction

Drawings and Reports Reference Data Guide 1172


Overview of Label Properties

maxOffset
Defines the maximum distance from a connection point that you can place a label.

1 - Minimum Offset
2 - Maximum Offset in the X direction
3 - Maximum Offset in the Y direction

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

Drawings and Reports Reference Data Guide 1173


Overview of Label Properties

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1174


Overview of Label Properties

Clear Space Grid Horizontal (DrawingGridLblHoriz)


Positions horizontal grid labels to the left or right of a drawing view. The Orientation tag under
labelSettings determines whether the labels are positioned on the left or right side. A value of 3
positions the labels on the left side, while a value of 4 positions the labels on the right side.
DrawingGridLblMarginOnly and DrawingGridLblMgnAbsPos must follow this positioning module
in the posModules section.

Usage in Label Template XML


<label>
<labelSettings>
<orientation>4</orientation>
<granularity>1</granularity>
<maxOffset>0.05</maxOffset>
<minOffset>0.01</minOffset>
</labelSettings>
...
<posModules>
<posModule value="DrawingGridLblHoriz"/>
<posModule value="DrawingGridLblMarginOnly"/>
<posModule value="DrawingGridLblMgnAbsPos"/>
</posModules>
</label>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Drawings and Reports Reference Data Guide 1175


Overview of Label Properties

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Drawings and Reports Reference Data Guide 1176


Overview of Label Properties

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

maxOffset
Defines the maximum distance from a connection point that you can place a label.

Drawings and Reports Reference Data Guide 1177


Overview of Label Properties

1 – Maximum Offset
2 – Perimeter Offset

Drawings and Reports Reference Data Guide 1178


Overview of Label Properties

minOffset
Defines the minimum distance from a connection point that you can place a label.

1 - Maximum Offset in X direction


2 - Maximum Offset in Y direction
3 - Minimum Offset

Drawings and Reports Reference Data Guide 1179


Overview of Label Properties

Clear Space Grid Margin (DrawingGridLblMarginOnly)


Positions grid labels that are placed in the margin. Places grid labels at a perimeter offset value
in the margin determined by the orientation tag. The perimeter is defined by the drawing volume.
Absolute Grid Margin (DrawingGridLblMgnAbsPos) (on page 1118) must follow this positioning
module in the posModules section.

Usage in Label Template XML


<label>
<posModules>
<posModule value="DrawingGridLblMarginOnly"/>
<orientation>2</orientation>
<granularity>1</granularity>
<maxOffset>0.05</maxOffset>
<perimeterOffset>0.01</perimeterOffset>
</posModule>
<posModule value="DrawingGridLblMgnAbsPos"/>
<orientation>2</orientation>
</posModule>
</posModules>
</label>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Use 1 to place the label in the top margin, 2 to place the label in the bottom margin, 3 to
place the label in the left margin, or 4 to place the label in the right margin.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

Drawings and Reports Reference Data Guide 1180


Overview of Label Properties

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Drawings and Reports Reference Data Guide 1181


Overview of Label Properties

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

Drawings and Reports Reference Data Guide 1182


Overview of Label Properties

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

maxOffset
Defines the maximum distance from a connection point that you can place a label.

1 – Perimeter Offset
2 – Margin
3 – Maximum Offset
4 – View border
5 – Label

perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

1 - Perimeter offset distance


2 - Dimension

Drawings and Reports Reference Data Guide 1183


Overview of Label Properties

Clear Space Grid Vertical (DrawingGridLblVert)


Positions vertical grid labels above or below a drawing view. The Orientation tag under
labelSettings determines whether the labels are positioned above or below the view. A value of
1 positions the labels above the drawing view, while a value of 2 positions the label below the
drawing view. DrawingGridLblMarginOnly and DrawingGridLblMgnAbsPos must follow this
positioning module in the posModules section.

Usage in Label Template XML


<label>
<labelSettings>
<orientation>2</orientation>
<maxOffset>0.05</maxOffset>
<minOffset>0.01</minOffset>
</labelSettings>
...
<posModules>
<posModule value="DrawingGridLblVert"/>
<granularity>1</granularity>
<posModule value="DrawingGridLblMarginOnly"/>
<posModule value="DrawingGridLblMgnAbsPos"/>
</posModules>
</label>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

Drawings and Reports Reference Data Guide 1184


Overview of Label Properties

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Drawings and Reports Reference Data Guide 1185


Overview of Label Properties

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

Drawings and Reports Reference Data Guide 1186


Overview of Label Properties

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

maxOffset
Defines the maximum distance from a connection point that you can place a label.

1 – Maximum Offset
2 – Perimeter Offset

Drawings and Reports Reference Data Guide 1187


Overview of Label Properties

minOffset
Defines the minimum distance from a connection point that you can place a label.

1 - Maximum Offset in X direction


2 - Maximum Offset in Y direction
3 - Minimum Offset

Drawings and Reports Reference Data Guide 1188


Overview of Label Properties

Clear Space Margin (DrawingMarginOnly)


Name: DrawingMarginOnly
Annotation Output: Label
Description: Positions labels in the margin. If the object is clipped, the label is positioned in the
same margin as the clipped object. If the object is linear, the label is positioned in the margin
that has the same linear direction.
Usage in Label Template XML
<posModules>
<posModule value="DrawingMarginOnly">
<orientation>1</orientation>
<perimeterOffset>0.01</perimeterOffset>
</posModule>
</posModules>
Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

Drawings and Reports Reference Data Guide 1189


Overview of Label Properties

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

Drawings and Reports Reference Data Guide 1190


Overview of Label Properties

1 - Perimeter offset distance


2 - Dimension

Clear Space Margin with Dimensions


(DwgMatchlineWithDim)
Positions labels and dimensions outside of the drawing matchline based on user-defined offsets.

Usage in Label Template XML


<posModules>
<posModule value="DwgMatchlineWithDim"/>
<dimension>-1</dimension>
<dimPerimeterOffset>0.02</dimPerimeterOffset>
<dimStyle>ANSI</dimStyle>
<dimTextOutside>-1</dimTextOutside>
<dimTextRotateClearance>0.002</dimTextRotateClearance>
<orientation>1</orientation>
<justification>-2</justification>
<angle>1</angle>
<clearance>0.003</clearance>
<perimeterOffset>0.01</perimeterOffset>
</posModules>

Customization
dimension
Specifies whether to place dimensions as part of the label rule.

Drawings and Reports Reference Data Guide 1191


Overview of Label Properties

Type -1 to place dimensions.

Type 0 to suppress dimensions.

dimPerimeterOffset
Determines the offset distance from the dimension to the matchline.

Drawings and Reports Reference Data Guide 1192


Overview of Label Properties

1 - Dimension Perimeter Offset

dimStyle
Defines the appearance of dimensions placed by the label rule.
Type any of the following styles.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

Drawings and Reports Reference Data Guide 1193


Overview of Label Properties

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

The following examples demonstrate the ISO and JIS properties, respectively.

1 - ISO dimension style

Drawings and Reports Reference Data Guide 1194


Overview of Label Properties

1 - JIS dimension style

dimTextOutside
Controls the placement of dimension text values for margin dimensions in the right and
bottom margins.
Type -1 to place the dimension text value outside of the dimension line.

1 - View border
2 - Dimension text value

Drawings and Reports Reference Data Guide 1195


Overview of Label Properties

Type 0 to place the dimension text value inside of the dimension line.

1 - View border
2 - Dimension text value

dimTextRotateClearance
Rotates the text of a dimension line 90 degrees when insufficient space exists for the text
between the projection lines.
Specify the minimum clearance between the beginning or end of the dimension line text and
the corresponding projection line. If the actual distance between the text and the projection
line is less than the specified value, the software rotates the text 90 degrees relative to the
dimension line.

Clearance of 0.01 m

In the above image, 0.01 m has been specified as the clearance between the end of the
dimension line text and the projection line. Because the distance between the end of the
dimension line text and the projection line is not at least 0.01 m, the text is not rotated.

Drawings and Reports Reference Data Guide 1196


Overview of Label Properties

Clearance of 0.002 m

In the above example, 0.002 m has been specified as the clearance between the end of the
dimension line text and the projection line. Because the distance between the end of the
dimension line text and the projection line is not at least 0.002 m, the text is rotated.
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Drawings and Reports Reference Data Guide 1197


Overview of Label Properties

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

justification

Drawings and Reports Reference Data Guide 1198


Overview of Label Properties

Determines whether to align labels inside or outside the available clear space.
The following example demonstrates a label as well as the text positioned inside clear
space.

The next example shows the result when the label and text are positioned outside clear
space.

The following options are available for manually editing the .xml file.
 Type -2 to position the label and align the text outside the available clear space.
 Type -1 to position the label outside the available clear space.
 Type 0 to disable Justification.
 Type 1 to position the label inside the available clear space.
 Type 2 to position the label and align the text inside the available clear space.

Drawings and Reports Reference Data Guide 1199


Overview of Label Properties

angle
Controls the vertical, horizontal, or absolute angle of a label.
If you are using the Absolute XY Offset (DrawingAbsolute) positioning module, then type a
floating point number as the value. You must type a number greater than negative pi/2 and
less than or equal to positive pi/2. Additionally, you must set the value in radians, not
degrees. The default value when you use this module is 0.0.
The following example demonstrates an Absolute setting.

1 - East label
2 - North Label

If you use the Clear Space Margin with Dimensions (DwgMatchlineWithDim) positioning
module, then you can specify 0 to set a Horizontal angle or 1 to specify a Vertical angle.
The default value when you use this module is 1.
The following example demonstrates a vertically placed label.

Drawings and Reports Reference Data Guide 1200


Overview of Label Properties

1 - Vertically placed label

The next example demonstrates a horizontally placed label.

1 - Horizontally placed label

Drawings and Reports Reference Data Guide 1201


Overview of Label Properties

clearance
Specifies the minimum distance separating adjacent labels.

1 - Clearance

If the labels in the current drawing use two separate templates that both define a
Clearance, then the software uses the larger of the two Clearance values to separate
adjacent labels.
perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

Drawings and Reports Reference Data Guide 1202


Overview of Label Properties

1 - Perimeter offset distance


2 - Dimension

Clear Space Position by 2D Curve


(ISDwgPositionByCurve2D)
Positions a label along the 2D curve, using clear space to avoid overlap with other labels. The
orientation of the label is set from the point, relative to the 2D curve, and is controlled by the
angle parameter.
The 2D curve of the 3D object must have one or more curves.

Usage in Label Template XML


<label>
<posSettings>
<posModulesSets>
<posModulesSet>
<connectPoint>4</connectPoint>
<positioningPoint>4</positioningPoint>
<posModules>
<posModule value="ISDwgPositionByCurve2D">
<startCurveRatio>0.0</startCurveRatio>
<endCurveRatio>1.0</endCurveRatio>
<angle>0</angle>
<anchor>1</anchor>
<searchMode>0</searchMode>
<hOffset>0.0</hOffset>
<vOffset>0.0</vOffset>
<granularity>1</granularity>
<priority>1</priority>

Drawings and Reports Reference Data Guide 1203


Overview of Label Properties

<whiteObj>LAYER_NAME</whiteObj>
</posModule>
</posModules>
</posModulesSet>
</posModulesSets>
</posSettings>
<\label>

Customization
startCurveRatio
Specifies the start point on the 2D curve. Specify the value as a ratio along the length of the
curve. The ratio must be between 0.0 and 1.0.

The software performs the search for clear space positioning between the start point and the
end point. The end curve ratio must be greater than the start curve ratio.
endCurveRatio
Specifies the end point on the 2D curve. The software defines this value as a ratio along the
length of the curve. The ratio must be between 0.0 and 1.0.

The software searches for clear space positioning between the start point and the end point.
The end curve ratio must be greater than the start curve ratio.
angle
Orientation of the label.

XML value

Tangent 0
Tangent to a
curve

Normal Out 1
Along
outward
normal

Drawings and Reports Reference Data Guide 1204


Overview of Label Properties

Normal In 2
Along
inward
normal

Horizontal 3

Vertical 4

Default 5
Orientation

Uses the orientation from the content module

anchor
The point on the label used for positioning.

XML
value
Treat as Label 0

Uses a key point on the bounding box of the label, as specified by


the connect point property in posModulesSet (on page 2037).

Treat as Symbol 1

Drawings and Reports Reference Data Guide 1205


Overview of Label Properties

Uses the origin of the symbol.

Use Connect Point 2


Similar to 0 (Treat as Label) but uses a key point specified by the
connect point property defined directly in this module.

connectPoint
Specifies the position of the label relative to the key point on the text bounding box and used
with the anchor property. The default value is 4 (Middle Middle).

Key Points

0 Top Left

1 Top Middle

2 Top Right

3 Middle Left

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

 Use the connect point in this module in the same way that you use the positioning point
in the posModuleSet positioning module.
 You can use the value of the connect point defined in the posModulesSet positioning
module by using 0 (Treat as Label) for anchor or define the value directly in this module
by using 2 (Use Connect Point) for anchor.
 positioningPoint in the posModulesSet positioning module is not used by this module
even when you have defined that parameter.
searchMode
Defines the starting point and search method for the clear space search along the 2D curve.

Drawings and Reports Reference Data Guide 1206


Overview of Label Properties

XML value

From Center 0

Starts from the center of the 2D curve. The software tries


to place the label to the left or right of the center of the
curve.

Low To High 1

Starts from the start curve ratio location. The system tries
to place the label in clear space in a search toward the
end curve ratio location.

High To Low 2

Starts from the end curve ratio location. The software


tries to place the label in clear space in a search toward
the start curve ratio location.

hOffset
Horizontal distance of the label from the positioning point. This value is measured in meters.
The default value is 0.00.
vOffset
Vertical distance of the label from the positioning point. The software measures this value in
meters. The default value is 0.00.
granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.

Drawings and Reports Reference Data Guide 1207


Overview of Label Properties

 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1208


Overview of Label Properties

priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.

1 - Equipment label placed using the Priority property


2 - Additional Structure label placed using the Priority property
3 - New label placement with Structure at Priority 1 and
Equipment at Priority 2

Drawings and Reports Reference Data Guide 1209


Overview of Label Properties

whiteObj
Allows you to specify one or more 2D layers in the drawing to serve as white object layers
for a label placed in clear space. Graphical objects set on these layers are rendered invisible
to this label, allowing placement of the label on top of these objects.

1 - Pipe within a White Object Layer


2 - Equipment label overlapping pipes

If this filter is set to "*" during label placement, then the system ignores all objects that
are not labels or leaders.

Drawings and Reports Reference Data Guide 1210


Overview of Label Properties

Example
Angle is 0, anchor is 0 (using connectPoint 4 in posModulesSet), startCurveRatio is 0.0,
endCurveRatio is 1.0, searchMode is 0

Although a content module creates the annotation output, this example shows how
this module affects the output.

Clear Space Position by 2D Curve at Margin


(ISDwgPositionByCurve2DAtMargin)
Positions a label for a 2D curve at the view margin relative to the position of the curve.
The 2D geometry of the 3D object must have one or more curves.

Usage in Label Template XML


<posSettings>
<posModulesSets>
<posModulesSet>
<connectPoint>4</connectPoint>
<positioningPoint>4</positioningPoint>
<posModules>
<posModule value="ISDwgPositionByCurve2DAtMargin">
<top>1</top>
<bottom>1</bottom>
<left>1</left>
<right>1</right>
<angle>3</angle>
<anchor>0</anchor>
<connectPoint>3</connectPoint>
<maxOffset>0.05</maxOffset>
<minOffset>0.01</minOffset>
<marginDefinition>1</marginDefinition>
<useClearSpace>1</useClearSpace>

Drawings and Reports Reference Data Guide 1211


Overview of Label Properties

<perimeterOffset>0.01</perimeterOffset>
<granularity>1</granularity>
</posModule>
</posModules>
</posModulesSet>
</posModulesSets>
</posSettings>

Customization
top, bottom, left, right
Sides of the view that you can use to locate the curve label. You can only locate labels in
the margins of the specified sides. For each side, select to allow a label in the margin (the
.xml value is 1) or clear if no label in the margin is needed (the .xml value is 0).

1 - Top
2 - Bottom
3 - Left
4 - Right

angle
Orientation of the label.

XML value

Tangent 0
Tangent to a
curve

Normal Out 1
Along
outward
normal

Drawings and Reports Reference Data Guide 1212


Overview of Label Properties

Normal In 2
Along
inward
normal

Horizontal 3

Vertical 4

Default 5
Orientation

Uses the orientation from the content module

anchor
The point on the label used for positioning.

XML
value
Treat as Label 0

Uses a key point on the bounding box of the label, as specified by


the connect point property in posModulesSet (on page 2037).

Treat as Symbol 1

Drawings and Reports Reference Data Guide 1213


Overview of Label Properties

Uses the origin of the symbol.

Use Connect Point 2


Similar to 0 (Treat as Label) but uses a key point specified by the
connect point property defined directly in this module.

connectPoint
Specifies the position of the label relative to the key point on the text bounding box and used
with the anchor property. The default value is 4 (Middle Middle).

Key Points

0 Top Left

1 Top Middle

2 Top Right

3 Middle Left

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

 Use the connect point in this module in the same way that you use the positioning point
in the posModuleSet positioning module.
 You can use the value of the connect point defined in the posModulesSet positioning
module by using 0 (Treat as Label) for anchor or define the value directly in this module
by using 2 (Use Connect Point) for anchor.
 positioningPoint in the posModulesSet positioning module is not used by this module
even when you have defined that parameter.

Drawings and Reports Reference Data Guide 1214


Overview of Label Properties

marginDefinition
Specifies the relationship of the grid axes to the drawing view for measuring the margin
offset of the axes.

XML
value

At View Frame 0
(default value)
Measures the margin
offset for each axis from
the edges of the view
SmartFrame, shown as
dashed lines in the
example.

At Drawing Area 1
Measures the margin
offset for each axis from
the edges of the drawing
area, shown as solid lines
in the example.

If you set the frame behavior to Frame resizes to drawing area, then the view frame and
the drawing area are the same size, and both values provide the same result, as shown in
the following example.

For more information, see Area Tab (Edit Ruleset View Style Dialog Box) (on page 130) in
the Drawings and Reports Reference Data Guide.

Drawings and Reports Reference Data Guide 1215


Overview of Label Properties

maxOffset
Defines the maximum distance from a connection point that you can place a label.

1 – Perimeter Offset
2 – Margin
3 – Maximum Offset
4 – View border
5 – Label

minOffset
Defines the minimum distance from a connection point that you can place a label.

1 - Minimum Offset
2 - Maximum Offset in the X direction
3 - Maximum Offset in the Y direction

Drawings and Reports Reference Data Guide 1216


Overview of Label Properties

useClearSpace
Specifies whether the software uses clear space to avoid overlap with other labels. Use 0 to
ignore clear space or 1 to use clear space.
perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

1 - Perimeter offset distance


2 - Dimension

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

Drawings and Reports Reference Data Guide 1217


Overview of Label Properties

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Example
The label is placed in the view margin instead of on the profile geometry.

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1218


Overview of Label Properties

Clear Space Position Marine Grid Label at Margin


(SMDwgPositionGridLblMarginOnly)
Determines both the clear space position of grid labels that are placed in the margin as well as
the end of the object relative to which the software should place the label.
Labels that are placed outside of the matchline and in clear space use the breakline settings as
well as the perimeterOffset setting. The SMDwgPositionGridLblMarginOnly module then
places grid labels at a perimeterOffset value in the margin. The orientation of the margin is
determined by the orientation tag, as in the .xml example below.
The Absolute Grid Margin (DrawingGridLblMgnAbsPos) (on page 1118) module must follow this
positioning module in the <posModules> section. For more information, see Absolute Grid
Margin (DrawingGridLblMgnAbsPos) (on page 1118).

Usage in Label Template XML


<label>
<posModules>
<posModule value="SMDwgPositionGridLblMarginOnly"/>
<orientation>2</orientation>
<granularity>1</granularity>
<maxOffset>0.05</maxOffset>
<minOffset>0.01</minOffset>
<perimeterOffset>0.01</perimeterOffset>
</posModule>
<posModule value="DrawingGridLblMgnAbsPos"/>
<orientation>2</orientation>
</posModule>
</posModules>
</label>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Use 1 to place the label in the top margin, 2 to place the label in the bottom margin, 3 to
place the label in the left margin, or 4 to place the label in the right margin.
granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

Drawings and Reports Reference Data Guide 1219


Overview of Label Properties

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

maxOffset
Defines the maximum distance from a connection point that you can place a label.

1 – Perimeter Offset
2 – Margin
3 – Maximum Offset
4 – View border
5 – Label

Drawings and Reports Reference Data Guide 1220


Overview of Label Properties

minOffset
Defines the minimum distance from a connection point that you can place a label.

1 - Minimum Offset
2 - Maximum Offset in the X direction
3 - Maximum Offset in the Y direction

Drawings and Reports Reference Data Guide 1221


Overview of Label Properties

perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

1 - Perimeter offset distance


2 - Dimension

Examples

1:
orientation is 1 (up)
perimeterOffset is 0.001
maxOffset is 0.005
2:
orientation is 3 (left)
perimeterOffset is 0.005
maxOffset is 0.005

Drawings and Reports Reference Data Guide 1222


Overview of Label Properties

1:
orientation is 1 (up)
perimeterOffset is 0.01
maxOffset is 0.01
2:
orientation is 4 (right)
perimeterOffset is 0.005
maxOffset is 0.005

Drawings and Reports Reference Data Guide 1223


Overview of Label Properties

Clear Space Quadrant 1 (DrawingQuadOne)


Positions labels in the first quadrant (upper-right) based on the positioning point. This module is
used with DrawingQuadTwo, DrawingQuadThree, and DrawingQuadFour. These modules do
not have to follow a certain order.

Usage in Label Template XML


<posModules>
<posModule value="DrawingQuadOne"/>
<positioningPoint>4</positioningPoint>
<hOffset>0.02</hOffset>
<vOffset>0.02</vOffset>
<connectPoint>4</connectPoint>
<granularity>1</granularity>
<labelOffset>0.04</labelOffset>
<posModule value="DrawingQuadTwo"/>
<posModule value="DrawingQuadThree"/>
<posModule value="DrawingQuadFour"/>
</posModules>

Customization
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.

Drawings and Reports Reference Data Guide 1224


Overview of Label Properties

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.

Drawings and Reports Reference Data Guide 1225


Overview of Label Properties

hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1226


Overview of Label Properties

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point. The range of options is indicated in colored dots in the following
graphic. The ConnectPoint is placed at the TopRight.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to manually edit the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1227


Overview of Label Properties

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

Drawings and Reports Reference Data Guide 1228


Overview of Label Properties

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.
Additional customization is available in the labelSettings section of the XML file. For
more information, see Label Templates Overview (on page 786).

Clear Space Quadrant 2 (DrawingQuadTwo)


Positions labels in the second quadrant (lower-right) based on the positioning point. This module
is used with DrawingQuadOne, DrawingQuadThree, and DrawingQuadFour. These modules do
not have to follow a certain order.

Usage in Label Template XML


<posModules>
<posModule value="DrawingQuadOne"/>
<posModule value="DrawingQuadTwo"/>
<positioningpoint>4</positioningPoint>
<granularity>1</granularity>
<connectPoint>4</connectPoint>
<labelOffset>0.04</labelOffset>
<posModule value="DrawingQuadThree"/>
<posModule value="DrawingQuadFour"/>
<hOffset>0.02</hOffset>
<vOffset>0.02</vOffset>
</posModules>

Customization
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting

Drawings and Reports Reference Data Guide 1229


Overview of Label Properties

at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.

Drawings and Reports Reference Data Guide 1230


Overview of Label Properties

 Type 7 to place the point in the bottom middle.


 Type 8 to place the point at the bottom middle.
hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1231


Overview of Label Properties

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point.
The range of options is indicated in colored dots in the following graphic. The connectPoint
is placed at the TopRight.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options are available for manually editing the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1232


Overview of Label Properties

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Additional customization is available in the labelSettings section of the XML file. For
more information, see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 1233


Overview of Label Properties

Clear Space Quadrant 3 (DrawingQuadThree)


Positions labels in the third quadrant (lower-left) based on the positioning point. This module is
used with DrawingQuadOne, DrawingQuadTwo, and DrawingQuadFour. These modules do not
have to follow a certain order.

Usage in Label Template XML


<posModules>
<posModule value="DrawingQuadOne"/>
<posModule value="DrawingQuadTwo"/>
<posModule value="DrawingQuadThree"/>
<positioningPoint>4</positioningPoint>
<hOffset>0.02</hOffset>
<vOffset>0.02</vOffset>
<connectPoint>4</connectPoint>
<granularity>1</granularity>
<labelOffset>0.04<labelOffset>
<posModule value="DrawingQuadFour"/>
</posModules>

Customization
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.

Drawings and Reports Reference Data Guide 1234


Overview of Label Properties

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.

Drawings and Reports Reference Data Guide 1235


Overview of Label Properties

hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point.
The range of options is indicated by colored dots in the following graphic. The connectPoint
is placed at the TopRight point.

Drawings and Reports Reference Data Guide 1236


Overview of Label Properties

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to edit the .xml file.


 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1237


Overview of Label Properties

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1238


Overview of Label Properties

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.
Additional customization is available in the labelSettings section of the XML file. For
more information, see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 1239


Overview of Label Properties

Clear Space Quadrant 4 (DrawingQuadFour)


Positions label in the fourth quadrant (upper-left) based on the positioning point. This module is
used with DrawingQuadOne, DrawingQuadTwo, and DrawingQuadThree. These modules do
not have to follow a certain order.

Usage in Label Template XML


<posModules>
<posModule value="DrawingQuadOne"/>
<posModule value="DrawingQuadTwo"/>
<posModule value="DrawingQuadThree"/>
<posModule value="DrawingQuadFour"/>
<positioningPoint>4</positioningPoint>
<hOffset>0.02</hOffset>
<vOffset>0.02</vOffset>
<connectPoint>4</connectPoint>
<granularity>1</granularity>
<labelOffset>0.04</labelOffset>
</posModules>

Customization
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.

Drawings and Reports Reference Data Guide 1240


Overview of Label Properties

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.

Drawings and Reports Reference Data Guide 1241


Overview of Label Properties

hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1242


Overview of Label Properties

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point.
The range of options is indicated by colored dots in the following graphic. The connectPoint
is placed at the TopRight point.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to manually edit the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1243


Overview of Label Properties

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1244


Overview of Label Properties

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.
Additional customization is available in the labelSettings section of the XML file. For
more information, see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 1245


Overview of Label Properties

Clear Space Radial (DrawingRadial)


Automatically searches points for labeling using radiating concentric circles.
The following image shows the possible positioning points generated radially from the connect
point of the labeled object. In this image, the maxOffset property is illustrated.

1 - Maximum Offset

Usage in Label Template XML


<posModule value="DrawingRadial"/>
<granularity>1</granularity>
<minOffset>0.015</minOffset>
<maxOffset>0.060</maxOffset>
</posModule>

Customization
granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
maxOffset
Defines the maximum distance from a connection point that you can place a label.
minOffset
Defines the minimum distance from a connection point that you can place a label.

Drawings and Reports Reference Data Guide 1246


Overview of Label Properties

Clear Space Radial from Object Center with


Clustering (DrawingCentroid)
Positions labels based on the white space located from the center of the related object and
vector. If objects have the same relation object and vector, they are grouped together. This
positioning module must be used with the Nozzle (DrawingPGNozzleandBrace) (on page 1401)
point generator module.

Usage in Label Template XML


<posModules>
<posModule value="DrawingCentroid">
<rOffset>0.0</rOffset>
<labelType>0</labelType>
<rotation>0</rotation>
<fromMatchline>0</fromMatchline>
<granularity>1</granularity>
<labelOffset>0.04</labelOffset>
</posModule>
</posModules>

Customization
rOffset
Determines the distance between a nozzle port and the label annotating the port.
labelType

Drawings and Reports Reference Data Guide 1247


Overview of Label Properties

 Specifies whether the label is a Nozzle, Top of Equipment/Bottom of Equipment, or


Angle label.

1 - Nozzle
2 - Top of Equipment/Bottom of Equipment
3 - Angle

 Type 0 to place a Nozzle label.


 Type 1 to place a TOP or BTM label.
 Type 2 to place an Angle label.

Drawings and Reports Reference Data Guide 1248


Overview of Label Properties

rotation
Determines the angular orientation of the labels. The labels can be aligned horizontally,
irrespective of the orientation of the nozzle orientation angle, or the labels can be rotated to
match the nozzle orientation angle.
Type -1 to rotate all labels.

Drawings and Reports Reference Data Guide 1249


Overview of Label Properties

Type 0 to force horizontal label angles.

Drawings and Reports Reference Data Guide 1250


Overview of Label Properties

fromMatchline
Determines the inside or outside placement of a label with respect to the matchline
boundary. Type -1 to position the labels outside of the matchline boundaries.

1 - Matchline

Drawings and Reports Reference Data Guide 1251


Overview of Label Properties

Type 0 to position the labels inside of the matchline boundaries.

1 - Matchline

Drawings and Reports Reference Data Guide 1252


Overview of Label Properties

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1253


Overview of Label Properties

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed. Use the Label Offset property when
you want to place the label within quadrants around the point. The point generator
calculates the point. The software starts from the point location and looks outward to the
limit of the Label Offset distance, and then begins looking for clear space within which to
place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.

Drawings and Reports Reference Data Guide 1254


Overview of Label Properties

Clear Space Tiling (CAD Details) (DrawingTileInView)


Permits an additional spacing option when labels in the view are tiled. This spacing option
recognizes the amount of space between each label and positions labels accordingly.

Usage in Label Template XML


<posModule>
<posModule value="DrawingTileInView">
<spacing>0.01</spacing>
</posModule>
</posModules>

Customization
spacing
Specifies the vertical and horizontal distances between CAD Details graphics placed on the
drawing sheet.
The following graphic shows the Spacing property with 0.01 m specified between two CAD
Details graphics.

1 - End plate
2 - Shoe base

Drawings and Reports Reference Data Guide 1255


Overview of Label Properties

The following graphic shows the Spacing property with 0.02 m specified between two CAD
Details graphics.

1 - End plate
2 - Shoe base
3 - Shoe vertical part

The number of CAD Details graphics that can fit on the drawing sheet depends on the
measurements that you specify for this property. Specifying a greater distance between
CAD Details graphics results in fewer graphics on the drawing sheet, while specifying a
smaller distance results in a greater number of graphics on the drawing sheet.

Drawings and Reports Reference Data Guide 1256


Overview of Label Properties

Connect Point
Specifies the point on the model object to which the leader line connects. If model objects block
the direct path of the leader line to the Connect Point, then the leader line points toward the
connect point.
You can select the point from a list. The range of options is indicated by colored dots in the
following graphic. The Connect Point is placed at the TopRight point.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The Connect Point property can only be used with one of the point
generators listed below. Otherwise, the software ignores the property.
 Key Point(DefaultLabelPointGenerator)
 Nozzle (DrawingPGNozzleandBrace)
 Points Along 2D Range (ISDwgPointsAlongRange2D)
 Points for View (ISDwgPointsForView)
 MidPoint (ISMidPointLabelPG)
 Default Marine Point (ISRulesetPointGenerator)

Drawings and Reports Reference Data Guide 1257


Overview of Label Properties

 Points At Manufacturing Sketch Coordinates (MfgSketchPG)

 You must use a positioning module when setting this property. The following positioning
modules use the Connect Point property.
 Absolute XY Offset (DrawingAbsolute)
 Clear Space Center Then Rotate
(DrawingCenterThenRotate)
 Clear Space Quadrant 1
(DrawingQuadOne)
 Clear Space Quadrant 2
(DrawingQuadTwo)
 Clear Space Quadrant 3
(DrawingQuadThree)
 Clear Space Quadrant 4
(DrawingQuadFour)
 Clear Space Radial (DrawingRadial)
 The following options allow you to manually edit the .xml file:
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.
 Enclose any of the above values within the following .xml tags.
<connectPoint>4</connectPoint>

Drawings and Reports Reference Data Guide 1258


Overview of Label Properties

Control Point Label Type


Controls the orientation of the coordinate label.

1 – Equipment object
2 – Vertical text label
3 – Static control point coordinate label symbol
4 – Horizontal text label

You can select any of the following three values from a list.
 Select Vertical to place a vertical label.
 Select Horizontal to place a horizontal label.
 Select Symbol to place a static control point coordinate label.
To eliminate duplicate vertically or horizontally aligned labels, only one label is placed on the
aligned objects.

 The software uses the Aligned Objects (DrawingGALabelInline) geometric analyzer to place
the label.
 The following options allow you to manually edit the .xml file:
 Type 0 to place a static control point coordinate label.
 Type 1 to place a horizontal text label.
 Type 2 to place a vertical text label.

Drawings and Reports Reference Data Guide 1259


Overview of Label Properties

 Enclose any of the above values within the following .xml tags.
<cpLabelType>0</cpLabelType>

Control Point Only (DrawingPGCPThenNone)


Places a point for labeling or dimensioning on an object's control point. If no control point exists,
then the software does not place a label or dimension.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGCPThenNone</pgModule>
</pointGeneratorSettings>

Customization
None

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1260


Overview of Label Properties

Control Point then Local CS Origin then Center


(DrawingPGControlPoint)
Places a point for labeling or dimensioning on an object's control point. If no control point exists,
then the software places the point on the object's origin. If the origin cannot be found, then the
software places the point at the 2D-projected location of the center of the object's 3D range.

1 - Equipment origin point


2 - Dimension

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGControlPoint</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1261


Overview of Label Properties

Coordinate (DrawingCoordLeaderControl)
Places a leader line under the coordinate label. The style tag determines which dimension style
to use from styles.sha, while the breakline tag determines whether or not to place a jog in the
leader. A value of -1 is true and places a jog in the leader, while a value of 0 does not place a
jog.

Usage in Label Template XML


<label>
<leaderSettings>
<leaderModule>DrawingCoordLeaderControl</leaderModule>
<breakline>0</breakline>
<style>ANSI</style>
</leaderSettings>
</label>

Customization
breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.

Type -1 to place a leader jog.

Type 0 to omit the jog.

Drawings and Reports Reference Data Guide 1262


Overview of Label Properties

You cannot place breaklines with acute leader jog angles when automatically
generating labels. However, you can manually place breaklines with acute leader jog angles
within SmartSketch by updating the view, then selecting a leader and clicking BreakLine .
style
Defines the appearance of a leader line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Drawings and Reports Reference Data Guide 1263


Overview of Label Properties

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Drawings and Reports Reference Data Guide 1264


Overview of Label Properties

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Default (DefaultLabelControlGenerator)
Currently used by all label templates. Generates a label control for each label that is used to run
the positioning modules.

Usage in Label Template XML


<annotationControlGenerator>
<acgModule>DefaultLabelControlGenerator</acgModule>
<labelLayer>MATCHLINE_LABELS</labelLayer>
<priority>1</priority>
</annotationControlGenerator>

Customization
labelLayer
Allows you to specify the 2D layer on which the software automatically places labels.
The following illustration shows an equipment object with a label placed on the layer
specified in the text box.

Drawings and Reports Reference Data Guide 1265


Overview of Label Properties

1 - Equipment object
2 - Label
3 - Text Box Properties dialog box specifying the
layer on which the label resides

Drawings and Reports Reference Data Guide 1266


Overview of Label Properties

priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.
The software attempts to place an annotation (such as a label or a dimension) in clear
space as close as possible to that object's Connect Point. Multiple annotations do not
overlap. The Priority property allows you to assign a priority to each annotation, with 1
being the highest priority. The software places the annotation with the highest priority
closest to that object's Connect Point. Additional annotations with lower priorities are
placed further away from the corresponding object's Connect Point.
To define the priority, type a positive integer in the Priority text box.

1 - Equipment labels placed with Priority set to 1


2 - Structure label placed with Priority set to 2

1 - Equipment label placed with Priority set to 2


2 - Structure label placed with Priority set to 1

Drawings and Reports Reference Data Guide 1267


Overview of Label Properties

Default (DrawingLabelHelper)
Outputs data in a text box that is taken from a specified report label. Two conditions must exist
for this content module to work properly:
 The drawing view must be linked to a report. If this condition is not met, an error is logged in
the Smart 3D Error Log.
 The item being labeled in the view style must be in the report. If this condition is not met, a
question mark (?) is displayed.
Type 0 to display the label regardless of an error.

1 - Error label

Type -1 to suppress the label when an error occurs.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingLabelHelper"/>
<ID attributeName="Equipment Plan_Equipment_Name">
Equipment Plan_Equipment_Name.rtp</ID>
<ignoreError>-1</ignoreError>
</content>
</label>

Drawings and Reports Reference Data Guide 1268


Overview of Label Properties

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
The ignoreError property is unavailable when you define the symbol path label.
For more information, see Symbol Path Label (on page 1474).
symbolPathLabel
Specifies which report template contains the symbol file names for the label.

 The ID attributeName value must match the name in the Value box in the Text Box
Properties dialog box for the label template .sym file you are modifying, as shown
below:

 For more information on modifying label templates, see Create a Compound Label with
a Combined Symbol (on page 748).

Drawings and Reports Reference Data Guide 1269


Overview of Label Properties

Examples
Equipment label:

Bubble label with no content and ignoreError value of 0 (or ignoreError is not defined):

Bubble label with no content and ignoreError value of -1:

Drawings and Reports Reference Data Guide 1270


Overview of Label Properties

Default (DwgLeaderControl)
Places a leader line between the label and the drawing object. The style tag determines which
dimension style to use from styles.sha, while the breakline tag determines whether or not to
place a job in the leader. A value of -1 is true and places a jog in the leader, while a value of 0
does not place a jog.

Usage in Label Template XML


<label>
<leaderSettings>
<leaderModule>DwgLeaderControl</leaderModule>
<style>ANSI</style>
<breakline>-1</breakline>
<disableAutoDelete>-1</disableAutoDelete>
<ignoreLeaderCrossings>-1</ignoreLeaderCrossings>
</leaderSettings>
</label>

Customization
style
Defines the appearance of a leader line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Drawings and Reports Reference Data Guide 1271


Overview of Label Properties

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

To manually edit the .xml, specify the style that you want applied to the leader line.
breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.
Type -1 to place a leader jog.

Drawings and Reports Reference Data Guide 1272


Overview of Label Properties

Type 0 to omit the jog.

You cannot place breaklines with acute leader jog angles when automatically
generating labels. However, you can manually place breaklines with acute leader jog angles
within SmartSketch by updating the view, then selecting a leader and clicking BreakLine .
disableAutoDelete
Controls the visibility of the leader line of a label when the distance from the label to the
corresponding connect point is less than half the label height.
Type -1 to retain the leader line.

1 - Label with leader line

Drawings and Reports Reference Data Guide 1273


Overview of Label Properties

Type 0 to turn off the leader line.

1 - Label with no leader line

ignoreLeaderCrossings
Renders the leader line of a label as invisible to other annotations.
Type -1 to allow leader lines and other annotations to intersect.

Drawings and Reports Reference Data Guide 1274


Overview of Label Properties

Type 0 to render the leader line visible to other annotations.

Default Marine Label (ISRulesetLabelContent)


Creates a text box symbol containing a value obtained from the embedded report.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISRulesetLabelContent"/>
<ID attributeName="Ruleset_Name">Ruleset_Name.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Drawings and Reports Reference Data Guide 1275


Overview of Label Properties

Default Marine Label Text (ISRulesetLabelAnalyzer)


Determines the labels needed for a point and gets the text for the label based on the type of
geometry used to generate the point.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>ISRulesetLabelAnalyzer</gaModule>
</geometricAnalyzerSettings>

Customization
None

Default Marine Point (ISRulesetPointGenerator)


Places a point for labeling on the 2D curves representing a 3D object at the control point of the
object.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>ISRulesetPointGenerator</pgModule>
</pointGeneratorSettings>

Customization
None

Example
The software places profile mounting angle and profile thickness labels (circled in red) using
points created by ISRulesetPointGenerator.

Drawings and Reports Reference Data Guide 1276


Overview of Label Properties

Dimension Perimeter Offset


Determines the offset distance from the dimension to the matchline.
Specify the offset distance in the text box.

1 - Dimension Perimeter Offset

 You must specify a positive double paper value for this measurement.
 You can use either metric or imperial units for this measurement.
 The positioning module Clear Space Margin with Dimensions (DwgMatchlineWithDim) uses
the Dimension Perimeter Offset property.
 To manually edit the .xml file, enclose the offset distance within the following .xml tags.
<dimPerimeterOffset>0.02
</dimPerimeterOffset>

Drawings and Reports Reference Data Guide 1277


Overview of Label Properties

Dimension Style
Defines the appearance of dimensions placed by the label rule.
To choose a default style delivered with the software, select the style that you want applied to
the dimension line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Drawings and Reports Reference Data Guide 1278


Overview of Label Properties

The following two examples demonstrate two cases of the Dimension Style property using the
ISO and JIS styles, respectively.

1 - ISO dimension style

1 - JIS dimension style

 You must use the positioning module Clear Space Margin with Dimensions
(DwgMatchlineWithDim) when defining the Dimension Style property.
 To manually edit the .xml file, enclose the style that you want applied to the dimension within
the following .xml tags.

Drawings and Reports Reference Data Guide 1279


Overview of Label Properties

<style>ANSI</style>

You can use SmartSketch Drawing Editor to create your own styles.

Dimension Text Rotate Clearance


Rotates the text of a dimension line 90 degrees when insufficient space exists for the text
between the projection lines.
Specify the minimum clearance between the beginning or end of the dimension line text and
the corresponding projection line. If the actual distance between the text and the projection
line is less than the specified value, the software rotates the text 90 degrees relative to the
dimension line.

Clearance of 0.01 m

In the above image, 0.01 m has been specified as the clearance between the end of the
dimension line text and the projection line. Because the distance between the end of the
dimension line text and the projection line is not at least 0.01 m, the text is not rotated.

Clearance of 0.002 m

Drawings and Reports Reference Data Guide 1280


Overview of Label Properties

In the above example, 0.002 m has been specified as the clearance between the end of the
dimension line text and the projection line. Because the distance between the end of the
dimension line text and the projection line is not at least 0.002 m, the text is rotated.

 The positioning module Clear Space Margin with Dimensions (DwgMatchlineWithDim) uses
the Dimension Text Rotate Clearance property.
 You must specify a positive paper value.
 You can use either metric or imperial units for this measurement.
 To manually edit the .xml file, type a value for the minimum clearance between the
beginning or end of the dimension line text and the corresponding projection line. Enclose
this value within the following .xml tags.
<dimTextRotateClearance>0.002
</dimTextRotateClearance>

Display Breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.
 Select On to display the breakline.

Drawings and Reports Reference Data Guide 1281


Overview of Label Properties

 Select Off to suppress the breakline so that the leader line connects directly to the label.

You must select Off if you use the Linear (DrawingLinearLeader) or Margin
(DwgMarginLeaderControl) leader modules.

 The following leader modules use the Display Breakline property:


 Default (DwgLeaderControl)
 Only Outside of Object (DwgLeaderInOutsideControl
 Stacked Labels (DwgStackLabelLeader)
 Materials Handling Absolute (MHDrawingAbsoluteLeader)
 The following options allow you to manually edit the .xml file:
 Type -1 to place a breakline.
 Type 0 to omit the breakline.
 Enclose either of the above values within the following .xml tags.
<breakline>-1</breakline>

Drawings and Reports Reference Data Guide 1282


Overview of Label Properties

Display Dimension
Specifies whether to place dimensions as part of the label rule.
 Select On to place dimensions.

 Select Off to suppress dimensions.

Drawings and Reports Reference Data Guide 1283


Overview of Label Properties

 The Clear Space Margin with Dimensions (DwgMatchlineWithDim) positioning module uses
the Display Dimension property.
 The following options allow you to manually edit the .xml file:
 Type -1 to place dimensions.
 Type 0 to suppress dimensions.
 Enclose either of the above values within the following .xml tags.
<dimension>-1</dimension>

Display Empty/Error Labels


Specifies whether or not the system places a label if the software returns no content or an
error for the label.
 Clear the Display Empty/Error Labels check box to suppress any empty labels or an error
for the label.
 Select the Display Empty/Error Labels check box if you want the label to display
regardless of empty content or an error. This option is selected by default.
The following example shows one of two results when the Display Empty/Error Labels option
is selected. In this case, an empty label displays even though the content module found no data
with which to populate the label.

1 - Empty label

In the next example, the Display Empty/Error Labels check box is selected as well. However,
in this case, the content module encountered an error while attempting to process the label.
Therefore, an error label displays.

Drawings and Reports Reference Data Guide 1284


Overview of Label Properties

1 - Error label

 The Display Empty/Error Labels option is available for all content modules.
 The following options allow you to manually edit the .xml file:
 Type -1 to suppress the label when an error occurs.
 Type 0 to display the label regardless of an error. This is the default value.
 Enclose either of the above values within the following .xml tags.
<ignoreError>0</ignoreError>

Dummy (DummyGeomAnalyzer)
Dummy module used for dimension anchoring and penetration plate dimensions. Point
generator modules use the dummy module to perform all geometric analyzing tasks. You must
use this module when you use the Penetration Plate (PenPlatePointGenerator) (on page 1777).

Usage in Label or Dimension Template XML


<geometricAnalyzerSettings>
<gaModule>DummyGeomAnalyzer</gaModule>
</geometricAnalyzerSettings>

Customization
None

Drawings and Reports Reference Data Guide 1285


Overview of Label Properties

Eliminate Labels with Missing Parents


(SMDGAEliminateLabelsWithMissingParents)
If all parents of a label are not drawn, then the label is not drawn.
Applies only to seam labels. Shows a seam when both adjacent target plate parts
have been drawn. Other seams are omitted. When a single plate is drawn without any adjacent
plates, no seam symbols are drawn.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>SMDGAEliminateLabelsWithMissingParents</gaModule>
</geometricAnalyzerSettings>

Customization
None

Examples
Seam example:
In the first example, plate 1 is drawn. The seam labels at adjacent plates are drawn (green
lines).

In the second example, plate 1 is not drawn. The seam labels at adjacent plates are not drawn
(blue lines).

Drawings and Reports Reference Data Guide 1286


Overview of Label Properties

Although a content module creates the annotation output, this example shows how
this module affects the output.

Eliminate Most Common Labels


(ISGAEliminateMostCommonLabels)
Identifies the most common label (typical labels) from the drawing view and places it as part of
the view label. This is done to prevent the duplication of labels in the drawing view.

Usage in Label Template XML


<label>
<geometricAnalyzerSettings>
<gaModule>ISGAEliminateMostCommonLabels</gaModule>
<equivalenceLabel>
Ship Structure Plate Thickness Material Grade by COM.rtp
</equivalenceLabel>
<equivalenceProperty interfaceName="IJDwgViewTypical"
propertyValue="Value2" propertyKey="Key2" />
</geometricAnalyzerSettings>
</label>

Customization
equivalenceLabel
Specifies the name of the report template that the software uses to determine the most
common, typical label. The report template must be located in the same folder as the label
template XML.
equivalenceProperty
Specifies the property values for the typical label used by the view label rule. See the
example below.
 interfaceName - Specifies the name of the interface that the software uses to collect
label attributes for determining typical labels.
 propertyValue - A custom property with a value ranging from Value1 to Value20. The
specified report template must use this value to define the typical label. See the
example below.
 propertyKey - This property is reserved for future use.

Drawings and Reports Reference Data Guide 1287


Overview of Label Properties

Example
The view below uses the ViewNameDirectionScale view label rule. Without
ISGAEliminateMostCommonLabels, the software places all plate labels and the view label as
follows.

The view below uses the ViewNameDirectionScale view label rule. Within the rule,
ISGAEliminateMostCommonLabels defines the typical label as a property value of Value2.
The report that you have specified as the equivalence label also defines the typical label as
Value2. The most common label is removed from the view, and a typical label is included with
the view label.

For more information, see ViewNameDirectionScale View Label Template (on page 921).
Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1288


Overview of Label Properties

Eliminate Overlapping Labels


(ISGAEliminateOverlappingLabels)
Eliminates the duplication of annotations when two geometric objects overlap.

Usage in Label Template XML


<label>
<geometricAnalyzerSettings>
<gaModule>ISGAEliminateOverlappinglabels</gaModule>
<equivalenceLabel>
Ship Structure Plate Thickness Material Grade by COM.rtp
</equivalenceLabel>
<overlapping>
<keeplabelByLocation>0</keeplabelByLocation>
</overlapping>
<nonoverlapping>
<keeplabelByLocation>3</keeplabelByLocation>
</nonoverlapping>
</geometricAnalyzerSettings>
</label>

Customization
equivalenceLabel
Specifies the name of the report template that the software uses to determine the most
common, typical label. The report template must be located in the same folder as the label
template XML.
overlapping
Specifies properties for overlapping labels on overlapping objects.
nonoverlapping
Specifies properties for non-overlapping labels on overlapping objects.
keeplabelByLocation
Specifies the label that the software keeps on overlapping objects. This property is specified
for overlapping and non-overlapping labels. Select one of the following options:

XML
value

Keep default 0

Drawings and Reports Reference Data Guide 1289


Overview of Label Properties

Keep near side 1

Keep far side 2

Keep both sides 3

Keep none 4

Embedded Label
Allows you to place two labels simultaneously.
Embedded Labels are valid only when manually placed. After you have placed the Embedded
Label, the system removes the unembedded label from the drawing. This results in two labels
within the drawing that are independent of each other.
Type the template file name to embed in the text box, excluding the .xml extension. The
software does not support multiple embedded labels.

 The following content modules use the Embedded Label(s) property.


 Piping Elevation
(DrawingBOLabelContent)
 Trench (DrawingCivilLabelContent)

Drawings and Reports Reference Data Guide 1290


Overview of Label Properties

 Object Coordinates
(DrawingEquipmentStyle2Content)
 Flow Direction
(DrawingFlowDirectionContent)
 Hanger Key Plan
(DrawingHangerLabelContent)
 Default (DrawingLabelHelper)
 No Label Content
(DrawingNoContent)
 DrawingOpeningContent
 DrawingOrientToY0Content
 Reference
(DrawingReferenceLabelContent)
 Weld (DrawingWeldSymbols)
 Structural Widget
(StructuralWidgetLabelContent)
 Scantling Weld Symbol
(DwgScantlingWeld)
 Longest Segment
(ISDwgProfileEndCutSymbol)
 Manufacturing Profile Plate Location Symbol
(MfgProfilePlateLocSymContent)
 SlotSymbol
 Generic Interoperability
(SMDGenericContentInterop)
 Pin Jig Seam Offset Label
(SMDPinJigSeamOffsetCM)
 Manufacturing Pin Height Label
(SMDwgMfgPinHeightLabelContent)
 Profile Sketch Label
(SMDwgProfileSketchLabelsContent)
 Ruler Axis (SMRulerAxisSymbolContent)
 To manually edit the .xml file, type a string designating the file name of the label .xml
template to embed, excluding the .xml extension. Enclose the file name within the following
.xml tags.
<embeddedLabel>
Instrument Elevation_Equipment_Name
</embeddedLabel>

Drawings and Reports Reference Data Guide 1291


Overview of Label Properties

End Curve Ratio


Specifies the end point on the 2D curve. The software defines this value as a ratio along the
length of the curve. The ratio must be between 0.0 and 1.0.

The software searches for clear space positioning between the start point and the end point.
The end curve ratio must be greater than the start curve ratio.

 The Clear Space Position by 2D Curve (ISDwgPositionByCurve2D) positioning module uses


the End Curve Ratio property.
 To manually edit the .xml file, enclose the ratio within the following .xml tags.
<endCurveRatio>1</endCurveRatio>

End of Segment (DrawingGAEndOfSegment)


Places labels on the segment ends of a linear object. Each vertical or horizontal segment and
both clipped sides are labeled.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGAEndOfSegment</gaModule>
<allowNonOrthogonalDirections>-1</allowNonOrthogonalDirections>
<ignoreClippingForGrouping>0</ignoreClippingForGrouping>
<maxOffsetForGrouping>0.1</maxOffsetForGrouping>
<ignoreOffsetForGrouping>0</ignoreOffsetForGrouping>
<equivalenceLabel>"Piping
Plan_FlowArrow_LongestSegment.rtp"</equivalenceLabel>
</geometricAnalyzerSettings>

Customization
allowNonOrthogonalDirections
Allows you to specify that the software places a label on objects that are non-orthogonal,
that is, neither horizontal nor vertical on the drawing sheet.
Type -1 to place the label.

Drawings and Reports Reference Data Guide 1292


Overview of Label Properties

1 - Non-orthogonal pipe with label

Type 0 to suppress the label.

1 - Unlabeled non-orthogonal pipe

ignoreClippingForGrouping
Allows you to turn off duplicate labels on straight features that are clipped on both sides.
Type 0 to turn off duplicate labels. Type -1 to allow duplicate labels.

Drawings and Reports Reference Data Guide 1293


Overview of Label Properties

maxOffsetForGrouping
Specifies the maximum distance between consecutive endpoints of linear objects.
The system uses the specified distance for grouping label points together, grouping points
that consecutively fall within the specified maximum offset into a particular set. The software
then creates one label per set. Conversely, the system creates a separate label for each
point that lies at a greater distance from the closest linear points than the specified
Maximum Offset for Grouping value.
The distance that you specify must take into account inline features, such as pipe valves.
Therefore, the specified value must be high enough that the system does not create labels
on both sides of each inline feature.
The default distance is 0.1 m.

 Specify 0 or a positive decimal value for this distance.


 In contrast to the majority of properties, the software interprets the distance that you
specify as model space units and not as paper space units.

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.
ignoreOffsetForGrouping
Specifies whether the software honors the offset value for the Maximum Offset for
Grouping property. When selected, this option honors the offset distance, forcing the
software to create separate labels when the distance between consecutive endpoints of
linear objects is greater than the Maximum Offset for Grouping.
Type -1 to ignore the offset distance. Type 0 to honor the offset distance.
equivalenceLabel
Eliminates duplicate labels on pipelines with multiple segments.
When the Equivalence Label property is used with the End of Segment geometric analyzer
and the pipeline is clipped, the software places a label at each end of the pipe segment.
Conversely, when the Equivalence Label property is used with the Longest Segment
geometric analyzer and the pipeline is clipped, a label is placed at the end of the longest line
segment.
See Also
Edit a label rule to use the Equivalence Label (on page 1799)

Drawings and Reports Reference Data Guide 1294


Overview of Label Properties

Equivalence Label
Eliminates duplicate labels on pipelines with multiple segments.
When the Equivalence Label property is used with the End of Segment geometric analyzer
and the pipeline is clipped, the software places a label at each end of the pipe segment.
Conversely, when the Equivalence Label property is used with the Longest Segment
geometric analyzer and the pipeline is clipped, a label is placed at the end of the longest line
segment.
To select an .rtp file to designate as the Equivalence Label, click the Browse button to
navigate to the Label/Templates directory. Select the .rtp file that you want to use.

 You can place labels on pipelines with multiple segments if the view style includes the
Longest Segment (ISDwgProfileEndCutSymbol) geometric analyzer module.
 You must use the Equivalence Label property with the Linear Object Endpoints
(DrawingPGLinear) point generator.
 The following geometric analyzers use the Equivalence Label property;
 End of Segment (DrawingGAEndOfSegment)
 Longest Segment (DrawingGALongestSegment)
 Aligned Objects (DrawingGALabelInline)
 To manually edit the .xml file, enclose a string designating the Equivalence Label, including
the .rtp, file, within the .xml tags.
<equivalenceLabel>".rtp file name of the label
template"</equivalenceLabel>
For example, the value of the equivalence label for a Piping Plan Flow Arrow Longest
Segment label template is "Piping Plan_FlowArrow_Longest Segment.rtp".

Equivalence Label
Specifies the name of the report template that the software uses to determine the most
common, typical label.

 The following geometric analyzers use the Equivalence Label property.


 End of Segment (DrawingGAEndOfSegment)
 Longest Segment (DrawingGALongestSegment)
 Eliminate Most Common Labels (ISGAEliminateMostCommonLabels)
 Eliminate Overlapping Labels (ISGAEliminateOverlappingLabels)
 To manually edit the .xml file, enclose the string designating the Equivalence Label,
including the .rtp, within the following .xml tags.
<equivalenceLabel>
"Ship Structure Plate Thickness

Drawings and Reports Reference Data Guide 1295


Overview of Label Properties

Material Grade by COM.rtp"


</equivalenceLabel>

Equivalence Property Interface Name


Specifies the name of the interface that the software uses to collect label attributes for
determining typical labels.

 The Eliminate Most Common Labels (ISGAEliminateMostCommonLabels) geometric


analyzer module uses the Equivalence Property Interface Name property.
 The Equivalence Property Interface Name property is associated with the Equivalence
Property Value and Property Key tags. To manually edit the .xml file, designate the
interface name for the interfaceName, as follows.
<equivalenceProperty
interfaceName="IJDwgViewTypical"
propertyValue="Value1"
propertyKey="Key2" />

Equivalence Property Value


A custom property with a value ranging from Value1 to Value20. The specified report template
must use this value to define the typical label.

Example
The view below uses the ViewNameDirectionScale view label rule. Without
ISGAEliminateMostCommonLabels, the software places all plate labels and the view label as
follows.

Drawings and Reports Reference Data Guide 1296


Overview of Label Properties

The view below uses the ViewNameDirectionScale view label rule. Within the rule,
ISGAEliminateMostCommonLabels defines the typical label as a property value of Value2.
The report that you have specified as the equivalence label also defines the typical label as
Value2. The most common label is removed from the view, and a typical label is included with
the view label.

 The Eliminate Most Common Labels (ISGAEliminateMostCommonLabels) geometric


analyzer module uses the Equivalence Property Value property.
 The Equivalence Property Value property is associated with the Equivalence Property
Interface Name and Property Key tags. To manually edit the .xml file, designate the virtual
attribute name for the propertyValue, as follows.
<equivalenceProperty
interfaceName="IJDwgViewTypical"
propertyValue="Value1"
propertyKey="Key2" />

Feature Type
Determines whether to place a point for either the turn feature or the straight feature, or both.
 Select Straight Feature to place a point for the straight feature.
 Select Turn Feature to place a point for the turn feature.
 Select Both Straight and Turn Features to place a point for both the straight feature and
the turn feature.

 The default Feature Type is Straight Feature.


 The Feature Type property is used with the Trench (CivilElevationPointGenerator) point
generator.
 The following options allow you to manually edit the .xml file:
 Type 1 to place a point for the straight feature.

Drawings and Reports Reference Data Guide 1297


Overview of Label Properties

 Type 2 to place a point for the turn feature.


 Type 3 to place a point for both the straight feature and the turn feature.
 Enclose any of the above values within the following .xml tags.
<featureType>1</featureType>

Flow Direction (DrawingFlowDirectionContent)


Places flow arrow symbols on pipe runs and orients them based on the flow direction properties
of the pipes. The software draws a symbol at one-half of the pipe diameter and can draw the
symbol on a pipe resymbolized as a line.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingFlowDirectionContent"/>
<unidirectionalSymbol>
Piping Plan_FlowArrow_By Part_Flow_arrow1.sym
</undirectionalSymbol>
<bidirectionalSymbol>
Piping Plan_FlowArrow_By Part_Flow_arrow-bi.sym
</bidirectionalSymbol>
<noFlowSymbol>
Piping Plan_FlowArrow_By Part_No-Flow_Arrow1.sym
<noFlowSymbol>
<minDiameter>0.02</minDiameter>
<ignoreError>-1</ignoreError>
<scaleFactor>0.5</scaleFactor>
</content>
</label>
The symbol file must be located in the same folder as the label template XML, and
the center line of the pipe must be drawn.

Customization
unidirectionalSymbol

1 - Pipe
2 - Unidirectional Symbol

Drawings and Reports Reference Data Guide 1298


Overview of Label Properties

bidirectionalSymbol

1 - Pipe
2 - Bidirectional Symbol

noFlowSymbol
Specifies the symbol that the system places when the pipe on which you want to place the
symbol does not permit flow to travel through the pipe.
This attribute is only available for flow arrows that you place manually.

1 - Pipe
2 - NoFlow Symbol

minDiameter
Specifies the minimum diameter of a routed object at which the system may place a flow
arrow.
Pipes of a smaller outside diameter have no flow arrow.

1 - 0.0 m diameter
pipe
2 - Flow arrow

Drawings and Reports Reference Data Guide 1299


Overview of Label Properties

ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

scaleFactor
Controls the size of pipe flow arrow symbols. The software places a flow direction arrow
scaled to a percentage of the pipe diameter.

Drawings and Reports Reference Data Guide 1300


Overview of Label Properties

From Matchline
Determines the inside or outside placement of a label with respect to the matchline boundary.
 Select True to place the label outside of the matchline boundary.

1 - Matchline

 Select False to place the label inside of the matchline boundary.

Drawings and Reports Reference Data Guide 1301


Overview of Label Properties

1 - Matchline

 The positioning module Clear Space Radial from Object Center with Clustering
(DrawingCentroid) uses the From Matchline property.
 The following options allow you to manually edit the .xml file:
 Type 0 if you want the software to position the labels inside of the matchline boundaries.
 Type -1 if you want the software to position the labels outside of the matchline
boundaries.
 Enclose either of the above values within the following .xml tags.
<fromMatchline>0</fromMatchline>

Drawings and Reports Reference Data Guide 1302


Overview of Label Properties

Generic Interoperability
(GenericGeometricAnalyzerInterop)
Acts as a wrapper module that forwards the geometric analyzer call to a module written in .NET.
In the following .xml example, the MfgSketchNameFeaturesGA geometric analyzer module
performs the actual geometric analysis.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>GenericGeometricAnalyzerInterop</gaModule>
<gaModuleSettings>
<Assembly value = "MfgSketchNameFeaturesGA" />
</gaModuleSettings>
</geometricAnalyzerSettings>

Customization
Assembly value
Specifies the name of the geometric analyzer to use.

 The GenericGeometricAnalyzerInterop geometric analyzer module is only used in


delivered label templates for manufacturing sketch drawings. For more information, see
MfgSketchNameFeaturesGA (on page 1389).
 GenericGeometricAnalyzerInterop is a wrapper geometric analyzer module that must be
used with .NET geometric analyzer modules.

Drawings and Reports Reference Data Guide 1303


Overview of Label Properties

Generic Interoperability (SMDGenericContentInterOp)


Acts as a wrapper module that forwards the content module call to a module written in .NET. In
the following .xml example, the MfgSketchContent content module creates the content.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDGenericContentInterOp"/>
<Assembly value="MfgSketchContent" />
<symbol representation="" scale="0.001">
<labels>
<label name="ANGLE_A">
<file>
<![CDATA[ StrMfg Sketch Bevel Symbol_Angle
Label ]]>
</file>
<value type="xpath">
<![CDATA[
descendant-or-self::SMS_BEVEL/@ANGLE_A ]]>
</value>
</label>
</labels>
<parameters>
<parameter name="ANGLE_A">
<value type="xpath">
<![CDATA[
descendant-or-self::SMS_BEVEL/@ANGLE_A ]]>
</value>
</parameter>
</parameters>
</symbols>
</content>
</label>

Customization
Assembly value
Specifies the name of the content module to use.

 The SMDGenericContentInterOp content module is only used in delivered label templates


for manufacturing sketch drawings. For more information, see Manufacturing Sketch
(MfgSketchContent) (on page 1371).
 SMDGenericContentInterOp is a wrapper content module that must be used with .NET
content modules.

Drawings and Reports Reference Data Guide 1304


Overview of Label Properties

Granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear space
in which to position the label. You can select from the following range of values in a list: Coarse,
Medium, or Fine. Each setting determines the height measurement the software uses when
placing the label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

 Choose Coarse to specify a large increment. With a Coarse setting, the software searches
an increment of exactly one height of the label in order to find clear space in which to place
the label.
 Choose Medium to specify a medium increment. With a Medium setting, the software
searches an increment of exactly one-half the height of the label in order to find clear space
in which to place the label.
 Choose Fine to specify a fine increment. With a Fine setting, the software searches an
increment of exactly one-third the height of the label in order to find clear space in which to
place the label.

Drawings and Reports Reference Data Guide 1305


Overview of Label Properties

A Granularity setting of Medium or Fine allows the software to check a greater number of
positions in which to place the label. Therefore, if you select these settings, the software takes
longer to find clear space for the label. However, because the Medium and Fine settings try to
place the label closer to the actual object that is being labeled, the relationship of the label to the
object may be clearer than if you select a Coarse setting.

 The label attempts to avoid overlaps, regardless of the Granularity setting that you select.
Instead, the software continues searching in increments of the specified measurement,
either until clear space is found within the Label Offset distance or until no further clear
space positions are available. At this point, the software applies the next positioning module
and begins searching again.
 The following positioning modules use different methods to search for clear space:
 Clear Space Quadrant 1 (DrawingQuadOne)
 Clear Space Quadrant 2 (DrawingQuadTwo)
 Clear Space Quadrant 3 (DrawingQuadThree)
 Clear Space Quadrant 4 (DrawingQuadFour)
The above positioning modules tell the software to search in increments equal to portions of
the existing label height only. If you select a Coarse setting, the software looks for clear
space in increments of exactly one label height. If you select Medium, the software looks for
clear space in increments of exactly half of one label height. Likewise, if you select a Fine
setting, the software looks for clear space in increments of exactly one-third of one label
height. The software uses the height of the existing label as the basis for the measurement.
 The following additional positioning modules use the Granularity property:
 Clear Space Center Then Above (DrawingCenterThenAbove)
 Clear Space Center Then Above Centerline (DrawingCenterThenAboveCL)
 Clear Space Radial from Object Center with Clustering (DrawingCentroid)
 Clear Space Coordinate (DrawingCoordLblPosMod)
 Clear Space Grid Horizontal (DrawingGridLblHoriz)
 Clear Space Grid Margin (DrawingGridLblMarginOnly)
 Clear Space Grid Vertical (DrawingGridLblVert)
 Clear Space End of Linear Object (DwgLblEndOfSegmentPos)
 Clear Space Position by 2D Curve (ISDwgPositionByCurve2D)
 Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin)
 Clear Space Position Marine Grid Label at Margin (SMDwgPositionGridLblMarginOnly)
 Clear Space Radial (DrawingRadial)
 The following options allow you to manually edit the .xml file:
 Type 0 to specify a Coarse setting.
 Type 1 to specify a Medium setting.
 Type 2 to specify a Fine setting.

Drawings and Reports Reference Data Guide 1306


Overview of Label Properties

 Enclose any of the above values within the following .xml tags.
<granularity>1</granularity>

Group Bubble Label


Defines the bubble label template and symbol used by a manually placed group label. If you do
not select a bubble label, then the software places the group labels without bubble labels.

To choose a new bubble label template file, click the ellipsis to the right of the Group
Bubble Label box. Select a bubble label template from the Select .xml File dialog box.

Usage in Label Template XML


<label>
<groupLabel>
<bubbleLabel>Name_None_CA_JL_Bubble</bubbleLabel>
<clearance>0.001</clearance>
</groupLabel>
</label>
See Also
Group Labels (on page 753)

Group by Axis (SMDwgGroupByAxisGA)


Finds the reference plane that is coincident with the geometry of the object to be labeled. If there
is no coincident reference plane, then the closest reference plane is found. When this module is
used with the Absolute Position by 2D Curve at Axis (SMDwgPositionByCurve2DAtAxis) (on
page 1124) positioning module, the reference plane label is placed on the appropriate grid axis.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>SMDwgGroupByAxisGA</gaModule>
</geometricAnalyzerSettings>

Customization
None

Drawings and Reports Reference Data Guide 1307


Overview of Label Properties

Example

Group Clipped Points


Allows you to turn off duplicate labels on straight features that are clipped on both sides.
 Select this option to turn off duplicate labels. This is the default setting.
 Clear this option to allow duplicate labels.

 The End of Segment (DrawingGAEndOfSegment) geometric analyzer uses the Group


Clipped Points property.
 The following options are available for manually editing the .xml file.
 Type 0 to allow duplicate labels.
 Type -1 to turn off duplicate labels.
 Enclose either of the above options within the following .xml tags.
<ignoreClippingForGrouping>0
</ignoreClippingForGrouping>

Drawings and Reports Reference Data Guide 1308


Overview of Label Properties

Group Label Clearance


Determines the distance between labels in a manually placed group label.
Specify the distance in the Group Label Clearance text box.

1 - Bubble label clearance

Usage in Label Template XML


<label>
<groupLabel>
<bubbleLabel>Name_None_CA_JL_Bubble</bubbleLabel>
<clearance>0.001</clearance>
</groupLabel>
</label>

 The software interprets the Group Label Clearance distance that you specify as paper
space units and not as model space units.
 You can use either metric or imperial units for this measurement.
 You must specify a positive decimal paper value for this distance.
See Also
Group Labels (on page 753)

Drawings and Reports Reference Data Guide 1309


Overview of Label Properties

Hanger Key Plan Control Point then Support Location


(DrawingPGKeyPlanControlPoint)
Generates a point at the location of the latest Key Plan Callout control point subtype. Only
control points placed as Support as parent or Support component as parent are considered.
If no control points with the Key Plan Callout subtype exist, then a point is generated at the
support origin.
This module is typically used for drawings containing pipe hangers or supports.

1 - Dimension
2 - Control point
3 - Support origin

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1310


Overview of Label Properties

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGKeyPlanControlPoint</pgModule>
</pointGeneratorSettings>

Customization
None

Honor Maximum Offset for Grouping


Specifies whether the software honors the offset value for the Maximum Offset for
Grouping property. When selected, this option honors the offset distance, forcing the
software to create separate labels when the distance between consecutive endpoints of
linear objects is greater than the Maximum Offset for Grouping.
 Select this option to honor the offset distance. This is the default setting.
 Clear this option to ignore the offset distance.

 You cannot set an offset value in the Maximum Offset for Grouping property if the Honor
Maximum Offset for Grouping property is cleared. For more information, see Maximum
Offset for Grouping (on page 1388).
 The End of Segment (DrawingGAEndOfSegment) geometric analyzer uses the Honor
Maximum Offset for Grouping property.
 The following options are available for manually editing the .xml file.
 Type -1 to ignore the offset distance.
 Type 0 to honor the offset distance.
 Enclose either of the above options within the following .xml tags.
<ignoreOffsetForGrouping>0
</ignoreOffsetForGrouping>

Drawings and Reports Reference Data Guide 1311


Overview of Label Properties

Honor View Direction


Determines whether or not the software considers the view direction when updating a
drawing. This setting is useful when placing an elevation coordinate label on a plan view.
 Clear this option to ignore the view direction. In the following example, the view direction is
East, and the Honor View Direction option is cleared.

1 - Equipment object
2 - Elevation label
3 - Static control point

To ensure that the system always horizontally orients elevation coordinate labels on the
drawing, clear this option when updating a drawing view with an elevation looking direction.
 Select this option to consider the view direction when updating the view. In the following
example, the view direction is East, and the Honor View Direction option is selected. The
software considers the view direction by default.

1 - Equipment object
2 - Elevation label
3 - Static control point

Drawings and Reports Reference Data Guide 1312


Overview of Label Properties

 The geometric analyzer Aligned Objects (DrawingGALabelInline) uses the Honor View
Direction property.
 The following options allow you to manually edit the .xml file:
 Type -1 if you want the software to ignore the view direction.
 Type 0 if you want the software to consider the view direction.
 Enclose either of the above values within the following .xml tags.
<ignoreViewDirection>0
</ignoreViewDirection>

Horizontal Offset, Vertical Offset


The horizontal or vertical distance of the label from the positioning point. This distance is applied
when the software cannot find clear space in which to place the label. The value is measured in
meters. If the software cannot find clear space, you may use the following absolute positioning
modules to place the label:
 Absolute XY Offset (DrawingAbsolute)
 Clear Space Center Then Rotate (DrawingCenterThenRotate)
 Absolute Position by 2D Curve (ISDwgAbsolutePositionByCurve2D)
 Clear Space Position by 2D Curve (ISDwgPositionByCurve2D)
Select a horizontal and a vertical distance that you choose to indicate where you want the
software to place the label with respect to the labeled point. Type the horizontal distance from
the point in the Horizontal Offset box. Then type the vertical distance from the point in the
Vertical Offset box.
For both the vertical and the horizontal distances, you can type positive or negative values. Type
0 if you want the software to place the label directly over the point.
If you specify a positive Horizontal Offset distance, the label moves right. If you specify a
negative Horizontal Offset distance, the label moves left. Likewise, specifying a positive
Vertical Offset distance moves the label up, while specifying a negative Vertical Offset
distance moves the label down. The software takes the horizontal and vertical distances that
you specify and places the label at that location, regardless of any model objects or annotations
that the label overlaps.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

Drawings and Reports Reference Data Guide 1313


Overview of Label Properties

1 - Horizontal Offset distance


2 - Vertical Offset distance

The Horizontal Offset and Vertical Offset properties are relative to the
symbol origin of the label and not to the edge of the label that is closest to the point that you are
labeling.

 The software interprets both the vertical and horizontal offset distances as paper space units
and not as model space units.
 You must specify a positive, negative, or zero paper distance value.
 To manually edit the .xml file, specify the distance that you want the horizontal and vertical
distances offset. Enclose this value within the following .xml tags.
<hOffset>0.0</hOffset>
<vOffset>0.0</vOffset>

Drawings and Reports Reference Data Guide 1314


Overview of Label Properties

Horizontal Ruler Axis Offset


Distance of a horizontal grid axis from the drawing view. Type the offset value in the Horizontal
Ruler Axis Offset box.

 The Ruler Axis (SMRulerAxisSymbolContent) content module uses the Horizontal Ruler
Axis Offset property.
 To manually edit the .xml file, first define the axis (top or bottom). Then, enclose the offset
value within the offset tags. An example follows.
<bottom>
<offset>0.03</offset>
</bottom>
See Also
Horizontal Ruler Axis Position (on page 1315)

Horizontal Ruler Axis Position


Specifies the side of the drawing view on which the software draws the horizontal axis.
Other properties are defined for this side. Select either Bottom or Top from the Horizontal
Ruler Axis Position list. Select None for no horizontal ruler axis to display.

Bottom

Drawings and Reports Reference Data Guide 1315


Overview of Label Properties

Top

None

 The Ruler Axis (SMRulerAxisSymbolContent) content module uses the Horizontal Ruler
Axis Position property.
 To manually edit the .xml file, first, specify axisInfo. Then, specify either top or bottom
as shown in the example below.
<axisInfo>
<top>
</top>
</axisInfo>
 Remove the top or bottom section from the .xml file if you do not want to display a
horizontal ruler axis.

Drawings and Reports Reference Data Guide 1316


Overview of Label Properties

Horizontal Ruler Axis Style


Defines the line style for the axis ruler. Select a style from the Horizontal Ruler Axis Style list.

1 - Style = Normal

 The Ruler Axis (SMRulerAxisSymbolContent) content module uses the Horizontal Ruler
Axis Style property.
 Select the axis ruler location (Top or Bottom) from the Horizontal Ruler Axis Position list.
 To manually edit the .xml file, first define the axis (top or bottom). Then, enclose the style
within the .xml tags as shown in the following example.
<bottom>
<style>Normal</style>
</bottom>
See Also
Horizontal Ruler Axis Position (on page 1315)

Drawings and Reports Reference Data Guide 1317


Overview of Label Properties

Horizontal Ruler Axis Tick Mark Length Away from


View
Defines the length of the grid tick mark from the axis and away from the drawing view. Type a
value in the Horizontal Ruler Axis Tick Mark Length Away from View box.

1 - Length of tick mark away from view

 The Ruler Axis (SMRulerAxisSymbolContent) content module uses the Horizontal Tick
Mark Length Away from View property.
 To manually edit the .xml file, specify the location of the tick mark using top or bottom.
Then, enclose the tick mark length within the following .xml tags.
<bottom>
<tickMarkInfo>
<minusX>0.01</minusX>
</tickMarkInfo>
</bottom>

Drawings and Reports Reference Data Guide 1318


Overview of Label Properties

Horizontal Ruler Axis Tick Mark Length toward View


Defines the length of the grid tick mark from the axis and toward the drawing view. Type a value
in the Horizontal Ruler Axis Tick Mark Length Away from View box.

1 - Length of tick mark away from view

 The Ruler Axis (SMRulerAxisSymbolContent) content module uses the Horizontal Ruler
Axis Tick Mark Length toward View property.
 To manually edit the .xml file, specify the location of the tick mark using top or bottom.
Then, enclose the tick mark length within the following .xml tags.
<bottom>
<tickMarkInfo>
<plusX>0.0</plusX>
</tickMarkInfo>
</bottom>

Drawings and Reports Reference Data Guide 1319


Overview of Label Properties

Horizontal Ruler Axis Tick Mark Style


Defines the line style for the axis tick marks. Select a style from the Horizontal Ruler Axis Tick
Mark Style list.

1 - Style = Normal

 The Ruler Axis (SMRulerAxisSymbolContent) content module uses the Horizontal Ruler
Axis Tick Mark Style property.
 To manually edit the .xml file, first define the axis (bottom or top). Then, enclose the style
within the .xml tags as shown in the following example.
<bottom>
<style>Normal</style>
</bottom>
See Also
Horizontal Ruler Axis Position (on page 1315)

ID
Links a label with the corresponding .xml attribute.
Follow these steps to see the ID of a label in the symbol file.
1. Open the label symbol file. The filename is the same as the label .xml template filename, but
it has a .sym file extension.
2. Right-click a label text box, and select Properties.
The Text Box Properties dialog box appears.
3. Click the User tab.

Drawings and Reports Reference Data Guide 1320


Overview of Label Properties

The ID and the ID Value appear as a user attribute.

The value that the system displays in the Text Box Properties dialog box is the value used in
the XML template content. This value appears as the attribute name in the actual template, as
shown in the following illustration. You can specify multiple ID values in the template, as shown
in the example. Each value corresponds to an ID attribute on a separate text box in the symbol
file.

Inside or Along 2D Curve (InsideOrAlongCurve2D)


Places a point along a 2D curve.
The 2D curve must have one or more curves.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>InsideOrAlongCurve2D</pgModule>
<pgModuleSettings>
<locations>
<location id="2" target="0" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
location id

Drawings and Reports Reference Data Guide 1321


Overview of Label Properties

XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Drawings and Reports Reference Data Guide 1322


Overview of Label Properties

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Drawings and Reports Reference Data Guide 1323


Overview of Label Properties

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 2 (Inmost) or 12 (At curve ratio).

Invert Elevation Location


Determines the location of the point that the software places on a straight or turn feature.
 Select Start to place a point at the start of the straight or turn feature.
 Select End to place a point at the end of either the straight feature or the turn feature. This
value is the default value.
 Select Turn to place a point at the turn along the miter line in the turn feature.

 The Trench (CivilElevationPointGenerator) point generator module uses the Invert


Elevation Location property.
 The following options allow you to manually edit the .xml file:
 Type 1 to place the point at the start of the feature.
 Type 2 to place the point at the end of the feature.
 Type 3 to place the point along the turn.
Enclose any of the above values within the following .xml tags.
<location>2</location>

Drawings and Reports Reference Data Guide 1324


Overview of Label Properties

Jog Segment Offset


Allows you to specify the offset from the first leader segment connected to the object to the
next jog segment in the leader line.
Specify the distance in the text box.

Drawings and Reports Reference Data Guide 1325


Overview of Label Properties

1 - Leader offset
2 - Leader length
3 - Jog Segment Offset
4 - Jog Segment Offset 1
5 - Jog Segment Offset 2
6 - Perimeter Offset

 The software interprets the Jog Segment Offset distance that you specify as paper space
units and not as model space units.
 You can use either metric or imperial units for this measurement.
 You must specify a positive decimal paper value for this distance.
 The following leader modules use the Jog Segment Offset property:
 Linear (DrawingLinearLeader)
 Margin (DwgMarginLeaderControl)
 To manually edit the .xml file, enclose the offset value within the following .xml tags.
<jogSegmentOffset>0.005
</jogSegmentOffset>

Drawings and Reports Reference Data Guide 1326


Overview of Label Properties

Jog Segment Offset 1


Allows you to specify the offset from the end of the jog segment offset 1 to the jog segment
offset 2 in a leader line.
Specify the distance in the text box.

1 - Leader offset
2 - Leader length
3 - Jog Segment Offset
4 - Jog Segment Offset 1
5 - Jog Segment Offset 2
6 - Perimeter Offset

Drawings and Reports Reference Data Guide 1327


Overview of Label Properties

 The software interprets the Jog Segment Offset 1 distance that you specify as paper space
units and not as model space units.
 You can use either metric or imperial units for this measurement.
 You must specify a positive decimal paper value for this distance.
 The leader module Margin (DwgMarginLeaderControl) uses the Jog Segment Offset 1
property.
 To manually edit the .xml file, enclose the offset value within the following .xml tags.
<jogSegmentOffset1>0.005
</jogSegmentOffset1>

Jog Segment Offset 2


Allows you to specify the offset from jog offset 1 to the remaining portion of the leader line. The
jog segment to which this property applies connects to the leader line that connects directly to
the label.
Specify the distance in the text box.

Drawings and Reports Reference Data Guide 1328


Overview of Label Properties

1 - Leader offset
2 - Leader length
3 - Jog Segment Offset
4 - Jog Segment Offset 1
5 - Jog Segment Offset 2
6 - Perimeter Offset

Drawings and Reports Reference Data Guide 1329


Overview of Label Properties

 The software interprets the Jog Segment Offset 2 distance that you specify as paper space
units and not as model space units.
 You can use either metric or imperial units for this measurement.
 You must specify a positive decimal paper value for this distance.
 The leader module Margin (DwgMarginLeaderControl) uses the Jog Segment Offset 2
property.
 To manually edit the .xml file, enclose the offset value within the following .xml tags.
<jogSegmentOffset2>0.005
</jogSegmentOffset2>

Justification
Determines whether to align labels inside or outside the available clear space. Select from the
following options.
 Select Label and Text Outside to position the label and align the text outside of the
available clear space.
 Select Label Outside to position the label outside the available clear space.
 Select None to disable the Justification option.
 Select Label Inside to position the label inside the available clear space.
 Select Label and Text Inside to position the label and align the text inside the available
clear space.
The following example demonstrates a label as well as the text positioned inside clear
space.

The next example shows the result when the label and text are positioned outside clear

Drawings and Reports Reference Data Guide 1330


Overview of Label Properties

space.

 The system positions the label and aligns the text outside the available clear space by
default.
 The Justification property is used with the Clear Space Margin with Dimensions
(DwgMatchlineWithDim) positioning module.
 The following options allow you to manually edit the .xml file:
 Type -2 to position the label and align the text outside the available clear space.
 Type -1 to position the label outside the available clear space.
 Type 0 to disable Justification.
 Type 1 to position the label inside the available clear space.
 Type 2 to position the label and align the text inside the available clear space.
 Enclose any of the above values within the following .xml tags.
<justification>-2</justification>

Drawings and Reports Reference Data Guide 1331


Overview of Label Properties

Keep Duplicate Labels


Specifies the points to label when more than one point is aligned horizontally or vertically.
 Select Keep Duplicate Labels to label all aligned points.

1 – First label
2 – First horizontally aligned point
3 – Equipment object
4 – Second horizontally aligned point
5 – Second label

 Clear Keep Duplicate Labels to place the label only on the point closest to the matchline.

1 – Label
2 – Point closest to the matchline
3 – Equipment object

Drawings and Reports Reference Data Guide 1332


Overview of Label Properties

 The geometric analyzer module Object Axis (DrawingGAEquipmentStyle2) uses the Keep
Duplicate Labels property.
 The following options allow you to manually edit the .xml file:
 Type -1 to place a label on the closest point.
 Type 0 to place a label on both points.
 Enclose either of the above values within the following .xml tags.
<deDuplicateLables>-1
</deDuplicateLables>

Keep Label by Location


Specifies the label that the software keeps on overlapping objects. This property is specified
for overlapping and non-overlapping labels. Select one of the following options:

XML
value

Keep default 0

Keep near side 1

Keep far side 2

Keep both sides 3

Drawings and Reports Reference Data Guide 1333


Overview of Label Properties

Keep none 4

 The Eliminate Overlapping Labels (ISGAEliminateOverlappingLabels) geometric analyzer


uses the Keep Label by Location property.
 To manually edit the .xml file, specify whether the geometry is overlapping or
non-overlapping. Then enclose any of the above .xml values within the appropriate .xml
tags, as follows.
<overlapping>
<keeplabelByLocation>3
</keeplabelByLocation>
</overlapping>
—OR—
<nonoverlapping>
<keepLabelByLocation>3
</keepLabelByLocation>
<nonoverlapping>

Keep Left or Right Duplicate


Allows you to place a label on either the leftmost or rightmost object in a group of objects
aligned at identical Y positions along a horizontal axis.
 Select Left to label the leftmost point.

1 - East coordinate label


2 - North coordinate label
3 - Equipment object

 Select Right to label the rightmost point.

Drawings and Reports Reference Data Guide 1334


Overview of Label Properties

1 - East coordinate label


2 - North coordinate label
3 - Equipment object

In either case, the software then uses the geometric analyzer module Aligned Objects
(DrawingGALabelInline) to label only the selected point.

 The following options allow you to manually edit the .xml file:
 Type 0 to label only the leftmost point.
 Type -1 to label only the rightmost point.
 Enclose either of the above values within the following .xml tags.
<keepLeftOrRightDup>0
</keepLeftOrRightDup>

Keep Top or Bottom Duplicate


Allows you to place a label on either the topmost or bottommost object in a group of objects
aligned at identical X positions along a vertical axis.
 Select Top to label the topmost point.

Drawings and Reports Reference Data Guide 1335


Overview of Label Properties

1 - Equipment object
2 -Labeled East coordinate
point
3 - North coordinate point

 Select Bottom to label the bottommost point.

Drawings and Reports Reference Data Guide 1336


Overview of Label Properties

1 - Equipment object
2 - Labeled East coordinate
point
3 - North coordinate point

In either case, the software then uses the geometric analyzer module Aligned Objects
(DrawingGALabelInline) to label only the selected point.

 The following options allow you to manually edit the .xml file:
 Type 0 to label only the topmost point.
 Type -1 to label only the bottommost point.
 Enclose either of the above values within the following .xml tags.
<keepTopOrBottomDup>0
</keepTopOrBottomDup>

Drawings and Reports Reference Data Guide 1337


Overview of Label Properties

Key Point (DefaultLabelPointGenerator)


Generates a point in the middle of the 2D range of an object. Used for name labels on
equipment and other non-linear objects.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>DefaultLabelPointGenerator</pgModule>
</pointGeneratorSettings>

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Knuckle Angle Symbol


(ISKnuckleAngleSymbolContent)
Creates a symbol containing the knuckle angle value obtained from the embedded report.

Knuckle angle symbol

Usage in Label Template XML


<label>
<content>
<contentModule value="ISKnuckleAngleSymbolContent"/>
<ID attributeName="Scantling Knuckle Surface Angle">
Scantling Knuckle Surface Angle.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Drawings and Reports Reference Data Guide 1338


Overview of Label Properties

Label Layer (labelLayer)


Allows you to specify the 2D layer on which the software automatically places labels. You can
select any layer on which to place the template. The system places all labels that use this
template on this layer.
Type the name in the text box of the layer on which you want the label to reside.
You can also name a new layer on which to place the template. If the specified layer does not
yet exist, the software automatically creates the layer.
The following illustration shows an equipment object with a label placed on the layer
specified in the text box.

1 - Equipment object
2 - Label
3 - Text Box Properties dialog box specifying the
layer on which the label resides

 The Default (DefaultLabelControlGenerator) (on page 1265) annotation control generator


uses the Label Layer property.
 Use the following .xml tags to manually edit the values for Label Layer.
<labelLayer>MATCHLINE_LABELS
</labelLayer>

Drawings and Reports Reference Data Guide 1339


Overview of Label Properties

 MATCHLINE_LABELS can be any name that you want, including an existing layer. If you
enter a new layer name, the software automatically creates that layer.

Label Offset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.

 The software interprets the Label Offset distance that you specify as paper space units and
not as model space units.
 You must specify the distance as a non-negative paper value.
 The following positioning modules use the Label Offset property:
 Clear Space Center Then Above (DrawingCenterThenAbove)
 Clear Space Center Then Above Centerline (DrawingCenterThenAboveCL)
 Clear Space Radial from Object Center with Clustering (DrawingCentroid)
 Clear Space Coordinate (DrawingCoordLblPosMod)
 Clear Space Quadrant 1 (DrawingQuadOne)
 Clear Space Quadrant 2 (DrawingQuadTwo)

Drawings and Reports Reference Data Guide 1340


Overview of Label Properties

 Clear Space Quadrant 3 (DrawingQuadThree)


 Clear Space Quadrant 4 (DrawingQuadFour)
 Clear Space Along Linear Object (DwgLinearPositioning)
 To manually edit the .xml file, enclose the offset distance for the label within the following
.xml tags.
<labelOffset>0.04</labelOffset>

Label Offset from Member or Widget


Specifies the perpendicular distance to offset the label away from a linear object, such as a
structural member. A positive value places the label above or left of the centerline, while a
negative value places the label below or right of the centerline.
Type the distance that you want the label offset.
The following graphic demonstrates the Label Offset from Member or Widget property with an
offset distance from the structural member of 0.01 m specified.

The following graphic demonstrates the Label Offset from Member or Widget property with an
offset distance from the structural member of 0.003 m specified.

Drawings and Reports Reference Data Guide 1341


Overview of Label Properties

 The Absolute Along Linear Object (DwgLinearAbsPos) positioning module uses the Label
Offset from Member or Widget property.
 You can specify any decimal paper value.
 You can use either metric or imperial units for this measurement.
 The software interprets the Label Offset from Member or Widget distance that you specify
as paper space units and not as model space units.
 To manually edit the .xml file, enclose the offset distance for the label within the following
.xml tags.
<offsetFromMember>0.01</offsetFromMember>

Label Orientation
Orientation of the label.

XML value

Tangent 0
Tangent to a
curve

Normal Out 1
Along
outward
normal

Drawings and Reports Reference Data Guide 1342


Overview of Label Properties

Normal In 2
Along
inward
normal

Horizontal 3

Vertical 4

Default 5
Orientation

Uses the orientation from the content module

 The following positioning modules use the Label Orientation property.


 Absolute Position by 2D Curve (ISDwgAbsolutePositionByCurve2D)
 Clear Space Position by 2D Curve (ISDwgPositionByCurve2D)
 Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin)
 To manually edit the .xml file, enclose any of the above values within the following .xml tags.
<angle>0</angle>

Drawings and Reports Reference Data Guide 1343


Overview of Label Properties

Label Symbol File


Controls the appearance of symbol graphics to be placed as a label. You can edit this file to
add, remove, or modify the existing graphics and symbol origin location. Graphics can include
lines, arcs, circles, text boxes, fills, and so forth. The symbol origin serves as the handle that the
automatic labeling engine uses to place the label.

Modify the symbol file


1. Click Launch SmartSketch .
SmartSketch Drawing Editor launches.
2. Within SmartSketch Drawing Editor, add, remove, or modify graphics and symbol origin for
your label.
3. Save your changes and exit SmartSketch Drawing Editor.

 Label symbol files contain graphics, and unlike many symbol files, are not associated with
database queries.
 If you open a symbol file, save your changes and exit SmartSketch Drawing Editor before
continuing work in the Matchline Rule Manager, the Label Rule Manager, or the North
Arrow Rule Manager. For more information, see Matchline Rule Manager (on page 1606),
Label Rule Manager (on page 1099), and North Arrow Rule Manager (on page 1633).

Drawings and Reports Reference Data Guide 1344


Overview of Label Properties

Label Type
Specifies whether the label is a Nozzle, Top of Equipment/Bottom of Equipment, or Angle
label.

1 - Nozzle
2 - Top of Equipment/Bottom of Equipment
3 - Angle

Select the value that you want to apply to the label from a list.
 Select Nozzle to label the nozzle. The system displays the label along the vector of the
nozzle orientation angle. When more than one nozzle lies along the same orientation angle,
the software groups the labels along one leader line.

Drawings and Reports Reference Data Guide 1345


Overview of Label Properties

 Select Top of Equipment/Bottom of Equipment to label the top or the bottom of the
equipment. The software references the report template file specification (Report Template)
to determine whether the label displays to the top (TOP) or bottom (BTM) of the equipment.
By default, the system displays TOP for report template Nozzle Orientation
Plan_Nozzle_TOP_Name.rtp. Likewise, by default, the system displays BTM for report
template Nozzle Orientation Plan_Nozzle_BTM_Name.rtp. The software places both the
TOP and BTM labels alongside the Nozzle label.
 Select Angle to label the angle of the nozzle on the equipment. The software determines
the angle label position based on the Global Coordinate System.

 The positioning module Clear Space Radial from Object Center with Clustering
(DrawingCentroid) uses the Label Type property.
 The following options allow you to manually edit the .xml file:
 Type 0 to place a Nozzle label.
 Type 1 to place a TOP or BTM label.
 Type 2 to place an Angle label.
 Enclose any of the above values within the following .xml tags.
<labelType>0</labelType>

Leader Length
Sets the distance from the matchline to the first jog in the leader line of a label when the leader
line contains multiple segments. This property can be applied only if the leader line uses a
breakline.
To set the Leader Length, specify the distance in the text box.
The following two examples demonstrate the Leader Length property applied according to
different specified distances from the matchline to the first jog in the respective leader lines.

1 - Matchline
2 - 0.03 m Leader Length
3 - Leader line

Drawings and Reports Reference Data Guide 1346


Overview of Label Properties

1 - Matchline
2 - 0.05 m Leader Length
3 - Leader line

 The leader module Margin (DwgMarginLeaderControl) uses the Leader Length property.
 You must specify the distance as a positive paper value.
 You can use either metric or imperial units for this measurement.
 To manually edit the .xml file, type the distance that you want the leader to extend from the
matchline to the first jog in the leader line. Enclose this value within the following xml tags.
<leaderLength>0.05</leaderLength>

Drawings and Reports Reference Data Guide 1347


Overview of Label Properties

Leader Offset
Specifies the distance outside of the matchline at which you want the leader line to terminate.
For example, if you specify that the leader offset is 4 cm, then the end of the leader line closest
to the matchline will terminate exactly 4 cm before reaching the matchline.

1 - 0.04 m leader offset

Drawings and Reports Reference Data Guide 1348


Overview of Label Properties

1 -0.055 m leader offset

 You must specify the distance as a non-negative paper value.


 You can use either metric or imperial units for this measurement.
 The Margin (DwgMarginLeaderControl) leader module uses the Leader Offset property.
 To manually edit the .xml file, enclose the offset measurement within the following .xml tags.
<leaderOffset>0.0</leaderOffset>

Drawings and Reports Reference Data Guide 1349


Overview of Label Properties

Leaders as Clear Space


Renders the leader line of a label as invisible to other annotations.
 Select True when objects are close together in the view and clear space is lacking. The
software considers the leader line to be clear space. As a result, you can place other
annotation objects, including labels, leader lines, or dimensions, on top of the leader line as
shown in the following illustration. Conversely, you can also place the leader line on top of
annotation objects.

 Select False to render the leader line as visible to other annotations. The software then
attempts to place the leader lines in clear space.

Drawings and Reports Reference Data Guide 1350


Overview of Label Properties

 The following leader modules use the Leaders as Clear Space property:
 Default (DwgLeaderControl)
 Margin (DwgMarginLeaderControl)
 The following options allow you to manually edit the .xml file:
 Type -1 to allow leader lines and other annotations to intersect.
 Type 0 to prevent leader line and annotation intersection.
 Enclose either of the above values within the following .xml tags.
<ignoreLeaderCrossings>-1</ignoreLeaderCrossings>
If you cannot find the ignoreLeaderCrossings tag in your .xml template
file, you must add the tag to the leaderSettings section.

Drawings and Reports Reference Data Guide 1351


Overview of Label Properties

Linear (DrawingLinearLeader)
Places a leader with 3 segments used with grid lines and other linear objects. The style tag
determines which dimension style to use from styles.sha, while the breakline tag determines
whether or not to place a jog in the leader. A value of -1 is true and places a jog in the leader,
while a value of 0 does not place a jog. The jogSegmentOffset value is the linear offset of the
middle of the leader. The jogLength value is the length of the leader segment connected to the
label.

Usage in Label Template XML


<label>
<leaderSettings>
<leaderModule>DrawingLinearLeader</leaderModule>
<style>ANSI_NOARROW</style>
<breakline>0</breakline>
<jogSegmentOffset>0.005</jogSegmentOffset>
<jogLength>0.005</jogLength>
</leaderSettings>
</label>

Customization
style
Defines the appearance of a leader line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

Drawings and Reports Reference Data Guide 1352


Overview of Label Properties

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.
Type -1 to place a leader jog.

Drawings and Reports Reference Data Guide 1353


Overview of Label Properties

Type 0 to omit the jog.

You cannot place breaklines with acute leader jog angles when automatically
generating labels. However, you can manually place breaklines with acute leader jog angles
within SmartSketch by updating the view, then selecting a leader and clicking BreakLine .

Drawings and Reports Reference Data Guide 1354


Overview of Label Properties

jogSegmentOffset
Allows you to specify the offset from the first leader segment connected to the object to the
next jog segment in the leader line.

1 - Leader offset
2 - Leader length
3 - Jog Segment Offset
4 - Jog Segment Offset 1
5 - Jog Segment Offset 2
6 - Perimeter Offset

Drawings and Reports Reference Data Guide 1355


Overview of Label Properties

jogLength
Type -1 to place a jog. Type 0 to suppress the jog.

Linear Endpoints (DrawingGAByOppositePoints)


Groups points that are generated by a linear point generator together based on the original
object that produced them.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGAByOppositePoints</gaModule>
</geometricAnalyzerSettings>

Customization
None

Drawings and Reports Reference Data Guide 1356


Overview of Label Properties

Linear Object Endpoints (DrawingPGLinear)


Generates a label at both ends of a pipe segment, structure member, or grid line.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGLinear</pgModule>
</pointGeneratorSettings>

Customization
None

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Linear Pipe Endpoints (DrawingPGPipeSegments)


This module has been replaced by the DrawingPGLinear module. For more information, see
Linear Object Endpoints (DrawingPGLinear) (on page 1357).

Drawings and Reports Reference Data Guide 1357


Overview of Label Properties

Line Style
Allows you to specify the style of the line connecting horizontally or vertically aligned pieces
of equipment. Define this property when you have labeled equipment inside a plant with
coordinate labels.
In the following graphic, the Line Style has been defined with the Dash Dot Red style.

1 - Dash Dot Red Line Style


2 - North coordinate label

You must define line styles manually within the templates delivered in [Product
Folder]\SharedContent\Drawings\Catalog\Templates\Styles.sha. You can select any one linear
style from the styles.sha document. If the Line Style that you want has not been defined in the
.sha file, then the software defaults to a solid black line style.
You must use a geometric analyzer module when setting this property. The following geometric
analyzer modules use the Line Style property:
 Object Axis (DrawingGAEquipmentStyle2)
 Aligned Objects (DrawingGALabelInline)

Drawings and Reports Reference Data Guide 1358


Overview of Label Properties

When you place lines using the Line Style property, you must select True for
the Place Lines property. If you select False for the Place Lines property, then the software
ignores the defined Line Style. For more information, see Place Lines (placeLines) (on page
1426).
To manually edit the .xml file, specify the style that you want applied to the leader
line. Enclose this value within the following .xml tags.
<lineStyle>ANSI</lineStyle>

Local Coordinate System Origin (DrawingPGLocalCS)


Places a point for labeling or dimensioning on an object's coordinate system origin.

1 - Label
2 - Point for labeling

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGLocalCS</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1359


Overview of Label Properties

Local CS Origin with Object Axis


(DrawingPGEquipmentStyle2)
Places a label point at the local coordinate system position of an object, typically equipment.
This point generator is used with the geometric analyzer Object Axis
(DrawingGAEquipmentStyle2) (on page 1401), the content module Object Coordinates
(DrawingEquipmentStyle2Content) (on page 1825), and the positioning module
DwgMatchlineWithDim (see "Clear Space Margin with Dimensions (DwgMatchlineWithDim)" on
page 1191).

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule value="DrawingPGEquipmentStyle2">
<orientation>1</orientation>
<pgmodule>
</pointGeneratorSettings>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Drawings and Reports Reference Data Guide 1360


Overview of Label Properties

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

Drawings and Reports Reference Data Guide 1361


Overview of Label Properties

Location Curve Ratio


Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

 The Curve Ratio property is used with the following modules.


 Scantling Weld Symbol (DwgScantlingWeld) content module when you set the location
id to 12 (at curve ratio).
 Weld Point (DrawingPGWelds), Points Along 2D Curve (ISDwgPointsAlongCurve2D), or
Point at Corner Cut (MHDrawingPGCornerCut) point generator modules when you set
the location id to 12 (at curve ratio).
 Inside or Along 2D Curve (InsideOrAlongCurve2D) point generator module when you
set the location id to 2 (inmost) or 12 (at curve ratio).
 To manually edit the .xml file, you must first specify the locations tag. Then, specify the
curveRatio as an attribute within the following .xml tag.
<locations>
<location curveRatio="0.25" .../>
</locations>

Location ID
XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Drawings and Reports Reference Data Guide 1362


Overview of Label Properties

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Drawings and Reports Reference Data Guide 1363


Overview of Label Properties

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

The possible values for Location ID when using the Profile Weld Point point
generator are limited to Top, Bottom, or Middle.

 The following point generators use the Location ID property:


 Weld Point (DrawingPGWelds)
 Profile Weld Points (SMDwgProfileWeldsPG)
 Inside or Along 2D Curve (InsideOrAlongCurve2D)
 Points Along 2D Curve (ISDwgPointsAlongCurve 2D)
 Point at Corner Cut (MHDrawingPGCornerCut)
 To manually edit the .xml file, you must first specify the locations tag. Then, specify the
location id. Enclose the attribute within the following .xml tag.
<locations>
<location id="12" .../>
</locations>

Location Target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Drawings and Reports Reference Data Guide 1364


Overview of Label Properties

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

 The following point generators use this property:


 Weld Point (DrawingPGWelds)
 Inside or Along 2D Curve (InsideOrAlongCurve2D)
 Points Along 2D Curve (ISDwgPointsAlongCurve2D)
 Point at Corner Cut (MHDrawingPGCornerCut)
 To manually edit the .xml file, you must first specify the locations tag. Then, specify the
location target. Enclose the attribute within the following .xml tag.
<locations>
<location target="0" .../>
</locations>

Location Target Name


Specifies a name for the target curve. The name is an attribute on an object in the drawing view.

 The following point generators use the Location Target Name property:
 Points Along 2D Curve (ISDwgPointsAlongCurve2D). The valid name is
TemplateMidLine. Specifying a target name does not specify the target.
 Profile Weld Points (SMDwgProfileWeldsPG). Valid names are Profile_Web and
Profile_Flange.
 Points by Associated Object ID (SMPointsByAssociateObjectID). Valid names are
PlateContour and TemplateBtmCrv.
 To manually edit the .xml file, you must first specify the locations tag. Then, specify the
target name. Enclose this attribute within the following .xml tag.
<locations>
<location
targetName="TemplateBtmCrv"/>
</locations>

Drawings and Reports Reference Data Guide 1365


Overview of Label Properties

Longest Segment (DrawingGALongestSegment)


Places a label on the longest segment of a linear object.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGALongestSegment</gaModule>
<allowNonOrthogonalDirections>-1</allowNonOrthogonalDirections>
<equivalenceLabel>"Piping
Plan_FlowArrow_LongestSegment.rtp"</equivalenceLabel>
</geometricAnalyzerSettings>

Customization
allowNonOrthogonalDirections
Allows you to specify that the software places a label on objects that are non-orthogonal,
that is, neither horizontal nor vertical on the drawing sheet.
Type -1 to place the label.

1 - Non-orthogonal pipe with label

Drawings and Reports Reference Data Guide 1366


Overview of Label Properties

Type 0 to suppress the label.

1 - Unlabeled non-orthogonal pipe

equivalenceLabel
Eliminates duplicate labels on pipelines with multiple segments.
When the Equivalence Label property is used with the End of Segment geometric analyzer
and the pipeline is clipped, the software places a label at each end of the pipe segment.
Conversely, when the Equivalence Label property is used with the Longest Segment
geometric analyzer and the pipeline is clipped, a label is placed at the end of the longest line
segment.

Drawings and Reports Reference Data Guide 1367


Overview of Label Properties

Example
The longest segment of pipe is labeled.

Although a content module creates the annotation output, this example shows how
this module affects the output.
See Also
Edit a label rule to allow non-orthogonal label directions (on page 1810)
Edit a label rule to use the Equivalence Label (on page 1799)

Drawings and Reports Reference Data Guide 1368


Overview of Label Properties

Manufacturing Margin Symbol


(ISMfgMarginSymbolContent)
Creates a symbol containing the plate margin value obtained from the embedded report.

Manufacturing margin symbol

Usage in Label Template XML


<label>
<content>
<contentModule value="ISMfgMarginSymbolContent"/>
<ID attributeName="MfgMarginValue">MfgMarginValue.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Manufacturing Pin Height Label


(SMDwgMfgPinHeightLabelContent)
Creates labels containing the pin height obtained from the embedded report.

Usage in Label Template XML

<label>
<content>
<contentModule value="SMDwgMfgPinHeightLabelContent">
<eliminateHeight>0</eliminateHeight>
</contentModule>
<ID attributeName="PinHeight">StrMfg PinJig PinHeight.rtp</ID>
</content>
</label>

Customization
eliminateHeight

Drawings and Reports Reference Data Guide 1369


Overview of Label Properties

Eliminates labels with a value less than or equal to the specified pin height value, in
millimeters.
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Manufacturing Profile Margin Symbol


(SMDwgMfgProfileMarginSymContent)
Creates a symbol containing the manufacturing profile margin obtained from the embedded
report.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgMfgProfileMarginSymContent"/>
<ID attributeName="MfgProfileMarginValue">
MfgProfileMarginValue.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Drawings and Reports Reference Data Guide 1370


Overview of Label Properties

Manufacturing Sketch (MfgSketchContent)


Creates symbols from manufacturing XML data created in the Structural Manufacturing task.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDGenericContentInterOp"/>
<Assembly value="MfgSketchContent" />
<symbol representation="" scale="0.001">
<labels>
<label name="ANGLE_A">
<file>
<![CDATA[ StrMfg Sketch Bevel Symbol_Angle
Label ]]>
</file>
<value type="xpath">
<![CDATA[
descendant-or-self::SMS_BEVEL/@ANGLE_A ]]>
</value>
</label>
</labels>
<parameters>
<parameter name="ANGLE_A">
<value type="xpath">
<![CDATA[
descendant-or-self::SMS_BEVEL/@ANGLE_A ]]>
</value>
</parameter>
</parameters>
</symbols>
</content>
</label>

Customization
Assembly value
Specifies the name of the content module to use.
SMDGenericContentInterOp is a wrapper content module that must be used with
.NET content modules.

Drawings and Reports Reference Data Guide 1371


Overview of Label Properties

Margin (DwgMarginLeaderControl)
Places a multi-segment leader that you can use with grid lines and other linear objects. For
labels that are located outside of the view, the software places the leader between the matchline
and the jog segment.

1 - Leader offset
2 - Leader length
3 - Jog segment offset
4 - Jog segment offset 1
5 - Jog segment offset 2
6 - Perimeter offset

Smart 3D only uses the Jog Segment Offset 1 and Jog Segment Offset 2
properties with the Clear Space Margin with Dimensions positioning module. For all other
positioning modules, Margin produces a leader line that looks like the example below.

1 - Leader offset
2 - Leader length
3 - Jog segment offset
4 - Perimeter offset

Drawings and Reports Reference Data Guide 1372


Overview of Label Properties

Usage in Label Template XML


<label>
<leaderSettings>
<leaderModule>DwgMarginLeaderControl</leaderModule>
<ignoreLeaderCrossings>-1</ignoreLeaderCrossings>
<disableAutoDelete>-1</disableAutoDelete>
<leaderOffset>0.002</leaderOffset>
<leaderLength>0.005</leaderLength>
<style>ANSI_NOARROW</style>
<jogSegmentOffset>0.015</jogSegmentOffset>
<jogSegmentOffset1>0.015</jogSegmentOffset1>
<jogSegmentOffset2>0.005<jogSegmentOffset2>
</leaderSettings>
</label>

Customization
ignoreLeaderCrossings
Renders the leader line of a label as invisible to other annotations.
Type -1 to allow leader lines and other annotations to intersect.

Drawings and Reports Reference Data Guide 1373


Overview of Label Properties

Type 0 to render the leader line visible to other annotations.

disableAutoDelete
Controls the visibility of the leader line of a label when the distance from the label to the
corresponding connect point is less than half the label height.
Type -1 to retain the leader line.

1 - Label with leader line

Drawings and Reports Reference Data Guide 1374


Overview of Label Properties

Type 0 to turn off the leader line.

1 - Label with no leader line

leaderOffset
Specifies the distance outside of the matchline at which you want the leader line to
terminate. If this value is zero, the leader line connects to the object.
The following example shows a leaderOffset of 0.001.

1 - Leader offset = 0.001

In the next example, the leaderOffset is set to zero.

1 - Leader offset = 0.0

Drawings and Reports Reference Data Guide 1375


Overview of Label Properties

leaderLength
Sets the distance from the matchline to the first jog in the leader line of a label when the
leader line contains multiple segments. This property can be applied only if the leader line
uses a breakline.

1 - Matchline
2 - 0.03 m Leader Length
3 - Leader line

1 - Matchline
2 - 0.05 m Leader Length
3 - Leader line

style
Defines the appearance of a leader line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

Drawings and Reports Reference Data Guide 1376


Overview of Label Properties

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

jogSegmentOffset
Allows you to specify the offset from the first leader segment connected to the object to the
next jog segment in the leader line.
jogSegmentOffset1
Allows you to specify the offset from the end of the jog segment offset 1 to the jog segment
offset 2 in a leader line.
jogSegmentOffset2
Allows you to specify the offset from jog offset 1 to the remaining portion of the leader line.
The jog segment to which this property applies connects to the leader line that connects
directly to the label.

Drawings and Reports Reference Data Guide 1377


Overview of Label Properties

Examples
In the following example, leaderOffset is not enabled.

Drawings and Reports Reference Data Guide 1378


Overview of Label Properties

In the following example, leaderOffset is enabled with the default value.

Drawings and Reports Reference Data Guide 1379


Overview of Label Properties

Margin Definition
Specifies the relationship of the grid axes to the drawing view for measuring the margin
offset of the axes.

XML
value

At View Frame 0
(default value)
Measures the margin
offset for each axis from
the edges of the view
SmartFrame, shown as
dashed lines in the
example.

At Drawing Area 1
Measures the margin
offset for each axis from
the edges of the drawing
area, shown as solid lines
in the example.

If you set the frame behavior to Frame resizes to drawing area, then the view frame and
the drawing area are the same size, and both values provide the same result, as shown in
the following example.

For more information, see Area Tab (Edit Ruleset View Style Dialog Box) (on page 130) in
the Drawings and Reports Reference Data Guide.

Drawings and Reports Reference Data Guide 1380


Overview of Label Properties

 The following modules use the Ruler Axis Margin Definition property.
 Ruler Axis (SMRulerAxisSymbolContent) content module. To manually edit the .xml file
when using this content module, enclose either of the above .xml values within the
following .xml tags.
<axisInfo>
<marginDefinition>1
</marginDefinition>
</axisInfo>
 Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin)
positioning module. To manually edit the .xml when using this positioning module,
enclose either of the above values within the following .xml tags.
<posModule="ISDwgPositionByCurve2DAtMargin">
<marginDefinition>1
</marginDefinition>
<posModule>

Materials Handling Absolute


(MHDrawingAbsoluteLeader)
Aligns the label and leader line to only one opening or slot for all identically sized openings or
slots. The system displays only one label for each set of openings when you use this module.

Usage in Label Template XML


<leadersettings>
<leaderModule>MHDrawingAbsolusteLeader</leaderModule>
<breakline>-1</breakline>
<style>ANSI</style>
</leadersettings>
Customization
breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.

Drawings and Reports Reference Data Guide 1381


Overview of Label Properties

Type -1 to display the leader jog.

Type 0 to omit the jog.

style
Defines the appearance of a leader line. Specify any of the following styles:
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

Drawings and Reports Reference Data Guide 1382


Overview of Label Properties

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Drawings and Reports Reference Data Guide 1383


Overview of Label Properties

Maximum Offset
Defines the maximum distance from a connection point that you can place a label.

The Maximum Offset property performs different actions depending on the positioning module
that you use. You must specify a non-negative paper value.
The following positioning modules use this property:
 Clear Space Radial (DrawingRadial)
 Clear Space Grid Horizontal (DrawingGridLblHoriz)
 Clear Space Grid Vertical (DrawingGridLblVert)
 Clear Space Grid Margin (DrawingGridLblMarginOnly)
 Clear Space End of Linear Object (DwgLblEndOfSegmentPos)
 Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin)
 Clear Space Position Marine Grid Label at Margin (SMDwgPositionGridLblMarginOnly)
The following sections explain how to use the above positioning modules with the Maximum
Offset property.
 Clear Space Radial (Drawing Radial)
When you place labels using radial positioning, use Maximum Offset to specify the
maximum radial distance from the connection point to the center of the label.

1 - Maximum Offset

Drawings and Reports Reference Data Guide 1384


Overview of Label Properties

 Clear Space Grid Horizontal (DrawingGridLblHoriz)


 Clear Space Grid Vertical (DrawingGridLblVert)
If you place the label within the view, use Maximum Offset with the above modules to place
grid labels.
The following graphic illustrates a grid label placed within the view when the Maximum
Offset has been specified using the gridline positioning modules. Because an equipment
object blocks the end of the labeled gridline, the software has moved the label up to find
clear space.

1 - Maximum Offset in X direction


2 - Maximum Offset in Y direction
3 - Minimum Offset

 Clear Space Grid Margin (DrawingGridLblMarginOnly)

Drawings and Reports Reference Data Guide 1385


Overview of Label Properties

1 – Maximum Offset
2 – Perimeter Offset

 Clear Space End of Linear Object (DwgLblEndOfSegmentPos)


Using this module, the software attempts to place the label in line with a straight feature,
such as a pipe, a cable, or an HVAC duct. The software begins at the Minimum Offset
distance from the terminating end of the feature and then continues out, alternating between
either end of the feature. In this way, the module looks for clear space within which to place
the label. The software continues on until reaching the specified Maximum Offset distance.
If no clear space is found in line with the feature, then the module returns to the specified
Minimum Offset distance from the end of the feature. The module then steps out
perpendicularly until reaching the specified Maximum Offset distance, still alternating
between either end of the feature. For more information about Minimum Offset, see
Minimum Offset (on page 1393).
The following graphic demonstrates the method used by the Clear Space End of Linear
Object (DwgLblEndofSegmentPos) module to find clear space in which to place the label.

Drawings and Reports Reference Data Guide 1386


Overview of Label Properties

1 - Minimum Offset
2 - Maximum Offset in the X direction
3 - Maximum Offset in the Y direction

 The software interprets the Maximum Offset distance that you specify as paper space units
and not as model space units.
 You must specify the distance as a non-negative paper value.
 The Maximum Offset value that you specify must be greater than or equal to the Minimum
Offset value, if a Minimum Offset value is specified. For more information, see Minimum
Offset (on page 1393).
 To manually edit the .xml file, enclose the maximum offset factor within the following .xml
tags.
<maxOffset>0.05</maxOffset>

Drawings and Reports Reference Data Guide 1387


Overview of Label Properties

Maximum Offset for Grouping


Specifies the maximum distance between consecutive endpoints of linear objects.
The system uses the specified distance for grouping label points together, grouping points
that consecutively fall within the specified maximum offset into a particular set. The software
then creates one label per set. Conversely, the system creates a separate label for each
point that lies at a greater distance from the closest linear points than the specified
Maximum Offset for Grouping value.
The distance that you specify must take into account inline features, such as pipe valves.
Therefore, the specified value must be high enough that the system does not create labels
on both sides of each inline feature.
The default distance is 0.1 m.

 Specify 0 or a positive decimal value for this distance.


 In contrast to the majority of properties, the software interprets the distance that you
specify as model space units and not as paper space units.

 The End of Segment (DrawingGAEndOfSegment) geometric analyzer module uses the
Maximum Offset for Grouping property.
 To manually edit the .xml file, enclose the maximum offset distance between the following
.xml tags.
<maxOffsetForGrouping>0.1
</maxOffsetForGrouping>
To edit the Maximum Offset for Grouping property in the Label Rule Manager, type the
distance in the text box.

Maximum Pin Height for Deletion


Eliminates labels with a value less than or equal to the specified pin height value, in
millimeters.

 The Manufacturing Pin Height Label (SMDwgMfgPinHeightLabelContent) content module


uses the Maximum Pin Height for Deletion property.
 To manually edit the .xml file, enclose the specified pin height within the following .xml tags.
<eliminateHeight>0</eliminateHeight>

Drawings and Reports Reference Data Guide 1388


Overview of Label Properties

MfgSketchNameFeaturesGA
Gathers clusters of points for both horizontal and vertical dimensioning.

Usage in Label Template XML


<label>
<geometricAnalyzerSettings>
<gaModule>GenericGeometricAnalyzerInterop</gaModule>
<gaModuleSettings>
<Assembly value="MfgSketchNameFeaturesGA" />
</gaModuleSettings>
</geometricAnalyzerSettings>
</label>

Customization
Assembly value
Specifies the name of the geometric analyzer to use.

 GenericGeometricAnalyzerInterop is a wrapper geometric analyzer that must be used with


.NET geometric analyzers.
 The annotation output is created by a content module, not this module.

MidPoint (ISMidPointLabelPG)
Places a label point on the 2D curves representing a 3D object at the center of the range box of
the object.

Usage in Dimension or Label Template XML


<pointGeneratorSettings>
<pgModule>ISMidPointLabelPG</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1389


Overview of Label Properties

Minimum Diameter
Specifies the minimum diameter of a routed object at which the system may place a flow
arrow.
The cross-sectional diameter of the routed object must be equal to or greater than the
specified diameter in order for the software to place a flow arrow on the object.

Examples
 The following image shows a pipe with a diameter of 0.508 m. The specified Minimum
Diameter is 0.0 m. The diameter of the pipe is greater than the Minimum Diameter.
Therefore, the system places a flow arrow on the pipe.

1 - 0.0 m diameter
pipe
2 - Flow arrow

 The following image shows a pipe with a diameter of 0.508 m. The specified Minimum
Diameter is 0.1 m. The diameter of the pipe is less than the specified Minimum Diameter.
Therefore, the software suppresses the flow arrow.

Drawings and Reports Reference Data Guide 1390


Overview of Label Properties

1 - 0.508 m pipe

No minDiameter value. The software draws flow arrows for all pipe sizes

Drawings and Reports Reference Data Guide 1391


Overview of Label Properties

No minDiameter value; resymbolized pipe

minDiameter = 0.2; the software does not draw flow arrows for pipes
below 200 mm diameter

minDiameter = 0.2; resymbolized pipe

Drawings and Reports Reference Data Guide 1392


Overview of Label Properties

 The content module Flow Direction (DrawingFlowDirectionContent) uses the Minimum


Diameter property.
 In contrast to the majority of properties, the software interprets the Minimum Diameter
distance that you specify as model space units and not paper space units.
 You must specify a non-negative model value for this diameter.
 You can use either metric or imperial units for this measurement.
 To manually edit the .xml, specify the minimum diameter at which a flow arrow must be
placed. Enclose this value within the following .xml tags.
<minDiameter>0.02</minDiameter>

Minimum Offset
Defines the minimum distance from a connection point that you can place a label.
The Minimum Offset property performs different actions depending on the positioning module
that you use. You must specify a non-negative paper value.
The following positioning modules use the Minimum Offset property:
 Clear Space Radial (DrawingRadial)
 Clear Space Grid Horizontal (DrawingGridLblHoriz)
 Clear Space Grid Vertical (DrawingGridLblVert)
 Clear Space End of Linear Object (DwgLblEndOfSegmentPos)
 Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin)
 Clear Space Position Marine Grid Label at Margin (SMDwgPositionGridLblMarginOnly)
 Clear Space Radial (DrawingRadial)
When you place labels using radial positioning, use Minimum Offset to specify the minimum
radial distance from the connection point to the center of the label.
The following image depicts the Minimum and Maximum Offsets when used with the Clear
Space Radial (DrawingRadial) positioning module. Each point represents a possible label
placement.

Drawings and Reports Reference Data Guide 1393


Overview of Label Properties

1 - Minimum Offset

 Clear Space Grid Horizontal (DrawingGridLblHoriz)


 Clear Space Grid Vertical (DrawingGridLblVert)
If you place the label within the view, use Minimum Offset with the above modules to place
grid labels.
The following graphic illustrates a grid label placed within the view when the Minimum
Offset has been specified using the gridline positioning modules. Because an equipment
object blocks the end of the labeled gridline, the software has moved the label up to find
clear space using the Maximum Offset. The lower grid label is not blocked and is placed
using the Minimum Offset. For more information about Maximum Offset, see Maximum
Offset (on page 1384).

Drawings and Reports Reference Data Guide 1394


Overview of Label Properties

1 - Maximum Offset in X direction


2 - Maximum Offset in Y direction
3 - Minimum Offset

 Clear Space End of Linear Object (DwgLblEndOfSegmentPos)


Using this module, the software attempts to place the label in line with a straight feature,
such as a pipe, a cable, or an HVAC duct. The software begins at the Minimum Offset
distance from the terminating end of the feature and then continues out, alternating between
either end of the feature. In this way, the module looks for clear space within which to place
the label. The software continues on until reaching the specified Maximum Offset distance.
If no clear space is found in line with the feature, then the module returns to the specified
Minimum Offset distance from the end of the feature. The module then steps out
perpendicularly until reaching the specified Maximum Offset distance, still alternating
between either end of the feature. For more information about Maximum Offset, see
Maximum Offset (on page 1384).
The following graphic demonstrates the method used by the Clear Space End of Linear
Object (DwgLblEndOfSegmentPos) module to find clear space in which to place the label.

Drawings and Reports Reference Data Guide 1395


Overview of Label Properties

1 - Minimum Offset
2 - Maximum Offset in the X direction
3 - Maximum Offset in the Y direction

 The software interprets the Minimum Offset distance that you specify as paper space units
and not as model space units.
 You must specify the distance as a non-negative paper value.
 To manually edit the .xml, specify the minimum distance at which you want the label placed.
Enclose this value within the following .xml tags.
<minOffset>0.01</minOffset>
The Minimum Offset property cannot be used with gridline labels placed
within the margin. These labels are placed at a fixed distance from the edge of the view. This
distance is specified by the Perimeter Offset property. For more information, see Perimeter
Offset (perimeterOffset) (on page 1423).

Drawings and Reports Reference Data Guide 1396


Overview of Label Properties

Move Dimension Text to Outside


 Controls the placement of dimension text values for margin dimensions in the right and
bottom margins. Click True to place the value outside of the dimension line relative to the
view.

1 - View border
2 - Dimension text value

 Click False to place the value inside of the dimension line relative to the view.

1 - View border
2 - Dimension text value

 The positioning module Clear Space Margin with Dimensions (DwgMatchlineWithDim) uses
the Move Dimension Text to Outside property.
 The following options allow you to manually edit the .xml file:

Drawings and Reports Reference Data Guide 1397


Overview of Label Properties

 Type -1 to place the dimension text value outside of the dimension line.
 Type 0 to place the dimension text value inside of the dimension line.
 Enclose either of the above values within the following .xml tags.
<dimTextOutside>-1</dimTextOutside>

No Grouping or Filtering (Default)


(DefaultLabelGeometricAnalyzer)
Used to place a label on the origin or control point of an object. This module does not perform
any grouping. Currently used by most non-linear labels.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DefaultLabelGeometricAnalyzer</gaModule>
</geometricAnalyzerSettings>

Customization
None

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

NoFlow Symbol
Specifies the symbol that the system places when the pipe on which you want to place the
symbol does not permit flow to travel through the pipe.
This attribute is only available for flow arrows that you place manually.
The content module Flow Direction (DrawingFlowDirectionContent) checks the pipe to
determine in which direction or directions the flow travels. The module then selects the
corresponding flow direction symbol to be placed on the pipe. In this case, because no flow
travels through the pipe, the software places the NoFlow Symbol on the pipe.
The following image demonstrates the NoFlow Symbol placed a on a pipe that does not permit
flow.

Drawings and Reports Reference Data Guide 1398


Overview of Label Properties

1 - Pipe
2 - NoFlow Symbol

No Label Content (DrawingNoContent)


Returns no content.
Type -1 to suppress a label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingNoContent"/>
<ignoreError>0</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an

Drawings and Reports Reference Data Guide 1399


Overview of Label Properties

error for the label.

North Arrow (DrawingNArrowContent)


Determines the direction of true north for the North Arrow symbol.

Usage in Label Template XML


<label
<content>
<contentModule value="DrawingNArrowContent"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Example of the North Arrow symbol

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs. Type 0 to display the label regardless of
an error.

Drawings and Reports Reference Data Guide 1400


Overview of Label Properties

Nozzle (DrawingPGNozzleandBrace)
Generates a point using the position of pipe nozzles and related shape objects. Allows a label to
be placed on a nozzle object. This point generator must be used with the Clear Space Radial
from Object Center with Clustering (DrawingCentroid) (on page 1247) positioning module.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGNozzleandBrace</pgModule>
</pointGeneratorSettings>

Customization
None

Object Axis (DrawingGAEquipmentStyle2)


Tests label points for equipment.

Usage in Label Template XML


<label>
<geometricAnalyzerSettings>
<gaModule>DrawingGAEquipmentStyle2</gaModule>
<placeLines>-1</placeLines>
<deDuplicateLables>-1</deDuplicateLables>
<lineStyle>ANSI</lineStyle>
</geometricAnalyzerSettings>
</label>

Customization
placeLines
Controls line placement through the coordinate label points along aligned objects. Use this
property to include a single label in the drawing that specifies a common elevation for
aligned objects.
In the following image, placeLines has been set to 0, and the software has placed a line
connecting the equipment objects and a single label for the common Northing coordinate.

Type -1 to place lines. Type 0 to suppress lines.


DuplicateLabels
Specifies the points to label when more than one point is aligned horizontally or vertically.
Type -1 to place a label on the closest point.

Drawings and Reports Reference Data Guide 1401


Overview of Label Properties

1 – Label
2 – Point closest to the matchline
3 – Equipment object

Type 0 to place a label on both points.

1 – First label
2 – First horizontally aligned point
3 – Equipment object
4 – Second horizontally aligned point
5 – Second label

Drawings and Reports Reference Data Guide 1402


Overview of Label Properties

lineStyle
Allows you to specify the style of the line connecting horizontally or vertically aligned pieces
of equipment. Define this property when you have labeled equipment inside a plant with
coordinate labels.
In the following graphic, the Line Style has been defined with the Dash Dot Red style.

1 - Dash Dot Red Line Style


2 - North coordinate label

Drawings and Reports Reference Data Guide 1403


Overview of Label Properties

Examples
placeLines is -1 and deDuplicateLables is -1:

Drawings and Reports Reference Data Guide 1404


Overview of Label Properties

placeLines is -1 and deDuplicateLables is 0:

Although a content module creates the annotation output, this example shows how
this module affects the output.

Object Type
Specifies the 2D shape.

Point

Circle

Rectangle

Drawings and Reports Reference Data Guide 1405


Overview of Label Properties

Line

Line String

Ellipse

 The Points by 2D Shape Type (SM3DwgPointsByType) point generator uses the Object
Type property.
 To manually edit the .xml file, enclose any of the above values within the following .xml tags.
<objectType>Point</objectType>

Offset Label from Widget


Determines the method of positioning the label offset.
 Select True to offset the label from the edge of the widget when the label and widget
coincide.
 Select False to offset the label from the object centerline when the label and widget do not
coincide.

1 - Offset Label from Widget set to True


2 - Offset Label from Widget set to False

 The default setting for Offset Label from Widget is False.

Drawings and Reports Reference Data Guide 1406


Overview of Label Properties

 The positioning module Absolute Along Linear Object (DwgLinearAbsPos) uses the Offset
Label from Widget property.
 The following options allow you to manually edit the .xml file:
 Type -1 if the label and widget coincide.
 Type 0 if the label and widget do not coincide.
 Enclose either of the above values within the following .xml tags.
<offsetFromWidget>0</offsetFromWidget>

Only Outside of Object (DwgLeaderInOutsideControl)


Places a leader line when the distance from the label to the graphic object exceeds the limit
defined in the label template.
In the following image, the distance from the graphic object to the leader line exceeds the
defined limit. Therefore, the system places a leader line.

Drawings and Reports Reference Data Guide 1407


Overview of Label Properties

In the next image, the distance from the graphic object to the label falls within the limit defined in
the label template. Therefore, the software does not place a leader line.

Usage in Label Template XML


<leaderSettings>
<leaderModule>DwgLeaderInOutsideControl</leaderModule>
<toleranceZone>0.08</toleranceZone>
<breakline>-1</breakline>
</leaderSettings>

Customization
toleranceZone
Controls when a leader line is placed or not based on the label's distance from the labeled
object.
If the label is within the specified distance from the outer boundary of the object, then the
leader line is suppressed. If the label is outside of the specified distance, then the leader line
is displayed. For example, if the Tolerance Zone value is set to 10 mm, the label must be at
least 10 mm away (in paper units) from the labeled object before a leader appears.
For labels placed manually using the Place a Label command, type in a distance value in
the Tolerance Zone box on the ribbon.

breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.
Type -1 to display the leader jog.

Drawings and Reports Reference Data Guide 1408


Overview of Label Properties

Type 0 to omit the leader jog.

Drawings and Reports Reference Data Guide 1409


Overview of Label Properties

Opening Objects (DrawingPGOpeningObjects)


Generates dimension points for certain types of openings. The placement of points on the
opening depends on the type of opening that you are dimensioning. Alternately, the points are
placed at range vertex points.
You can generate dimension points for the following types of openings.
 Rectangle. The software generates points at each corner of the opening. The angles of the
rectangle must be 90 degrees.

1 - Dimension points
2 - Rectangular opening

 Circle. The software generates a point in the center of the opening.


The software does not support dimensioning ellipses.

1 - Circular opening
2 - Dimension point

 Square and rounded corners. The software generates points at the expected intersection of
the lines. The arc angle must be 90 degrees.

Drawings and Reports Reference Data Guide 1410


Overview of Label Properties

1 - Dimension points
2 - Opening with rounded corners

 Slot. The software generates points at the ends of each arc. The arc angle must be 180
degrees.

1 - Dimension points
2 - Slotted opening

Usage in Dimension and Label Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGOpeningObjects</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1411


Overview of Label Properties

Orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.

Applying the orientation property with the Clear Space Margin with Dimensions
(DwgMatchlineWithDim) positioning module enables you to select from five base values: Right,
Left, Bottom, Top, or Auto.
 Right places the label in the right margin of the view.

Drawings and Reports Reference Data Guide 1412


Overview of Label Properties

 Left places the label in the left margin of the view.

 Bottom places the label in the bottom margin of the view.

Drawings and Reports Reference Data Guide 1413


Overview of Label Properties

 Top places the label in the top margin of the view.

Drawings and Reports Reference Data Guide 1414


Overview of Label Properties

 Auto places the label by default in the margin that is closest to the labeled object.

You can select additional values, Longitudinal and Transversal, by combining the Local CS
Origin with Object Axis (DrawingPGEquipmentStyle2) point generator with the Clear Space
Margin with Dimensions (DwgMatchlineWithDim) positioning module. If you do not use the Local
CS Origin with Object Axis point generator, these additional values do not display in the
interface.

Drawings and Reports Reference Data Guide 1415


Overview of Label Properties

 Longitudinal places the leader line of the label along the major, or longer, axis of the object
that you are labeling.

Drawings and Reports Reference Data Guide 1416


Overview of Label Properties

 Transversal places the leader line of the label along the minor, or shorter, axis of the object
that you are labeling.

To apply margin grid labels outside of the matchline to your view style, you must use the
positioning modules Clear Space Grid Margin (DrawingMarginOnly) and/or Absolute Grid Margin
(DrawingGridLblMgnAbsPos).
For grid labels, the possible values for Orientation are Top, Bottom, Left, and Right. You
cannot specify any two of these in same label template. For example, in order to place grid
labels in both the bottom and right margins, you must create separate label rules and templates
for each orientation. Then, you must apply each label rule to different filter criteria in the view
style.

Drawings and Reports Reference Data Guide 1417


Overview of Label Properties

 The following image shows the Orientation property with two separate label templates,
Right and Bottom, applied.

Drawings and Reports Reference Data Guide 1418


Overview of Label Properties

 The following image shows the Orientation property with two separate label templates, Left
and Top, applied.

Additionally, you can place the grid labels inside the matchline by applying the Clear Space Grid
Horizontal (DrawingGridLblHoriz), Clear Space Grid Vertical (DrawingGridLblVert), or Clear
Space Position Marine Grid Label at Margin (SMDwgPositionGridLblMarginOnly) positioning
modules. Clear Space Grid Horizontal supports either a Left or Right value. Clear Space Grid
Vertical supports either a Top or Bottom value. Clear Space Position Marine Grid Label at
Margin supports Top, Bottom, Left, or Right values.
When using the Clear Space Grid Horizontal (DrawingGridLblHoriz) positioning module, you
cannot specify both Left and Right as the label orientation in the same label template. Likewise,
when using the Clear Space Grid Vertical (DrawingGridLblVert) positioning module, you cannot
specify both Top and Bottom as the label orientation within the same label template. You must
create separate label rules and templates for each orientation. Then, apply each label rule to
different filter criteria in the view style.
Use the positioning module Clear Space Coordinate (DrawingCoordLblPosMod) positioning
module to place coordinate labels. Coordinate labels contain the Northing and Easting positional
information for the labeled object. You can select either the Horizontal or Vertical coordinate
along which to place the Orientation for the label.

Drawings and Reports Reference Data Guide 1419


Overview of Label Properties

In the following image, the system has placed horizontal and vertical labels containing the
Easting and Northing coordinates, respectively.

Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

Drawings and Reports Reference Data Guide 1420


Overview of Label Properties

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

Enclose any of the above values within the following .xml tags.
<orientation>1</orientation>

Drawings and Reports Reference Data Guide 1421


Overview of Label Properties

Percentage Offset
Determines the label position along the length of a linear object, such as a structural member.
You can specify 0, 1, or any decimal value between 0 and 1 as the fractional position of the label
along the object. For horizontal members, the leftmost point is 0. For vertical members, the
bottommost point is 0.
 The following graphic illustrates the Percentage Offset property with a distance of 0.2,
or 20 percent, specified.

 The following graphic illustrates the Percentage Offset property with a distance of 0.5,
or 50 percent, specified.

Drawings and Reports Reference Data Guide 1422


Overview of Label Properties

 The Absolute Along Linear Object (DwgLinearAbsPos) positioning module uses the
Percentage Offset property.
 The following options allow you to manually edit the .xml file:
 Type 0 to place the label at the bottom left of the object.
 Type 1 to place the label at the top right of the object.
 Type a decimal value to place the label at a fractional point.
 Enclose any of the above values within the following .xml tags.
<percentageOffset>0.5
</percentageOffset>

Perimeter Offset (perimeterOffset)


Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.
Specify the distance to apply the Perimeter Offset property.

1 - Perimeter offset distance


2 - Dimension

 This property applies when you place the label or dimension using a positioning module.
The following label positioning modules use this property:
 Clear Space Margin (DrawingMarginOnly)
 Absolute Grid Margin (DrawingGridLblMgnAbsPos)
 Clear Space Grid Margin (DrawingGridLblMarginOnly)
 Clear Space Clipped (DwgClippedPositioning)

Drawings and Reports Reference Data Guide 1423


Overview of Label Properties

 Clear Space Margin with Dimensions (DwgMatchlineWithDim)


 Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin)
 Clear Space Position Marine Grid Label at Margin (SMDwgPositionGridLblMarginOnly)
 The Absolute Margin (DrawingDimMarginPos) dimension positioning module uses this
property.
 This property places the label or dimension within the margin outside of the view, instead of
within the boundaries of the view.
 The software interprets the distance from the edge of the view to the dimension line or edge
of the label as paper space units and not as model space units.
 You must specify a positive distance value, and the value must be greater than 0.000001 m.
 To manually edit the .xml file, specify the distance that you want offset from the edge of the
view to the dimension line or edge of the label. Enclose this value within the following .xml
tags.
<perimeterOffset>0.01</perimeterOffset>

Pin Jig Seam Offset Label (SMDPinJigSeamOffsetCM)


Gets the girth length of the curve for the intersection point and populates the label text box.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDPinJigSeamOffsetCM"/>
<Side>left</Side>
</content>
</label>

Customization
Side
The side of the curve that can be used to locate the label. Select Left or Right.

1 - Left
2 - Right

Drawings and Reports Reference Data Guide 1424


Overview of Label Properties

Piping Elevation (DrawingBOLabelContent)


Uses data from reports to label elevations of routing objects, such as pipe, ducts, cable trays,
and conduit.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingBOLabelContent"/>
<ID attributeName="Piping Plan_Routable_INV Elev_M">
Piping Plan_Routable_INV Elev_M.rtp</ID>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of

Drawings and Reports Reference Data Guide 1425


Overview of Label Properties

the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).

Example

Place Lines (placeLines)


Controls line placement through the coordinate label points along aligned objects. Use this
property to include a line between label points that are aligned horizontally or vertically on the
drawing sheet.
Select On to place one or more lines that connect the objects.

 You can place lines in a vertical or horizontal direction, depending on the alignment of the
objects. However, diagonal placement for diagonally aligned objects is not supported.
 If you do not specify a line style, the software applies a default line style. For more
information, see Line Style (on page 1358).
 The following geometric analyzer modules use the Place Lines property:
 Object Axis (DrawingGAEquipmentStyle2)
 Aligned Objects (DrawingGALabelInline)
 The following options allow you to manually edit the .xml file:

Drawings and Reports Reference Data Guide 1426


Overview of Label Properties

 Type -1 to place lines.


 Type 0 to suppress lines.
 Enclose either of the above values within the following .xml tags.
<placeLines>-1</placeLines>

Place Lines on Sheet


Allows you to preserve manual changes to the line position or style options between updates
when this option is turned on. Additionally, you can delete a connecting line between objects
when this option is turned on. If this option is cleared, the software redraws the connecting line
and does not preserve style changes each time that you regenerate the drawing.

 The Place Lines on Sheet option is cleared by default.


 The geometric analyzer Aligned Objects (DrawingGALabelInline) uses the Place Lines on
Sheet property.
 The following options allow you to manually edit the .xml file:
 Type 0 to turn off this option.
 Type -1 to preserve changes to the line between updates.
 Enclose either of the above options in the following .xml tags.
<placeLinesOnSheet>-1
</placeLinesOnSheet>

Plate Angle Symbol (ISPlateAngleSymbolContent)


Computes the angle of the non-target plate with reference to the target plate and places the
mounting angle symbol. The module obtains the plate angle value from the embedded report.
The orientation of the symbol indicates the mounting side of the plate.

Plate angle symbol

A symbol is not placed when:


 The mounting angle is 90º.
 The plate is not planar.

Drawings and Reports Reference Data Guide 1427


Overview of Label Properties

Usage in Label Template XML


<label>
<content>
<contentModule value="ISPlateAngleSymbolContent"/>
ID attributeName="Scantling Plate Mounting Angle">
Scantling Plate Mounting Angle.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Plate Grid Name Label


(SMDwgPlateGridNameLabelContent)
Creates labels for plate grid names.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgPlateGridNameLabelContent"/>
</content>
</label>

Customization
None

Point at Corner Cut (MHDrawingPGCornerCut)


Sets the control points used to place a corner cut label on an object, and the position along the
curve at the control point.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>MHDrawingPGCornerCut</pgModule>
<pgModuleSettings>
<locations>
<location id="1" target="0" />
<location id="12" target="0" curveRatio="0.25" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Drawings and Reports Reference Data Guide 1428


Overview of Label Properties

Customization
location ID XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Drawings and Reports Reference Data Guide 1429


Overview of Label Properties

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Drawings and Reports Reference Data Guide 1430


Overview of Label Properties

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 12 (At curve ratio).

Point for Profile Sketch Bevel Shape


(SMProfileSketchBevelShapeLabelsPG)
Generates a point for each label on the bevel shape.

1 - Point for bevel shape

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SMProfileSketchBevelShapeLabelsPG</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1431


Overview of Label Properties

Point on Remarking Curve along Girth


(SM3DDwgRemarkingGirthLengthPG)
Places a point at the midpoint of two intersection points on a remarking line curve along the
horizontal and/or vertical girth length.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SM3DDwgRemarkingGirthLengthPG</pgModule>
<Horizontal>0</Horizontal>
<Vertical>1</Vertical>
</pointGeneratorSettings>

Customization

1 - Horizontal remarking line


2 - Vertical remarking line
- Intersection point
- Point

Horizontal
Adds points to horizontal remarking line girth curves at the midpoints of intersection points.
 Select for on (the .xml value is 1).
 Clear for off (the .xml value is 0).
Vertical
Adds points to vertical remarking line girth curves at the midpoints of intersection points.
 Select for on (the .xml value is 1).
 Clear for off (the .xml value is 0).

Drawings and Reports Reference Data Guide 1432


Overview of Label Properties

Points Along 2D Curve (ISDwgPointsAlongCurve2D)


Places one or more points along the 2D curve representing a 3D object.
The 2D curve of the 3D object must have one or more curves.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>ISDwgPositionByCurve2D</pgModule>
<pgModuleSettings>
<locations>
<location id="3" targetName='FirstEnd'/>
<location id="12" target="0" curveRatio="0.25" />
<location targetName='TemplateBtmCrv'/>
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
location id

XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

Drawings and Reports Reference Data Guide 1433


Overview of Label Properties

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

Drawings and Reports Reference Data Guide 1434


Overview of Label Properties

target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 12 (At curve ratio).


targetName
Specifies a name for the target curve. The name is an attribute on an object in the drawing
view. The valid name is TemplateMidLine.
Specify target or targetName. Do not specify both.

Drawings and Reports Reference Data Guide 1435


Overview of Label Properties

Points Along 2D Range (ISDwgPointsAlongRange2D)


Places one or more points on a 2D representation of a 3D object. You can specify multiple
points.

Usage in Label Template XML


<label>
<pointGeneratorSettings>
<pgModule>ISDwgPositionByRange2D</pgModule>
<rangePoint>0</rangePoint>
<rangePoint>1</rangePoint>
<rangePoint>2</rangePoint>
</pgModuleSettings>
</pointGeneratorSettings>
</label>

Customization
rangePoint
Specifies the position of a point on an object. You can specify multiple range points.

Key Points

0 Top Left

1 Top Middle

2 Top Right

3 Middle Left

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

Drawings and Reports Reference Data Guide 1436


Overview of Label Properties

Points at Manufacturing Sketch Coordinates


(MfgSketchPG)
Places points based on coordinate values in the manufacturing data XML created in the
Structural Manufacturing task.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>MfgSketchPG</pgModule>
<pgModuleSettings>
<parseGraphics>0</parseGraphics>
<pgTransform>
...
</pgTransform>
</pgModuleSettings>
</pointGeneratorSettings>
The parseGraphics property is only used for placing dimensions. See Dimension Rule
Manager (on page 1503) in the Smart 3D Drawings and Reports Reference Data Guide for more
information.

Customization
The following properties are used for dimensioning. There are no customizable
properties for this module when it is used for placing labels.
maxDimOffset
Determines the maximum linear paper space distance between consecutive witness lines in
a linear distance dimension group.
MaxWtnessLength
Controls the length of witness lines so that you can determine how far across the drawing
the line is drawn. Points that fall outside the maximum witness length are eliminated from
consideration.
overall
Places an additional dimension over each dimension chain cluster identified by the rule.
parseGraphics
Specifies whether to determine dimension point locations by examining object graphics or
by using the pgTransform XSLT information in the template. Set the value to -1 to process
the graphics and forward them to the Penetration Plate (PenPlatePointGenerator) point
generator module. Set the value to 0 to process the pgTransform information.
The annotation output is created by a content module, not this module.

Drawings and Reports Reference Data Guide 1437


Overview of Label Properties

Points by 2D Shape Type (SMDwgPointsByType)


Places one or more points at the center of the 2D shape representing a 3D object.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SMDwgPointsByType</pgModule>
<pgModuleSettings>
<ObjectType>Point</ObjectType>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
ObjectType
Specifies the 2D shape.

Point

Circle

Rectangle

Line

Line String

Ellipse

Drawings and Reports Reference Data Guide 1438


Overview of Label Properties

Example
A non-target seam that intersects a target plate in two locations (such as a transverse hull seam
intersecting a deck) receives a point at each intersection.

Points by Associated Object ID


(SMPointsByAssociateObjectID)
Places an annotation point for each 2D point in the group and orients the label with respect to
any other object in the drawing. In the following example, the label will be oriented tangential to
the TemplateBtmCrv.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SMPointsByAssociateObjectID</pgModule>
<pgModuleSettings>
<locations>
<location targetName='TemplateBtmCrv'/>
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
targetName
Specifies a name for the target curve. The name is an attribute on an object in the drawing
view. Valid names are PlateContour and TemplateBtmCrv.

Example
StrMfg Templateset Midline Symbol
A reference curve that intersects a template will get a point at the intersection. This point is
associated with the reference curve and has template OID (Object ID) as its ID.

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1439


Overview of Label Properties

Points for View (ISDwgPointsForView)


Places a point to be used for north arrow or view labels at the center of a view.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>ISDwgPointsForView</pgModule>
</pointGeneratorSettings>

Customization
None

Positioning Point
Allows you to select a point within the range of a model object as the starting point. Starting at
this specified point, the software searches for clear space in the quadrants in order to place a
label.
You can select the positioning point from a list. The range of available options is indicated by
colored dots in the following graphic. In the following image, the Positioning Point is shown
placed in the TopRight position, and the Connect Point is shown placed in the MiddleRight
position.

Drawings and Reports Reference Data Guide 1440


Overview of Label Properties

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

For more information about Connect Points, see Connect Point (on page 1257).
The Positioning Point property can only be used with one of the point
generators listed below. Otherwise, the software ignores the property.
 Key Point(DefaultLabelPointGenerator)
 Nozzle (DrawingPGNozzleandBrace)
 Points Along 2D Range (ISDwgPointsAlongRange2D)
 Points for View (ISDwgPointsForView)
 MidPoint (ISMidPointLabelPG)
 Default Marine Point (ISRulesetPointGenerator)
 Points At Manufacturing Sketch Coordinates (MfgSketchPG)

The Positioning Point property may be used with the following positioning modules:
 Clear Space Quadrant 1 (DrawingQuadOne)
 Clear Space Quadrant 2 (DrawingQuadTwo)
 Clear Space Quadrant 3 (DrawingQuadThree)
 Clear Space Quadrant 4 (DrawingQuadFour)
 Clear Space Coordinate (DrawingCoordLblPosMod)
 Clear Space Radial (DrawingRadial)
 The method used by the software to search for clear space depends on the positioning
module used.
 The following options allow you to manually edit the .xml file:
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.

Drawings and Reports Reference Data Guide 1441


Overview of Label Properties

 Type 8 to place the point at the bottom middle.


Enclose any of the above values within the following .xml tags.
<positioningPoint>4</positioningPoint>

Priority (priority)
Determines the order in which the software places an annotation based on available clear space
and proximity to other annotations.
The software attempts to place an annotation (such as a label or a dimension) in clear
space as close as possible to that object's Connect Point. Multiple annotations do not
overlap. The Priority property allows you to assign a priority to each annotation, with 1
being the highest priority. The software places the annotation with the highest priority
closest to that object's Connect Point. Additional annotations with lower priorities are
placed further away from the corresponding object's Connect Point.
To define the priority, type a positive integer in the Priority text box.

1 - Equipment labels placed with Priority set to 1


2 - Structure label placed with Priority set to 2

Drawings and Reports Reference Data Guide 1442


Overview of Label Properties

1 - Equipment label placed with Priority set to 2


2 - Structure label placed with Priority set to 1

For more information about connect points, see Connect Point (on page 1257).

 The Default (DefaultLabelControlGenerator) (on page 1265) annotation control generator


and the Clear Space Position by 2D Curve (ISDwgPositionByCurve2D) (on page 1203)
positioning module use this property.
 To manually edit the .xml file, specify a positive integer to assign as a Priority number for
each annotation. Enclose this value within the following .xml tags.
<priority>1</priority>

Drawings and Reports Reference Data Guide 1443


Overview of Label Properties

Profile Angle Symbol (ISProfileAngleSymbolContent)


Creates a symbol containing the profile mounting angle value obtained from the embedded
report. The orientation of the symbol indicates the mounting side of the profile.

Profile angle symbol

A symbol is not placed when:


 The mounting angle is 90º.
 The profile is twisted and has multiple regions with different mounting angles.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISProfileAngleSymbolContent"/>
<ID attributeName="Scantling Profile Mounting Angle">
Scantling Profile Mounting Angle.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.
The format is:
< ID attributeName="symbol file name (without .sym extension)">report file name.rtp</ID >
You can define the report template location in the label template XML file.

ISProfilePartThicknessSymContent
Name: ISProfilePartThicknessSymContent
Description: Places a symbol that indicates the thickness direction of a profile part.
Type: Content Module
Annotation Output: Symbol
Currently Used By: Scantling Profile Thickness Symbol.xml
Usage in Label Template in XML

Drawings and Reports Reference Data Guide 1444


Overview of Label Properties

<content>
<contentModule value="ISProfilePartThicknessSymContent" />
<contentModuleSettings>
</contentModuleSettings>
</content>

Example:

Profile Sketch Bevel Shape Label


(SMProfileSketchBevelShapeLabelsCM)
Outputs the labels in the shape of a bevel.

Usage in Label Template XML


<label>
<content>
<contentModule value = "SMProfileSketchBevelShapeLabelsCM"/>
</content>
</label>

Customization
None

Example

Drawings and Reports Reference Data Guide 1445


Overview of Label Properties

Profile Sketch Bevel Symbol


(SMProfileSketchBevelSymbolCM)
Outputs the bevel symbol with labels on the profile sketch.

Usage in Label Template XML


<label>
<content>
<contentModule value = "SMProfileSketchBevelSymbolCM"/>
</content>
</label>

Customization
None

Example

Profile Sketch Detail Name Label


(SMDwgProfileSketchDetailNameLabelContent)
Outputs the detail name label content placed by profile sketch marking lines.

Usage in Label Template XML


<label>
<content>
<contentModule
value="SMDwgProfileSketchDetailNameLabelContent"/>
</content>
</label>

Customization
None

Drawings and Reports Reference Data Guide 1446


Overview of Label Properties

Profile Sketch Knuckle Label


(SMDwgProfileSketchKnuckleLabelContent)
Outputs the label content placed for profile sketch knuckles.

Usage in Label Template XML


<label>
<content>
<contentModule
value="SMDwgProfileSketchKnuckleLabelContent"/>
</content>
</label>

Customization
None

Profile Sketch Label


(SMDwgProfileSketchLabelsContent)
Creates labels for profile sketches.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgProfileSketchLabelsContent"/>
</content>
</label>

Customization
You can replace the content module in the label template with any .dll name that uses
IJDwgProfileSketchLabelGenerator to make it the current LabelGenerator for profile
sketches.

Drawings and Reports Reference Data Guide 1447


Overview of Label Properties

Profile Weld Points (SMDwgProfileWeldsPG)


Places points on the 2D curves representing a 3D profile, for use in placing weld labels.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SMDwgProfileWeldsPG</pgModule>
<pgModuleSettings>
<locations>
<location id="1" targetName="Profile_Web" />
<location id="8" targetName="Profile_Flange" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
location ID

XML
value

Middle 1

At the middle point of a curve.

Top 7

On the top of the range box for


the curve.

Bottom 8

On the bottom of the range


box for the curve.

targetName
Specifies a name for the target curve. The name is an attribute on an object in the drawing
view. Valid names are Profile_Web and Profile_Flange.

Drawings and Reports Reference Data Guide 1448


Overview of Label Properties

Radius Offset
Determines the distance between a nozzle port and the label annotating the port.

1 - Radius Offset with From Matchline property set to True

When the From Matchline property is set to True, the offset distance extends from the edge of
the matchline to the label. If From Matchline is set to False, then the distance specified extends
from the nozzle port to the label. For more information, see From Matchline (on page 1301).
Specify the offset in the text box.

 The positioning module Clear Space Radial from Object Center with Clustering
(DrawingCentroid) uses the Radius Offset property.
 The software interprets the Radius Offset distance that you specify as paper space units
and not model space units.

Drawings and Reports Reference Data Guide 1449


Overview of Label Properties

 You must specify 0 or any positive decimal paper value.


 To manually edit the .xml file, type the distance measurement that you want extended
between the nozzle port and the label annotating the port. Enclose this value within the
following .xml tags.
<rOffset>0.0</rOffset>

Range Point
Specifies the position of a point on an object. You can specify multiple range points.

Key Points

0 Top Left

1 Top Middle

2 Top Right

3 Middle Left

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

The Range of Points (ISDwgPointsAlongRange2D) content module uses this


property.

Drawings and Reports Reference Data Guide 1450


Overview of Label Properties

Reference (DrawingReferenceLabelContent)
Uses data from reports to label objects in drawings. Typically, the value is an item number, but
data from any field in the report can be passed in. Two conditions must exist for this content
module to work properly:
 The drawing view must be linked to a report. If this condition is not met, an error is logged in
the SP3D Error Log.
 The item being labeled in the view style must be in the report. If this condition is not met, a
question mark (?) is displayed.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingReferenceLabelContent"/>
<ID attributeName="ItemTag">ItemTag.rtp</ID>
<ignoreError>0</ignoreError>
</content>
</label>

Drawings and Reports Reference Data Guide 1451


Overview of Label Properties

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.

Remarking Girth Length Label


(SM3DDwgRemarkingGirthLengthCM)
Creates a label containing the girth length of a curve.

Usage in Label Template XML


<label>
<content>
<contentModule value="SM3DDwgRemarkingGirthLengthCM"/>
</content>
</label>

Customization
None

Report Template
Specifies the report template (.rtp) used to define the label content.
Report templates run a query against the model to gather the label data. To choose a new
report template file, click the ellipsis to the right of the Report Template box. Select the
report template file to use from the Select .rtp File dialog box.

Use the Define Label command to create report templates in the Catalog task. This
command creates three additional files in conjunction with the .rtp file that you create. If you
define a new label query, you must copy all four files from the Catalog folders into the Drawings
folders, located in the [SharedContent] folder. For more information, see Label Editor in the
Drawings and Reports Reference Data Guide.
See Also
Properties Tab (on page 1103)
Comments Tab (on page 1112)
Relationships Tab (on page 1111)

Drawings and Reports Reference Data Guide 1452


Overview of Label Properties

Rotation
Determines the angular orientation of the labels. The labels can be aligned horizontally,
irrespective of the orientation of the nozzle orientation angle, or the labels can be rotated to
match the nozzle orientation angle.
 Select True to rotate all labels to match the respective nozzle orientation angles.

Drawings and Reports Reference Data Guide 1453


Overview of Label Properties

 Select False to force horizontal label angles.

 The positioning module Clear Space Radial from Object Center with Clustering
(DrawingCentroid) uses the Rotation property.
 The following options allow you to manually edit the .xml file:
 Type -1 to rotate all labels.
 Type 0 to force horizontal label angles.
 Enclose either of the above values within the following .xml tags.
<rotation>0</rotation>

Drawings and Reports Reference Data Guide 1454


Overview of Label Properties

Ruler Axis (SMRulerAxisSymbolContent)


Creates a reference axis line with a tick mark at each reference plane. This module is used with
the Absolute Axis Position (SMDwgPositionAxis) (on page 1117) positioning module.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMRulerAxisSymbolContent"/>
<contentModuleSettings>
<axisInfo>
<marginDefinition>1</marginDefinition>
<bottom>
<offset>0.03</offset>
<style>Normal</style>
<tickMarkInfo>
<plusX>0.0</plusX>
<minusX>0.01</minusX>
<style>Normal</style>
</tickMarkInfo>
</bottom>
<left>
<offset>0.03</offset>
<style>Normal</style>
<tickMarkInfo>
<plusX>0.0</plusX>
<minusX>0.01</minusX>
<style>Normal</style>
</tickMarkInfo>
</left>
</axisInfo>
</contentModuleSettings>
</content>
</label>

Customization
axisInfo
Contains options for axis graphics.
tickMarkInfo
Contains options for tick mark graphics.

Drawings and Reports Reference Data Guide 1455


Overview of Label Properties

marginDefinition
Specifies the relationship of the grid axes to the drawing view for measuring the margin
offset of the axes.

XML
value

At View Frame 0
(default value)
Measures the margin
offset for each axis from
the edges of the view
SmartFrame, shown as
dashed lines in the
example.

At Drawing Area 1
Measures the margin
offset for each axis from
the edges of the drawing
area, shown as solid lines
in the example.

If you set the frame behavior to Frame resizes to drawing area, then the view frame and
the drawing area are the same size, and both values provide the same result, as shown in
the following example.

For more information, see Area Tab (Edit Ruleset View Style Dialog Box) (on page 130) in
the Drawings and Reports Reference Data Guide.
bottom or top
Specifies the side of the drawing view on which the software draws the horizontal axis.
Other properties are defined for this side. Select either Bottom or Top from the Horizontal
Ruler Axis Position list. Select None for no horizontal ruler axis to display.

Drawings and Reports Reference Data Guide 1456


Overview of Label Properties

Bottom

Top

left or right
Specifies the side of the drawing view on which the software draws the vertical axis. Other
properties are defined for the side. Select either Left or Right from the Vertical Ruler Axis
Position list. Select None for no ruler axis to display.

Left

Right

Drawings and Reports Reference Data Guide 1457


Overview of Label Properties

offset
Distance of a grid axis from the drawing view. Use offset in combination with the defined
axis (bottom, top, left, or right) and the margin definition.

style
Defines the line style for the axis or tick mark. Use style in combination with the defined axis
(bottom, top, left, or right) and with the tick mark information.
Line styles are defined in [Reference Data Product
Folder]\SharedContent\Drawings\Catalog\templates\Styles.sha.
plusX
Defines the length of the grid tick mark from the axis and toward the drawing view.

Drawings and Reports Reference Data Guide 1458


Overview of Label Properties

minusX
Defines the length of the grid tick mark from the axis and away from the drawing view.

Example

See Also
Horizontal Ruler Axis Offset (on page 1315)
Horizontal Ruler Axis Position (on page 1315)
Horizontal Ruler Axis Style (on page 1317)
Horizontal Ruler Axis Tick Mark Length Away from View (on page 1318)
Horizontal Ruler Axis Tick Mark Length toward View (on page 1319)
Horizontal Ruler Axis Tick Mark Style (on page 1320)
Vertical Ruler Axis Offset (on page 1484)
Vertical Ruler Axis Position (on page 1485)
Vertical Ruler Axis Style (on page 1486)
Vertical Ruler Axis Tick Mark Length Away from View (on page 1487)
Vertical Ruler Axis Tick Mark Length toward View (on page 1488)
Vertical Ruler Axis Tick Mark Style (on page 1489)

Drawings and Reports Reference Data Guide 1459


Overview of Label Properties

Scale Factor Percentage (scaleFactor)


Controls the size of pipe flow arrow symbols. The software places a flow direction arrow
scaled to a percentage of the pipe diameter. For example, type 50 to place a flow direction
arrow that is one-half the pipe diameter. If the value is 0, the flow direction arrow is not
scaled.

1 - Scale Factor Percentage = 50 (0.5 in .xml)


2 - Scale Factor Percentage = 30 (0.3 in .xml)
3 - Scale Factor Percentage = 0

 The content module Flow Direction (DrawingFlowDirectionContent) (on page 1298)


uses this property.
 Type 0 to place a flow arrow without applying a scale factor.
 Type a value in the Scale Factor Percentage box. Alternatively, enclose the equivalent
decimal value within the following .xml tags:
<scaleFactor>0.5</scaleFactor>

Drawings and Reports Reference Data Guide 1460


Overview of Label Properties

Scantling Near Side or Far Side Direction Symbol


(SMDwgScantlingNSorFSDirectionContent)
Creates ship direction symbols based on whether the near side or the far side of a plate is
displayed.
The near side of a plate is the side with the most profile stiffeners.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgScantlingNSorFSDirectionContent"/>
<contentModuleSettings>
<directionSymbols>
<port>port.sym</port>
<starboard>starboard.sym</starboard>
<aft>aft.sym</aft>
<forward>forward.sym</forward>
<up>up.sym</up>
<down>down.sym</down>
</directionSymbols>
</contentModuleSettings>
</content>
</label>

Customization
directionSymbols
Contains options for the direction symbols.
port, starboard, aft, forward, up, down
Specify the symbol file (.sym) for each side. If a path for a file is not given, the file is located
in the same folder as the label template .xml file.

Drawings and Reports Reference Data Guide 1461


Overview of Label Properties

Search Mode
Defines the starting point and search method for the clear space search along the 2D curve.

XML value

From Center 0

Starts from the center of the 2D curve. The software tries


to place the label to the left or right of the center of the
curve.

Low To High 1

Starts from the start curve ratio location. The system tries
to place the label in clear space in a search toward the
end curve ratio location.

High To Low 2

Starts from the end curve ratio location. The software


tries to place the label in clear space in a search toward
the start curve ratio location.

 The Clear Space Position by 2D Curve (ISDwgPositionByCurve2DAtMargin) positioning


module uses the Search Mode property.
 To manually edit the .xml file, enclose any of the above values within the following .xml tags.
<searchMode>0</searchMode>

Drawings and Reports Reference Data Guide 1462


Overview of Label Properties

Ship Direction Symbol


(ISShipDirectionSymbolContent)
Creates a ship direction symbol for a specified view direction. A symbol is selected based on the
ship direction matching a selected view direction.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISShipDirectionSymbolContent"/>
<contentModuleSettings>
<directionValue>Up</directionValue>
<directionSymbols>
<port>port.sym</port>
<starboard>starboard.sym</starboard>
<aft>aft.sym</aft>
<forward>forward.sym</forward>
<up>up.sym</up>
<down>down.sym</down>
</directionSymbols>
</contentModuleSettings>
</content>
</label>

Customization
directionValue
Specifies the view direction. Use Up, Down, Left, or Right.

1 - Up
2 - Down
3 - Left
4 - Right

directionSymbols
Specifies the symbol (.sym) file to use for each ship direction. Specify symbols for port,
starboard, aft, forward, up, and down. If a path for a file is not given, the file is located in
the same folder as the label template .xml file.

 View direction is the direction in paper space (that is, on the drawing sheet).

Drawings and Reports Reference Data Guide 1463


Overview of Label Properties

 Ship direction is determined within the view based on the location and direction of the view
relative to the model.

Examples
Ship direction is up for a directionValue of Up. The up option of directionSymbols is used:

Ship direction is starboard for a directionValue of Right. The starboard option of


directionSymbols is used:

Drawings and Reports Reference Data Guide 1464


Overview of Label Properties

Sheet Direction
Specifies the view direction. Select Up, Down, Left, or Right.

1 - Up
2 - Down
3 - Left
4 - Right

Select the direction from the Sheet Direction list in the North Arrow Rule Manager. Alternately,
enclose the direction within the following .xml tags:
<directionValue>Right</directionValue>

Customization
None

Spacing
Specifies the vertical and horizontal distances between CAD Details graphics placed on the
drawing sheet. Type the distance in the text box.
The following graphic shows the Spacing property with 0.01 m specified between two CAD
Details graphics.

1 - End plate
2 - Shoe base

The following graphic shows the Spacing property with 0.02 m specified between two CAD

Drawings and Reports Reference Data Guide 1465


Overview of Label Properties

Details graphics.

1 - End plate
2 - Shoe base
3 - Shoe vertical part

The number of CAD Details graphics that can fit on the drawing sheet depends on the
measurements that you specify for this property. Specifying a greater distance between CAD
Details graphics results in fewer graphics on the drawing sheet, while specifying a smaller
distance results in a greater number of graphics on the drawing sheet.

 The Clear Space Tiling (CAD Details) (DrawingTileInView) positioning module uses the
Spacing property.
 You must specify the distances as a non-negative paper value.
 You can use either metric or imperial units for this measurement.
 To manually edit the .xml file, specify the vertical and horizontal distances. Enclose this
value within the following .xml tags.
<spacing>0.01</spacing>

Stacked Labels (DwgStackLabelLeader)


Places a single-segment leader line between the label and drawing object. If more than one
label exists for the object, the labels are stacked next to each other along the same axis of the
leader line. You must use the Clear Space Radial from Object Center with Clustering
(DrawingCentroid) (on page 1247) positioning module with this leader module.

Usage in Label Template XML


<label>
<leaderSettings>
<leaderModule>DwgStackLabelLeader</leaderModule>
<style>ANSI</style>
<breakline>0</breakline>
<disableAutoDelete>-1</disableAutoDelete>
</leaderSettings>
</label>

Drawings and Reports Reference Data Guide 1466


Overview of Label Properties

Customization
style
Defines the appearance of a leader line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

To manually edit the .xml file, specify the style that you want applied to the leader line.
breakline

Drawings and Reports Reference Data Guide 1467


Overview of Label Properties

Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.
Type -1 to place a breakline.

Type 0 to omit the breakline.

You cannot place breaklines with acute leader jog angles when automatically
generating labels. However, you can manually place breaklines with acute leader jog angles
within SmartSketch by updating the view, then selecting a leader and clicking BreakLine .
disableAutoDelete
Controls the visibility of the leader line of a label when the distance from the label to the
corresponding connect point is less than half the label height.
Type -1 to retain the leader line.

Drawings and Reports Reference Data Guide 1468


Overview of Label Properties

1 - Label with leader line

Type 0 to turn off the leader line.

1 - Label with no leader line

Start Curve Ratio


Specifies the start point on the 2D curve. Specify the value as a ratio along the length of the
curve. The ratio must be between 0.0 and 1.0.

The software performs the search for clear space positioning between the start point and the
end point. The end curve ratio must be greater than the start curve ratio.

 The Clear Space Position by 2D Curve (ISDwgPositionByCurve2D) positioning module uses


the Start Curve Ratio property.

Drawings and Reports Reference Data Guide 1469


Overview of Label Properties

 To manually edit the .xml file, enclose the ratio within the following .xml tags.
<startCurveRatio>0</startCurveRatio>

Structural Widget (StructuralWidgetLabelContent)


Generates structural widgets for members. A widget can be moved along the member.

Usage in Label Template XML


<label>
<content>
<contentModule value="StructuralWidgetLabelContent"/>
</content>
</label>

Customization
None

Example
Volume in the model used to create a drawing view:

Drawings and Reports Reference Data Guide 1470


Overview of Label Properties

Drawing view with widgets for the members:

Style
Specifies the line style for the leader.

1 - Leader line
2 - Break line

To manually edit the .xml file, enclose the style to apply to the leader line within the
following .xml tags, as follows.
<style>NO_ARROW</style>
For more information about the available styles, see Style (on page 1471).

Style
Defines the appearance of a leader line. To choose a default style delivered with the software,
select the style to apply to the leader line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

Drawings and Reports Reference Data Guide 1471


Overview of Label Properties

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

The following additional styles are available for Marine only. Select the style to apply to the
leader line.

Drawings and Reports Reference Data Guide 1472


Overview of Label Properties

 ISISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ISISO 2.5x: Applies a thick, solid, dark cyan line style with a small, filled arrow terminator to
the leader line.

 ISISO_Slash: Applies a thick, solid, dark cyan line style with a slash terminator to the leader
line.

 ISISO_Slash_Red: Applies a thick, solid, red line style with a slash terminator to the leader
line.

 ISIS0Right 2.5x: Applies a thin, solid, dark cyan line style with a small, filled arrow
terminator to the leader line.

 ISORight: Applies a thin, solid, dark cyan line with a large, filled arrow terminator to the
leader line.

You can use SmartSketch Drawing Editor to create your own styles.

 The following leader modules use the Style property:


 Coordinate (DrawingCoordLeaderControl)
 Linear (DrawingLinearLeader)
 Weld (DrawingWeldLeader)
 Default (DwgLeaderControl)
 Margin (DwgMarginLeaderControl)
 Stacked Labels (DwgStackLabelLeader)
 Materials Handling Absolute (MHDrawingAbsoluteLeader)
 To manually edit the .xml file, specify the style that you want applied to the leader line.
Enclose this value within the following .xml tags.
<style>ANSI</style>

Drawings and Reports Reference Data Guide 1473


Overview of Label Properties

Subpriority
Provides a second priority on labels in order to resolve more specific conflicts among multiple
labels searching for clear space. As with the Priority property, the lower the number, the higher
the priority. For example, 1 is a higher priority than 3. A value of 0 indicates that the Subpriority
property is turned off.

 The Clear Space Position by 2D Curve (ISDwgPositionByCurve2D) positioning module uses


the Subpriority property.
 To manually edit the .xml file, enclose the subPriority number within the following .xml tags.
<subPriority>1</subPriority>

Symbol Attribute Name


Displays the value of the ID user attribute for the text box in the associated symbol file. This
attribute links the text box to the report template file.
The software automatically updates this attribute when the symbol file is modified.
See Also
Properties Tab (on page 1103)
Relationships Tab (on page 1111)
Comments Tab (on page 1112)

Symbol Path Label


Specifies which report template contains the symbol file names for the label. This property is
used with the Default (DrawingLabelHelper) (on page 1268) content module.
The ignoreError property is unavailable when you define the symbol path label.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingLabelHelper"/>
<symbolPathLabel>HngSup Cad Details_Cad
Detail.rtp</symbolPathLabel>
</content>
</label>
See Also
Content Module (Properties tab) (on page 1105)
Default (DrawingLabelHelper) (on page 1268)

Drawings and Reports Reference Data Guide 1474


Overview of Label Properties

Template Set Full Scale Direction Symbol


(SMTemplatesetFullScaleDirSymbolContent)
Creates a looking direction symbol for the view.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMTemplatesetFullScaleDirSymbolContent"/>
<contentModuleSettings>
<directionValue>Right</directionValue>
<directionSymbols>
<port>port.sym<port>
<starboard>starboard.sym</starboard>
<aft>aft.sym</aft>
<forward>forward.sym</forward>
<up>up.sym</up>
<down>down.sym</down>
</directionSymbols>
</contentModuleSettings>
</content>
</label>

Customization
port
Specify the port direction symbol file (.sym).
starboard
Specify the starboard direction symbol file (.sym).
aft
Specify the aft direction symbol file (.sym).
forward
Specify the forward direction symbol file (.sym).
up
Specify the up direction symbol file (.sym).
down
Specify the down direction symbol file (.sym).
If a path for a file is not given, the file is located in the same folder as the label
template XML file.

Example

Drawings and Reports Reference Data Guide 1475


Overview of Label Properties

Tolerance Angle
Denotes the range in degrees on either side of the weld reference line or the perpendicular
of the line. The leader line of a weld label cannot be placed within this range. If you place
the weld label in such a way that the leader line of the label falls within this range, that
leader line automatically shifts until free of the Tolerance Angle range.

Specify the Tolerance Angle in the text box. The default value is 0 degrees.

 The Weld (DrawingWeldSymbols) content module uses the Tolerance Angle property.
 You must specify a positive decimal paper value for this distance.
 To manually edit the .xml file, enclose the range within the following .xml tags.
<toleranceAngle>0
</toleranceAngle>

Tolerance Angle for Single Bevel J Weld


Specifies the permissible range of degrees within which the leader line of the label may fall
when the arrow line points toward certain welds. Single-bevel butt welds, single-bevel butt
welds with broad root faces, and single J butt welds are all affected by this property. In the
case of welds of these types, the arrow line points toward the prepared edge of the plate. If
the arrow line falls outside of the specified range, then the leader line connecting to the
arrow line shifts by 90 degrees minus the value of Tolerance Angle for Single Bevel J
Weld.

Specify the range of degrees for the Tolerance Angle for Single Bevel J Weld in the text box.
The default range is 0.

 The Weld (DrawingWeldSymbols) content module uses the Tolerance Angle for Single
Bevel J Weld property.
 The software interprets the Tolerance Angle for Single Bevel J Weld that you specify as
paper space units and not as model space units.
 You must specify a positive decimal value in degrees.
 To manually edit the .xml file, enclose the range in degrees within the following .xml tags.
<toleranceAngleForSingleBevelJWeld>0
</toleranceAngleForSingleBevelJWeld>

Drawings and Reports Reference Data Guide 1476


Overview of Label Properties

Tolerance Zone
Controls when a leader line is placed or not based on the label's distance from the labeled
object.
If the label is within the specified distance from the outer boundary of the object, then the
leader line is suppressed. If the label is outside of the specified distance, then the leader line
is displayed. For example, if the Tolerance Zone value is set to 10 mm, the label must be at
least 10 mm away (in paper units) from the labeled object before a leader appears.
For labels placed manually using the Place a Label command, type in a distance value in
the Tolerance Zone box on the ribbon.

Specify the distance in the text box.

 The leader module Only Outside of Object (DwgLeaderInOutsideControl) uses the


Tolerance Zone property.
 The software interprets the Tolerance Zone distance that you specify as paper space units
and not model space units.
 You can use either metric or imperial units for this measurement.
 You must specify a positive decimal paper value for this distance.
 To manually edit the .xml file, enclose the Tolerance Zone value (in meters only, imperial
units are not supported in XML) within the following XML tags.
<toleranceZone>0.01</toleranceZone>

Top, Bottom, Left, Right


Sides of the curve that can be used to locate the label with respect to an axis.

1 - Top
2 - Bottom
3 - Left
4 - Right

Drawings and Reports Reference Data Guide 1477


Overview of Label Properties

In the example below, thickness markings are placed on the left axis for the lines in red
representing profiles.

The Absolute Position by 2D Curve at Axis (SMDwgPositionByCurve2DAtAxis)


positioning module uses these properties.

Top, Bottom, Left, Right Margin Labels


Sides of the view that you can use to locate the curve label. You can only locate labels in
the margins of the specified sides. For each side, select to allow a label in the margin (the
.xml value is 1) or clear if no label in the margin is needed (the .xml value is 0).

1 - Top
2 - Bottom
3 - Left
4 - Right

 The Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin)


positioning module uses these properties.

Drawings and Reports Reference Data Guide 1478


Overview of Label Properties

 The following options are available for manually editing the .xml file.
 Type 1 to allow the label.
 Type 0 if no margin label is needed.
Enclose either value within the following .xml tags.
<top>1</top>
<bottom>1</bottom>
<right>1<right>
<left>1</left>

Trench (DrawingCivilLabelContent)
Places an automatic label with the content of invert elevation values (Z) of the straight and turn
features created with the Civil task.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingCivilLabelContent"/>

Drawings and Reports Reference Data Guide 1479


Overview of Label Properties

<ID attributeName="Civil_TrenchFeature_StartElevation">
Civil_TrenchFeature_StartElevation.rtp</ID>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).

Example

Drawings and Reports Reference Data Guide 1480


Overview of Label Properties

Trench (CivilElevationPointGenerator)
Places label points at the start or end of the trench straight features and at the miter center of
the trench turn feature.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>CivilElevationPointGenerator</pgModule>
<pgModuleSettings>
<featureType>3</featureType>
<location>1</location>
<choice>1</choice>
<cardinalPoint>2</cardinalPoint>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
featureType
Determines whether to place a point for either the turn feature or the straight feature, or
both.
Type 1 to place a point for the straight feature. Type 2 to place a point for the turn feature.
Type 3 to place a point for both the straight feature and the turn feature.
location
Determines the location of the point that the software places on a straight or turn feature.
Type 1 to place the point at the start of the feature.

Type 2 to place the point at the end of the feature.

Type 3 to place the point along the turn.

Drawings and Reports Reference Data Guide 1481


Overview of Label Properties

choice
Allows you to select the trench features on which the software places points.
 The following options are available for manually editing the .xml file.
 Type 1 to place points on all features.
 Type 2 to place a point on the first feature only.
 Type 3 to place a point of the last feature only.
 Type 4 to place no points.
cardinalPoint
Determines the placement of the key, or cardinal, point on a feature.
Possible cardinal points for cross-section used in the trench feature are shown in the
diagram below.

The following options are available for manually editing the .xml file.
 Type 1 to place the Cardinal Point at the bottom left.
 Type 2 to place the Cardinal Point in the bottom center.
 Type 3 to place the Cardinal Point at the bottom right.
 Type 7 to place the Cardinal Point at the top left.
 Type 8 to place the Cardinal Point in the top center.
 Type 9 to place the Cardinal Point at the top right.

Drawings and Reports Reference Data Guide 1482


Overview of Label Properties

Unidirectional Symbol
Specifies the symbol that the system places when the pipe permits flow to travel in only one
direction through the pipe.
The following image shows the Unidirectional Symbol placed on two pipes that each allow
flow to travel in only one direction.

1 - Pipe
2 - Unidirectional Symbol

The content module Flow Direction (DrawingFlowDirectionContent) checks the pipe to


determine in which direction or directions the flow travels. The module then selects the
corresponding flow direction symbol to be placed on the pipe. In this case, because flow
travels in only one direction through the pipe, the software places the Unidirectional
Symbol on the pipe.

Use Clear Space


Specifies whether the software uses clear space to avoid overlap with other labels.
 Select to use clear space.
 Clear to ignore clear space.

 The Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin)


positioning module uses the Use Clear Space property.
 The following options allow you to manually edit the .xml file.
 Type 0 to ignore clear space.
 Type 1 to use clear space.
 Enclose either of the above values within the following .xml tags.
<useClearSpace>0</useClearSpace>

Drawings and Reports Reference Data Guide 1483


Overview of Label Properties

Vertical Offset
Vertical distance of the label from the positioning point. The software measures this value in
meters. The default value is 0.00.

The following positioning modules use this property:


 DrawingAbsolute
 DrawingCenterThenRotate
 DwgAbsolutePositionByCurve2D
 ClearSpace Position by 2D Curve

Vertical Ruler Axis Offset


Distance of a vertical grid axis from the drawing view. Type the offset value in the Vertical Ruler
Axis Offset box.

 The Ruler Axis (SMRulerAxisSymbolContent) content module uses the Vertical Ruler Axis
Offset property.
 To manually edit the .xml file, first define the axis (left, or right). Then, enclose the offset
value within the offset tags. An example follows.
<left>
<offset>0.03</offset>
</left>
See Also
Vertical Ruler Axis Position (on page 1485)

Drawings and Reports Reference Data Guide 1484


Overview of Label Properties

Vertical Ruler Axis Position


Specifies the side of the drawing view on which the software draws the vertical axis. Other
properties are defined for the side. Select either Left or Right from the Vertical Ruler Axis
Position list. Select None for no ruler axis to display.

Left

Right

None

 The Ruler Axis (SMRulerAxisSymbolContent) content module uses the Vertical Ruler Axis
Position property.
 To manually edit the .xml file, first, specify axisInfo. Then, specify either left or right
as shown in the example below. The following example includes additional properties
defined for the side.

Drawings and Reports Reference Data Guide 1485


Overview of Label Properties

<axisInfo>
<left>
<offsetX>0.01</offsetX>
<offsetY>0.0</offsetY>
<angle>3</angle>
<anchor>0</anchor>
<connectPoint>5</connectPoint>
</left>
</axisInfo>
 Remove the left or right section from the .xml file if you do not want to display a vertical
ruler axis.

Vertical Ruler Axis Style


Defines the line style for the axis ruler. Select a style from the Vertical Ruler Axis Style list.

1 - Style = Normal

 The Ruler Axis (SMRulerAxisSymbolContent) content module uses the Vertical Ruler Axis
Style property.
 Select the axis ruler location (Left or Right) from the Vertical Ruler Axis Position list.
 To manually edit the .xml file, first define the axis (left or right). Then, enclose the style
within the .xml tags as shown in the following example.
<right>
<style>Normal</style>
</right>
See Also
Vertical Ruler Axis Position (on page 1485)

Drawings and Reports Reference Data Guide 1486


Overview of Label Properties

Vertical Ruler Axis Tick Mark Length Away from View


Defines the length of the grid tick mark from the axis and away from the drawing view. Type a
value in the Vertical Ruler Axis Tick Mark Length Away from View box.

1 - Length of tick mark away from view

 The Ruler Axis (SMRulerAxisSymbolContent) content module uses the Vertical Tick Mark
Length Away from View property.
 To manually edit the .xml file, specify the location of the tick mark using left or right.
Then, enclose the tick mark length within the following .xml tags.
<left>
<tickMarkInfo>
<minusX>0.01</minusX>
</tickMarkInfo>
</left>
 In the Label Rule Manager, type the value in the Vertical Ruler Axis Tick Mark Length
Away from View box.

Drawings and Reports Reference Data Guide 1487


Overview of Label Properties

Vertical Ruler Axis Tick Mark Length toward View


Defines the length of the grid tick mark from the axis and toward the drawing view. Type a value
in the Vertical Ruler Axis Tick Mark Length Away from View box.

1 - Length of tick mark toward view

 The Ruler Axis (SMRulerAxisSymbolContent) content module uses the Vertical Ruler Axis
Tick Mark Length toward View property.
 To manually edit the .xml file, specify the location of the tick mark using left or right.
Then, enclose the tick mark length within the following .xml tags.
<right>
<tickMarkInfo>
<plusX>0.0</plusX>
</tickMarkInfo>
</right>

Drawings and Reports Reference Data Guide 1488


Overview of Label Properties

Vertical Ruler Axis Tick Mark Style


Defines the line style for the axis tick marks. Select a style from the Vertical Ruler Axis Tick
Mark Style list.

1 - style = Normal

 The Ruler Axis (SMRulerAxisSymbolContent) content module uses the Vertical Ruler Axis
Tick Mark Style property.
 To manually edit the .xml file, first define the axis (left or right). Then, enclose the style
within the .xml tags as shown in the following example.
<right>
<style>Normal</style>
</right>

See Also
Vertical Ruler Axis Position (on page 1485)

Drawings and Reports Reference Data Guide 1489


Overview of Label Properties

Weld (DrawingWeldLeader)
Connects the leader line to either the left-most or right-most point of the weld line, depending on
the orientation of the label.
The following image shows the leader line connecting to the left-most point of the weld line.

1 - Leader line
2 - Weld line

Customization
breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.
Type -1 to place a leader jog.

Drawings and Reports Reference Data Guide 1490


Overview of Label Properties

Type 0 to omit the leader jog.

style
Defines the appearance of a leader line.
Specify any of the following styles.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Drawings and Reports Reference Data Guide 1491


Overview of Label Properties

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Weld (DrawingWeldSymbols)
Determines what weld symbols to place on a drawing

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingWeldSymbols"/>
<ID>WeldSymbols\Weldsymbol.rtp</ID>
<ignoreError>0</ignoreError>
</content>
<leaderSettings>
<toleranceAngle>0</toleranceAngle>
<toleranceAngleForSingleBevelJWeld>0
</toleranceAngleForSingleBevelJWeld>
</leaderSettings>
</label>

 This content module automatically generates the weld symbol representation according to
the AWS standard based on the label output provided in the <ID> section.
 The two-dimensional weld symbol that the software writes to the drawing is based on the
occurrence attributes provided in the Support Weld Component Properties dialog box
under the Welding category in the model and the 2D symbols located in the [Symbol
Share]\drawings\catalog\labels\templates\weldsymbols folder.
 For more information on the mapping of three-dimensional weld component properties and
the two-dimensional weld symbol representation, see AWS Standards in Drawings (on page
34) in the Drawings and Reports Reference Data Guide and Weld Properties in the Hangers
and Supports SmartPart Symbols Reference Guide.
 The report template must be located in the same folder as the label template XML.

Drawings and Reports Reference Data Guide 1492


Overview of Label Properties

Customization
ID
Specifies the report template that defines the label contents.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
The ignoreError property is unavailable when you define the symbol path label.
For more information, see Symbol Path Label (on page 1474).
toleranceAngle
Denotes the range in degrees on either side of the weld reference line or the perpendicular
of the line. The leader line of a weld label cannot be placed within this range. If you place
the weld label in such a way that the leader line of the label falls within this range, that
leader line automatically shifts until free of the Tolerance Angle range.
toleranceAngleForSingleBevelJWeld
Specifies the permissible range of degrees within which the leader line of the label may fall
when the arrow line points toward certain welds. Single-bevel butt welds, single-bevel butt
welds with broad root faces, and single J butt welds are all affected by this property. In the
case of welds of these types, the arrow line points toward the prepared edge of the plate. If
the arrow line falls outside of the specified range, then the leader line connecting to the
arrow line shifts by 90 degrees minus the value of Tolerance Angle for Single Bevel J
Weld.

Weld Label Text (DrawingGAWelds)


Sets a weld attribute on the points or deletes points placed by the point generator. This module
is used with the Weld Point (DrawingPGWelds) (on page 1494) point generator.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGAWelds</gaModule>
</geometricAnalyzerSettings>

Customization
None

Drawings and Reports Reference Data Guide 1493


Overview of Label Properties

Weld Point (DrawingPGWelds)


Sets the control points used to place a weld symbol on an object and the position along the
curve at the control point. This module is used with the Weld Label Text (DrawingGAWelds) (on
page 1493) geometric analyzer.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGWelds</pgModule>
<pgModuleSettings>
<locations>
<location id="1" target="0" />
<location id="12" target="0" curveRatio="0.25" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
location id

XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

Drawings and Reports Reference Data Guide 1494


Overview of Label Properties

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

Drawings and Reports Reference Data Guide 1495


Overview of Label Properties

target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 12 (at curve ratio).

Drawings and Reports Reference Data Guide 1496


Overview of Label Properties

Weld Type
Specifies a weld type as defined in the catalog.

ButtWeld1, ButtWeldI, Butt-I


Symbol Joint

1 - Gap

ButtWeld2, ButtWeldY
Symbol Joint

1 - Reference part
2 - Root gap
3 - Non-reference root gap
4 - Nose

ButtWeld3, ButtWeldK, ButtWeldX


Symbol Joint

1 - Reference part
2 - Root gap
3 - Non-reference root gap
4 - Nose

Drawings and Reports Reference Data Guide 1497


Overview of Label Properties

ButtWeld4, ButtWeldV
Symbol Joint

ButtWeldIV
Symbol Joint

ButtWeldIX
Symbol Joint

1 - Bevel angle
2 - Molded side

FilletWeld1, FilletWeld2
Symbol Joint

1 - Leg
2 - Molded side

Drawings and Reports Reference Data Guide 1498


Overview of Label Properties

TeeWeld1
Symbol Joint

TeeWeld2
Symbol Joint

TeeWeld3
Symbol Joint

Drawings and Reports Reference Data Guide 1499


Overview of Label Properties

TeeWeld4
Symbol Joint

TeeWeld5
Symbol Joint

TeeWeld6
Symbol Joint

Drawings and Reports Reference Data Guide 1500


Overview of Label Properties

TeeWeld7
Symbol Joint

TeeWeldK
Symbol Joint

1 - Reference side bevel depth


2 - Anti-reference side bevel depth
3 - Nose
4 - Reference side bevel angle
5 - Anti-reference side bevel angle

TeeWeldV
Symbol Joint

1 - Reference side bevel depth


2 - Reference side bevel angle

Drawings and Reports Reference Data Guide 1501


Overview of Label Properties

TeeWeldX
Symbol Joint

1 - Reference side bevel depth


2 - Anti-reference side bevel depth
3 - Reference side bevel angle
4 - Anti-reference side bevel angle

TeeWeldY
Symbol Joint

1 - Reference side bevel angle


2 - Nose

ButtDemarcation, TeeDemarcation

The Scantling Weld Symbol (DwgScantlingWeld) content module uses the Weld
Type property.

Drawings and Reports Reference Data Guide 1502


SECTION 17

Dimension Rule Manager


The Dimension Rule Manager allows you to modify dimension rules and the properties of
dimension templates. When you select a dimension template to modify from the Dimension
Rule list on the View Style Properties dialog box, the Dimension Rule Manager opens the
template. The template name and the rule description display at the top of the Dimension Rule
Manager. The Properties tab contains a search box and a list of modules that the template
uses. Each module displays properties you can modify to customize the selected dimension
template. The Help topic associated with each property that you select displays in the
Information pane on the right-hand side of the Dimension Rule Manager.
You can type a property name in the Search box at the top of the Properties tab to
quickly navigate to the options for that property.
The modules and properties that display depend on which module you select. For more
information, see Properties Tab (Dimension Rule Manager) (on page 1506).
If you type an invalid value into a property's text box, a red border displays around
that property to alert you. Hover over the text box to display additional information about the
error.
After you have made changes to the rule, click Save.
Click Save and Close to save all changes and exit the Dimension Rule Manager.
To clear all changes that you have made to the template or templates, click Reset to revert to
the original values in the template file.
To cancel all changes that you have made, click Cancel. An alert displays. Click Yes to cancel
all changes and return to the Select Dimension Rule dialog box. Click No to return to the
Dimension Rule Manager.
See Also
View Style Properties Dialog Box (on page 59)
Launch Dimension Rule Manager (Orthographic Drawings) (on page 1504)
Properties Tab (Dimension Rule Manager) (on page 1506)
Comments Tab (Dimension Rule Manager) (on page 1512)
Relationships Tab (Dimension Rule Manager) (on page 1511)

Drawings and Reports Reference Data Guide 1503


Dimension Rule Manager

Launch Dimension Rule Manager (Orthographic


Drawings)
Follow these steps to launch the Dimension Rule Manager.
1. Click Tasks > Drawings and Reports.
2. Click Tools > Define View Style.
The Define View Style window displays.
3. Select Orthographic from the View Style Type list.

4. Select an existing view style, or click New Style to create a new view style.
5. Click Properties .
The View Style Properties dialog box displays.
6. Select More from the Dimension Rule list.
The Select Dimension Rule dialog box displays.

7. Select a dimension rule, and then click Properties.


The Dimension Rule Manager displays.
You can access the Dimension Rule Manager from the View Style Properties
dialog box. Select a template from the Dimension Rule menu, and then press F12 to
display the Dimension Rule Manager.
See Also
Dimension Rule Manager (on page 1503)
Copy a Rule (on page 86)

Launch Dimension Rule Manager (Drawings by Rule)


Follow these steps to launch the Dimension Rule Manager for drawings by rule (marine mode
only).
1. Click Tasks > Drawings and Reports.
2. Click Tools > Define View Style.
The Define View Style window displays.
3. Select RulesetStyles from the View Style Type list.

4. Select an existing view style, or click New Style to create a new view style.
5. Click Properties .

Drawings and Reports Reference Data Guide 1504


Dimension Rule Manager

The Actions tab on the Edit Ruleset View Style dialog box displays.
6. Select More from the Dimension list.
If you create a new style, you must select a ruleset and a source before you click
More. For more information, see Actions Tab (Edit Ruleset View Style Dialog Box) in the
Smart 3D Drawings and Reports Reference Data Guide.
The Select Dimension window displays.
7. Select a rule, and then click Properties.
The Dimension Rule Manager displays.
You can access the Dimension Rule Manager from the Edit Ruleset View Style
dialog box. Select a template from the Dimension menu, and then press F12 to display the
Dimension Rule Manager.

Copy a Rule
Copy a Simple Label, North Arrow, or Dimension Rule
A simple rule only has one template, and may have a single symbol file and a single
report file.
1. In the Select [Label or Dimension] Rule dialog box, select the label, north arrow, or
dimension rule to copy.
2. Click Copy.
The Copy [Label, North Arrow, or Dimension] Rule dialog box displays.
3. Type the name for the new rule in the Change Rule Name box.
Rule names do not support any character not supported by your operating
system.
The software displays all affected files in the View Changes pane and dynamically updates
the file names as you type.
4. Click Copy.
The software returns you to the Select (Label or Dimension) Rule dialog box with the
newly copied rule selected.

Copy a Compound Label, Matchline, or North Arrow Rule


A compound rule can have multiple templates and can be associated with multiple
symbol and report files.
1. In the Select Label Rule dialog box, select the label, matchline, or north arrow rule to copy.
2. Click Copy.
The Copy [Label, Matchline, or North Arrow] Rule dialog box displays.
3. Click Add Prefix or Add Suffix.
—OR—
Select both options to add a prefix and a suffix to the rule name.

Drawings and Reports Reference Data Guide 1505


Dimension Rule Manager

The software populates the Change Rule Name box with the existing name and positions
the cursor according to your selection.
4. Type to add the prefix or suffix to the rule name.
Rule names do not support any character not supported by your operating
system.
The software displays all affected files in the View Changes display and dynamically
updates the file names as you type.
5. Click Copy.
The software returns you to the Select Label Rule dialog box with the newly copied rule
selected.

 You cannot copy a template if you do not have certain permissions. For example, if you do
not have write permissions to the Labels\Templates folder or the Dimensions\Templates
folder, then an error message displays, and the command exits.
 If the software cannot copy a label, matchline, north arrow, or dimension rule, an error
message displays and the command exits. Copy errors can occur in the following situations:
 The rule contains a template that is missing from disk.
 The rule contains one or more templates with XML errors.
 If you are copying a label associated with a formatting file (.rfm) that references a formatting
parameter file (.rfp), the .rfm and .rfp file prefixes must be identical. Otherwise, the software
does not copy the .rfp file, and the new label continues to reference the original .rfp file.
See Also
Label Rule Manager (on page 1099)
Dimension Rule Manager (on page 1503)

Properties Tab (Dimension Rule Manager)


Displays the annotation modules for the selected template, and allows you to edit the properties
that each module uses.
Modules and their properties are grouped under the following headings:
 Content (displays the Content module)
 General (displays the Annotation Control Generator module)
 Point Generation (displays the Point Generator module)
 Geometric Analysis (displays the Geometric Analyzer module)
 Positioning Common, 1, 2, and so forth (display the Positioning modules)
The modules that display depend on the template that you have selected for editing.
Under each heading, the module name displays first in the list of properties that each module
uses. Click the module name to display the associated Help for that module.
To expand or collapse the list of properties that each module uses, click the arrow on the far
right of each module name. The properties that each module uses display beneath the module
names. Click each property to display the associated Help for that property.

Drawings and Reports Reference Data Guide 1506


Dimension Rule Manager

To edit the property values, type the value into the text box next to the property. For some
properties, you can select or clear a check box next to the property. For other properties, you
can click a drop-down arrow to display a list of values to select. For still other properties, you
can toggle an option button to make your selection. After you have clicked the option button of
your choice, a small preview of the result displays next to the option buttons.
To find a property to edit, type the property name in the text box at the top of the Properties tab,
and then press ENTER or click the search button .
In the following image, the Electrical CableTray Elevation_Columns_Horizontal template is
selected for editing. The modules display on the Properties tab. Underneath the General
heading, the Preserve Text Orientation property is selected. On the right, Help automatically
displays information about the selected property.

See Also
Dimension Rule Manager (on page 1503)
Relationships Tab (Dimension Rule Manager) (on page 1511)
Comments Tab (Dimension Rule Manager) (on page 1512)

Drawings and Reports Reference Data Guide 1507


Dimension Rule Manager

Content Module (Properties tab)


Gathers the information to display within a label or dimension. Additionally, a content module
specifies dimension styles.
Content modules are highly customizable. For labels, the system uses report label files in
addition to code in the content module in order to display the label. For dimensions, code
interacts with SmartSketch in order to place the dimension value, as well apply any changes to
the appearance of the dimension. While content modules ready annotations for placement on
the drawing view, the modules do not position the annotations.
The list of supported content modules follows. Names in parentheses are as identified in the
.xml files.
 Horizontal Coordinate Dimensions (DrawingCoordDimContLinHNoReplace) (on page 1545)
 Horizontal Linear Dimensions (DrawingDimContLinHNoReplace) (on page 1546)
 Horizontal Linear Dimensions with Value Replacement (DrawingDimContentLinearH) (on
page 1547)
 Marine Linear (SMDrawingDimContentLinear) (on page 1562)
 Vertical Coordinate Dimensions (DrawingCoordDimContLinVNoReplace) (on page 1600)
 Vertical Linear Dimensions (DrawingDimContLinVNoReplace) (on page 1601)
 Vertical Linear Dimensions with Value Replacement (DrawingDimContentLinearV) (on page
1602)
See Also
Annotation Control Generator Module (Properties tab) (on page 1107)
Geometric Analyzer Module (Properties tab) (on page 1510)
Point Generator Module (Properties tab) (on page 1509)
Positioning Module (Properties tab) (on page 1510)

Annotation Control Generator Module (Properties tab)


Creates an annotation control object, either as a label control object or dimension control object,
which the system uses to represent each individual label or dimension. The annotation control
object then manages the list of positioning modules that can use that particular annotation and
keeps track of the annotation's current position at any point in time.
Only the Default (DefaultLabelControlGenerator) (on page 1265) annotation control generator is
supported for labels.
The annotation control generator modules supported for dimensions are listed below:
 Anchor to Nearest Object (DrawingSepDimGenerator) (on page 1520)
 Coordinate (DrawingCoordDimGenerator) (on page 1532)
 Default (DrawingDimGenerator) (on page 1533)
 Incremental (MHIncrementalDimGenerator) (on page 1551)
 Pipe Segments (DrawingPipeSegmentsCG) (on page 1583)

Drawings and Reports Reference Data Guide 1508


Dimension Rule Manager

See Also
Label Rule Manager (on page 1099)
Dimension Rule Manager (on page 1503)

Point Generator Module (Properties tab)


Gathers data from the 3D geometry and places points on 2D objects that need labels,
dimensions, or matchlines.
The system can generate the point on any number of object locations, depending on the point
generator module that you use. This includes, but is not limited to, the object origin, control
point, straight feature end point, and so forth. A point generator can place one or multiple points
on the same object. No annotations are created with this module.
The list of supported point generator modules follows. Names in parentheses are as identified in
the .xml files.
 2D Object Center (ISStruct2DRangePG) (on page 1513)
 3D Object Center (DrawingPointGenerator) (on page 1514)
 Between Points (ISDimensionBtwPointsPG) (on page 1522)
 Control Point Only (DrawingPGCPThenNone) (on page 1529)
 Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on page 1261)
 Default Marine Point (ISRulesetPointGenerator) (on page 1276)
 Edge to Edge (MHEdgeToEdgePG) (on page 1540)
 Hanger Key Plan Control Point then Support Location (DrawingPGKeyPlanControlPoint) (on
page 1544)
 Holes (MHPGForHoles) (on page 1545)
 Horizontal Linear Object Endpoints (DrawingPGStructHoriz) (on page 1547)
 Horizontal Object Anchor (DrawingPGAnchorHoriz) (on page 1549)
 Horizontal Routable Object (DrawingPGRoutableObjHoriz) (on page 1549)
 Linear Object Endpoints (DrawingPGLinear) (on page 1558)
 Local Coordinate System Origin (DrawingPGLocalCS) (on page 1558)
 MidPoint (ISMidPointLabelPG) (on page 1567)
 Nearest Pin (ISPinJigPointsOnNearestPin) (on page 1571)
 Note (DrawingPGByNote) (on page 1572)
 Object Corners (DrawingPGObjectCorners) (on page 1573)
 Opening Objects (DrawingPGOpeningObjects) (on page 1410)
 Penetration Plate (PenPlatePointGenerator) (on page 1580)
 Pin Jig Corners (SMDwgPinJigCornersDistancePG) (on page 1581)
 Points at Manufacturing Sketch Coordinates (MfgSketchPG) (on page 1586)
 Profile Sketch Linear Feature (ISProfileSketchFeatureLinearDimPG) (on page 1590)

Drawings and Reports Reference Data Guide 1509


Dimension Rule Manager

 Profile Sketch Radial Feature (ISProfileSketchFeatureRadialDimPG) (on page 1591)


 Template Offset (StrMfgTemplateOffsetPG) (on page 1597)
 Template Set Offset (StrMfgTemplateSetOffsetPG) (on page 1598)
 Vertical Linear Object Endpoints (DrawingPGStructVert) (on page 1603)
 Vertical Object Anchor (DrawingPGAnchorVert) (on page 1604)
See Also
Annotation Control Generator Module (Properties tab) (on page 1107)
Geometric Analyzer Module (Properties tab) (on page 1510)

Geometric Analyzer Module (Properties tab)


Evaluates the points placed by the point generator module. The selected module groups or
deletes points as needed. This module does not create any annotations.
The list of supported geometric analyzer modules follows. Names in parentheses are as
identified in the .xml files.
 Between Points (ISDimensionBetweenPointsGA) (on page 1522)
 Convert to Coordinate Dimension (SMDwgConvertToCoordDimGA) (on page 1531)
 Default (DrawingGeometricAnalyzer) (on page 1534)
 Dummy (DummyGeomAnalyzer) (on page 1540)
 Margin (DrawingGAMarginOnly) (on page 1559)
 Margin with Occluded Graphics (DrawingGAMarginOnlyWithOccludedGraphics) (on page
1561)
 Pipe Segments (DrawingGAPipeSegments) (on page 1582)
See Also
Annotation Control Generator Module (Properties tab) (on page 1107)

Positioning Module (Properties tab)


Determines the position of a dimension.
Some positioning modules consider clear space when readying dimensions for placement.
Alternatively, other positioning modules determine an absolute position at which to place the
dimension without regard to clear space.
The list of supported positioning modules follows. Names in parentheses are as identified in the
.xml files.
 Absolute Dimension Offset (DrawingDimAbsolutePos) (on page 1514)
 Absolute Margin (DrawingDimMarginPos) (on page 1516)
 Clear Space Horizontal Bottom (DrawingDimHorizBottomCS) (on page 1523)
 Clear Space Horizontal Top (DrawingDimHorizTopCS) (on page 1525)
 Clear Space Pipe Segments (DrawingDimPipeSegPos) (on page 1526)
 Clear Space Vertical Left (DrawingDimVertLeftCS) (on page 1527)

Drawings and Reports Reference Data Guide 1510


Dimension Rule Manager

 Clear Space Vertical Right (DrawingDimVertRightCS) (on page 1528)


 Incremental (MHIncDimPos) (on page 1550)
See Also
Annotation Control Generator Module (Properties tab) (on page 1107)
Content Module (Properties tab) (on page 1508)
Geometric Analyzer Module (Properties tab) (on page 1510)
Point Generator Module (Properties tab) (on page 1509)

Relationships Tab (Dimension Rule Manager)


Displays the name of the selected template and the list of rules that reference that template, as
well as the view styles that use those rules.
Information displayed on the Relationships tab helps you determine the impacts that changes
to the template can have on other label rules and view styles.
Click Reset to revert the template to the initial state. This action also discards all templates that
you have added to the rule, leaving only the original template. Click Cancel to discard all
template modifications and exit the Dimension Rule Manager. Click Save to save all changes.
Click Save & Close to save all changes and exit the Dimension Rule Manager.
See Also
Dimension Rule Manager (on page 1503)
Properties Tab (Dimension Rule Manager) (on page 1506)
Comments Tab (Dimension Rule Manager) (on page 1512)

Drawings and Reports Reference Data Guide 1511


Dimension Rule Manager

Comments Tab (Dimension Rule Manager)


Allows you to type notes that the system copies to the top of the .xml file.

Click Reset to revert the template to the initial state. Click Cancel to discard all comments and
exit the Dimension Rule Manager. Click Save to save all comments. Click Save & Close to save
all comments and exit the Dimension Rule Manager.
See Also
Dimension Rule Manager (on page 1503)
Properties Tab (Dimension Rule Manager) (on page 1506)
Relationships Tab (Dimension Rule Manager) (on page 1511)

Drawings and Reports Reference Data Guide 1512


APPENDIX C

Overview of Dimension Properties


This appendix contains descriptions of all the dimension rule properties available to apply to a
dimension created using the Drawings and Reports task. Dimension rule properties are editable
either from within the .xml template or by using the Dimension Rule Manager. Both methods of
editing the label rule are documented here.
For more information on the Dimension Rule Manager, see Dimension Rule Manager (on page
1503).

2D Object Center (ISStruct2DRangePG)


Generates a point in the middle of the 2D range of an object.

1 - Box indicating object range


2 - Point

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>ISStruct2DRangePG</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1513


Overview of Dimension Properties

3D Object Center (DrawingPointGenerator)


Places a dimension at the center of the 3D range of an object.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPointGenerator</pgModule>
</pointGeneratorSettings>

Customization
None

Absolute Dimension Offset


(DrawingDimAbsolutePos)
Positions dimensions at an absolute location.

1 - hOffset distance
2 - Dimension

Drawings and Reports Reference Data Guide 1514


Overview of Dimension Properties

1 - vOffset distance
2 - Dimension

Usage in Label or Dimension Template XML


<posModules>
<posModule value="DrawingDimAbsolutePos">
<hOffset>0.04</hOffset>
<vOffset>0.04</vOffset>
<overallOffset>0</overallOffset>
</posModule>
</posModules>

Customization
hOffset
Specifies the horizontal distance from the dimension line to the nearest dimension point in
the chain for a vertical dimension. If hOffset is positive, then the dimension line is placed at
the hOffset distance to the right of the rightmost point in the chain. If hOffset is negative,
then the dimension line is placed at the hOffset distance to the left of the leftmost point in
the chain.
vOffset
Specifies the vertical distance from the dimension line to the nearest dimension point in the
chain for a horizontal dimension. If vOffset is positive, then the dimension line is placed at
the vOffset distance above the top point in the chain. If vOffset is negative, then the
dimension line is placed at the vOffset distance below the bottom point in the chain.
overallOffset
Determines the offset for the overall dimension from the dimension chain.

Drawings and Reports Reference Data Guide 1515


Overview of Dimension Properties

Absolute Margin (DrawingDimMarginPos)


Places dimensions in the margin outside of the drawing view.

1 - Perimeter offset distance


2 - Dimension

Usage in Label or Dimension Template XML


<posModules>
<posModule value="DrawingDimMarginPos"/>
<overallOffset>0</overallOffset>
<perimeterOffset>0.01</perimeterOffset>
</posModule>
</posModules>

Customization
overallOffset
Determines the offset for the overall dimension from the dimension chain.
perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

Drawings and Reports Reference Data Guide 1516


Overview of Dimension Properties

Align (align)
Aligns dimension chains that have matching projection angles if the alignment does not overlap
another element, such as a label or a model graphic.
 Select On to align the dimensions.

1 - Dimension with Align turned off

 Select Off to place absolute positioned dimensions or to suppress aligned dimensions. This
is the default behavior.

1 - Dimension with Align turned on

Drawings and Reports Reference Data Guide 1517


Overview of Dimension Properties

 You cannot use the Align property with the Absolute Dimension Offset
(DrawingDimAbsolutePos) positioning module.
 The following control generators use the Align property.
 Coordinate (DrawingCoordDimGenerator)
 Default (DrawingDimGenerator)
 Anchor to Nearest Object (DrawingSepDimGenerator)
 The following options allow you to manually edit the .xml file:
 Type -1 to align the dimensions.
 Type 0 to suppress aligned dimensions. This is the default behavior.
 Enclose either of the above values within the following .xml tags.
<align>0</align>

Anchor (dimensionAnchor value)


A secondary dimension template that specifies additional points to include in the dimension
chain. Many delivered dimension templates have existing anchor templates. These anchor
templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates\ folder.
You can attach multiple anchor templates to the main template, or change the anchor rule that
the main template uses. To add an anchor template to the main template, or to change an
existing anchor template, perform the following steps:
1. Open the main template's rule in the Dimension Rule Manager.
Any existing anchor templates display in the Anchor text boxes. An empty Anchor text box
displays below the last populated Anchor text box.
2. To add another anchor template to the main template, type the name of a valid anchor
template in the empty Anchor text box,
-OR-

a. Click the browse button ( ) in the empty Anchor text box to access the Select a
dimension anchor window;
b. Select a dimension anchor, and then click Open to return to the Dimension Rule
Manager.
The anchor template you added displays below the existing anchor template, and another
empty Anchor text box displays below the anchor template you just added.
Delete the anchor template name in the Anchor text box to remove that anchor from
the main template.
The following examples show how you can include anchor objects that are not the subject of a
dimension chain when you place dimensions.

Drawings and Reports Reference Data Guide 1518


Overview of Dimension Properties

In the first example, a dimension is placed between two pumps. The columns are not included in
the dimension chain.

1 - Pump
2 - Column
3 - Dimension

The following example shows the anchor dimensions between the columns and the pumps.

1 - Pump
2 - Column
3 - Overall dimension
4 - Dimensions

 The overall dimension in the previous example is shown for reference.

Drawings and Reports Reference Data Guide 1519


Overview of Dimension Properties

 The following geometric analyzer modules use the Anchor property.


 Margin (DrawingGAMarginOnly)
 Margin with Occluded Graphics (DrawingGAMarginOnlyWithOccludedGraphics)
 Pipe Segments (DrawingGAPipeSegments)
 Default (DrawingGeometricAnalyzer)

Anchor to Nearest Object (DrawingSepDimGenerator)


Creates horizontal and vertical linear distance dimensions from each opening to the anchor
object nearest that opening. Anchor objects are generally grid lines when the software uses this
module.

1 - Gridlines
2 - Openings
3 - Dimension

In order for the software to anchor openings, you must use two different dimension rules. The
template for the first rule uses the Opening Objects point generator module and the Anchor to
Nearest Object (DrawingSeptDimGenerator) module. For more information, see Opening
Objects (DrawingPGOpeningObjects) (on page 1410).
This template must in turn anchor to the second rule's template. The second rule uses an
anchor template and must use either the Horizontal Object Anchor or the Vertical Object Anchor
point generator modules. Additionally, the anchor template must use the Dummy geometric
analyzer module. For more information, see Horizontal Object Anchor (DrawingPGAnchorHoriz)
(on page 1549), Vertical Object Anchor (DrawingPGAnchorVert) (on page 1604), and Dummy
(DummyGeomAnalyzer) (on page 1540).

Usage in Dimension Template XML


<annotationControlGenerator>
<acgModule>DrawingSepDimGenerator</acgModule>
</annotationControlGenerator>

Drawings and Reports Reference Data Guide 1520


Overview of Dimension Properties

Customization
overallDimension
Displays the name of the separate dimension template containing the content module that
the software uses to determine the appearance of the overall dimension.
horiz
Places dimensions that measure horizontal distances on the drawing sheet.
vert
Places dimensions that measure vertical distances on the drawing sheet.
align
Aligns dimension chains that have matching projection angles if the alignment does not
overlap another element, such as a label or a model graphic.
range
Displays the Internal Dimension, External Dimension, Range Offset, and Trim Witness
properties.
internalDimension
Places dimensions connecting to points inside a certain inward distance from the matchline,
as specified by Range Offset.
externalDimension
Place dimensions connecting to points outside of a certain inward distance from the
matchline, as specified by Range Offset.
rangeOffset
Determines the inward distance from the matchline for the boundary between objects meant
for internal (inside the view) and external (margin) dimensioning.
minimumDimension
Determines a minimum dimension distance. If a dimension is less than the specified
distance, then the software does not place a dimension in the drawing. If a dimension is less
than the specified distance and is part of a dimension chain, then the software absorbs that
dimension into the larger dimension.
priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.

Drawings and Reports Reference Data Guide 1521


Overview of Dimension Properties

Between Points (ISDimensionBetweenPointsGA)


Groups dimension points into pairs containing each point and its opposite point as placed by the
point generator module.

1 - Points for dimensioning

Usage in Label or Dimension Template XML


<geometricAnalyzerSettings>
<gaModule>ISDimensionBetweenPointsGA</gaModule>
</geometricAnalyzerSettings>

Customization
None

Between Points (ISDimensionBtwPointsPG)


Places a pair of points to be used for a dimension.

targetName = ProfileWeb
1 - Points for dimensioning

targetName = Profile TopFlange


1 - Points for dimensioning

Drawings and Reports Reference Data Guide 1522


Overview of Dimension Properties

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>ISDimensionBtwPointsPG</pgModule>
<pgModuleSettings>
<locations>
<location id="10" target="0" targetName="ProfileWeb" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
None

Clear Space Horizontal Bottom


(DrawingDimHorizBottomCS)
Places horizontal dimensions below the points that the software is dimensioning on the drawing
sheet.

1 - Minimum offset
2 - Maximum offset

Usage in Label or Dimension Template XML


<posModules>
<horiz>
<posModule value="DrawingDimHorizBottomCS">
<minOffset>0.01</minOffset>
<maxOffset>0.1</maxOffset>
</posModule>
</horiz>
</posModules>

Customization
granularity

Drawings and Reports Reference Data Guide 1523


Overview of Dimension Properties

Specifies a portion of the height of a dimension value as the basis for the increment used to
find clear space in which to position the dimension.
minOffset
Defines the minimum distance from a connection point that you can place a dimension.
maxOffset
Defines the maximum distance from a connection point that you can place a dimension.

Drawings and Reports Reference Data Guide 1524


Overview of Dimension Properties

Clear Space Horizontal Top (DrawingDimHorizTopCS)


Places a horizontal dimension above the points that the software is dimensioning on the drawing
sheet.

1 - Minimum offset
2 - Maximum offset

Usage in Label or Dimension Template XML


<posModules>
<horiz>
<posModule value="DrawingDimHorizTopCS">
<minOffset>0.01</minOffset>
<maxOffset>0.1</maxOffset>
</posModule>
</horiz>
</posModules>

Customization
minOffset
Defines the minimum distance from a connection point that you can place a dimension.
maxOffset
Defines the maximum distance from a connection point that you can place a dimension.

Drawings and Reports Reference Data Guide 1525


Overview of Dimension Properties

Clear Space Pipe Segments


(DrawingDimPipeSegPos)
Places dimensions on straight features or members along the axis in clear space inside the
drawing sheet.

1 - Minimum offset
2 - Maximum offset

Usage in Dimension Template XML


<posModules>
<posModule value="DrawingDimPipeSegPos">
<minOffset>0.01</minOffset>
<maxOffset>0.4</maxOffset>
</posModule>
</posModules>

Customization
minOffset
Defines the minimum distance from a connection point that you can place a dimension.
maxOffset
Defines the maximum distance from a connection point that you can place a dimension.
granularity
Specifies a portion of the height of a dimension value as the basis for the increment used to
find clear space in which to position the dimension.

Drawings and Reports Reference Data Guide 1526


Overview of Dimension Properties

Clear Space Vertical Left (DrawingDimVertLeftCS)


Places vertical dimensions to the left of the points that the software is dimensioning in the
drawing sheet.

1 - Minimum offset
2 - Maximum offset

Usage in Label or Dimension Template XML


<posModules>
<vert>
<posModule value="DrawingDimVertLeftCS">
<minOffset>0.01</minOffset>
<maxOffset>0.1</maxOffset>
</posModule>
</vert>
</posModules>

Customization
granularity
Specifies a portion of the height of a dimension value as the basis for the increment used to
find clear space in which to position the dimension.
minOffset
Defines the minimum distance from a connection point that you can place a dimension.
maxOffset
Defines the maximum distance from a connection point that you can place a dimension.

Drawings and Reports Reference Data Guide 1527


Overview of Dimension Properties

Clear Space Vertical Right (DrawingDimVertRightCS)


Positions vertical dimensions to the right of the points that the software is dimensioning on the
drawing sheet.

1 - Minimum offset
2 - Maximum offset

Usage in Label or Dimension Template XML


<posModules>
<vert>
<posModule value="DrawingDimVertRightCS">
<minOffset>0.01</minOffset>
<maxOffset>0.1</maxOffset>
</posModule>
</vert>
</posModules>

Customization
granularity
Specifies a portion of the height of a dimension value as the basis for the increment used to
find clear space in which to position the dimension.
minOffset
Defines the minimum distance from a connection point that you can place a dimension.
maxOffset
Defines the maximum distance from a connection point that you can place a dimension.

Drawings and Reports Reference Data Guide 1528


Overview of Dimension Properties

Control Point Only (DrawingPGCPThenNone)


Places a point for labeling or dimensioning on an object's control point. If no control point exists,
then the software does not place a label or dimension.

1 - Equipment control point


2 - Dimension

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGCPThenNone</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1529


Overview of Dimension Properties

Control Point then Local CS Origin then Center


(DrawingPGControlPoint)
Places a point for labeling or dimensioning on an object's control point. If no control point exists,
then the software places the point on the object's origin. If the origin cannot be found, then the
software places the point at the 2D-projected location of the center of the object's 3D range.

1 - Equipment origin point


2 - Dimension

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGControlPoint</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1530


Overview of Dimension Properties

Convert to Coordinate Dimension


(SMDwgConvertToCoordDimGA)
Groups key points for dimensions to coordinate system reference planes into consecutive key
points of the dimensions.

1 - Points converted to a single set of consecutive key points


2 - Distance is cumulative and dimension line is continuous

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<geometricAnalyzerSettings>
<gaModule>SMDwgConvertToCoordDimGA</gaModule>
<gaModuleSettings>
<filterCriteria pointName='FEATURE_DIMPOINT_TOP'/>
</gaModuleSettings>
</geometricAnalyzerSettings>

Customization
Based on the point name specified, the respective points are grouped.

Drawings and Reports Reference Data Guide 1531


Overview of Dimension Properties

Coordinate (DrawingCoordDimGenerator)
Generates coordinate, angular, and radial dimension content in horizontal and vertical
directions.

Usage in Label or Dimension Template XML


<annotationControlGenerator>
<acgModule>DrawingCoordDimGenerator</acgModule>
<overallDimension>
<horiz>0</horiz>
<vert>0</vert>
<align>0</align>
<range>0</range>
<internalDimension>-1</internalDimension>
<externalDimension>-1</externalDimension>
<rangeOffset>0.0</rangeOffset>
<minimumDimension>0.0</minimumDimension>
<priority>1</priority>
</annotationControlGenerator>

Customization
overallDimension
Displays the name of the separate dimension template containing the content module that
the software uses to determine the appearance of the overall dimension.
horiz
Places dimensions that measure horizontal distances on the drawing sheet.
vert
Places dimensions that measure vertical distances on the drawing sheet.
align
Aligns dimension chains that have matching projection angles if the alignment does not
overlap another element, such as a label or a model graphic.
range
Displays the Internal Dimension, External Dimension, Range Offset, and Trim Witness
properties.
internalDimension
Places dimensions connecting to points inside a certain inward distance from the matchline,
as specified by Range Offset.
externalDimension
Place dimensions connecting to points outside of a certain inward distance from the
matchline, as specified by Range Offset.
rangeOffset
Determines the inward distance from the matchline for the boundary between objects meant

Drawings and Reports Reference Data Guide 1532


Overview of Dimension Properties

for internal (inside the view) and external (margin) dimensioning.


minimumDimension
Determines a minimum dimension distance. If a dimension is less than the specified
distance, then the software does not place a dimension in the drawing. If a dimension is less
than the specified distance and is part of a dimension chain, then the software absorbs that
dimension into the larger dimension.
priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.

Default (DrawingDimGenerator)
Generates linear dimension content in horizontal and vertical directions, as well as radial and
angular dimension content. Used by most dimension templates.
You must place the control point with Show dimension turned on in order to display
the dimension in a Hangers and Support drawing.

Usage in Label or Dimension Template XML


<annotationControlGenerator>
<acgModule>DrawingDimGenerator</acgModule>
<overallDimensionValue>
<horiz>0</horiz>
<vert>0</vert>
<align>0</align>
<range>0</range>
<internalDimension>-1</internalDimension>
<externalDimension>-1</externalDimension>
<rangeOffset>0.0</externalDimension>
<mimimumDimension>0.0</minimumDimension>
<priority>1</priority>
</annotationControlGenerator>

Customization
overallDimension
Displays the name of the separate dimension template containing the content module that
the software uses to determine the appearance of the overall dimension.
horiz
Places dimensions that measure horizontal distances on the drawing sheet.
vert
Places dimensions that measure vertical distances on the drawing sheet.
align
Aligns dimension chains that have matching projection angles if the alignment does not
overlap another element, such as a label or a model graphic.

Drawings and Reports Reference Data Guide 1533


Overview of Dimension Properties

range
Displays the Internal Dimension, External Dimension, Range Offset, and Trim Witness
properties.
internalDimension
Places dimensions connecting to points inside a certain inward distance from the matchline,
as specified by Range Offset.
externalDimension
Place dimensions connecting to points outside of a certain inward distance from the
matchline, as specified by Range Offset.
rangeOffset
Determines the inward distance from the matchline for the boundary between objects meant
for internal (inside the view) and external (margin) dimensioning.
minimumDimension
Determines a minimum dimension distance. If a dimension is less than the specified
distance, then the software does not place a dimension in the drawing. If a dimension is less
than the specified distance and is part of a dimension chain, then the software absorbs that
dimension into the larger dimension.
priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.

Default (DrawingGeometricAnalyzer)
Chains dimensions together within a view based on the proximity of the objects intended for
dimensioning.

Drawings and Reports Reference Data Guide 1534


Overview of Dimension Properties

1 - Dimension
2 - Equipment objects
3 - View

Usage in Label or Dimension Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGeometricAnalyzer</gaModule>
</geometricAnalyzerSettings>

Customization
keepTopOrBottomDup
Allows you to place a label on either the topmost or bottommost object in a group of objects
aligned at identical X positions along a vertical axis.
keepLeftOrRightDup
Allows you to place a label on either the leftmost or rightmost object in a group of objects
aligned at identical Y positions along a horizontal axis.
maxDimOffset
Determines the maximum linear paper space distance between consecutive witness lines in
a linear distance dimension group.
maxWitnessLength
Controls the length of witness lines so that you can determine how far across the drawing
the line is drawn. Points that fall outside the maximum witness length are eliminated from
consideration.
overall
Places an additional dimension over each dimension chain cluster identified by the rule.
placeLines
Controls line placement through the coordinate label points along aligned objects. Use this
property to include a single label in the drawing that specifies a common elevation for
aligned objects.
keepEqualDistanceDup
Eliminates points from dimensioning consideration when multiple pairs of points are equal
distances apart (for example, when multiple objects are placed in a grid pattern). If you
select the Keep Equal Distance Duplicates check box, multiple dimensions with identical
values might appear on the drawing.

Drawings and Reports Reference Data Guide 1535


Overview of Dimension Properties

Default Marine Point (ISRulesetPointGenerator)


Places a point for labeling on the 2D curves representing a 3D object at the control point of the
object.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>ISRulesetPointGenerator</pgModule>
</pointGeneratorSettings>

Customization
None

Example
The software places profile mounting angle and profile thickness labels (circled in red) using
points created by ISRulesetPointGenerator.

Dimension Layer (dimLayer)


Represents the SmartSketch drawing layer on which the software places the dimensions for the
selected template.
Type any valid name for a SmartSketch layer in the Dimension Layer text box. The name
cannot contain white space.

1 - Dimension on layer D

 The following content modules use the Dimension Layer property.


 Horizontal Coordinate Dimensions (DrawingCoordDimContLinHNoReplace)

Drawings and Reports Reference Data Guide 1536


Overview of Dimension Properties

 Vertical Coordinate Dimensions (DrawingCoordDimContLinVNoReplace)


 Horizontal Linear Dimensions with Value Replacement (DrawingDimContentLinearH)
 Vertical Linear Dimensions with Value Replacement (DrawingDimContentLinearV)
 Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
 Vertical Linear Dimensions (DrawingDimContLinVNoReplace)
 To manually edit the .xml file, specify the layer on which you want the dimensions placed.
Enclose this value within the following .xml tags.
<dimLayer>MyDimensionLayer</dimLayer>

Display Angular (angular)


The following annotation control generators use the Display Angular (angular) property.
 Coordinate (DrawingCoordDimGenerator)
 Default (DrawingDimGenerator)
 Anchor to Nearest Object (DrawingSepDimGenerator)

Display Horizontal (horiz)


Places dimensions that measure horizontal distances on the drawing sheet.
 Select the Display Horizontal check box to place horizontal dimensions.
 Clear the Display Horizontal check box to suppress horizontal dimensions. This is the
default behavior.

1 - Equipment
2 - Columns
3 - Horizontal dimensions

 The following control generators use the Display Horizontal property:

Drawings and Reports Reference Data Guide 1537


Overview of Dimension Properties

 Coordinate (DrawingCoordDimGenerator)
 Default (DrawingDimGenerator)
 Anchor to Nearest Object (DrawingSepDimGenerator)
 The following options allow you to manually edit the .xml file:
 Type -1 to place horizontal dimensions.
 Type 0 to suppress horizontal dimensions.
 Enclose either of the above values within the following .xml tags:
<horiz>0</horiz>

Display Overall Dimensions (overall)


Places an additional dimension over each dimension chain cluster identified by the rule.
 Select On to place an additional dimension.
 Select Off to suppress additional dimensions.

1 - Overall dimension

 The following options allow you to manually edit the .xml file:
 Type -1 to place an additional dimension
 Type 0 to suppress additional dimensions. This is the default behavior.
 Enclose either value within the following .xml tags.
<overall>0</overall>

Drawings and Reports Reference Data Guide 1538


Overview of Dimension Properties

Display Vertical (vert)


Places dimensions that measure vertical distances on the drawing sheet.
 Select the Display Vertical check box to place the vertical dimension.
 Clear the Display Vertical check box to suppress vertical dimensions. This is the default
behavior.

1 - Equipment
2 - Columns
3 - Vertical dimensions

 The following modules use the Display Vertical property:


 Coordinate (DrawingCoordDimGenerator)
 Default (DrawingDimGenerator)
 Anchor to Nearest Object (DrawingSepDimGenerator)
 The following options allow you to manually edit the .xml file:
 Type -1 to place vertical dimensions.
 Type 0 to suppress vertical dimensions.
 Enclose either of the above options within the following .xml tags:
<vert>0</vert>

Drawings and Reports Reference Data Guide 1539


Overview of Dimension Properties

Dummy (DummyGeomAnalyzer)
Dummy module used for dimension anchoring and penetration plate dimensions. Point
generator modules use the dummy module to perform all geometric analyzing tasks. You must
use this module when you use the Penetration Plate (PenPlatePointGenerator) (on page 1777).

Usage in Label or Dimension Template XML


<geometricAnalyzerSettings>
<gaModule>DummyGeomAnalyzer</gaModule>
</geometricAnalyzerSettings>

Customization
None

Edge to Edge (MHEdgeToEdgePG)


Places dimensioning points on individual graphic elements for plates with an inclined edge.
Points are placed on the ends of lines and at the centers of arcs, ellipses, and circles.

1 - Plate
2 - Dimensioning points
3 - Edge dimensions

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>MHEdgeToEdgePG</pgModule>
</pointGeneratorSettings>

Drawings and Reports Reference Data Guide 1540


Overview of Dimension Properties

Customization
None

External Dimension (externalDimension)


Place dimensions connecting to points outside of a certain inward distance from the matchline,
as specified by Range Offset.
 Select True to place dimensions connecting to points outside of the specified inward
distance from the matchline as shown in the following illustration.

1 - Range offset
2 - Equipment
3 - Columns
4 - External dimensions

 Select False to suppress dimensions connecting to points within the Range Offset distance,
as shown in the following illustration.

Drawings and Reports Reference Data Guide 1541


Overview of Dimension Properties

1 - Range offset
2 - Equipment
3 - Columns

 The External Dimension property is only available if the Range property is set to On. For
more information, see Range (range) (on page 1593).
 The following annotation control generator modules use the External Dimension property.
 Coordinate (DrawingCoordDimGenerator)
 Default (DrawingDimGenerator)
 Anchor to Nearest Object (DrawingSepDimGenerator)
 The following options allow you to manually edit the .xml file:
 Type -1 to place all dimensions connecting to points outside of the range. This is the
default behavior.
 Type 0 to suppress dimensions connecting to points outside of the range.
 Enclose either of the above values within the following .xml tags.
<externalDimension>-1</externalDimension>

Drawings and Reports Reference Data Guide 1542


Overview of Dimension Properties

Granularity (granularity)
Specifies a portion of the height of a dimension value as the basis for the increment used to find
clear space in which to position the dimension.
 The Granularity setting determines the height measurements the software uses when
placing the dimensions. Select one of the following options from the Granularity list.
 Coarse - specifies a large increment. The software searches an increment of exactly
one height of the dimension value in order to find clear space in which to place the
dimension.
 Medium - specifies a medium increment. The software searches an increment of
exactly one-half the height of the dimension value in order to find clear space in which to
place the dimension.
 Fine - specifies a small increment. The software searches an increment of exactly
one-third the height of the dimension value in order to find clear space in which to place
the dimension.

1 - Label offset
2 - Coarse (.xml = 0)
3 - Medium (.xml = 1)
4 - Fine (.xml = 2)

 The following options allow you to manually edit the .xml file:
 Type 0 to specify a course setting.
 Type 1 to specify a medium setting.
 Type 2 to specify a fine setting.
 Enclose any of the above values within the following .xml tags.
<granularity>1</granularity>

Drawings and Reports Reference Data Guide 1543


Overview of Dimension Properties

Hanger Key Plan Control Point then Support Location


(DrawingPGKeyPlanControlPoint)
Places dimension points on part geometry key points for lines and circles.
This module is typically used for drawings containing pipe hangers or supports.

1 - Dimension
2 - Equipment
3 - Support origin

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGKeyPlanControlPoint</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1544


Overview of Dimension Properties

Holes (MHPGForHoles)
Places linear (hole-to-hole) and radial dimensioning points for holes at the center of arcs,
ellipses, and circles.

1 - Plate
2 - Dimensioning points
3 - Edge dimensions

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>MHPGForHoles</pgModule>
</pointGeneratorSettings>

Customization
None

Horizontal Coordinate Dimensions


(DrawingCoordDimContLinHNoReplace)
Places a horizontal coordinate dimension that is based on paper space within the matchline.

Usage in Label or Dimension Template XML


<label>
<content>
<contentModule value="DrawingCoordDimContLinHNoReplace" />
<preserveTextOrientation>0</preserveTextOrientation>
<dimStyle>ANSI</dimStyle>
<dimLayer></dimLayer>
</content>
</label>

Customization
preserveTextOrientation

Drawings and Reports Reference Data Guide 1545


Overview of Dimension Properties

Determines whether or not text always uses the dimension style setting in the label template
.xml file.
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.
dimLayer
Represents the SmartSketch drawing layer on which the software places the dimensions for
the selected template.

Horizontal Linear Dimensions


(DrawingDimContLinHNoReplace)
Places a horizontal dimension that is based on paper space in the view.

Usage in Label or Dimension Template XML


<label>
<content>
<contentModule value="DrawingDimContLinHNoReplace"/>
<preserveTextOrientation>0</preserveTextOrientation>
<dimStyle>ANSI</dimStyle>
<dimLayer>???</dimLayer>
</content>
</label>

Customization
preserveTextOrientation
Determines whether or not text always uses the dimension style setting in the label template
.xml file.
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.
dimLayer
Represents the SmartSketch drawing layer on which the software places the dimensions for
the selected template.

Drawings and Reports Reference Data Guide 1546


Overview of Dimension Properties

Horizontal Linear Dimensions with Value


Replacement (DrawingDimContentLinearH)
Places a horizontal dimension between two points in the drawing view using the calculated,
transformed value from the 3D model space to the 2D drawing space.

Usage in Label or Dimension Template XML


<label>
<content>
<contentModule value="DrawingDimContentLinearH"/>
<preserveTextOrientation>0</preserveTextOrientation>
<dimStyle>ANSI</dimStyle>
<dimLayer>???</dimLayer>
</content>
</label>

Customization
preserveTextOrientation
Determines whether or not text always uses the dimension style setting in the label template
.xml file.
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.
dimLayer
Represents the SmartSketch drawing layer on which the software places the dimensions for
the selected template.

Horizontal Linear Object Endpoints


(DrawingPGStructHoriz)
Places a vertically centered point at the left and right ends of a horizontal straight feature, such
as a pipe segment or a structural beam

1 - Vertically centered endpoint


2 - Horizontal straight feature

Drawings and Reports Reference Data Guide 1547


Overview of Dimension Properties

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGStructHoriz</pgModule>
</pointGeneratorSettings>

Customization
None

Horizontal Offset (hOffset)


Specifies the horizontal distance from the dimension line to the nearest dimension point in the
chain for a vertical dimension. If hOffset is positive, then the dimension line is placed at the
hOffset distance to the right of the rightmost point in the chain. If hOffset is negative, then the
dimension line is placed at the hOffset distance to the left of the leftmost point in the chain.

1 - Horizontal offset
2 - Dimension

 Type a value in the Horizontal Offset text box.


 The software interprets the value that you type as paper space units and not model space
units.
 To manually edit the .xml file, specify a decimal value. Enclose this value within the following
.xml tags.
<hOffset>0.0</hOffset>

Drawings and Reports Reference Data Guide 1548


Overview of Dimension Properties

Horizontal Object Anchor (DrawingPGAnchorHoriz)


Places points vertically centered at the left and right end points of a horizontal straight feature in
the drawing view.

1 - Left end point


2 - Right end point

You must use the Horizontal Object Anchor (DrawingPGAnchorHoriz) module with the Dummy
(DummyGeomAnalyzer) geometric analyzer in the same dimension anchor template. For more
information, see Dummy (DummyGeomAnalyzer) (on page 1540).
The main dimension template that anchors to the template that uses this point
generator must use the Anchor to Nearest Object (DrawingSepDimGenerator) annotation
control generator. For more information, see Anchor to Nearest Object
(DrawingSepDimGenerator) (on page 1520).

Customization
None

Horizontal Routable Object


(DrawingPGRoutableObjHoriz)
Places dimension points on routable objects that are horizontally oriented in the drawing view.
Points are placed based on the Point Location (pointLocation) (on page 1585) property.
The following piping image shows points placed for dimensioning.

1 - Piping
2 - Points for dimensions

Drawings and Reports Reference Data Guide 1549


Overview of Dimension Properties

Usage in Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGRoutableObjHoriz</pgModule>
</pointGeneratorSettings>

Customization
pointLocation
Indicates the position of dimension points placed by the Horizontal Routable Object
(DrawingPGRoutableObjHoriz) point generator module. Select Top, Center, or Bottom.

Incremental (MHIncDimPos)
Provides incremental stacked dimensioning for better manufacturing. This module must be used
with the Incremental annotation control generator module. For more information, see
Incremental (MHIncrementalDimGenerator) (on page 1551).

1 - Plate
2 - Dimensioning points
3 - Dimensions

Usage in Label or Dimension Template XML


<posModules>
<horiz>
<posModule value="MHIncDimPos">
<vOffset>0.00</vOffset>
</posModule>
</horiz>
</posModules>

Customization
vOffset

Drawings and Reports Reference Data Guide 1550


Overview of Dimension Properties

Specifies the vertical distance from the dimension line to the nearest dimension point in the
chain for a horizontal dimension. If vOffset is positive, then the dimension line is placed at
the vOffset distance above the top point in the chain. If vOffset is negative, then the
dimension line is placed at the vOffset distance below the bottom point in the chain.

Incremental (MHIncrementalDimGenerator)
Provides incremental stacked dimensioning for better manufacturing. This module must be used
with the Incremental positioning module. For more information, see Incremental
(MHIncDimPos) (on page 1550).

1 - Plate
2 - Dimensioning points
3 - Dimensions

Usage in Label or Dimension Template XML


<annotationControlGenerator>
<acgModule>MHIncrementalDimGenerator</acgModule>
</annotationControlGenerator>

Customization
horiz
Places dimensions that measure horizontal distances on the drawing sheet.
vert
Places dimensions that measure vertical distances on the drawing sheet.
angular
Determines whether to place an angular dimension based on the angle in the 3D model
instead of what is generated in the view.
radial
Determines whether to place a radial dimension using the actual 3D model radius.

Drawings and Reports Reference Data Guide 1551


Overview of Dimension Properties

horizBottom
Determines whether to place dimensions below the point that the software is dimensioning
on the drawing sheet.
horizTop
Determines whether to place dimensions above the point that the software is dimensioning
on the drawing sheet.
vertLeft
Determines whether to place dimensions to the left of the point that the software is
dimensioning on the drawing sheet.
vertRight
Determines whether to place dimensions to the right of the point that the software is
dimensioning on the drawing sheet.
align
Aligns dimension chains that have matching projection angles if the alignment does not
overlap another element, such as a label or a model graphic.
priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.

Internal Dimension (internalDimension)


Places dimensions connecting to points inside a certain inward distance from the matchline, as
specified by Range Offset.
 Select True to place dimensions connecting to points inside the specified inward distance
from the matchline, as shown in the following illustration.

Drawings and Reports Reference Data Guide 1552


Overview of Dimension Properties

1 - Range offset
2 - Equipment
3 - Columns
4 - Internal dimensions

 Select False to suppress dimensions inside the matchline, as shown in the following
illustration.

1 - Range offset
2 - Equipment
3 - Columns

The Internal Dimension property is only visible if the Range property is set to On. For more
information, see Range (range) (on page 1593).

 The following control generators use the Internal Dimension property:


 Coordinate (DrawingCoordDimGenerator)
 Default (DrawingDimGenerator)
 Anchor to Nearest Object (DrawingSepDimGenerator)
 The following options allow you to manually edit the .xml file:
 Type -1 to place all dimensions connecting to points inside of the range.
 Type 0 to suppress dimensions connecting to points inside of the range.
 Enclose either of the above values within the following .xml tags.
<internalDimension>-1</internalDimension>

Drawings and Reports Reference Data Guide 1553


Overview of Dimension Properties

Interval (interval)
Sets an interval value (in meters) for placing the template points.

 The following point generators use the Interval property.


 StrMfgTemplateOffsetPG
 StrMfgTemplateSetOffsetPG
 To manually edit the .xml file, enclose the interval value within the following .xml tags.
<interval>0.5</interval>

Keep Equal Distance Duplicates


(keepEqualDistanceDup)
Eliminates points from dimensioning consideration when multiple pairs of points are equal
distances apart (for example, when multiple objects are placed in a grid pattern). If you select
the Keep Equal Distance Duplicates check box, multiple dimensions with identical values
might appear on the drawing.
The Default (DrawingGeometricAnalyzer) geometric analyzer module uses the
Keep Equal Distance Duplicates property.
1. In the following example, the software examines the points at the same Y location, and
traverses them horizontally to find and eliminate points that are equal X distances apart from
dimensioning consideration. The software retains only the two leftmost dimension connect
points because the other pairs of points are equal distances apart.
2. Likewise, the software examines the points at the same X location, and traverses them
vertically to find and eliminate points that are equal Y distances apart from dimensioning
consideration. The software retains only the bottom two dimension connect points because
the other pairs of points are equal distances apart.

Drawings and Reports Reference Data Guide 1554


Overview of Dimension Properties

1 - Vertical connect points


2 - Horizontal connect points

Usage in Label or Dimension Template XML


<dimension>
<dimensionSettings>
<keepEqualDistanceDup>0</keepEqualDistanceDup>
</dimensionSettings>
</dimension>

Customization
None

Drawings and Reports Reference Data Guide 1555


Overview of Dimension Properties

Keep Left or Right Duplicate (keepLeftOrRightDup)


Eliminates points from dimensioning consideration when multiple pairs of points are aligned at
identical Y positions along a horizontal axis.
If you select Left, the software only considers the leftmost point in a horizontally aligned set of
points for dimensioning. If you select Right, the software only considers the rightmost point in a
horizontally aligned set of points for dimensioning.

1 - Left duplicate
2 - Right duplicate

Usage in Label or Dimension Template XML


<dimension>
<dimensionSettings>
<keepLeftOrRightDup>0<keepLeftOrRightDup>
</dimensionSettings>
</dimension>

Customization
None

Drawings and Reports Reference Data Guide 1556


Overview of Dimension Properties

Keep Top or Bottom Duplicate


(keepTopOrBottomDup)
Eliminates points from dimensioning consideration when multiple pairs of points are aligned at
identical X positions along a vertical axis.
If you select Top, the software only considers the top point in a vertically aligned set of points for
dimensioning. If you select Bottom, the software only considers the bottom point in a vertically
aligned set of points for dimensioning.

1 - Top duplicate
2 - Bottom duplicate

Usage in Label or Dimension Template XML


<dimension>
<dimensionSettings>
<keepTopOrBottomDup>0<keepTopOrBottomDup>
</dimensionSettings>
</dimension>

Customization
None

Drawings and Reports Reference Data Guide 1557


Overview of Dimension Properties

Linear Object Endpoints (DrawingPGLinear)


Places a dimension or label at both ends of a pipe segment, structure member, or grid line.

1 - Structural member
2 - Endpoints

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGLinear</pgModule>
</pointGeneratorSettings>

Customization
None

Local Coordinate System Origin (DrawingPGLocalCS)


Places a point for labeling or dimensioning on an object's coordinate system origin.

Drawings and Reports Reference Data Guide 1558


Overview of Dimension Properties

1 - Equipment origin point


2 - Dimension

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGLocalCS</pgModule>
</pointGeneratorSettings>

Customization
None

Location Target Name (targetName)


Identifies the location name and target defined by several point generator modules.

Margin (DrawingGAMarginOnly)
Chains a group of dimensions into the appropriate margins based on the position at which the
software places the dimensioning points.
In the following example, the amount of space between the dimension lines of the first and third
dimensions in the chain allows the software to embed the measurements.
Very little space exists between the second set of dimension lines. Therefore, the software
rotates the measurement vertically and places it above the chain.
Likewise, the fourth set of dimension lines has a small amount of space. In this case, the
measurement is rotated; however, there is enough space for the software to embed the
measurement.

1 - Dimension embedded in chain


2 - Dimension rotated and placed above chain
3 - Dimension rotated and embedded in chain

Drawings and Reports Reference Data Guide 1559


Overview of Dimension Properties

Usage in Label or Dimension Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGAMarginOnly</gaModule>
</geometricAnalyzerSettings>

Customization
keepTopOrBottomDup
Allows you to place a label on either the topmost or bottommost object in a group of objects
aligned at identical X positions along a vertical axis. If the value for keepTopOrBottomDup
is 0, then only the topmost point of an aligned set of points is considered for dimensioning. If
the value is set to -1, then only the bottommost point of an aligned set of points is
considered for dimensioning.
keepLeftOrRightDup
Allows you to place a label on either the leftmost or rightmost object in a group of objects
aligned at identical Y positions along a horizontal axis. If the value for keepLeftOrRightDup
is set to 0, then only the leftmost point in a horizontally aligned set of points is considered in
dimensioning. If the value is set to -1, then only the rightmost point in a horizontally aligned
set of points is considered for dimensioning.
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
maxDimOffset
Determines the maximum linear paper space distance between consecutive witness lines in
a linear distance dimension group.
maxWitnessLength
Controls the length of witness lines so that you can determine how far across the drawing
the line is drawn. Points that fall outside the maximum witness length are eliminated from
consideration.
overall
Places an additional dimension over each dimension chain cluster identified by the rule.
trimWitness
Determines whether or not a dimension witness line extends into the drawing view to the
dimensioned object or stops at the drawing view. If the trimWitness value is selected, then
the software trims the dimension witness lines. If the value is cleared, then the dimension
witness lines continue into the drawing view to the dimensioned objects.

Drawings and Reports Reference Data Guide 1560


Overview of Dimension Properties

Margin with Occluded Graphics


(DrawingGAMarginOnlyWithOccludedGraphics)
Chains a group of dimensions into the appropriate margins based on the position at which the
software places the dimensioning points. If multiple model objects exist at the same X and Y
coordinates but at different Z coordinates, the module uses the dimensioning point at the highest
Z coordinate for sorting consistency.

1 - Grid lines at same XY coordinates


2 - Dimension point at highest Z coordinate

Usage in Label or Dimension Template XML


<geometricAnalyzerSettings>
<gaModule value="DrawingGAMarginOnlyWithOccludedGraphics">
</gaModule>
/geometricAnalyzerSettings>

Customization
None

Drawings and Reports Reference Data Guide 1561


Overview of Dimension Properties

Marine Linear (SMDrawingDimContentLinear)


Places a linear dimension parallel to an imaginary line drawn between two dimensioning points,
and replaces the value of the dimension with the distance between two dimensioning points in
the 3D model.

Usage in Label or Dimension Template XML

<dimensionContentModules>
<horiz>SMDrawingDimContentLinear</horiz>
<vert>SMDrawingDimContentLinear</vert>
<preserveTextOrientation>0</preserveTextOrientation>
<dimStyle>ANSI</dimStyle>
<dimLayer>???</dimLayer>
</dimensionContentModules>

Customization
preserveTextOrientation
Determines whether or not text always uses the dimension style setting in the label template
.xml file.
In the Preserve Text Orientation property, select On to force the text to follow the style
setting of the dimension or label template .xml file. Select Off to rotate and move the text
away from the dimension line when not enough clear space exists.
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.
dimLayer
Represents the SmartSketch drawing layer on which the software places the dimensions for
the selected template.

Drawings and Reports Reference Data Guide 1562


Overview of Dimension Properties

Maximum Dimension Offset (maxDimOffset)


Determines the maximum linear paper space distance between consecutive witness lines in a
linear distance dimension group.

1 - Dimension placed between objects that do not


exceed maximum offset
2 - Dimension not placed because distance between 3
and 4 exceeds maximum offset
3 - Object
4 - Object
5 - Object

To specify the maximum dimension offset, type a decimal value in the text box.

 The software interprets the value that you type as paper space units and not model space
units.
 To manually edit the .xml file, specify a decimal value. Enclose this value within the following
.xml tags.
<maxDimOffset>0.0</maxDimOffset>

Drawings and Reports Reference Data Guide 1563


Overview of Dimension Properties

Maximum Offset (maxOffset)


Specifies the maximum distance from the dimension line to the nearest point in the dimension
chain. The Maximum Offset property behavior is specific to the dimension chain type.
Maximum Offset behavior for horizontal dimension chains
 Above dimension points - the distance between the dimension line and the highest point
in the dimension chain.

1 - Horizontal dimension above points


2 - Offset

 Below dimension points - the distance between the dimension line and the lowest point in
the chain.

1 - Horizontal dimension below points


2 - Offset

Drawings and Reports Reference Data Guide 1564


Overview of Dimension Properties

Vertical Offset behavior for vertical dimension chains


 To the right of dimension points - the distance between the dimension point and the
right-most point in the dimension chain.

1 - Vertical dimension, right side


2 - Offset

 To the left of dimension points - the distance between the dimension point and the
left-most point in the dimension chain.

1 - Vertical dimension, left side


2 - Offset

 Type a value in the Maximum Offset text box.


 The software interprets the value that you type as paper space units and not model space
units.
 To manually edit the .xml file, specify a decimal value. Enclose this value within the following
.xml tags:

Drawings and Reports Reference Data Guide 1565


Overview of Dimension Properties

<maxOffset>0.1</maxOffset>

Maximum Witness Length (maxWitnessLength)


Controls the length of witness lines so that you can determine how far across the drawing the
line is drawn. Points that fall outside the maximum witness length are eliminated from
consideration.
The following example contains a horizontal dimension group. The maximum witness length
extends downward from the dimension point that has the highest Y value on the drawing sheet.
The objects that fall outside the defined maximum witness length are excluded from the
dimension group.

1 - Object within maximum witness length range


2 - Dimension
3 - Object outside maximum witness length range
4 - Maximum witness length range

The next example contains a vertical dimension group with horizontal witness lines. Here, the
maximum witness length extends leftward from the dimension point with the highest X value on
the drawing sheet. Points outside of that value are excluded from the dimension group.

Drawings and Reports Reference Data Guide 1566


Overview of Dimension Properties

1 - Object outside maximum witness length range


2 - Object inside maximum witness length range
3 - Dimension
4 - Maximum witness length range

To specify the maximum witness line length, type a decimal value in the text box.

 The software interprets the value that you type as paper space units and not model space
units.
 To manually edit the .xml file, specify a decimal value. Enclose this value within the following
.xml tags.
<maxWitnessLength>0.0</maxWitnessLength>

MidPoint (ISMidPointLabelPG)
Places a label point on the 2D curves representing a 3D object at the center of the range box of
the object.

Usage in Dimension or Label Template XML


<pointGeneratorSettings>
<pgModule>ISMidPointLabelPG</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1567


Overview of Dimension Properties

Minimum Dimension Distance (minimumDimension)


Determines a minimum dimension distance. If a dimension is less than the specified
distance, then the software does not place a dimension in the drawing. If a dimension is less
than the specified distance and is part of a dimension chain, then the software absorbs that
dimension into the larger dimension.
The surrounding dimension that absorbs the smaller dimension is determined by the
direction of the dimension. For vertical dimensions, the smaller dimension is absorbed by
the larger dimension underneath it. For horizontal dimensions, the smaller dimension is
absorbed by the larger dimension to its left.
To specify the minimum dimension, type a decimal value in the text box.

1 - Dimension
2 - Distance less than minimum dimension
3 - Smaller dimension (2) absorbed by larger dimension (3)
on the left

Drawings and Reports Reference Data Guide 1568


Overview of Dimension Properties

 The software interprets the value that you type as paper space units and not model space
units.
 To manually edit the .xml file, specify the minimum dimension. Enclose this value within the
following .xml tags.
<minimumDimension>0.0</minimumDimension>

Minimum Offset (minOffset)


Specifies the minimum distance from the dimension line to the nearest point in the dimension
chain. The Minimum Offset property behavior is specific to the dimension chain type.
Minimum Offset behavior for horizontal dimension chains
 Above dimension points - the distance between the dimension line and the highest point
in the dimension chain.

1 - Horizontal dimension above points


2 - Offset

 Below dimension points - the distance between the dimension line and the lowest point in
the chain.

1 - Horizontal dimension below points


2 - Offset

Vertical Offset behavior for vertical dimension chains


 To the right of dimension points - the distance between the dimension point and the
right-most point in the dimension chain.

Drawings and Reports Reference Data Guide 1569


Overview of Dimension Properties

1 - Vertical dimension, right side


2 - Offset

 To the left of dimension points - the distance between the dimension point and the
left-most point in the dimension chain.

1 - Vertical dimension, left side


2 - Offset

 Type a value in the Minimum Offset text box.


 The software interprets the value that you type as paper space units and not model space
units.
 To manually edit the .xml file, specify a decimal value. Enclose this value within the following
.xml tags:
<minOffset>0.01</minOffset>

Drawings and Reports Reference Data Guide 1570


Overview of Dimension Properties

Nearest Pin (ISPinJigPointsOnNearestPin)


Places points on the intersection point and its nearest pin.

1 - Points for dimensioning

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>ISPinJigPointsOnNearestPin</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1571


Overview of Dimension Properties

Note (DrawingPGByNote)
Generates points on individual objects for dimensioning using the General Notes and Catalog
Notes related to those objects and any design children. DrawingPGByNote allows placement of
a dimension from one point of an object to another point on the same object, such as
dimensions needed for individual hanger support components.

1 - Dimension points on single object


2 - Dimension point on the same object
3 - Dimension

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGByNote</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1572


Overview of Dimension Properties

Object Corners (DrawingPGObjectCorners)


Places points at the four corners of an object's range in order to anchor matchlines to other
dimensioned objects.

1 - Object
2 - Points at corners of range box

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGObjectCorners</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1573


Overview of Dimension Properties

Offset from Range (overall)


Determines whether to offset the dimension value from points placed for the profile sketch
dimension, or to offset the dimension from the edge of the range.

1 - Offset from points


2 - Offset from range

 The following point generators use the Offset from Range property:
 Profile Sketch Linear Feature (ISProfileSketchFeatureLinearDimPG) (on page 1590)
 Points at Manufacturing Sketch Coordinates (MfgSketchPG) (on page 1586)
 The following options allow you to manually edit the .xml file:
 Type 1 to offset the dimension from the range. This can place the dimension farther
from the object edge.
 Type 0 to offset the dimension from the points. This can place the dimension closer to
the actual edge of the object.
 Enclose either value within the following .xml tags:
<overall>0</overall>

See Also
Profile Sketch Linear Feature (ISProfileSketchFeatureLinearDimPG) (on page 1590)
Points at Manufacturing Sketch Coordinates (MfgSketchPG) (on page 1586)

Drawings and Reports Reference Data Guide 1574


Overview of Dimension Properties

Opening Objects (DrawingPGOpeningObjects)


Generates dimension points for certain types of openings. The placement of points on the
opening depends on the type of opening that you are dimensioning. Alternately, the points are
placed at range vertex points.
You can generate dimension points for the following types of openings.
 Rectangle. The software generates points at each corner of the opening. The angles of the
rectangle must be 90 degrees.

1 - Dimension points
2 - Rectangular opening

 Circle. The software generates a point in the center of the opening.


The software does not support dimensioning ellipses.

1 - Circular opening
2 - Dimension point

 Square and rounded corners. The software generates points at the expected intersection of
the lines. The arc angle must be 90 degrees.

1 - Dimension points
2 - Opening with rounded corners

Drawings and Reports Reference Data Guide 1575


Overview of Dimension Properties

 Slot. The software generates points at the ends of each arc. The arc angle must be 180
degrees.

1 - Dimension points
2 - Slotted opening

Usage in Dimension and Label Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGOpeningObjects</pgModule>
</pointGeneratorSettings>

Customization
None

Orientation (orientation)
Specifies the positional orientation of the dimension with respect to the dimensioned object.
Select one of the following options from the Orientation list.
 Top - places a horizontal dimension at the top of the view
 Bottom - places a horizontal dimension at the bottom of the view
 Left - places a vertical dimension on the left side of the view
 Right - places a vertical dimension on the right side of the view
 Undefined - does not place a dimension

Drawings and Reports Reference Data Guide 1576


Overview of Dimension Properties

1 - Top
2 - Bottom
3 - Left
4 - Right

 The following options allow you to edit the .xml file.


 Type 0 to prevent the software from placing a dimension.
 Type 1 to place a horizontal dimension at the top of the view.
 Type 2 to place a horizontal dimension at the bottom of the view.
 Type 3 to place a vertical dimension on the left side of the view.
 Type 4 to place a vertical dimension on the right side of the view.
 Enclose any of the values listed above within the following .xml tags:
<orientation>0</orientation>

Drawings and Reports Reference Data Guide 1577


Overview of Dimension Properties

Overall Dimension (overallDimension value)


Displays the name of the separate dimension template containing the content module that the
software uses to determine the appearance of the overall dimension.
Type a string designating the overall dimension template name, excluding the .xml extension, in
the textbox.

 The following control generator modules use the Overall Dimension property.
 Coordinate (DrawingCoordDimGenerator)
 Default (DrawingDimGenerator)
 Anchor to Nearest Object (DrawingSepDimGenerator)
 To manually edit the .xml file, type the value designating the template name. Enclose this
value within the following .xml tag.
<overallDimension value="Linear A HV" />

Overall Offset (overallOffset)


Determines the offset for the overall dimension from the dimension chain.
To specify an offset, type a decimal value in the text box.

1 - Overall dimension
2 - Offset distance

 The software interprets the value that you type as paper space units and not model space
units.

Drawings and Reports Reference Data Guide 1578


Overview of Dimension Properties

 To manually edit the .xml file, specify an offset. Enclose this value within the following .xml
tags.
<overallOffset>0</overallOffset>

Override (ISDimensionContentOverride)
Places a horizontal dimension between two points on a non-scale drawing, such as a profile
sketch drawing. The distance between the points is determined from the model, and a string
with that value overrides the incorrect value of the not-to-scale dimension. This module is
typically used with the Between Points (ISDimensionBtwPointsPG) (on page 1753) point
generator and the Between Points (ISDimensionBetweenPointsGA) (on page 1788)
geometric analyzer.

Usage in Label or Dimension Template XML


<dimension>
<dimensionContentModules>
<horiz>ISDimensionContentOverride</horiz>
<dimStyle>ANSI</dimStyle>
</dimensionContentModules>
</dimension>

Customization
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.

Parse Graphics (parseGraphics)


Specifies whether to determine dimension point locations by examining object graphics or by
using the pgTransform XSLT information in the template.

 The Points at Manufacturing Sketch Coordinates (MfgSketchPG) (on page 1586) point
generator module uses the Parse Graphics property.
 Select the Parse Graphics check box to process the graphics and forward them to the
Penetration Plate (PenPlatePointGenerator) (on page 1580) point generator module.
 The following options allow you to manually edit the .xml file:
 Type -1 to process the graphics and forward them to the Penetration Plate
(PenPlatePointGenerator) (on page 1580) point generator module.
 Type 0 to process the pgTransform information.
 Enclose either value within the following .xml tags:
<parseGraphics>0</parseGraphics>

See Also
Penetration Plate (PenPlatePointGenerator) (on page 1580)
Points at Manufacturing Sketch Coordinates (MfgSketchPG) (on page 1586)

Drawings and Reports Reference Data Guide 1579


Overview of Dimension Properties

Penetration Plate (PenPlatePointGenerator)


Custom point generator used by ISO process to dimension a penetration plate. This module also
performs the functions of a geometric analyzer and must be used with DummyGeomAnalyzer.
For more information, see Dummy (DummyGeomAnalyzer) (on page 1540).

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>PenPlatePointGenerator</pgModule>
</pointGeneratorSettings>

Perimeter Offset (perimeterOffset)


Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.
Specify the distance to apply the Perimeter Offset property.

1 - Perimeter offset distance


2 - Dimension

Drawings and Reports Reference Data Guide 1580


Overview of Dimension Properties

 This property applies when you place the label or dimension using a positioning module.
The following label positioning modules use this property:
 Clear Space Margin (DrawingMarginOnly)
 Absolute Grid Margin (DrawingGridLblMgnAbsPos)
 Clear Space Grid Margin (DrawingGridLblMarginOnly)
 Clear Space Clipped (DwgClippedPositioning)
 Clear Space Margin with Dimensions (DwgMatchlineWithDim)
 Clear Space Position by 2D Curve at Margin (ISDwgPositionByCurve2DAtMargin)
 Clear Space Position Marine Grid Label at Margin (SMDwgPositionGridLblMarginOnly)
 The Absolute Margin (DrawingDimMarginPos) dimension positioning module uses this
property.
 This property places the label or dimension within the margin outside of the view, instead of
within the boundaries of the view.
 The software interprets the distance from the edge of the view to the dimension line or edge
of the label as paper space units and not as model space units.
 You must specify a positive distance value, and the value must be greater than 0.000001 m.
 To manually edit the .xml file, specify the distance that you want offset from the edge of the
view to the dimension line or edge of the label. Enclose this value within the following .xml
tags.
<perimeterOffset>0.01</perimeterOffset>

Pin Jig Corners (SMDwgPinJigCornersDistancePG)


Custom point generator that collects the corner points on a pin jig contour remarking line and
places points to dimension the distance between these corner points.

1 - Dimension between corner points


2 - Corner points

Drawings and Reports Reference Data Guide 1581


Overview of Dimension Properties

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>SMDwgPinjigCornersDistancePG</pgModule>
</pointGeneratorSettings>

Customization
None

Pipe Segments (DrawingGAPipeSegments)


Groups dimensions for pipe segments of any angle into chained families. The software places
the dimensions within the drawing view.

Dimensioned pipe segments

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<geometricAnalyzerSettings>
<gaModule value="DrawingGAPipeSegments">
<horiz>0</horiz>
<vert>0</vert>
<maxDimOffset>0.0</maxDimOffset>
<maxWitnessLength>0.0</maxWitnessLength>
<overall>0</overall>
</gaModule>
</geometricAnalyzerSettings>

Customization
horiz
Places dimensions that measure horizontal distances on the drawing sheet.
vert
Places dimensions that measure vertical distances on the drawing sheet.

Drawings and Reports Reference Data Guide 1582


Overview of Dimension Properties

maxDimOffset
Determines the maximum linear paper space distance between consecutive witness lines in
a linear distance dimension group.
maxWitnessLength
Controls the length of witness lines so that you can determine how far across the drawing
the line is drawn. Points that fall outside the maximum witness length are eliminated from
consideration.
overall
Places an additional dimension over each dimension chain cluster identified by the rule.

Pipe Segments (DrawingPipeSegmentsCG)


Control generator used for pipe segments. Generates linear dimension content at any angle.

Usage in Label or Dimension Template XML


<annotationControlGenerator>
<acgModule value="DrawingPipeSegmentsCG"
<align>0</align>
<priority>1</priority>
</acgModule>
</annotationControlGenerator>

Customization
align
Aligns dimension chains that have matching projection angles if the alignment does not
overlap another element, such as a label or a model graphic.
priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.

Drawings and Reports Reference Data Guide 1583


Overview of Dimension Properties

Place Lines (placeLines)


Controls line placement through dimension points that are aligned horizontally or vertically on
the drawing sheet. Use this option to place a line that is separate from the dimension but aligned
with the dimension's witness line.
 If you select On, the software places a separate line through all vertically or horizontally
aligned dimension points.

1 - Equipment object
2 - Lines

 If you select Off, the software does not place a separate line through multiple aligned
objects.

1 - Equipment object

Drawings and Reports Reference Data Guide 1584


Overview of Dimension Properties

 You can place lines in a vertical or horizontal direction, depending on the alignment of the
objects. However, diagonal placement for diagonally aligned objects is not supported.
 The following dimension geometric analyzer modules use the Place Lines property:
 Default (DrawingGeometricAnalyzer)
 Margin (DrawingGAMarginOnly)
 The following options allow you to manually edit the .xml file:
 Type -1 to place lines.
 Type 0 to suppress lines.
 Enclose either of the above values within the following .xml tags.
<placeLines>-1</placeLines>

Point Location (pointLocation)


Indicates the position of dimension points placed by the Horizontal Routable Object
(DrawingPGRoutableObjHoriz) point generator module. Select Top, Center, or Bottom.
The following image shows points placed on an object.

1 - Top
2 - Center
3 - Bottom

 The Horizontal Routable Object (DrawingPGRoutableObjHoriz) point generator uses the


Point Location property. For more information, see Horizontal Routable Object
(DrawingPGRoutableObjHoriz) (on page 1549).
 The following options allow you to manually edit the .xml file:
 Top - places points at the top left and top right of the object
 Center - places points at the middle left and middle right of the object
 Bottom - places points at the bottom left and bottom right of the object

Drawings and Reports Reference Data Guide 1585


Overview of Dimension Properties

 Enclose one of the above options within the following .xml tags:
<pointLocation>Center</pointLocation>

Point Name (filterCriteriaPointName)


The geometric analyzer SMDwgConvertToCoordDimGA uses the Point Name property.

Points at Manufacturing Sketch Coordinates


(MfgSketchPG)
Places points based on coordinate values in the manufacturing data XML created in the
Structural Manufacturing task. Alternately, the property places points according to the behavior
of the Penetration Plate (PenPlatePointGenerator) (on page 1580) property depending on how
the parseGraphics property is set.

Usage in Dimension Template XML


<pointGeneratorSettings>
<pgModule>MfgSketchPG</pgModule>
<pgModuleSettings>
<parseGraphics>0</parseGraphics>
<pgTransform>
...
</pgTransform>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
maxDimOffset
Determines the maximum linear paper space distance between consecutive witness lines in
a linear distance dimension group.
maxWitnessLength
Controls the length of witness lines so that you can determine how far across the drawing
the line is drawn. Points that fall outside the maximum witness length are eliminated from
consideration.
overall
Specifies whether to connect the dimension witness line end points to the corners of the
dimensioned object’s range or to the points placed by the module. Set the value to 1 to
connect to the object’s range. Set the value to 0 to connect to the points.
parseGraphics
Specifies whether to determine dimension point locations by examining object graphics or
by using the pgTransform XSLT information in the template. Set the value to -1 to process
the graphics and forward them to the Penetration Plate (PenPlatePointGenerator) point
generator module. Set the value to 0 to process the pgTransform information.

Drawings and Reports Reference Data Guide 1586


Overview of Dimension Properties

Preserve Text Orientation (preserveTextOrientation)


Determines whether or not text always uses the dimension style setting in the label template
.xml file.
In the Preserve Text Orientation property, select On to force the text to follow the style setting
of the dimension or label template .xml file. Select Off to rotate and move the text away from the
dimension line when not enough clear space exists.

1 - Non-rotated dimension text


2 - Dimension text with Preserve Text
Orientation turned on
3 - Equipment object

Drawings and Reports Reference Data Guide 1587


Overview of Dimension Properties

1 - Non-rotated dimension text


2 - Dimension text with Preserve Text
Orientation turned off
3 - Equipment object

 The following content modules use the Preserve Text Orientation property.
 Vertical Coordinate Dimensions (DrawingCoordDimContLinVNoReplace)
 Horizontal Coordinate Dimensions (DrawingCoordDimContLinHNoReplace)
 Vertical Linear Dimensions (DrawingDimContLinVNoReplace)
 Horizontal Linear Dimensions (DrawingDimContLinHNoReplace)
 Horizontal Linear Dimensions with Value Replacement (DrawingDimContentLinearH)
 Vertical Linear Dimensions with Value Replacement (DrawingDimContentLinearV)
 The following options allow you to manually edit the .xml file:
 Type -1 to preserve the text orientation.
 Type 0 to allow the software to rotate the dimension text.
 Enclose either of the above values within the following .xml tags.
<preserveTextOrientation>0</preserveTextOrientation>

Drawings and Reports Reference Data Guide 1588


Overview of Dimension Properties

Priority (priority)
Determines the order in which the software places an annotation based on available clear space
and proximity to other annotations. Additionally, label and dimension priorities are considered
globally, which means that you can give preference to dimensions over labels and so forth.

1 - Equipment labels placed with Priority set to 1


2 - Structure label placed with Priority set to 2

1 - Equipment label placed with Priority set to 2


2 - Structure label placed with Priority set to 1

To manually edit the .xml file, specify a positive integer to assign as a priority number for each
annotation. Enclose this value within the following .xml tags.
<priority>1</priority>

Drawings and Reports Reference Data Guide 1589


Overview of Dimension Properties

Profile Sketch Linear Feature


(ISProfileSketchFeatureLinearDimCM)
Places a horizontal dimension on a profile feature, such as an edge or corner feature, on a
profile sketch drawing. Profile Sketch Linear Feature (ISProfileSketchFeatureLinearDimPG) (on
page 1760) creates points for the dimension.

Usage in Label or Dimension Template XML


<dimension>
<dimensionContentModules>
<horiz>ISProfileSketchFeatureLinearDimCM</horiz>
<dimStyle>ANSI</dimStyle>
</dimensionContentModules>
</dimension>

Customization
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.

Profile Sketch Linear Feature


(ISProfileSketchFeatureLinearDimPG)
Places points for linear distance dimensioning on profile sketch drawings.

1 - Points for dimensioning

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>ISProfileSketchFeatureLinearDimPG</pgModule>
</pointGeneratorSettings>

Customization
overall
Specifies whether to connect the dimension witness line end points to the corners of the
dimensioned object’s range or to the points placed by the module. Set the value to 1 to

Drawings and Reports Reference Data Guide 1590


Overview of Dimension Properties

connect to the object’s range. Set the value to 0 to connect to the points.

Profile Sketch Radial Feature


(ISProfileSketchFeatureRadialDimCM)
Places a radial dimension on a profile feature, such as an edge or corner feature, on a profile
sketch drawing. Profile Sketch Radial Feature (ISProfileSketchFeatureRadialDimPG) (on page
1761) creates points for the dimension.

Usage in Label or Dimension Template XML

<dimension>
<dimensionContentModules>
<horiz>ISProfileSketchFeatureRadialDimCM</horiz>
<dimStyle>ANSI</dimStyle>
</dimensionContentModules>
</dimension>

Customization
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.

Profile Sketch Radial Feature


(ISProfileSketchFeatureRadialDimPG)
Places points for radial dimensioning on profile sketch drawings.

1 - Dimensioning point

Drawings and Reports Reference Data Guide 1591


Overview of Dimension Properties

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>ISProfileSketchFeatureRadialDimPG</pgModule>
</pointGeneratorSettings>

Customization
None

Radial Dimensions with Value Replacement


(DrawingDimContentRadial)
Places a radial dimension using the actual 3D model radius. Only the penetration plate
dimensioning function in Piping Isometric Drawings uses this module.

Usage in Label or Dimension Template XML


<label>
<content>
<contentModule value="DrawingDimContentRadial"/>
<preserveTextOrientation>0</preserveTextOrientation>
<dimStyle>ANSI</dimStyle>
<dimLayer>???</dimLayer>
</content>
</label>

Customization
preserveTextOrientation
Determines whether or not text always uses the dimension style setting in the label template
.xml file.
In the Preserve Text Orientation property, select On to force the text to follow the style
setting of the dimension or label template .xml file. Select Off to rotate and move the text
away from the dimension line when not enough clear space exists.
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.
dimLayer
Represents the SmartSketch drawing layer on which the software places the dimensions for
the selected template.

Drawings and Reports Reference Data Guide 1592


Overview of Dimension Properties

Range (range)
Displays the Internal Dimension, External Dimension, Range Offset, and Trim Witness
properties.
 Select On to display other range-related properties.
In the following image, On is selected. Therefore, the External Dimension, Internal
Dimension, Range Offset, and Trim Witness properties are available. For more
information, see External Dimension (externalDimension) (on page 1541), Internal
Dimension (internalDimension) (on page 1552), Range Offset (rangeOffset) (on page 1594),
and Trim Witness (trimWitness) (on page 1599).

1 - Range offset
2 - Equipment within internal range
3 - Columns within external range
4 - External dimensions
5 - Internal dimensions

 Select Off to suppress other range-related properties. This is the default behavior.

 The following modules are available only when the Range property is set to On.
 External Dimension
 Internal Dimension
 Range Offset
 Trim Witness
 The following annotation control generators use the Range property.
 Coordinate (DrawingCoordDimGenerator)
 Default (DrawingDimGenerator)
 Pipe Segments (DrawingPipeSegmentsCG)

Drawings and Reports Reference Data Guide 1593


Overview of Dimension Properties

 The following options allow you to manually edit the .xml file:
 Type -1 to display other range-related properties.
 Type 0 to suppress other range-related properties.
 Enclose either option within the following .xml tags.
<range>0</range>

Range Offset (rangeOffset)


Determines the inward distance from the matchline for the boundary between objects meant for
internal (inside the view) and external (margin) dimensioning. This property is available only
when the Range (range) (on page 1593) property is set to On.

1 - Range offset
2 - Equipment within internal range
3 - Columns within external range
4 - External dimensions
5 - Internal dimensions

To specify the range offset value, type a decimal value in the Range Offset text box.

 The software interprets the value that you type as paper space units and not model space
units.
 A rangeOffset value of 0.03 specifies whether objects are treated as internal or external
dimensioning points.
 Objects more than 3 cm inward from the matchline are treated as internal dimensioning
points.

Drawings and Reports Reference Data Guide 1594


Overview of Dimension Properties

 Objects less than 3 cm inward from the matchline are treated as external dimensioning
points.
 The rangeOffset value in the .xml file is only valid when the range property is selected.
Otherwise, the software ignores the property.
 To manually edit the .xml file, specify a value. Enclose this value within the following .xml
tags.
<rangeOffset>0.0</rangeOffset>

Style (dimStyle)
Defines the appearance of a leader line. To choose a default style delivered with the software,
select the style to apply to the leader line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

Drawings and Reports Reference Data Guide 1595


Overview of Dimension Properties

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ISISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ISISO 2.5x: Applies a thick, solid, dark cyan line style with a small, filled arrow terminator to
the leader line.

 ISISO_Slash: Applies a thick, solid, dark cyan line style with a slash terminator to the leader
line.

 ISISO_Slash_Red: Applies a thick, solid, red line style with a slash terminator to the leader
line.

 ISIS0Right 2.5x: Applies a thin, solid, dark cyan line style with a small, filled arrow
terminator to the leader line.

 ISORight: Applies a thin, solid, dark cyan line with a large, filled arrow terminator to the
leader line.

 The following content modules use the Style property.


 DrawingCoordDimContLinHNoReplace
 DrawingCoordDimContLinVNoReplace
 DrawingDimContAngNoReplace
 DrawingDimContentAngular
 DrawingDimContentLinearH
 DrawingDimContentLinearV
 DrawingDimContentRadial
 DrawingPipeSegsDimContNoReplace

Drawings and Reports Reference Data Guide 1596


Overview of Dimension Properties

 SMDrawingDimContentLinear
 MHAlignedDimContModule
 To manually edit the .xml file, enclose the dimension style within the following xml tags.
<dimStyle>ISO</dimstyle>

Template Offset (StrMfgTemplateOffsetPG)


Places offset distance, offset height, and offset girth distance dimension points for a template.
This module supports coordinate dimensioning.

Interval = 0.5 (500 mm)


1 - Points for dimensioning

Interval = 0.3 (300 mm)


1 - Points for dimensioning

Drawings and Reports Reference Data Guide 1597


Overview of Dimension Properties

Height at interval = 0.3


1 - Points for dimensioning

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>StrMfgTemplateOffsetPG</pgModule>
<pgModuleSettings>
<interval>0.5</interval>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
interval
Sets an interval value (in meters) for placing the template points.

Template Set Offset (StrMfgTemplateSetOffsetPG)


Places offset distance, offset height, and offset girth distance dimension points for a
templateSet. This module supports coordinate dimensioning.

GirthLength offset at interval = 0.5


1 - Points for dimensioning

Drawings and Reports Reference Data Guide 1598


Overview of Dimension Properties

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>StrMfgTemplateSetOffsetPG</pgModule>
<pgModuleSettings>
<interval>0.5</interval>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
interval
Sets an interval value (in meters) for placing the template points.

Trim Witness (trimWitness)


Determines whether or not a dimension witness line extends into the drawing view to the
dimensioned object or stops at the drawing view.
 Select True to force the software to trim witness lines.

1 - Object
2 - Dimension
3 - Drawing view edge

 Select False to allow the dimension lines to continue into the view.

Drawings and Reports Reference Data Guide 1599


Overview of Dimension Properties

1 - Object
2 - Dimension
3 - Drawing view edge

 The Trim Witness property is only visible if the Range property is On.
 The following options allow you to manually edit the .xml file:
 Type -1 to trim witness lines.
 Type 0 to allow dimension lines to continue. This is the default behavior.
 Enclose either of the above options within the following .xml tags.
<trimWitness>0</trimWitness>

Vertical Coordinate Dimensions


(DrawingCoordDimContLinVNoReplace)
Places a vertical coordinate dimension that is based on paper space within the matchline.

Usage in Label or Dimension Template XML


<label>
<content>
<contentModule value="DrawingCoordDimContLinVNoReplace />
<preserveTextOrientation>0</preserveTextOrientation>
<dimStyle>ANSI</dimStyle>
<dimLayer></dimLayer>
</content>
</label>

Customization
preserveTextOrientation
Determines whether or not text always uses the dimension style setting in the label template
.xml file.

Drawings and Reports Reference Data Guide 1600


Overview of Dimension Properties

In the Preserve Text Orientation property, select On to force the text to follow the style
setting of the dimension or label template .xml file. Select Off to rotate and move the text
away from the dimension line when not enough clear space exists.
dimLayer
Represents the SmartSketch drawing layer on which the software places the dimensions for
the selected template.
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.

Vertical Linear Dimensions


(DrawingDimContLinVNoReplace)
Places a vertical dimension that is based on paper space in the view.

Usage in Label or Dimension Template XML


<label>
<content>
<contentModule value="DrawingDimContLinVNoReplace"/>
<preserveTextOrientation>0</preserveTextOrientation>
<dimStyle>ANSI</dimStyle>
<dimLayer>???</dimLayer>
</content>
</label>

Customization
preserveTextOrientation
Determines whether or not text always uses the dimension style setting in the label template
.xml file.
dimStyle
Defines the appearance of dimensions placed by the label rule.
dimLayer
Represents the SmartSketch drawing layer on which the software places the dimensions for
the selected template.

Drawings and Reports Reference Data Guide 1601


Overview of Dimension Properties

Vertical Linear Dimensions with Value Replacement


(DrawingDimContentLinearV)
Places a vertical dimension between two points in the drawing view using the calculated,
transformed value from the 3D model space to the 2D drawing space.

Usage in Label or Dimension Template XML


<label>
<content>
<contentModule value="DrawingDimContentLinearV"/>
<preserveTextOrientation>0</preserveTextOrientation>
<dimStyle>ANSI</dimStyle>
<dimLayer>???</dimLayer>
</content>
</label>

Customization
preserveTextOrientation
Determines whether or not text always uses the dimension style setting in the label template
.xml file.
In the Preserve Text Orientation property, select On to force the text to follow the style
setting of the dimension or label template .xml file. Select Off to rotate and move the text
away from the dimension line when not enough clear space exists.
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.
dimLayer
Represents the SmartSketch drawing layer on which the software places the dimensions for
the selected template.

Drawings and Reports Reference Data Guide 1602


Overview of Dimension Properties

Vertical Linear Object Endpoints


(DrawingPGStructVert)
Places a horizontally centered point at the top and bottom ends of a vertical straight feature,
such as a pipe segment or a structural beam.

1 - Horizontally centered endpoints


2 - Vertical straight feature

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGStructVert</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1603


Overview of Dimension Properties

Vertical Object Anchor (DrawingPGAnchorVert)


Places points horizontally centered at the top and bottom end points of a vertical straight feature
in the drawing view.

1 - Top end point


2 - Bottom end point

You must use the Vertical Object Anchor (DrawingPGAnchorVert) module with the Dummy
(DummyGeomAnalyzer) geometric analyzer in the same dimension anchor template.
The main dimension template that anchors to the template that uses this point
generator must use the Anchor to Nearest Object (DrawingSepDimGenerator) annotation
control generator. For more information, see Anchor to Nearest Object
(DrawingSepDimGenerator) (on page 1520).

Customization
None

Drawings and Reports Reference Data Guide 1604


Overview of Dimension Properties

Vertical Offset (vOffset)


Specifies the vertical distance from the dimension line to the nearest dimension point in the
chain for a horizontal dimension. If vOffset is positive, then the dimension line is placed at the
vOffset distance above the top point in the chain. If vOffset is negative, then the dimension line
is placed at the vOffset distance below the bottom point in the chain.

1 - Vertical offset
2 - Horizontal dimension

 The software interprets the value that you type as paper space units and not model space
units.
 To manually edit the .xml file, specify a decimal value. Enclose this value within the following
.xml tags.
<vOffset>0.0</vOffset>

Drawings and Reports Reference Data Guide 1605


SECTION 18

Matchline Rule Manager


The Matchline Rule Manager allows you to modify the rules and properties of matchline
templates.
To modify a template, first launch the Matchline Rule Manager. For more information,
see Launch Matchline Rule Manager (on page 1606).
To add additional templates to the rule, click the green icon that displays at the far right of
the Template List box. For more information about adding templates, see Add Template Dialog
Box (on page 1100).
Click Reset to revert the template to the initial state. This action also discards all templates that
you have added to the rule, leaving only the original template. Click Cancel to discard all
template modifications and exit the Rule Manager. Click Save to save all changes. Click Save &
Close to save all changes and exit the Rule Manager.
See Also
Launch Matchline Rule Manager (on page 1606)
Properties Tab (on page 1608)
Relationships Tab (on page 1611)
Comments Tab (on page 1612)

Launch Matchline Rule Manager


Follow these steps to launch the Matchline Rule Manager.
1. Click Tasks > Drawings and Reports.
2. Click Tools > Define View Style.
The Define View Style window displays.
3. Select Orthographic from the View Style Type list.

4. Select an existing view style, or click New Style to create a new view style.
5. Click Properties .
The View Style Properties dialog box displays.
6. Select More from the Matchline Rule list.
The Select Label Rule window displays.
7. Select a rule, and then click Properties.
The Matchline Rule Manager displays.
You can access the Matchline Rule Manager from the View Style Properties
dialog box. Select a template from the Matchline Rule menu, and then press F12.

Drawings and Reports Reference Data Guide 1606


Matchline Rule Manager

Add Template Dialog Box


Allows you to add a template based on the existing set of templates on disk.

 You cannot add dimension rule templates.


 You must have already launched the Label Rule Manager, the Matchline Rule Manager,
or the North Arrow Rule Manager, depending on the type of template you want to add.

To add a template to the rule


1. Click Add a template to this rule ( on the right side of the Template List box).
The software calculates the impact that the rule change has on existing view styles. Then,
the software displays a list of view styles that are affected when you add a new template to
the rule, and prompts you to confirm the action.
2. Click No to return to the Rule Manager, or click Yes to proceed.
The Select Templates dialog box displays.
3. Select the template or templates to add from the list. Alternately, you can search for a
template using the Search Templates box.
4. Click Open to add the template to the rule and return to the Rule Manager.
The software loads the selected template or templates to the rule.
5. Click the arrow next to the Template List box to display the list of templates that you
have added. Click Cancel to cancel the addition of the new template and return to the Rule
Manager without adding any new templates to the rule.
See Also
Launch Label Rule Manager (Orthographic Drawings) (on page 1099)
Launch Matchline Rule Manager (on page 1606)
Delete a Template (on page 1102)

Copy a Compound Matchline Rule


A compound rule can have multiple templates and can be associated with multiple
symbol and report files.
1. In the Select Label Rule dialog box, select the matchline rule to copy.
2. Click Copy.
The Copy Matchline Rule dialog box displays.
3. Click Add Prefix or Add Suffix.
—OR—
Select both options to add a prefix and a suffix to the rule name.
The software populates the Change Rule Name box with the existing name and positions
the cursor according to your selection.

Drawings and Reports Reference Data Guide 1607


Matchline Rule Manager

4. Type to add the prefix or suffix to the rule name.


Rule names do not support any character not supported by your operating
system.
The software displays all affected files in the View Changes display and dynamically
updates the file names as you type.
5. Click Copy.
The software returns you to the Select Label Rule dialog box with the newly copied rule
selected.

 You cannot copy a template if you do not have certain permissions. For example, if you do
not have write permissions to the Labels\Templates\Matchline folder, then an error message
displays, and the command exits.
 If the software cannot copy a matchline rule, an error message displays and the command
exits. Copy errors can occur in the following situations:
 The rule contains a template that is missing from disk.
 The rule contains one or more templates with XML errors.

Properties Tab
Displays the modules for the selected template and allows you to edit the properties that each
module uses.
Modules and properties are grouped under the following headings:
 Content (displays the content modules)
 General (displays the annotation control generator modules)
 Leader (displays the leader modules)
 Point Generation (displays the point generator modules)
 Geometric Analysis (displays the geometric analyzer modules)
 Positioning 1,2, and so forth (display the positioning modules)
The modules that display vary based on the template that you have selected for editing.
Under each heading, the module name displays first in the list of properties that each module
uses. Click the module name to display the associated Help for that module.
To expand or collapse the list of properties that each module uses, click the arrow on the far
right of each module name. The properties that each module uses display beneath the module
names. Click each property to display the associated Help for that property.
To edit the property values, type the value into the text box next to the property. For some
properties, you can select or clear a check box next to the property. For other properties, you
click an arrow next to the property, and then select a value from the list that displays.
To search for a property to edit, type the name of the property that you want to edit in the
Search box, and then press ENTER.

Drawings and Reports Reference Data Guide 1608


Matchline Rule Manager

In the following image, the Matchline_None_A template is selected for editing in the Matchline
Rule Manager. The modules display on the Properties tab. Underneath the Content heading,
the Display Empty/Error Labels property is selected.

See Also
Launch Matchline Rule Manager (on page 1606)

Content Module (Properties tab)


Gathers the information to display within a matchline. Additionally, a content module specifies
matchline styles.
Content modules are highly customizable. For matchlines, the system uses report template files
in addition to code in the content module in order to display the matchline. While content
modules ready annotations for placement on the drawing view, the modules do not position the
annotations.
The list of supported content modules follows. Names in parentheses are as identified in the
.xml files.
 Matchline (DrawingMatchlineContent) (on page 1621)
See Also
Annotation Control Generator Module (Properties tab) (on page 1610)
Point Generator Module (Properties tab) (on page 1610)
Geometric Analyzer Module (Properties tab) (on page 1611)
Positioning Module (Properties tab) (on page 1611)

Drawings and Reports Reference Data Guide 1609


Matchline Rule Manager

Annotation Control Generator Module (Properties tab)


Creates an annotation control object as a matchline object, which the system uses to represent
each individual matchline. The annotation control object then manages the list of positioning
modules that can use that particular annotation and keeps track of the annotation's current
position at any point in time.
Only the Default (DefaultLabelControlGenerator) (on page 1265) annotation control generator is
supported for matchlines.
See Also
Content Module (Properties tab) (on page 1609)
Point Generator Module (Properties tab) (on page 1610)
Geometric Analyzer Module (Properties tab) (on page 1611)
Positioning Module (Properties tab) (on page 1611)

Leader Module (Properties tab)


The Matchline Rule Manager does not support leader modules.

Point Generator Module (Properties tab)


Gathers data from the 3D geometry and places points on 2D objects that need labels,
dimensions, or matchlines.
The system can generate the point on any number of object locations, depending on the point
generator module that you use. This includes, but is not limited to, the object origin, control
point, straight feature end point, and so forth. A point generator can place one or multiple points
on the same object. No annotations are created with this module.
The list of supported point generator modules follows. Names in parentheses are as identified in
the .xml files.
 Matchline (DrawingMatchlinePG) (on page 1623)
See Also
Content Module (Properties tab) (on page 1609)
Annotation Control Generator Module (Properties tab) (on page 1610)
Geometric Analyzer Module (Properties tab) (on page 1611)
Positioning Module (Properties tab) (on page 1611)

Drawings and Reports Reference Data Guide 1610


Matchline Rule Manager

Geometric Analyzer Module (Properties tab)


Evaluates the points placed by the point generator module. The selected module groups or
deletes points as needed. This module does not create any annotations.
 No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on page 1398)
See Also
Content Module (Properties tab) (on page 1609)
Point Generator Module (Properties tab) (on page 1610)
Positioning Module (Properties tab) (on page 1611)

Positioning Module (Properties tab)


Determines the position of a matchline.
Some positioning modules consider clear space when readying matchlines for placement.
Alternately, other positioning modules determine an absolute position at which to place the
matchline without regard to clear space.
The list of supported positioning modules follows. Names in parentheses are as identified in the
.xml files.
 Absolute Matchline (DrawingMatchlinePositioning) (on page 1613)
See Also
Content Module (Properties tab) (on page 1609)
Annotation Control Generator Module (Properties tab) (on page 1610)
Point Generator Module (Properties tab) (on page 1610)
Geometric Analyzer Module (Properties tab) (on page 1611)

Relationships Tab
Displays the name of the selected template and the list of rules that reference that template, as
well as the view styles that use those rules.
Information displayed on the Relationships tab helps you determine the impacts that changes
to the template can have on other matchline rules and view styles.
Click Reset to revert the template to the initial state. This action also discards all templates that
you have added to the rule, leaving only the original template. Click Cancel to discard all
template modifications and exit the Rule Manager. Click Save to save all changes. Click Save &
Close to save all changes and exit the Rule Manager.
See Also
Properties Tab (on page 1608)
Comments Tab (on page 1612)

Drawings and Reports Reference Data Guide 1611


Matchline Rule Manager

Comments Tab
Allows you to type notes that the system copies to the top of the .xml file.

Click Reset to revert the template to the initial state. This action also discards all templates that
you have added to the rule, leaving only the original template. Click Cancel to discard all
template modifications and exit the Rule Manager. Click Save to save all changes. Click Save &
Close to save all changes and exit the Rule Manager.
See Also
Properties Tab (on page 1608)
Relationships Tab (on page 1611)

Drawings and Reports Reference Data Guide 1612


APPENDIX D

Overview of Matchline Properties


This appendix contains descriptions of all the matchline rule properties available to apply to
matchlines created using the Drawings and Reports task. Matchline rule properties are editable
either from within the .xml template or by using the Matchline Rule Manager. Both methods of
editing the matchline rule are documented here.
For more information on the Matchline Rule Manager, see Matchline Rule Manager (on page
1606).

Absolute Matchline (DrawingMatchlinePositioning)


Positions matchline labels in the margin.

Usage in Label Template XML


<posModules>
<posModule value="DrawingMatchlinePositioning"/>
</posModules>

Customization
None
See Also
Positioning Module (Properties tab) (on page 1611)

Adjacent Edge Overlap Percentage (adjacentOverlap)


Eliminates volumes from horizontal and vertical matchline label consideration. For horizontal
consideration, the command eliminates any neighboring volumes that are too far left or right of
the drawing volume center. For vertical matchline label consideration, the command eliminates
neighboring volumes that are too far above or below the drawing volume center. The Adjacent
Edge Overlap Percentage property is a multiplier that is applied to the sides of the drawing
volume. Smaller Adjacent Edge Overlap Percentage values result in more matchline labels.
Specify a Gap Tolerance and an Adjacent Edge Overlap Percentage to define an acceptable
volume range, or include range. A matchline label displays when any point of a neighboring view
volume lies within the include range. For more information, see Matchline
(DrawingMatchlinePG) (on page 1623) and Gap Tolerance (gapTolerance) (on page 1618).

 You do not have to use Gap Tolerance and Adjacent Edge Overlap Percentage together.
 If the closest parallel side of the neighboring volume does not overlap the side of the subject
volume by at least the Adjacent Edge Overlap Percentage, the software displays a
drawing limit label instead of a matchline label.
 The default adjacentOverlap value is 0.33.

Drawings and Reports Reference Data Guide 1613


Overview of Matchline Properties

1 - Drawing volumes (subject volume is blue)


2 - Gap tolerance
3 - Adjacent edge overlap percentage

1 - Drawing volumes (subject volume is blue)


2 - Gap tolerance
3 - Adjacent edge overlap percentage

Type a value in the Adjacent Edge Overlap Percentage box in the Matchline Rule Manager.
Alternately, enclose the equivalent decimal value within the following .xml tags:
<adjacentOverlap>0.33</adjacentOverlap>

See Also
Matchline (DrawingMatchlinePG) (on page 1623)
Gap Tolerance (gapTolerance) (on page 1618)

Drawings and Reports Reference Data Guide 1614


Overview of Matchline Properties

Default (DefaultLabelControlGenerator)
Currently used by all label templates. Generates a label control for each label that is used to run
the positioning modules.

Usage in Label Template XML


<annotationControlGenerator>
<acgModule>DefaultLabelControlGenerator</acgModule>
<labelLayer>MATCHLINE_LABELS</labelLayer>
<priority>1</priority>
</annotationControlGenerator>

Customization
labelLayer
Allows you to specify the 2D layer on which the software automatically places labels.
The following illustration shows an equipment object with a label placed on the layer
specified in the text box.

1 - Equipment object
2 - Label
3 - Text Box Properties dialog box specifying the
layer on which the label resides

priority
Determines the order in which the software places an annotation based on available clear

Drawings and Reports Reference Data Guide 1615


Overview of Matchline Properties

space and proximity to other annotations.


The software attempts to place an annotation (such as a label or a dimension) in clear
space as close as possible to that object's Connect Point. Multiple annotations do not
overlap. The Priority property allows you to assign a priority to each annotation, with 1
being the highest priority. The software places the annotation with the highest priority
closest to that object's Connect Point. Additional annotations with lower priorities are
placed further away from the corresponding object's Connect Point.
To define the priority, type a positive integer in the Priority text box.

1 - Equipment labels placed with Priority set to 1


2 - Structure label placed with Priority set to 2

1 - Equipment label placed with Priority set to 2


2 - Structure label placed with Priority set to 1

Drawings and Reports Reference Data Guide 1616


Overview of Matchline Properties

Display Empty/Error Labels


Specifies whether or not the system places a label if the software returns no content or an
error for the label.
 Clear the Display Empty/Error Labels check box to suppress any empty labels or an error
for the label.
 Select the Display Empty/Error Labels check box if you want the label to display
regardless of empty content or an error. This option is selected by default.
The following example shows one of two results when the Display Empty/Error Labels option
is selected. In this case, an empty label displays even though the content module found no data
with which to populate the label.

1 - Empty label

In the next example, the Display Empty/Error Labels check box is selected as well. However,
in this case, the content module encountered an error while attempting to process the label.
Therefore, an error label displays.

1 - Error label

 The Display Empty/Error Labels option is available for all content modules.
 The following options allow you to manually edit the .xml file:
 Type -1 to suppress the label when an error occurs.

Drawings and Reports Reference Data Guide 1617


Overview of Matchline Properties

 Type 0 to display the label regardless of an error. This is the default value.
 Enclose either of the above values within the following .xml tags.
<ignoreError>0</ignoreError>

East Report Template


Specifies the report template (.rtp) used to define the label content.
Report templates run a query against the model to gather the label data. To choose a new
report template file, click the ellipsis to the right of the Report Template box. Select the
report template file to use from the Select .rtp File dialog box.

Use the Define Label command to create report templates in the Catalog task. This
command creates three additional files in conjunction with the .rtp file that you create. If you
define a new label query, you must copy all four files from the Catalog folders into the Drawings
folders, located in the [SharedContent] folder. For more information, see Label Editor in the
Drawings and Reports Reference Data Guide.

East Symbol Attribute Name


Displays the value of the ID user attribute for the text box in the associated symbol file. This
attribute links the text box to the report template file.
The software automatically updates this attribute when the symbol file is modified.

Gap Tolerance (gapTolerance)


Determines the maximum distance that a matchline label allows between a drawing volume and
a neighboring volume. If the neighboring volume falls outside this distance, then a drawing limit
label replaces the matchline label. The software eliminates candidates that are too far away
from the drawing view volume from matchline consideration.

 You do not have to use Gap Tolerance and Adjacent Edge Overlap Percentage together.
 The default gapTolerance is 0.000000001 meter. For more information, see DEFAULT (on
page 1080) in the User Interface Schema Overview (on page 1066), and Change a
displayed unit of measure in the Smart 3D Common User's Guide.

Drawings and Reports Reference Data Guide 1618


Overview of Matchline Properties

1 - Drawing volumes (subject volume is blue)


2 - Gap tolerance
3 - Adjacent edge overlap percentage

1 - Drawing volumes (subject volume is blue)


2 - Gap tolerance
3 - Adjacent edge overlap percentage

Type a distance in the Gap Tolerance box on the Matchline Rule Manager. Alternately,
enclose the equivalent decimal value within the following .xml tags:
<gapTolerance>0.001</gapTolerance>

See Also
Matchline (DrawingMatchlinePG) (on page 1623)
Adjacent Edge Overlap Percentage (adjacentOverlap) (on page 1613)

Drawings and Reports Reference Data Guide 1619


Overview of Matchline Properties

Label Layer (labelLayer)


Allows you to specify the 2D layer on which the software automatically places labels. You can
select any layer on which to place the template. The system places all labels that use this
template on this layer.
Type the name in the text box of the layer on which you want the label to reside.
You can also name a new layer on which to place the template. If the specified layer does not
yet exist, the software automatically creates the layer.
The following illustration shows an equipment object with a label placed on the layer
specified in the text box.

1 - Equipment object
2 - Label
3 - Text Box Properties dialog box specifying the
layer on which the label resides

 The Default (DefaultLabelControlGenerator) (on page 1265) annotation control generator


uses the Label Layer property.
 Use the following .xml tags to manually edit the values for Label Layer.
<labelLayer>MATCHLINE_LABELS
</labelLayer>
 MATCHLINE_LABELS can be any name that you want, including an existing layer. If you
enter a new layer name, the software automatically creates that layer.

Drawings and Reports Reference Data Guide 1620


Overview of Matchline Properties

Label Symbol File


Controls the appearance of symbol graphics to be placed as a label. You can edit this file to
add, remove, or modify the existing graphics and symbol origin location. Graphics can include
lines, arcs, circles, text boxes, fills, and so forth. The symbol origin serves as the handle that the
automatic labeling engine uses to place the label.

Modify the symbol file


1. Click Launch SmartSketch .
SmartSketch Drawing Editor launches.
2. Within SmartSketch Drawing Editor, add, remove, or modify graphics and symbol origin for
your label.
3. Save your changes and exit SmartSketch Drawing Editor.

 Label symbol files contain graphics, and unlike many symbol files, are not associated with
database queries.
 If you open a symbol file, save your changes and exit SmartSketch Drawing Editor before
continuing work in the Matchline Rule Manager, the Label Rule Manager, or the North
Arrow Rule Manager. For more information, see Matchline Rule Manager (on page 1606),
Label Rule Manager (on page 1099), and North Arrow Rule Manager (on page 1633).

Matchline (DrawingMatchlineContent)
Generates matchline label content. This content module is dependent on the
DrawingMatchlinePG point generator. For more information, see Matchline
(DrawingMatchlinePG) (on page 1623).

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingMatchlineContent"/>
<ID attributeName="Matchline" type="North">
Matchline\MatchlineNorth.rtp</ID>
<ID attributeName="Matchline" type="West">
Matchline\MatchlineWest.rtp</ID>
<ID attributeName="Matchline" type="South">
Matchline\MatchlineSouth.rtp</ID>
<ID attributeName="Matchline" type="East">
Matchline\MatchlineEast.rtp</ID>
<ignoreError>-1</ignoreError>
</content>
</label>

Drawings and Reports Reference Data Guide 1621


Overview of Matchline Properties

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).

Drawings and Reports Reference Data Guide 1622


Overview of Matchline Properties

 The ID attributeName value must match the name in the Value box in the Text Box
Properties dialog box for the label template .sym file you are modifying, as shown
below:

 For more information on modifying label templates, see Create a Compound Label with
a Combined Symbol (on page 748).

Matchline (DrawingMatchlinePG)
Generates at least four points at the edge of a view to place a matchline label. The software
generates more points when multiple edges of a view border other drawings.
The Adjacent Edge Overlap Percentage and Gap Tolerance properties define an acceptable
volume range, also known as an include range. For more information on using these properties
with the Matchline module, see Adjacent Edge Overlap Percentage (adjacentOverlap) (on page
1613) and Gap Tolerance (gapTolerance) (on page 1618).

 You do not have to use Gap Tolerance and Adjacent Edge Overlap Percentage together.
 If the template file does not define the adjacentOverlap or gapTolerance .xml tags, the
software displays the default values:
 Gap Tolerance - 0 mm
 Adjacent Edge Overlap Percentage - 33

Drawings and Reports Reference Data Guide 1623


Overview of Matchline Properties

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>DrawingMatchlinePG</pgModule>
<gapTolerance>0.000000001</gapTolerance>
<adjacentOverlap>0.33</adjacentOverlap>
</pointGeneratorSettings>

Customization
gapTolerance
Determines the maximum distance that a matchline label allows between a drawing volume
and a neighboring volume. If the neighboring volume falls outside this distance, then a
drawing limit label replaces the matchline label. The software eliminates candidates that are
too far away from the drawing view volume from matchline consideration.
adjacentOverlap
Eliminates volumes from horizontal and vertical matchline label consideration. For horizontal
consideration, the command eliminates any neighboring volumes that are too far left or right
of the drawing volume center. For vertical matchline label consideration, the command
eliminates neighboring volumes that are too far above or below the drawing volume center.
The Adjacent Edge Overlap Percentage property is a multiplier that is applied to the sides
of the drawing volume. Smaller Adjacent Edge Overlap Percentage values result in more
matchline labels.

Example 1
The following shows part of a drawing volume inside of the include range:

1 - Drawing volume (subject volume in blue)


2 - Gap Tolerance
3 - Include range
4 - Adjacent Edge Overlap Percentage

A matchline label displays on the top side of the subject volume because part of the adjacent
drawing volume is within the include range.

Drawings and Reports Reference Data Guide 1624


Overview of Matchline Properties

Subject volume matchline label

Example 2
The following shows a drawing volume outside of the include range:

1 - Drawing volume (subject volume in blue)


2 - Gap Tolerance
3 - Include range
4 - Adjacent Edge Overlap Percentage

A drawing limit label displays on the top side of the subject volume because the adjacent
drawing volume is not within the include range.

Subject volume drawing limit label

Although a content module creates the annotation output, this example shows how
this module affects the output.
See Also
Adjacent Edge Overlap Percentage (adjacentOverlap) (on page 1613)
Gap Tolerance (gapTolerance) (on page 1618)

Drawings and Reports Reference Data Guide 1625


Overview of Matchline Properties

Matchline Layer (matchlineLayer)


Specifies the drawing view layer that contains the matchline graphics. If you specify a layer that
does not exist, the software creates it.
The software places matchline labels on a different layer. For more information, see
Label Layer (labelLayer) (on page 1339).

Usage in Matchline Rule XML


<ACTION>
<CATEGORY>VHL_VisibleLineLayer</CATEGORY>
<VALUE type="string">LayerName</VALUE>
</ACTION>

 Type a layer name in the Matchline Layer text box. If the layer does not exist, the software
automatically creates it.
 The matchline layer is defined in the matchline rule .xml file.
See Also
Point Generator Module (Properties tab) (on page 1610)
Matchline (DrawingMatchlinePG) (on page 1623)

No Grouping or Filtering (Default)


(DefaultLabelGeometricAnalyzer)
Used to place a label on the origin or control point of an object. This module does not perform
any grouping. Currently used by most non-linear labels.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DefaultLabelGeometricAnalyzer</gaModule>
</geometricAnalyzerSettings>

Customization
None

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1626


Overview of Matchline Properties

North Report Template


Specifies the report template (.rtp) used to define the label content.
Report templates run a query against the model to gather the label data. To choose a new
report template file, click the ellipsis to the right of the Report Template box. Select the
report template file to use from the Select .rtp File dialog box.

Use the Define Label command to create report templates in the Catalog task. This
command creates three additional files in conjunction with the .rtp file that you create. If you
define a new label query, you must copy all four files from the Catalog folders into the Drawings
folders, located in the [SharedContent] folder. For more information, see Label Editor in the
Drawings and Reports Reference Data Guide.

North Symbol Attribute Name


Displays the value of the ID user attribute for the text box in the associated symbol file. This
attribute links the text box to the report template file.
The software automatically updates this attribute when the symbol file is modified.

Occluded Matchline Style (occludedMatchlineStyle)


Specifies the line style that the software applies when the matchline overlaps an object in an
adjacent volume. Select a matchline style from the Occluded Matchline Style list.

Examples

1 - 2Dash Dot
2 - Chain
3 - Normal

All line styles are found in the Styles.sha and ISStyles.sha files, located in the
[Reference Data Folder]\SharedContent\Drawings\Catalog\Templates folder. You can add new
line styles to this file.

Drawings and Reports Reference Data Guide 1627


Overview of Matchline Properties

See Also
Default (DefaultLabelControlGenerator) (on page 1265)
Visible Matchline Style (visibleMatchlineStyle) (on page 1632)

Priority (priority)
Determines the order in which the software places an annotation based on available clear space
and proximity to other annotations.
The software attempts to place an annotation (such as a label or a dimension) in clear
space as close as possible to that object's Connect Point. Multiple annotations do not
overlap. The Priority property allows you to assign a priority to each annotation, with 1
being the highest priority. The software places the annotation with the highest priority
closest to that object's Connect Point. Additional annotations with lower priorities are
placed further away from the corresponding object's Connect Point.
To define the priority, type a positive integer in the Priority text box.

1 - Equipment labels placed with Priority set to 1


2 - Structure label placed with Priority set to 2

Drawings and Reports Reference Data Guide 1628


Overview of Matchline Properties

1 - Equipment label placed with Priority set to 2


2 - Structure label placed with Priority set to 1

For more information about connect points, see Connect Point (on page 1257).

 The Default (DefaultLabelControlGenerator) (on page 1265) annotation control generator


and the Clear Space Position by 2D Curve (ISDwgPositionByCurve2D) (on page 1203)
positioning module use this property.
 To manually edit the .xml file, specify a positive integer to assign as a Priority number for
each annotation. Enclose this value within the following .xml tags.
<priority>1</priority>

Side (side)
Specifies which side of the curve is used to locate the label. Select Left or Right.

1 - Left
2 - Right

 The Pin Jig Seam Offset Label (SMDPinJigSeamOffsetCM) (on page 1424) content module
uses the Side property.
 To manually edit the .xml file, specify either left or right. Enclose either value within the
following .xml tags:
<Side>left</Side>

Drawings and Reports Reference Data Guide 1629


Overview of Matchline Properties

South Report Template


Specifies the report template (.rtp) used to define the label content.
Report templates run a query against the model to gather the label data. To choose a new
report template file, click the ellipsis to the right of the Report Template box. Select the
report template file to use from the Select .rtp File dialog box.

Use the Define Label command to create report templates in the Catalog task. This
command creates three additional files in conjunction with the .rtp file that you create. If you
define a new label query, you must copy all four files from the Catalog folders into the Drawings
folders, located in the [SharedContent] folder. For more information, see Label Editor in the
Drawings and Reports Reference Data Guide.

South Symbol Attribute Name


Displays the value of the ID user attribute for the text box in the associated symbol file. This
attribute links the text box to the report template file.
The software automatically updates this attribute when the symbol file is modified.

West Report Template


Specifies the report template (.rtp) used to define the label content.
Report templates run a query against the model to gather the label data. To choose a new
report template file, click the ellipsis to the right of the Report Template box. Select the
report template file to use from the Select .rtp File dialog box.

Use the Define Label command to create report templates in the Catalog task. This
command creates three additional files in conjunction with the .rtp file that you create. If you
define a new label query, you must copy all four files from the Catalog folders into the Drawings
folders, located in the [SharedContent] folder. For more information, see Label Editor in the
Drawings and Reports Reference Data Guide.

West Symbol Attribute Name


Displays the value of the ID user attribute for the text box in the associated symbol file. This
attribute links the text box to the report template file.
The software automatically updates this attribute when the symbol file is modified.

Drawings and Reports Reference Data Guide 1630


Overview of Matchline Properties

White Object Layer (whiteObj)


Allows you to specify one or more 2D layers in the drawing to serve as white object layers
for a label placed in clear space. Graphical objects set on these layers are rendered invisible
to this label, allowing placement of the label on top of these objects.

1 - Pipe within a White Object Layer


2 - Equipment label overlapping pipes

For example, you can create a graphic rule for piping, placing all piping graphics on the Pipes
layer. Next, specify the Pipes layer for the White Object Layer property. All labels of this label
template type then overlap all drawing view graphics on the Pipes layer.

 If this filter is set to "*" during label placement, then the system ignores all objects that are
not labels or leaders.
 The number of allowed white object layers in the label template is unlimited.
 The Default (DefaultLabelControlGenerator) (on page 1265) annotation control generator
uses this property.
 The Clear Space Position by 2D Curve (ISDwgPositionByCurve2D) (on page 1203)
positioning module uses this property.
 To manually edit the .xml file, enclose the layer name within the following .xml tags.
<whiteObj>LAYER_NAME
</whiteObj>

Drawings and Reports Reference Data Guide 1631


Overview of Matchline Properties

 LAYER_NAME can refer to any layer that you choose.

Visible Matchline Style (visibleMatchlineStyle)


Specifies the line style that the software applies to visible portions of matchlines. Select a
matchline style from the Visible Matchline Style list.

Examples

1 - 2Dash Dot
2 - Chain
3 - Normal

All line styles are found in the Styles.sha and ISStyles.sha files, located in the
[Reference Data Folder]\SharedContent\Drawings\Catalog\Templates folder. You can add new
line styles to this file.
See Also
Default (DefaultLabelControlGenerator) (on page 1265)
Occluded Matchline Style (occludedMatchlineStyle) (on page 1627)

Drawings and Reports Reference Data Guide 1632


SECTION 19

North Arrow Rule Manager


The North Arrow Rule Manager allows you to modify the rules and properties of North Arrow
templates.
To modify a template, first launch the North Arrow Rule Manager. For more
information, see Launch North Arrow Rule Manager (on page 1633).
To add additional templates to the rule, click the green icon that displays at the far right of
the Template List box. For more information about adding templates, see Add Template Dialog
Box (on page 1100).
Click Reset to revert the template to the initial state. This action also discards all templates that
you have added to the rule, leaving only the original template. Click Cancel to discard all
template modifications and exit the Rule Manager. Click Save to save all changes. Click Save &
Close to save all changes and exit the Rule Manager.
See Also
Launch North Arrow Rule Manager (on page 1633)
Add Template Dialog Box (on page 1100)
Properties Tab (on page 1103)
Relationships Tab (on page 1111)
Comments Tab (on page 1112)

Launch North Arrow Rule Manager


Follow these steps to launch the North Arrow Rule Manager.
1. Click Tasks > Drawings and Reports.
2. Click Tools > Define View Style.
The Define View Style window displays.
3. Select Orthographic from the View Style Type list.

4. Select an existing view style, or click New Style to create a new view style.
5. Click Properties .
The View Style Properties dialog box displays.
6. Select More from the North Arrow Rule list.
The Select Label Rule window displays.
7. Select a rule, and then click Properties.
The North Arrow Rule Manager displays.
You can access the North Arrow Rule Manager from the View Style Properties
dialog box. Select a template from the North Arrow Rule menu, and then press F12 to
display the North Arrow Rule Manager.

Drawings and Reports Reference Data Guide 1633


North Arrow Rule Manager

Add Template Dialog Box


Allows you to add a template based on the existing set of templates on disk.

 You cannot add dimension rule templates.


 You must have already launched the Label Rule Manager, the Matchline Rule Manager,
or the North Arrow Rule Manager, depending on the type of template you want to add.

To add a template to the rule


1. Click Add a template to this rule ( on the right side of the Template List box).
The software calculates the impact that the rule change has on existing view styles. Then,
the software displays a list of view styles that are affected when you add a new template to
the rule, and prompts you to confirm the action.
2. Click No to return to the Rule Manager, or click Yes to proceed.
The Select Templates dialog box displays.
3. Select the template or templates to add from the list. Alternately, you can search for a
template using the Search Templates box.
4. Click Open to add the template to the rule and return to the Rule Manager.
The software loads the selected template or templates to the rule.
5. Click the arrow next to the Template List box to display the list of templates that you
have added. Click Cancel to cancel the addition of the new template and return to the Rule
Manager without adding any new templates to the rule.
See Also
Launch Label Rule Manager (Orthographic Drawings) (on page 1099)
Launch Matchline Rule Manager (on page 1606)
Delete a Template (on page 1102)

Copy a Rule
Copy a Simple Label, North Arrow, or Dimension Rule
A simple rule only has one template, and may have a single symbol file and a single
report file.
1. In the Select [Label or Dimension] Rule dialog box, select the label, north arrow, or
dimension rule to copy.
2. Click Copy.
The Copy [Label, North Arrow, or Dimension] Rule dialog box displays.
3. Type the name for the new rule in the Change Rule Name box.
Rule names do not support any character not supported by your operating
system.

Drawings and Reports Reference Data Guide 1634


North Arrow Rule Manager

The software displays all affected files in the View Changes pane and dynamically updates
the file names as you type.
4. Click Copy.
The software returns you to the Select (Label or Dimension) Rule dialog box with the
newly copied rule selected.

Copy a Compound Label, Matchline, or North Arrow Rule


A compound rule can have multiple templates and can be associated with multiple
symbol and report files.
1. In the Select Label Rule dialog box, select the label, matchline, or north arrow rule to copy.
2. Click Copy.
The Copy [Label, Matchline, or North Arrow] Rule dialog box displays.
3. Click Add Prefix or Add Suffix.
—OR—
Select both options to add a prefix and a suffix to the rule name.
The software populates the Change Rule Name box with the existing name and positions
the cursor according to your selection.
4. Type to add the prefix or suffix to the rule name.
Rule names do not support any character not supported by your operating
system.
The software displays all affected files in the View Changes display and dynamically
updates the file names as you type.
5. Click Copy.
The software returns you to the Select Label Rule dialog box with the newly copied rule
selected.

 You cannot copy a template if you do not have certain permissions. For example, if you do
not have write permissions to the Labels\Templates folder or the Dimensions\Templates
folder, then an error message displays, and the command exits.
 If the software cannot copy a label, matchline, north arrow, or dimension rule, an error
message displays and the command exits. Copy errors can occur in the following situations:
 The rule contains a template that is missing from disk.
 The rule contains one or more templates with XML errors.
 If you are copying a label associated with a formatting file (.rfm) that references a formatting
parameter file (.rfp), the .rfm and .rfp file prefixes must be identical. Otherwise, the software
does not copy the .rfp file, and the new label continues to reference the original .rfp file.
See Also
Label Rule Manager (on page 1099)
Dimension Rule Manager (on page 1503)

Drawings and Reports Reference Data Guide 1635


North Arrow Rule Manager

Properties Tab
Displays the modules for the selected template and allows you to edit the properties that each
module uses.
Modules and properties are grouped under the following headings:
 Content (displays the content modules)
 General (displays the annotation control generator modules)
 Leader (displays the leader modules)
 Point Generation (displays the point generator modules)
 Geometric Analysis (displays the geometric analyzer modules)
 Positioning 1,2, and so forth (display the positioning modules)
The modules that display vary based on the template that you have selected for editing.
Under each heading, the module name displays first in the list of properties that each module
uses. Click the module name to display the associated Help for that module.
To expand or collapse the list of properties that each module uses, click the arrow on the far
right of each module name. The properties that each module uses display beneath the module
names. Click each property to display the associated Help for that property.
To edit the property values, type the value into the text box next to the property. For some
properties, you can select or clear a check box next to the property. For other properties, you
click an arrow next to the property, and then select a value from the list that displays.
To search for a property to edit, type the name of the property that you want to edit in the
Search box, and then press ENTER.

Drawings and Reports Reference Data Guide 1636


North Arrow Rule Manager

In the following image, the Civil Plan_Equipment_Name template is selected for editing in the
Label Rule Manager. The modules display on the Properties tab. Underneath the Leader
heading, the Display Breakline property is selected. On the right, Help automatically displays
information about the selected property.

See Also
Relationships Tab (on page 1111)
Comments Tab (on page 1112)

Content Module (Properties tab)


Gathers the information to display within a label or dimension. Additionally, a content module
specifies dimension styles.
Content modules are highly customizable. For labels, the system uses report label files in
addition to code in the content module in order to display the label. For dimensions, code
interacts with SmartSketch in order to place the dimension value, as well apply any changes to
the appearance of the dimension. While content modules ready annotations for placement on
the drawing view, the modules do not position the annotations.
The list of supported content modules follows. Names in parentheses are as identified in the
.xml files.
 Default (DrawingLabelHelper) (on page 1268)
 Knuckle Angle Symbol (ISKnuckleAngleSymbolContent) (on page 1338)
 Manufacturing Margin Symbol (ISMfgMarginSymbolContent) (on page 1369)
 Manufacturing Pin Height Label (SMDwgMfgPinHeightLabelContent) (on page 1369)

Drawings and Reports Reference Data Guide 1637


North Arrow Rule Manager

 Manufacturing Profile Margin Symbol (SMDwgMfgProfileMarginSymContent) (on page


1370)
 No Label Content (DrawingNoContent) (on page 1399)
 North Arrow (DrawingNArrowContent) (on page 1400)
 Pin Jig Seam Offset Label (SMDPinJigSeamOffsetCM) (on page 1424)
 Piping Elevation (DrawingBOLabelContent) (on page 1425)
 Plate Angle Symbol (ISPlateAngleSymbolContent) (on page 1427)
 Plate Grid Name Label (SMDwgPlateGridNameLabelContent) (on page 1428)
 Profile Angle Symbol (ISProfileAngleSymbolContent) (on page 1444)
 Profile Sketch Bevel Symbol (SMProfileSketchBevelSymbolCM) (on page 1446)
 Profile Sketch Label (SMDwgProfileSketchLabelsContent) (on page 1447)
 Reference (DrawingReferenceLabelContent) (on page 1451)
 Scantling Near Side or Far Side Direction Symbol
(SMDwgScantlingNSorFSDirectionContent) (on page 1461)
 Ship Direction Symbol (ISShipDirectionSymbolContent) (on page 1463)
 Template Set Full Scale Direction Symbol (SMTemplatesetFullScaleDirSymbolContent) (on
page 1475)
See Also
Annotation Control Generator Module (Properties tab) (on page 1638)
Point Generator Module (Properties tab) (on page 1639)
Geometric Analyzer Module (Properties tab) (on page 1640)
Positioning Module (Properties tab) (on page 1640)

Annotation Control Generator Module (Properties tab)


Creates an annotation control object as a north arrow, which the system uses to represent each
individual north arrow. The annotation control object then manages the list of positioning
modules that can use that particular annotation and keeps track of the annotation's current
position at any point in time.
Only the Default (DefaultLabelControlGenerator) (on page 1265) annotation control generator is
supported for north arrows.
See Also
Content Module (Properties tab) (on page 1637)
Point Generator Module (Properties tab) (on page 1639)
Geometric Analyzer Module (Properties tab) (on page 1640)
Positioning Module (Properties tab) (on page 1640)

Drawings and Reports Reference Data Guide 1638


North Arrow Rule Manager

Leader Module (Properties tab)


The North Arrow Rule Manager does not support leader modules.

Point Generator Module (Properties tab)


Gathers data from the 3D geometry and places points on 2D objects that need labels,
dimensions, or matchlines.
The system can generate the point on any number of object locations, depending on the point
generator module that you use. This includes, but is not limited to, the object origin, control
point, straight feature end point, and so forth. A point generator can place one or multiple points
on the same object. No annotations are created with this module.
The list of supported point generator modules follows. Names in parentheses are as identified in
the .xml files.
 Absolute Points (ISAbsolutePointLabelPG) (on page 1120)
 Control Point Only (DrawingPGCPThenNone) (on page 1260)
 Control Point then Local CS Origin then Center (DrawingPGControlPoint) (on page 1261)
 Default Marine Point (ISRulesetPointGenerator) (on page 1276)
 Hanger Key Plan Control Point then Support Location (DrawingPGKeyPlanControlPoint) (on
page 1310)
 Inside or Along 2D Curve (InsideOrAlongCurve2D) (on page 1321)
 Key Point (DefaultLabelPointGenerator) (on page 1338)
 Linear Object Endpoints (DrawingPGLinear) (on page 1357)
 Linear Pipe Endpoints (DrawingPGPipeSegments) (on page 1357)
 Local Coordinate System Origin (DrawingPGLocalCS) (on page 1359)
 Local CS Origin with Object Axis (DrawingPGEquipmentStyle2) (on page 1360)
 MidPoint (ISMidPointLabelPG) (on page 1389)
 Nozzle (DrawingPGNozzleandBrace) (on page 1401)
 Point at Corner Cut (MHDrawingPGCornerCut) (on page 1428)
 Point for Profile Sketch Bevel Shape (SMProfileSketchBevelShapeLabelsPG) (on page
1431)
 Point on Remarking Curve along Girth (SM3DDwgRemarkingGirthLengthPG) (on page
1432)
 Points Along 2D Curve (ISDwgPointsAlongCurve2D) (on page 1433)
 Points Along 2D Range (ISDwgPointsAlongRange2D) (on page 1436)
 Points at Manufacturing Sketch Coordinates (MfgSketchPG) (on page 1437)
 Points by 2D Shape Type (SMDwgPointsByType) (on page 1438)
 Points by Associated Object ID (SMPointsByAssociateObjectID) (on page 1439)

Drawings and Reports Reference Data Guide 1639


North Arrow Rule Manager

 Points for View (ISDwgPointsForView) (on page 1440)


 Profile Weld Points (SMDwgProfileWeldsPG) (on page 1448)
 Trench (CivilElevationPointGenerator) (on page 1481)
 Weld Point (DrawingPGWelds) (on page 1494)
See Also
Content Module (Properties tab) (on page 1637)
Annotation Control Generator Module (Properties tab) (on page 1638)
Geometric Analyzer Module (Properties tab) (on page 1640)
Positioning Module (Properties tab) (on page 1640)

Geometric Analyzer Module (Properties tab)


Evaluates the points placed by the point generator module. The selected module groups or
deletes points as needed. This module does not create any annotations.
 No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) (on page 1398)
See Also
Content Module (Properties tab) (on page 1637)
Annotation Control Generator Module (Properties tab) (on page 1638)
Point Generator Module (Properties tab) (on page 1639)
Positioning Module (Properties tab) (on page 1640)

Positioning Module (Properties tab)


Determines the position of a north arrow.
Some positioning modules consider clear space when readying north arrows for placement.
Alternately, other positioning modules determine an absolute position at which to place the north
arrow without regard to clear space.
The list of supported positioning modules follows. Names in parentheses are as identified in the
.xml files.
 Absolute XY Offset (DrawingAbsolute) (on page 1130)
 Clear Space Quadrant 1 (DrawingQuadOne) (on page 1224)
 Clear Space Quadrant 2 (DrawingQuadTwo) (on page 1229)
 Clear Space Quadrant 3 (DrawingQuadThree) (on page 1234)
 Clear Space Quadrant 4 (DrawingQuadFour) (on page 1240)
See Also
Content Module (Properties tab) (on page 1637)
Annotation Control Generator Module (Properties tab) (on page 1638)
Point Generator Module (Properties tab) (on page 1639)
Geometric Analyzer Module (Properties tab) (on page 1640)

Drawings and Reports Reference Data Guide 1640


North Arrow Rule Manager

Relationships Tab
Displays the name of the selected template and the list of rules that reference that template, as
well as the view styles that use those rules.
Information displayed on the Relationships tab helps you determine the impacts that changes
to the template can have on other label rules and view styles.
Click Reset to revert the template to the initial state. This action also discards all templates that
you have added to the rule, leaving only the original template. Click Cancel to discard all
template modifications and exit the Rule Manager. Click Save to save all changes. Click Save &
Close to save all changes and exit the Rule Manager.

See Also
Comments Tab (on page 1112)
Properties Tab (on page 1103)

Comments Tab
Allows you to type notes that the system copies to the top of the .xml file.

Click Reset to revert the template to the initial state. This action also discards all templates that
you have added to the rule, leaving only the original template. Click Cancel to discard all
template modifications and exit the Rule Manager. Click Save to save all changes. Click Save &
Close to save all changes and exit the Rule Manager.
See Also
Properties Tab (on page 1103)
Relationships Tab (on page 1111)

Drawings and Reports Reference Data Guide 1641


APPENDIX E

Overview of North Arrow Rule Properties


This appendix contains descriptions of all the north arrow rule properties available to apply to a
north arrow created using the Drawings and Reports task. North arrow rule properties are
editable either from within the .xml template or by using the North Arrow Rule Manager. Both
methods of editing the north arrow rule are described here.
For more information, see North Arrow Rule Manager (on page 1633).

Absolute Points (ISAbsolutePointLabelPG)


Places a point on each end of straight features and members.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>ISAbsolutePointLabelPG</pgModule>
</pointGeneratorSettings>

Customization
None

Example

1 - Labels placed by the IS_ProfileSketch_Arial_2.5mm label using points created by


ISAbsolutePointLabelPG.
2 - Labels placed by the StrMfg ProfileSketch Detail Name_Voffset label using points created
by ISAbsolutePointLabelPG.

Drawings and Reports Reference Data Guide 1642


Overview of North Arrow Rule Properties

Absolute XY Offset (DrawingAbsolute)


Positions labels at an absolute horizontal, vertical, or angular position, depending on view
direction.

Usage in Label Template XML


<posModules>
<posModule value="DrawingAbsolute">
<hOffset>.005</hOffset>
<vOffset>-.005</vOffset>
<angle>1</angle>
<connectPoint>4</connectPoint>
</posModule>
</posModules>

Customization
hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1643


Overview of North Arrow Rule Properties

angle
Controls the vertical, horizontal, or absolute angle of a label.
If you are using the Absolute XY Offset (DrawingAbsolute) positioning module, then type a
floating point number as the value. You must type a number greater than negative pi/2 and
less than or equal to positive pi/2. Additionally, you must set the value in radians, not
degrees. The default value when you use this module is 0.0.
The following example demonstrates an Absolute setting.

1 - East label
2 - North Label

If you use the Clear Space Margin with Dimensions (DwgMatchlineWithDim) positioning
module, then you can specify 0 to set a Horizontal angle or 1 to specify a Vertical angle.
The default value when you use this module is 1.
The following two examples demonstrate horizontally and vertically placed labels.

Drawings and Reports Reference Data Guide 1644


Overview of North Arrow Rule Properties

1 - Horizontally placed label

Drawings and Reports Reference Data Guide 1645


Overview of North Arrow Rule Properties

1 - Vertically placed label

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point. The range of options is indicated by colored dots in the following
graphic. The connectPoint is placed at the TopRight.

Drawings and Reports Reference Data Guide 1646


Overview of North Arrow Rule Properties

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to manually edit the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1647


Overview of North Arrow Rule Properties

Clear Space Quadrant 1 (DrawingQuadOne)


Positions labels in the first quadrant (upper-right) based on the positioning point. This module is
used with DrawingQuadTwo, DrawingQuadThree, and DrawingQuadFour. These modules do
not have to follow a certain order.

Usage in Label Template XML


<posModules>
<posModule value="DrawingQuadOne"/>
<positioningPoint>4</positioningPoint>
<hOffset>0.02</hOffset>
<vOffset>0.02</vOffset>
<connectPoint>4</connectPoint>
<granularity>1</granularity>
<labelOffset>0.04</labelOffset>
<posModule value="DrawingQuadTwo"/>
<posModule value="DrawingQuadThree"/>
<posModule value="DrawingQuadFour"/>
</posModules>

Customization
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.

Drawings and Reports Reference Data Guide 1648


Overview of North Arrow Rule Properties

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.

Drawings and Reports Reference Data Guide 1649


Overview of North Arrow Rule Properties

hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1650


Overview of North Arrow Rule Properties

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point. The range of options is indicated in colored dots in the following
graphic. The ConnectPoint is placed at the TopRight.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to manually edit the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1651


Overview of North Arrow Rule Properties

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1652


Overview of North Arrow Rule Properties

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.
Additional customization is available in the labelSettings section of the XML file. For
more information, see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 1653


Overview of North Arrow Rule Properties

Clear Space Quadrant 2 (DrawingQuadTwo)


Positions labels in the second quadrant (lower-right) based on the positioning point. This module
is used with DrawingQuadOne, DrawingQuadThree, and DrawingQuadFour. These modules do
not have to follow a certain order.

Usage in Label Template XML


<posModules>
<posModule value="DrawingQuadOne"/>
<posModule value="DrawingQuadTwo"/>
<positioningpoint>4</positioningPoint>
<granularity>1</granularity>
<connectPoint>4</connectPoint>
<labelOffset>0.04</labelOffset>
<posModule value="DrawingQuadThree"/>
<posModule value="DrawingQuadFour"/>
<hOffset>0.02</hOffset>
<vOffset>0.02</vOffset>
</posModules>

Customization
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.

Drawings and Reports Reference Data Guide 1654


Overview of North Arrow Rule Properties

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.

Drawings and Reports Reference Data Guide 1655


Overview of North Arrow Rule Properties

hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1656


Overview of North Arrow Rule Properties

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point.
The range of options is indicated in colored dots in the following graphic. The connectPoint
is placed at the TopRight.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options are available for manually editing the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1657


Overview of North Arrow Rule Properties

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Additional customization is available in the labelSettings section of the XML file. For
more information, see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 1658


Overview of North Arrow Rule Properties

Clear Space Quadrant 3 (DrawingQuadThree)


Positions labels in the third quadrant (lower-left) based on the positioning point. This module is
used with DrawingQuadOne, DrawingQuadTwo, and DrawingQuadFour. These modules do not
have to follow a certain order.

Usage in Label Template XML


<posModules>
<posModule value="DrawingQuadOne"/>
<posModule value="DrawingQuadTwo"/>
<posModule value="DrawingQuadThree"/>
<positioningPoint>4</positioningPoint>
<hOffset>0.02</hOffset>
<vOffset>0.02</vOffset>
<connectPoint>4</connectPoint>
<granularity>1</granularity>
<labelOffset>0.04<labelOffset>
<posModule value="DrawingQuadFour"/>
</posModules>

Customization
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.

Drawings and Reports Reference Data Guide 1659


Overview of North Arrow Rule Properties

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.

Drawings and Reports Reference Data Guide 1660


Overview of North Arrow Rule Properties

hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1661


Overview of North Arrow Rule Properties

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point.
The range of options is indicated by colored dots in the following graphic. The connectPoint
is placed at the TopRight point.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to edit the .xml file.


 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1662


Overview of North Arrow Rule Properties

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1663


Overview of North Arrow Rule Properties

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.
Additional customization is available in the labelSettings section of the XML file. For
more information, see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 1664


Overview of North Arrow Rule Properties

Clear Space Quadrant 4 (DrawingQuadFour)


Positions label in the fourth quadrant (upper-left) based on the positioning point. This module is
used with DrawingQuadOne, DrawingQuadTwo, and DrawingQuadThree. These modules do
not have to follow a certain order.

Usage in Label Template XML


<posModules>
<posModule value="DrawingQuadOne"/>
<posModule value="DrawingQuadTwo"/>
<posModule value="DrawingQuadThree"/>
<posModule value="DrawingQuadFour"/>
<positioningPoint>4</positioningPoint>
<hOffset>0.02</hOffset>
<vOffset>0.02</vOffset>
<connectPoint>4</connectPoint>
<granularity>1</granularity>
<labelOffset>0.04</labelOffset>
</posModules>

Customization
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.

Drawings and Reports Reference Data Guide 1665


Overview of North Arrow Rule Properties

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.

Drawings and Reports Reference Data Guide 1666


Overview of North Arrow Rule Properties

hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1667


Overview of North Arrow Rule Properties

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point.
The range of options is indicated by colored dots in the following graphic. The connectPoint
is placed at the TopRight point.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to manually edit the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1668


Overview of North Arrow Rule Properties

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1669


Overview of North Arrow Rule Properties

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.
Additional customization is available in the labelSettings section of the XML file. For
more information, see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 1670


Overview of North Arrow Rule Properties

Control Point Only (DrawingPGCPThenNone)


Places a point for labeling or dimensioning on an object's control point. If no control point exists,
then the software does not place a label or dimension.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGCPThenNone</pgModule>
</pointGeneratorSettings>

Customization
None

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1671


Overview of North Arrow Rule Properties

Control Point then Local CS Origin then Center


(DrawingPGControlPoint)
Places a point for labeling or dimensioning on an object's control point. If no control point exists,
then the software places the point on the object's origin. If the origin cannot be found, then the
software places the point at the 2D-projected location of the center of the object's 3D range.

1 - Equipment origin point


2 - Dimension

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGControlPoint</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1672


Overview of North Arrow Rule Properties

Default (DefaultLabelControlGenerator)
Currently used by all label templates. Generates a label control for each label that is used to run
the positioning modules.

Usage in Label Template XML


<annotationControlGenerator>
<acgModule>DefaultLabelControlGenerator</acgModule>
<labelLayer>MATCHLINE_LABELS</labelLayer>
<priority>1</priority>
</annotationControlGenerator>

Customization
labelLayer
Allows you to specify the 2D layer on which the software automatically places labels.
The following illustration shows an equipment object with a label placed on the layer
specified in the text box.

1 - Equipment object
2 - Label
3 - Text Box Properties dialog box specifying the
layer on which the label resides

Drawings and Reports Reference Data Guide 1673


Overview of North Arrow Rule Properties

priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.
The software attempts to place an annotation (such as a label or a dimension) in clear
space as close as possible to that object's Connect Point. Multiple annotations do not
overlap. The Priority property allows you to assign a priority to each annotation, with 1
being the highest priority. The software places the annotation with the highest priority
closest to that object's Connect Point. Additional annotations with lower priorities are
placed further away from the corresponding object's Connect Point.
To define the priority, type a positive integer in the Priority text box.

1 - Equipment labels placed with Priority set to 1


2 - Structure label placed with Priority set to 2

Drawings and Reports Reference Data Guide 1674


Overview of North Arrow Rule Properties

1 - Equipment label placed with Priority set to 2


2 - Structure label placed with Priority set to 1

Default (DrawingLabelHelper)
Outputs data in a text box that is taken from a specified report label. Two conditions must exist
for this content module to work properly:
 The drawing view must be linked to a report. If this condition is not met, an error is logged in
the Smart 3D Error Log.
 The item being labeled in the view style must be in the report. If this condition is not met, a
question mark (?) is displayed.
Type 0 to display the label regardless of an error.

1 - Error label

Type -1 to suppress the label when an error occurs.

1 - Empty label

Drawings and Reports Reference Data Guide 1675


Overview of North Arrow Rule Properties

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingLabelHelper"/>
<ID attributeName="Equipment Plan_Equipment_Name">
Equipment Plan_Equipment_Name.rtp</ID>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
The ignoreError property is unavailable when you define the symbol path label.
For more information, see Symbol Path Label (on page 1474).
symbolPathLabel
Specifies which report template contains the symbol file names for the label.

 The ID attributeName value must match the name in the Value box in the Text Box
Properties dialog box for the label template .sym file you are modifying, as shown
below:

Drawings and Reports Reference Data Guide 1676


Overview of North Arrow Rule Properties

 For more information on modifying label templates, see Create a Compound Label with
a Combined Symbol (on page 748).

Examples
Equipment label:

Bubble label with no content and ignoreError value of 0 (or ignoreError is not defined):

Bubble label with no content and ignoreError value of -1:

Drawings and Reports Reference Data Guide 1677


Overview of North Arrow Rule Properties

Default Marine Point (ISRulesetPointGenerator)


Places a point for labeling on the 2D curves representing a 3D object at the control point of the
object.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>ISRulesetPointGenerator</pgModule>
</pointGeneratorSettings>

Customization
None

Example
The software places profile mounting angle and profile thickness labels (circled in red) using
points created by ISRulesetPointGenerator.

Display Empty/Error Labels


Specifies whether or not the system places a label if the software returns no content or an
error for the label.
 Clear the Display Empty/Error Labels check box to suppress any empty labels or an error
for the label.
 Select the Display Empty/Error Labels check box if you want the label to display
regardless of empty content or an error. This option is selected by default.
The following example shows one of two results when the Display Empty/Error Labels option
is selected. In this case, an empty label displays even though the content module found no data
with which to populate the label.

1 - Empty label

Drawings and Reports Reference Data Guide 1678


Overview of North Arrow Rule Properties

In the next example, the Display Empty/Error Labels check box is selected as well. However,
in this case, the content module encountered an error while attempting to process the label.
Therefore, an error label displays.

1 - Error label

 The Display Empty/Error Labels option is available for all content modules.
 The following options allow you to manually edit the .xml file:
 Type -1 to suppress the label when an error occurs.
 Type 0 to display the label regardless of an error. This is the default value.
 Enclose either of the above values within the following .xml tags.
<ignoreError>0</ignoreError>

Drawings and Reports Reference Data Guide 1679


Overview of North Arrow Rule Properties

Hanger Key Plan Control Point then Support Location


(DrawingPGKeyPlanControlPoint)
Generates a point at the location of the latest Key Plan Callout control point subtype. Only
control points placed as Support as parent or Support component as parent are considered.
If no control points with the Key Plan Callout subtype exist, then a point is generated at the
support origin.
This module is typically used for drawings containing pipe hangers or supports.

1 - Dimension
2 - Control point
3 - Support origin

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGKeyPlanControlPoint</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1680


Overview of North Arrow Rule Properties

Inside or Along 2D Curve (InsideOrAlongCurve2D)


Places a point along a 2D curve.
The 2D curve must have one or more curves.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>InsideOrAlongCurve2D</pgModule>
<pgModuleSettings>
<locations>
<location id="2" target="0" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
location id

XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

At first end 3
At the first end point of curve.

Drawings and Reports Reference Data Guide 1681


Overview of North Arrow Rule Properties

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

target
The curve used for determining location.

XML
value

Drawings and Reports Reference Data Guide 1682


Overview of North Arrow Rule Properties

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 2 (Inmost) or 12 (At curve ratio).

Drawings and Reports Reference Data Guide 1683


Overview of North Arrow Rule Properties

Key Point (DefaultLabelPointGenerator)


Generates a point in the middle of the 2D range of an object. Used for name labels on
equipment and other non-linear objects.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>DefaultLabelPointGenerator</pgModule>
</pointGeneratorSettings>

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Knuckle Angle Symbol


(ISKnuckleAngleSymbolContent)
Creates a symbol containing the knuckle angle value obtained from the embedded report.

Knuckle angle symbol

Usage in Label Template XML


<label>
<content>
<contentModule value="ISKnuckleAngleSymbolContent"/>
<ID attributeName="Scantling Knuckle Surface Angle">
Scantling Knuckle Surface Angle.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Drawings and Reports Reference Data Guide 1684


Overview of North Arrow Rule Properties

Label Symbol File


Controls the appearance of symbol graphics to be placed as a label. You can edit this file to
add, remove, or modify the existing graphics and symbol origin location. Graphics can include
lines, arcs, circles, text boxes, fills, and so forth. The symbol origin serves as the handle that the
automatic labeling engine uses to place the label.

Modify the symbol file


1. Click Launch SmartSketch .
SmartSketch Drawing Editor launches.
2. Within SmartSketch Drawing Editor, add, remove, or modify graphics and symbol origin for
your label.
3. Save your changes and exit SmartSketch Drawing Editor.

 Label symbol files contain graphics, and unlike many symbol files, are not associated with
database queries.
 If you open a symbol file, save your changes and exit SmartSketch Drawing Editor before
continuing work in the Matchline Rule Manager, the Label Rule Manager, or the North
Arrow Rule Manager. For more information, see Matchline Rule Manager (on page 1606),
Label Rule Manager (on page 1099), and North Arrow Rule Manager (on page 1633).

Linear Object Endpoints (DrawingPGLinear)


Generates a label at both ends of a pipe segment, structure member, or grid line.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGLinear</pgModule>
</pointGeneratorSettings>

Customization
None

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1685


Overview of North Arrow Rule Properties

Linear Pipe Endpoints (DrawingPGPipeSegments)


This module has been replaced by the DrawingPGLinear module. For more information, see
Linear Object Endpoints (DrawingPGLinear) (on page 1357).

Local Coordinate System Origin (DrawingPGLocalCS)


Places a point for labeling or dimensioning on an object's coordinate system origin.

1 - Label
2 - Point for labeling

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGLocalCS</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1686


Overview of North Arrow Rule Properties

Local CS Origin with Object Axis


(DrawingPGEquipmentStyle2)
Places a label point at the local coordinate system position of an object, typically equipment.
This point generator is used with the geometric analyzer Object Axis
(DrawingGAEquipmentStyle2) (on page 1401), the content module Object Coordinates
(DrawingEquipmentStyle2Content) (on page 1825), and the positioning module
DwgMatchlineWithDim (see "Clear Space Margin with Dimensions (DwgMatchlineWithDim)" on
page 1191).

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule value="DrawingPGEquipmentStyle2">
<orientation>1</orientation>
<pgmodule>
</pointGeneratorSettings>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Drawings and Reports Reference Data Guide 1687


Overview of North Arrow Rule Properties

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

Drawings and Reports Reference Data Guide 1688


Overview of North Arrow Rule Properties

Manufacturing Margin Symbol


(ISMfgMarginSymbolContent)
Creates a symbol containing the plate margin value obtained from the embedded report.

Manufacturing margin symbol

Usage in Label Template XML


<label>
<content>
<contentModule value="ISMfgMarginSymbolContent"/>
<ID attributeName="MfgMarginValue">MfgMarginValue.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Manufacturing Pin Height Label


(SMDwgMfgPinHeightLabelContent)
Creates labels containing the pin height obtained from the embedded report.

Usage in Label Template XML

<label>
<content>
<contentModule value="SMDwgMfgPinHeightLabelContent">
<eliminateHeight>0</eliminateHeight>
</contentModule>
<ID attributeName="PinHeight">StrMfg PinJig PinHeight.rtp</ID>
</content>
</label>

Customization
eliminateHeight

Drawings and Reports Reference Data Guide 1689


Overview of North Arrow Rule Properties

Eliminates labels with a value less than or equal to the specified pin height value, in
millimeters.
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Manufacturing Profile Margin Symbol


(SMDwgMfgProfileMarginSymContent)
Creates a symbol containing the manufacturing profile margin obtained from the embedded
report.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgMfgProfileMarginSymContent"/>
<ID attributeName="MfgProfileMarginValue">
MfgProfileMarginValue.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

MidPoint (ISMidPointLabelPG)
Places a label point on the 2D curves representing a 3D object at the center of the range box of
the object.

Usage in Dimension or Label Template XML


<pointGeneratorSettings>
<pgModule>ISMidPointLabelPG</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1690


Overview of North Arrow Rule Properties

No Grouping or Filtering (Default)


(DefaultLabelGeometricAnalyzer)
Used to place a label on the origin or control point of an object. This module does not perform
any grouping. Currently used by most non-linear labels.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DefaultLabelGeometricAnalyzer</gaModule>
</geometricAnalyzerSettings>

Customization
None

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

No Label Content (DrawingNoContent)


Returns no content.
Type -1 to suppress a label when an error occurs.

1 - Error label

Drawings and Reports Reference Data Guide 1691


Overview of North Arrow Rule Properties

Type 0 to display the label regardless of an error.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingNoContent"/>
<ignoreError>0</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.

Drawings and Reports Reference Data Guide 1692


Overview of North Arrow Rule Properties

North Arrow (DrawingNArrowContent)


Determines the direction of true north for the North Arrow symbol.

Usage in Label Template XML


<label
<content>
<contentModule value="DrawingNArrowContent"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Example of the North Arrow symbol

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs. Type 0 to display the label regardless of
an error.

Drawings and Reports Reference Data Guide 1693


Overview of North Arrow Rule Properties

Nozzle (DrawingPGNozzleandBrace)
Generates a point using the position of pipe nozzles and related shape objects. Allows a label to
be placed on a nozzle object. This point generator must be used with the Clear Space Radial
from Object Center with Clustering (DrawingCentroid) (on page 1247) positioning module.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGNozzleandBrace</pgModule>
</pointGeneratorSettings>

Customization
None

Pin Jig Seam Offset Label (SMDPinJigSeamOffsetCM)


Gets the girth length of the curve for the intersection point and populates the label text box.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDPinJigSeamOffsetCM"/>
<Side>left</Side>
</content>
</label>

Customization
Side
The side of the curve that can be used to locate the label. Select Left or Right.

1 - Left
2 - Right

Drawings and Reports Reference Data Guide 1694


Overview of North Arrow Rule Properties

Piping Elevation (DrawingBOLabelContent)


Uses data from reports to label elevations of routing objects, such as pipe, ducts, cable trays,
and conduit.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingBOLabelContent"/>
<ID attributeName="Piping Plan_Routable_INV Elev_M">
Piping Plan_Routable_INV Elev_M.rtp</ID>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of

Drawings and Reports Reference Data Guide 1695


Overview of North Arrow Rule Properties

the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).

Example

Plate Angle Symbol (ISPlateAngleSymbolContent)


Computes the angle of the non-target plate with reference to the target plate and places the
mounting angle symbol. The module obtains the plate angle value from the embedded report.
The orientation of the symbol indicates the mounting side of the plate.

Plate angle symbol

A symbol is not placed when:


 The mounting angle is 90º.
 The plate is not planar.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISPlateAngleSymbolContent"/>
ID attributeName="Scantling Plate Mounting Angle">
Scantling Plate Mounting Angle.rtp</ID>
</content>
</label>

Drawings and Reports Reference Data Guide 1696


Overview of North Arrow Rule Properties

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Plate Grid Name Label


(SMDwgPlateGridNameLabelContent)
Creates labels for plate grid names.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgPlateGridNameLabelContent"/>
</content>
</label>

Customization
None

Point at Corner Cut (MHDrawingPGCornerCut)


Sets the control points used to place a corner cut label on an object, and the position along the
curve at the control point.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>MHDrawingPGCornerCut</pgModule>
<pgModuleSettings>
<locations>
<location id="1" target="0" />
<location id="12" target="0" curveRatio="0.25" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Drawings and Reports Reference Data Guide 1697


Overview of North Arrow Rule Properties

Customization
location ID XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Drawings and Reports Reference Data Guide 1698


Overview of North Arrow Rule Properties

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Drawings and Reports Reference Data Guide 1699


Overview of North Arrow Rule Properties

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 12 (At curve ratio).

Point for Profile Sketch Bevel Shape


(SMProfileSketchBevelShapeLabelsPG)
Generates a point for each label on the bevel shape.

1 - Point for bevel shape

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SMProfileSketchBevelShapeLabelsPG</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1700


Overview of North Arrow Rule Properties

Point on Remarking Curve along Girth


(SM3DDwgRemarkingGirthLengthPG)
Places a point at the midpoint of two intersection points on a remarking line curve along the
horizontal and/or vertical girth length.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SM3DDwgRemarkingGirthLengthPG</pgModule>
<Horizontal>0</Horizontal>
<Vertical>1</Vertical>
</pointGeneratorSettings>

Customization

1 - Horizontal remarking line


2 - Vertical remarking line
- Intersection point
- Point

Horizontal
Adds points to horizontal remarking line girth curves at the midpoints of intersection points.
 Select for on (the .xml value is 1).
 Clear for off (the .xml value is 0).
Vertical
Adds points to vertical remarking line girth curves at the midpoints of intersection points.
 Select for on (the .xml value is 1).
 Clear for off (the .xml value is 0).

Drawings and Reports Reference Data Guide 1701


Overview of North Arrow Rule Properties

Points Along 2D Curve (ISDwgPointsAlongCurve2D)


Places one or more points along the 2D curve representing a 3D object.
The 2D curve of the 3D object must have one or more curves.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>ISDwgPositionByCurve2D</pgModule>
<pgModuleSettings>
<locations>
<location id="3" targetName='FirstEnd'/>
<location id="12" target="0" curveRatio="0.25" />
<location targetName='TemplateBtmCrv'/>
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
location id

XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

Drawings and Reports Reference Data Guide 1702


Overview of North Arrow Rule Properties

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

Drawings and Reports Reference Data Guide 1703


Overview of North Arrow Rule Properties

target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 12 (At curve ratio).


targetName
Specifies a name for the target curve. The name is an attribute on an object in the drawing
view. The valid name is TemplateMidLine.
Specify target or targetName. Do not specify both.

Drawings and Reports Reference Data Guide 1704


Overview of North Arrow Rule Properties

Points Along 2D Range (ISDwgPointsAlongRange2D)


Places one or more points on a 2D representation of a 3D object. You can specify multiple
points.

Usage in Label Template XML


<label>
<pointGeneratorSettings>
<pgModule>ISDwgPositionByRange2D</pgModule>
<rangePoint>0</rangePoint>
<rangePoint>1</rangePoint>
<rangePoint>2</rangePoint>
</pgModuleSettings>
</pointGeneratorSettings>
</label>

Customization
rangePoint
Specifies the position of a point on an object. You can specify multiple range points.

Key Points

0 Top Left

1 Top Middle

2 Top Right

3 Middle Left

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

Drawings and Reports Reference Data Guide 1705


Overview of North Arrow Rule Properties

Points at Manufacturing Sketch Coordinates


(MfgSketchPG)
Places points based on coordinate values in the manufacturing data XML created in the
Structural Manufacturing task.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>MfgSketchPG</pgModule>
<pgModuleSettings>
<parseGraphics>0</parseGraphics>
<pgTransform>
...
</pgTransform>
</pgModuleSettings>
</pointGeneratorSettings>
The parseGraphics property is only used for placing dimensions. See Dimension Rule
Manager (on page 1503) in the Smart 3D Drawings and Reports Reference Data Guide for more
information.

Customization
The following properties are used for dimensioning. There are no customizable
properties for this module when it is used for placing labels.
maxDimOffset
Determines the maximum linear paper space distance between consecutive witness lines in
a linear distance dimension group.
MaxWtnessLength
Controls the length of witness lines so that you can determine how far across the drawing
the line is drawn. Points that fall outside the maximum witness length are eliminated from
consideration.
overall
Places an additional dimension over each dimension chain cluster identified by the rule.
parseGraphics
Specifies whether to determine dimension point locations by examining object graphics or
by using the pgTransform XSLT information in the template. Set the value to -1 to process
the graphics and forward them to the Penetration Plate (PenPlatePointGenerator) point
generator module. Set the value to 0 to process the pgTransform information.
The annotation output is created by a content module, not this module.

Drawings and Reports Reference Data Guide 1706


Overview of North Arrow Rule Properties

Points by 2D Shape Type (SMDwgPointsByType)


Places one or more points at the center of the 2D shape representing a 3D object.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SMDwgPointsByType</pgModule>
<pgModuleSettings>
<ObjectType>Point</ObjectType>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
ObjectType
Specifies the 2D shape.

Point

Circle

Rectangle

Line

Line String

Ellipse

Drawings and Reports Reference Data Guide 1707


Overview of North Arrow Rule Properties

Example
A non-target seam that intersects a target plate in two locations (such as a transverse hull seam
intersecting a deck) receives a point at each intersection.

Points by Associated Object ID


(SMPointsByAssociateObjectID)
Places an annotation point for each 2D point in the group and orients the label with respect to
any other object in the drawing. In the following example, the label will be oriented tangential to
the TemplateBtmCrv.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SMPointsByAssociateObjectID</pgModule>
<pgModuleSettings>
<locations>
<location targetName='TemplateBtmCrv'/>
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
targetName
Specifies a name for the target curve. The name is an attribute on an object in the drawing
view. Valid names are PlateContour and TemplateBtmCrv.

Example
StrMfg Templateset Midline Symbol
A reference curve that intersects a template will get a point at the intersection. This point is
associated with the reference curve and has template OID (Object ID) as its ID.

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1708


Overview of North Arrow Rule Properties

Points for View (ISDwgPointsForView)


Places a point to be used for north arrow or view labels at the center of a view.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>ISDwgPointsForView</pgModule>
</pointGeneratorSettings>

Customization
None

Profile Angle Symbol (ISProfileAngleSymbolContent)


Creates a symbol containing the profile mounting angle value obtained from the embedded
report. The orientation of the symbol indicates the mounting side of the profile.

Profile angle symbol

A symbol is not placed when:


 The mounting angle is 90º.
 The profile is twisted and has multiple regions with different mounting angles.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISProfileAngleSymbolContent"/>
<ID attributeName="Scantling Profile Mounting Angle">
Scantling Profile Mounting Angle.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.
The format is:
< ID attributeName="symbol file name (without .sym extension)">report file name.rtp</ID >
You can define the report template location in the label template XML file.

Drawings and Reports Reference Data Guide 1709


Overview of North Arrow Rule Properties

Profile Sketch Bevel Symbol


(SMProfileSketchBevelSymbolCM)
Outputs the bevel symbol with labels on the profile sketch.

Usage in Label Template XML


<label>
<content>
<contentModule value = "SMProfileSketchBevelSymbolCM"/>
</content>
</label>

Customization
None

Example

Profile Sketch Label


(SMDwgProfileSketchLabelsContent)
Creates labels for profile sketches.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgProfileSketchLabelsContent"/>
</content>
</label>

Customization
You can replace the content module in the label template with any .dll name that uses
IJDwgProfileSketchLabelGenerator to make it the current LabelGenerator for profile
sketches.

Drawings and Reports Reference Data Guide 1710


Overview of North Arrow Rule Properties

Profile Weld Points (SMDwgProfileWeldsPG)


Places points on the 2D curves representing a 3D profile, for use in placing weld labels.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SMDwgProfileWeldsPG</pgModule>
<pgModuleSettings>
<locations>
<location id="1" targetName="Profile_Web" />
<location id="8" targetName="Profile_Flange" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
location ID

XML
value

Middle 1

At the middle point of a curve.

Top 7

On the top of the range box for


the curve.

Bottom 8

On the bottom of the range


box for the curve.

targetName
Specifies a name for the target curve. The name is an attribute on an object in the drawing
view. Valid names are Profile_Web and Profile_Flange.

Drawings and Reports Reference Data Guide 1711


Overview of North Arrow Rule Properties

Reference (DrawingReferenceLabelContent)
Uses data from reports to label objects in drawings. Typically, the value is an item number, but
data from any field in the report can be passed in. Two conditions must exist for this content
module to work properly:
 The drawing view must be linked to a report. If this condition is not met, an error is logged in
the SP3D Error Log.
 The item being labeled in the view style must be in the report. If this condition is not met, a
question mark (?) is displayed.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingReferenceLabelContent"/>
<ID attributeName="ItemTag">ItemTag.rtp</ID>
<ignoreError>0</ignoreError>
</content>
</label>

Drawings and Reports Reference Data Guide 1712


Overview of North Arrow Rule Properties

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.

Scantling Near Side or Far Side Direction Symbol


(SMDwgScantlingNSorFSDirectionContent)
Creates ship direction symbols based on whether the near side or the far side of a plate is
displayed.
The near side of a plate is the side with the most profile stiffeners.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgScantlingNSorFSDirectionContent"/>
<contentModuleSettings>
<directionSymbols>
<port>port.sym</port>
<starboard>starboard.sym</starboard>
<aft>aft.sym</aft>
<forward>forward.sym</forward>
<up>up.sym</up>
<down>down.sym</down>
</directionSymbols>
</contentModuleSettings>
</content>
</label>

Customization
directionSymbols
Contains options for the direction symbols.
port, starboard, aft, forward, up, down
Specify the symbol file (.sym) for each side. If a path for a file is not given, the file is located
in the same folder as the label template .xml file.

Drawings and Reports Reference Data Guide 1713


Overview of North Arrow Rule Properties

Sheet Direction
Specifies the view direction. Select Up, Down, Left, or Right.

1 - Up
2 - Down
3 - Left
4 - Right

Select the direction from the Sheet Direction list in the North Arrow Rule Manager. Alternately,
enclose the direction within the following .xml tags:
<directionValue>Right</directionValue>

Customization
None

Ship Direction Symbol


(ISShipDirectionSymbolContent)
Creates a ship direction symbol for a specified view direction. A symbol is selected based on the
ship direction matching a selected view direction.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISShipDirectionSymbolContent"/>
<contentModuleSettings>
<directionValue>Up</directionValue>
<directionSymbols>
<port>port.sym</port>
<starboard>starboard.sym</starboard>
<aft>aft.sym</aft>
<forward>forward.sym</forward>
<up>up.sym</up>
<down>down.sym</down>
</directionSymbols>
</contentModuleSettings>
</content>
</label>

Drawings and Reports Reference Data Guide 1714


Overview of North Arrow Rule Properties

Customization
directionValue
Specifies the view direction. Use Up, Down, Left, or Right.

1 - Up
2 - Down
3 - Left
4 - Right

directionSymbols
Specifies the symbol (.sym) file to use for each ship direction. Specify symbols for port,
starboard, aft, forward, up, and down. If a path for a file is not given, the file is located in
the same folder as the label template .xml file.

 View direction is the direction in paper space (that is, on the drawing sheet).
 Ship direction is determined within the view based on the location and direction of the view
relative to the model.

Examples
Ship direction is up for a directionValue of Up. The up option of directionSymbols is used:

Ship direction is starboard for a directionValue of Right. The starboard option of


directionSymbols is used:

Drawings and Reports Reference Data Guide 1715


Overview of North Arrow Rule Properties

Template Set Full Scale Direction Symbol


(SMTemplatesetFullScaleDirSymbolContent)
Creates a looking direction symbol for the view.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMTemplatesetFullScaleDirSymbolContent"/>
<contentModuleSettings>
<directionValue>Right</directionValue>
<directionSymbols>
<port>port.sym<port>
<starboard>starboard.sym</starboard>
<aft>aft.sym</aft>
<forward>forward.sym</forward>
<up>up.sym</up>
<down>down.sym</down>
</directionSymbols>
</contentModuleSettings>
</content>
</label>

Customization
port
Specify the port direction symbol file (.sym).
starboard
Specify the starboard direction symbol file (.sym).
aft
Specify the aft direction symbol file (.sym).
forward
Specify the forward direction symbol file (.sym).
up
Specify the up direction symbol file (.sym).
down
Specify the down direction symbol file (.sym).
If a path for a file is not given, the file is located in the same folder as the label
template XML file.

Example

Drawings and Reports Reference Data Guide 1716


Overview of North Arrow Rule Properties

Trench (CivilElevationPointGenerator)
Places label points at the start or end of the trench straight features and at the miter center of
the trench turn feature.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>CivilElevationPointGenerator</pgModule>
<pgModuleSettings>
<featureType>3</featureType>
<location>1</location>
<choice>1</choice>
<cardinalPoint>2</cardinalPoint>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
featureType
Determines whether to place a point for either the turn feature or the straight feature, or
both.
Type 1 to place a point for the straight feature. Type 2 to place a point for the turn feature.
Type 3 to place a point for both the straight feature and the turn feature.
location
Determines the location of the point that the software places on a straight or turn feature.
Type 1 to place the point at the start of the feature.

Type 2 to place the point at the end of the feature.

Drawings and Reports Reference Data Guide 1717


Overview of North Arrow Rule Properties

Type 3 to place the point along the turn.

choice
Allows you to select the trench features on which the software places points.
 The following options are available for manually editing the .xml file.
 Type 1 to place points on all features.
 Type 2 to place a point on the first feature only.
 Type 3 to place a point of the last feature only.
 Type 4 to place no points.
cardinalPoint
Determines the placement of the key, or cardinal, point on a feature.
Possible cardinal points for cross-section used in the trench feature are shown in the
diagram below.

The following options are available for manually editing the .xml file.
 Type 1 to place the Cardinal Point at the bottom left.
 Type 2 to place the Cardinal Point in the bottom center.
 Type 3 to place the Cardinal Point at the bottom right.
 Type 7 to place the Cardinal Point at the top left.
 Type 8 to place the Cardinal Point in the top center.
 Type 9 to place the Cardinal Point at the top right.

Drawings and Reports Reference Data Guide 1718


Overview of North Arrow Rule Properties

Weld Point (DrawingPGWelds)


Sets the control points used to place a weld symbol on an object and the position along the
curve at the control point. This module is used with the Weld Label Text (DrawingGAWelds) (on
page 1493) geometric analyzer.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGWelds</pgModule>
<pgModuleSettings>
<locations>
<location id="1" target="0" />
<location id="12" target="0" curveRatio="0.25" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
location id

XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

Drawings and Reports Reference Data Guide 1719


Overview of North Arrow Rule Properties

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

Drawings and Reports Reference Data Guide 1720


Overview of North Arrow Rule Properties

target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 12 (at curve ratio).

Drawings and Reports Reference Data Guide 1721


APPENDIX F

Appendix: Migrating Dimension Rules


This appendix describes the changes to dimension anchoring that make the functionality easier
to use.

Changes
1. The filter node is no longer used.
2. The value for dimensionAnchor in the main template is now the filename of the dimension
anchor template without the .xml extension.
See Also
Dimension Anchoring Overview (on page 1722)
Migration Activities (on page 1725)
Drawing/View Update Checker (on page 1727)

Dimension Anchoring Overview


Previously, the dimension anchoring functionality was cumbersome to use because of the way
the software tied the main dimension template to the anchor.

Set up anchoring (previous method)


1. Create a main dimension rule and template for dimensioning objects of type A.
2. Create an anchor dimension rule and template for including objects of type B into the
dimension chains created by the main rule.
3. Edit the main template to include the following:
<dimensionAnchorSet>
<dimensionAnchor value=“anchorFilter”/>
</dimensionAnchorSet>
4. Edit the anchor rule to include the following:
<filter>anchorFilter</filter>
5. Include both the main and anchor rules in the view style to be used.
The bold values (in this example, anchorFilter) are how the main template anchors to the
anchor rule. These values must be identical.
Notice the filter node in the dimension rule .xml file. This node has always been a source of
confusion because of its name – it was never intended to contain the name of an actual model
filter; rather, it simply contains an arbitrary text string that must match the value of the
dimensionAnchor in the main template.

Drawings and Reports Reference Data Guide 1722


Appendix: Migrating Dimension Rules

Migrate Dimension Rules Command Overview


Even though new instances of dimension anchoring are now easier to set up, you may have
existing templates and rules tied together by the older (filter-based) anchoring mechanism
described in the Dimension Anchoring Overview (on page 1722). A new tool,
MigrateDimensionRules.exe, is now available. This tool is delivered to the [Smart
3DInstallFolder]\Core\Container\Bin\Assemblies\Release folder.
See Also
Migrate Dimension Rules Command (on page 1723)
Migrate Dimension Rules Dialog Box (on page 1724)
Command Line Interface (on page 1725)

Migrate Dimension Rules Command


Open Migrate Dimension Rules
1. Double-click MigrateDimensionRules.exe.
-OR-
Type MigrateDimensionRules.exe at a command-line prompt, and then press ENTER.
For more information about the command-line interface, see Command Line Interface (on
page 1725).
The MIGRATE DIMENSION RULES dialog box displays.

For more information about this dialog box, see Migrate Dimension Rules Dialog Box (on page
1724).

Drawings and Reports Reference Data Guide 1723


Appendix: Migrating Dimension Rules

Migrate Dimension Rules Dialog Box


Select View Styles Folder
Specifies a view styles folder in shared content (such as
SharedContent\Drawings\Catalog\Rules\Orthographic). You must specify the location of the
view styles because the software must examine view styles that contain main dimension
rules as well as anchor rules to know whether anchoring is occurring.
Select Output Log Folder
Specifies where the software writes the log file. The default output log location is the
%TEMP% folder on the computer. When the migration is finished, the software writes a log
file called MigrateDimensionRules_[ViewStyleFolderName_YYYY_MM_DD_hh_mm_ss].log,
and saves it in the folder specified in the Select Output Log Folder box.

ViewStyleFolderName - Contains the view style rules that the software examines to
determine which dimension rules to migrate. Dimension rules are delivered in the
SharedContent\Drawings\Catalog\Rules\DimensionRules folder.
YYYY - The four-digit representation of the year.
MM - The two-digit representation of the month.
DD - The two-digit representation of the day.
hh - The two-digit representation of the hour, in 24-hour time format.
mm - The two-digit representation of the minute.
ss - The two-digit representation of the second.
Make folder backup copies
Copies the folders listed below before migration. Smart 3D appends a
YYYY_MM_DD_hh_mm_ss suffix to the copied folder names.
 SharedContent\Drawings\Catalog\Rules\DimensionRules
 SharedContent\Drawings\Catalog\Dimensions\Templates
Cancel
Closes the dialog box without migrating any dimension rules.
Update
Initiates the migration, and displays a progress bar that shows that the tool is busy. After
migration completes, the software displays the output log file contents.
See Also
Migrate Dimension Rules Command Overview (on page 1723)

Drawings and Reports Reference Data Guide 1724


Appendix: Migrating Dimension Rules

Command Line Interface


A non-graphical command-line interface is available for MigrateDimensionRules.exe. This
interface is particularly useful when you perform dimension rule migration as part of a set of
scripted commands. You can list the command line options by invoking the executable with the
/? switch from the command line prompt, as in the following example:
MigrateDimensionRules.exe /?
All behaviors of Migrate Dimension Rules are supported by the command line interface,
including:
 View styles folder specification
 Output log folder specification
 Toggle for making folder backup copies
See Also
Migrate Dimension Rules Command Overview (on page 1723)
Migrate Dimension Rules Dialog Box (on page 1724)

Migration Activities
The migration performs the following tasks.
 Adds a VERSION=“11.00” attribute to the root XML node of all dimension rules and
templates to signify that migration has taken place.
 If applicable, updates the dimensionAnchor value in every main template to refer to the
filename of the anchor template instead of the value of the filter node.
 Adds a comment before each filter node in dimension rules stating that the node is no
longer used for dimension anchoring.
 For anchor templates using the DummyGeomAnalyzer geometric analyzer, removes all
non-comment nodes except for pointGeneratorSettings and geometricAnalyzerSettings
and their descendants. This helps reduce clutter in these templates because the point
generator and geometric analyzer modules are the only ones used by anchors.
 Removes empty dimensionAnchorSet nodes from templates.
 Removes duplicate dimensionAnchor values from templates. For example:
<dimensionAnchorSet>
<dimensionAnchor value=“AnchorRuleName”/>
<dimensionAnchor value=“AnchorRuleName”/>
</dimensionAnchorSet>
becomes
<dimensionAnchorSet>
<dimensionAnchor value=“AnchorRuleName”/>
</dimensionAnchorSet>
 Removes duplicate dimensionAnchorSet nodes, leaving only the first one. For example:

Drawings and Reports Reference Data Guide 1725


Appendix: Migrating Dimension Rules

<dimensionAnchorSet>
<dimensionAnchor value=“AnchorRuleName1”/>
</dimensionAnchorSet>
<dimensionAnchorSet>
<dimensionAnchor value=“AnchorRuleName2”/>
</dimensionAnchorSet>
becomes
<dimensionAnchorSet>
<dimensionAnchor value=“AnchorRuleName1”/>
</dimensionAnchorSet>
 Adds a new XML node called pointLocation to the pointGeneratorSettings section for any
template that uses the DrawingPGRoutableObjHoriz point generator module. The
migration does this because the DrawingPGRoutableObjHoriz point generator module no
longer uses the rule’s filter node value for its point location property setting. This
pointLocation node takes on the value of the filter node in this template’s rule file.

The migration does not fix the following issues, but warns you about them in the log:
 View styles that reference nonexistent dimension rules
 Dimension rules that reference nonexistent dimension templates
 Dimension templates that reference nonexistent anchors
 Dimension templates that reference anchors that do not coexist in the same view style as
the main dimension rule
 Anchor templates that do not use the DummyGeomAnalyzer geometric analyzer module
 Dimension templates that, before migration, may have unintentionally anchored to more
than one anchor rule because of the possibility that multiple anchor rules in the view style
can have the same filter value
 Dimension templates that anchor to themselves

Drawings and Reports Reference Data Guide 1726


Appendix: Migrating Dimension Rules

On-the-Fly Migration (Dimension Rule Manager)


The Smart 3D Drawings software now expects that all dimension rules and templates are in a
post-migrated state before they are used. Because of this, if you use the Dimension Rule
Manager to open a dimension rule that has not been migrated (or whose template has not been
migrated), all dimension rules and templates in the parent view style are silently migrated before
the Dimension Rule Manager opens, and the software displays the following message:

Drawing/View Update Checker


Because any dimension anchors set up to use the previous filter logic no longer function as
expected, the software performs a check at the drawing or view update time that examines the
view styles in use to determine if they reference unmigrated dimension rules.
Unmigrated dimension rules do not contain the VERSION="11.00" attribute on the
root XML node.
If the software finds any unmigrated rules, then the checker halts the update process and
displays the following message:

If you have any content created with Smart 3D before version 2016, you must
run the Migrate Dimension Rules tool before you update any drawings that use the legacy
dimension rules and templates; otherwise, the software does not perform the updates.

Drawings and Reports Reference Data Guide 1727


SECTION 20

Annotation Modules
Annotation modules are used within label rules to analyze, place, and position text labels,
symbol labels, and dimensions. They are called by label templates or reports.
Annotation modules can be listed in any order in a label template, but the software processes
the modules in the following order:

1. Gathering Data: Point Generators


 A point generator gathers data from the geometry (either the 2D geometry drawn in a view,
or the associated 3D geometry in the model), and places points on the geometry.
 No annotations are created.
For more information, see Point Generators (on page 1730).

2. Analyzing Data: Geometric Analyzers


 A geometric analyzer evaluates the points placed by the point generator. Points can be
grouped or deleted as needed.
 No annotations are created.
For more information, see Geometric Analyzers (on page 1781).

3. Deciding What Annotations to Place: Content Modules and Control Generators


 A content module creates a label or dimension.
 A control generator creates a text box for a label.
 Labels are positioned at 0,0 of the view. Dimensions are positioned without regard to clear
space with other dimensions and labels.
 Annotations are ready for placement on the drawing view but are not in the correct positions.
For more information, see Content Modules (on page 1818), Control Generators (on page
1899), and Leader Modules (on page 2040).

4. Deciding Where to Place the Annotations: Positioning Modules


 A positioning module determines the position of a label or dimension and places it on the
drawing view.
 Clear space around the annotations is considered in placement.
 Annotations are ready for placement on the drawing view, and are now in the correct
positions.
For more information, see Positioning Modules (on page 1905).

5. Placing the Annotations: Content Modules and Leader Modules


 A dimension content module runs again to place dimensions on the drawing view.

Drawings and Reports Reference Data Guide 1728


Annotation Modules

 A leader module creates a leader for a label (when needed) and places labels on the
drawing view.
 Annotations are now on the drawing view.
For more information, see Content Modules (on page 1818) and Leader Modules (on page
2040).

Custom Annotation Modules


You can separate custom content from the delivered content through customized annotation
modules. This separation simplifies the deployment of content packages by allowing you to load
only the content that is required. The separation also allows you to customize the folder
structure as the content .dll files are registered through Update Custom Symbol Configuration
in Project Management. For more information, see Update Custom Symbol Configuration in the
Project Management User's Guide.
As the customized annotation modules are defined in the SystemSymbolConfiguration.xml file,
you must update all the required labels and dimension templates.
The custom annotation modules are supported only for Point Generators, Geometric
Analyzers, Content Modules, Positioning Modules, and Leader Modules.
Use the following steps to customize annotation modules:
1. Under [Reference Data Folder]\SharedContent\Bin, create a folder named
CustomizedAnnotation.
2. Point the annotation modules to the CustomizedAnnotation folder.
3. In Project Management, run Tools > Update Custom Symbol Configuration. For more
information, see Update Custom Symbol Configuration in the Project Management User's
Guide.
4. Under [Reference Data Folder]\SharedContent\XML, open the SystemSymbolConfig.xml
file.
5. Identify the ProgID name of the customized annotation module.

6. Update the content module value to match the ProgID name for the label or the dimension
template.

-
 The label templates are located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder.
 The dimension templates are located in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Dimensions\Templates folder.

Drawings and Reports Reference Data Guide 1729


Annotation Modules

In This Section
Point Generators ............................................................................1730
Geometric Analyzers ......................................................................1781
Content Modules ............................................................................1818
Control Generators .........................................................................1899
Positioning Modules .......................................................................1905
Leader Modules ..............................................................................2040

Point Generators
Point generator modules are used in Drawings label templates to place a point (or points) on
objects that need labels or dimensions. The point can be generated on the object origin, control
point, or other absolute positions. Point generators also place points for dimensions to use.
For information on the relationship of point generators to other annotation modules, see
Annotation Modules (on page 1728).

Topics
3D Object Center (DrawingPointGenerator) .................................. 1732
Control Point Only (DrawingPGCPThenNone) .............................. 1732
Control Point then Local CS Origin then Center (DrawingPGControlPoint) 1733
Local CS Origin with Object Axis (DrawingPGEquipmentStyle2).. 1734
Hanger Key Plan Control Point then Support Location (DrawingPGKeyPlanControlPoint) 1736
Points Along 2D Range (ISDwgPointsAlongRange2D) ................. 1736
Local Coordinate System Origin (DrawingPGLocalCS) ................ 1738
Point at Corner Cut (MHDrawingPGCornerCut) ............................ 1738
Note (DrawingPGByNote) .............................................................. 1741
Object Corners (DrawingPGObjectCorners) ................................. 1742
Opening Objects (DrawingPGOpeningObjects) ............................ 1743
Points at Manufacturing Sketch Coordinates (MfgSketchPG)....... 1744
Trench (CivilElevationPointGenerator) .......................................... 1745
Weld Point (DrawingPGWelds)...................................................... 1747
Inside or Along 2D Curve (InsideOrAlongCurve2D) ...................... 1750
Absolute Points (ISAbsolutePointLabelPG) ................................... 1753
Between Points (ISDimensionBtwPointsPG) ................................. 1753
Points Along 2D Curve (ISDwgPointsAlongCurve2D) ................... 1756
Points for View (ISDwgPointsForView) ......................................... 1759
MidPoint (ISMidPointLabelPG) ...................................................... 1759
Nearest Pin (ISPinJigPointsOnNearestPin) ................................... 1760
Profile Sketch Linear Feature (ISProfileSketchFeatureLinearDimPG) 1760
Profile Sketch Radial Feature (ISProfileSketchFeatureRadialDimPG) 1761
Default Marine Point (ISRulesetPointGenerator)........................... 1764
Pinjig Corners (SMDwgPinjigCornersDistancePG) ....................... 1764
Points by 2D Shape Type (SMDwgPointsByType) ....................... 1765
Profile Weld Points (SMDwgProfileWeldsPG) ............................... 1766
Points by Associated Object ID (SMPointsByAssociateObjectID) 1767
Point for Profile Sketch Bevel Shape (SMProfileSketchBevelShapeLabelsPG) 1768
Point on Remarking Curve along Girth (SM3DDwgRemarkingGirthLengthPG) 1768
Key Point (DefaultLabelPointGenerator) ....................................... 1769
Matchline (DrawingMatchlinePG) .................................................. 1770
DrawingPGCuttingPlane ................................................................ 1773

Drawings and Reports Reference Data Guide 1730


Annotation Modules

Linear Object Endpoints (DrawingPGLinear) ................................ 1773


Nozzle (DrawingPGNozzleandBrace) ........................................... 1774
Linear Pipe Endpoints (DrawingPGPipeSegments) ...................... 1774
Horizontal Linear Object Endpoints (DrawingPGStructHoriz) ....... 1775
Vertical Linear Object Endpoints (DrawingPGStructVert) ............. 1776
Penetration Plate (PenPlatePointGenerator) ................................. 1777
Template Offset (StrMfgTemplateOffsetPG) ................................. 1778
Template Set Offset (StrMfgTemplateSetOffsetPG) ..................... 1779

Drawings and Reports Reference Data Guide 1731


Annotation Modules

3D Object Center (DrawingPointGenerator)


Places a dimension at the center of the 3D range of an object.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPointGenerator</pgModule>
</pointGeneratorSettings>

Customization
None

Control Point Only (DrawingPGCPThenNone)


Places a point for labeling or dimensioning on an object's control point. If no control point exists,
then the software does not place a label or dimension.

1 - Equipment control point


2 - Dimension

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGCPThenNone</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1732


Annotation Modules

Control Point then Local CS Origin then Center


(DrawingPGControlPoint)
Places a point for labeling or dimensioning on an object's control point. If no control point exists,
then the software places the point on the object's origin. If the origin cannot be found, then the
software places the point at the 2D-projected location of the center of the object's 3D range.

1 - Equipment origin point


2 - Dimension

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGControlPoint</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1733


Annotation Modules

Local CS Origin with Object Axis


(DrawingPGEquipmentStyle2)
Places a label point at the local coordinate system position of an object, typically equipment.
This point generator is used with the geometric analyzer Object Axis
(DrawingGAEquipmentStyle2) (on page 1401), the content module Object Coordinates
(DrawingEquipmentStyle2Content) (on page 1825), and the positioning module
DwgMatchlineWithDim (see "Clear Space Margin with Dimensions (DwgMatchlineWithDim)" on
page 1191).

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule value="DrawingPGEquipmentStyle2">
<orientation>1</orientation>
<pgmodule>
</pointGeneratorSettings>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Drawings and Reports Reference Data Guide 1734


Annotation Modules

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

Drawings and Reports Reference Data Guide 1735


Annotation Modules

Hanger Key Plan Control Point then Support Location


(DrawingPGKeyPlanControlPoint)
Places dimension points on part geometry key points for lines and circles.
This module is typically used for drawings containing pipe hangers or supports.

1 - Dimension
2 - Equipment
3 - Support origin

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGKeyPlanControlPoint</pgModule>
</pointGeneratorSettings>

Customization
None

Points Along 2D Range (ISDwgPointsAlongRange2D)


Places one or more points on a 2D representation of a 3D object. You can specify multiple
points.

Usage in Label Template XML


<label>
<pointGeneratorSettings>
<pgModule>ISDwgPositionByRange2D</pgModule>
<rangePoint>0</rangePoint>
<rangePoint>1</rangePoint>
<rangePoint>2</rangePoint>

Drawings and Reports Reference Data Guide 1736


Annotation Modules

</pgModuleSettings>
</pointGeneratorSettings>
</label>

Customization
rangePoint
Specifies the position of a point on an object. You can specify multiple range points.

Key Points

0 Top Left

1 Top Middle

2 Top Right

3 Middle Left

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

Drawings and Reports Reference Data Guide 1737


Annotation Modules

Local Coordinate System Origin (DrawingPGLocalCS)


Places a point for labeling or dimensioning on an object's coordinate system origin.

1 - Equipment origin point


2 - Dimension

Although a content module creates the annotation output, this example shows how
this module affects the output.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGLocalCS</pgModule>
</pointGeneratorSettings>

Customization
None

Point at Corner Cut (MHDrawingPGCornerCut)


Sets the control points used to place a corner cut label on an object, and the position along the
curve at the control point.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>MHDrawingPGCornerCut</pgModule>
<pgModuleSettings>
<locations>
<location id="1" target="0" />
<location id="12" target="0" curveRatio="0.25" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Drawings and Reports Reference Data Guide 1738


Annotation Modules

Customization
location ID XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Drawings and Reports Reference Data Guide 1739


Annotation Modules

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Drawings and Reports Reference Data Guide 1740


Annotation Modules

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 12 (At curve ratio).

Note (DrawingPGByNote)
Generates points on individual objects for dimensioning using the General Notes and Catalog
Notes related to those objects and any design children. DrawingPGByNote allows placement of
a dimension from one point of an object to another point on the same object, such as
dimensions needed for individual hanger support components.

1 - Dimension points on single object


2 - Dimension point on the same object
3 - Dimension

Drawings and Reports Reference Data Guide 1741


Annotation Modules

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGByNote</pgModule>
</pointGeneratorSettings>

Customization
None

Object Corners (DrawingPGObjectCorners)


Places points at the four corners of an object's range in order to anchor matchlines to other
dimensioned objects.

1 - Object
2 - Points at corners of range box

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGObjectCorners</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1742


Annotation Modules

Opening Objects (DrawingPGOpeningObjects)


Generates dimension points for certain types of openings. The placement of points on the
opening depends on the type of opening that you are dimensioning. Alternately, the points are
placed at range vertex points.
You can generate dimension points for the following types of openings.
 Rectangle. The software generates points at each corner of the opening. The angles of the
rectangle must be 90 degrees.

1 - Dimension points
2 - Rectangular opening

 Circle. The software generates a point in the center of the opening.


The software does not support dimensioning ellipses.

1 - Circular opening
2 - Dimension point

 Square and rounded corners. The software generates points at the expected intersection of
the lines. The arc angle must be 90 degrees.

Drawings and Reports Reference Data Guide 1743


Annotation Modules

1 - Dimension points
2 - Opening with rounded corners

 Slot. The software generates points at the ends of each arc. The arc angle must be 180
degrees.

1 - Dimension points
2 - Slotted opening

Usage in Dimension and Label Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGOpeningObjects</pgModule>
</pointGeneratorSettings>

Customization
None

Points at Manufacturing Sketch Coordinates (MfgSketchPG)


Places points based on coordinate values in the manufacturing data XML created in the
Structural Manufacturing task.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>MfgSketchPG</pgModule>
<pgModuleSettings>
<parseGraphics>0</parseGraphics>
<pgTransform>
...
</pgTransform>
</pgModuleSettings>
</pointGeneratorSettings>
The parseGraphics property is only used for placing dimensions. See Dimension Rule
Manager (on page 1503) in the Smart 3D Drawings and Reports Reference Data Guide for more
information.

Drawings and Reports Reference Data Guide 1744


Annotation Modules

Customization
The following properties are used for dimensioning. There are no customizable
properties for this module when it is used for placing labels.
maxDimOffset
Determines the maximum linear paper space distance between consecutive witness lines in
a linear distance dimension group.
MaxWtnessLength
Controls the length of witness lines so that you can determine how far across the drawing
the line is drawn. Points that fall outside the maximum witness length are eliminated from
consideration.
overall
Places an additional dimension over each dimension chain cluster identified by the rule.
parseGraphics
Specifies whether to determine dimension point locations by examining object graphics or
by using the pgTransform XSLT information in the template. Set the value to -1 to process
the graphics and forward them to the Penetration Plate (PenPlatePointGenerator) point
generator module. Set the value to 0 to process the pgTransform information.
The annotation output is created by a content module, not this module.

Trench (CivilElevationPointGenerator)
Places label points at the start or end of the trench straight features and at the miter center of
the trench turn feature.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>CivilElevationPointGenerator</pgModule>
<pgModuleSettings>
<featureType>3</featureType>
<location>1</location>
<choice>1</choice>
<cardinalPoint>2</cardinalPoint>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
featureType
Determines whether to place a point for either the turn feature or the straight feature, or
both.
Type 1 to place a point for the straight feature. Type 2 to place a point for the turn feature.
Type 3 to place a point for both the straight feature and the turn feature.
location
Determines the location of the point that the software places on a straight or turn feature.

Drawings and Reports Reference Data Guide 1745


Annotation Modules

Type 1 to place the point at the start of the feature.

Type 2 to place the point at the end of the feature.

Type 3 to place the point along the turn.

choice
Allows you to select the trench features on which the software places points.
 The following options are available for manually editing the .xml file.
 Type 1 to place points on all features.
 Type 2 to place a point on the first feature only.
 Type 3 to place a point of the last feature only.
 Type 4 to place no points.
cardinalPoint
Determines the placement of the key, or cardinal, point on a feature.
Possible cardinal points for cross-section used in the trench feature are shown in the
diagram below.

Drawings and Reports Reference Data Guide 1746


Annotation Modules

The following options are available for manually editing the .xml file.
 Type 1 to place the Cardinal Point at the bottom left.
 Type 2 to place the Cardinal Point in the bottom center.
 Type 3 to place the Cardinal Point at the bottom right.
 Type 7 to place the Cardinal Point at the top left.
 Type 8 to place the Cardinal Point in the top center.
 Type 9 to place the Cardinal Point at the top right.

Weld Point (DrawingPGWelds)


Sets the control points used to place a weld symbol on an object and the position along the
curve at the control point. This module is used with the Weld Label Text (DrawingGAWelds) (on
page 1493) geometric analyzer.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGWelds</pgModule>
<pgModuleSettings>
<locations>
<location id="1" target="0" />
<location id="12" target="0" curveRatio="0.25" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
location id

XML
value

Drawings and Reports Reference Data Guide 1747


Annotation Modules

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Bottom 8
On the bottom of the range
box for the curve.

Drawings and Reports Reference Data Guide 1748


Annotation Modules

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

Drawings and Reports Reference Data Guide 1749


Annotation Modules

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 12 (at curve ratio).

Inside or Along 2D Curve (InsideOrAlongCurve2D)


Places a point along a 2D curve.
The 2D curve must have one or more curves.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>InsideOrAlongCurve2D</pgModule>
<pgModuleSettings>
<locations>
<location id="2" target="0" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
location id

XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Drawings and Reports Reference Data Guide 1750


Annotation Modules

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Drawings and Reports Reference Data Guide 1751


Annotation Modules

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 2 (Inmost) or 12 (At curve ratio).

Drawings and Reports Reference Data Guide 1752


Annotation Modules

Absolute Points (ISAbsolutePointLabelPG)


Places a point on each end of straight features and members.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>ISAbsolutePointLabelPG</pgModule>
</pointGeneratorSettings>

Customization
None

Example

1 - Labels placed by the IS_ProfileSketch_Arial_2.5mm label using points created by


ISAbsolutePointLabelPG.
2 - Labels placed by the StrMfg ProfileSketch Detail Name_Voffset label using points created
by ISAbsolutePointLabelPG.

Between Points (ISDimensionBtwPointsPG)


Places a pair of points to be used for a dimension.
This module is intended for use with the web length on profile sketch drawings.

Usage in Label Template XML

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>ISDimensionBtwPointsPG</pgModule>
<pgModuleSettings>
<locations>
<location id="10" target="0" targetName="ProfileWeb" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Drawings and Reports Reference Data Guide 1753


Annotation Modules

Customization
location ID

XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Drawings and Reports Reference Data Guide 1754


Annotation Modules

Top 7
On the top of the range box
for the curve.

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

Drawings and Reports Reference Data Guide 1755


Annotation Modules

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 12 (At curve ratio).


targetName
Specify a name for the curve defined in target.

Points Along 2D Curve (ISDwgPointsAlongCurve2D)


Places one or more points along the 2D curve representing a 3D object.
The 2D curve of the 3D object must have one or more curves.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>ISDwgPositionByCurve2D</pgModule>
<pgModuleSettings>
<locations>
<location id="3" targetName='FirstEnd'/>
<location id="12" target="0" curveRatio="0.25" />
<location targetName='TemplateBtmCrv'/>
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
location id

Drawings and Reports Reference Data Guide 1756


Annotation Modules

XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Drawings and Reports Reference Data Guide 1757


Annotation Modules

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

target
The curve used for determining location.

XML
value

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Drawings and Reports Reference Data Guide 1758


Annotation Modules

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 12 (At curve ratio).


targetName
Specifies a name for the target curve. The name is an attribute on an object in the drawing
view. The valid name is TemplateMidLine.
Specify target or targetName. Do not specify both.

Points for View (ISDwgPointsForView)


Places a point to be used for north arrow or view labels at the center of a view.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>ISDwgPointsForView</pgModule>
</pointGeneratorSettings>

Customization
None

MidPoint (ISMidPointLabelPG)
Places a label point on the 2D curves representing a 3D object at the center of the range box of
the object.

Usage in Dimension or Label Template XML


<pointGeneratorSettings>
<pgModule>ISMidPointLabelPG</pgModule>
</pointGeneratorSettings>

Drawings and Reports Reference Data Guide 1759


Annotation Modules

Customization
None

Nearest Pin (ISPinJigPointsOnNearestPin)


Places points on the intersection point and its nearest pin.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>ISPinJigPointsOnNearestPin</pgModule>
</pointGeneratorSettings>

Customization
None

Profile Sketch Linear Feature


(ISProfileSketchFeatureLinearDimPG)
Places points for linear distance dimensioning on profile sketch drawings.

1 - Points for dimensioning

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>ISProfileSketchFeatureLinearDimPG</pgModule>
</pointGeneratorSettings>

Customization
overall
Specifies whether to connect the dimension witness line end points to the corners of the
dimensioned object’s range or to the points placed by the module. Set the value to 1 to
connect to the object’s range. Set the value to 0 to connect to the points.

Drawings and Reports Reference Data Guide 1760


Annotation Modules

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>ISProfileSketchFeatureLinearDimPG</pgModule>
</pointGeneratorSettings>

Profile Sketch Radial Feature


(ISProfileSketchFeatureRadialDimPG)
Places points for radial dimensioning on profile sketch drawings.
This module is intended for use with feature symbols on profile sketch drawings.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>ISProfileSketchFeatureRadialDimPG</pgModule>
</pointGeneratorSettings>

Customization
location ID

XML
value

Center 0
At the centroid of the area of
a closed shape (that is, the
geometry must be a closed
curve). The centroid cannot
be on the curve.

Middle 1
At the middle point of a curve.

Inmost 2
At the innermost point inside
the area of a closed shape
(that is, the geometry must be
a closed curve).

Drawings and Reports Reference Data Guide 1761


Annotation Modules

At first end 3
At the first end point of curve.

At second end 4
At the second end point of
curve.

Right 5
On the right side of the range
box for the curve.

Left 6
On the left side of the range
box for the curve.

Top 7
On the top of the range box
for the curve.

Bottom 8
On the bottom of the range
box for the curve.

Box center 9
At the center of the range box
for the curve.

Default location 10
Default location for the curve.

At curve ratio 12
At the curve ratio along the
curve.

Used with the curve ratio property.


Used with positioning modules that use their start curve
ratio and end curve ratio property.

target
The curve used for determining location.

XML
value

Drawings and Reports Reference Data Guide 1762


Annotation Modules

Default target 0
Places points on the first
curve of the 2D
representation of the 3D
object.
The first
curve is assigned internally
by the software and is not
predictable.

All curves 1
Places points on all curves
of the 2D representation of
the 3D object.

Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.

curveRatio
Point along the 2D curve when you use location id 12, specified as a ratio along the length
of the curve. The value must be between 0.0 and 1.0.

curveRatio is used when location id is set to 12 (At curve ratio).


targetName
Specify a name for the curve defined in target.

Drawings and Reports Reference Data Guide 1763


Annotation Modules

Default Marine Point (ISRulesetPointGenerator)


Places a point for labeling on the 2D curves representing a 3D object at the control point of the
object.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>ISRulesetPointGenerator</pgModule>
</pointGeneratorSettings>

Customization
None

Example
The software places profile mounting angle and profile thickness labels (circled in red) using
points created by ISRulesetPointGenerator.

Pinjig Corners (SMDwgPinjigCornersDistancePG)


Custom point generator that collects the corner points on a pin jig contour remarking line and
places points to dimension the distance between these corner points.

Usage in Dimension Template XML


<pointGeneratorSettings>
<pgModule>SMDwgPinjigCornersDistancePG</pgModule>
</pointGeneratorSettings>

Customization
None

Example

Drawings and Reports Reference Data Guide 1764


Annotation Modules

Although a content module creates the annotation output, this example shows how
this module affects the output.

Points by 2D Shape Type (SMDwgPointsByType)


Places one or more points at the center of the 2D shape representing a 3D object.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SMDwgPointsByType</pgModule>
<pgModuleSettings>
<ObjectType>Point</ObjectType>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
ObjectType
Specifies the 2D shape.

Point

Circle

Rectangle

Line

Line String

Drawings and Reports Reference Data Guide 1765


Annotation Modules

Ellipse

Example
A non-target seam that intersects a target plate in two locations (such as a transverse hull seam
intersecting a deck) receives a point at each intersection.

Profile Weld Points (SMDwgProfileWeldsPG)


Places points on the 2D curves representing a 3D profile, for use in placing weld labels.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SMDwgProfileWeldsPG</pgModule>
<pgModuleSettings>
<locations>
<location id="1" targetName="Profile_Web" />
<location id="8" targetName="Profile_Flange" />
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
location ID

XML
value

Middle 1

At the middle point of a curve.

Top 7

On the top of the range box for


the curve.

Bottom 8

On the bottom of the range


box for the curve.

targetName

Drawings and Reports Reference Data Guide 1766


Annotation Modules

Specifies a name for the target curve. The name is an attribute on an object in the drawing
view. Valid names are Profile_Web and Profile_Flange.

Points by Associated Object ID


(SMPointsByAssociateObjectID)
Places an annotation point for each 2D point in the group and orients the label with respect to
any other object in the drawing. In the following example, the label will be oriented tangential to
the TemplateBtmCrv.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SMPointsByAssociateObjectID</pgModule>
<pgModuleSettings>
<locations>
<location targetName='TemplateBtmCrv'/>
</locations>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
targetName
Specifies a name for the target curve. The name is an attribute on an object in the drawing
view. Valid names are PlateContour and TemplateBtmCrv.

Example
StrMfg Templateset Midline Symbol
A reference curve that intersects a template will get a point at the intersection. This point is
associated with the reference curve and has template OID (Object ID) as its ID.

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1767


Annotation Modules

Point for Profile Sketch Bevel Shape


(SMProfileSketchBevelShapeLabelsPG)
Generates a point for each label on the bevel shape.

1 - Point for bevel shape

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SMProfileSketchBevelShapeLabelsPG</pgModule>
</pointGeneratorSettings>

Customization
None

Point on Remarking Curve along Girth


(SM3DDwgRemarkingGirthLengthPG)
Places a point at the midpoint of two intersection points on a remarking line curve along the
horizontal and/or vertical girth length.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>SM3DDwgRemarkingGirthLengthPG</pgModule>
<Horizontal>0</Horizontal>
<Vertical>1</Vertical>
</pointGeneratorSettings>

Drawings and Reports Reference Data Guide 1768


Annotation Modules

Customization

1 - Horizontal remarking line


2 - Vertical remarking line
- Intersection point
- Point

Horizontal
Adds points to horizontal remarking line girth curves at the midpoints of intersection points.
 Select for on (the .xml value is 1).
 Clear for off (the .xml value is 0).
Vertical
Adds points to vertical remarking line girth curves at the midpoints of intersection points.
 Select for on (the .xml value is 1).
 Clear for off (the .xml value is 0).

Key Point (DefaultLabelPointGenerator)


Generates a point in the middle of the 2D range of an object. Used for name labels on
equipment and other non-linear objects.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>DefaultLabelPointGenerator</pgModule>
</pointGeneratorSettings>

Drawings and Reports Reference Data Guide 1769


Annotation Modules

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Matchline (DrawingMatchlinePG)
Generates at least four points at the edge of a view to place a matchline label. The software
generates more points when multiple edges of a view border other drawings.
The Adjacent Edge Overlap Percentage and Gap Tolerance properties define an acceptable
volume range, also known as an include range. For more information on using these properties
with the Matchline module, see Adjacent Edge Overlap Percentage (adjacentOverlap) (on page
1613) and Gap Tolerance (gapTolerance) (on page 1618).

 You do not have to use Gap Tolerance and Adjacent Edge Overlap Percentage together.
 If the template file does not define the adjacentOverlap or gapTolerance .xml tags, the
software displays the default values:
 Gap Tolerance - 0 mm
 Adjacent Edge Overlap Percentage - 33

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>DrawingMatchlinePG</pgModule>
<gapTolerance>0.000000001</gapTolerance>
<adjacentOverlap>0.33</adjacentOverlap>
</pointGeneratorSettings>

Customization
gapTolerance
Determines the maximum distance that a matchline label allows between a drawing volume
and a neighboring volume. If the neighboring volume falls outside this distance, then a
drawing limit label replaces the matchline label. The software eliminates candidates that are
too far away from the drawing view volume from matchline consideration.
adjacentOverlap
Eliminates volumes from horizontal and vertical matchline label consideration. For horizontal
consideration, the command eliminates any neighboring volumes that are too far left or right
of the drawing volume center. For vertical matchline label consideration, the command
eliminates neighboring volumes that are too far above or below the drawing volume center.
The Adjacent Edge Overlap Percentage property is a multiplier that is applied to the sides

Drawings and Reports Reference Data Guide 1770


Annotation Modules

of the drawing volume. Smaller Adjacent Edge Overlap Percentage values result in more
matchline labels.

Example 1
The following shows part of a drawing volume inside of the include range:

1 - Drawing volume (subject volume in blue)


2 - Gap Tolerance
3 - Include range
4 - Adjacent Edge Overlap Percentage

A matchline label displays on the top side of the subject volume because part of the adjacent
drawing volume is within the include range.

Subject volume matchline label

Example 2
The following shows a drawing volume outside of the include range:

Drawings and Reports Reference Data Guide 1771


Annotation Modules

1 - Drawing volume (subject volume in blue)


2 - Gap Tolerance
3 - Include range
4 - Adjacent Edge Overlap Percentage

A drawing limit label displays on the top side of the subject volume because the adjacent
drawing volume is not within the include range.

Subject volume drawing limit label

Although a content module creates the annotation output, this example shows how
this module affects the output.
See Also
Adjacent Edge Overlap Percentage (adjacentOverlap) (on page 1613)
Gap Tolerance (gapTolerance) (on page 1618)

Drawings and Reports Reference Data Guide 1772


Annotation Modules

DrawingPGCuttingPlane
Generates the points used to place a cutting plane. The template used should have startPoint
and endPoint set to 0 or -1 (where -1 is true).

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGCuttingPlanes</pgModule>
<startPoint>-1</startPoint>
<endPoint>0</endPoint>
</pointGeneratorSettings>

Customization
Yes

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Linear Object Endpoints (DrawingPGLinear)


Generates a label at both ends of a pipe segment, structure member, or grid line.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGLinear</pgModule>
</pointGeneratorSettings>

Customization
None

Drawings and Reports Reference Data Guide 1773


Annotation Modules

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Nozzle (DrawingPGNozzleandBrace)
Generates a point using the position of pipe nozzles and related shape objects. Allows a label to
be placed on a nozzle object. This point generator must be used with the Clear Space Radial
from Object Center with Clustering (DrawingCentroid) (on page 1247) positioning module.

Usage in Label Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGNozzleandBrace</pgModule>
</pointGeneratorSettings>

Customization
None

Linear Pipe Endpoints (DrawingPGPipeSegments)


This module has been replaced by the DrawingPGLinear module. For more information, see
Linear Object Endpoints (DrawingPGLinear) (on page 1357).

Drawings and Reports Reference Data Guide 1774


Annotation Modules

Horizontal Linear Object Endpoints (DrawingPGStructHoriz)


Places a vertically centered point at the left and right ends of a horizontal straight feature, such
as a pipe segment or a structural beam

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGStructHoriz</pgModule>
</pointGeneratorSettings>

Customization
None

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1775


Annotation Modules

Vertical Linear Object Endpoints (DrawingPGStructVert)


Places a horizontally centered point at the top and bottom ends of a vertical straight feature,
such as a pipe segment or a structural beam.

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>DrawingPGStructVert</pgModule>
</pointGeneratorSettings>

Customization
None

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1776


Annotation Modules

Penetration Plate (PenPlatePointGenerator)


Custom point generator used by ISO process to dimension a penetration plate. This module also
performs the functions of a geometric analyzer and must be used with DummyGeomAnalyzer.
For more information, see Dummy (DummyGeomAnalyzer) (on page 1540).

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>PenPlatePointGenerator</pgModule>
</pointGeneratorSettings>

Customization
None

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1777


Annotation Modules

Template Offset (StrMfgTemplateOffsetPG)


Places offset distance, offset height, and offset girth distance dimension points for a template.
This module supports coordinate dimensioning.

Interval = 0.5 (500 mm)


1 - Points for dimensioning

Interval = 0.3 (300 mm)


1 - Points for dimensioning

Drawings and Reports Reference Data Guide 1778


Annotation Modules

Height at interval = 0.3


1 - Points for dimensioning

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>StrMfgTemplateOffsetPG</pgModule>
<pgModuleSettings>
<interval>0.5</interval>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
interval
Sets an interval value (in meters) for placing the template points.

Template Set Offset (StrMfgTemplateSetOffsetPG)


Places offset distance, offset height, and offset girth distance dimension points for a
templateSet. This module supports coordinate dimensioning.

GirthLength offset at interval = 0.5


1 - Points for dimensioning

Drawings and Reports Reference Data Guide 1779


Annotation Modules

Usage in Label or Dimension Template XML


<pointGeneratorSettings>
<pgModule>StrMfgTemplateSetOffsetPG</pgModule>
<pgModuleSettings>
<interval>0.5</interval>
</pgModuleSettings>
</pointGeneratorSettings>

Customization
interval
Sets an interval value (in meters) for placing the template points.

Drawings and Reports Reference Data Guide 1780


Annotation Modules

Geometric Analyzers
Geometric Analyzer modules are used in Drawings label templates to analyze points generated
by a point generator module. The geometric analyzer then deletes unneeded points and/or
groups points together according to the specific algorithm it uses. For more information on point
generators, see Point Generators (on page 1730).
For information on the relationship of geometric analyzers to other annotation modules, see
Annotation Modules (on page 1728).

Topics
Object Axis (DrawingGAEquipmentStyle2) ................................... 1781
Margin with Occluded Graphics (DrawingGAMarginOnlyWithOccludedGraphics) 1786
Generic Interoperability (GenericGeometricAnalyzerInterop) ....... 1787
MfgSketchNameFeaturesGA ......................................................... 1787
Weld Label Text (DrawingGAWelds) ............................................. 1788
Between Points (ISDimensionBetweenPointsGA) ........................ 1788
Eliminate Most Common Labels (ISGAEliminateMostCommonLabels) 1789
Eliminate Overlapping Labels (ISGAEliminateOverlappingLabels) 1791
Default Marine Label Text (ISRulesetLabelAnalyzer) ................... 1792
Eliminate Labels with Missing Parents (SMDGAEliminateLabelsWithMissingParents) 1793
Convert to Coordinate Dimension (SMDwgConvertToCoordDimGA) 1794
Group by Axis (SMDwgGroupByAxisGA) ...................................... 1794
No Grouping or Filtering (Default) (DefaultLabelGeometricAnalyzer) 1795
Linear Endpoints (DrawingGAByOppositePoints) ......................... 1796
End of Segment (DrawingGAEndOfSegment) .............................. 1796
Aligned Objects (DrawingGALabelInline) ...................................... 1800
Longest Segment (DrawingGALongestSegment) ......................... 1807
Pipe Segments (DrawingGAPipeSegments) ................................. 1812
Margin (DrawingGAMarginOnly).................................................... 1814
Dummy (DummyGeomAnalyzer) ................................................... 1815
Default (DrawingGeometricAnalyzer) ............................................ 1816

Object Axis (DrawingGAEquipmentStyle2)


Tests label points for equipment.

Usage in Label Template XML


<label>
<geometricAnalyzerSettings>
<gaModule>DrawingGAEquipmentStyle2</gaModule>
<placeLines>-1</placeLines>
<deDuplicateLables>-1</deDuplicateLables>
<lineStyle>ANSI</lineStyle>
</geometricAnalyzerSettings>
</label>

Customization
placeLines

Drawings and Reports Reference Data Guide 1781


Annotation Modules

Controls line placement through the coordinate label points along aligned objects. Use this
property to include a single label in the drawing that specifies a common elevation for
aligned objects.
In the following image, placeLines has been set to 0, and the software has placed a line
connecting the equipment objects and a single label for the common Northing coordinate.

Type -1 to place lines. Type 0 to suppress lines.


DuplicateLabels
Specifies the points to label when more than one point is aligned horizontally or vertically.
Type -1 to place a label on the closest point.

1 – Label
2 – Point closest to the matchline
3 – Equipment object

Drawings and Reports Reference Data Guide 1782


Annotation Modules

Type 0 to place a label on both points.

1 – First label
2 – First horizontally aligned point
3 – Equipment object
4 – Second horizontally aligned point
5 – Second label

lineStyle
Allows you to specify the style of the line connecting horizontally or vertically aligned pieces
of equipment. Define this property when you have labeled equipment inside a plant with
coordinate labels.
In the following graphic, the Line Style has been defined with the Dash Dot Red style.

Drawings and Reports Reference Data Guide 1783


Annotation Modules

1 - Dash Dot Red Line Style


2 - North coordinate label

Drawings and Reports Reference Data Guide 1784


Annotation Modules

Examples
placeLines is -1 and deDuplicateLables is -1:

Drawings and Reports Reference Data Guide 1785


Annotation Modules

placeLines is -1 and deDuplicateLables is 0:

Although a content module creates the annotation output, this example shows how
this module affects the output.

Margin with Occluded Graphics


(DrawingGAMarginOnlyWithOccludedGraphics)
Redraws an object when the X and Y coordinates for that object display on the same gridline.
The software considers the Z-coordinate as the fixed point when updating the object. This
behavior ensures that the gridlines are not duplicated.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGAMarginOnlyWithOccludedGraphics</gaModule>
</geometricAnalyzerSettings>

Drawings and Reports Reference Data Guide 1786


Annotation Modules

Generic Interoperability (GenericGeometricAnalyzerInterop)


Acts as a wrapper module that forwards the geometric analyzer call to a module written in .NET.
In the following .xml example, the MfgSketchNameFeaturesGA geometric analyzer module
performs the actual geometric analysis.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>GenericGeometricAnalyzerInterop</gaModule>
<gaModuleSettings>
<Assembly value = "MfgSketchNameFeaturesGA" />
</gaModuleSettings>
</geometricAnalyzerSettings>

Customization
Assembly value
Specifies the name of the geometric analyzer to use.

 The GenericGeometricAnalyzerInterop geometric analyzer module is only used in


delivered label templates for manufacturing sketch drawings. For more information, see
MfgSketchNameFeaturesGA (on page 1389).
 GenericGeometricAnalyzerInterop is a wrapper geometric analyzer module that must be
used with .NET geometric analyzer modules.

MfgSketchNameFeaturesGA
Gathers clusters of points for both horizontal and vertical dimensioning.

Usage in Label Template XML


<label>
<geometricAnalyzerSettings>
<gaModule>GenericGeometricAnalyzerInterop</gaModule>
<gaModuleSettings>
<Assembly value="MfgSketchNameFeaturesGA" />
</gaModuleSettings>
</geometricAnalyzerSettings>
</label>

Customization
Assembly value
Specifies the name of the geometric analyzer to use.

 GenericGeometricAnalyzerInterop is a wrapper geometric analyzer that must be used with


.NET geometric analyzers.
 The annotation output is created by a content module, not this module.

Drawings and Reports Reference Data Guide 1787


Annotation Modules

Weld Label Text (DrawingGAWelds)


Sets a weld attribute on the points or deletes points placed by the point generator. This module
is used with the Weld Point (DrawingPGWelds) (on page 1494) point generator.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGAWelds</gaModule>
</geometricAnalyzerSettings>

Customization
None

Between Points (ISDimensionBetweenPointsGA)


Groups dimension points into pairs containing each point and its opposite point as placed by the
point generator module.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>ISDimensionBetweenPointsGA</gaModule>
</geometricAnalyzerSettings>

Customization
None

Examples

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1788


Annotation Modules

Eliminate Most Common Labels


(ISGAEliminateMostCommonLabels)
Identifies the most common label (typical labels) from the drawing view and places it as part of
the view label. This is done to prevent the duplication of labels in the drawing view.

Usage in Label Template XML


<label>
<geometricAnalyzerSettings>
<gaModule>ISGAEliminateMostCommonLabels</gaModule>
<equivalenceLabel>
Ship Structure Plate Thickness Material Grade by COM.rtp
</equivalenceLabel>
<equivalenceProperty interfaceName="IJDwgViewTypical"
propertyValue="Value2" propertyKey="Key2" />
</geometricAnalyzerSettings>
</label>

Customization
equivalenceLabel
Specifies the name of the report template that the software uses to determine the most
common, typical label. The report template must be located in the same folder as the label
template XML.
equivalenceProperty
Specifies the property values for the typical label used by the view label rule. See the
example below.
 interfaceName - Specifies the name of the interface that the software uses to collect
label attributes for determining typical labels.
 propertyValue - A custom property with a value ranging from Value1 to Value20. The
specified report template must use this value to define the typical label. See the
example below.
 propertyKey - This property is reserved for future use.

Drawings and Reports Reference Data Guide 1789


Annotation Modules

Example
The view below uses the ViewNameDirectionScale view label rule. Without
ISGAEliminateMostCommonLabels, the software places all plate labels and the view label as
follows.

The view below uses the ViewNameDirectionScale view label rule. Within the rule,
ISGAEliminateMostCommonLabels defines the typical label as a property value of Value2.
The report that you have specified as the equivalence label also defines the typical label as
Value2. The most common label is removed from the view, and a typical label is included with
the view label.

For more information, see ViewNameDirectionScale View Label Template (on page 921).
Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1790


Annotation Modules

Eliminate Overlapping Labels


(ISGAEliminateOverlappingLabels)
Eliminates the duplication of annotations when two geometric objects overlap.

Usage in Label Template XML


<label>
<geometricAnalyzerSettings>
<gaModule>ISGAEliminateOverlappinglabels</gaModule>
<equivalenceLabel>
Ship Structure Plate Thickness Material Grade by COM.rtp
</equivalenceLabel>
<overlapping>
<keeplabelByLocation>0</keeplabelByLocation>
</overlapping>
<nonoverlapping>
<keeplabelByLocation>3</keeplabelByLocation>
</nonoverlapping>
</geometricAnalyzerSettings>
</label>

Customization
equivalenceLabel
Specifies the name of the report template that the software uses to determine the most
common, typical label. The report template must be located in the same folder as the label
template XML.
overlapping
Specifies properties for overlapping labels on overlapping objects.
nonoverlapping
Specifies properties for non-overlapping labels on overlapping objects.
keeplabelByLocation
Specifies the label that the software keeps on overlapping objects. This property is specified
for overlapping and non-overlapping labels. Select one of the following options:

XML
value

Keep default 0

Keep near side 1

Drawings and Reports Reference Data Guide 1791


Annotation Modules

Keep far side 2

Keep both sides 3

Keep none 4

Default Marine Label Text (ISRulesetLabelAnalyzer)


Determines the labels needed for a point and gets the text for the label based on the type of
geometry used to generate the point.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>ISRulesetLabelAnalyzer</gaModule>
</geometricAnalyzerSettings>

Customization
None

Drawings and Reports Reference Data Guide 1792


Annotation Modules

Eliminate Labels with Missing Parents


(SMDGAEliminateLabelsWithMissingParents)
If all parents of a label are not drawn, then the label is not drawn.
Applies only to seam labels. Shows a seam when both adjacent target plate parts
have been drawn. Other seams are omitted. When a single plate is drawn without any adjacent
plates, no seam symbols are drawn.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>SMDGAEliminateLabelsWithMissingParents</gaModule>
</geometricAnalyzerSettings>

Customization
None

Examples
Seam example:
In the first example, plate 1 is drawn. The seam labels at adjacent plates are drawn (green
lines).

In the second example, plate 1 is not drawn. The seam labels at adjacent plates are not drawn
(blue lines).

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1793


Annotation Modules

Convert to Coordinate Dimension


(SMDwgConvertToCoordDimGA)
Groups key points for dimensions to coordinate system reference planes into consecutive key
points of the dimensions.

Usage in Label or Dimension Template XML


<geometricAnalyzerSettings>
<gaModule>SMDwgConvertToCoordDimGA</gaModule>
<gaModuleSettings>
<filterCriteria pointName='FEATURE_DIMPOINT_TOP'/>
</gaModuleSettings>
</geometricAnalyzerSettings>

Customization
Based on the point name specified, the respective key points are grouped.

Examples

This geometric analyzer converts the points to a single set of consecutive key points.

The distance measured is cumulative and the dimension line is continuous. The end point of the
first dimension becomes the start point of the next dimension.
Although a content module creates the annotation output, this example shows how
this module affects the output.

Group by Axis (SMDwgGroupByAxisGA)


Finds the reference plane that is coincident with the geometry of the object to be labeled. If there
is no coincident reference plane, then the closest reference plane is found. When this module is
used with the Absolute Position by 2D Curve at Axis (SMDwgPositionByCurve2DAtAxis) (on
page 1124) positioning module, the reference plane label is placed on the appropriate grid axis.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>SMDwgGroupByAxisGA</gaModule>
</geometricAnalyzerSettings>

Drawings and Reports Reference Data Guide 1794


Annotation Modules

Customization
None

Example

No Grouping or Filtering (Default)


(DefaultLabelGeometricAnalyzer)
Used to place a label on the origin or control point of an object. This module does not perform
any grouping. Currently used by most non-linear labels.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DefaultLabelGeometricAnalyzer</gaModule>
</geometricAnalyzerSettings>

Customization
None

Drawings and Reports Reference Data Guide 1795


Annotation Modules

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Linear Endpoints (DrawingGAByOppositePoints)


Groups points that are generated by a linear point generator together based on the original
object that produced them.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGAByOppositePoints</gaModule>
</geometricAnalyzerSettings>

Customization
None

End of Segment (DrawingGAEndOfSegment)


Places labels on the segment ends of a linear object. Each vertical or horizontal segment and
both clipped sides are labeled.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGAEndOfSegment</gaModule>
<allowNonOrthogonalDirections>-1</allowNonOrthogonalDirections>
<ignoreClippingForGrouping>0</ignoreClippingForGrouping>
<maxOffsetForGrouping>0.1</maxOffsetForGrouping>
<ignoreOffsetForGrouping>0</ignoreOffsetForGrouping>
<equivalenceLabel>"Piping
Plan_FlowArrow_LongestSegment.rtp"</equivalenceLabel>
</geometricAnalyzerSettings>

Customization
allowNonOrthogonalDirections
Allows you to specify that the software places a label on objects that are non-orthogonal,
that is, neither horizontal nor vertical on the drawing sheet.
Type -1 to place the label.

Drawings and Reports Reference Data Guide 1796


Annotation Modules

1 - Non-orthogonal pipe with label

Type 0 to suppress the label.

1 - Unlabeled non-orthogonal pipe

ignoreClippingForGrouping
Allows you to turn off duplicate labels on straight features that are clipped on both sides.
Type 0 to turn off duplicate labels. Type -1 to allow duplicate labels.

Drawings and Reports Reference Data Guide 1797


Annotation Modules

maxOffsetForGrouping
Specifies the maximum distance between consecutive endpoints of linear objects.
The system uses the specified distance for grouping label points together, grouping points
that consecutively fall within the specified maximum offset into a particular set. The software
then creates one label per set. Conversely, the system creates a separate label for each
point that lies at a greater distance from the closest linear points than the specified
Maximum Offset for Grouping value.
The distance that you specify must take into account inline features, such as pipe valves.
Therefore, the specified value must be high enough that the system does not create labels
on both sides of each inline feature.
The default distance is 0.1 m.

 Specify 0 or a positive decimal value for this distance.


 In contrast to the majority of properties, the software interprets the distance that you
specify as model space units and not as paper space units.

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.
ignoreOffsetForGrouping
Specifies whether the software honors the offset value for the Maximum Offset for
Grouping property. When selected, this option honors the offset distance, forcing the
software to create separate labels when the distance between consecutive endpoints of
linear objects is greater than the Maximum Offset for Grouping.
Type -1 to ignore the offset distance. Type 0 to honor the offset distance.
equivalenceLabel
Eliminates duplicate labels on pipelines with multiple segments.
When the Equivalence Label property is used with the End of Segment geometric analyzer
and the pipeline is clipped, the software places a label at each end of the pipe segment.
Conversely, when the Equivalence Label property is used with the Longest Segment
geometric analyzer and the pipeline is clipped, a label is placed at the end of the longest line
segment.
See Also
Edit a label rule to use the Equivalence Label (on page 1799)

Drawings and Reports Reference Data Guide 1798


Annotation Modules

Edit a Label Rule to use the Equivalence Label


The equivalenceLabel tag eliminates duplicate labels on pipelines with multiple segments. One
label is placed at the end of the longest line segment. If this tag is used with the
DrawingGAEndOfSegment geometric analyzer and the pipeline is clipped, a label is placed at
each end of the pipe segment. If this tag is used with the DrawingGALongestSegment
geometric analyzer and the pipeline is clipped, one label is placed at the end of the longest
segment.
To place a label on a pipeline with multiple segments, you must edit the label .xml file. The
default location for these files is [Reference Data Product
Folder]\CatalogData\Symbols\Drawings\Catalog\Labels\Templates.
1. Open the .xml file you want to modify.
2. Locate the <geometricAnalyzerSettings> tag.
3. Insert the following line between the <geometricAnalyzerSettings> and
</geometricAnalyzerSettings> tags:
<equivalenceLabel>".rtp file name of the label
template"</equivalenceLabel>
For example, the value of the equivalence label for a Piping Plan Flow Arrow Longest
Segment label template is "Piping Plan_FlowArrow_Longest Segment.rtp".
4. Save the file and exit.

 You should make a copy of the label XML file before editing the original file.
 You can place labels on pipelines with multiple segments while using a view style that
includes the DrawingGALongestSegment geometric analyzer module.
 To use the equivalenceLabel tag, set the point generator to DrawingPGLinear. For more
information, see Linear Object Endpoints (DrawingPGLinear) (on page 1357).

Drawings and Reports Reference Data Guide 1799


Annotation Modules

Aligned Objects (DrawingGALabelInline)


Places a coordinate label between objects in a view. The coordinate line is placed on the origin
or control point given by the point generator. This module also places the line between the
objects. A placeLines value of 0 does not place a coordinate line, while a value of -1 does place
a coordinate line. For more information on other settings available for this module, see Label
Templates Overview (on page 786).

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGALabelInline</gaModule>
<placeLines>-1</placeLines>
<keepTopOrBottomDup>0</keepTopOrBottomDup>
<keepLeftOrRightDup>0</keepLeftOrRightDup>
<cpLabelType>2</cpLabelType>
<placeLinesOnSheet>-1</placeLinesOnSheet>
<lineStyle>Dash Dot Red</lineStyle>
<equivalenceLabel>"Piping
Plan_FlowArrow_LongestSegment.rtp"</equivalenceLabel>
<ignoreViewDirection>0</ignoreViewDirection>
</geometricAnalyzerSettings>

Customization
placeLines
Controls line placement through the coordinate label points along aligned objects. Use this
property to include a single label in the drawing that specifies a common elevation for
aligned objects.
In the following image, placeLines has been set to 0, and the software has placed a line
connecting the equipment objects and a single label for the common Northing coordinate.

Type -1 to place lines. Type 0 to suppress lines.

Drawings and Reports Reference Data Guide 1800


Annotation Modules

keepTopOrBottomDup
Allows you to place a label on either the topmost or bottommost object in a group of objects
aligned at identical X positions along a vertical axis. If the value for keepTopOrBottomDup
is 0, then only the topmost point of an aligned set of points is considered for dimensioning. If
the value is set to -1, then only the bottommost point of an aligned set of points is
considered for dimensioning.Type 0 to label only the topmost point.

1 - Equipment object
2 -Labeled East coordinate
point
3 - North coordinate point

Drawings and Reports Reference Data Guide 1801


Annotation Modules

Type -1 to label only the bottommost point.

1 - Equipment object
2 - Labeled East coordinate
point
3 - North coordinate point

keepLeftOrRightDup
Allows you to place a label on either the leftmost or rightmost object in a group of objects
aligned at identical Y positions along a horizontal axis. If the value for keepLeftOrRightDup
is set to 0, then only the leftmost point in a horizontally aligned set of points is considered in
dimensioning. If the value is set to -1, then only the rightmost point in a horizontally aligned
set of points is considered for dimensioning.
Type 0 to label only the leftmost point.

1 - East coordinate label


2 - North coordinate label
3 - Equipment object

Drawings and Reports Reference Data Guide 1802


Annotation Modules

Type -1 to label the rightmost point.

1 - East coordinate label


2 - North coordinate label
3 - Equipment object

cpLabelType

1 – Equipment object

2 – Vertical text label


3 – Static control point coordinate label symbol
4 – Horizontal text label

placeLinesOnSheet
Allows you to preserve manual changes to the line position or style options between
updates when this option is turned on. Additionally, you can delete a connecting line
between objects when this option is turned on. Type 0 to turn off this option. Type -1 to
preserve changes to the line between updates.

Drawings and Reports Reference Data Guide 1803


Annotation Modules

lineStyle
Allows you to specify the style of the line connecting horizontally or vertically aligned pieces
of equipment. Define this property when you have labeled equipment inside a plant with
coordinate labels.
In the following graphic, the Line Style has been defined with the Dash Dot Red style.

1 - Dash Dot Red Line Style


2 - North coordinate label

equivalenceLabel
Eliminates duplicate labels on pipelines with multiple segments.
When the Equivalence Label property is used with the End of Segment geometric analyzer
and the pipeline is clipped, the software places a label at each end of the pipe segment.
Conversely, when the Equivalence Label property is used with the Longest Segment
geometric analyzer and the pipeline is clipped, a label is placed at the end of the longest line
segment.
ignoreViewDirection
Determines whether or not the software considers the view direction when updating a
drawing. This setting is useful when placing an elevation coordinate label on a plan view.

Drawings and Reports Reference Data Guide 1804


Annotation Modules

Type -1 to ignore the view direction.

1 - Equipment object
2 - Elevation label
3 - Static control point

Type 0 to consider the view direction.

1 - Equipment object
2 - Elevation label
3 - Static control point

Drawings and Reports Reference Data Guide 1805


Annotation Modules

Examples
Drawing View:

Drawings and Reports Reference Data Guide 1806


Annotation Modules

Detailed view of the above drawing:

Although a content module creates the annotation output, this example shows how
this module affects the output.

Longest Segment (DrawingGALongestSegment)


Places a label on the longest segment of a linear object.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGALongestSegment</gaModule>
<allowNonOrthogonalDirections>-1</allowNonOrthogonalDirections>
<equivalenceLabel>"Piping
Plan_FlowArrow_LongestSegment.rtp"</equivalenceLabel>
</geometricAnalyzerSettings>

Customization
allowNonOrthogonalDirections
Allows you to specify that the software places a label on objects that are non-orthogonal,
that is, neither horizontal nor vertical on the drawing sheet.
Type -1 to place the label.

Drawings and Reports Reference Data Guide 1807


Annotation Modules

1 - Non-orthogonal pipe with label

Type 0 to suppress the label.

1 - Unlabeled non-orthogonal pipe

Drawings and Reports Reference Data Guide 1808


Annotation Modules

equivalenceLabel
Eliminates duplicate labels on pipelines with multiple segments.
When the Equivalence Label property is used with the End of Segment geometric analyzer
and the pipeline is clipped, the software places a label at each end of the pipe segment.
Conversely, when the Equivalence Label property is used with the Longest Segment
geometric analyzer and the pipeline is clipped, a label is placed at the end of the longest line
segment.

Example
The longest segment of pipe is labeled.

Although a content module creates the annotation output, this example shows how
this module affects the output.
See Also
Edit a label rule to allow non-orthogonal label directions (on page 1810)
Edit a label rule to use the Equivalence Label (on page 1799)

Drawings and Reports Reference Data Guide 1809


Annotation Modules

Edit a label rule to allow non-orthogonal label directions


This workflow describes the process for enabling the ability to place a label on a non-orthogonal
pipe in a drawing. Some delivered label rules, including piping, HVAC, cableways, and conduits,
are designed for vertical or horizontal parts, but allowNonOrthogonalDirections allows you to
specify that the software places a label on objects that are non-orthogonal, that is, neither
horizontal nor vertical on the drawing sheet. The label rule must be using the
DrawingGALongestSegment geometric analyzer module in order for the
allowNonOrthogonalDirections tag to work.
In the following example, allowNonOrthogonalDirections is turned on (set to -1).

Drawings and Reports Reference Data Guide 1810


Annotation Modules

In the next example, allowNonOrthogonalDirections is turned off (set to 0).

To place a label on a non-orthogonal pipe, you must edit the label .xml file. The default location
for these files is [Reference Data Product
Folder]\CatalogData\Symbols\Drawings\Catalog\Labels\Templates.
1. Open the appropriate .xml file you want to modify.
2. Locate the <geometricAnalyzerSettings> tag.
3. Insert the following line between the <geometricAnalyzerSettings> and
</geometricAnalyzerSettings> tags:
<allowNonOrthogonalDirections>-1
</allowNonOrthogonalDirections>
4. Type -1 to place the label. Type 0 to suppress the label.
5. Save the file and exit.

 You should make a copy of the label .xml file before editing the original file.
 You can place labels on non-orthogonal objects while using a view style that includes the
DrawingGALongestSegment geometric analyzer module.

Drawings and Reports Reference Data Guide 1811


Annotation Modules

Edit a Label Rule to use the Equivalence Label


The equivalenceLabel tag eliminates duplicate labels on pipelines with multiple segments. One
label is placed at the end of the longest line segment. If this tag is used with the
DrawingGAEndOfSegment geometric analyzer and the pipeline is clipped, a label is placed at
each end of the pipe segment. If this tag is used with the DrawingGALongestSegment
geometric analyzer and the pipeline is clipped, one label is placed at the end of the longest
segment.
To place a label on a pipeline with multiple segments, you must edit the label .xml file. The
default location for these files is [Reference Data Product
Folder]\CatalogData\Symbols\Drawings\Catalog\Labels\Templates.
1. Open the .xml file you want to modify.
2. Locate the <geometricAnalyzerSettings> tag.
3. Insert the following line between the <geometricAnalyzerSettings> and
</geometricAnalyzerSettings> tags:
<equivalenceLabel>".rtp file name of the label
template"</equivalenceLabel>
For example, the value of the equivalence label for a Piping Plan Flow Arrow Longest
Segment label template is "Piping Plan_FlowArrow_Longest Segment.rtp".
4. Save the file and exit.

 You should make a copy of the label XML file before editing the original file.
 You can place labels on pipelines with multiple segments while using a view style that
includes the DrawingGALongestSegment geometric analyzer module.
 To use the equivalenceLabel tag, set the point generator to DrawingPGLinear. For more
information, see Linear Object Endpoints (DrawingPGLinear) (on page 1357).

Pipe Segments (DrawingGAPipeSegments)


Groups dimensions for pipe segments of any angle into chained families. The software places
the dimensions within the drawing view.

Usage in Label Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGAPipeSegments</gaModule>
</geometricAnalyzerSettings>

Customization
Yes

Drawings and Reports Reference Data Guide 1812


Annotation Modules

Examples

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1813


Annotation Modules

Margin (DrawingGAMarginOnly)
Chains a group of dimensions into the appropriate margins based on the position at which the
software places the dimensioning points.
In the following example, the amount of space between the dimension lines of the first and third
dimensions in the chain allows the software to embed the measurements.
Very little space exists between the second set of dimension lines. Therefore, the software
rotates the measurement vertically and places it above the chain.
Likewise, the fourth set of dimension lines has a small amount of space. In this case, the
measurement is rotated; however, there is enough space for the software to embed the
measurement.

1 - Dimension embedded in chain


2 - Dimension rotated and placed above chain
3 - Dimension rotated and embedded in chain

Usage in Label or Dimension Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGAMarginOnly</gaModule>
</geometricAnalyzerSettings>

Customization
keepTopOrBottomDup
Allows you to place a label on either the topmost or bottommost object in a group of objects
aligned at identical X positions along a vertical axis. If the value for keepTopOrBottomDup
is 0, then only the topmost point of an aligned set of points is considered for dimensioning. If
the value is set to -1, then only the bottommost point of an aligned set of points is
considered for dimensioning.
keepLeftOrRightDup
Allows you to place a label on either the leftmost or rightmost object in a group of objects
aligned at identical Y positions along a horizontal axis. If the value for keepLeftOrRightDup
is set to 0, then only the leftmost point in a horizontally aligned set of points is considered in
dimensioning. If the value is set to -1, then only the rightmost point in a horizontally aligned

Drawings and Reports Reference Data Guide 1814


Annotation Modules

set of points is considered for dimensioning.


orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
maxDimOffset
Determines the maximum linear paper space distance between consecutive witness lines in
a linear distance dimension group.
maxWitnessLength
Controls the length of witness lines so that you can determine how far across the drawing
the line is drawn. Points that fall outside the maximum witness length are eliminated from
consideration.
overall
Places an additional dimension over each dimension chain cluster identified by the rule.
trimWitness
Determines whether or not a dimension witness line extends into the drawing view to the
dimensioned object or stops at the drawing view. If the trimWitness value is selected, then
the software trims the dimension witness lines. If the value is cleared, then the dimension
witness lines continue into the drawing view to the dimensioned objects.

Dummy (DummyGeomAnalyzer)
Dummy module used for dimension anchoring and penetration plate dimensions. Point
generator modules use the dummy module to perform all geometric analyzing tasks. You must
use this module when you use the Penetration Plate (PenPlatePointGenerator) (on page 1777).

Usage in Label or Dimension Template XML


<geometricAnalyzerSettings>
<gaModule>DummyGeomAnalyzer</gaModule>
</geometricAnalyzerSettings>

Customization
None

Drawings and Reports Reference Data Guide 1815


Annotation Modules

Default (DrawingGeometricAnalyzer)
Chains dimensions together within a view based on the proximity of the objects intended for
dimensioning.

1 - Dimension
2 - Equipment objects
3 - View

Usage in Label or Dimension Template XML


<geometricAnalyzerSettings>
<gaModule>DrawingGeometricAnalyzer</gaModule>
</geometricAnalyzerSettings>

Customization
keepTopOrBottomDup
Allows you to place a label on either the topmost or bottommost object in a group of objects
aligned at identical X positions along a vertical axis.
keepLeftOrRightDup
Allows you to place a label on either the leftmost or rightmost object in a group of objects
aligned at identical Y positions along a horizontal axis.
maxDimOffset
Determines the maximum linear paper space distance between consecutive witness lines in
a linear distance dimension group.
maxWitnessLength
Controls the length of witness lines so that you can determine how far across the drawing

Drawings and Reports Reference Data Guide 1816


Annotation Modules

the line is drawn. Points that fall outside the maximum witness length are eliminated from
consideration.
overall
Places an additional dimension over each dimension chain cluster identified by the rule.
placeLines
Controls line placement through the coordinate label points along aligned objects. Use this
property to include a single label in the drawing that specifies a common elevation for
aligned objects.
keepEqualDistanceDup
Eliminates points from dimensioning consideration when multiple pairs of points are equal
distances apart (for example, when multiple objects are placed in a grid pattern). If you
select the Keep Equal Distance Duplicates check box, multiple dimensions with identical
values might appear on the drawing.

Drawings and Reports Reference Data Guide 1817


Annotation Modules

Content Modules
Content modules are used in Drawings label templates to generate labels or dimensions based
on criteria of the 3D objects represented in the drawing views. These modules generally run a
report of a label in order to pass the results on to another module. The content modules are
highly customizable because they are essentially report labels. Content modules for dimensions
also place dimensions on the drawing view.
For information on the relationship of content modules to other annotation modules, see
Annotation Modules (on page 1728).

Topics
Piping Elevation (DrawingBOLabelContent) .................................. 1819
Trench (DrawingCivilLabelContent) ............................................... 1821
Horizontal Coordinate Dimensions (DrawingCoordDimContLinHNoReplace) 1823
Vertical Coordinate Dimensions (DrawingCoordDimContLinVNoReplace) 1823
DrawingCuttingPlanesContent ...................................................... 1824
Object Coordinates (DrawingEquipmentStyle2Content) ............... 1825
Flow Direction (DrawingFlowDirectionContent) ............................. 1827
Hanger Key Plan (DrawingHangerLabelContent) ......................... 1830
Default (DrawingLabelHelper) ....................................................... 1831
Matchline (DrawingMatchlineContent) ........................................... 1835
DrawingOrientToY0Content........................................................... 1837
Reference (DrawingReferenceLabelContent) ............................... 1838
Knuckle Angle Symbol (ISKnuckleAngleSymbolContent) ............. 1839
Manufacturing Margin Symbol (ISMfgMarginSymbolContent) ...... 1840
Profile Sketch Linear Feature (ISProfileSketchFeatureLinearDimCM) 1840
Profile Sketch Radial Feature (ISProfileSketchFeatureRadialDimCM) 1841
ISRulesetSymbolContent ............................................................... 1841
Manufacturing Sketch (MfgSketchContent) ................................... 1842
Scantling Weld Symbol (DwgScantlingWeld) ................................ 1842
Override (ISDimensionContentOverride) ....................................... 1844
ISDwgEndCutRuleServer .............................................................. 1844
ISDwgProfileEndCutSymbol .......................................................... 1845
ISDwgSlotRuleServer .................................................................... 1847
Knuckle Point Symbol (ISKnucklePointSymbolContent) ............... 1848
Knuckle Sloping Direction Symbol (ISKnuckleSlopingDirectionSymbolContent) 1849
Plate Angle Symbol (ISPlateAngleSymbolContent) ...................... 1850
Plate Thickness Symbol (ISPlateThicknessSymbolContent) ........ 1851
Profile Angle Symbol (ISProfileAngleSymbolContent) .................. 1852
ISProfilePartThicknessSymbolContent .......................................... 1853
Profile System Thickness Symbol (ISProfileSysThicknessSymbolContent) 1855
Default Marine Label (ISRulesetLabelContent) ............................. 1856
Seam Symbol (ISSeamSymbolContent) ....................................... 1856
Ship Direction Symbol (ISShipDirectionSymbolContent) .............. 1858
Manufacturing Profile Plate Location Symbol (MfgProfilePlateLocSymContent) 1860
SM3D ProfileSketchFeatureSymbol .............................................. 1862
ProfileSketchMarkingLineSymbol .................................................. 1864
SlotSymbols ................................................................................... 1864
Remarking Girth Length Label (SM3DDwgRemarkingGirthLengthCM) 1866

Drawings and Reports Reference Data Guide 1818


Annotation Modules

Marine Linear (SMDrawingDimContentLinear) .............................. 1866


Manufacturing Pin Height Label (SMDwgMfgPinHeightLabelContent) 1867
Manufacturing Profile Margin Symbol (SMDwgMfgProfileMarginSymContent) 1868
Plate Grid Name Label (SMDwgPlateGridNameLabelContent) .... 1868
Scantling Near Side or Far Side Symbol (SMDwgScantlingNSorFSContent) 1869
Scantling Near Side or Far Side Direction Symbol (SMDwgScantlingNSorFSDirectionContent)
....................................................................................................... 1869
Profile Seam Symbol (SMProfileSeamSymbolContent) ................ 1870
Profile Sketch Bevel Shape Label (SMProfileSketchBevelShapeLabelsCM) 1871
Profile Sketch Bevel Symbol (SMProfileSketchBevelSymbolCM). 1872
Ruler Axis (SMRulerAxisSymbolContent) ..................................... 1873
Template Set Full Scale Direction Symbol (SMTemplatesetFullScaleDirSymbolContent) 1878
Thickness Direction Symbol (ThicknessSymContent) ................... 1879
Pin Jig Seam Offset Label (SMDPinJigSeamOffsetCM) ............... 1880
Profile Sketch Label (SMDwgProfileSketchLabelsContent) .......... 1881
Profile Sketch Web Thickness Symbol (SMPSWebThicknessContent) 1881
Angular Dimensions (DrawingDimContAngNoReplace) ............... 1883
Angular Dimensions with Value Replacement (DrawingDimContentAngular) 1884
Horizontal Linear Dimensions with Value Replacement (DrawingDimContentLinearH) 1885
Vertical Linear Dimensions with Value Replacement (DrawingDimContentLinearV) 1886
Radial Dimensions with Value Replacement (DrawingDimContentRadial) 1887
Horizontal Linear Dimensions (DrawingDimContLinHNoReplace) 1888
Vertical Linear Dimensions (DrawingDimContLinVNoReplace) .... 1889
Radial Dimensions (DrawingDimContRadNoReplace) ................. 1890
North Arrow (DrawingNArrowContent) .......................................... 1891
No Label Content (DrawingNoContent) ......................................... 1893
Pipe Segment Dimensions with Value Replacement (DrawingPipeSegsDimContent) 1894
Pipe Segment Dimensions (DrawingPipeSegsDimContNoReplace) 1895
Weld (DrawingWeldSymbols) ........................................................ 1896
SP3DDrawingLabelQuery.............................................................. 1897
Structural Widget (StructuralWidgetLabelContent) ....................... 1897

Piping Elevation (DrawingBOLabelContent)


Uses data from reports to label elevations of routing objects, such as pipe, ducts, cable trays,
and conduit.
Type -1 to suppress the label when an error occurs.

1 - Error label

Drawings and Reports Reference Data Guide 1819


Annotation Modules

Type 0 to display the label regardless of an error.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingBOLabelContent"/>
<ID attributeName="Piping Plan_Routable_INV Elev_M">
Piping Plan_Routable_INV Elev_M.rtp</ID>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).

Example

Drawings and Reports Reference Data Guide 1820


Annotation Modules

Trench (DrawingCivilLabelContent)
Places an automatic label with the content of invert elevation values (Z) of the straight and turn
features created with the Civil task.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingCivilLabelContent"/>
<ID attributeName="Civil_TrenchFeature_StartElevation">
Civil_TrenchFeature_StartElevation.rtp</ID>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.

Drawings and Reports Reference Data Guide 1821


Annotation Modules

ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).

Example

Drawings and Reports Reference Data Guide 1822


Annotation Modules

Horizontal Coordinate Dimensions


(DrawingCoordDimContLinHNoReplace)
Places a horizontal coordinate dimension that is based on paper space within the matchline.

Usage in Label or Dimension Template XML


<label>
<content>
<contentModule value="DrawingCoordDimContLinHNoReplace" />
<preserveTextOrientation>0</preserveTextOrientation>
<dimStyle>ANSI</dimStyle>
<dimLayer></dimLayer>
</content>
</label>

Customization
preserveTextOrientation
Determines whether or not text always uses the dimension style setting in the label template
.xml file.
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.
dimLayer
Represents the SmartSketch drawing layer on which the software places the dimensions for
the selected template.

Vertical Coordinate Dimensions


(DrawingCoordDimContLinVNoReplace)
Places a vertical coordinate dimension that is based on paper space within the matchline.

Usage in Label or Dimension Template XML


<label>
<content>
<contentModule value="DrawingCoordDimContLinVNoReplace />
<preserveTextOrientation>0</preserveTextOrientation>
<dimStyle>ANSI</dimStyle>
<dimLayer></dimLayer>
</content>
</label>

Customization
preserveTextOrientation
Determines whether or not text always uses the dimension style setting in the label template
.xml file.

Drawings and Reports Reference Data Guide 1823


Annotation Modules

In the Preserve Text Orientation property, select On to force the text to follow the style
setting of the dimension or label template .xml file. Select Off to rotate and move the text
away from the dimension line when not enough clear space exists.
dimLayer
Represents the SmartSketch drawing layer on which the software places the dimensions for
the selected template.
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.

DrawingCuttingPlanesContent
Outputs cutting plane information based on the view direction of the section view. This module
inherits functionality from Default (DrawingLabelHelper) (on page 1268).

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingCuttingPlanesContent"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

1 - Error label

Drawings and Reports Reference Data Guide 1824


Annotation Modules

Type 0 to display the label regardless of an error.

1 - Empty label

For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).

Example

Object Coordinates (DrawingEquipmentStyle2Content)


Outputs coordinate label data in a text box that is taken from specified reports. A separate report
is specified for each view local coordinate system axis.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingEquipmentStyle2Content"/>
<ID attributeName=
"Piping Plan_Equipment_Name_Style2_East Coordinate"
type="Vert">
Piping Plan_Equipment_Name_Style2_East Coordinate.rtp
</ID>
<ID attributeName=
"Piping Plan_Equipment_Name_Style2_East Coordinate"
type="Horiz">
Piping Plan_Equipment_Name_Style2_North Coordinate.rtp
</ID>
<ignoreError>-1</ignoreError>
</content>
</label>

Drawings and Reports Reference Data Guide 1825


Annotation Modules

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.
type
Specifies the local coordinate system axis of the view.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).

Drawings and Reports Reference Data Guide 1826


Annotation Modules

Flow Direction (DrawingFlowDirectionContent)


Places flow arrow symbols on pipe runs and orients them based on the flow direction properties
of the pipes. The software draws a symbol at one-half of the pipe diameter and can draw the
symbol on a pipe resymbolized as a line.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingFlowDirectionContent"/>
<unidirectionalSymbol>
Piping Plan_FlowArrow_By Part_Flow_arrow1.sym
</undirectionalSymbol>
<bidirectionalSymbol>
Piping Plan_FlowArrow_By Part_Flow_arrow-bi.sym
</bidirectionalSymbol>
<noFlowSymbol>
Piping Plan_FlowArrow_By Part_No-Flow_Arrow1.sym
<noFlowSymbol>
<minDiameter>0.02</minDiameter>
<ignoreError>-1</ignoreError>
<scaleFactor>0.5</scaleFactor>
</content>
</label>
The symbol file must be located in the same folder as the label template XML, and
the center line of the pipe must be drawn.

Customization
unidirectionalSymbol

1 - Pipe
2 - Unidirectional Symbol

bidirectionalSymbol

Drawings and Reports Reference Data Guide 1827


Annotation Modules

1 - Pipe
2 - Bidirectional Symbol

noFlowSymbol
Specifies the symbol that the system places when the pipe on which you want to place the
symbol does not permit flow to travel through the pipe.
This attribute is only available for flow arrows that you place manually.

1 - Pipe
2 - NoFlow Symbol

minDiameter
Specifies the minimum diameter of a routed object at which the system may place a flow
arrow.
Pipes of a smaller outside diameter have no flow arrow.

1 - 0.0 m diameter
pipe
2 - Flow arrow

ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

Drawings and Reports Reference Data Guide 1828


Annotation Modules

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

scaleFactor
Controls the size of pipe flow arrow symbols. The software places a flow direction arrow
scaled to a percentage of the pipe diameter.

Drawings and Reports Reference Data Guide 1829


Annotation Modules

Hanger Key Plan (DrawingHangerLabelContent)


Determines key plan symbols for pipe hangers.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingHangerLabelContent"/>
<ID attributeName="GRID1">
HngSup KeyPlan_Grid1.rtp</ID>
<ID attributeName="GRID2">
HngSup KeyPlan_Grid2.rtp</ID>
<ID attributeName="DIMENSION1">
HngSup KeyPlan_Dimension1.rtp</ID>
<ID attributeName="DIMENSION2">
HngSup KeyPlan_Dimension2.rtp</ID>
<ID attributeName="ELEVATION">
HngSup KeyPlan_Elevation.rtp</ID>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

1 - Error label

Drawings and Reports Reference Data Guide 1830


Annotation Modules

Type 0 to display the label regardless of an error.

1 - Empty label

For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).

Default (DrawingLabelHelper)
Outputs data in a text box that is taken from a specified report label. Two conditions must exist
for this content module to work properly:
 The drawing view must be linked to a report. If this condition is not met, an error is logged in
the Smart 3D Error Log.
 The item being labeled in the view style must be in the report. If this condition is not met, a
question mark (?) is displayed.
Type 0 to display the label regardless of an error.

1 - Error label

Drawings and Reports Reference Data Guide 1831


Annotation Modules

Type -1 to suppress the label when an error occurs.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingLabelHelper"/>
<ID attributeName="Equipment Plan_Equipment_Name">
Equipment Plan_Equipment_Name.rtp</ID>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
The ignoreError property is unavailable when you define the symbol path label.
For more information, see Symbol Path Label (on page 1474).
symbolPathLabel
Specifies which report template contains the symbol file names for the label.

Drawings and Reports Reference Data Guide 1832


Annotation Modules

 The ID attributeName value must match the name in the Value box in the Text Box
Properties dialog box for the label template .sym file you are modifying, as shown
below:

 For more information on modifying label templates, see Create a Compound Label with
a Combined Symbol (on page 748).

Examples
Equipment label:

Drawings and Reports Reference Data Guide 1833


Annotation Modules

Bubble label with no content and ignoreError value of 0 (or ignoreError is not defined):

Bubble label with no content and ignoreError value of -1:

Drawings and Reports Reference Data Guide 1834


Annotation Modules

Matchline (DrawingMatchlineContent)
Generates matchline label content. This content module is dependent on the
DrawingMatchlinePG point generator. For more information, see Matchline
(DrawingMatchlinePG) (on page 1623).

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingMatchlineContent"/>
<ID attributeName="Matchline" type="North">
Matchline\MatchlineNorth.rtp</ID>
<ID attributeName="Matchline" type="West">
Matchline\MatchlineWest.rtp</ID>
<ID attributeName="Matchline" type="South">
Matchline\MatchlineSouth.rtp</ID>
<ID attributeName="Matchline" type="East">
Matchline\MatchlineEast.rtp</ID>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

1 - Error label

Drawings and Reports Reference Data Guide 1835


Annotation Modules

Type 0 to display the label regardless of an error.

1 - Empty label

For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).

 The ID attributeName value must match the name in the Value box in the Text Box
Properties dialog box for the label template .sym file you are modifying, as shown
below:

 For more information on modifying label templates, see Create a Compound Label with
a Combined Symbol (on page 748).

Drawings and Reports Reference Data Guide 1836


Annotation Modules

DrawingOrientToY0Content
Orients label content to the Y0 grid of the coordinate system. This module is used by the
OffCenterline label.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingOrientToY0Content"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).

Drawings and Reports Reference Data Guide 1837


Annotation Modules

Reference (DrawingReferenceLabelContent)
Uses data from reports to label objects in drawings. Typically, the value is an item number, but
data from any field in the report can be passed in. Two conditions must exist for this content
module to work properly:
 The drawing view must be linked to a report. If this condition is not met, an error is logged in
the SP3D Error Log.
 The item being labeled in the view style must be in the report. If this condition is not met, a
question mark (?) is displayed.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingReferenceLabelContent"/>
<ID attributeName="ItemTag">ItemTag.rtp</ID>
<ignoreError>0</ignoreError>
</content>
</label>

Drawings and Reports Reference Data Guide 1838


Annotation Modules

Customization
attributeName
Specifies the name of a label attribute and the report template used to define the contents of
the label. You can define the report template location in the label template XML.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.

Knuckle Angle Symbol (ISKnuckleAngleSymbolContent)


Creates a symbol containing the knuckle angle value obtained from the embedded report.

Knuckle angle symbol

Usage in Label Template XML


<label>
<content>
<contentModule value="ISKnuckleAngleSymbolContent"/>
<ID attributeName="Scantling Knuckle Surface Angle">
Scantling Knuckle Surface Angle.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Drawings and Reports Reference Data Guide 1839


Annotation Modules

Manufacturing Margin Symbol (ISMfgMarginSymbolContent)


Creates a symbol containing the plate margin value obtained from the embedded report.

Manufacturing margin symbol

Usage in Label Template XML


<label>
<content>
<contentModule value="ISMfgMarginSymbolContent"/>
<ID attributeName="MfgMarginValue">MfgMarginValue.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Profile Sketch Linear Feature


(ISProfileSketchFeatureLinearDimCM)
Places a horizontal dimension on a profile feature, such as an edge or corner feature, on a
profile sketch drawing. Profile Sketch Linear Feature (ISProfileSketchFeatureLinearDimPG) (on
page 1760) creates points for the dimension.

Usage in Label or Dimension Template XML


<dimension>
<dimensionContentModules>
<horiz>ISProfileSketchFeatureLinearDimCM</horiz>
<dimStyle>ANSI</dimStyle>
</dimensionContentModules>
</dimension>

Customization
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.

Drawings and Reports Reference Data Guide 1840


Annotation Modules

Profile Sketch Radial Feature


(ISProfileSketchFeatureRadialDimCM)
Places a radial dimension on a profile feature, such as an edge or corner feature, on a profile
sketch drawing. Profile Sketch Radial Feature (ISProfileSketchFeatureRadialDimPG) (on page
1761) creates points for the dimension.

Usage in Label or Dimension Template XML

<dimension>
<dimensionContentModules>
<horiz>ISProfileSketchFeatureRadialDimCM</horiz>
<dimStyle>ANSI</dimStyle>
</dimensionContentModules>
</dimension>

Customization
dimStyle
Defines the appearance of a leader line. To choose a default style delivered with the
software, select the style to apply to the leader line.

ISRulesetSymbolContent
Places symbols outside of the view.

Customization
None

Drawings and Reports Reference Data Guide 1841


Annotation Modules

Manufacturing Sketch (MfgSketchContent)


Creates symbols from manufacturing XML data created in the Structural Manufacturing task.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDGenericContentInterOp"/>
<Assembly value="MfgSketchContent" />
<symbol representation="" scale="0.001">
<labels>
<label name="ANGLE_A">
<file>
<![CDATA[ StrMfg Sketch Bevel Symbol_Angle
Label ]]>
</file>
<value type="xpath">
<![CDATA[
descendant-or-self::SMS_BEVEL/@ANGLE_A ]]>
</value>
</label>
</labels>
<parameters>
<parameter name="ANGLE_A">
<value type="xpath">
<![CDATA[
descendant-or-self::SMS_BEVEL/@ANGLE_A ]]>
</value>
</parameter>
</parameters>
</symbols>
</content>
</label>

Customization
Assembly value
Specifies the name of the content module to use.
SMDGenericContentInterOp is a wrapper content module that must be used with
.NET content modules.

Scantling Weld Symbol (DwgScantlingWeld)


Creates a weld symbol. Selects a weld symbol file based on weld type.

Usage in Label Template XML


<label>
<content>
<contentModule value="DwgScantlingWeld"/>
<contentModuleSettings>

Drawings and Reports Reference Data Guide 1842


Annotation Modules

<symbolInfo>
<weldInfo>
<weldType>ButtWeld1</weldType>
</weldInfo>
<symbol>Structure_Weld_IButt.sym</symbol>
</symbolInfo>
<symbolInfo>
<weldInfo>
<weldType>TeeWeld1</weldType>
</weldInfo>
<symbol>Structure_Weld_Tee1.sym</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Customization
symbolInfo
Contains options for the weld symbol. symbolInfo is typically specified multiple times for
different weld types.
weldInfo
Contains options for the weld.
weldType
Specifies a weld type as defined in the catalog, such as ButtWeld1, ButtWeld2, and
TeeWeld1.
symbol
Specifies the weld symbol file (.sym) that the software uses with the specified weld type. If
you do not provide a path for a file, the software looks for the file in the same folder as the
label template .xml file.
For more information about weld types, see Weld Labels (on page 938).

Examples
Each weldType can place a different weld symbol.

1 - Tee weld
2 - Butt weld

Drawings and Reports Reference Data Guide 1843


Annotation Modules

Override (ISDimensionContentOverride)
Places a horizontal dimension between two points on a non-scale drawing, such as a profile
sketch drawing. The distance between the points is determined from the model, and a string
with that value overrides the incorrect value of the not-to-scale dimension. This module is
typically used with the Between Points (ISDimensionBtwPointsPG) (on page 1753) point
generator and the Between Points (ISDimensionBetweenPointsGA) (on page 1788)
geometric analyzer.
Vertical dimensions are not supported.

Usage in Label Template XML


<dimension>
<dimensionContentModules>
<horiz>ISDimensionContentOverride</horiz>
</dimensionContentModules>
</dimension>

Customization
None

Example

ISDwgEndCutRuleServer
Receives profile and end cut geometry from an end cut content module, and returns the
appropriate end cut symbol.

 This module is used with a delivered content module, such as ISDwgProfileEndCutSymbol


(on page 1845), and as an interface with third-party software.
 This module is only valid with steel order rule sets.

Drawings and Reports Reference Data Guide 1844


Annotation Modules

Usage in Label Template XML


<label>
<content>
<contentModule value="ISDwgProfileEndCutSymbol"/>
<externalRuleServer value="ISDwgEndCutRuleServer"/>
<contentModuleSettings>
.....
</contentModuleSettings>
</content>
</label>

Customization
None

ISDwgProfileEndCutSymbol
Creates a profile end cut symbol. Selects an end cut symbol file based on profile cross-section,
end cut type, location of the endcut on the profile, and end cut filter.
Used with the external rule server ISDwgEndCutRuleServer (on page 1844).

Usage in Label Template XML


<label>
<content>
<contentModule value="ISDwgProfileEndCutSymbol"/>
<externalRuleServer value="ISDwgEndCutRuleServer"/>
<contentModuleSettings>
<symbolInfo>
<profileInfo>
<SectionType>B</SectionType>
<EndCutType>W</EndCutType>
<WebCutType>WebCut_C3Right</WebCutType>
<ProfileSide>Start</ProfileSide>
<WebCutFilter>
<![CDATA[Catalog Filters\Default Filters\
Drawing Filters\Types of Drawings\
Scantling By Plate Parts\EndCut Filters\
Sniped Web with Cutback]]>
</WebCutFilter>
<TopFlangeCutFilter>
<![CDATA[Any]]>
</TopFlangeCutFilter>
<BottomFlangeCutFilter>
<![CDATA[Any]]>
</BottomFlangeCutFilter>
</profileInfo>
<symbol>EndCut_1_Open_Off_S.sym</symbol>
</symbolInfo>
<symbolInfo>
<profileInfo>
<SectionType>B</SectionType>
<EndCutType>W</EndCutType>

Drawings and Reports Reference Data Guide 1845


Annotation Modules

<WebCutType>WebCut_C3Right</WebCutType>
<ProfileSide>End</ProfileSide>
<WebCutFilter>
<![CDATA[Catalog Filters\Default Filters\
Drawing Filters\Types of Drawings\
Scantling By Plate Parts\EndCut Filters\
Sniped Web with Cutback]]>
</WebCutFilter>
<TopFlangeCutFilter>
<![CDATA[Any]]>
</TopFlangeCutFilter>
<BottomFlangeCutFilter>
<![CDATA[Any]]>
</BottomFlangeCutFilter>
</profileInfo>
<symbol>EndCut_1_Open_Off_S.sym</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Customization
externalRuleServer
Specifies the name of the rule used by the content module. The valid value is
ISDwgEndCutRuleServer,
symbolInfo
Contains options for the end cut symbol.
symbolInfo is typically specified multiple times for different profile and end cut
combinations.
profileInfo
Contains options for the profile using the end cut symbol.
SectionType
Specify a profile section type defined in the Catalog, such as B, BUL2, EA, FB, T, or UA.
For more information, see 2D Symbols Reference Data Guide.
EndCutType
Specify an end cut type as defined in the Catalog, such as W, C, F, S, FV, R, or RV. For
more information, see 2D Symbols Reference Data Guide.
WebCutType
Specify a web cut type as defined in the Catalog, such as WebCut_C3Right, WebCut_F1B,
or WebCut_S1. For more information, see 2D Symbols Reference Data Guide.
ProfileSide
Specify the end of the profile, relative to the drawing view. Use Start or End. Start is the
bottom and/or left-most end. End is the top and/or right-most end. Different symbols are
typically specified for Start and End when the symbols are unsymmetrical.

Drawings and Reports Reference Data Guide 1846


Annotation Modules

1 - Start
2 - End

WebCutFilter, TopFlangeCutFilter, BottomFlangeCutFilter


Specify a filter as defined in the Catalog. The complete filter path is specified using the XML
character data CDATA format. No end cut symbol is placed for an end cut that does not
meet the filter criteria.
symbol
Specify the end cut symbol file (.sym). If a path for a file is not given, the file is located in the
same folder as the label template XML file. For more information, see End Cut Embedded
Symbols (Steel Order Rule Set) (on page 1045).

Example
Each combination of options in symbolInfo can place a different end cut symbol. Three types
are shown in the example.

ISDwgSlotRuleServer
Receives profile and slot geometry from a slot content module, and returns the appropriate slot
symbol.
Used with a delivered content module, such as SlotSymbols (on page 1864), and as
an interface with third-party software.

Usage in Label Template XML


<label>
<content>
<contentModule value="SlotSymbols"/>
<externalRuleServer value="ISDwgSlotRuleServer"/>

Drawings and Reports Reference Data Guide 1847


Annotation Modules

<contentModuleSettings>
.....
</contentModuleSettings>
</content>
</label>

Customization
None

Knuckle Point Symbol (ISKnucklePointSymbolContent)


Creates a knuckle point symbol on a plate.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISKnucklePointSymbolContent"/>
<contentModuleSettings>
<symbolInfo>
<symbol>Scantling Knuckle Point
Symbol.sym</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Customization
symbolInfo
Contains options for the knuckle slope symbol.
symbol
Specifies the knuckle slope symbol file (.sym). If a path for a file is not given, the file is
located in the same folder as the label template XML file.

Examples

Drawings and Reports Reference Data Guide 1848


Annotation Modules

Knuckle Sloping Direction Symbol


(ISKnuckleSlopingDirectionSymbolContent)
Creates a knuckle slope symbol on a plate, based on the direction of the slope.

Usage in Label Template XML


<label>
<content>
<contentModule
value="ISKnuckleSlopingDirectionSymbolContent"/>
<contentModuleSettings>
<symbolInfo>
<knuckleInfo>
<SurfaceA_Topology>1</SurfaceA_Topology>
<SurfaceB_Topology>2</SurfaceB_Topology>
</knuckleInfo>
<symbol>
Scantling Knuckle Plate Sloping Symbol.sym
</symbol>
</symbolInfo>
<symbolInfo>
<knuckleInfo>
<SurfaceA_Topology>2</SurfaceA_Topology>
<SurfaceB_Topology>2</SurfaceB_Topology>
</knuckleInfo>
<symbol>
Scantling Knuckle Plate Sloping Bothsides
Symbol.sym
</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Customization
symbolInfo
Contains options for the knuckle slope symbol.
symbolInfo is typically specified multiple times for different surface topology
combinations.
knuckleInfo
Contains properties for the knuckle surfaces.
SurfaceA_Topology, SurfaceB_Topology
Specifies whether each surface of the knuckle has a slope with respect to the plane of the
drawing view. Select 1 for no slope, 2 for slope.
symbol
Specifies the knuckle slope symbol file (.sym). If a path for a file is not given, the file is

Drawings and Reports Reference Data Guide 1849


Annotation Modules

located in the same folder as the label template XML file.

Examples
Sloped on one side:

Sloped on two sides:

Plate Angle Symbol (ISPlateAngleSymbolContent)


Computes the angle of the non-target plate with reference to the target plate and places the
mounting angle symbol. The module obtains the plate angle value from the embedded report.
The orientation of the symbol indicates the mounting side of the plate.

Plate angle symbol

A symbol is not placed when:


 The mounting angle is 90º.
 The plate is not planar.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISPlateAngleSymbolContent"/>
ID attributeName="Scantling Plate Mounting Angle">
Scantling Plate Mounting Angle.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Drawings and Reports Reference Data Guide 1850


Annotation Modules

Plate Thickness Symbol (ISPlateThicknessSymbolContent)


Creates a plate thickness direction symbol for a non-target plate.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISPlateThicknessSymbolContent"/>
<contentModuleSettings>
<symbolInfo>
<plateInfo>
<ThicknessDirection>Up</ThicknessDirection>
</plateInfo>
<symbol>
Scantlings\ISO Plate Thickness Direction Up.sym
</symbol>
</symbolInfo>
<symbolInfo>
<plateInfo>
<ThicknessDirection>Down</ThicknessDirection>
</plateInfo>
<symbol>
Scantlings\ISO Plate Thickness Direction Down.sym
</symbol>
</symbolInfo>
<symbolInfo>
<plateInfo>
<ThicknessDirection>Centered</ThicknessDirection>
</plateInfo>
<symbol>
Scantlings\ISO Plate Thickness Direction Centered.sym
</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Customization
symbolInfo
Contains options for the thickness symbol.
plateInfo
Contains options for the plate using the thickness symbol.
ThicknessDirection
Specify the thickness direction. Select Up, Down, Centered, or Any. Up is determined by
the positive axes of the drawing view, as defined by the orientation rule of the view. For
more information, see Orientation Rules in Drawings by Rule (on page 297).
symbol

Drawings and Reports Reference Data Guide 1851


Annotation Modules

Specify the thickness symbol file (.sym). If a path for a file is not given, the file is located in
the same folder as the label template XML file.
symbolInfo is typically specified multiple times for different thickness directions.

Example

Profile Angle Symbol (ISProfileAngleSymbolContent)


Creates a symbol containing the profile mounting angle value obtained from the embedded
report. The orientation of the symbol indicates the mounting side of the profile.

Profile angle symbol

A symbol is not placed when:


 The mounting angle is 90º.
 The profile is twisted and has multiple regions with different mounting angles.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISProfileAngleSymbolContent"/>
<ID attributeName="Scantling Profile Mounting Angle">
Scantling Profile Mounting Angle.rtp</ID>
</content>
</label>

Customization
attributeName

Drawings and Reports Reference Data Guide 1852


Annotation Modules

Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.
The format is:
< ID attributeName="symbol file name (without .sym extension)">report file name.rtp</ID >
You can define the report template location in the label template XML file.

ISProfilePartThicknessSymbolContent
Creates a profile thickness direction symbol for a profile part based on profile cross-section,
thickness direction, and flange direction.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISProfilePartThicknessSymbolContent"/>
<contentModuleSettings>
<symbolInfo>
<profileInfo>
<crossSectionType>BulbFlat</crossSectionType>
<thicknessDirection>Up</thicknessDirection>
<flangeDirection>Up</flangeDirection>
</profileInfo>
<symbol>
Scantlings\
ISO Profile Bulb flat-section Thickness Up Flange Up.sym
</symbol>
</symbolInfo>
<symbolInfo>
<profileInfo>
<crossSectionType>UnequalAngle</crossSectionType>
<thicknessDirection>Down</thicknessDirection>
<flangeDirection>Up</flangeDirection>
</profileInfo>
<symbol>
Scantlings\
ISO Profile L-section Thickness Down Flange Up.sym
</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Customization
symbolInfo
Contains options for the thickness symbol.
profileInfo
Contains options for the profile using the thickness symbol.

Drawings and Reports Reference Data Guide 1853


Annotation Modules

crossSectionType
Specify a profile section type defined in the Catalog. Select BulbFlat, EqualAngle,
UnequalAngle, FlatBar, IBar, TeeBar, Channel, RoundTube, RectangleTube, or Any.
For more information, see 2D Symbols Reference Data Guide.
thicknessDirection
Specify the thickness direction. Select Up, Down, Centered, or Any.
flangeDirection
Specify the flange direction. Select Up, Down, or Any.
symbol
Specify the thickness symbol file (.sym). If a path for a file is not given, the file is located in
the same folder as the label template XML file.

 symbolInfo is typically specified multiple times for different profile and thickness direction
combinations.
 Up is determined by the positive axes of the drawing view, as defined by the orientation rule
of the view. For more information, see Orientation Rules in Drawings by Rule (on page 297).

Example

Drawings and Reports Reference Data Guide 1854


Annotation Modules

Profile System Thickness Symbol


(ISProfileSysThicknessSymbolContent)
Creates a profile thickness direction symbol for a profile system based on thickness direction.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISProfileSysThicknessSymbolContent"/>
<contentModuleSettings>
<symbolInfo>
<profileInfo>
<thicknessDirection>Up</thicknessDirection>
</profileInfo>
<symbol>Scantling Thickness Direction Up.sym</symbol>
</symbolInfo>
<symbolInfo>
<profileInfo>
<thicknessDirection>Down</thicknessDirection>
</profileInfo>
<symbol>Scantling Thickness Direction Down.sym</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Customization
symbolInfo
Contains options for the thickness symbol.
profileInfo
Contains options for the profile using the thickness symbol.
thicknessDirection
Specify the thickness direction. Select Up, Down, Centered, or Any.
symbol
Specify the thickness symbol file (.sym). If a path for a file is not given, the file is located in
the same folder as the label template XML file.

 symbolInfo is typically specified multiple times for different thickness directions.


 Up is determined by the positive axes of the drawing view, as defined by the orientation
rule of the view. For more information, see Orientation Rules in Drawings by Rule (on
page 297).

Drawings and Reports Reference Data Guide 1855


Annotation Modules

Default Marine Label (ISRulesetLabelContent)


Creates a text box symbol containing a value obtained from the embedded report.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISRulesetLabelContent"/>
<ID attributeName="Ruleset_Name">Ruleset_Name.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Seam Symbol (ISSeamSymbolContent)


Creates a seam symbol on a plate. Selects a seam symbol file based on seam type.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISSeamSymbolContent"/>
<contentModuleSettings>
<symbolInfo>
<seamInfo>
<SeamType>Design<SeamType>
</seamInfo>
<symbol>Scantling Design Seam Symbol.sym</symbol>
</symbolInfo>
<symbolInfo>
<seamInfo>
<SeamType>Planning</SeamType>
</seamInfo>
<symbol>Scantling Block Seam Symbol.sym</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Customization
symbolInfo
Contains options for the seam symbol.

Drawings and Reports Reference Data Guide 1856


Annotation Modules

symbolInfo is typically specified multiple times for different seam types.


seamInfo
Contains options for the seam.
SeamType
Specify a seam type. Select Design, Intersection, Straking, Planning, or Any.
symbol
Specify the seam symbol file (.sym). If a path for a file is not given, the file is located in the
same folder as the label template XML file.

Examples

1- Design seam symbol on a target plate


2 - Design seam symbol on a non-target plate

Drawings and Reports Reference Data Guide 1857


Annotation Modules

Ship Direction Symbol (ISShipDirectionSymbolContent)


Creates a ship direction symbol for a specified view direction. A symbol is selected based on the
ship direction matching a selected view direction.

Usage in Label Template XML


<label>
<content>
<contentModule value="ISShipDirectionSymbolContent"/>
<contentModuleSettings>
<directionValue>Up</directionValue>
<directionSymbols>
<port>port.sym</port>
<starboard>starboard.sym</starboard>
<aft>aft.sym</aft>
<forward>forward.sym</forward>
<up>up.sym</up>
<down>down.sym</down>
</directionSymbols>
</contentModuleSettings>
</content>
</label>

Customization
directionValue
Specifies the view direction. Use Up, Down, Left, or Right.

1 - Up
2 - Down
3 - Left
4 - Right

directionSymbols
Specifies the symbol (.sym) file to use for each ship direction. Specify symbols for port,
starboard, aft, forward, up, and down. If a path for a file is not given, the file is located in
the same folder as the label template .xml file.

 View direction is the direction in paper space (that is, on the drawing sheet).
 Ship direction is determined within the view based on the location and direction of the view
relative to the model.

Drawings and Reports Reference Data Guide 1858


Annotation Modules

Examples
Ship direction is up for a directionValue of Up. The up option of directionSymbols is used:

Ship direction is starboard for a directionValue of Right. The starboard option of


directionSymbols is used:

Drawings and Reports Reference Data Guide 1859


Annotation Modules

Manufacturing Profile Plate Location Symbol


(MfgProfilePlateLocSymContent)
Creates a plate location mark symbol with thickness direction information on an edge
reinforcement (ER) profile. Selects a symbol file based on the thickness direction of the plate
and the marked side.

Usage in Label Template XML


<label>
<content>
<contentModule value="MfgProfilePlateLocSymContent"/>
<contentModuleSettings>
<symbolInfo>
<plateInfo>

<thicknessDirection>Centered</thicknessDirection>
<markedSide>0</markedSide>
</plateInfo>
<symbol> StrMfg ProfileSketch Plate Location
Symbol Centered.sym </symbol>
</symbolInfo>
<symbolInfo>
<plateInfo>

<thicknessDirection>Centered</thicknessDirection>
<markedSide>1</markedSide>
</plateInfo>
<symbol> StrMfg ProfileSketch Plate Location
Symbol Centered Hidden.sym</symbol>
</symbolInfo>
<symbolInfo>
<plateInfo>

<thicknessDirection>Any</thicknessDirection>
<markedSide>0</markedSide>
</plateInfo>
<symbol> StrMfg ProfileSketch Plate Location
Symbol.sym </symbol>
</symbolInfo>
<symbolInfo>
<plateInfo>

<thicknessDirection>Any</thicknessDirection>
<markedSide>1</markedSide>
</plateInfo>
<symbol> StrMfg ProfileSketch Plate Location
Symbol Hidden.sym </symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Drawings and Reports Reference Data Guide 1860


Annotation Modules

Customization:
symbolInfo
Contains options for the thickness direction and marked side of the plate location symbol.
symbolInfo is typically specified multiple times for different seam types.
plateInfo
Contains options for the plate.
symbol
Specifies the symbol file (.sym). Specify the symbol for thickness directions Centered and
Up/Down (Any). If the path for a file is not given, the file is placed in the same folder as the
label template XML file.
thicknessDirection
Specifies the thickness direction of the plate. Select Centered or Any as required.
markedSide
Specifies the marked side of plate mark. Select 0 (marking side) or 1 (anti-marking side) as
required.
Centered
Specifies that the thickness direction of the plate that has the edge reinforcement centered.

Drawings and Reports Reference Data Guide 1861


Annotation Modules

Any
Specifies that the thickness direction of the plate that has an edge reinforcement is either up
or down. The software uses the same symbol file for both the up and down directions. If
required. the symbol is rotated, based on the thickness direction of the plate.

SM3D ProfileSketchFeatureSymbol
Places feature symbols for defined feature types.

Usage in Label Template XML


<label>
<content>
<contentModule value="ProfileSketchFeatureSymbol"/>
<contentModuleSettings>
<!-- Feature Types = EdgeFeature, WaterStop -->
<symbolInfo>
<FeatureInfo>
<FeatureType>EdgeFeature</FeatureType>
</FeatureInfo>
<symbol>EdgeFeature.sym</symbol>
</symbolInfo>
<symbolInfo>
<FeatureInfo>
<FeatureType>WaterStop</FeatureType>
</FeatureInfo>
<symbol>WaterStop.sym</symbol>

Drawings and Reports Reference Data Guide 1862


Annotation Modules

</symbolInfo>
<symbolInfo>
<FeatureInfo>
<FeatureType>Any</FeatureType>
</FeatureInfo>
<symbol>DefaultFeature.sym</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Customization
symbolInfo, FeatureInfo, symbol

Example

1 - Symbol for a waterstop feature


2 - Symbol for an edge feature

Drawings and Reports Reference Data Guide 1863


Annotation Modules

ProfileSketchMarkingLineSymbol
Places appropriate marking symbol for a given type of marking line.

Usage in Label Template XML


<label>
<content>
<contentModule value="ProfileSketchMarkingLineSymbol"/>
<contentModuleSettings>
<!-- Marking Line Types = Fitting, ReferencePlane, etc -->
<symbolInfo>
<MarkInfo>
<MarkingLineType>Fitting</MarkingLineType>
</MarkInfo>
<symbol>FittingMark.sym</symbol>
</symbolInfo>
<symbolInfo>
<MarkInfo>
<MarkingLineType>Any</MarkingLineType>
</MarkInfo>
<symbol>DefaultMark.sym</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Customization
symbolInfo
Contains options for the thickness direction and marked side of the plate location symbol.
symbol
Specify the slot symbol file (.sym). If a path for a file is not given, the file is located in the
same folder as the label template XML file. For more information, see Slot Embedded
Symbols (on page 1056).

SlotSymbols
Creates a profile slot symbol. Selects a slot symbol file based on slot type, collar side, and plate
tightness.

 Used with the external rule server ISDwgSlotRuleServer (on page 1847).
 Typically used only with classification drawings containing light (non-detailed) parts.

Usage in Label Template XML


<label>
<content>
<contentModule value="SlotSymbols"/>
<externalRuleServer value="ISDwgSlotRuleServer"/>

Drawings and Reports Reference Data Guide 1864


Annotation Modules

<contentModuleSettings>
<symbolInfo>
<slotInfo>
<SlotType>SlotAA</SlotType>
<CollarSide>Any</CollarSide>
<PlateTightness>Non-Tight</PlateTightness>
</slotInfo>
<symbol>SystemSlotAA.sym</symbol>
</symbolInfo>
<symbolInfo>
<slotInfo>
<SlotType>SlotFA</SlotType>
<CollarSide>Hidden</CollarSide>
<PlateTightness>Tight</PlateTightness>
</slotInfo>
<symbol>SystemSlotF_CH_T.sym</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Customization
externalRuleServer
Specifies the name of the rule used by the content module. The valid value is
ISDwgSlotRuleServer,
symbolInfo
Contains options for the slot symbol.
slotInfo
Contains options for the slot using the slot symbol.
SlotType
Specify a slot type defined in the Catalog, such as SlotAA, SlotAC, or Slot AI. For more
information, see 2D Symbols Reference Data Guide.
CollarSide
Specify the side of the penetrated plate on which the collar is mounted, as the collar
appears in the drawing view. Select Hidden, Visible, or Any.
PlateTightness
Specify the tightness of the penetrated plate. Select Tight, Non-Tight, or Any.
symbol
Specify the slot symbol file (.sym). If a path for a file is not given, the file is located in the
same folder as the label template XML file. For more information, see Slot Embedded
Symbols (on page 1056).

 symbolInfo is typically specified multiple times for different slot combinations.

Drawings and Reports Reference Data Guide 1865


Annotation Modules

 CollarSide is used to define a SlotType, but the collar geometry may not be defined in the
symbol file.

Example

Remarking Girth Length Label


(SM3DDwgRemarkingGirthLengthCM)
Creates a label containing the girth length of a curve.

Usage in Label Template XML


<label>
<content>
<contentModule value="SM3DDwgRemarkingGirthLengthCM"/>
</content>
</label>

Customization
None

Marine Linear (SMDrawingDimContentLinear)


Places a linear dimension parallel to an imaginary line drawn between two dimensioning points,
and replaces the value of the dimension with the distance between two dimensioning points in
the 3D model.

Usage in Dimension Template XML

Usage in Label or Dimension Template XML

<dimensionContentModules>
<horiz>SMDrawingDimContentLinear</horiz>
<vert>SMDrawingDimContentLinear</vert>
<preserveTextOrientation>0</preserveTextOrientation>
<dimStyle>ANSI</dimStyle>
<dimLayer>???</dimLayer>
</dimensionContentModules>

Drawings and Reports Reference Data Guide 1866


Annotation Modules

Customization
None

Example

Manufacturing Pin Height Label


(SMDwgMfgPinHeightLabelContent)
Creates labels containing the pin height obtained from the embedded report.

Usage in Label Template XML

<label>
<content>
<contentModule value="SMDwgMfgPinHeightLabelContent">
<eliminateHeight>0</eliminateHeight>
</contentModule>
<ID attributeName="PinHeight">StrMfg PinJig PinHeight.rtp</ID>
</content>
</label>

Customization
eliminateHeight
Eliminates labels with a value less than or equal to the specified pin height value, in
millimeters.
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Drawings and Reports Reference Data Guide 1867


Annotation Modules

Manufacturing Profile Margin Symbol


(SMDwgMfgProfileMarginSymContent)
Creates a symbol containing the manufacturing profile margin obtained from the embedded
report.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgMfgProfileMarginSymContent"/>
<ID attributeName="MfgProfileMarginValue">
MfgProfileMarginValue.rtp</ID>
</content>
</label>

Customization
attributeName
Specify an attribute name and the report file (.rtp) that queries the model for needed values.
The values are added to a symbol file (.sym) used by the report. You can define the report
template location in the label template XML file.

Plate Grid Name Label (SMDwgPlateGridNameLabelContent)


Creates labels for plate grid names.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgPlateGridNameLabelContent"/>
</content>
</label>

Customization
None

Drawings and Reports Reference Data Guide 1868


Annotation Modules

Scantling Near Side or Far Side Symbol


(SMDwgScantlingNSorFSContent)
Creates symbols to designate near side and far side of a plate.
Near side of a plate is the side with the most profile stiffeners.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgScantlingNSorFSContent"/>
<contentModuleSettings>
<directionSymbols>
<near>NearSide.sym</near>
<far>FarSide.sym</far>
</directionSymbols>
</contentModuleSettings>
</content>
</label>

Customization
directionSymbols
Contains options for the symbols.
near, far
Specify the symbol file (.sym) for each side. If a path for a file is not given, the file is located
in the same folder as the label template .xml file.

Scantling Near Side or Far Side Direction Symbol


(SMDwgScantlingNSorFSDirectionContent)
Creates ship direction symbols based on whether the near side or the far side of a plate is
displayed.
The near side of a plate is the side with the most profile stiffeners.

Drawings and Reports Reference Data Guide 1869


Annotation Modules

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgScantlingNSorFSDirectionContent"/>
<contentModuleSettings>
<directionSymbols>
<port>port.sym</port>
<starboard>starboard.sym</starboard>
<aft>aft.sym</aft>
<forward>forward.sym</forward>
<up>up.sym</up>
<down>down.sym</down>
</directionSymbols>
</contentModuleSettings>
</content>
</label>

Customization
directionSymbols
Contains options for the direction symbols.
port, starboard, aft, forward, up, down
Specify the symbol file (.sym) for each side. If a path for a file is not given, the file is located
in the same folder as the label template .xml file.

Profile Seam Symbol (SMProfileSeamSymbolContent)


Creates a seam symbol on a profile. Selects a seam symbol file based on seam type.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMProfileSeamSymbolContent"/>
<contentModuleSettings>
<symbolInfo>
<seamInfo>
<SeamType>Design<SeamType>
</seamInfo>
<symbol>Scantling Block Seam Symbol.sym</symbol>
</symbolInfo>
<symbolInfo>
<seamInfo>
<SeamType>Any</SeamType>
</seamInfo>
<symbol>Scantling Unknown Seam Symbol.sym</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Drawings and Reports Reference Data Guide 1870


Annotation Modules

Customization
symbolInfo
Contains options for the seam symbol.
symbolInfo is typically specified multiple times for different seam types.
seamInfo
Contains options for the seam.
SeamType
Specify a seam type. Select Design, Intersection, Straking, Planning, or Any.
symbol
Specify the seam symbol file (.sym). If a path for a file is not given, the file is located in the
same folder as the label template XML file.

Profile Sketch Bevel Shape Label


(SMProfileSketchBevelShapeLabelsCM)
Outputs the labels in the shape of a bevel.

Usage in Label Template XML


<label>
<content>
<contentModule value = "SMProfileSketchBevelShapeLabelsCM"/>
</content>
</label>

Customization
None

Example

Drawings and Reports Reference Data Guide 1871


Annotation Modules

Profile Sketch Bevel Symbol


(SMProfileSketchBevelSymbolCM)
Outputs the bevel symbol with labels on the profile sketch.

Usage in Label Template XML


<label>
<content>
<contentModule value = "SMProfileSketchBevelSymbolCM"/>
</content>
</label>

Customization
None

Example

Drawings and Reports Reference Data Guide 1872


Annotation Modules

Ruler Axis (SMRulerAxisSymbolContent)


Creates a reference axis line with a tick mark at each reference plane. This module is used with
the Absolute Axis Position (SMDwgPositionAxis) (on page 1117) positioning module.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMRulerAxisSymbolContent"/>
<contentModuleSettings>
<axisInfo>
<marginDefinition>1</marginDefinition>
<bottom>
<offset>0.03</offset>
<style>Normal</style>
<tickMarkInfo>
<plusX>0.0</plusX>
<minusX>0.01</minusX>
<style>Normal</style>
</tickMarkInfo>
</bottom>
<left>
<offset>0.03</offset>
<style>Normal</style>
<tickMarkInfo>
<plusX>0.0</plusX>
<minusX>0.01</minusX>
<style>Normal</style>
</tickMarkInfo>
</left>
</axisInfo>
</contentModuleSettings>
</content>
</label>

Customization
axisInfo
Contains options for axis graphics.
tickMarkInfo
Contains options for tick mark graphics.

Drawings and Reports Reference Data Guide 1873


Annotation Modules

marginDefinition
Specifies the relationship of the grid axes to the drawing view for measuring the margin
offset of the axes.

XML
value

At View Frame 0
(default value)
Measures the margin
offset for each axis from
the edges of the view
SmartFrame, shown as
dashed lines in the
example.

At Drawing Area 1
Measures the margin
offset for each axis from
the edges of the drawing
area, shown as solid lines
in the example.

If you set the frame behavior to Frame resizes to drawing area, then the view frame and
the drawing area are the same size, and both values provide the same result, as shown in
the following example.

For more information, see Area Tab (Edit Ruleset View Style Dialog Box) (on page 130) in
the Drawings and Reports Reference Data Guide.
bottom or top
Specifies the side of the drawing view on which the software draws the horizontal axis.
Other properties are defined for this side. Select either Bottom or Top from the Horizontal
Ruler Axis Position list. Select None for no horizontal ruler axis to display.

Drawings and Reports Reference Data Guide 1874


Annotation Modules

Bottom

Top

left or right
Specifies the side of the drawing view on which the software draws the vertical axis. Other
properties are defined for the side. Select either Left or Right from the Vertical Ruler Axis
Position list. Select None for no ruler axis to display.

Left

Right

Drawings and Reports Reference Data Guide 1875


Annotation Modules

offset
Distance of a grid axis from the drawing view. Use offset in combination with the defined
axis (bottom, top, left, or right) and the margin definition.

style
Defines the line style for the axis or tick mark. Use style in combination with the defined axis
(bottom, top, left, or right) and with the tick mark information.
Line styles are defined in [Reference Data Product
Folder]\SharedContent\Drawings\Catalog\templates\Styles.sha.
plusX
Defines the length of the grid tick mark from the axis and toward the drawing view.

Drawings and Reports Reference Data Guide 1876


Annotation Modules

minusX
Defines the length of the grid tick mark from the axis and away from the drawing view.

Example

See Also
Horizontal Ruler Axis Offset (on page 1315)
Horizontal Ruler Axis Position (on page 1315)
Horizontal Ruler Axis Style (on page 1317)
Horizontal Ruler Axis Tick Mark Length Away from View (on page 1318)
Horizontal Ruler Axis Tick Mark Length toward View (on page 1319)
Horizontal Ruler Axis Tick Mark Style (on page 1320)
Vertical Ruler Axis Offset (on page 1484)
Vertical Ruler Axis Position (on page 1485)
Vertical Ruler Axis Style (on page 1486)
Vertical Ruler Axis Tick Mark Length Away from View (on page 1487)
Vertical Ruler Axis Tick Mark Length toward View (on page 1488)
Vertical Ruler Axis Tick Mark Style (on page 1489)

Drawings and Reports Reference Data Guide 1877


Annotation Modules

Template Set Full Scale Direction Symbol


(SMTemplatesetFullScaleDirSymbolContent)
Creates a looking direction symbol for the view.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMTemplatesetFullScaleDirSymbolContent"/>
<contentModuleSettings>
<directionValue>Right</directionValue>
<directionSymbols>
<port>port.sym<port>
<starboard>starboard.sym</starboard>
<aft>aft.sym</aft>
<forward>forward.sym</forward>
<up>up.sym</up>
<down>down.sym</down>
</directionSymbols>
</contentModuleSettings>
</content>
</label>

Customization
port
Specify the port direction symbol file (.sym).
starboard
Specify the starboard direction symbol file (.sym).
aft
Specify the aft direction symbol file (.sym).
forward
Specify the forward direction symbol file (.sym).
up
Specify the up direction symbol file (.sym).
down
Specify the down direction symbol file (.sym).
If a path for a file is not given, the file is located in the same folder as the label
template XML file.

Example

Drawings and Reports Reference Data Guide 1878


Annotation Modules

Thickness Direction Symbol (ThicknessSymContent)


Creates profile thickness direction symbols for:
 Non-target plate parts.
 Profile parts based on profile cross-section, thickness direction, and flange direction.

Usage in Label Template XML


<label>
<content>
<contentModule value="ThicknessSymContent"/>
<contentModuleSettings>
<symbolInfo>
<objectInfo>
<thicknessDirection>Up</thicknessDirection>
<crossSectionType>BulbFlat</crossSectionType>
<flangeDirection>Up</flangeDirection>
</objectInfo>
<symbol>..\ISO Profile Bulb flat-section Thickness
Up Flange Up.sym</symbol>
</symbolInfo>
<symbolInfo>
<objectInfo>
<thicknessDirection>Up</thicknessDirection>
<crossSectionType>N/A</crossSectionType>
<flangeDirection>N/A</flangeDirection>
</objectInfo>
<symbol>..\ISO Plate Thickness Direction Up.sym</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>

Customization
symbolInfo
Contains options for the thickness symbol.
objectInfo
Contains options for the plate or profile using the thickness symbol.
crossSectionType
Specify a profile section type defined in the Catalog. Select BulbFlat, EqualAngle,
UnequalAngle, FlatBar, IBar, TeeBar, Channel, RoundTube, RectangleTube, or Any.
Select N/A for plates. For more information, see 2D Symbols Reference Data Guide.
thicknessDirection
Specify the thickness direction. Select Up, Down, Centered, or Any.
flangeDirection
Specify the flange direction for a profile. Select Up, Down, or Any for profiles. Select N/A for

Drawings and Reports Reference Data Guide 1879


Annotation Modules

plates.
symbol
Specify the thickness symbol file (.sym). If a path for a file is not given, the file is located in
the same folder as the label template XML file.

 symbolInfo is typically specified multiple times for different plate thickness directions and
different profile/thickness direction combinations.
 Up is determined by the positive axes of the drawing view, as defined by the orientation rule
of the view. For more information, see Orientation Rules in Drawings by Rule (on page 297).

Example

Pin Jig Seam Offset Label (SMDPinJigSeamOffsetCM)


Gets the girth length of the curve for the intersection point and populates the label text box.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDPinJigSeamOffsetCM"/>
<Side>left</Side>
</content>
</label>

Customization
Side
The side of the curve that can be used to locate the label. Select Left or Right.

Drawings and Reports Reference Data Guide 1880


Annotation Modules

1 - Left
2 - Right

Profile Sketch Label (SMDwgProfileSketchLabelsContent)


Creates labels for profile sketches.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMDwgProfileSketchLabelsContent"/>
</content>
</label>

Customization
You can replace the content module in the label template with any .dll name that uses
IJDwgProfileSketchLabelGenerator to make it the current LabelGenerator for profile
sketches.

Profile Sketch Web Thickness Symbol


(SMPSWebThicknessContent)
Creates a web thickness direction symbol and places this on the top and bottom flanges of a
Built Up profile.

Usage in Label Template XML


<label>
<content>
<contentModule value="SMPSWebThicknessContent"/>
<contentModuleSettings>
<directionSymbols>
<Up>StrMfg ProfileSketch WebThickness_Up.sym</Up>
<Down>StrMfg ProfileSketch WebThickness_Down.sym</Down>
</directionSymbols>
</contentModuleSettings>
</content>
</label>

Customization
directionSymbols

Drawings and Reports Reference Data Guide 1881


Annotation Modules

Specify the symbol (.sym) file to use for each web thickness. Specify symbols for thickness
up and down directions. If a path for a file is not given, the file is located in the same folder
as the label template XML file.

Examples
The Up option of directionSymbols specifies the thickness up direction.

The Down option of directionSymbols specifies the thickness down direction.

Up is determined by the positive axes of the drawing view, as defined by the


orientation rule of the view. For more information, see Orientation Rules in Drawings by Rule (on
page 297).

Drawings and Reports Reference Data Guide 1882


Annotation Modules

Angular Dimensions (DrawingDimContAngNoReplace)


Places an angular dimension. The dimension is based on paper space in the view. This module
is only used by the penetration plate dimensioning in Piping Isometric Drawings.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingDimContAngNoReplace"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Drawings and Reports Reference Data Guide 1883


Annotation Modules

Angular Dimensions with Value Replacement


(DrawingDimContentAngular)
Places an angular dimension. The dimension is based on the angle in the 3D model, instead of
what is generated in the view.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingDimContentAngular"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

Drawings and Reports Reference Data Guide 1884


Annotation Modules

1 - Empty label

Horizontal Linear Dimensions with Value Replacement


(DrawingDimContentLinearH)
Places a horizontal dimension and replaces the value of the dimension with the distance
between two dimensioning points in the 3D model.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingDimContentLinearH"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

1 - Error label

Drawings and Reports Reference Data Guide 1885


Annotation Modules

Type 0 to display the label regardless of an error.

1 - Empty label

Vertical Linear Dimensions with Value Replacement


(DrawingDimContentLinearV)
Places a vertical dimension between two points in the drawing view using the calculated,
transformed value from the 3D model space to the 2D drawing space.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingDimContentLinearV"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

Drawings and Reports Reference Data Guide 1886


Annotation Modules

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Radial Dimensions with Value Replacement


(DrawingDimContentRadial)
Places a radial dimension using the actual 3D model radius. Only the penetration plate
dimensioning function in Piping Isometric Drawings uses this module.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingDimContentRadial"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

Drawings and Reports Reference Data Guide 1887


Annotation Modules

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Horizontal Linear Dimensions


(DrawingDimContLinHNoReplace)
Places a horizontal dimension that is based on paper space in the view.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingDimContLinHNoReplace"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.

Drawings and Reports Reference Data Guide 1888


Annotation Modules

Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Vertical Linear Dimensions


(DrawingDimContLinVNoReplace)
Places a vertical dimension that is based on paper space in the view.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingDimContLinVNoReplace"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an

Drawings and Reports Reference Data Guide 1889


Annotation Modules

error for the label.


Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Radial Dimensions (DrawingDimContRadNoReplace)


Places a radial dimension using the 2D paper-space model radius in the view.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingDimContRadNoReplace"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an

Drawings and Reports Reference Data Guide 1890


Annotation Modules

error for the label.


Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

North Arrow (DrawingNArrowContent)


Determines direction of true North for the North Arrow symbol.

Usage in Label Template XML


<label
<content>
<contentModule value="DrawingNArrowContent"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.

Drawings and Reports Reference Data Guide 1891


Annotation Modules

Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Example

Drawings and Reports Reference Data Guide 1892


Annotation Modules

No Label Content (DrawingNoContent)


Returns no content.
Type -1 to suppress a label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

1 - Empty label

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingNoContent"/>
<ignoreError>0</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.

Drawings and Reports Reference Data Guide 1893


Annotation Modules

Pipe Segment Dimensions with Value Replacement


(DrawingPipeSegsDimContent)
Places a linear dimension at any angle using the 3D model distance between the dimensioning
points. The distance is perpendicular to axes of pipe segments.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingPipeSegsDimContent"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

Drawings and Reports Reference Data Guide 1894


Annotation Modules

1 - Empty label

Pipe Segment Dimensions


(DrawingPipeSegsDimContNoReplace)
Places a linear dimension at any angle using the 2D paper-space distance between the
dimensioning points. Distance is perpendicular to axes of pipe segments.

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingPipeSegsDimContNoReplace"/>
<ignoreError>-1</ignoreError>
</content>
</label>

Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
Type -1 to suppress the label when an error occurs.

1 - Error label

Type 0 to display the label regardless of an error.

Drawings and Reports Reference Data Guide 1895


Annotation Modules

1 - Empty label

Weld (DrawingWeldSymbols)
Determines what weld symbols to place on a drawing

Usage in Label Template XML


<label>
<content>
<contentModule value="DrawingWeldSymbols"/>
<ID>WeldSymbols\Weldsymbol.rtp</ID>
<ignoreError>0</ignoreError>
</content>
<leaderSettings>
<toleranceAngle>0</toleranceAngle>
<toleranceAngleForSingleBevelJWeld>0
</toleranceAngleForSingleBevelJWeld>
</leaderSettings>
</label>

 This content module automatically generates the weld symbol representation according to
the AWS standard based on the label output provided in the <ID> section.
 The two-dimensional weld symbol that the software writes to the drawing is based on the
occurrence attributes provided in the Support Weld Component Properties dialog box
under the Welding category in the model and the 2D symbols located in the [Symbol
Share]\drawings\catalog\labels\templates\weldsymbols folder.
 For more information on the mapping of three-dimensional weld component properties and
the two-dimensional weld symbol representation, see AWS Standards in Drawings (on page
34) in the Drawings and Reports Reference Data Guide and Weld Properties in the Hangers
and Supports SmartPart Symbols Reference Guide.
 The report template must be located in the same folder as the label template XML.

Drawings and Reports Reference Data Guide 1896


Annotation Modules

Customization
ID
Specifies the report template that defines the label contents.
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
The ignoreError property is unavailable when you define the symbol path label.
For more information, see Symbol Path Label (on page 1474).
toleranceAngle
Denotes the range in degrees on either side of the weld reference line or the perpendicular
of the line. The leader line of a weld label cannot be placed within this range. If you place
the weld label in such a way that the leader line of the label falls within this range, that
leader line automatically shifts until free of the Tolerance Angle range.
toleranceAngleForSingleBevelJWeld
Specifies the permissible range of degrees within which the leader line of the label may fall
when the arrow line points toward certain welds. Single-bevel butt welds, single-bevel butt
welds with broad root faces, and single J butt welds are all affected by this property. In the
case of welds of these types, the arrow line points toward the prepared edge of the plate. If
the arrow line falls outside of the specified range, then the leader line connecting to the
arrow line shifts by 90 degrees minus the value of Tolerance Angle for Single Bevel J
Weld.

SP3DDrawingLabelQuery
Generates nozzle angle content. This content module is dependent on the
DrawingPGNozzleandBrace point generator. For more information, see Nozzle
(DrawingPGNozzleandBrace) (on page 1401).

Customization
None

Structural Widget (StructuralWidgetLabelContent)


Generates structural widgets for members. A widget can be moved along the member.

Usage in Label Template XML


<label>
<content>
<contentModule value="StructuralWidgetLabelContent"/>
</content>
</label>

Customization
None

Drawings and Reports Reference Data Guide 1897


Annotation Modules

Example
Volume in the model used to create a drawing view:

Drawing view with widgets for the members:

Drawings and Reports Reference Data Guide 1898


Annotation Modules

Control Generators
Control generator modules are used in Drawings label templates to generate text boxes for
labels.

Overall Dimensions
By default, dimension control generators use the settings in the Linear_A_HV.xml dimension
template. By using <overallDimension>, you can override Linear_A_HV.xml and select another
template for overall dimensions. In the example below, Piping Plan_Pipes_Horizontal.xml is
used as the dimension template for piping parts:
<dimensionSettings>
<overall>-1</overall>
<overallDimension value="Piping Plan_Pipes_Horizontal">
</dimensionSettings>
For information on the relationship of control generators to other annotation modules, see
Annotation Modules (on page 1728).

Topics
Coordinate (DrawingCoordDimGenerator) .................................... 1899
Default (DrawingDimGenerator) .................................................... 1901
Default (DefaultLabelControlGenerator) ........................................ 1902
Pipe Segments (DrawingPipeSegmentsCG) ................................. 1905

Coordinate (DrawingCoordDimGenerator)
Generates coordinate, angular, and radial dimension content in horizontal and vertical
directions.

Usage in Label or Dimension Template XML


<annotationControlGenerator>
<acgModule>DrawingCoordDimGenerator</acgModule>
<overallDimension>
<horiz>0</horiz>
<vert>0</vert>
<align>0</align>
<range>0</range>
<internalDimension>-1</internalDimension>
<externalDimension>-1</externalDimension>
<rangeOffset>0.0</rangeOffset>
<minimumDimension>0.0</minimumDimension>
<priority>1</priority>
</annotationControlGenerator>

Customization
overallDimension
Displays the name of the separate dimension template containing the content module that
the software uses to determine the appearance of the overall dimension.

Drawings and Reports Reference Data Guide 1899


Annotation Modules

horiz
Places dimensions that measure horizontal distances on the drawing sheet.
vert
Places dimensions that measure vertical distances on the drawing sheet.
align
Aligns dimension chains that have matching projection angles if the alignment does not
overlap another element, such as a label or a model graphic.
range
Displays the Internal Dimension, External Dimension, Range Offset, and Trim Witness
properties.
internalDimension
Places dimensions connecting to points inside a certain inward distance from the matchline,
as specified by Range Offset.
externalDimension
Place dimensions connecting to points outside of a certain inward distance from the
matchline, as specified by Range Offset.
rangeOffset
Determines the inward distance from the matchline for the boundary between objects meant
for internal (inside the view) and external (margin) dimensioning.
minimumDimension
Determines a minimum dimension distance. If a dimension is less than the specified
distance, then the software does not place a dimension in the drawing. If a dimension is less
than the specified distance and is part of a dimension chain, then the software absorbs that
dimension into the larger dimension.
priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.

Drawings and Reports Reference Data Guide 1900


Annotation Modules

Default (DrawingDimGenerator)
Generates linear dimension content in horizontal and vertical directions, as well as radial and
angular dimension content. Used by most dimension templates.
You must place the control point with Show dimension turned on in order to display
the dimension in a Hangers and Support drawing.

Usage in Label or Dimension Template XML


<annotationControlGenerator>
<acgModule>DrawingDimGenerator</acgModule>
<overallDimensionValue>
<horiz>0</horiz>
<vert>0</vert>
<align>0</align>
<range>0</range>
<internalDimension>-1</internalDimension>
<externalDimension>-1</externalDimension>
<rangeOffset>0.0</externalDimension>
<mimimumDimension>0.0</minimumDimension>
<priority>1</priority>
</annotationControlGenerator>

Customization
overallDimension
Displays the name of the separate dimension template containing the content module that
the software uses to determine the appearance of the overall dimension.
horiz
Places dimensions that measure horizontal distances on the drawing sheet.
vert
Places dimensions that measure vertical distances on the drawing sheet.
align
Aligns dimension chains that have matching projection angles if the alignment does not
overlap another element, such as a label or a model graphic.
range
Displays the Internal Dimension, External Dimension, Range Offset, and Trim Witness
properties.
internalDimension
Places dimensions connecting to points inside a certain inward distance from the matchline,
as specified by Range Offset.
externalDimension
Place dimensions connecting to points outside of a certain inward distance from the
matchline, as specified by Range Offset.

Drawings and Reports Reference Data Guide 1901


Annotation Modules

rangeOffset
Determines the inward distance from the matchline for the boundary between objects meant
for internal (inside the view) and external (margin) dimensioning.
minimumDimension
Determines a minimum dimension distance. If a dimension is less than the specified
distance, then the software does not place a dimension in the drawing. If a dimension is less
than the specified distance and is part of a dimension chain, then the software absorbs that
dimension into the larger dimension.
priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.

Default (DefaultLabelControlGenerator)
Currently used by all label templates. Generates a label control for each label that is used to run
the positioning modules.

Usage in Label Template XML


<annotationControlGenerator>
<acgModule>DefaultLabelControlGenerator</acgModule>
<labelLayer>MATCHLINE_LABELS</labelLayer>
<priority>1</priority>
</annotationControlGenerator>

Customization
labelLayer
Allows you to specify the 2D layer on which the software automatically places labels.
The following illustration shows an equipment object with a label placed on the layer
specified in the text box.

Drawings and Reports Reference Data Guide 1902


Annotation Modules

1 - Equipment object
2 - Label
3 - Text Box Properties dialog box specifying the
layer on which the label resides

priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.
The software attempts to place an annotation (such as a label or a dimension) in clear
space as close as possible to that object's Connect Point. Multiple annotations do not
overlap. The Priority property allows you to assign a priority to each annotation, with 1
being the highest priority. The software places the annotation with the highest priority
closest to that object's Connect Point. Additional annotations with lower priorities are
placed further away from the corresponding object's Connect Point.
To define the priority, type a positive integer in the Priority text box.

Drawings and Reports Reference Data Guide 1903


Annotation Modules

1 - Equipment labels placed with Priority set to 1


2 - Structure label placed with Priority set to 2

1 - Equipment label placed with Priority set to 2


2 - Structure label placed with Priority set to 1

Drawings and Reports Reference Data Guide 1904


Annotation Modules

Pipe Segments (DrawingPipeSegmentsCG)


Control generator used for pipe segments. Generates linear dimension content at any angle.

Usage in Label Template XML


<annotationControlGenerator>
<acgModule>DrawingPipeSegmentsCG</acgModule>
</annotationControlGenerator>

Customization
None

Positioning Modules
Positioning modules are used in Drawings label templates to position annotations either in clear
space or in a position absolutely relative to the object being labeled. There are no restrictions on
the number of positioning modules being used with a label or dimension. The positioning module
returns a valid position, an absolute position, or no valid position to the system. The system
consults the next positioning module if there are no valid positions.
For information on the relationship of positioning modules to other annotation modules, see
Annotation Modules (on page 1728).

Topics
Absolute Dimension Offset (DrawingDimAbsolutePos) ................. 1907
Clear Space Horizontal Bottom (DrawingDimHorizBottomCS) ..... 1908
Clear Space Horizontal Top (DrawingDimHorizTopCS) ................ 1909
Absolute Margin (DrawingDimMarginPos) .................................... 1910
Clear Space Vertical Left (DrawingDimVertLeftCS) ...................... 1911
Clear Space Vertical Right (DrawingDimVertRightCS) ................. 1912
Clear Space Radial (DrawingRadial) ............................................. 1913
Clear Space Tiling (CAD Details) (DrawingTileInView) ................. 1914
Absolute Position by 2D Curve (ISDwgAbsolutePositionByCurve2D)
....................................................................................................... 1915
Clear Space Position by 2D Curve (ISDwgPositionByCurve2D) ... 1919
Clear Space Position by 2D Curve at Margin
(ISDwgPositionByCurve2DAtMargin) ............................................ 1927
Absolute Axis Position (SMDwgPositionAxis) ............................... 1935
Absolute Position by 2D Curve at Axis (SMDwgPositionByCurve2DAtAxis)
....................................................................................................... 1936
Clear Space Position Marine Grid Label at Margin
(SMDwgPositionGridLblMarginOnly) ............................................. 1942
Absolute XY Offset (DrawingAbsolute) .......................................... 1947
Clear Space Center Then Above (DrawingCenterThenAbove) ..... 1952
Clear Space Center Then Above Centerline (DrawingCenterThenAboveCL)
....................................................................................................... 1954
Clear Space Center Then Rotate (DrawingCenterThenRotate) .... 1956
Clear Space Radial from Object Center with Clustering (DrawingCentroid)
....................................................................................................... 1959

Drawings and Reports Reference Data Guide 1905


Annotation Modules

Clear Space Coordinate (DrawingCoordLblPosMod) .................... 1967


Absolute Dimension Offset (DrawingDimAbsolutePos) ................. 1973
Clear Space Pipe Segments (DrawingDimPipeSegPos) .............. 1973
Clear Space Grid Horizontal (DrawingGridLblHoriz) ..................... 1973
Clear Space Grid Margin (DrawingGridLblMarginOnly) ................ 1979
Absolute Grid Margin (DrawingGridLblMgnAbsPos) ..................... 1983
Clear Space Grid Vertical (DrawingGridLblVert) ........................... 1985
Clear Space Margin (DrawingMarginOnly) .................................... 1989
Absolute Matchline (DrawingMatchlinePositioning)....................... 1992
Clear Space Quadrant 4 (DrawingQuadFour) ............................... 1993
Clear Space Quadrant 1 (DrawingQuadOne)................................ 1999
Clear Space Quadrant 3 (DrawingQuadThree) ............................. 2005
Clear Space Quadrant 2 (DrawingQuadTwo)................................ 2011
Absolute Radial from View Center (DrawingVectorAbsolute) ....... 2016
Clear Space Clipped (DwgClippedPositioning) ............................. 2016
Clear Space End of Linear Object (DwgLblEndOfSegmentPos)... 2017
Absolute Along Linear Object (DwgLinearAbsPos) ....................... 2020
Clear Space Along Linear Object (DwgLinearPositioning) ............ 2023
Clear Space Margin with Dimensions (DwgMatchlineWithDim) .... 2024
posModulesSet .............................................................................. 2037

Drawings and Reports Reference Data Guide 1906


Annotation Modules

Absolute Dimension Offset (DrawingDimAbsolutePos)


Positions dimensions at an absolute location.

1 - hOffset distance
2 - Dimension

1 - vOffset distance
2 - Dimension

Usage in Label or Dimension Template XML


<posModules>
<posModule value="DrawingDimAbsolutePos">
<hOffset>0.04</hOffset>
<vOffset>0.04</vOffset>
<overallOffset>0</overallOffset>
</posModule>
</posModules>

Customization
hOffset

Drawings and Reports Reference Data Guide 1907


Annotation Modules

Specifies the horizontal distance from the dimension line to the nearest dimension point in
the chain for a vertical dimension. If hOffset is positive, then the dimension line is placed at
the hOffset distance to the right of the rightmost point in the chain. If hOffset is negative,
then the dimension line is placed at the hOffset distance to the left of the leftmost point in
the chain.
vOffset
Specifies the vertical distance from the dimension line to the nearest dimension point in the
chain for a horizontal dimension. If vOffset is positive, then the dimension line is placed at
the vOffset distance above the top point in the chain. If vOffset is negative, then the
dimension line is placed at the vOffset distance below the bottom point in the chain.
overallOffset
Determines the offset for the overall dimension from the dimension chain.

Clear Space Horizontal Bottom (DrawingDimHorizBottomCS)


Places horizontal dimensions below the points that the software is dimensioning on the drawing
sheet.

1 - Minimum offset
2 - Maximum offset

Usage in Label or Dimension Template XML


<posModules>
<horiz>
<posModule value="DrawingDimHorizBottomCS">
<minOffset>0.01</minOffset>
<maxOffset>0.1</maxOffset>
</posModule>
</horiz>
</posModules>

Customization
granularity
Specifies a portion of the height of a dimension value as the basis for the increment used to

Drawings and Reports Reference Data Guide 1908


Annotation Modules

find clear space in which to position the dimension.


minOffset
Defines the minimum distance from a connection point that you can place a dimension.
maxOffset
Defines the maximum distance from a connection point that you can place a dimension.

Clear Space Horizontal Top (DrawingDimHorizTopCS)


Places a horizontal dimension above the points that the software is dimensioning on the drawing
sheet.

1 - Minimum offset
2 - Maximum offset

Usage in Label or Dimension Template XML


<posModules>
<horiz>
<posModule value="DrawingDimHorizTopCS">
<minOffset>0.01</minOffset>
<maxOffset>0.1</maxOffset>
</posModule>
</horiz>
</posModules>

Customization
minOffset
Defines the minimum distance from a connection point that you can place a dimension.
maxOffset
Defines the maximum distance from a connection point that you can place a dimension.

Drawings and Reports Reference Data Guide 1909


Annotation Modules

Absolute Margin (DrawingDimMarginPos)


Places dimensions in the margin outside of the drawing view.

1 - Perimeter offset distance


2 - Dimension

Usage in Label or Dimension Template XML


<posModules>
<posModule value="DrawingDimMarginPos"/>
<overallOffset>0</overallOffset>
<perimeterOffset>0.01</perimeterOffset>
</posModule>
</posModules>

Customization
overallOffset
Determines the offset for the overall dimension from the dimension chain.
perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

Drawings and Reports Reference Data Guide 1910


Annotation Modules

Clear Space Vertical Left (DrawingDimVertLeftCS)


Places vertical dimensions to the left of the points that the software is dimensioning in the
drawing sheet.

1 - Minimum offset
2 - Maximum offset

Usage in Label or Dimension Template XML


<posModules>
<vert>
<posModule value="DrawingDimVertLeftCS">
<minOffset>0.01</minOffset>
<maxOffset>0.1</maxOffset>
</posModule>
</vert>
</posModules>

Customization
granularity
Specifies a portion of the height of a dimension value as the basis for the increment used to
find clear space in which to position the dimension.
minOffset
Defines the minimum distance from a connection point that you can place a dimension.
maxOffset
Defines the maximum distance from a connection point that you can place a dimension.

Drawings and Reports Reference Data Guide 1911


Annotation Modules

Clear Space Vertical Right (DrawingDimVertRightCS)


Positions vertical dimensions to the right of the points that the software is dimensioning on the
drawing sheet.

1 - Minimum offset
2 - Maximum offset

Usage in Label or Dimension Template XML


<posModules>
<vert>
<posModule value="DrawingDimVertRightCS">
<minOffset>0.01</minOffset>
<maxOffset>0.1</maxOffset>
</posModule>
</vert>
</posModules>

Customization
granularity
Specifies a portion of the height of a dimension value as the basis for the increment used to
find clear space in which to position the dimension.
minOffset
Defines the minimum distance from a connection point that you can place a dimension.
maxOffset
Defines the maximum distance from a connection point that you can place a dimension.

Drawings and Reports Reference Data Guide 1912


Annotation Modules

Clear Space Radial (DrawingRadial)


Automatically searches points for labeling using radiating concentric circles.
The following image shows the possible positioning points generated radially from the connect
point of the labeled object. In this image, the maxOffset property is illustrated.

1 - Maximum Offset

Usage in Label Template XML


<posModule value="DrawingRadial"/>
<granularity>1</granularity>
<minOffset>0.015</minOffset>
<maxOffset>0.060</maxOffset>
</posModule>

Customization
granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
maxOffset
Defines the maximum distance from a connection point that you can place a label.
minOffset
Defines the minimum distance from a connection point that you can place a label.

Drawings and Reports Reference Data Guide 1913


Annotation Modules

Clear Space Tiling (CAD Details) (DrawingTileInView)


Permits an additional spacing option when labels in the view are tiled. This spacing option
recognizes the amount of space between each label and positions labels accordingly.

Usage in Label Template XML


<posModule>
<posModule value="DrawingTileInView">
<spacing>0.01</spacing>
</posModule>
</posModules>

Customization
spacing
Specifies the vertical and horizontal distances between CAD Details graphics placed on the
drawing sheet.
The following graphic shows the Spacing property with 0.01 m specified between two CAD
Details graphics.

1 - End plate
2 - Shoe base

The following graphic shows the Spacing property with 0.02 m specified between two CAD
Details graphics.

Drawings and Reports Reference Data Guide 1914


Annotation Modules

1 - End plate
2 - Shoe base
3 - Shoe vertical part

The number of CAD Details graphics that can fit on the drawing sheet depends on the
measurements that you specify for this property. Specifying a greater distance between
CAD Details graphics results in fewer graphics on the drawing sheet, while specifying a
smaller distance results in a greater number of graphics on the drawing sheet.

Absolute Position by 2D Curve


(ISDwgAbsolutePositionByCurve2D)
Places a label at an absolute position along the 2D curve. This is similar to the Clear Space
Position by 2D Curve (ISDwgPositionByCurve2D) (on page 1203) positioning module, but does
not use clear space. The absolute position is the point created by the point generator used in the
label template. The orientation of the label is set from the point, relative to the 2D curve, and is
controlled by the parameters.
This module can be used as the last positioning module in a label template. It will
position the label when other clear space positioning modules cannot find a location.

Usage in Label Template XML


<label>
<posSettings>
<posModulesSets>
<posModulesSet>
<connectPoint>4</connectPoint>
<positioningPoint>4</positioningPoint>
<posModules>
<posModule value="ISDwgAbsolutePositionByCurve2D">
<angle>0</angle>
<anchor>1</anchor>
<hOffset>0.0</hOffset>

Drawings and Reports Reference Data Guide 1915


Annotation Modules

<vOffset>0.0</vOffset>
</posModule>
</posModules>
</posModulesSet>
</posModulesSets>
</posSettings>
<\label>

Customization
angle
Orientation of the label.

XML value

Tangent 0
Tangent to a
curve

Normal Out 1
Along
outward
normal

Normal In 2
Along
inward
normal

Horizontal 3

Vertical 4

Default 5
Orientation

Drawings and Reports Reference Data Guide 1916


Annotation Modules

Uses the orientation from the content module

anchor
The point on the label used for positioning.

XML
value
Treat as Label 0

Uses a key point on the bounding box of the label, as specified by


the connect point property in posModulesSet (on page 2037).

Treat as Symbol 1

Uses the origin of the symbol.

Use Connect Point 2


Similar to 0 (Treat as Label) but uses a key point specified by the
connect point property defined directly in this module.

connectPoint
Specifies the position of the label relative to the key point on the text bounding box and used
with the anchor property. The default value is 4 (Middle Middle).

Key Points

0 Top Left

Drawings and Reports Reference Data Guide 1917


Annotation Modules

1 Top Middle

2 Top Right

3 Middle Left

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

 Use the connect point in this module in the same way that you use the positioning point
in the posModuleSet positioning module.
 You can use the value of the connect point defined in the posModulesSet positioning
module by using 0 (Treat as Label) for anchor or define the value directly in this module
by using 2 (Use Connect Point) for anchor.
 positioningPoint in the posModulesSet positioning module is not used by this module
even when you have defined that parameter.
hOffset
Horizontal distance of the label from the positioning point. This value is measured in meters.
The default value is 0.00.
vOffset
Vertical distance of the label from the positioning point. The software measures this value in
meters. The default value is 0.00.
This module also uses the minFactor and maxFactor parameters. For more
information, see Label Templates Overview (on page 786).

Examples
For the labels in the following example, Angle is 0 and Anchor is 0 (using connectPoint 4 in
posModulesSet)

The location of the profile thickness symbols change in the following examples based on the
parameters.

Drawings and Reports Reference Data Guide 1918


Annotation Modules

hOffset is 0
vOffset is 0
angle is 0 (Tangent)

hOffset is 0.01
vOffset is 0.03
angle is 0 (Tangent)

hOffset is 0
vOffset is 0
angle is 3 (Horizontal)

Although a content module creates the annotation output, this example shows how
this module affects the output.

Clear Space Position by 2D Curve


(ISDwgPositionByCurve2D)
Positions a label along the 2D curve, using clear space to avoid overlap with other labels. The
orientation of the label is set from the point, relative to the 2D curve, and is controlled by the
angle parameter.
The 2D curve of the 3D object must have one or more curves.

Usage in Label Template XML


<label>
<posSettings>
<posModulesSets>
<posModulesSet>
<connectPoint>4</connectPoint>
<positioningPoint>4</positioningPoint>
<posModules>
<posModule value="ISDwgPositionByCurve2D">
<startCurveRatio>0.0</startCurveRatio>
<endCurveRatio>1.0</endCurveRatio>
<angle>0</angle>
<anchor>1</anchor>
<searchMode>0</searchMode>
<hOffset>0.0</hOffset>
<vOffset>0.0</vOffset>
<granularity>1</granularity>

Drawings and Reports Reference Data Guide 1919


Annotation Modules

<priority>1</priority>
<whiteObj>LAYER_NAME</whiteObj>
</posModule>
</posModules>
</posModulesSet>
</posModulesSets>
</posSettings>
<\label>

Customization
startCurveRatio
Specifies the start point on the 2D curve. Specify the value as a ratio along the length of the
curve. The ratio must be between 0.0 and 1.0.

The software performs the search for clear space positioning between the start point and the
end point. The end curve ratio must be greater than the start curve ratio.
endCurveRatio
Specifies the end point on the 2D curve. The software defines this value as a ratio along the
length of the curve. The ratio must be between 0.0 and 1.0.

The software searches for clear space positioning between the start point and the end point.
The end curve ratio must be greater than the start curve ratio.
angle
Orientation of the label.

XML value

Tangent 0
Tangent to a
curve

Normal Out 1
Along
outward
normal

Drawings and Reports Reference Data Guide 1920


Annotation Modules

Normal In 2
Along
inward
normal

Horizontal 3

Vertical 4

Default 5
Orientation

Uses the orientation from the content module

anchor
The point on the label used for positioning.

XML
value
Treat as Label 0

Uses a key point on the bounding box of the label, as specified by


the connect point property in posModulesSet (on page 2037).

Treat as Symbol 1

Drawings and Reports Reference Data Guide 1921


Annotation Modules

Uses the origin of the symbol.

Use Connect Point 2


Similar to 0 (Treat as Label) but uses a key point specified by the
connect point property defined directly in this module.

connectPoint
Specifies the position of the label relative to the key point on the text bounding box and used
with the anchor property. The default value is 4 (Middle Middle).

Key Points

0 Top Left

1 Top Middle

2 Top Right

3 Middle Left

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

 Use the connect point in this module in the same way that you use the positioning point
in the posModuleSet positioning module.
 You can use the value of the connect point defined in the posModulesSet positioning
module by using 0 (Treat as Label) for anchor or define the value directly in this module
by using 2 (Use Connect Point) for anchor.
 positioningPoint in the posModulesSet positioning module is not used by this module
even when you have defined that parameter.
searchMode
Defines the starting point and search method for the clear space search along the 2D curve.

Drawings and Reports Reference Data Guide 1922


Annotation Modules

XML value

From Center 0

Starts from the center of the 2D curve. The software tries


to place the label to the left or right of the center of the
curve.

Low To High 1

Starts from the start curve ratio location. The system tries
to place the label in clear space in a search toward the
end curve ratio location.

High To Low 2

Starts from the end curve ratio location. The software


tries to place the label in clear space in a search toward
the start curve ratio location.

hOffset
Horizontal distance of the label from the positioning point. This value is measured in meters.
The default value is 0.00.
vOffset
Vertical distance of the label from the positioning point. The software measures this value in
meters. The default value is 0.00.
granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.

Drawings and Reports Reference Data Guide 1923


Annotation Modules

 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

priority
Determines the order in which the software places an annotation based on available clear
space and proximity to other annotations.

Drawings and Reports Reference Data Guide 1924


Annotation Modules

1 - Equipment label placed using the Priority property


2 - Additional Structure label placed using the Priority property
3 - New label placement with Structure at Priority 1 and
Equipment at Priority 2

whiteObj
Allows you to specify one or more 2D layers in the drawing to serve as white object layers
for a label placed in clear space. Graphical objects set on these layers are rendered invisible
to this label, allowing placement of the label on top of these objects.

Drawings and Reports Reference Data Guide 1925


Annotation Modules

1 - Pipe within a White Object Layer


2 - Equipment label overlapping pipes

If this filter is set to "*" during label placement, then the system ignores all objects that
are not labels or leaders.

Example
Angle is 0, anchor is 0 (using connectPoint 4 in posModulesSet), startCurveRatio is 0.0,
endCurveRatio is 1.0, searchMode is 0

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1926


Annotation Modules

Clear Space Position by 2D Curve at Margin


(ISDwgPositionByCurve2DAtMargin)
Positions a label for a 2D curve at the view margin relative to the position of the curve.
The 2D geometry of the 3D object must have one or more curves.

Usage in Label Template XML


<posSettings>
<posModulesSets>
<posModulesSet>
<connectPoint>4</connectPoint>
<positioningPoint>4</positioningPoint>
<posModules>
<posModule value="ISDwgPositionByCurve2DAtMargin">
<top>1</top>
<bottom>1</bottom>
<left>1</left>
<right>1</right>
<angle>3</angle>
<anchor>0</anchor>
<connectPoint>3</connectPoint>
<maxOffset>0.05</maxOffset>
<minOffset>0.01</minOffset>
<marginDefinition>1</marginDefinition>
<useClearSpace>1</useClearSpace>
<perimeterOffset>0.01</perimeterOffset>
<granularity>1</granularity>
</posModule>
</posModules>
</posModulesSet>
</posModulesSets>
</posSettings>

Customization
top, bottom, left, right
Sides of the view that you can use to locate the curve label. You can only locate labels in
the margins of the specified sides. For each side, select to allow a label in the margin (the
.xml value is 1) or clear if no label in the margin is needed (the .xml value is 0).

Drawings and Reports Reference Data Guide 1927


Annotation Modules

1 - Top
2 - Bottom
3 - Left
4 - Right

angle
Orientation of the label.

XML value

Tangent 0
Tangent to a
curve

Normal Out 1
Along
outward
normal

Normal In 2
Along
inward
normal

Horizontal 3

Vertical 4

Drawings and Reports Reference Data Guide 1928


Annotation Modules

Default 5
Orientation

Uses the orientation from the content module

anchor
The point on the label used for positioning.

XML
value
Treat as Label 0

Uses a key point on the bounding box of the label, as specified by


the connect point property in posModulesSet (on page 2037).

Treat as Symbol 1

Uses the origin of the symbol.

Use Connect Point 2


Similar to 0 (Treat as Label) but uses a key point specified by the
connect point property defined directly in this module.

connectPoint
Specifies the position of the label relative to the key point on the text bounding box and used
with the anchor property. The default value is 4 (Middle Middle).

Drawings and Reports Reference Data Guide 1929


Annotation Modules

Key Points

0 Top Left

1 Top Middle

2 Top Right

3 Middle Left

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

 Use the connect point in this module in the same way that you use the positioning point
in the posModuleSet positioning module.
 You can use the value of the connect point defined in the posModulesSet positioning
module by using 0 (Treat as Label) for anchor or define the value directly in this module
by using 2 (Use Connect Point) for anchor.
 positioningPoint in the posModulesSet positioning module is not used by this module
even when you have defined that parameter.
marginDefinition
Specifies the relationship of the grid axes to the drawing view for measuring the margin
offset of the axes.

XML
value

At View Frame 0
(default value)
Measures the margin
offset for each axis from
the edges of the view
SmartFrame, shown as
dashed lines in the
example.

Drawings and Reports Reference Data Guide 1930


Annotation Modules

At Drawing Area 1
Measures the margin
offset for each axis from
the edges of the drawing
area, shown as solid lines
in the example.

If you set the frame behavior to Frame resizes to drawing area, then the view frame and
the drawing area are the same size, and both values provide the same result, as shown in
the following example.

For more information, see Area Tab (Edit Ruleset View Style Dialog Box) (on page 130) in
the Drawings and Reports Reference Data Guide.
maxOffset
Defines the maximum distance from a connection point that you can place a label.

1 – Perimeter Offset
2 – Margin
3 – Maximum Offset
4 – View border
5 – Label

minOffset

Drawings and Reports Reference Data Guide 1931


Annotation Modules

Defines the minimum distance from a connection point that you can place a label.

1 - Minimum Offset
2 - Maximum Offset in the X direction
3 - Maximum Offset in the Y direction

useClearSpace
Specifies whether the software uses clear space to avoid overlap with other labels. Use 0 to
ignore clear space or 1 to use clear space.
perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

Drawings and Reports Reference Data Guide 1932


Annotation Modules

1 - Perimeter offset distance


2 - Dimension

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

Drawings and Reports Reference Data Guide 1933


Annotation Modules

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Example
The label is placed in the view margin instead of on the profile geometry.

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1934


Annotation Modules

Absolute Axis Position (SMDwgPositionAxis)


Determines the absolute position of the axis label and positions the reference plane axis line.
This module is used with the Ruler Axis (SMRulerAxisSymbolContent) (on page 1455) content
module.

Usage in Label Template XML


<posSettings>
<posModulesSets>
<posModulesSet>
<posModules>
<posModule value="SMDwgPositionAxis" />
</posModules>
</posModulesSet>
</posModulesSets>
</posSettings>

Customization
None

Example
The AddOn - Grid Axis and Lines view style adds visible coordinate system rulers, axes, and
grid lines to a rule set view style. SMDwgPositionAxis positions the axis label and line.

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1935


Annotation Modules

Absolute Position by 2D Curve at Axis


(SMDwgPositionByCurve2DAtAxis)
Positions a label in clear space for a 2D curve based on a related reference plane. For example,
if a non-target plate is coplanar with a reference plane, the label for that plate can be positioned
with respect to the reference plane instead of the 2D curve for the plate.

 This module is used with the Group by Axis (SMDwgGroupByAxisGA) (on page 1307)
geometric analyzer.
 The 2D geometry of the 3D object must have one or more curves.
 If no reference plane is identified for an object, then no label is positioned by this module.

Drawings and Reports Reference Data Guide 1936


Annotation Modules

Usage in Label Template XML


<posSettings>
<posModulesSets>
<posModulesSet>
<connectPoint>4</connectPoint>
<positioningPoint>4</positioningPoint>
<posModules>
<posModule value="SMDwgPositionByCurve2DAtAxis">
<axisInfo>Grid Axis</axisInfo>
<top>
<offsetX>0.0</offsetX>
<offsetY>0.01</offsetY>
<angle>4</angle>
<anchor>0</anchor>
<connectPoint>3</connectPoint>
</top>
<bottom>
<offsetX>0.0</offsetX>
<offsetY>0.01</offsetY>
<angle>4</angle>
<anchor>0</anchor>
<connectPoint>3</connectPoint>
</bottom>
<left>
<offsetX>0.01</offsetX>
<offsetY>0.0</offsetY>
<angle>3</angle>
<anchor>0</anchor>
<connectPoint>5</connectPoint>
</left>
<right>
<offsetX>0.01</offsetX>
<offsetY>0.0</offsetY>
<angle>3</angle>
<anchor>0</anchor>
<connectPoint>3</connectPoint>
</right>
</posModule>
</posModules>
</posModulesSet>
</posModulesSets>
</posSettings>

Customization
axisinfo
Name of the label template .xml file that creates the reference planes. The delivered files
are Grid Axis.xml and Grid Axis_No Spacing.xml.
top, bottom, left, right
Sides of the curve that can be used to locate the label with respect to an axis.

Drawings and Reports Reference Data Guide 1937


Annotation Modules

1 - Top
2 - Bottom
3 - Left
4 - Right

In the example below, thickness markings are placed on the left axis for the lines in red
representing profiles.

offsetX, offsetY
Offset distance of the label from the 2D axis. This property is used in combination with the
defined side of the curve (top, bottom, left, or right) that can be used to locate the label.

Drawings and Reports Reference Data Guide 1938


Annotation Modules

1 - Offset from X axis


2 - Offset from Y axis

angle
Orientation of the label for the defined side (top, bottom, left, or right).

XML
valu
e

Horizontal 3

Vertical 4

anchor
The point on the label used for positioning.

XML
value
Treat as Label 0

Uses a key point on the bounding box of the label, as specified by


the connect point property in posModulesSet (on page 2037).

Drawings and Reports Reference Data Guide 1939


Annotation Modules

Treat as Symbol 1

Uses the origin of the symbol.

Use Connect Point 2


Similar to 0 (Treat as Label) but uses a key point specified by the
connect point property defined directly in this module.

connectPoint
Specifies the position of the label relative to the key point on the text bounding box and used
with the anchor property. The default value is 4 (Middle Middle).

Key Points

0 Top Left

1 Top Middle

2 Top Right

3 Middle Left

4 Middle Middle

5 Middle Right

6 Bottom Left

7 Bottom Middle

8 Bottom Right

 Use the connect point in this module in the same way that you use the positioning point
in the posModuleSet positioning module.
 You can use the value of the connect point defined in the posModulesSet positioning
module by using 0 (Treat as Label) for anchor or define the value directly in this module
by using 2 (Use Connect Point) for anchor.

Drawings and Reports Reference Data Guide 1940


Annotation Modules

 positioningPoint in the posModulesSet positioning module is not used by this module


even when you have defined that parameter.

Example
The thickness symbol is placed on the reference plane instead of the profile geometry.

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 1941


Annotation Modules

Clear Space Position Marine Grid Label at Margin


(SMDwgPositionGridLblMarginOnly)
Determines both the clear space position of grid labels that are placed in the margin as well as
the end of the object relative to which the software should place the label.
Labels that are placed outside of the matchline and in clear space use the breakline settings as
well as the perimeterOffset setting. The SMDwgPositionGridLblMarginOnly module then
places grid labels at a perimeterOffset value in the margin. The orientation of the margin is
determined by the orientation tag, as in the .xml example below.
The Absolute Grid Margin (DrawingGridLblMgnAbsPos) (on page 1118) module must follow this
positioning module in the <posModules> section. For more information, see Absolute Grid
Margin (DrawingGridLblMgnAbsPos) (on page 1118).

Usage in Label Template XML


<label>
<posModules>
<posModule value="SMDwgPositionGridLblMarginOnly"/>
<orientation>2</orientation>
<granularity>1</granularity>
<maxOffset>0.05</maxOffset>
<minOffset>0.01</minOffset>
<perimeterOffset>0.01</perimeterOffset>
</posModule>
<posModule value="DrawingGridLblMgnAbsPos"/>
<orientation>2</orientation>
</posModule>
</posModules>
</label>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Use 1 to place the label in the top margin, 2 to place the label in the bottom margin, 3 to
place the label in the left margin, or 4 to place the label in the right margin.
granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

Drawings and Reports Reference Data Guide 1942


Annotation Modules

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

maxOffset
Defines the maximum distance from a connection point that you can place a label.

1 – Perimeter Offset
2 – Margin
3 – Maximum Offset
4 – View border
5 – Label

Drawings and Reports Reference Data Guide 1943


Annotation Modules

minOffset
Defines the minimum distance from a connection point that you can place a label.

1 - Minimum Offset
2 - Maximum Offset in the X direction
3 - Maximum Offset in the Y direction

Drawings and Reports Reference Data Guide 1944


Annotation Modules

perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

1 - Perimeter offset distance


2 - Dimension

Examples

1:
orientation is 1 (up)
perimeterOffset is 0.001
maxOffset is 0.005
2:
orientation is 3 (left)
perimeterOffset is 0.005
maxOffset is 0.005

Drawings and Reports Reference Data Guide 1945


Annotation Modules

1:
orientation is 1 (up)
perimeterOffset is 0.01
maxOffset is 0.01
2:
orientation is 4 (right)
perimeterOffset is 0.005
maxOffset is 0.005

Drawings and Reports Reference Data Guide 1946


Annotation Modules

Absolute XY Offset (DrawingAbsolute)


Positions labels at an absolute horizontal, vertical, or angular position, depending on view
direction.

Usage in Label Template XML


<posModules>
<posModule value="DrawingAbsolute">
<hOffset>.005</hOffset>
<vOffset>-.005</vOffset>
<angle>1</angle>
<connectPoint>4</connectPoint>
</posModule>
</posModules>

Customization
hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1947


Annotation Modules

angle
Controls the vertical, horizontal, or absolute angle of a label.
If you are using the Absolute XY Offset (DrawingAbsolute) positioning module, then type a
floating point number as the value. You must type a number greater than negative pi/2 and
less than or equal to positive pi/2. Additionally, you must set the value in radians, not
degrees. The default value when you use this module is 0.0.
The following example demonstrates an Absolute setting.

1 - East label
2 - North Label

If you use the Clear Space Margin with Dimensions (DwgMatchlineWithDim) positioning
module, then you can specify 0 to set a Horizontal angle or 1 to specify a Vertical angle.
The default value when you use this module is 1.

Drawings and Reports Reference Data Guide 1948


Annotation Modules

The following two examples demonstrate horizontally and vertically placed labels.

1 - Horizontally placed label

Drawings and Reports Reference Data Guide 1949


Annotation Modules

1 - Vertically placed label

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point. The range of options is indicated by colored dots in the following
graphic. The connectPoint is placed at the TopRight.

Drawings and Reports Reference Data Guide 1950


Annotation Modules

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to manually edit the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1951


Annotation Modules

Clear Space Center Then Above (DrawingCenterThenAbove)


Places a label either in the center of the linear segment or above the linear segment. The
orientation of the label and the definition of "above" is determined by the direction of the linear
segment. DwgLinearAbsPos or DrawingMarginOnly should always follow this module in the
posModules section of the XML.

Usage in Label Template XML


<label>
<posSettings>
<posModulesSets>
<posModulesSet>
<PosModules>
<posModule value="DrawingCenterThenAbove">
<granularity>1</granularity>
<labelOffset>0.04</labelOffset>
</posModule>
<posModule value="DwgLinearAbsPos">
<percentageOffset>0.50</percentageOffset>
<offsetFromMember>0.01</offsetFromMember>
</posModule>
</PosModules>
</posModulesSet>
</posModulesSets>
</posSettings>
</label>

Customization
granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

Drawings and Reports Reference Data Guide 1952


Annotation Modules

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1953


Annotation Modules

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed. Use the Label Offset property when
you want to place the label within quadrants around the point. The point generator
calculates the point. The software starts from the point location and looks outward to the
limit of the Label Offset distance, and then begins looking for clear space within which to
place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.

Clear Space Center Then Above Centerline


(DrawingCenterThenAboveCL)
Places a label either above or on center of center line on a linear segment. "Above" is
determined by the direction of the line. If no clear space is found, the label is placed on the
longest visible segment of the center line of the linear segment. Used by Piping
Plan_FlowArrow_Longest Segment.xml.

Customization
granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.

Drawings and Reports Reference Data Guide 1954


Annotation Modules

 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1955


Annotation Modules

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed. Use the Label Offset property when
you want to place the label within quadrants around the point. The point generator
calculates the point. The software starts from the point location and looks outward to the
limit of the Label Offset distance, and then begins looking for clear space within which to
place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.

Clear Space Center Then Rotate (DrawingCenterThenRotate)


Positions a label in the center of the range of an object and rotates the label 90 degrees if there
is not enough clear space in the first position.

Usage in Label Template XML


<posModules>
<posModule value="DrawingCenterThenRotate">
<hOffset>0</hOffset>
<vOffset>0</vOffset>
<connectPoint>4</connectPoint>
</posModule>
</posModules>

Customization
hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.

Drawings and Reports Reference Data Guide 1956


Annotation Modules

The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1957


Annotation Modules

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point.
The range of options is indicated by colored dots in the following graphic. The connectPoint
is placed at the TopRight point.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to manually edit the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1958


Annotation Modules

Clear Space Radial from Object Center with Clustering


(DrawingCentroid)
Positions labels based on the white space located from the center of the related object and
vector. If objects have the same relation object and vector, they are grouped together. This
positioning module must be used with the Nozzle (DrawingPGNozzleandBrace) (on page 1401)
point generator module.

Usage in Label Template XML


<posModules>
<posModule value="DrawingCentroid">
<rOffset>0.0</rOffset>
<labelType>0</labelType>
<rotation>0</rotation>
<fromMatchline>0</fromMatchline>
<granularity>1</granularity>
<labelOffset>0.04</labelOffset>
</posModule>
</posModules>

Customization
rOffset
Determines the distance between a nozzle port and the label annotating the port.

Drawings and Reports Reference Data Guide 1959


Annotation Modules

labelType

 Specifies whether the label is a Nozzle, Top of Equipment/Bottom of Equipment, or


Angle label.

Drawings and Reports Reference Data Guide 1960


Annotation Modules

1 - Nozzle
2 - Top of Equipment/Bottom of Equipment
3 - Angle

 Type 0 to place a Nozzle label.


 Type 1 to place a TOP or BTM label.
 Type 2 to place an Angle label.

Drawings and Reports Reference Data Guide 1961


Annotation Modules

rotation
Determines the angular orientation of the labels. The labels can be aligned horizontally,
irrespective of the orientation of the nozzle orientation angle, or the labels can be rotated to
match the nozzle orientation angle.
Type -1 to rotate all labels.

Drawings and Reports Reference Data Guide 1962


Annotation Modules

Type 0 to force horizontal label angles.

Drawings and Reports Reference Data Guide 1963


Annotation Modules

fromMatchline
Determines the inside or outside placement of a label with respect to the matchline
boundary. Type -1 to position the labels outside of the matchline boundaries.

1 - Matchline

Drawings and Reports Reference Data Guide 1964


Annotation Modules

Type 0 to position the labels inside of the matchline boundaries.

1 - Matchline

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

Drawings and Reports Reference Data Guide 1965


Annotation Modules

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1966


Annotation Modules

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed. Use the Label Offset property when
you want to place the label within quadrants around the point. The point generator
calculates the point. The software starts from the point location and looks outward to the
limit of the Label Offset distance, and then begins looking for clear space within which to
place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.

Clear Space Coordinate (DrawingCoordLblPosMod)


Orients coordinate labels based on the "up" direction of the drawing view. DrawingAbsolute or
DrawingMarginOnly should always follow this module in the posModules section of the XML.
This positioning module supports plan views only.

Usage in Label Template XML


<posModules>
<posModule value="DrawingCoordLblPosMod">
<orientation>1</orientation>
<granularity>1</granularity>
<positioningPoint>4</positioningPoint>
<labelOffset>0.04</labeloffset>
</posModule>
<posModule value="DrawingAbsolute">
<hOffset>-0.003</hOffset>
<vOffset>0.02</vOffset>
<angle>1.570796</angle>
</posModule>
</posModules>

Drawings and Reports Reference Data Guide 1967


Annotation Modules

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Drawings and Reports Reference Data Guide 1968


Annotation Modules

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

Drawings and Reports Reference Data Guide 1969


Annotation Modules

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1970


Annotation Modules

positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.
In the following image, the Positioning Point is shown placed in the TopRight position, and
the Connect Point is shown placed in the MiddleRight position.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.

Drawings and Reports Reference Data Guide 1971


Annotation Modules

 Type 3 to place the point at the middle left.


 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.
labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.

Drawings and Reports Reference Data Guide 1972


Annotation Modules

Absolute Dimension Offset (DrawingDimAbsolutePos)


Positions dimensions at an absolute location.

Usage in Label Template XML


<posModules>
<posModule value="DrawingDimAbsolutePos">
<hOffset>0</hOffset>
<vOffset>0</vOffset>
</posModule>
</posModules>

Customization
hOffset, vOffset

Clear Space Pipe Segments (DrawingDimPipeSegPos)


Positions dimensions at any angle inside the view.

Usage in Label Template XML


<posModules>
<posModule value="DrawingDimPipeSegPos">
<minOffset>0</minOffset>
<maxOffset>0</maxOffset>
</posModule>
</posModules>

Customization
minOffset, maxOffset

Clear Space Grid Horizontal (DrawingGridLblHoriz)


Positions horizontal grid labels to the left or right of a drawing view. The Orientation tag under
labelSettings determines whether the labels are positioned on the left or right side. A value of 3
positions the labels on the left side, while a value of 4 positions the labels on the right side.
DrawingGridLblMarginOnly and DrawingGridLblMgnAbsPos must follow this positioning module
in the posModules section.

Drawings and Reports Reference Data Guide 1973


Annotation Modules

Usage in Label Template XML


<label>
<labelSettings>
<orientation>4</orientation>
<granularity>1</granularity>
<maxOffset>0.05</maxOffset>
<minOffset>0.01</minOffset>
</labelSettings>
...
<posModules>
<posModule value="DrawingGridLblHoriz"/>
<posModule value="DrawingGridLblMarginOnly"/>
<posModule value="DrawingGridLblMgnAbsPos"/>
</posModules>
</label>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

Drawings and Reports Reference Data Guide 1974


Annotation Modules

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.

Drawings and Reports Reference Data Guide 1975


Annotation Modules

 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1976


Annotation Modules

maxOffset
Defines the maximum distance from a connection point that you can place a label.

1 – Maximum Offset
2 – Perimeter Offset

Drawings and Reports Reference Data Guide 1977


Annotation Modules

minOffset
Defines the minimum distance from a connection point that you can place a label.

1 - Maximum Offset in X direction


2 - Maximum Offset in Y direction
3 - Minimum Offset

Drawings and Reports Reference Data Guide 1978


Annotation Modules

Clear Space Grid Margin (DrawingGridLblMarginOnly)


Positions grid labels that are placed in the margin. Places grid labels at a perimeter offset value
in the margin determined by the orientation tag. The perimeter is defined by the drawing volume.
Absolute Grid Margin (DrawingGridLblMgnAbsPos) (on page 1118) must follow this positioning
module in the posModules section.

Usage in Label Template XML


<label>
<posModules>
<posModule value="DrawingGridLblMarginOnly"/>
<orientation>2</orientation>
<granularity>1</granularity>
<maxOffset>0.05</maxOffset>
<perimeterOffset>0.01</perimeterOffset>
</posModule>
<posModule value="DrawingGridLblMgnAbsPos"/>
<orientation>2</orientation>
</posModule>
</posModules>
</label>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Use 1 to place the label in the top margin, 2 to place the label in the bottom margin, 3 to
place the label in the left margin, or 4 to place the label in the right margin.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Drawings and Reports Reference Data Guide 1979


Annotation Modules

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Drawings and Reports Reference Data Guide 1980


Annotation Modules

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1981


Annotation Modules

maxOffset
Defines the maximum distance from a connection point that you can place a label.

1 – Perimeter Offset
2 – Margin
3 – Maximum Offset
4 – View border
5 – Label

perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

1 - Perimeter offset distance


2 - Dimension

Drawings and Reports Reference Data Guide 1982


Annotation Modules

Absolute Grid Margin (DrawingGridLblMgnAbsPos)


Places a grid label at an absolute position in the margin determined by the orientation tag in the
XML file. A value of 1 places the label in the top margin, while 2 places a label in the bottom
margin, 3 places the label in the left margin, and 4 places the label in the right margin.

Usage in Label Template XML


<posModules>
<posModule value="DrawingGridLblMgnAbsPos">
<orientation>2</orientation>
<perimeterOffset>0.01</perimeterOffset>
</posModule>
</posModules>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

Drawings and Reports Reference Data Guide 1983


Annotation Modules

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

Drawings and Reports Reference Data Guide 1984


Annotation Modules

Clear Space Grid Vertical (DrawingGridLblVert)


Positions vertical grid labels above or below a drawing view. The Orientation tag under
labelSettings determines whether the labels are positioned above or below the view. A value of
1 positions the labels above the drawing view, while a value of 2 positions the label below the
drawing view. DrawingGridLblMarginOnly and DrawingGridLblMgnAbsPos must follow this
positioning module in the posModules section.

Usage in Label Template XML


<label>
<labelSettings>
<orientation>2</orientation>
<maxOffset>0.05</maxOffset>
<minOffset>0.01</minOffset>
</labelSettings>
...
<posModules>
<posModule value="DrawingGridLblVert"/>
<granularity>1</granularity>
<posModule value="DrawingGridLblMarginOnly"/>
<posModule value="DrawingGridLblMgnAbsPos"/>
</posModules>
</label>

Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Drawings and Reports Reference Data Guide 1985


Annotation Modules

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Drawings and Reports Reference Data Guide 1986


Annotation Modules

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1987


Annotation Modules

maxOffset
Defines the maximum distance from a connection point that you can place a label.

1 – Maximum Offset
2 – Perimeter Offset

Drawings and Reports Reference Data Guide 1988


Annotation Modules

minOffset
Defines the minimum distance from a connection point that you can place a label.

1 - Maximum Offset in X direction


2 - Maximum Offset in Y direction
3 - Minimum Offset

Clear Space Margin (DrawingMarginOnly)


Name: DrawingMarginOnly
Annotation Output: Label
Description: Positions labels in the margin. If the object is clipped, the label is positioned in the
same margin as the clipped object. If the object is linear, the label is positioned in the margin
that has the same linear direction.
Usage in Label Template XML
<posModules>
<posModule value="DrawingMarginOnly">
<orientation>1</orientation>
<perimeterOffset>0.01</perimeterOffset>
</posModule>
</posModules>
Customization
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.

Drawings and Reports Reference Data Guide 1989


Annotation Modules

Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Drawings and Reports Reference Data Guide 1990


Annotation Modules

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

Drawings and Reports Reference Data Guide 1991


Annotation Modules

1 - Perimeter offset distance


2 - Dimension

Absolute Matchline (DrawingMatchlinePositioning)


Positions matchline labels in the margin.

Usage in Label Template XML


<posModules>
<posModule value="DrawingMatchlinePositioning"/>
</posModules>

Customization
None
See Also
Positioning Module (Properties tab) (on page 1611)

Drawings and Reports Reference Data Guide 1992


Annotation Modules

Clear Space Quadrant 4 (DrawingQuadFour)


Positions label in the fourth quadrant (upper-left) based on the positioning point. This module is
used with DrawingQuadOne, DrawingQuadTwo, and DrawingQuadThree. These modules do
not have to follow a certain order.

Usage in Label Template XML


<posModules>
<posModule value="DrawingQuadOne"/>
<posModule value="DrawingQuadTwo"/>
<posModule value="DrawingQuadThree"/>
<posModule value="DrawingQuadFour"/>
<positioningPoint>4</positioningPoint>
<hOffset>0.02</hOffset>
<vOffset>0.02</vOffset>
<connectPoint>4</connectPoint>
<granularity>1</granularity>
<labelOffset>0.04</labelOffset>
</posModules>

Customization
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.

Drawings and Reports Reference Data Guide 1993


Annotation Modules

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.

Drawings and Reports Reference Data Guide 1994


Annotation Modules

hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 1995


Annotation Modules

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point.
The range of options is indicated by colored dots in the following graphic. The connectPoint
is placed at the TopRight point.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to manually edit the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 1996


Annotation Modules

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 1997


Annotation Modules

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.
Additional customization is available in the labelSettings section of the XML file. For
more information, see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 1998


Annotation Modules

Clear Space Quadrant 1 (DrawingQuadOne)


Positions labels in the first quadrant (upper-right) based on the positioning point. This module is
used with DrawingQuadTwo, DrawingQuadThree, and DrawingQuadFour. These modules do
not have to follow a certain order.

Usage in Label Template XML


<posModules>
<posModule value="DrawingQuadOne"/>
<positioningPoint>4</positioningPoint>
<hOffset>0.02</hOffset>
<vOffset>0.02</vOffset>
<connectPoint>4</connectPoint>
<granularity>1</granularity>
<labelOffset>0.04</labelOffset>
<posModule value="DrawingQuadTwo"/>
<posModule value="DrawingQuadThree"/>
<posModule value="DrawingQuadFour"/>
</posModules>

Customization
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.

Drawings and Reports Reference Data Guide 1999


Annotation Modules

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.

Drawings and Reports Reference Data Guide 2000


Annotation Modules

hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 2001


Annotation Modules

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point. The range of options is indicated in colored dots in the following
graphic. The ConnectPoint is placed at the TopRight.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to manually edit the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 2002


Annotation Modules

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 2003


Annotation Modules

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.
Additional customization is available in the labelSettings section of the XML file. For
more information, see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 2004


Annotation Modules

Clear Space Quadrant 3 (DrawingQuadThree)


Positions labels in the third quadrant (lower-left) based on the positioning point. This module is
used with DrawingQuadOne, DrawingQuadTwo, and DrawingQuadFour. These modules do not
have to follow a certain order.

Usage in Label Template XML


<posModules>
<posModule value="DrawingQuadOne"/>
<posModule value="DrawingQuadTwo"/>
<posModule value="DrawingQuadThree"/>
<positioningPoint>4</positioningPoint>
<hOffset>0.02</hOffset>
<vOffset>0.02</vOffset>
<connectPoint>4</connectPoint>
<granularity>1</granularity>
<labelOffset>0.04<labelOffset>
<posModule value="DrawingQuadFour"/>
</posModules>

Customization
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.

Drawings and Reports Reference Data Guide 2005


Annotation Modules

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.

Drawings and Reports Reference Data Guide 2006


Annotation Modules

hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 2007


Annotation Modules

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point.
The range of options is indicated by colored dots in the following graphic. The connectPoint
is placed at the TopRight point.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to edit the .xml file.


 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 2008


Annotation Modules

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Drawings and Reports Reference Data Guide 2009


Annotation Modules

labelOffset
Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Use the Label Offset property when you want to place the label within quadrants around the
point. The point generator calculates the point. The software starts from the point location
and looks outward to the limit of the Label Offset distance, and then begins looking for clear
space within which to place the label.

1 - Label Offset

Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.
Additional customization is available in the labelSettings section of the XML file. For
more information, see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 2010


Annotation Modules

Clear Space Quadrant 2 (DrawingQuadTwo)


Positions labels in the second quadrant (lower-right) based on the positioning point. This module
is used with DrawingQuadOne, DrawingQuadThree, and DrawingQuadFour. These modules do
not have to follow a certain order.

Usage in Label Template XML


<posModules>
<posModule value="DrawingQuadOne"/>
<posModule value="DrawingQuadTwo"/>
<positioningpoint>4</positioningPoint>
<granularity>1</granularity>
<connectPoint>4</connectPoint>
<labelOffset>0.04</labelOffset>
<posModule value="DrawingQuadThree"/>
<posModule value="DrawingQuadFour"/>
<hOffset>0.02</hOffset>
<vOffset>0.02</vOffset>
</posModules>

Customization
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label.
The range of available options is indicated by colored dots in the following graphic. In the
following image, the Positioning Point is shown placed in the TopRight position, and the
Connect Point is shown placed in the MiddleRight position.

Drawings and Reports Reference Data Guide 2011


Annotation Modules

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options allow you to manually edit the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.

Drawings and Reports Reference Data Guide 2012


Annotation Modules

hOffset, vOffset
The horizontal or vertical distance of the label from the positioning point. This distance is
applied when the software cannot find clear space in which to place the label. The value is
measured in meters.
The following graphic shows a label placed according to positive Vertical Offset and
Horizontal Offset values.

1 - Horizontal Offset distance


2 - Vertical Offset distance

Drawings and Reports Reference Data Guide 2013


Annotation Modules

connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point.
The range of options is indicated in colored dots in the following graphic. The connectPoint
is placed at the TopRight.

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options are available for manually editing the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.

Drawings and Reports Reference Data Guide 2014


Annotation Modules

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Allows you to specify the distance from a point placed on the model object to the farthest
location from the point that the label can be placed.
Additional customization is available in the labelSettings section of the XML file. For
more information, see Label Templates Overview (on page 786).

Drawings and Reports Reference Data Guide 2015


Annotation Modules

Absolute Radial from View Center (DrawingVectorAbsolute)


Places label along a vector from the center of the view with a 4 cm offset.

Usage in Label Template XML


<posModules>
<posModule value="DrawingVectorAbsolute">
</posModule>
</posModules>

Customization
None

Clear Space Clipped (DwgClippedPositioning)


Positions labels of clipped objects in the adjacent margin.

Usage in Label Template XML


<posModules>
<posModule value="DwgClippedPositioning">
<perimeterOffset>0.01</perimeterOffset>
</posModule>
</posModules>

Customization
perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

1 - Perimeter offset distance


2 - Dimension

Drawings and Reports Reference Data Guide 2016


Annotation Modules

Clear Space End of Linear Object


(DwgLblEndOfSegmentPos)
Positions labels on the ends of linear segments. Uses information from Linear Object Endpoints
(DrawingPGLinear) (on page 1357) to determine the ends of linear segments. For more
information, see Linear Object Endpoints (DrawingPGLinear) (on page 1357).

Usage in Label Template XML


<label>
<posModule value="DwgLblEndOfSegmentPos">
<minOffset>0</minOffset>
<maxOffset>0.05</maxOffset>
<granularity>1</granularity>
</posModule>
</label>

Customization
minOffset
Defines the minimum distance from a connection point that you can place a label.

1 - Minimum Offset
2 - Maximum Offset in the X direction
3 - Maximum Offset in the Y direction

Drawings and Reports Reference Data Guide 2017


Annotation Modules

maxOffset
Defines the maximum distance from a connection point that you can place a label.

1 - Minimum Offset
2 - Maximum Offset in the X direction
3 - Maximum Offset in the Y direction

granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
space in which to position the label.
 Type 0 to specify a Coarse setting. With a Coarse setting, the software searches an
increment of exactly one width and height of the existing label in order to find clear
space in which to place the new label.
 Type 1 to specify a Medium setting. With a Medium setting, the software searches an
increment of exactly one-half the width and height of the existing label.
 Type 2 to specify a Fine setting. With a Fine setting, the software searches an
increment of exactly one-third the width and height of the existing label.

Drawings and Reports Reference Data Guide 2018


Annotation Modules

1 - Label Offset
2 - Coarse setting
3 - Medium setting
4 - Fine setting

Example

Although a content module creates the annotation output, this example shows how
this module affects the output.

Drawings and Reports Reference Data Guide 2019


Annotation Modules

Absolute Along Linear Object (DwgLinearAbsPos)


Positions label at an absolute offset from a linear object, such as a structural member. This
positioning module is used with the Structural Widget (StructuralWidgetLabelContent) (on page
1470) content module.

Usage in Label Template XML


<posModules>
<posModule value="DwgLinearAbsPos">
<percentageOffset>0.50</percentageOffset>
<offsetFromMember>0.01</offsetFromMember>
<offsetFromWidget>-1</offsetFromWidget>
</posModule>
</posModules>

Customization
percentageOffset
Determines the label position along the length of a linear object, such as a structural
member.
 The following graphic illustrates the Percentage Offset property with a distance of 0.2,
or 20 percent, specified.

 The following graphic illustrates the Percentage Offset property with a distance of 0.5,
or 50 percent, specified.

Drawings and Reports Reference Data Guide 2020


Annotation Modules

The following options are available for manually editing the .xml file.
 Type 0 to place the label at the bottom left of the object.
 Type 1 to place the label at the top right of the object.
 Type a decimal value to place the label at a fractional point.
offsetFromMember
Specifies the perpendicular distance to offset the label away from a linear object, such as a
structural member. A positive value places the label above or left of the centerline, while a
negative value places the label below or right of the centerline.
The following graphic demonstrates the offsetFromMember property with an offset
distance from the structural member of 0.01 m specified.

The next graphic demonstrates the offsetFromMember property with an offset distance
from the structural member of 0.003 m specified.

Drawings and Reports Reference Data Guide 2021


Annotation Modules

offsetFromWidget
Determines the method of positioning the label offset. Type 0 to always offset the label from
the object centerline. Type -1 to offset the label from the edge of the widget when the label
and widget coincide and from the object centerline when they do not coincide. The value of
offsetFromMember is used for the offset.

1 - offsetFromWidget with a value of -1


2 - offsetFromWidget with a value of 0

Drawings and Reports Reference Data Guide 2022


Annotation Modules

Examples
percentageOffset is 0.5, offsetFromMember is 0.01, and offsetFromWidget is 0:

percentageOffset is 0.5, offsetFromMember is 0.01, and offsetFromWidget is -1:

Clear Space Along Linear Object (DwgLinearPositioning)


Aligns the label to the longest line in the 2D representation of an object.

Usage in Label Template XML


<label>
<posModules>
<posModule value="DwgLinearPositioning"/>
</posModules>
</label>

Customization
None

Drawings and Reports Reference Data Guide 2023


Annotation Modules

Clear Space Margin with Dimensions


(DwgMatchlineWithDim)
Positions labels and dimensions outside of the drawing matchline based on user-defined offsets.

Usage in Label Template XML


<posModules>
<posModule value="DwgMatchlineWithDim"/>
<dimension>-1</dimension>
<dimPerimeterOffset>0.02</dimPerimeterOffset>
<dimStyle>ANSI</dimStyle>
<dimTextOutside>-1</dimTextOutside>
<dimTextRotateClearance>0.002</dimTextRotateClearance>
<orientation>1</orientation>
<justification>-2</justification>
<angle>1</angle>
<clearance>0.003</clearance>
<perimeterOffset>0.01</perimeterOffset>
</posModules>

Customization
dimension
Specifies whether to place dimensions as part of the label rule.
Type -1 to place dimensions.

Drawings and Reports Reference Data Guide 2024


Annotation Modules

Type 0 to suppress dimensions.

dimPerimeterOffset
Determines the offset distance from the dimension to the matchline.

Drawings and Reports Reference Data Guide 2025


Annotation Modules

1 - Dimension Perimeter Offset

dimStyle
Defines the appearance of dimensions placed by the label rule.
Type any of the following styles.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

Drawings and Reports Reference Data Guide 2026


Annotation Modules

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

The following examples demonstrate the ISO and JIS properties, respectively.

Drawings and Reports Reference Data Guide 2027


Annotation Modules

1 - ISO dimension style

1 - JIS dimension style

dimTextOutside
Controls the placement of dimension text values for margin dimensions in the right and
bottom margins.
Type -1 to place the dimension text value outside of the dimension line.

1 - View border
2 - Dimension text value

Type 0 to place the dimension text value inside of the dimension line.

Drawings and Reports Reference Data Guide 2028


Annotation Modules

1 - View border
2 - Dimension text value

dimTextRotateClearance
Rotates the text of a dimension line 90 degrees when insufficient space exists for the text
between the projection lines.
Specify the minimum clearance between the beginning or end of the dimension line text and
the corresponding projection line. If the actual distance between the text and the projection
line is less than the specified value, the software rotates the text 90 degrees relative to the
dimension line.

Clearance of 0.01 m

In the above image, 0.01 m has been specified as the clearance between the end of the
dimension line text and the projection line. Because the distance between the end of the
dimension line text and the projection line is not at least 0.01 m, the text is not rotated.

Drawings and Reports Reference Data Guide 2029


Annotation Modules

Clearance of 0.002 m

In the above example, 0.002 m has been specified as the clearance between the end of the
dimension line text and the projection line. Because the distance between the end of the
dimension line text and the projection line is not at least 0.002 m, the text is rotated.
orientation
Allows you to specify the positional orientation of the label with respect to the labeled object.
Manual .xml edits depend on the module that you use, as follows.

Positioning Module XML Value Corresponding


Placement

Absolute XY Offset 1 Up

2 Down

3 Left

4 Right

Absolute Grid Margin 1 Top

2 Bottom

3 Left

4 Right

Clear Space 0 Horizontal


Coordinate

1 Vertical

Drawings and Reports Reference Data Guide 2030


Annotation Modules

Clear Space Grid 3 Left


Horizontal

4 Right

Clear Space Grid 1 Top


Margin

2 Bottom

3 Left

4 Right

Clear Space Grid 1 Top


Vertical

2 Bottom

Clear Space Margin 0 Auto


with Dimensions,
used with non-linear
point generator

1 Top

2 Bottom

3 Left

4 Right

Clear Space Margin 5 Longitudinal


with Dimensions,
only for Equipment

6 Transversal

Point Generator XML Value Corresponding


Placement

Local CS Origin with 5 Longitudinal


Object Axis

Local CS Origin with 6 Transversal


Object Axis, only for
Equipment

justification

Drawings and Reports Reference Data Guide 2031


Annotation Modules

Determines whether to align labels inside or outside the available clear space.
The following example demonstrates a label as well as the text positioned inside clear
space.

The next example shows the result when the label and text are positioned outside clear
space.

The following options are available for manually editing the .xml file.
 Type -2 to position the label and align the text outside the available clear space.
 Type -1 to position the label outside the available clear space.
 Type 0 to disable Justification.
 Type 1 to position the label inside the available clear space.
 Type 2 to position the label and align the text inside the available clear space.

Drawings and Reports Reference Data Guide 2032


Annotation Modules

angle
Controls the vertical, horizontal, or absolute angle of a label.
If you are using the Absolute XY Offset (DrawingAbsolute) positioning module, then type a
floating point number as the value. You must type a number greater than negative pi/2 and
less than or equal to positive pi/2. Additionally, you must set the value in radians, not
degrees. The default value when you use this module is 0.0.
The following example demonstrates an Absolute setting.

1 - East label
2 - North Label

If you use the Clear Space Margin with Dimensions (DwgMatchlineWithDim) positioning
module, then you can specify 0 to set a Horizontal angle or 1 to specify a Vertical angle.
The default value when you use this module is 1.
The following example demonstrates a vertically placed label.

Drawings and Reports Reference Data Guide 2033


Annotation Modules

1 - Vertically placed label

Drawings and Reports Reference Data Guide 2034


Annotation Modules

The next example demonstrates a horizontally placed label.

1 - Horizontally placed label

Drawings and Reports Reference Data Guide 2035


Annotation Modules

clearance
Specifies the minimum distance separating adjacent labels.

1 - Clearance

If the labels in the current drawing use two separate templates that both define a
Clearance, then the software uses the larger of the two Clearance values to separate
adjacent labels.

Drawings and Reports Reference Data Guide 2036


Annotation Modules

perimeterOffset
Specifies either the distance from the edge of the view to the dimension line, or the distance
from the edge of the view to the edge of the label that is closest to the view.

1 - Perimeter offset distance


2 - Dimension

posModulesSet
Provides keypoint settings used by positioning modules.

Usage in Label Template XML


<posSettings>
<posModulesSets>
<posModulesSet>
<connectPoint>4</connectPoint>
<positioningPoint>4</positioningPoint>
<posModules>
Positioning modules appear here
</posModules>
</posModulesSet>
</posModulesSets>
</posSettings>

Customization
connectPoint
Specifies the point on the model object to which the leader line connects. If model objects
block the direct path of the leader line to the Connect Point, then the leader line points
toward the connect point. The range of options is indicated by colored dots in the following
graphic. The connect point is placed at the top right point.

Drawings and Reports Reference Data Guide 2037


Annotation Modules

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right

The following options allow you to manually edit the .xml file.
 Type 0 to place the Connect Point at the top left.
 Type 1 to place the Connect Point at the top middle.
 Type 2 to place the Connect Point at the top right.
 Type 3 to place the Connect Point at the middle left.
 Type 4 to place the Connect Point in the middle middle.
 Type 5 to place the Connect Point at the middle right.
 Type 6 to place the Connect Point at the bottom left.
 Type 7 to place the Connect Point at the bottom middle.
 Type 8 to place the Connect Point at the bottom right.
positioningPoint
Allows you to select a point within the range of a model object as the starting point. Starting
at this specified point, the software searches for clear space in the quadrants in order to
place a label. The range of available options is indicated by colored dots in the following
graphic. In the following image, the positioning point is shown placed in the top right
position, and the connect point is shown placed in the middle right position.

Drawings and Reports Reference Data Guide 2038


Annotation Modules

1 - Top Left
2 - Top Middle
3 - Top Right
4 - Middle Left
5 - Middle Middle
6 - Middle Right
7 - Bottom Left
8 - Bottom Middle
9 - Bottom Right
10 - Quadrant 1

The following options are available for manually editing the .xml file.
 Type 0 to place the point at the top left.
 Type 1 to place the point in the top middle.
 Type 2 to place the point at the top right.
 Type 3 to place the point at the middle left.
 Type 4 to place the point in the middle middle.
 Type 5 to place the point at the middle right.
 Type 6 to place the point at the middle left.
 Type 7 to place the point in the bottom middle.
 Type 8 to place the point at the bottom middle.

Drawings and Reports Reference Data Guide 2039


Annotation Modules

Leader Modules
Leader modules are used in Drawings label templates to determine where to position label
leaders on drawings. The leader module is responsible for determining the points for the leader
beginning and end. The leader module also determines the dimensions style of the leader line
(from styles.sha) and whether or not a jog is placed in the leader line. As a result of the leader
positioning, a label is also positioned and placed on the drawing view.
For information on the relationship of leader modules to other annotation modules, see
Annotation Modules (on page 1728).

Topics
Clear Space Tiling (CAD Details) (DrawingTileInView) ................. 2040
Weld (DrawingWeldLeader)........................................................... 2042
Only Outside of Object (DwgLeaderInOutsideControl) ................. 2044
Margin (DwgMarginLeaderControl) ............................................... 2046
ISDwgMarginLeader ...................................................................... 2054
Materials Handling Absolute (MHDrawingAbsoluteLeader) .......... 2058
Coordinate (DrawingCoordLeaderControl) .................................... 2060
Linear (DrawingLinearLeader) ....................................................... 2063
Default (DwgLeaderControl) .......................................................... 2067
Stacked Labels (DwgStackLabelLeader) ...................................... 2072

Clear Space Tiling (CAD Details) (DrawingTileInView)


Permits an additional spacing option when labels in the view are tiled. This spacing option
recognizes the amount of space between each label and positions labels accordingly.

Usage in Label Template XML


<posModule>
<posModule value="DrawingTileInView">
<spacing>0.01</spacing>
</posModule>
</posModules>

Customization
spacing
Specifies the vertical and horizontal distances between CAD Details graphics placed on the
drawing sheet.
The following graphic shows the Spacing property with 0.01 m specified between two CAD
Details graphics.

Drawings and Reports Reference Data Guide 2040


Annotation Modules

1 - End plate
2 - Shoe base

The following graphic shows the Spacing property with 0.02 m specified between two CAD
Details graphics.

1 - End plate
2 - Shoe base
3 - Shoe vertical part

The number of CAD Details graphics that can fit on the drawing sheet depends on the
measurements that you specify for this property. Specifying a greater distance between
CAD Details graphics results in fewer graphics on the drawing sheet, while specifying a
smaller distance results in a greater number of graphics on the drawing sheet.

Drawings and Reports Reference Data Guide 2041


Annotation Modules

Weld (DrawingWeldLeader)
Connects the leader line to either the left-most or right-most point of the weld line, depending on
the orientation of the label.
The following image shows the leader line connecting to the left-most point of the weld line.

1 - Leader line
2 - Weld line

Customization
breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.
Type -1 to place a leader jog.

Drawings and Reports Reference Data Guide 2042


Annotation Modules

Type 0 to omit the leader jog.

style
Defines the appearance of a leader line.
Specify any of the following styles.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Drawings and Reports Reference Data Guide 2043


Annotation Modules

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Only Outside of Object (DwgLeaderInOutsideControl)


Places a leader line when the distance from the label to the graphic object exceeds the limit
defined in the label template.
In the following image, the distance from the graphic object to the leader line exceeds the
defined limit. Therefore, the system places a leader line.

Drawings and Reports Reference Data Guide 2044


Annotation Modules

In the next image, the distance from the graphic object to the label falls within the limit defined in
the label template. Therefore, the software does not place a leader line.

Usage in Label Template XML


<leaderSettings>
<leaderModule>DwgLeaderInOutsideControl</leaderModule>
<toleranceZone>0.08</toleranceZone>
<breakline>-1</breakline>
</leaderSettings>

Customization
toleranceZone
Controls when a leader line is placed or not based on the label's distance from the labeled
object.
If the label is within the specified distance from the outer boundary of the object, then the
leader line is suppressed. If the label is outside of the specified distance, then the leader line
is displayed. For example, if the Tolerance Zone value is set to 10 mm, the label must be at
least 10 mm away (in paper units) from the labeled object before a leader appears.
For labels placed manually using the Place a Label command, type in a distance value in
the Tolerance Zone box on the ribbon.

breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.
Type -1 to display the leader jog.

Drawings and Reports Reference Data Guide 2045


Annotation Modules

Type 0 to omit the leader jog.

Margin (DwgMarginLeaderControl)
Places a multi-segment leader that you can use with grid lines and other linear objects. For
labels that are located outside of the view, the software places the leader between the matchline
and the jog segment.

Drawings and Reports Reference Data Guide 2046


Annotation Modules

1 - Leader offset
2 - Leader length
3 - Jog segment offset
4 - Jog segment offset 1
5 - Jog segment offset 2
6 - Perimeter offset

Smart 3D only uses the Jog Segment Offset 1 and Jog Segment Offset 2
properties with the Clear Space Margin with Dimensions positioning module. For all other
positioning modules, Margin produces a leader line that looks like the example below.

1 - Leader offset
2 - Leader length
3 - Jog segment offset
4 - Perimeter offset

Usage in Label Template XML


<label>
<leaderSettings>
<leaderModule>DwgMarginLeaderControl</leaderModule>
<ignoreLeaderCrossings>-1</ignoreLeaderCrossings>
<disableAutoDelete>-1</disableAutoDelete>
<leaderOffset>0.002</leaderOffset>
<leaderLength>0.005</leaderLength>
<style>ANSI_NOARROW</style>
<jogSegmentOffset>0.015</jogSegmentOffset>
<jogSegmentOffset1>0.015</jogSegmentOffset1>
<jogSegmentOffset2>0.005<jogSegmentOffset2>
</leaderSettings>
</label>

Customization
ignoreLeaderCrossings
Renders the leader line of a label as invisible to other annotations.
Type -1 to allow leader lines and other annotations to intersect.

Drawings and Reports Reference Data Guide 2047


Annotation Modules

Type 0 to render the leader line visible to other annotations.

Drawings and Reports Reference Data Guide 2048


Annotation Modules

disableAutoDelete
Controls the visibility of the leader line of a label when the distance from the label to the
corresponding connect point is less than half the label height.
Type -1 to retain the leader line.

1 - Label with leader line

Type 0 to turn off the leader line.

1 - Label with no leader line

Drawings and Reports Reference Data Guide 2049


Annotation Modules

leaderOffset
Specifies the distance outside of the matchline at which you want the leader line to
terminate. If this value is zero, the leader line connects to the object.
The following example shows a leaderOffset of 0.001.

1 - Leader offset = 0.001

In the next example, the leaderOffset is set to zero.

1 - Leader offset = 0.0

leaderLength
Sets the distance from the matchline to the first jog in the leader line of a label when the
leader line contains multiple segments. This property can be applied only if the leader line
uses a breakline.

Drawings and Reports Reference Data Guide 2050


Annotation Modules

1 - Matchline
2 - 0.03 m Leader Length
3 - Leader line

1 - Matchline
2 - 0.05 m Leader Length
3 - Leader line

style
Defines the appearance of a leader line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Drawings and Reports Reference Data Guide 2051


Annotation Modules

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

jogSegmentOffset
Allows you to specify the offset from the first leader segment connected to the object to the
next jog segment in the leader line.
jogSegmentOffset1
Allows you to specify the offset from the end of the jog segment offset 1 to the jog segment
offset 2 in a leader line.
jogSegmentOffset2
Allows you to specify the offset from jog offset 1 to the remaining portion of the leader line.
The jog segment to which this property applies connects to the leader line that connects
directly to the label.

Drawings and Reports Reference Data Guide 2052


Annotation Modules

Examples
In the following example, leaderOffset is not enabled.

Drawings and Reports Reference Data Guide 2053


Annotation Modules

In the following example, leaderOffset is enabled with the default value.

ISDwgMarginLeader
Places a leader line for margin labeling. The leader is placed between the label and the drawing
object. ISDwgMarginLeader uses control points from the point generator module to place the
terminator of the leader.

Usage in Label Template XML


<label>
<leaderSettings>
<leaderModule>ISDwgMarginLeader</leaderModule>
<style>ANSI_NOARROW</style>
<witness>ANSI_NOARROW</witness>
<breakline>-1</breakline>
<jogSegmentOffset>0.005</jogSegmentOffset>
<jogLength>0.005</jogLength>
</leaderSettings>
</label>

Drawings and Reports Reference Data Guide 2054


Annotation Modules

Customization
style
Specifies the line style for the leader.

1 - Leader line
2 - Break line

witness
Specifies the line style for the witness line of a dimension.

1 - Witness line
2 - Dimension line

Line styles are defined in [Reference Data Product


Folder]\SharedContent\Drawings\Catalog\templates\Styles.sha.
breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.
Type -1 to display the leader jog.

Type 0 to omit the jog.

Drawings and Reports Reference Data Guide 2055


Annotation Modules

You cannot place breaklines with acute leader jog angles when automatically
generating labels. However, you can manually place breaklines with acute leader jog angles
within SmartSketch by updating the view, then selecting a leader and clicking BreakLine .
jogSegmentOffset
Allows you to specify the offset from the first leader segment connected to the object to the
next jog segment in the leader line.

Drawings and Reports Reference Data Guide 2056


Annotation Modules

1 - Leader offset
2 - Leader length
3 - Jog Segment Offset
4 - Jog Segment Offset 1
5 - Jog Segment Offset 2
6 - Perimeter Offset

jogLength
Allows you to set the length of the jog segment in a leader line that connects to the label.

Drawings and Reports Reference Data Guide 2057


Annotation Modules

Type -1 to place a jog. Type 0 to suppress the jog.

1 - jogLength

Materials Handling Absolute (MHDrawingAbsoluteLeader)


Aligns the label and leader line to only one opening or slot for all identically sized openings or
slots. The system displays only one label for each set of openings when you use this module.

Usage in Label Template XML


<leadersettings>
<leaderModule>MHDrawingAbsolusteLeader</leaderModule>
<breakline>-1</breakline>
<style>ANSI</style>
</leadersettings>
Customization
breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.

Drawings and Reports Reference Data Guide 2058


Annotation Modules

Type -1 to display the leader jog.

Type 0 to omit the jog.

style
Defines the appearance of a leader line. Specify any of the following styles:
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

Drawings and Reports Reference Data Guide 2059


Annotation Modules

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Coordinate (DrawingCoordLeaderControl)
Places a leader line under the coordinate label. The style tag determines which dimension style
to use from styles.sha, while the breakline tag determines whether or not to place a jog in the
leader. A value of -1 is true and places a jog in the leader, while a value of 0 does not place a
jog.

Usage in Label Template XML


<label>
<leaderSettings>
<leaderModule>DrawingCoordLeaderControl</leaderModule>
<breakline>0</breakline>
<style>ANSI</style>
</leaderSettings>
</label>

Customization
breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.

Drawings and Reports Reference Data Guide 2060


Annotation Modules

Type -1 to place a leader jog.

Type 0 to omit the jog.

You cannot place breaklines with acute leader jog angles when automatically
generating labels. However, you can manually place breaklines with acute leader jog angles
within SmartSketch by updating the view, then selecting a leader and clicking BreakLine .
style
Defines the appearance of a leader line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

Drawings and Reports Reference Data Guide 2061


Annotation Modules

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

Drawings and Reports Reference Data Guide 2062


Annotation Modules

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Linear (DrawingLinearLeader)
Places a leader with 3 segments used with grid lines and other linear objects. The style tag
determines which dimension style to use from styles.sha, while the breakline tag determines
whether or not to place a jog in the leader. A value of -1 is true and places a jog in the leader,
while a value of 0 does not place a jog. The jogSegmentOffset value is the linear offset of the
middle of the leader. The jogLength value is the length of the leader segment connected to the
label.

Usage in Label Template XML


<label>
<leaderSettings>
<leaderModule>DrawingLinearLeader</leaderModule>
<style>ANSI_NOARROW</style>
<breakline>0</breakline>
<jogSegmentOffset>0.005</jogSegmentOffset>
<jogLength>0.005</jogLength>
</leaderSettings>
</label>

Drawings and Reports Reference Data Guide 2063


Annotation Modules

Customization
style
Defines the appearance of a leader line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.

Drawings and Reports Reference Data Guide 2064


Annotation Modules

Type -1 to place a leader jog.

Type 0 to omit the jog.

You cannot place breaklines with acute leader jog angles when automatically
generating labels. However, you can manually place breaklines with acute leader jog angles
within SmartSketch by updating the view, then selecting a leader and clicking BreakLine .
jogSegmentOffset
Allows you to specify the offset from the first leader segment connected to the object to the
next jog segment in the leader line.

Drawings and Reports Reference Data Guide 2065


Annotation Modules

1 - Leader offset
2 - Leader length
3 - Jog Segment Offset
4 - Jog Segment Offset 1
5 - Jog Segment Offset 2
6 - Perimeter Offset

jogLength
Type -1 to place a jog. Type 0 to suppress the jog.

Drawings and Reports Reference Data Guide 2066


Annotation Modules

Default (DwgLeaderControl)
Places a leader line between the label and the drawing object. The style tag determines which
dimension style to use from styles.sha, while the breakline tag determines whether or not to
place a job in the leader. A value of -1 is true and places a jog in the leader, while a value of 0
does not place a jog.

Usage in Label Template XML


<label>
<leaderSettings>
<leaderModule>DwgLeaderControl</leaderModule>
<style>ANSI</style>
<breakline>-1</breakline>
<disableAutoDelete>-1</disableAutoDelete>
<ignoreLeaderCrossings>-1</ignoreLeaderCrossings>
</leaderSettings>
</label>

Customization
style
Defines the appearance of a leader line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

Drawings and Reports Reference Data Guide 2067


Annotation Modules

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

To manually edit the .xml, specify the style that you want applied to the leader line.
breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.
Type -1 to place a leader jog.

Drawings and Reports Reference Data Guide 2068


Annotation Modules

Type 0 to omit the jog.

You cannot place breaklines with acute leader jog angles when automatically
generating labels. However, you can manually place breaklines with acute leader jog angles
within SmartSketch by updating the view, then selecting a leader and clicking BreakLine .
disableAutoDelete
Controls the visibility of the leader line of a label when the distance from the label to the
corresponding connect point is less than half the label height.
Type -1 to retain the leader line.

Drawings and Reports Reference Data Guide 2069


Annotation Modules

1 - Label with leader line

Type 0 to turn off the leader line.

1 - Label with no leader line

ignoreLeaderCrossings
Renders the leader line of a label as invisible to other annotations.
Type -1 to allow leader lines and other annotations to intersect.

Drawings and Reports Reference Data Guide 2070


Annotation Modules

Type 0 to render the leader line visible to other annotations.

Drawings and Reports Reference Data Guide 2071


Annotation Modules

Stacked Labels (DwgStackLabelLeader)


Places a single-segment leader line between the label and drawing object. If more than one
label exists for the object, the labels are stacked next to each other along the same axis of the
leader line. You must use the Clear Space Radial from Object Center with Clustering
(DrawingCentroid) (on page 1247) positioning module with this leader module.

Usage in Label Template XML


<label>
<leaderSettings>
<leaderModule>DwgStackLabelLeader</leaderModule>
<style>ANSI</style>
<breakline>0</breakline>
<disableAutoDelete>-1</disableAutoDelete>
</leaderSettings>
</label>

Customization
style
Defines the appearance of a leader line.
 ANSI: Applies a thin, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 ANSI_FRACTIONAL: Applies a thick, solid, dark cyan line style with a filled arrow
terminator to the leader line.

 ANSI_NOARROW: Applies a thick, solid, dark cyan line style with no terminator to the
leader line.

 JIS: Applies a thick, solid, dark cyan line style with a large, open arrow terminator to the
leader line.

 ISO: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

Drawings and Reports Reference Data Guide 2072


Annotation Modules

 DIN: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

 ASA: Applies a thick, solid, dark cyan line style with a filled arrow terminator to the
leader line.

 BSI: Applies a thick, solid, dark cyan line style with a large, filled arrow terminator to the
leader line.

To manually edit the .xml file, specify the style that you want applied to the leader line.
breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line to the label.
Type -1 to place a breakline.

Type 0 to omit the breakline.

Drawings and Reports Reference Data Guide 2073


Annotation Modules

You cannot place breaklines with acute leader jog angles when automatically
generating labels. However, you can manually place breaklines with acute leader jog angles
within SmartSketch by updating the view, then selecting a leader and clicking BreakLine .
disableAutoDelete
Controls the visibility of the leader line of a label when the distance from the label to the
corresponding connect point is less than half the label height.
Type -1 to retain the leader line.

1 - Label with leader line

Type 0 to turn off the leader line.

Drawings and Reports Reference Data Guide 2074


Annotation Modules

1 - Label with no leader line

Drawings and Reports Reference Data Guide 2075


Index
Absolute XY Offset (DrawingAbsolute) •
1 1130, 1643, 1947
Actions Tab (Edit Ruleset View Style Dialog
1. Hull Lines (Hull Lines - Body Plan View) • Box) • 119
172 Actual 3D Geometry • 982
Add A Drawing Volume Part Class • 323
2 Add a Report Template • 655
2. Hull Lines (Hull Lines - Body Plan View) • Add an Add-on View Style to an Existing
174 Ruleset View Style • 136
2D Object Center (ISStruct2DRangePG) • Add Custom Command Dialog Box • 161
1513 Add custom commands • 159
Add Flow Arrows to Orthographic Drawings
• 107
3 Add Point along Horizontal Girth Length •
3. Hull Lines (Hull Lines - Body Plan View) • 1134
175 Add Point along Vertical Girth Length •
3D Model By Query • 41 1134
3D Model Data • 42 Add Template Dialog Box • 1100, 1607,
3D Object Center (DrawingPointGenerator) 1634
• 1514, 1732 Add-on Ruleset View Styles • 288
AddOns Tab (Edit Ruleset View Style
A Dialog Box) • 132
Absolute Along Linear Object AddOns Tab (Graphic Style Dialog Box) •
(DwgLinearAbsPos) • 1113, 2020 129
Absolute Axis Position Adjacent Edge Overlap Percentage
(SMDwgPositionAxis) • 1117, 1935 (adjacentOverlap) • 1613
Absolute Dimension Offset Align (align) • 1517
(DrawingDimAbsolutePos) • 1514, 1907, Aligned Objects (DrawingGALabelInline) •
1973 1135, 1800
Absolute Grid Margin Allow Acute Breakline Angle • 1142
(DrawingGridLblMgnAbsPos) • 1118, Allow Labels Outside View • 1144
1983 Allow Non-Orthogonal Directions • 1145
Absolute Margin (DrawingDimMarginPos) • Allow Short Leaders • 1147
1516, 1910 Anchor • 1148
Absolute Matchline Anchor (dimensionAnchor value) • 1518
(DrawingMatchlinePositioning) • 1613, Anchor to Nearest Object
1992 (DrawingSepDimGenerator) • 1520
Absolute Points (ISAbsolutePointLabelPG) • Angle • 1149
1120, 1642, 1753 Angular Dimensions
Absolute Position by 2D Curve (DrawingDimContAngNoReplace) • 1883
(ISDwgAbsolutePositionByCurve2D) • Angular Dimensions with Value
1120, 1915 Replacement
Absolute Position by 2D Curve at Axis (DrawingDimContentAngular) • 1884
(SMDwgPositionByCurve2DAtAxis) • Annotation Control Generator Module
1124, 1936 (Properties tab) • 1107, 1508, 1610, 1638
Absolute Radial from View Center Annotation Modules • 1728
(DrawingVectorAbsolute) • 1129, 2016 Appendix
Annotation Rule Manager Customization
• 1066

Drawings and Reports Reference Data Guide 2076


Index

Migrating Dimension Rules • 1722 Breakline Length • 1155


Apply a Clipped Solid Fill Style to a Drawing Built-up Member To Parts • 984
• 101 Bulkload Files • 321, 641
Apply a Visible Fill Style to a Drawing • 98
Apply an Add-on to a Source Action • 138 C
Apply Grid Labels to Elevation Views • 92
Apply Invisible Option to an Orthographic Capped Normal Pipe • 984
View Style • 104 Cardinal Point • 1156
Apply Symbology to Graphic Object Catalog Symbols • 1065
Aspects • 106 Change the End Cut Embedded Symbol
Apply Transparency to an Orthographic Rule for a Source Action • 139
View Style • 103 Choice • 1157
Apply Transparency to Members in a Choose Symbol Dialog Box • 84
Ruleset View Style • 139 Chord Line Source
Area Tab (Edit Ruleset View Style Dialog (MfgPinJigSideView.Default) • 224
Box) • 130 Civil Elevation • 961
Assembly Drawing Rule Set • 190 Civil Elevation View Style • 375
Assign Drawing Objects to Specific Layers • Civil Isometric View Style • 376
117 Civil Key Plan View Style • 383
ATTRIBUTE and ATTRIBUTE_VALUE • Civil Overall Key Plan • 961
1075 Civil Overall Key Plan View Style • 385
AWS Standards in Drawings • 34 Civil Plan • 961
Axis Angle • 1152 Civil Plan View Style • 390
Axis Connect Point • 1152 Civil View Styles • 375
Axis Definition • 1153 Clear Space Along Linear Object
Axis X Offset, Axis Y Offset • 1154 (DwgLinearPositioning) • 1159, 2023
Clear Space Center Then Above
(DrawingCenterThenAbove) • 1159, 1952
B Clear Space Center Then Above Centerline
Base Control Source (DrawingCenterThenAboveCL) • 1162,
(MfgTemplateRuleSet.DefaultRuleSet) • 1954
217 Clear Space Center Then Rotate
Beam Part • 982 (DrawingCenterThenRotate) • 1164,
Beam Part Source 1956
(ISSteelOrderRuleSet.Default) • 230 Clear Space Clipped
Belongs to Query • 264 (DwgClippedPositioning) • 1166, 2016
Between Points Clear Space Coordinate
(ISDimensionBetweenPointsGA) • 1522, (DrawingCoordLblPosMod) • 1167, 1967
1788 Clear Space End of Linear Object
Between Points (ISDimensionBtwPointsPG) (DwgLblEndOfSegmentPos) • 1172,
• 1522, 1753 2017
Bevel Orientation • 265 Clear Space Grid Horizontal
Bevel Source (DrawingGridLblHoriz) • 1175, 1973
(MfgProfileRuleSet.DefaultRuleSet) • 209 Clear Space Grid Margin
Bidirectional Symbol • 1155 (DrawingGridLblMarginOnly) • 1180,
Block Action 1979
Get Parts in Range of the Block • 242 Clear Space Grid Vertical
Block Location • 266 (DrawingGridLblVert) • 1184, 1985
Block Source Clear Space Horizontal Bottom
(ISSteelOrderRuleSet.Default) • 230 (DrawingDimHorizBottomCS) • 1523,
Bounded • 268 1908
Braces • 1076 Clear Space Horizontal Top
Bracket with Flange • 982 (DrawingDimHorizTopCS) • 1525, 1909

Drawings and Reports Reference Data Guide 2077


Index

Clear Space Margin (DrawingMarginOnly) • Connect Point • 1257


1189, 1989 Connected Parts • 268
Clear Space Margin with Dimensions Connection Action
(DwgMatchlineWithDim) • 1191, 2024 Label Butt Welds • 258
Clear Space Pipe Segments Label Connections with Intersection
(DrawingDimPipeSegPos) • 1526, 1973 Symbols • 256
Clear Space Position by 2D Curve Label Tee Welds • 259
(ISDwgPositionByCurve2D) • 1203, 1919 Label with Penetration Symbols • 257
Clear Space Position by 2D Curve at Connection Source
Margin (ISSteelOrderRuleSet.Default) • 231
(ISDwgPositionByCurve2DAtMargin) • Connection Species • 270
1211, 1927 Connection Type • 271
Clear Space Position Marine Grid Label at Content Module (Properties tab) • 1105,
Margin 1508, 1609, 1637
(SMDwgPositionGridLblMarginOnly) • Content Modules • 1818
1219, 1942 CONTENT_SUPPORTED • 1071
Clear Space Quadrant 1 CONTROL • 1079
(DrawingQuadOne) • 1224, 1648, 1999 Control Generators • 1899
Clear Space Quadrant 2 Control Point Label Type • 1259
(DrawingQuadTwo) • 1229, 1654, 2011 Control Point Only
Clear Space Quadrant 3 (DrawingPGCPThenNone) • 1260, 1529,
(DrawingQuadThree) • 1234, 1659, 2005 1671, 1732
Clear Space Quadrant 4 Control Point then Local CS Origin then
(DrawingQuadFour) • 1240, 1665, 1993 Center (DrawingPGControlPoint) • 1261,
Clear Space Radial (DrawingRadial) • 1246, 1530, 1672, 1733
1913 Convert to Coordinate Dimension
Clear Space Radial from Object Center with (SMDwgConvertToCoordDimGA) • 1531,
Clustering (DrawingCentroid) • 1247, 1794
1959 Coordinate (DrawingCoordDimGenerator) •
Clear Space Tiling (CAD Details) 1532, 1899
(DrawingTileInView) • 1255, 1914, 2040 Coordinate (DrawingCoordLeaderControl) •
Clear Space Vertical Left 1262, 2060
(DrawingDimVertLeftCS) • 1527, 1911 Coordinate and Control Point Labels • 823
Clear Space Vertical Right Coordinate Labels • 826
(DrawingDimVertRightCS) • 1528, 1912 Coordinate System Relation • 272
Clearance • 1158 Copy a Compound Matchline Rule • 1607
Clipped Geometry With Volume • 985 Copy a Rule • 86, 1101, 1505, 1634
Clipped Labels • 822 Create a Compound Label Using Label
Collation Rules in Drawings by Rule • 293 Rules • 745
Command Line Interface • 1725 Create a Compound Label Using the
Comments Tab • 1112, 1612, 1641 Content Module • 750
Comments Tab (Dimension Rule Manager) Create a Compound Label with a Combined
• 1512 Symbol • 748
Common Dimension Template Properties • Create a Custom Cutting Plane Symbol •
694 907
Compartment Source Create a Custom Symbol for Drawings •
(ISSteelOrderRuleSet.Default) • 231 906
Composed Drawings • 44 Create a filter-based report that uses the
Compound Labels • 744 DrawingMAP table • 656
Concatenated Labels for Drawings by Rule Create a Key Plan View Style • 88
• 915 Create a Label • 929
CONDITION • 1077 Create a new isometric drawing style • 646
Configure New Command on a Folder • 40 Create a New Label Rule • 931

Drawings and Reports Reference Data Guide 2078


Index

Create a new layout style with custom Default Marine Label Text
layout processors • 148 (ISRulesetLabelAnalyzer) • 1276, 1792
Create a Rule Set View Style • 135 Default Marine Point
Create a View Style with Resymbolized (ISRulesetPointGenerator) • 1276, 1536,
Normal Pipes • 974 1678, 1764
Create a View Style with Single Line Pipes • Define a Layout Style • 147
977 Define Layout Style Command (Tools
Create an Orthographic Drawing View Style Menu) • 145
• 87 Define Layout Style Dialog Box • 146
Create Border and Layout Templates • 151 Define View Style Command (Tools Menu) •
Create custom commands • 159 56
Create Line Styles to Use in Drawing View Define View Style Dialog Box • 58
Styles • 89 Delete a custom command • 160
Create or Edit a Graphic Preparation Rule • Delete a source on the Actions tab • 136
91 Delete a Template • 1102
Cross-Section Edge Names • 1034 Delivered Custom Commands • 162
CtrlPtCoordSym_None_A_NL • 834 Design Equipment Part Separator • 986
CtrlPtECoord_None_CA_L • 835 DetailSimpleReference • 919
CtrlPtNCoord_None_CA_L • 835 Dimension Anchoring Overview • 1722
CtrlPtOnlyCoordSym_None_A_NL • 835 Dimension Anchors • 690
CtrlPtOnlyECoord_None_CA_L • 836 Dimension Layer (dimLayer) • 1536
CtrlPtOnlyNCoord_None_CA_L • 836 Dimension Perimeter Offset • 1277
Custom Attributes • 325 Dimension Rule Manager • 1503
Custom Commands • 156 Dimension Rules • 680
Custom Commands Dialog Box • 160 Dimension Style • 1278
Custom Graphic Modules • 972 Dimension Templates Overview • 694
Custom Graphic Rule Dialog Box • 68 Dimension Text Rotate Clearance • 1280
Custom Scale Codelist Workbook • 323 Dimensions • 679
Custom Tab (Graphic Style Dialog Box) • Direction • 273
129 DISPLAY (Property Name) • 1080
Custom Tests Dialog Box • 122 DISPLAY (Value Range) • 1081
Custom Tests Dialog Box (Generic Rule Display Angular (angular) • 1537
Set) • 123 Display Breakline • 1281
Customization Examples • 1096 Display Dimension • 1283
Customized Graphic Rules • 726 Display Empty/Error Labels • 1284, 1617,
Cutting Surface Intersection • 726 1678
Display Horizontal (horiz) • 1537
D Display Overall Dimensions (overall) • 1538
Display Vertical (vert) • 1539
DATA_TYPE • 1079 Document and Sheet Naming Rules in
DEFAULT • 1080 Drawings by Rule • 313
Default (DefaultLabelControlGenerator) • Draw 2D Graphics • 728
1265, 1615, 1673, 1902 Draw Detail • 274
Default (DrawingDimGenerator) • 1533, Draw Flange on Web • 275
1901 Drawable Default Graphics • 987
Default (DrawingGeometricAnalyzer) • Drawing View Style Creation Process • 371
1534, 1816 Drawing/View Update Checker • 1727
Default (DrawingLabelHelper) • 1268, 1675, DrawingCustomProperties Workbook • 325
1831 DrawingCuttingPlanesContent • 1824
Default (DwgLeaderControl) • 1271, 2067 DrawingIssueReason_Codelist Workbook •
Default Graphics • 985 328
Default Marine Label DrawingOrientToY0Content • 1837
(ISRulesetLabelContent) • 1275, 1856 DrawingPGCuttingPlane • 1773

Drawings and Reports Reference Data Guide 2079


Index

Drawings by Query Manager • 47 Electrical CableTray Key Plan View Style •


Drawings by Rule Labels, Symbols, and 416
Dimensions • 910 Electrical CableTray Layout Plan • 962
Drawings by Rule Packages • 164 Electrical CableTray Layout Plan Package •
Drawings by Rule Reference Data • 163 333
Drawings by Rule Reports • 319 Electrical CableTray Overall Key Plan • 962
Drawings by Rule View Style Rule Sets • Electrical CableTray Overall Key Plan
190 Package • 334
Drawings by Rule View Styles • 167 Electrical CableTray Overall Key Plan View
Drawings Workbook • 322 Style • 417
Drawings-ExtendCustomAttributes Electrical CableTray Plan • 962
Workbook • 327 Electrical CableTray Plan Package • 335
Ducts in HVAC View Styles (Normal Electrical CableTray Plan View Style • 420
Orientation) • 510 Electrical Equipment Drawings Package •
Dummy (DummyGeomAnalyzer) • 1285, 336
1540, 1815 Electrical Equipment Elevation • 962
Electrical Equipment Elevation Package •
E 336
Electrical Equipment Elevation View Style •
East Report Template • 1618 431
East Symbol Attribute Name • 1618 Electrical Equipment Isometric Package •
Edge Feature Source 337
(MfgProfileRuleSet.DefaultRuleSet) • 210 Electrical Equipment Isometric View Style •
Edge to Edge (MHEdgeToEdgePG) • 1540 435
Edit a custom command • 159 Electrical Equipment Key Plan • 962
Edit a label rule to allow non-orthogonal Electrical Equipment Key Plan View Style •
label directions • 1810 437
Edit a Label Rule to use the Equivalence Electrical Equipment Overall Key Plan • 963
Label • 1799, 1812 Electrical Equipment Overall Key Plan
Edit a Layout Template • 154 Package • 338
Edit Action Description Dialog Box • 121 Electrical Equipment Overall Key Plan View
Edit an Isometric Backing Sheet • 649 Style • 438
Edit Border Template Command (Tools Electrical Equipment Plan Package • 339
Menu) • 149 Electrical Equipment Plan View Style • 440
Edit Custom Command Dialog Box • 161 Electrical Instrument Plan Package • 340
Edit Layout Style Dialog Box • 146 Electrical Instrument Plan View Style • 444
Edit Layout Template Command (Tools Electrical Lighting Plan Package • 341
Menu) • 152 Electrical Lighting Plan View Style • 453
Edit Ruleset View Style Dialog Box • 118 Electrical Packages • 330
Elbow To Arc • 987 Electrical Raceway Plan • 963
Elbow To Single Arc • 988 Electrical View Styles • 398
Electrical Above Ground Plan • 961 Eliminate Labels with Missing Parents
Electrical CableTray Drawings Package • (SMDGAEliminateLabelsWithMissingPar
331 ents) • 1286, 1793
Electrical CableTray Elevation • 961 Eliminate Most Common Labels
Electrical CableTray Elevation Package • (ISGAEliminateMostCommonLabels) •
331 1287, 1789
Electrical CableTray Elevation View Style • Eliminate Overlapping Labels
398 (ISGAEliminateOverlappingLabels) •
Electrical CableTray Isometric Package • 1289, 1791
332 Embedded Label • 1290
Electrical CableTray Isometric View Style • Embedded Symbol Rules • 1043
409 End Curve Ratio • 1292

Drawings and Reports Reference Data Guide 2080


Index

End Cut Embedded Symbols (Generic Rule From Matchline • 1301


Set) • 1053
End Cut Embedded Symbols (Steel Order G
Rule Set) • 1045
End of Segment Gap Tolerance (gapTolerance) • 1618
(DrawingGAEndOfSegment) • 1292, GATHER • 1083
1796 Gathered • 276
Enumerate Equipment Graphic Children • Gathering Rules in Drawings by Rule • 307
988 General Label Rules • 852
Enumerate Hanger Graphic Children • 990 General Tab (Edit Ruleset View Style
Equipment Drawings Package • 342 Dialog Box) • 133
Equipment Elevation • 963 Generic Horizontal Dimensions • 698
Equipment Elevation Package • 343 Generic Interoperability
Equipment Elevation View Style • 460 (GenericGeometricAnalyzerInterop) •
Equipment Isometric Package • 344 1303, 1787
Equipment Isometric View Style • 468 Generic Interoperability
Equipment Key Plan View Style • 473 (SMDGenericContentInterOp) • 1304
Equipment Nozzle Separator • 992 Generic Line • 996
Equipment Overall Key Plan • 963 Generic Module Folder • 44
Equipment Overall Key Plan Package • 345 Generic Name Labels • 758
Equipment Overall Key Plan View Style • Generic Plate Anti-Molded Side • 997
474 Generic Plate Anti-Molded Side Without
Equipment Packages • 342 Features • 997
Equipment Plan • 963 Generic Plate Both Sides Without Features
Equipment Plan Package • 346 • 997
Equipment Plan View Style • 477 Generic Plate Molded Side • 997
Equipment View Styles • 459 Generic Plate Molded Side Without
Equivalence Label • 1295 Features • 998
Equivalence Property Interface Name • Generic Rule Set • 191
1296 Generic Stiffener Extended Geometry • 998
Equivalence Property Value • 1296 Generic Stiffener Landing Curve • 998
Examples of Actions in Scantling Drawing Generic Stiffener Web Left • 999
View Styles • 241 Generic Stiffener with Flange • 999
Exclude • 993 Generic Vertical Dimensions • 700
Exclude with Not Drawn Rule • 994 Geometric Analyzer Module (Properties tab)
Exporting 3D Model Graphics to • 1109, 1510, 1611, 1640
MicroStation • 43 Geometric Analyzers • 1781
Extended Structure Geometry • 996 Get Parts in Range • 276
External Dimension (externalDimension) • Granularity • 1305
1541 Granularity (granularity) • 1543
EXTERNAL_SOURCE • 1082 Graphic Preparation Rules • 959
Graphic Rule - Line Dialog Box • 76
Graphic Rule - Line with Widget Dialog Box
F • 78
Feature Embedded Symbols • 1064 Graphic Rule - Symbol Dialog Box • 82
Feature Source Graphic Rule - VHL Dialog Box • 71
(ISSteelOrderRuleSet.Default) • 232 Graphic Rules • 725
Feature Type • 1297 Graphic Style Dialog Box • 126
FILE • 1082 Graphic Tab (Graphic Style Dialog Box) •
Flow Direction 126
(DrawingFlowDirectionContent) • 1298, Graphics Tab (Graphic Rule - Line with
1827 Widget Dialog Box) • 78
Footing Piers in Plan View Styles • 396 Grid Add-on Rulesets • 291

Drawings and Reports Reference Data Guide 2081


Index

Grid Labels • 829 Horizontal Linear Dimensions with Value


Grid Line • 1004 Replacement
Grid Plane • 1004 (DrawingDimContentLinearH) • 1547,
Group Bubble Label • 1307 1885
Group by Axis (SMDwgGroupByAxisGA) • Horizontal Linear Object Endpoints
1307, 1794 (DrawingPGStructHoriz) • 1547, 1775
Group Clipped Points • 1308 Horizontal Object Anchor
Group Label Clearance • 1309 (DrawingPGAnchorHoriz) • 1549
Group Labels • 753 Horizontal Offset (hOffset) • 1548
Horizontal Offset, Vertical Offset • 1313
H Horizontal Routable Object
(DrawingPGRoutableObjHoriz) • 1549
Hanger and Support Piping Properties • 919 Horizontal Ruler Axis Offset • 1315
Hanger Key Plan Horizontal Ruler Axis Position • 1315
(DrawingHangerLabelContent) • 1830 Horizontal Ruler Axis Style • 1317
Hanger Key Plan Control Point then Horizontal Ruler Axis Tick Mark Length
Support Location Away from View • 1318
(DrawingPGKeyPlanControlPoint) • 1310, Horizontal Ruler Axis Tick Mark Length
1544, 1680, 1736 toward View • 1319
Hangers and Supports Dimensions • 701 Horizontal Ruler Axis Tick Mark Style •
Has Intersection Seam • 277 1320
HELP_ID • 1083 Horizontal Structure Dimensions • 705
HngSup - CAD Detail • 964 How Actions are Applied to a View • 121
HngSup - Cad Details View Style • 489 HS_Property_Interface Sheet • 644
HngSup - End • 964 Hull Lines - Body Plan View • 170
HngSup - End Style2 • 964 Hull Lines and Manufacturing Label Rules •
HngSup - End Style2 View Style • 491 856
HngSup - End View Style • 489 Hull Lines Drawings Rule Set • 196
HngSup - ISO View Style • 493 Hull Lines Source
HngSup - Key Plan • 964 (HullLinesRuleSets.DefaultRuleset) • 198
HngSup - Key Plan View Style • 494 HVAC Drawings Package • 347
HngSup - Side Style2 • 965 HVAC Elevation • 965
HngSup - Side Style2 View Style • 496 HVAC Elevation Package • 348
HngSup - Side View Style • 494 HVAC Elevation View Style • 498
HngSup End_KeyPlan_Coordinate Label • HVAC Isometric • 965
836 HVAC Isometric Package • 349
HngSup HVAC Isometric View Style • 500
End_KeyPlan_Coordinate_KPLabel HVAC Key Plan View Style • 501
Label • 837 HVAC Overall Key Plan • 965
HngSup View Styles • 489 HVAC Overall Key Plan Package • 350
HngSup3View Package • 358 HVAC Overall Key Plan View Style • 502
Holes (MHPGForHoles) • 1545 HVAC Packages • 347
Honor Maximum Offset for Grouping • 1311 HVAC Plan • 966
Honor View Direction • 1312 HVAC Plan Package • 351
Horizontal and Vertical Cable Trays • 704 HVAC Plan View Style • 505
Horizontal Coordinate Dimensions HVAC View Styles • 498
(DrawingCoordDimContLinHNoReplace)
• 1545, 1823
Horizontal Linear Dimensions I
(DrawingDimContLinHNoReplace) • ID • 1320
1546, 1888 Import a Border File and Create a Drawing
Area • 150

Drawings and Reports Reference Data Guide 2082


Index

Import an Existing MicroStation DGN Jog Segment Offset 1 • 1327


Border • 648 Jog Segment Offset 2 • 1328
Incremental (MHIncDimPos) • 1550 Justification • 1330
Incremental (MHIncrementalDimGenerator)
• 1551 K
Inside or Along 2D Curve
(InsideOrAlongCurve2D) • 1321, 1681, Keep Duplicate Labels • 1332
1750 Keep Equal Distance Duplicates
Instrument Drawings Package • 352 (keepEqualDistanceDup) • 1554
Instrument Elevation • 966 Keep Label by Location • 1333
Instrument Elevation Package • 353 Keep Left or Right Duplicate • 1334
Instrument Elevation View Style • 517 Keep Left or Right Duplicate
Instrument Isometric Package • 354 (keepLeftOrRightDup) • 1556
Instrument Isometric View Style • 534 Keep Top or Bottom Duplicate • 1335
Instrument Key Plan View Style • 540 Keep Top or Bottom Duplicate
Instrument Overall Key Plan • 966 (keepTopOrBottomDup) • 1557
Instrument Overall Key Plan Package • 355 Key Plan Drawing Requirements • 375
Instrument Overall Key Plan View Style • Key Plan Style Dialog Box • 140
541 Key Plan View Styles • 373
Instrument Packages • 352 Key Point (DefaultLabelPointGenerator) •
Instrument Plan Package • 356 1338, 1684, 1769
Instrument Plan View Style • 545 Knuckle Action
Instrument View Styles • 517 Label Knuckles • 261
Internal Dimension (internalDimension) • Knuckle Angle Symbol
1552 (ISKnuckleAngleSymbolContent) • 1338,
Interval (interval) • 1554 1684, 1839
Invert Elevation Location • 1324 Knuckle Point Symbol
Is Root Logical Connection • 278 (ISKnucklePointSymbolContent) • 1848
ISDwgEndCutRuleServer • 1844 Knuckle Sloping Direction Symbol
ISDwgMarginLeader • 2054 (ISKnuckleSlopingDirectionSymbolConte
ISDwgProfileEndCutSymbol • 1845 nt) • 1849
ISDwgSlotRuleServer • 1847
Iso PenSpool Package • 357 L
Iso Pipeline Manager Package • 357 Label Definition for Drawings by Rule • 912
Iso Pipeline Package • 357 Label Editor • 922
Iso Spool Manager Package • 357 Label Layer (labelLayer) • 1339, 1620
Iso Spool Package • 357 Label Offset • 1340
ISO Standards in Marine Drawings • 31 Label Offset from Member or Widget • 1341
Iso Stress Package • 358 Label Orientation • 1342
Isogen Isometric Drawing by Query Label Rule Manager • 1099
Packages • 645 Label Rules • 764
Isogen Isometric Drawings by Query • 49 Label Rules in Drawings by Rule • 852
Isogen Isometric Drawings Reference Data Label Rules in Offshore Drawings • 905
• 639 Label Symbol File • 1344, 1621, 1685
Isometrics (by Query) Packages • 357 Label Templates • 786
ISProfilePartThicknessSymbolContent • A - G • 859
1853 H - L • 865
ISProfilePartThicknessSymContent • 1444 Mfg - R • 867
ISRulesetSymbolContent • 1841 Scantling • 872
Ship Structure Plate • 880
J Ship Structure Profile • 883
Jog Segment Offset • 1325 StrMfg - W • 886

Drawings and Reports Reference Data Guide 2083


Index

Label Templates in Drawings by Rule • 859 Logical Connection to Intersection Seam •


Label Templates Overview • 786 1004
Label Type • 1345 Longest Segment
Labels • 740 (DrawingGALongestSegment) • 1366,
Labels Tab (Edit Ruleset View Style Dialog 1807
Box) • 132 Longest Segment Labels • 833
Landing Curve with End Cuts • 729
Launch Dimension Rule Manager M
(Drawings by Rule) • 1504
Launch Dimension Rule Manager Make Drawable • 1004
(Orthographic Drawings) • 1504 Make Drawable Assembly • 1005
Launch Label Rule Manager (Drawings by Make Drawable Simple • 1006
Rule) • 1100 Manufacturing Dimension Rules • 693
Launch Label Rule Manager (Orthographic Manufacturing Margin • 1006
Drawings) • 1099 Manufacturing Margin Symbol
Launch Matchline Rule Manager • 1606 (ISMfgMarginSymbolContent) • 1369,
Launch North Arrow Rule Manager • 1633 1689, 1840
Layout Style Rules in Drawings by Rule • Manufacturing Pin Height Label
302 (SMDwgMfgPinHeightLabelContent) •
Layout Style Rules in Orthographic 1369, 1689, 1867
Drawings • 635 Manufacturing PinJig Drawing Rule Set •
Leader Length • 1346 206
Leader Module (Properties tab) • 1107, Manufacturing PinJig Side View Rule Set •
1610, 1639 222
Leader Modules • 2040 Manufacturing Profile Margin Symbol
Leader Offset • 1348 (SMDwgMfgProfileMarginSymContent) •
Leaders as Clear Space • 1350 1370, 1690, 1868
Level • 278 Manufacturing Profile Plate Location
Line Style • 1358 Symbol (MfgProfilePlateLocSymContent)
Line Styles in Drawings by Rule • 313 • 1860
Linear (DrawingLinearLeader) • 1352, 2063 Manufacturing Profile Sketch Rule Set • 207
Linear Endpoints Manufacturing Shrinkage • 1006
(DrawingGAByOppositePoints) • 1356, Manufacturing Sketch (MfgSketchContent) •
1796 1371, 1842
Linear Object Endpoints (DrawingPGLinear) Manufacturing Sketch Rule Set • 212
• 1357, 1558, 1685, 1773 Manufacturing Template Drawing Rule Sets
Linear Pipe Endpoints • 216
(DrawingPGPipeSegments) • 1357, Manufacturing Templateset Full Scale
1686, 1774 Drawing Rule Set • 219
Local Coordinate System Origin Margin (DrawingGAMarginOnly) • 1559,
(DrawingPGLocalCS) • 1359, 1558, 1814
1686, 1738 Margin (DwgMarginLeaderControl) • 1372,
Local CS Origin with Object Axis 2046
(DrawingPGEquipmentStyle2) • 1360, Margin Definition • 1380
1687, 1734 Margin with Occluded Graphics
LOCATION • 1084 (DrawingGAMarginOnlyWithOccludedGra
Location Curve Ratio • 1362 phics) • 1561, 1786
Location ID • 1362 Marine Dimension Rules • 690
Location Target • 1364 Marine Dimension Templates • 715
Location Target Name • 1365 Marine Linear
Location Target Name (targetName) • 1559 (SMDrawingDimContentLinear) • 1562,
Locations of Drawings and Reports Data • 1866
39 Marking Line Embedded Symbols • 1061

Drawings and Reports Reference Data Guide 2084


Index

Marking Lines Source MHE_Site Plan View Style • 678


(MfgProfileRuleSet.DefaultRuleSet) • 210 MHE_SketchedFeatures • 677
Matchline (DrawingMatchlineContent) • MidPoint (ISMidPointLabelPG) • 1389,
1621, 1835 1567, 1690, 1759
Matchline (DrawingMatchlinePG) • 1623, Migrate Dimension Rules Command • 1723
1770 Migrate Dimension Rules Command
Matchline Drawing Requirements • 933 Overview • 1723
Matchline Layer (matchlineLayer) • 1626 Migrate Dimension Rules Dialog Box • 1724
Matchline Rule Manager • 1606 Migration Activities • 1725
Matchline Rules • 932 MIN • 1085
Material Handling Drawing View Styles • Minimum Diameter • 1390
657 Minimum Dimension Distance
Materials Handling Absolute (minimumDimension) • 1568
(MHDrawingAbsoluteLeader) • 1381, Minimum Offset • 1393
2058 Minimum Offset (minOffset) • 1569
MATH • 1084 Miscellaneous Dimensions • 707
MAX • 1085 Miscellaneous Labels • 834
Maximum Dimension Offset Modify an Existing Border File • 645
(maxDimOffset) • 1563 Modify Label Symbol File • 930
Maximum Offset • 1384 Modify Label XML File • 931
Maximum Offset (maxOffset) • 1564 Modify the Label Template Layer • 117
Maximum Offset for Grouping • 1388 Module-to-Module Compatibilities • 1068
Maximum Pin Height for Deletion • 1388 Molded Conventions for Plate Parts • 240
Maximum Witness Length Move Dimension Text to Outside • 1397
(maxWitnessLength) • 1566
Member Centerline • 1007 N
Member Part • 176
Member Part Source Name Labels (DrawingAbsolute) • 841
(ISSteelOrderRuleSet.Default) • 233 Name Labels (DwgLinearAbsPos) • 845
Mfg PinJig SideView • 177 Name Labels (Name-Elevation-Width) • 847
Mfg Profile Sketch • 179 Name Tab (Edit Ruleset View Style Dialog
Mfg TemplateSet - Full Scale • 181 Box) • 118
Mfg Templateset (Full Scale) Package • 166 Name_None_AV_NL • 839
MfgSketchNameFeaturesGA • 1389, 1787 Name_None_CPM_JL • 840
MHE Plate-Openings View Style • 658 Name_None_M_JL • 840
MHE_Chute System Details • 658 Nearest Pin (ISPinJigPointsOnNearestPin) •
MHE_Chute System Isometric View Style • 1571, 1760
659 No Grouping or Filtering (Default)
MHE_InclinedPlateDimensions View Style • (DefaultLabelGeometricAnalyzer) • 1398,
660 1626, 1691, 1795
MHE_Incremental and Normal Dimensions No Label Content (DrawingNoContent) •
View Style • 661 1399, 1691, 1893
MHE_Member Details • 966 NoFlow Symbol • 1398
MHE_Member Openings • 661 North Arrow (DrawingNArrowContent) •
MHE_Plate Details View Style • 662 1400, 1693, 1891
MHE_Plot Plan View Style • 663 North Arrow Label Rules • 858
MHE_Profile Details View Style • 664 North Arrow Rule Manager • 1633
MHE_ProfileAndData View Style • 665 North Arrow Rules • 934
MHE_ProfileAndData_IdlersNormalToBelt North Arrow Templates • 894
View Style • 667 North Report Template • 1627
MHE_ProfileAssembly_Isometric View Style North Symbol Attribute Name • 1627
• 675 North-East Coordinate Labels • 784
MHE_ProfileAssembly_M View Style • 676 Not Drawn • 730

Drawings and Reports Reference Data Guide 2085


Index

Note (DrawingPGByNote) • 1572, 1741 Overview of Dimension Properties • 1513


Nozzle (DrawingPGNozzleandBrace) • Overview of Label Properties • 1113
1401, 1694, 1774 Overview of Matchline Properties • 1613
Nozzle Orientation Labels • 848 Overview of North Arrow Rule Properties •
Nozzle View Styles • 560 1642
Owned By • 280
O
Object Axis (DrawingGAEquipmentStyle2) • P
1401, 1781 PARENT • 1086
Object Coordinates Parent Parts • 280
(DrawingEquipmentStyle2Content) • Parent Plate • 280
1825 Parse Graphics (parseGraphics) • 1579
Object Corners (DrawingPGObjectCorners) PartOccTestCOMLabelFormat • 919
• 1573, 1742 Penetration Plate (PenPlatePointGenerator)
Object Type • 1405 • 1580, 1777
Occluded Matchline Style Percentage Offset • 1422
(occludedMatchlineStyle) • 1627 Perimeter Offset (perimeterOffset) • 1423,
Offset from Range (overall) • 1574 1580
Offset Label from Widget • 1406 Pin Jig Corners
Only Outside of Object (SMDwgPinJigCornersDistancePG) •
(DwgLeaderInOutsideControl) • 1407, 1581
2044 Pin Jig Seam Offset Label
On-the-Fly Migration (Dimension Rule (SMDPinJigSeamOffsetCM) • 1424,
Manager) • 1727 1694, 1880
Opening • 1007 Pinjig Corners
Opening Action (SMDwgPinjigCornersDistancePG) •
Label with Typicals • 262 1764
Opening Objects Pipe Segment Dimensions
(DrawingPGOpeningObjects) • 1410, (DrawingPipeSegsDimContNoReplace) •
1575, 1743 1895
Opening Source Pipe Segment Dimensions with Value
(ISSteelOrderRuleSet.Default) • 233 Replacement
Opening To X • 1008 (DrawingPipeSegsDimContent) • 1894
Opening Type • 279 Pipe Segments (DrawingGAPipeSegments)
ORDER • 1086 • 1582, 1812
ordinal • 1086 Pipe Segments (DrawingPipeSegmentsCG)
Orientation • 279, 1412 • 1583, 1905
Orientation (orientation) • 1576 Pipe Support Drawings Package • 359
Orientation Angle • 280 Pipe Supports • 967
Orientation Rules in Drawings by Rule • 297 Pipe Supports - Components View Style •
Orthographic (by Query) Packages • 358 564
Orthographic and Key Plan View Styles • Pipe Supports - Piping View Style • 564
370 Pipe Supports - Structure View Style • 565
Orthographic Drawing Packages • 330 Pipe Supports View Styles • 564
Orthographic Drawings by Query • 48 Pipe Turn Feature To Arc • 1010
Orthographic Drawings Reference Data • PipeMfgMapSymbol Sheet • 642
321 PipeMfgRules Sheet • 642
Overall Dimension (overallDimension value) PipeMfgSpoolRule Sheet • 643
• 1578 Piping Drawings Package • 361
Overall Offset (overallOffset) • 1578 Piping Elevation • 967
Override (ISDimensionContentOverride) • Piping Elevation (DrawingBOLabelContent)
1579, 1844 • 1425, 1695, 1819

Drawings and Reports Reference Data Guide 2086


Index

Piping Elevation Package • 362 Draw Non-Target Plates That Split Target
Piping Elevation Style2 View Style • 577 Plate • 249
Piping Elevation View Style • 566 Draw Target Hull Plate Parts • 242
Piping Fire Protection Plan • 967 Draw Target Hull Plates as Non-Target •
Piping Isometric Detail • 967 244
Piping Isometric Detail View Style • 585 Draw Target Light Plates • 245
Piping Isometric Key View Style • 586 Draw Target Plates • 246
Piping Isometric Package • 363 Plate Part Source
Piping Isometric View Style • 579 (ISSteelOrderRuleSet.Default) • 234
Piping Key Plan View Style • 587 Plate Stiffeners Summary Label Template •
Piping Overall Key Plan • 967 903
Piping Overall Key Plan Package • 364 Plate System • 1016
Piping Overall Key Plan View Style • 588 Plate Systems on Hull Source
Piping Packages • 361 (HullLinesRuleSets.DefaultRuleset) • 201
Piping Plan Package • 365 Plate Thickness Symbol
Piping Plan Style2 View Style • 606 (ISPlateThicknessSymbolContent) • 1851
Piping Plan View Style • 591 PlateEdge Source
Piping Safety Shower Plan • 968 (MfgPinJigSideView.Default) • 223
Piping Utility Station Plan • 968 Point at Corner Cut
Piping View Styles • 566 (MHDrawingPGCornerCut) • 1428, 1697,
Place a Manual North Arrow on a Drawing • 1738
112 Point for Profile Sketch Bevel Shape
Place Lines (placeLines) • 1426, 1584 (SMProfileSketchBevelShapeLabelsPG)
Place Lines on Sheet • 1427 • 1431, 1700, 1768
Place Piping Isometric Drawings Point Generator Module (Properties tab) •
Surface-mounted Components • 649 1108, 1509, 1610, 1639
Plane Geometry • 1011 Point Generators • 1730
Plate Angle Symbol Point Location (pointLocation) • 1585
(ISPlateAngleSymbolContent) • 1427, Point Name (filterCriteriaPointName) • 1586
1696, 1850 Point on Remarking Curve along Girth
Plate Anti-Molded Side • 1011 (SM3DDwgRemarkingGirthLengthPG) •
Plate Anti-Molded Side Without Features • 1432, 1701, 1768
1011 Points Along 2D Curve
Plate Both Sides Without Features • 1011 (ISDwgPointsAlongCurve2D) • 1433,
Plate Contour • 1012 1702, 1756
Plate Grid Name Label Points Along 2D Range
(SMDwgPlateGridNameLabelContent) • (ISDwgPointsAlongRange2D) • 1436,
1428, 1697, 1868 1705, 1736
Plate Knuckle Source Points at Manufacturing Sketch Coordinates
(ISSteelOrderRuleSet.Default) • 234 (MfgSketchPG) • 1437, 1586, 1706, 1744
Plate Molded Side • 1013 Points by 2D Shape Type
Plate Molded Side Without Features • 1013 (SMDwgPointsByType) • 1438, 1707,
Plate Molded Surface • 1013 1765
Plate Outer Contour • 1014 Points by Associated Object ID
Plate Part • 1015 (SMPointsByAssociateObjectID) • 1439,
Plate Part Action 1708, 1767
Draw Non-Target Plates Bounded by Points for View (ISDwgPointsForView) •
Target Hull Plate • 243 1440, 1709, 1759
Draw Non-Target Plates Bounded by POPULATE • 1087
Target Plate • 248 Ports Separator • 1017
Draw Non-Target Plates Spit by Target Positioning Module (Properties tab) • 1110,
Plate • 247 1510, 1611, 1640
Positioning Modules • 1905

Drawings and Reports Reference Data Guide 2087


Index

Positioning Point • 1440 Profile Sketch Radial Feature


posModulesSet • 2037 (ISProfileSketchFeatureRadialDimPG) •
POSSIBLE_VALUES • 1087 1591, 1761
Preface • 28 Profile Sketch Web Thickness Symbol
Preserve Text Orientation (SMPSWebThicknessContent) • 1881
(preserveTextOrientation) • 1587 Profile System • 1020
Primary and Secondary Orientation • 281 Profile System Cross Section • 1021
Priority (priority) • 1442, 1589, 1628 Profile System Thickness Symbol
Profile Angle Symbol (ISProfileSysThicknessSymbolContent) •
(ISProfileAngleSymbolContent) • 1444, 1855
1709, 1852 Profile Systems on Hull Source
Profile Cross Section • 1018 (HullLinesRuleSets.DefaultRuleset) • 202
Profile Knuckle As Curve • 1019 Profile Weld Points
Profile Knuckle Source (SMDwgProfileWeldsPG) • 1448, 1711,
(ISSteelOrderRuleSet.Default) • 236 1766
Profile Outline Source ProfileSketchMarkingLineSymbol • 1864
(MfgProfileRuleSet.DefaultRuleSet) • 211 PROGID • 1088
Profile Part • 1019 Properties Tab • 1103, 1608, 1636
Profile Part Action Properties Tab (Dimension Rule Manager) •
Draw and Label Hull Profiles • 249 1506
Draw Edge Reinforcement Profiles • 252
Draw Non-Target Profiles • 253 Q
Draw Target Light Profiles • 250
Draw Target Profiles • 251 Query Tab (Edit Ruleset View Style Dialog
Profile Part Source Box) • 129
(ISSteelOrderRuleSet.Default) • 237
Profile Seam Symbol R
(SMProfileSeamSymbolContent) • 1870 Radial Dimensions
Profile Sketch Bevel Shape Label (DrawingDimContRadNoReplace) • 1890
(SMProfileSketchBevelShapeLabelsCM) Radial Dimensions with Value Replacement
• 1445, 1871 (DrawingDimContentRadial) • 1592, 1887
Profile Sketch Bevel Symbol Radius Offset • 1449
(SMProfileSketchBevelSymbolCM) • RANGE • 1088
1446, 1710, 1872 Range (range) • 1593
Profile Sketch Detail Name Label Range Center • 1022
(SMDwgProfileSketchDetailNameLabelC Range Offset (rangeOffset) • 1594
ontent) • 1446 Range Point • 1450
Profile Sketch Knuckle Label Reference
(SMDwgProfileSketchKnuckleLabelConte (DrawingReferenceLabelContent) • 1451,
nt) • 1447 1712, 1838
Profile Sketch Label Reference Curve Action
(SMDwgProfileSketchLabelsContent) • Draw and Label Reference Curves • 260
1447, 1710, 1881 Reference Curve Source
Profile Sketch Linear Feature (ISSteelOrderRuleSet.Default) • 238
(ISProfileSketchFeatureLinearDimCM) • Reference Curve Source
1590, 1840 (MfgTemplatesetFullScale.DefaultRuleset
Profile Sketch Linear Feature ) • 221
(ISProfileSketchFeatureLinearDimPG) • Reference Labels • 850
1590, 1760 Related Object Exists • 285
Profile Sketch Radial Feature Relation to Target • 286
(ISProfileSketchFeatureRadialDimCM) • Relation to Target Plate • 287
1591, 1841 Relations for Custom Tests • 124

Drawings and Reports Reference Data Guide 2088


Index

Relationships Tab • 1111, 1611, 1641 Seam Action


Relationships Tab (Dimension Rule Draw Seam Symbols on Bounding Plates
Manager) • 1511 • 255
Remarking Girth Length Label Draw Seam Symbols on Target Plates •
(SM3DDwgRemarkingGirthLengthCM) • 254
1452, 1866 Seam Intersection Point Source
Repair Documents Custom Command • 162 (MfgPinJigSideView.Default) • 224
Replace Intersection Seam with Slot Seam Source
Symbol • 731 (ISSteelOrderRuleSet.Default) • 239
Replace Objects with Line • 732 Seam Source
Replace Sloped Pipe On Hanger • 1022 (MfgTemplateRuleSet.DefaultRuleSet) •
Replace With Point • 1024 218
Report Sheet • 652 Seam Source
Report Template • 1452 (MfgTemplatesetFullScale.DefaultRuleset
Reports Reference Data • 651 ) • 221
Reserved Tags • 1094 Seam Symbol (ISSeamSymbolContent) •
Resymbolized by Rule Set • 734 1856
Rotation • 1453 Seams on Hull Source
Route Component Centerline • 1025 (HullLinesRuleSets.DefaultRuleset) • 204
Rule Manager and XML Template Search Folders • 51
Difference • 1095 Search Mode • 1462
Ruler Axis (SMRulerAxisSymbolContent) • Section Size Labels • 851
1455, 1873 Section View Orientation Rules in Drawings
Rulers – Axis • 1026 by Rule • 308
Rulers – Reference Plane • 1026 SectionSimpleReference1 • 920
Ruleset Custom Tests • 263 SectionSimpleReference2 • 920
Run a custom command • 159 Select Border Family Dialog Box • 154
Run Time Query Options • 653 Select Dimension Rule Dialog Box • 85
Select Filter Dialog Box • 143
S Select Graphic Preparation Rule Dialog Box
• 67
Scale Factor Percentage (scaleFactor) • Select Graphic Rule Dialog Box • 68
1460 Select Label Rule Dialog Box • 84
Scantling Label Rules • 853 Select Layout Template Dialog Box • 153
Scantling Near Side or Far Side Direction Select properties for a manufacturing
Symbol sketch source • 215
(SMDwgScantlingNSorFSDirectionConte Select Rule Dialog Box (Label Editor - Unit
nt) • 1461, 1713, 1869 of Measure) • 928
Scantling Near Side or Far Side Symbol Select Template Dialog Box • 150
(SMDwgScantlingNSorFSContent) • Select View Rule Dialog Box • 936
1869 Set up custom layout processor modules •
Scantling Profile Weld_IButt • 938 147
Scantling Profile Weld_IVButt • 939 Sheet Direction • 1465, 1714
Scantling Profile Weld_IXButt • 939 Shell Expansion • 182
Scantling Profile Weld_VButt • 940 Ship Direction Symbol
Scantling Profile Weld_XButt • 940 (ISShipDirectionSymbolContent) • 1463,
Scantling Profile Weld_XButtSM • 941 1714, 1858
Scantling Profile Weld_YButt • 941 ShipParentBlockAndPartName View Label
Scantling Shell Profile Weld Label • 938 Template • 922
Scantling Weld Symbol Shortcut Menus • 40
(DwgScantlingWeld) • 1842 SIBLING and SIBLING_VALUE • 1088
Schema File Types • 1067 Sibling Plates Stiffeners Summary Label
Seam • 1026 Template • 903

Drawings and Reports Reference Data Guide 2089


Index

Side (side) • 1629 Structural Framing Key Plan View Style •


Simple Volume To X • 1027 622
Sloped Pipe With Arc Symbol • 1027 Structural Framing Packages • 366
Slot Embedded Symbols • 1056 Structural Framing Plan • 971
SlotSymbols • 1864 Structural Framing Plan Package • 369
SM_Electrical_Cable_Tray_Elevation • 968 Structural Framing Plan View Styles • 623
SM_Electrical_Cable_Tray_Elevation View Structural Transient Ports • 1040
Style • 457 Structural Widget
SM_Electrical_Cable_Tray_Plan • 968 (StructuralWidgetLabelContent) • 1470,
SM_Electrical_Cable_Tray_Plan View Style 1897
• 455 Structure Margin Dimensions • 710
SM_Equipment_Plan • 969 Structure_Weld • 942
SM_Equipment_Plan View Style • 482 Structure_Weld_Fillet • 949
SM_HVAC_Elevation • 969 Structure_Weld_IButt • 950
SM_HVAC_Elevation View Style • 516 Structure_Weld_IVButt • 950
SM_HVAC_Plan • 970 Structure_Weld_IXButt • 950
SM_HVAC_Plan View Style • 515 Structure_Weld_Tee1 • 952
SM_Lighting_Plan • 970 Structure_Weld_Tee2 • 953
SM_Lighting_Plan View Style • 458 Structure_Weld_Tee3 • 953
SM_Piping_Elevation • 970 Structure_Weld_Tee4 • 954
SM_Piping_Elevation View Style • 609 Structure_Weld_Tee5 • 954
SM_Piping_Plan • 971 Structure_Weld_Tee6 • 955
SM_Piping_Plan View Style • 607 Structure_Weld_Tee7 • 955
SM3D ProfileSketchFeatureSymbol • 1862 Structure_Weld_TeeK • 956
South Report Template • 1630 Structure_Weld_TeeV • 956
South Symbol Attribute Name • 1630 Structure_Weld_TeeX • 957
SP3DCoordinate_BottomLeft_CA_JL • 843 Structure_Weld_TeeY • 957
SP3DCoordinate_TopRight_CA_JL • 844 Structure_Weld_VButt • 951
SP3DDrawingLabelQuery • 1897 Structure_Weld_XButt • 951
Spacing • 1465 Structure_Weld_YButt • 952
Spreadsheet Reports • 51 Style • 1471
Stacked Labels (DwgStackLabelLeader) • Style (dimStyle) • 1595
1466, 2072 Subpriority • 1474
Start Curve Ratio • 1469 Symbol Attribute Name • 1474
Std Member With Flange • 1028 Symbol Definition for Drawings by Rule •
Std Member With Web • 1028 916
Steel Order - Reference Plane (Generic) Symbol Path Label • 1474
View Style • 184 SYMBOL_FILE • 1072
Steel Order - Section and Detail (Generic) Symbols in Orthographic Drawings • 906
Views • 186 System-FluidCode-Seq-Insul_None_CPM_
Steel Order (Generic) • 188 JL • 840
Steel Order Drawing Rule Set • 225
Steel Order Templates • 898 T
Stiffened Plates • 288
Stiffener With Flange • 1029 Template Mid Line Source
Structural Drawings Package • 366 (MfgTemplatesetFullScale.DefaultRuleset
Structural Framing Elevation • 971 ) • 220
Structural Framing Elevation Package • 367 Template Offset (StrMfgTemplateOffsetPG)
Structural Framing Elevation View Style • • 1597, 1778
611 Template Set Full Scale Direction Symbol
Structural Framing Isometric Package • 368 (SMTemplatesetFullScaleDirSymbolCont
Structural Framing Isometric View Style • ent) • 1475, 1716, 1878
621

Drawings and Reports Reference Data Guide 2090


Index

Template Set Offset Vertical Linear Object Endpoints


(StrMfgTemplateSetOffsetPG) • 1598, (DrawingPGStructVert) • 1603, 1776
1779 Vertical Object Anchor
Template Source (DrawingPGAnchorVert) • 1604
(MfgTemplateRuleSet.DefaultRuleSet) • Vertical Offset • 1484
217 Vertical Offset (vOffset) • 1605
Template Source Vertical Routable Dimensions • 711
(MfgTemplatesetFullScale.DefaultRuleset Vertical Ruler Axis Offset • 1484
) • 220 Vertical Ruler Axis Position • 1485
The Management Console, Folders, and Vertical Ruler Axis Style • 1486
Components • 35 Vertical Ruler Axis Tick Mark Length Away
Thickness Direction Symbol from View • 1487
(ThicknessSymContent) • 1879 Vertical Ruler Axis Tick Mark Length toward
Tolerance Angle • 1476 View • 1488
Tolerance Angle for Single Bevel J Weld • Vertical Ruler Axis Tick Mark Style • 1489
1476 Vertical Structure Dimensions • 712
Tolerance Zone • 1477 View Frame Rule Dialog Box • 937
Tools Menu • 55 View Label Rules in Drawings • 918, 935
Top, Bottom, Left, Right • 1477 View Label Rules in Drawings by Rule • 920
Top, Bottom, Left, Right Margin Labels • View Naming Rules in Drawings by Rule •
1478 317
Trench (CivilElevationPointGenerator) • View Rules • 935
1481, 1717, 1745 View Style Properties Dialog Box • 59
Trench (DrawingCivilLabelContent) • 1479, View Style Rules • 57
1821 View Templates • 897
Trench Parts Ports • 1040 ViewNameDirectionScale View Label
Trim Pipe Surface • 1041 Template • 921
Trim Witness (trimWitness) • 1599 ViewTypeDirectionAndScale • 958
TYPE • 1089 Visible Matchline Style
(visibleMatchlineStyle) • 1632
U Visible/Hidden Edges (VHL) • 734
Volume Drawings • 53
Unidirectional Symbol • 1483 Volume Wire Frame • 1041
UOM • 1090
Use Bubble Labels in Drawings • 115
Use Clear Space • 1483 W
Use the Make Clipped Solid Monolithic Web Orientation • 288
Option • 109 Weld (DrawingWeldLeader) • 1490, 2042
User Interface Schema Overview • 1066 Weld (DrawingWeldSymbols) • 1492, 1896
Weld Label Text (DrawingGAWelds) • 1493,
V 1788
Weld Labels • 938
VALUE • 1091 Weld Point (DrawingPGWelds) • 1494,
Vertical Coordinate Dimensions 1719, 1747
(DrawingCoordDimContLinVNoReplace) Weld To Line • 1042
• 1600, 1823 Weld Type • 1497
Vertical Linear Dimensions WeldLabel • 949
(DrawingDimContLinVNoReplace) • WeldSymbol • 958
1601, 1889 West Report Template • 1630
Vertical Linear Dimensions with Value West Symbol Attribute Name • 1630
Replacement What's New in Drawings and Reports
(DrawingDimContentLinearV) • 1602, Reference Data • 28
1886 White Object Layer (whiteObj) • 1631

Drawings and Reports Reference Data Guide 2091


Index

Widget Tab (Graphic Rule - Line with


Widget Dialog Box) • 80

X
XML Structure for Property and Property
Group Definitions • 1073
XML Structure of Compatible Modules •
1069
XML Structure of Module Definitions • 1093
XML Structure of Reserved Symbol Tags •
1095
XML Structure of Reserved Tags • 1094
XML Structure of Supported Properties •
1072
XML_PATH • 1092

Drawings and Reports Reference Data Guide 2092

You might also like