Drawingsand Reports Reference Data Guide
Drawingsand Reports Reference Data Guide
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.
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.
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).
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)
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)
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 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 7462:1985(E) Shipbuilding – Principal ship dimensions. Terminology and definitions for
computer applications
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)
1 - Primary Side Symbol or Primary Side Groove 13 - Secondary Side Pitch or Distance Between the Ends of
Adjacent Welds
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
SECTION 1
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.
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.
In marine mode, the following component is found on the Ship tab of the Add Component
dialog box:
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)
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:
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="&Folder"/>
<Menuitem id="Group1" caption="-"/>
<Menuitem id="Imported Folder" arg1="" action="" accel=""
caption="&Imported Folder"/>
<Menuitem id="Search Folder" arg1="" action="" accel="" caption="My
&Search Folder"/>
</PopupMenu>
</xml>
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.
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.
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.
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.
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.
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.
Setup - Specifies the Filter and Package to query for the Drawings by Query components.
Properties - Displays the Properties dialog box for the component.
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.
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
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.
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.
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:
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.
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.
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
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)
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).
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)
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.
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:
Row Numbers
Display the order of the filters in the table. These numbers make it easier to find filters in the
table.
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
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:
Parallel
Parallel, vertical
Parallel, pointing up
Parallel, pointing down
Parallel, horizontal
Parallel, pointing right
Parallel, pointing left
Parallel, sloped
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.
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.
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.
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)
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.
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.
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)
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.
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.
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.
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
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.
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)
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
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)
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)
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.
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.
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.
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.
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)
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)
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.
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)
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.
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)
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.
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.
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)
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.
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.
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.
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.
13. After defining the drawing view style, click OK to save the settings. The view style is now
ready to use with drawings.
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)
Without using the Visible Fill Style VHL graphic rule option, the drawings of the slabs display
without a fill as follows:
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.
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)
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.
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)
For more information, see Graphic Rule - VHL Dialog Box (on page 71).
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)
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.
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.
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)
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)
You can also place a drawing volume that clips the east side of the wall and slab, as in the
example model.
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.
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.
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)
<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.
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.
The north arrow displays in the view you placed and indicates the north direction.
See Also
View Style Rules (on page 57)
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)
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).
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.
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)
Filter Method
Provides options to either Match All or Match Any objects found by the selected tests.
See Also
Create a Rule Set View Style (on page 135)
Filter Method
Provides options to either Match All or Match Any objects found by the selected tests.
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)
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.
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.
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.
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)
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)
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)
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)
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)
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.
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)
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.
14. Test your view style by creating drawings. You can edit the view styleas needed with Tools
> Define View Style.
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)
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:
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)
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.
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.
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)
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.
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.
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)
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)
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)
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)
6. Type the Prog ID of the custom module as the module name in the layoutstyle.xml file.
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.
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.
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).
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)
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)
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).
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)
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.
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.
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.
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.
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.
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
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.
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.
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.
Template Example
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):
Assembly (Generic)
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)
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).
See Also
Drawings by Rule Reference Data (on page 163)
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.
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.
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
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)
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)
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)
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.
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)
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.
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.
Query
Manufacturing PinJig
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)
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)
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)
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
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
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.
Query
Structural Part or Plane
Positive and negative thicknesses from the view plane - 5 mm
Use expansion
Angle for target evaluation - 20 degrees
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
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)
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
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
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:
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.
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
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).
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.
Example
Typical label, summary labels, and position index numbers on a steel order drawing.
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
AssemblyRuleSets.Default
This rule set is used for assembly drawings showing either the assembly method or assembly
sequence.
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)
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.
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.
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.
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.
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.
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
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.
Custom Tests
See Custom Tests Dialog Box (on page 122).
Condition Values
Condition Values
1 - Forward
2 - Typical transverse grid plane
3 - Transverse Lines
1 - Forward
2 - Typical deck grid plane
3 - Water Lines
1 - Forward
2 - Typical longitudinal grid plane
3 - Buttock Lines
Unknown
Port or Port
Starboard
Starboard
Both
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
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Hull Lines Drawings Rule Set (on page 196)
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
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
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Hull Lines Drawings Rule Set (on page 196)
Custom Tests
See Custom Tests Dialog Box (on page 122).
Condition Values
Port or Port
Starboard
Starboard
Both
Condition Values
OnReference
Unknown
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
Property Values
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Hull Lines Drawings Rule Set (on page 196)
Custom Tests
See Custom Tests Dialog Box (on page 122).
Condition Values
Port or Port
Starboard
Starboard
Both
OnReferenc
e
Unknown
Aft or Aft
Condition Values
Forward Both - Seam lies on both sides
Forward
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
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
See Also
Hull Lines Drawings Rule Set (on page 196)
MfgPinJigRuleSet.Default
This rule set is used for all pin jig drawings.
Plate None
Pin None
Axis None
Area Shape
Frame Shape
Frame Border Style
Frame Behavior
MfgProfileRuleSet.DefaultRuleSet
This rule set is used for all single and multiple profile sketch drawings.
Knuckle Cell
Margin Cell
Draw
3. Frame Shape
4. Frame Border Style
5. Frame Behavior
Custom Test
See Custom Tests Dialog Box (on page 122).
Condition Values
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
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box)
Custom Test
See Custom Tests Dialog Box (on page 122).
Condition Values
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).
Custom Test
See Custom Tests Dialog Box (on page 122).
Condition Values
Condition Values
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).
Custom Test
See Custom Tests Dialog Box (on page 122).
Condition Values
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
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box)
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).
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.
1 - Reports region
and view
2 - Drawing region
and view
Drawing Zones:
3 - Main
4 - Feature Detail
5 - Bevel Detail
MfgTemplateRuleSet.DefaultRuleSet
This rule set is used for single template drawings.
Base Control Source (see "Base Control Source Seam's Side to Draw
(MfgTemplateRuleSet.DefaultRuleSet)" on page 217)
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)
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)
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)
MfgTemplatesetFullScale.DefaultRuleset
This rule set is used for templateset full-scale drawings.
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)
Custom Test
No custom tests are used by the Template Mid Line 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)
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)
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).
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)
MfgPinJigSideView.Default
This rule set is used for PinJig side view drawings.
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)
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)
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)
ISSteelOrderRuleSet.Default
This rule set is used for scantling production (steel order) and classification drawings using both
detailed parts and light (non-detailed) parts.
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.
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.
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.
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.
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.
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
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
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.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
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).
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.
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
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).
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
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
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).
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).
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).
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)
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
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.
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.
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).
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
Property Values
General tab of Graphic Style dialog box: See General Tab (Graphic Style Dialog Box).
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 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).
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).
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
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)
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
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
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
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
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
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:
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
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.
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
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
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.
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.
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
1 - Target
2 - Non-target
- Connection
- Direction of view
Face on Side
A target face connects to a non-target side.
Face on Face
A face has a lapped connection with a face.
Side on Side
A side has an edge connection with a side.
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
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.
The detail box for the bevels is not shown in the drawing.
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.
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.
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.
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.
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.
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
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.
2 Non-target knuckles
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
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:
Parallel
Parallel, vertical
Parallel, pointing up
Parallel, pointing down
Parallel, horizontal
Parallel, pointing right
Parallel, pointing left
Parallel, sloped
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.
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.
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.
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
Example
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.
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
ISGridRuleSets.Default
Source Item Condition
Coordinate System Drawn or Not Drawn. Applied to Grid Lines and Grid Axis
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.
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
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).
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.
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.
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:
See Also
Create Line Styles to Use in Drawing View Styles (on page 89)
+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:
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:
See Also
Create Line Styles to Use in Drawing View Styles (on page 89)
One Document Per Query Creates one document for each query no matter how many
views are created.
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.
One Sheet Per Query Specifies that the number of sheets is controlled by the
number of queries.
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.
Each delivered rule uses a processor DLL that defines how the rule behaves within the software.
Allowed view types Graphical views only Specifies whether the region accepts
Graphical views and graphical views, report views, or both.
reports
Reports only
Draw outline Line style Defines the line style used to draw the
rectangle for the outline for the region.
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.
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
Looking North
Looking East
Looking Aft
Looking Port
For more information, see Orientation Rules in Drawings by Rule (on page 297) in the Drawings
and Reports Reference Data Guide.
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
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.
Default
Default naming convention is applied by the software. For example: View1.
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 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.
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
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)
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 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)
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.
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.
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.
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-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.
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
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.
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
Template Example
Template Example
Template Example
Template Example
Template Example
Template Example
Template Example
Template Example
Template Example
Template Example
Template Example
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
Template Example
Template Example
Template Example
Template Example
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
Template Example
Template Example
Template Example
Template Example
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
Template Example
Template Example
Template Example
Template Example
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
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
Template Example
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
Template Example
Template Example
Template Example
Template Example
Template Example
Template Example
Template Example
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
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.
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.
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
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.
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).
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).
Beams Civil_Beams.xml
Trench Civil_Reference.xml
Block Civil_Foundation.xml
Foundation
Example
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.
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.
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.
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.
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.
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).
Grid Civil_Reference.xml
Systems
KEY_PLAN_ Civil_Reference.xml
ADJACENT_
ELEMENT
Example
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).
Beams Civil_Reference.xml
Braces Civil_Reference.xml
Columns Civil_Reference.xml
Equipment Civil_Equipment.xml
Slabs Civil_Reference.xml
Example
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 braces in a drawing.
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.
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.
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.
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).
Plan_Columns_Vertical.
xml
Trench Civil_Reference.xml
Block Civil_Foundation.xml
Foundation
Trench Civil
Parts Plan_TrenchParts.xml
Example
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 trench in a plan drawing.
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.
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.
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 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.
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.
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).
Beams Electrical
CableTray_Reference.xml
Handrails Electrical_Handrail.xml
Stairs Electrical
CableTray_Stairs_Centerline.
xml
Ladders Electrical
CableTray_Ladders.xml
Examples
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.
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.
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.
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.
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.
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.
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.
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.
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.
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).
Columns Electrical
Beams Electrical
CableTray_Reference.xml
Braces Electrical
CableTray_Reference.xml
Equipment Electrical
Foundation CableTray_Reference.xml
Example
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.
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.
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.
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.
Graphic Rule
This is an example of the graphic representation of footings in an isometric drawing.
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).
Grid Electrical
Systems CableTray_Reference.xml
KEY_PLAN_ Electrical
ADJACENT_ CableTray_Reference.xml
ELEMENT
Example
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).
Columns Electrical
CableTray_Reference.xml
Equipment Electrical
CableTray_Equipment.xml
Slabs Electrical
CableTray_Reference.xml
Example
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.
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.
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.
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).
Beams Electrical
CableTray_Reference.xml
Conduit Electrical
CableTray_Conduit.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
Example
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.
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.
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.
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.
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.
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.
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.
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.
Graphic Rule
This is an example of the graphic representation of conduits in a plan view.
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).
Cableway Electrical
Parts Equipment_Cableways
.xml
Beams Electrical
Equipment_Reference.
xml
Handrails Electrical_Handrail.xml
Stairs Electrical
Equipment_Stairs_Cen
terline.xml
Ladders Electrical
Equipment_Ladders.x
ml
Example
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.
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.
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).
Example
Graphic Rule
This is an example of electrical equipment in an isometric view.
Label Rule
All electrical equipment objects are labeled with the corresponding name from the model.
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).
KEY_PLAN_ADJACEN Electrical
T_ELEMENT Equipment_Reference.xml
Example
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).
Columns Electrical
Equipment_Reference.xml
Electrical Electrical
Equipment Equipment_Equipment.xml
Slabs Electrical
Equipment_Reference.xml
Example
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).
Beams Electrical
Equipment_Reference.xml
Conduit Electrical
Equipment_Conduit.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
Example
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.
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).
Columns Electrical
Instrument_Reference
.xml
Columns Electrical
Instrument_Reference
.xml
Columns Electrical
Instrument_Reference
.xml
Columns Electrical
Instrument_Reference
.xml
Cableway Electrical
Parts Instrument_Cableway
s.xml
Beams Electrical
Instrument_Reference
.xml
Stairs Electrical
Instrument_Stair.xml
Ladders Electrical
Instrument_Ladder.x
ml
Example
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.
Graphic Rule
This is an example of the graphic representation of cable trays in a plan view.
Graphic Rule
This is an example of the graphic representation of piping parts in a plan view.
Graphic Rule
This is an example of the graphic representation of piping in a drawing.
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.
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.
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).
Structure Electrical
Lighting_Reference.xm
l
Example
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.
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).
Equipment SM_
and ElectricalCableTray_
Furnishing Plan_Equipment
Cableway SM_
ElectricalCableTray_
Plan_Instrumentation
Cableway SM_
ElectricalCableTray_
Plan_Others
Cableway SM_
ElectricalCableTray_
Plan_Power
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).
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
CableWay_ SM_
Instrumentation ElectricalCableTray_
Elevation_
Instrumentation
CableWay_ SM_
Others ElectricalCableTray_
Elevation_Others
Cableway SM_
ElectricalCableTray_
Elevation_Power
Cableway SM_
Name_Elevation_
None_JL
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).
Root SM_Lighting_Plan_BH
Longitudinal D
Bulkhead
Plate Systems
Root SM_Lighting_Plan_BH
Transverse D
Bulkhead
Plate Systems
Equipment SM_Lighting_Plan_
Except Equipment
Lighting
Fluorescent SM_Lighting_Plan_
Light Light_Description_
Vert
Lighting SM_Lighting_Plan_
Fixtures Light_Description
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).
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
Example
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.
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.
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.
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.
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 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.
Graphic Rule
This is an example of the graphic representation of a footing in an elevation drawing.
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).
Equipment Equipment_Pipe
Nozzle.xml
Members Equipment_Referenc
e.xml
Equipment Equipment_Referenc
Foundations e.xml
Footings Equipment_Referenc
e.xml
Example
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.
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.
Graphic Rule
This is an example of the graphic representation of members in an isometric drawing.
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).
Grid Equipment_Reference.xm
Systems l
KEY_PLAN_ Equipment_Reference.xm
ADJACENT_ l
ELEMENT
Example
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).
Columns Equipment_Referenc
e.xml
Equipment Equipment_Equipmen
t.xml
Slabs Equipment_Referenc
e.xml
Example
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 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.
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.
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).
Beams Equipment_Columns.xml
Footings Equipment_Reference.xml
Ladders Equipment_Ladders.xml
Lighting Equipment_Reference.xml
Fixtures
Trench Equipment_Reference.xml
Stairs Equipment_Stairs.xml
Example
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.
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.
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).
Root SM_Equipment_Plan_
Longitudinal BHD
Bulkhead
Plate Systems
Root SM_Equipment_Plan_
Transverse BHD
Bulkhead
Plate Systems
Equipment SM_Equipment_Plan_\
and Equipment_Vertical
Furnishing
Ladders SM_Equipment_Plan_
Ladders
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.
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.
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.
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.
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.
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.
Graphic Rule
This is an example of the graphic representation of a trench in a plan drawing.
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).
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).
Support HngSup
Components End_Components
Blue.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.
Support HngSup
Components End_Components
Blue.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).
Standard HngSup
Component ISO_Components
Blue.xml
Cableway HngSup
Parts ISO_CableTray
Reference.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).
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).
Support HngSup
Components Side_Components
Blue.xml
Cableway HngSup
Parts Side_CableTray
Reference.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.
Support HngSup
Components Side_Components
Blue.xml
Cableway HngSup
Parts Side_CableTray
Reference.xml
Weld HngSup_Weld
Component Blue.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).
HVAC HVAC_HVAC.xml
Components
Beams HVAC_Reference.xml
Handrails HVAC_Handrail.xml
Stairs HVAC_Stairs_Centerlin
e.xml
Ladders HVAC_Ladders.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).
Members HVAC_Reference.xml
Footings HVAC_Footings.xml
Ladders HVAC_Ladder.xml
Handrails HVAC_Handrail.xml
Stairs HVAC_Stairs_Centerli
ne.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).
Grid HVAC_Reference.xml
Systems
KEY_PLAN_ HVAC_Reference.xml
ADJACENT_
ELEMENT
Example
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).
Columns HVAC_Reference.xml
Slabs HVAC_Reference.xml
Equipment HVAC_Equipment.xm
l
Example
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 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.
Graphic Rule
This is an example of the graphic representation of equipment in a plan drawing.
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).
HVAC HVAC_HVAC.xml
Components
Beams HVAC_Columns.x
ml
Stairs HVAC_Stairs.xml
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.
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.
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.
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.
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.
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.
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.
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.
Front
Clipped
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).
Root SM_HVAC_Plan_BHD
Longitudinal
Bulkhead
Plate Systems
Root SM_HVAC_Plan_BHD
Transverse
Bulkhead
Plate Systems
Equipment SM_HVAC_Plan_Equi
and pment
Furnishing
Ladders SM_HVAC_Plan_
Ladders
Stairs SM_HVAC_Plan_
Stairs
HVAC SM_HVAC_Plan_
HVAC
Ducts SM_HVAC_Plan_Duct_
Horizontal
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).
Root SM_HVAC_
Longitudinal Elevation_BHD
Bulkhead Plate
Systems
Ladders SM_HVAC_Elevation
_
Ladders
Stairs SM_HVAC_Elevation
_
Stairs
HVAC SM_HVAC_Elevation
_
HVAC
Ducts SM_HVAC_
LinearDuct_
CrossSectionSize
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).
Beams Instrument_Referenc
e.xml
Stairs Instrument_Stair_Ce
nterline.xml
Ladders Instrument_Ladder.x
ml
Handrails Instrument_Handrail.
xml
Example
Graphic Rule
This is an example of the graphic representation of cable trays in an elevation view.
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.
Graphic Rule
This is an example of the graphic representation of a conduit in an elevation view.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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).
Structure Instrument_Reference
.xml
Cableway Instrument_Reference
.xml
Graphic Rule
This is an example of the graphic representation of an Equipment component in an isometric
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 is placed inside the object without a leader.
Graphic Rule
This is an example of the graphic representation of structure in an isometric view.
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.
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.
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).
Grid Instrument_Reference
Systems .xml
KEY_PLAN_ Instrument_Reference
ADJACENT_ .xml
ELEMENT
Example
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).
Columns Instrument_Reference.
xml
Slabs Instrument_Reference.
xml
Equipment Instrument_Equipment.
xml
Example
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 braces in a drawing.
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 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.
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.
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).
Pipe Instrument
Supports Plan_Piping.xml
Cableway Instrument_Cableway
Parts s.xml
Conduit Instrument_Conduit.x
Parts ml
Beams Instrument_Reference
.xml
Stairs Instrument_Stair.xml
Ladders Instrument_Ladder.x
ml
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
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.
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.
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.
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
Front
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 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.
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.
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.
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.
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.
Graphic Rule
This is an example of the graphic representation of piping parts in a plan view.
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).
Equipment Nozzle
Orientation_Equipme
nt.xml
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
Example
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.
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).
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).
Structure Pipe
Supports_Structure.x
ml
Piping Pipe
Supports_Piping.xml
Supports Pipe
Support_Components
.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).
Piping Pipe
Supports_Reference.
xml
Supports Pipe
Supports_Component
s.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).
Beams Piping_Reference.x
ml
Handrails Piping_Handrail.xml
Ladders Piping_Ladders.xml
Stairs Piping_Stairs_Cente
rline.xml
Example
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Columns Piping_Reference.xml
Columns Piping_Reference.xml
Equipment Piping_Equipment.xml
Equipment Piping_Equipment.xml
Beams Piping_Reference.xml
Handrails Piping_Reference.xml
Ladders Piping_Ladders.xml
Stairs Piping_Stairs_Centerline
.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).
Members Piping_Members.xml
Equipment Piping_Foundations.xm
Foundations l
Footings Piping_Foundations.xm
l
Example
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.
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 members in an isometric drawing.
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.
Graphic Rule
This is an example of the graphic representation of footings in an isometric drawing.
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).
Members Piping_Members.xml
Equipment Piping_Foundations.x
Foundations ml
Footings Piping_Foundations.x
ml
Beams Piping_Members_Lin
e.xml
Columns Piping_Members_Lin
e.xml
Process Piping_Process
Vessel Vessel.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).
Grid Piping_Reference.xml
Systems
KEY_PLAN_ Piping_Reference.xml
ADJACENT_
ELEMENT
Example
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).
Columns Piping_Reference.x
ml
Equipment Piping_Equipment.x
ml
Slabs Piping_Reference.x
ml
Example
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.
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 Column in a drawing.
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).
Beams Piping_Beams.xml
Stairs Piping_Stairs.xml
Ladders Piping_Ladders.xml
Example
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
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.
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.
Dimension Rule
Vertical and horizontal dimensions are placed on the equipment components. The equipment is
also dimensioned to nearby columns in the volume.
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.
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.
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.
Graphic Rule
This is an example of the graphic representation of piping parts in a 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.
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
Front
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.
Columns Piping_Reference.xml
Beams Piping_Beams.xml
Stairs Piping_Stairs.xml
Ladders Piping_Ladders.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).
Root SM_Piping_Plan_BHD
Longitudinal
Bulkhead
Plate Systems
Root SM_Piping_Plan_BHD
Transverse
Bulkhead
Plate Systems
Equipment SM_Piping_Plan_
and Equipment
Furnishing
Piping SM_Piping_Plan_
Piping
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).
Root SM_Piping_
Longitudinal Elevation_BHD
Bulkhead Plate
Systems
Piping SM_Piping_Elevation
_
Piping
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
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).
Footings Structural
Framing_Footings
Example
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.
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.
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.
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.
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.
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.
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.
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).
Structure Structural
Framing_Reference.xml
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).
Grid Structural
Systems Framing_Reference.
xml
KEY_PLAN_ Structural
ADJACENT_ Framing_Reference.
ELEMENT xml
Example
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).
Openings Structural
Framing_Openings.xml
Equipment Structural
Foundation Framing_Foundation.x
ml
Footings Structural
Framing_Foundation.x
ml
Ladders Structural
Framing_Ladders.xml
Stairs Structural
Framing_Stairs.xml
Example
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.
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.
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.
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.
Graphic Rule
This is an example of the graphic representation of an opening in a plan drawing.
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.
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.
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.
Eight View
Five View A
Five View B
Four View A
Four View B
Four View C
Four View D
Seven View A
Seven View B
Single View
Six View A
Six View B
Six View C
Six View D
Ten View
Three View A
Three View B
Two View A
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)
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).
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.
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).
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
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
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.
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.
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.
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.
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.
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/).
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).
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.
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.
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)
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 -
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.
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
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).
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).
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).
Profile MHE_Isometric
Parts Profile parts.xml
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).
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).
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).
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).
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).
Conveyor Structural_Wall_El
Belt evation.xml
Equipment MHE-Equipment.x
ml
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).
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).
Conveyor Structural_Wall_
Belt Elevation.xml
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).
MHEBelt MHE_Belt
Single Line
Conveyor Structural_
Belt Wall_Eleva
tion.xml
Plumber Control
Block Point.xml
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).
Profile MHE_Isometric
Parts Profile parts.xml
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).
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).
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).
Conveyor Structural_Wall_
Belt Elevation.xml
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.
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:
ALR_CA_PenetrationPlate ALR_CA_PenetrationPlate
Electrical Electrical
Elevation_CableTray_Anchor_Horizontal Elevation_CableTray_Anchor_Horizontal
Equipment Equipment
Elevation_Columns_Anchor_Horizontal Elevation_Columns_Anchor_Horizontal
Equipment Equipment
Elevation_Equipment_Anchor_Horizontal Elevation_Equipment_Anchor_Horizontal
Equipment Equipment
Elevation_Equipment_Anchor_Vertical Elevation_Equipment_Anchor_Vertical
Instrument Instrument
Elevation_Columns_Anchor_Horizontal Elevation_Columns_Anchor_Horizontal
Instrument Instrument
Elevation_Instruments_Anchor_Horizontal Elevation_Instruments_Anchor_Horizontal
Instrument Instrument
Elevation_Instruments_Anchor_Vertical Elevation_Instruments_Anchor_Vertical
Instrumentation Instrumentation
Elevation_Columns_Anchor_Horizontal Elevation_Columns_Anchor_Horizontal
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 Instrumentation
Plan_Columns_Anchor_Horizontal Plan_Columns_Anchor_Horizontal
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
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.
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
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_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
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 Sketch Feature Contour Dimensions StrMfg Sketch Feature Contour Dimensions
MHE_HolePositioning MHE_HolePositioning
MHE_InclinedPlateDetailsDimensions MHE_InclinedPlateDetailsDimensions
MHE_PlateDetailsDimensions MHE_PlateDetailsDimensions
MHE_PlateIncrementalDimensions MHE_PlateIncrementalDimensions
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
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.
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:
Civil Plan_Columns_Anchor_Horizontal
Electrical Elevation_CableTray_Anchor_Horizontal
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 Plan_Columns_Anchor_Horizontal
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_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
Civil Plan_Columns_Anchor_Vertical
Electrical Elevation_CableTray_Anchor_Vertical
Equipment Elevation_Columns_Anchor_Horizontal
Equipment Plan_Columns_Anchor_Vertical
HVAC Plan_Equipment_Anchor_Vertical
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
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.
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)
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)
Electrical Equipment
Elevation_CableTray_Horizontal
Electrical Equipment
Elevation_CableTray_Vertical
HVAC Elevation_Columns_Horizontal
HVAC Plan_Columns_Horizontal
Electrical Elevation_Columns_Anchor_Horizontal
Electrical Elevation_Columns_Horizontal
HVAC Elevation_Columns_Anchor_Horizontal
Piping Elevation_Columns_Anchor_Horizontal
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)
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).
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.
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
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.
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.
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 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.
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.
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.
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
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.
object and for centerlines in the Centerline aspect. The line style is shown as dashed red 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.
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:
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.
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).
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.
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
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
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.
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
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 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.
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.
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:
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)
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:
<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.
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.
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:
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)
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).
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.
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
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.
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.
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
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 .
Example
For more information on name labels used in view styles, see Equipment in Equipment View
Styles (on page 483).
BopPipePort1_CA_JL1 Name
HngSup_Note Name
HngSup_Piping_Properties Name
Name-Part_Circle_CA_L Name
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_CM_JL Name
Name_Rect_CA_JL Name
Note_Rect_CA_JL Name
PipeComponent_None_CA_JL Name
PipeWeld_None_CA_JL 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:
BopPipePort1_CA_JL BopPipePort1_CA_JL
Civil_TrenchFeature Civil_TrenchFeature
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 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 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 Equipment Plan_Grid Line_X Name Electrical Equipment Plan_Grid Line_X Name
Electrical Equipment Plan_Grid Line_Y Name Electrical Equipment Plan_Grid Line_Y 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 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
Elevation Elevation
EndOfPipeSegment_None_CM_JL EndOfPipeSegment_None_CM_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
Generic_Name_RC_L Generic_Name_RC_L
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_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
HVAC Elevation_Linear Duct Cross Section HVAC Elevation_Linear Duct Cross Section
Size Size
HVAC Isometric_Linear Duct Cross Section HVAC Isometric_Linear Duct Cross Section
Size Size
HVAC Linear Duct Cross Section Size HVAC Linear Duct Cross Section Size
HVAC Plan_Linear Duct Cross Section Size HVAC Plan_Linear Duct Cross Section Size
IS_ProfileSketch_Arial_2.5mm IS_ProfileSketch_Arial_2.5mm
KeyPlanVolume_Name_Rect_A_NL KeyPlanVolume_Name_Rect_A_NL
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
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
Opening Opening
PipeComponent_None_CA_JL PipeComponent_None_CA_JL
PipeWeld_None_CA_JL PipeWeld_None_CA_JL
Piping Plan_Grid Line_X Name Style2 Piping Plan_Grid Line_X Name Style2
Piping Plan_Grid Line_Y Name Style2 Piping Plan_Grid Line_Y Name Style2
Reference_Circle_CA_L Reference_Circle_CA_L
Ruleset_Name Ruleset_Name
Scantling Knuckle Sloping Dir Symbol Scantling Knuckle Sloping Dir Symbol
Scantling Knuckle Sloping Direction Symbol Scantling Knuckle Sloping Direction Symbol
Scantling Shell Profile Weld Label Scantling Shell Profile Weld Label
SectionSize_None_APO_NL SectionSize_None_APO_NL
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 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
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
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_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_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_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
SP3DCoordinate_BottomLeft_CA_JL SP3DCoordinate_BottomLeft_CA_JL
SP3DCoordinate_CA_JL SP3DCoordinate_CA_JL
SP3DCoordinate_TopRight_CA_JL SP3DCoordinate_TopRight_CA_JL
StrMfg PinJig Plate Material Type Grade StrMfg PinJig Plate Material Type Grade
Thickness Thickness
StrMfg PinJig Seam Point Symbol StrMfg PinJig Seam Point Symbol
StrMfg ProfileSketch Bevel Shape 1mm StrMfg ProfileSketch Bevel Shape 1mm
StrMfg ProfileSketch Bevel Shape 2mm StrMfg ProfileSketch Bevel Shape 2mm
StrMfg ProfileSketch Plate Location Symbol StrMfg ProfileSketch Plate Location Symbol
StrMfg Templateset Seam Point Symbol StrMfg Templateset Seam Point Symbol
StrMfg Templateset Tangent Point Symbol StrMfg Templateset Tangent Point Symbol
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 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
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
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)
Example:
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
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:
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:
<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
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.
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
Select False to place the label inside of the matchline boundary as shown in the example
below.
1 - Matchline
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.
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.
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:
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
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).
Display Dimension
Specifies whether to place dimensions as part of the label rule.
Click On to place dimensions as shown in the graphic below.
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.
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
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.
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.
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.
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
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.055 m leaderOffset
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.
Select False to render the leader line visible to other annotations. The software then
attempts to place the leader lines in clear space.
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.
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.
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.
To manually edit the .xml file, specify a positive integer to assign as a priority number for
each annotation.
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.
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>
Maximum Offset
Defines the maximum distance from a connection point that you can place a label.
1 – Maximum Offset
2 – Perimeter Offset
Minimum Offset
Defines the minimum distance from a connection point that you can place a label.
If this filter is set to "*" during label placement, then the system ignores all objects that
are not labels or leaders.
1 - Equipment object
2 - Vertical label
3 - Static control point coordinate label symbol
4 - Horizontal text label
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
Text formatting
Type of property
Value for the symbol
Attributes
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.
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).
For more information on these labels, see Control Points in Plan View Styles (on page 483).
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.
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.
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
Piping Utility Station Plan_Control Point Structure_East Coordinate X1, Y1, Z1, X, Y, Z
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
For more information on grid labels in view styles, see Grid Lines in Plan View Styles (on page
393).
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.
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
GridLineX_Circle_A_L Name
GridLineY_Circle_A_L Name
GridPlane_Name Name
For more information on the longest segment rule in view styles, see Piping Parts in Piping View
Styles (on page 603).
BopPipePort1_CA_JL 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
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)
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)
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).
Example
See Also
Compound Labels (on page 744)
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.
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)
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
For more information on volume names in view styles, see Civil Key Plan View Style (on page
383).
DrawingVolume_Name_Rect_A_NL 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
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.
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.
Vertical Segment
For more information on these labels, see HVAC Parts in HVAC View Styles (on page 511).
Section Size
For more information on these labels, see Structural Framing Plan View Styles (on page 623).
Name_None_APO_NL Name
For more information on name labels used in view styles, see Cable Trays in Elevation View
Styles (on page 404).
Example
For more information on nozzle orientation labels in view styles, see Nozzle View Styles (on
page 560).
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)
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)
HngSup_End_Diamond_M_L None
HngSup_Diamond_M_L None
For more information on section size labels, see Structural Framing Elevation View Style (on
page 611).
Topics
General Label Rules ...................................................................... 852
Scantling Label Rules .................................................................... 853
Hull Lines and Manufacturing Label Rules .................................... 856
North Arrow Label Rules ................................................................ 858
Generic_Name Generic_Name
Generic_Name _L Generic_Name _L
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
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)
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 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)
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)
WeldSymbols WeldSymbols
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
Manufacturing
Label Rule Label Templates used in Rule
(.xml) (.xml)
StrMfg PinJig Seam Point Symbol StrMfg PinJig Seam Point Symbol
StrMfg ProfileSketch Bevel Shape 1mm StrMfg ProfileSketch Bevel Shape 1mm (see
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 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 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 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
StrMfg ProfileSketch Plate Location Symbol StrMfg ProfileSketch Plate Location Symbol
(see "Label Templates: StrMfg - W" on page
886)
NorthArrow NorthArrows\NorthArrow
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 Templates: H - L
The following label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates folder:
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)
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)
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)
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
View Templates
The following label templates are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Labels\Templates\Views folder:
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.
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.
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)
3. Use the Select Tool to draw a fence around the symbol graphics.
4. Click Create Symbol .
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)
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.
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
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)
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.
6. In the Layout section, set up the formatting of the label and insert the property as needed.
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:
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.
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)
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).
SteelOrderSectionandDetailViewRule View Label Rule for Section and Detail Views (ISO 128)
ViewNameScaleRule View Label Rule for Section and Detail Views (ISO 128)
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:
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:
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:
Default View
Displays the name of the view naming rule. For example:
LONGITUDINAL L-2
ShipDirectionRule Right Up
Displays the Right and Up directions of the profile. This rule uses the ShipDirectionRule Right
Up View Label Template.
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
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).
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.
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:
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.
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.
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.
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.
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 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.
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.
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.
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.
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.
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.
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.
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)
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)
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.
Type1
Displays the view direction and view scale. For example:
Looking North
SCALE: Fit To Scale
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)
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)
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)
Weld Labels
Weld labels are used in marine mode drawings.
In This Section
Scantling Shell Profile Weld Label ................................................. 938
Structure_Weld .............................................................................. 942
WeldLabel ...................................................................................... 949
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
Symbol Joint
1 - Gap
Symbol Joint
Symbol Joint
1 - Bevel angle
2 - Molded side
Symbol Joint
Symbol Joint
1 - Reference part
2 - Root gap
3 - Non-reference root gap
4 - Nose
Symbol Joint
Symbol Joint
1 - Reference part
2 - Root gap
3 - Non-reference root gap
4 - Nose
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.
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
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.
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.
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).
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
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.
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.
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.
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.
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
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
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
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
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
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
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
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
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
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
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
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:
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
Civil Elevation
Filter Name Custom Module
Civil Plan
Filter Name Custom Module
Equipment Elevation
Filter Name Custom Module
Equipment Plan
Filter Name Custom Module
HngSup - End
Filter Name Custom Module
HVAC Elevation
Filter Name Custom Module
HVAC Isometric
Filter Name Custom Module
HVAC Plan
Filter Name Custom Module
Instrument Elevation
Filter Name Custom Module
MHE_Member Details
This custom graphic rule is only available when you are using the material handling
mode.
Pipe Supports
Filter Name Custom Module
Piping Elevation
Filter Name Custom Module
Piping Parts equal to or less than 4in NPD-2 Elbow To Arc (on
page 987)
SM_Electrical_Cable_Tray_Elevation
Filter Name Custom Module
Root Transverse Bulkhead Plate Systems Make Drawable (on page 1004)
SM_Electrical_Cable_Tray_Plan
Filter Name Custom Module
Root Transverse Bulkhead Plate Systems Make Drawable (on page 1004)
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)
SM_HVAC_Elevation
Filter Name Custom Module
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)
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)
SM_Piping_Elevation
Filter Name Custom Module
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)
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
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)
To create a view style that resymbolizes pipes of a particular diameter into single lines, follow
the four procedures provided below.
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.
Plan
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)
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.
You can define location offset with respect to the tangent edge on the flanged bracket.
<GRAPHIC Location="0.01"></GRAPHIC>
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.
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.
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:
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 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.
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.
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 graphics output by the view style in the drawing depend on the filters you specify and the
graphic rules applied.
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.
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 output of this drawing excludes the elbows and in-line piping components:
In the View Style Properties dialog box below, Piping is selected as the filter, but another filter
specifies Not Drawn for Piping Components.
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.
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.
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.
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).
On the drawing view, the landing curve of the profile part is drawn:
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"
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>
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.
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.
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.
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.
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).
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.
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:
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.
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.
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.
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.
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).
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).
For a description of plate sides, see Molded Conventions for Plate Parts (on page 240).
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:
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).
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).
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.
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:
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:
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.
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.
On the drawing view, the cross-section of the profile part is drawn at the starting point of the
profile landing curve:
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:
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:
On the drawing view, the cross-section of the profile system is drawn at the starting point of the
profile landing curve:
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.
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).
Piping Plan
Piping Plan
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.
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:
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.
You can use this graphic module when sloped pipe should be represented on a plan drawing.
Looking North
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.
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.
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.
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.
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
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.
I-to-T
Angle
Includes equal and unequal leg angles.
Fabricated angle
Channel
Includes S and M types.
Channel cut
Flat bar
Bulb
Bulb T
Pipe
Includes pipe, tube, and round bar.
Rectangular tube
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.
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
End EndCut_1_Open_Off_
E.sym
End EndCut_1_Closed_
E.sym
End EndCut_1_Open_Off_
Vert_E.sym
End EndCut_2_Open_
Snip
End EndCut_2_Open_E.sym
End EndCut_1_Open_Vert_
E.sym
Any
End EndCut_1_Open_E.sym
End EndCut_Default_E.sym
End EndCut_2_Closed_
E.sym
End EndCut_2_Open_
E.sym
End EndCut_2_Open_
Off_Vert_E.sym
End EndCut_Default_E.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.
</ProfileInfo>
<Symbol>WebCutName.sym</Symbol>
</SymbolInfo>
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.
EdgeFeature EdgeFeature.sym
WaterStop WaterStop.sym
DefaultFeature DefaultFeature.sym
Catalog Symbols
The following catalog symbols are delivered in the [Reference Data
Folder]\SharedContent\Drawings\Catalog\Symbols folder:
For more information, see Embedded Symbol Rules (on page 1043).
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)
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
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)
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>
<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
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:
<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)
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.
See Also
Label Rule Manager (on page 1099)
Appendix: Annotation Rule Manager Customization (on page 1066)
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)
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
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)
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.
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.
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.
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.
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.
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)
0.0 0
0.3 30
0.5 50
1.0 100
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)
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)
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)
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)
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.
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)
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)
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.
<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:
<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.
See Also
POSSIBLE_VALUES (on page 1087)
TYPE (on page 1089)
Label Rule Manager (on page 1099)
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)
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)
Project Nodes
The common modules schema file is divided into the following project type nodes:
SP3D (plant)
SM3D (marine)
MHE (material handling)
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.
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)
Customization Examples
When you create a new module, you must add the module to the schema to use it in the rule
manager.
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.
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
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)
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)
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)
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.
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.
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.
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)
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.
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)
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)
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.
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.
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.
Examples
percentageOffset is 0.5, offsetFromMember is 0.01, and offsetFromWidget is 0:
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.
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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.
Customization
None
Example
<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
Vertical 4
Default 5
Orientation
anchor
The point on the label used for positioning.
XML
value
Treat as Label 0
Treat as Symbol 1
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.
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.
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.
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.
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.
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.
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
Treat as Symbol 1
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.
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.
Customization
None
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.
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.
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.
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.
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.
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
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.
cpLabelType
1 – Equipment object
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.
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.
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.
1 - Equipment object
2 - Elevation label
3 - Static control point
1 - Equipment object
2 - Elevation label
3 - Static control point
Examples
Drawing View:
Although a content module creates the annotation output, this example shows how
this module affects the output.
Clear Allow Acute Breakline Angle to place a breakline with an obtuse angle.
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>
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.
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>
Select False to turn off the leader line if the label is positioned within this distance.
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:
Anchor
The point on the label used for positioning.
XML
value
Treat as Label 0
Treat as Symbol 1
.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.
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.
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.
1 - East label
2 - North Label
Axis Angle
Orientation of the label for the defined side (top, bottom, left, or right).
XML
valu
e
Horizontal 3
Vertical 4
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.
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.
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
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>
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>
Clearance
Specifies the minimum distance separating adjacent labels.
Type the distance in the text box.
1 - Clearance
Customization
None
Customization
granularity
Specifies a portion of the height of a label as the basis for the increment used to find clear
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.
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.
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.
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.
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.
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.
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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
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.
1 - Label Offset
Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.
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
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.
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.
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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.
1 – Maximum Offset
2 – Perimeter Offset
minOffset
Defines the minimum distance from a connection point that you can place a 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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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.
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.
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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.
1 – Maximum Offset
2 – Perimeter Offset
minOffset
Defines the minimum distance from a connection point that you can place a label.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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.
Customization
dimension
Specifies whether to place dimensions as part of the label rule.
dimPerimeterOffset
Determines the offset distance from the dimension to the matchline.
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.
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.
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.
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.
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
justification
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.
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.
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.
<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
Normal In 2
Along
inward
normal
Horizontal 3
Vertical 4
Default 5
Orientation
anchor
The point on the label used for positioning.
XML
value
Treat as Label 0
Treat as Symbol 1
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.
XML value
From Center 0
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
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.
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.
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.
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.
<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
Normal In 2
Along
inward
normal
Horizontal 3
Vertical 4
Default 5
Orientation
anchor
The point on the label used for positioning.
XML
value
Treat as Label 0
Treat as Symbol 1
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.
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.
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
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.
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
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.
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.
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
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
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.
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
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
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.
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.
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.
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.
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.
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).
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.
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.
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.
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).
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.
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.
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.
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
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.
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).
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.
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.
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.
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.
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.
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).
1 - Maximum Offset
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.
Customization
rOffset
Determines the distance between a nozzle port and the label annotating the port.
labelType
1 - Nozzle
2 - Top of Equipment/Bottom of Equipment
3 - Angle
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.
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
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.
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.
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.
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.
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)
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>
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.
Enclose any of the above values within the following .xml tags.
<cpLabelType>0</cpLabelType>
Customization
None
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
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.
Customization
breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line 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 .
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.
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.
Default (DefaultLabelControlGenerator)
Currently used by all label templates. Generates a label control for each label that is used to run
the positioning modules.
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
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.
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
1 - Empty 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:
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):
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.
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, 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.
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.
ignoreLeaderCrossings
Renders the leader line of a label as invisible to other annotations.
Type -1 to allow leader lines and other annotations to intersect.
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.
Customization
None
Customization
None
Example
The software places profile mounting angle and profile thickness labels (circled in red) using
points created by ISRulesetPointGenerator.
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>
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.
The following two examples demonstrate two cases of the Dimension Style property using the
ISO and JIS styles, respectively.
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.
<style>ANSI</style>
You can use SmartSketch Drawing Editor to create your own styles.
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
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.
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.
Display Dimension
Specifies whether to place dimensions as part of the label rule.
Select On to place dimensions.
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>
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.
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).
Customization
None
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.
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.
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.
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 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.
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>
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.
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.
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.
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.
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)
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.
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.
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.
Customization
unidirectionalSymbol
1 - Pipe
2 - Unidirectional Symbol
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
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
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.
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
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>
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.
Customization
Assembly value
Specifies the name of the geometric analyzer to use.
Customization
Assembly value
Specifies the name of the content module to use.
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.
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.
Enclose any of the above values within the following .xml tags.
<granularity>1</granularity>
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.
Customization
None
Example
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)
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.
Customization
None
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>
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
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>
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>
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)
Bottom
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.
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)
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>
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>
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.
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.
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.
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.
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.
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>
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 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>
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 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
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>
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
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>
XML
value
Keep default 0
Keep none 4
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>
1 - Equipment object
2 -Labeled East coordinate
point
3 - North coordinate point
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>
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
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.
1 - Equipment object
2 - Label
3 - Text Box Properties dialog box specifying the
layer on which the label resides
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)
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.
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
Normal In 2
Along
inward
normal
Horizontal 3
Vertical 4
Default 5
Orientation
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).
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.
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
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>
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.
Select False to render the leader line as visible to other annotations. The software then
attempts to place the leader lines in clear space.
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.
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.
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.
Type -1 to place a leader 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.
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.
Customization
None
Customization
None
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
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.
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)
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>
1 - Label
2 - Point for labeling
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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.
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.
The possible values for Location ID when using the Profile Weld Point point
generator are limited to Top, Bottom, or Middle.
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.
Longest curve 2
Places points on the first
longest curve of the 2D
representation of the 3D
object.
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>
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.
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)
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.
<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.
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.
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.
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
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.
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.
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.
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.
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.
Examples
In the following example, leaderOffset is not enabled.
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.
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>
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.
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.
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
1 – Maximum Offset
2 – Perimeter Offset
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>
MfgSketchNameFeaturesGA
Gathers clusters of points for both horizontal and vertical dimensioning.
Customization
Assembly value
Specifies the name of the geometric analyzer to use.
MidPoint (ISMidPointLabelPG)
Places a label point on the 2D curves representing a 3D object at the center of the range box of
the object.
Customization
None
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.
1 - 0.508 m pipe
No minDiameter value. The software draws flow arrows for all pipe sizes
minDiameter = 0.2; the software does not draw flow arrows for pipes
below 200 mm diameter
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.
1 - Minimum Offset
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).
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:
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>
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.
1 - Pipe
2 - NoFlow Symbol
1 - Error label
1 - Empty label
Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
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.
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.
Customization
None
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.
1 – Label
2 – Point closest to the matchline
3 – Equipment object
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.
Examples
placeLines is -1 and deDuplicateLables is -1:
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
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>
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>
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.
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.
1 - Dimension points
2 - Rectangular opening
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
Slot. The software generates points at the ends of each arc. The arc angle must be 180
degrees.
1 - Dimension points
2 - Slotted opening
Customization
None
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.
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.
Longitudinal places the leader line of the label along the major, or longer, axis of the object
that you are labeling.
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.
The following image shows the Orientation property with two separate label templates,
Right and Bottom, applied.
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.
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
Enclose any of the above values within the following .xml tags.
<orientation>1</orientation>
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.
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>
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)
Customization
Side
The side of the curve that can be used to locate the label. Select Left or Right.
1 - Left
2 - Right
1 - Error label
1 - Empty 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
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:
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.
Customization
None
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.
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.
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.
Customization
None
Customization
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).
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.
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.
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.
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
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.
Customization
ObjectType
Specifies the 2D shape.
Point
Circle
Rectangle
Line
Line String
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.
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.
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.
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.
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.
For more information about connect points, see Connect Point (on page 1257).
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
<content>
<contentModule value="ISProfilePartThicknessSymContent" />
<contentModuleSettings>
</contentModuleSettings>
</content>
Example:
Customization
None
Example
Customization
None
Example
Customization
None
Customization
None
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.
Customization
location ID
XML
value
Middle 1
Top 7
Bottom 8
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.
Radius Offset
Determines the distance between a nozzle port and the label annotating the port.
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.
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
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
1 - Empty 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.
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)
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.
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>
Customization
axisInfo
Contains options for axis graphics.
tickMarkInfo
Contains options for tick mark graphics.
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.
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
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.
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)
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.
Search Mode
Defines the starting point and search method for the clear space search along the 2D curve.
XML value
From Center 0
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
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:
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
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>
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
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.
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.
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.
To manually edit the .xml file, enclose the ratio within the following .xml tags.
<startCurveRatio>0</startCurveRatio>
Customization
None
Example
Volume in the model used to create a drawing view:
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.
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.
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.
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.
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
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>
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>
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.
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.
1 - Top
2 - Bottom
3 - Left
4 - Right
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
1 - Empty label
<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
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.
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.
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.
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
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 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)
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.
<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.
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)
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.
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>
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)
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.
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.
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
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.
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.
Customization
None
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.
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.
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.
Weld Type
Specifies a weld type as defined in the catalog.
1 - Gap
ButtWeld2, ButtWeldY
Symbol Joint
1 - Reference part
2 - Root gap
3 - Non-reference root gap
4 - Nose
1 - Reference part
2 - Root gap
3 - Non-reference root gap
4 - Nose
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
TeeWeld1
Symbol Joint
TeeWeld2
Symbol Joint
TeeWeld3
Symbol Joint
TeeWeld4
Symbol Joint
TeeWeld5
Symbol Joint
TeeWeld6
Symbol Joint
TeeWeld7
Symbol Joint
TeeWeldK
Symbol Joint
TeeWeldV
Symbol Joint
TeeWeldX
Symbol Joint
TeeWeldY
Symbol Joint
ButtDemarcation, TeeDemarcation
The Scantling Weld Symbol (DwgScantlingWeld) content module uses the Weld
Type property.
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.
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 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.
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)
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)
See Also
Label Rule Manager (on page 1099)
Dimension Rule Manager (on page 1503)
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)
Customization
None
Customization
None
1 - hOffset distance
2 - Dimension
1 - vOffset distance
2 - Dimension
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.
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.
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.
Select Off to place absolute positioned dimensions or to suppress aligned dimensions. This
is the default behavior.
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>
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.
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
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).
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.
Customization
None
targetName = ProfileWeb
1 - Points for dimensioning
Customization
None
1 - Minimum offset
2 - Maximum offset
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.
1 - Minimum offset
2 - Maximum offset
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.
1 - Minimum offset
2 - Maximum offset
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.
1 - Minimum offset
2 - Maximum offset
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.
1 - Minimum offset
2 - Maximum offset
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.
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
Customization
None
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
Based on the point name specified, the respective points are grouped.
Coordinate (DrawingCoordDimGenerator)
Generates coordinate, angular, and radial dimension content in horizontal and vertical
directions.
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
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.
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.
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
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.
Customization
None
Example
The software places profile mounting angle and profile thickness labels (circled in red) using
points created by ISRulesetPointGenerator.
1 - Dimension on layer D
1 - Equipment
2 - Columns
3 - Horizontal dimensions
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>
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>
1 - Equipment
2 - Columns
3 - Vertical dimensions
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).
Customization
None
1 - Plate
2 - Dimensioning points
3 - Edge dimensions
Customization
None
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.
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>
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>
1 - Dimension
2 - Equipment
3 - Support origin
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
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
Customization
None
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.
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.
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.
Customization
None
1 - Horizontal offset
2 - Dimension
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
1 - Piping
2 - Points for dimensions
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
Customization
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.
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
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.
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.
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).
Interval (interval)
Sets an interval value (in meters) for placing the template points.
Customization
None
1 - Left duplicate
2 - Right duplicate
Customization
None
1 - Top duplicate
2 - Bottom duplicate
Customization
None
1 - Structural member
2 - Endpoints
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
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.
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.
Customization
None
<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.
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>
Below dimension points - the distance between the dimension line and the lowest point in
the chain.
To the left of dimension points - the distance between the dimension point and the
left-most point in the dimension chain.
<maxOffset>0.1</maxOffset>
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.
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.
Customization
None
1 - Dimension
2 - Distance less than minimum dimension
3 - Smaller dimension (2) absorbed by larger dimension (3)
on the left
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>
Below dimension points - the distance between the dimension line and the lowest point in
the chain.
To the left of dimension points - the distance between the dimension point and the
left-most point in the dimension chain.
Customization
None
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.
Customization
None
1 - Object
2 - Points at corners of range box
Customization
None
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)
1 - Dimension points
2 - Rectangular opening
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
Slot. The software generates points at the ends of each arc. The arc angle must be 180
degrees.
1 - Dimension points
2 - Slotted opening
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
1 - Top
2 - Bottom
3 - Left
4 - Right
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" />
1 - Overall dimension
2 - Offset distance
The software interprets the value that you type as paper space units and not model space
units.
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.
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.
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)
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>
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
horiz
Places dimensions that measure horizontal distances on the drawing sheet.
vert
Places dimensions that measure vertical distances on the drawing sheet.
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.
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.
1 - Equipment object
2 - Lines
If you select Off, the software does not place a separate line through multiple aligned
objects.
1 - Equipment object
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>
1 - Top
2 - Center
3 - Bottom
Enclose one of the above options within the following .xml tags:
<pointLocation>Center</pointLocation>
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.
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>
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.
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>
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.
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.
<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.
1 - Dimensioning point
Customization
None
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.
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)
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>
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.
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.
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.
SMDrawingDimContentLinear
MHAlignedDimContModule
To manually edit the .xml file, enclose the dimension style within the following xml tags.
<dimStyle>ISO</dimstyle>
Customization
interval
Sets an interval value (in meters) for placing the template points.
Customization
interval
Sets an interval value (in meters) for placing the template points.
1 - Object
2 - Dimension
3 - Drawing view edge
Select False to allow the dimension lines to continue into the view.
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>
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.
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.
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.
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.
Customization
None
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
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>
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.
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.
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)
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)
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)
Customization
None
See Also
Positioning Module (Properties tab) (on page 1611)
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.
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)
Default (DefaultLabelControlGenerator)
Currently used by all label templates. Generates a label control for each label that is used to run
the positioning modules.
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
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.
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>
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.
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.
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)
1 - Equipment object
2 - Label
3 - Text Box Properties dialog box specifying the
layer on which the label resides
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).
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
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).
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
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:
A matchline label displays on the top side of the subject volume because part of the adjacent
drawing volume is within the include range.
Example 2
The following shows a drawing volume outside of the include range:
A drawing limit label displays on the top side of the subject volume because the adjacent
drawing volume is not within the include range.
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)
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)
Customization
None
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
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.
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)
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.
For more information about connect points, see Connect Point (on page 1257).
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>
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.
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.
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>
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)
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.
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.
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
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.
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)
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)
Customization
None
Example
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.
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.
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.
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.
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.
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.
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.
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.
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.
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).
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.
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.
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.
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.
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).
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.
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.
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.
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
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.
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).
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.
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.
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.
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.
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.
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).
Customization
None
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
Default (DefaultLabelControlGenerator)
Currently used by all label templates. Generates a label control for each label that is used to run
the positioning modules.
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
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.
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
1 - Empty 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:
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):
Customization
None
Example
The software places profile mounting angle and profile thickness labels (circled in red) using
points created by ISRulesetPointGenerator.
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.
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>
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.
Customization
None
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.
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.
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.
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
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.
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).
Customization
None
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
1 - Label
2 - Point for labeling
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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.
<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.
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.
Customization
None
Customization
None
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
1 - Error label
1 - Empty label
Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the 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. Type 0 to display the label regardless of
an error.
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.
Customization
None
Customization
Side
The side of the curve that can be used to locate the label. Select Left or Right.
1 - Left
2 - Right
1 - Error label
1 - Empty 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
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.
Customization
None
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.
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.
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.
Customization
None
Customization
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).
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.
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.
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.
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
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.
Customization
ObjectType
Specifies the 2D shape.
Point
Circle
Rectangle
Line
Line String
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.
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.
Customization
None
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.
Customization
None
Example
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.
Customization
location ID
XML
value
Middle 1
Top 7
Bottom 8
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.
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
1 - Empty 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.
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.
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
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:
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
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.
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.
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.
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.
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.
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.
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)
For more information about this dialog box, see Migrate Dimension Rules Dialog Box (on page
1724).
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)
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:
<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
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.
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:
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).
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.
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
Customization
None
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
Customization
None
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
1 - Dimension
2 - Equipment
3 - Support origin
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
</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
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
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.
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.
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.
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.
Customization
None
1 - Object
2 - Points at corners of range box
Customization
None
1 - Dimension points
2 - Rectangular opening
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
Slot. The software generates points at the ends of each arc. The arc angle must be 180
degrees.
1 - Dimension points
2 - Slotted opening
Customization
None
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.
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.
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.
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.
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.
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.
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.
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.
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.
Customization
None
Example
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.
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.
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.
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.
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.
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.
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.
Customization
None
Customization
None
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.
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.
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.
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.
Customization
None
Example
The software places profile mounting angle and profile thickness labels (circled in red) using
points created by ISRulesetPointGenerator.
Customization
None
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
ObjectType
Specifies the 2D shape.
Point
Circle
Rectangle
Line
Line String
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.
Customization
location ID
XML
value
Middle 1
Top 7
Bottom 8
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.
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.
Customization
None
Customization
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).
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
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:
A matchline label displays on the top side of the subject volume because part of the adjacent
drawing volume is within the include range.
Example 2
The following shows a drawing volume outside of the include range:
A drawing limit label displays on the top side of the subject volume because the adjacent
drawing volume is not within the include range.
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)
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).
Customization
Yes
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
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.
Customization
None
Customization
None
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
interval
Sets an interval value (in meters) for placing the template points.
Customization
interval
Sets an interval value (in meters) for placing the template points.
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
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.
1 – Label
2 – Point closest to the matchline
3 – Equipment object
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.
Examples
placeLines is -1 and deDuplicateLables is -1:
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
Assembly value
Specifies the name of the geometric analyzer to use.
MfgSketchNameFeaturesGA
Gathers clusters of points for both horizontal and vertical dimensioning.
Customization
Assembly value
Specifies the name of the geometric analyzer to use.
Customization
None
Customization
None
Examples
Although a content module creates the annotation output, this example shows how
this module affects the output.
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.
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.
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 none 4
Customization
None
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.
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.
Customization
None
Example
Customization
None
Example
Although a content module creates the annotation output, this example shows how
this module affects the output.
Customization
None
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.
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.
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.
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)
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).
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.
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
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.
cpLabelType
1 – Equipment object
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.
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.
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.
1 - Equipment object
2 - Elevation label
3 - Static control point
1 - Equipment object
2 - Elevation label
3 - Static control point
Examples
Drawing View:
Although a content module creates the annotation output, this example shows how
this module affects the output.
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.
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)
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.
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).
Customization
Yes
Examples
Although a content module creates the annotation output, this example shows how
this module affects the output.
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.
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
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).
Customization
None
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
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.
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
1 - Error label
1 - Empty 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
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
1 - Empty 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
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.
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.
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).
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
1 - Empty label
For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).
Example
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
1 - Empty label
For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).
Customization
unidirectionalSymbol
1 - Pipe
2 - Unidirectional Symbol
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
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
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.
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
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
1 - Empty 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:
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):
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).
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
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).
DrawingOrientToY0Content
Orients label content to the Y0 grid of the coordinate system. This module is used by the
OffCenterline 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
1 - Empty label
For more information, see Examples in Default (DrawingLabelHelper) (on page 1268).
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
1 - Empty 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.
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.
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.
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.
<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
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.
<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
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.
Customization
None
Example
ISDwgEndCutRuleServer
Receives profile and end cut geometry from an end cut content module, and returns the
appropriate end cut symbol.
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).
<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.
1 - Start
2 - End
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.
<contentModuleSettings>
.....
</contentModuleSettings>
</content>
</label>
Customization
None
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
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
Examples
Sloped on one side:
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.
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
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
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.
ISProfilePartThicknessSymbolContent
Creates a profile thickness direction symbol for a profile part based on profile cross-section,
thickness direction, and flange direction.
Customization
symbolInfo
Contains options for the thickness symbol.
profileInfo
Contains options for the 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.
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
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.
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.
Customization
symbolInfo
Contains options for the seam symbol.
Examples
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:
<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>
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.
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.
</symbolInfo>
<symbolInfo>
<FeatureInfo>
<FeatureType>Any</FeatureType>
</FeatureInfo>
<symbol>DefaultFeature.sym</symbol>
</symbolInfo>
</contentModuleSettings>
</content>
</label>
Customization
symbolInfo, FeatureInfo, symbol
Example
ProfileSketchMarkingLineSymbol
Places appropriate marking symbol for a given type of marking line.
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.
<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).
CollarSide is used to define a SlotType, but the collar geometry may not be defined in the
symbol file.
Example
Customization
None
<dimensionContentModules>
<horiz>SMDrawingDimContentLinear</horiz>
<vert>SMDrawingDimContentLinear</vert>
<preserveTextOrientation>0</preserveTextOrientation>
<dimStyle>ANSI</dimStyle>
<dimLayer>???</dimLayer>
</dimensionContentModules>
Customization
None
Example
<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.
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.
Customization
None
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.
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.
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.
Customization
None
Example
Customization
None
Example
Customization
axisInfo
Contains options for axis graphics.
tickMarkInfo
Contains options for tick mark graphics.
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.
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
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.
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)
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
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
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
Customization
Side
The side of the curve that can be used to locate the label. Select Left or Right.
1 - Left
2 - Right
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.
Customization
directionSymbols
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.
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
1 - Empty 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
1 - Empty 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
1 - Empty 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
1 - Empty 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
1 - Empty label
Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
1 - Error label
1 - Empty label
Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
1 - Error label
1 - Empty label
Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
1 - Error label
1 - Empty label
Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the label.
1 - Error label
1 - Empty label
Example
1 - Error label
1 - Empty label
Customization
ignoreError
Specifies whether or not the system places a label if the software returns no content or an
error for the 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
1 - Empty 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
1 - Empty label
Weld (DrawingWeldSymbols)
Determines what weld symbols to place on a drawing
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.
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
Customization
None
Example
Volume in the model used to create a drawing view:
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.
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.
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.
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.
Default (DefaultLabelControlGenerator)
Currently used by all label templates. Generates a label control for each label that is used to run
the positioning modules.
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
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.
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
1 - hOffset distance
2 - Dimension
1 - vOffset distance
2 - Dimension
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.
1 - Minimum offset
2 - Maximum offset
Customization
granularity
Specifies a portion of the height of a dimension value as the basis for the increment used to
1 - Minimum offset
2 - Maximum offset
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.
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.
1 - Minimum offset
2 - Maximum offset
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.
1 - Minimum offset
2 - Maximum offset
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.
1 - Maximum Offset
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.
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.
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.
<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
anchor
The point on the label used for positioning.
XML
value
Treat as Label 0
Treat as Symbol 1
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.
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.
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.
<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
Normal In 2
Along
inward
normal
Horizontal 3
Vertical 4
Default 5
Orientation
anchor
The point on the label used for positioning.
XML
value
Treat as Label 0
Treat as Symbol 1
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.
XML value
From Center 0
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
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.
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.
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.
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.
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
Normal In 2
Along
inward
normal
Horizontal 3
Vertical 4
Default 5
Orientation
anchor
The point on the label used for positioning.
XML
value
Treat as Label 0
Treat as Symbol 1
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.
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.
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
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.
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
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.
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.
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.
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.
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.
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
Treat as Symbol 1
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.
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.
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.
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
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
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.
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
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
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
Customization
rOffset
Determines the distance between a nozzle port and the label annotating the port.
labelType
1 - Nozzle
2 - Top of Equipment/Bottom of Equipment
3 - Angle
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.
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
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.
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.
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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
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.
1 - Label Offset
Specify both the horizontal and vertical distances within which to place the label. Both
distances must be the same.
Customization
hOffset, vOffset
Customization
minOffset, maxOffset
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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.
1 – Maximum Offset
2 – Perimeter Offset
minOffset
Defines the minimum distance from a connection point that you can place a 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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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.
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.
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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.
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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.
1 – Maximum Offset
2 – Perimeter Offset
minOffset
Defines the minimum distance from a connection point that you can place a label.
Manual .xml edits depend on the module that you use, as follows.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
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.
Customization
None
See Also
Positioning Module (Properties tab) (on page 1611)
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.
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.
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.
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.
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.
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).
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.
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.
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.
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.
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.
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).
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.
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.
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.
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
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.
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).
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.
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.
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.
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.
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).
Customization
None
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.
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
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.
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.
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.
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.
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.
Examples
percentageOffset is 0.5, offsetFromMember is 0.01, and offsetFromWidget is 0:
Customization
None
Customization
dimension
Specifies whether to place dimensions as part of the label rule.
Type -1 to place dimensions.
dimPerimeterOffset
Determines the offset distance from the dimension to the matchline.
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.
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.
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.
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.
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.
Absolute XY Offset 1 Up
2 Down
3 Left
4 Right
2 Bottom
3 Left
4 Right
1 Vertical
4 Right
2 Bottom
3 Left
4 Right
2 Bottom
1 Top
2 Bottom
3 Left
4 Right
6 Transversal
justification
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.
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.
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.
posModulesSet
Provides keypoint settings used by positioning modules.
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.
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.
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.
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
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.
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.
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.
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.
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.
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.
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.
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
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.
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.
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.
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.
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.
Examples
In the following example, leaderOffset is not enabled.
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.
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
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.
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.
1 - jogLength
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.
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.
Customization
breakline
Controls whether or not a breakline appears for the label. The breakline normally connects
the leader line 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 .
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.
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.
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.
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.
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.
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.
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.
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, 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.
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.
ignoreLeaderCrossings
Renders the leader line of a label as invisible to other annotations.
Type -1 to allow leader lines and other annotations to intersect.
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
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.
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.
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
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
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