Professional Documents
Culture Documents
User’s Guide
Including software, file formats, and visual displays; may be used pursuant to applicable software license
agreement; contains confidential and proprietary information of 3DS which is protected by copyright and
trade secret law and may not be provided or otherwise made available without authorization.
Use, duplication, or disclosure by the government is subject to restrictions as set forth in subparagraph (c)
(1) (ii) of The Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 or
subparagraphs (c) (1) and (2) of Commercial Computer Software - Restricted Rights at 48 CFR 52.227-
19, as applicable.
Warranties
All warranties given by 3DS about software is set forth in your purchase contract, and nothing stated in, or
implied by, this document or its contents shall be considered or deemed a modification or amendment of
such warranties.
In the interest of continuous development, the information and the software discussed in this document
are subject to change without notice and should not be considered commitments by 3DS. 3DS assumes
no responsibility for any error that may appear in this
document.
The software discussed in this document is furnished under a license and may be used or copied only in
accordance with the terms of this license.
Trademarks
Intergraph, the Intergraph logo, CADWorx, PDS, SmartPlant, FrameWorks, ISOGEN, SmartSketch are
trademarks or registered trademarks of Intergraph Corporation or its subsidiaries in the United States and
other countries. Microsoft and Windows are registered trademarks of Microsoft Corporation. Oracle is a
registered trademark of Oracle Corporation and/or its affiliates. MicroStation is a registered trademark of
Bentley Systems Inc, all rights reserved. Other brands and product names are trademarks of their
respective owners.
Winner of the 1990 “Computer Art Contest” Engineering and Construction category
Intergraph Graphics User Group (IGUG) - Huntsville, Alabama
Contents ........................................................................................................................................................ 3
Preface .......................................................................................................................................................... 7
Technical Support ...................................................................................................................................... 7
What’s New in OrthoGen ........................................................................................................................... 8
Installation ................................................................................................................................................... 10
OrthoGen System Requirements ............................................................................................................ 10
OrthoGen Installation............................................................................................................................... 13
Delivered View Styles .............................................................................................................................. 17
Trouble Shooting ..................................................................................................................................... 17
Overview ..................................................................................................................................................... 18
3D Plant Design Systems ........................................................................................................................ 18
CAD Systems .......................................................................................................................................... 18
Paper Space ............................................................................................................................................ 18
Model Space ............................................................................................................................................ 18
Quick Start................................................................................................................................................... 19
Annotate a “Layout” in 4 steps ................................................................................................................ 19
CADWorx Interface ..................................................................................................................................... 21
Model and Entities ................................................................................................................................... 21
Data Generation – Xdata Reader ............................................................................................................ 21
CADWorx Structure Grid Models ............................................................................................................ 21
User Defined Grid Models ....................................................................................................................... 22
ISOGEN Supplementals .......................................................................................................................... 22
Paper Space Drawings and Views .............................................................................................................. 23
Composition ............................................................................................................................................. 23
Folder Structure ....................................................................................................................................... 23
Active Layout - Viewports ........................................................................................................................ 23
Borders - Frames ..................................................................................................................................... 24
CAD File Units ......................................................................................................................................... 24
Drawing Composition Considerations ..................................................................................................... 24
Composite Annotation – (Multiple Passes) ............................................................................................. 24
Rotated Views ......................................................................................................................................... 25
OrthoGen View Manager ............................................................................................................................ 28
Model Data Sets ...................................................................................................................................... 28
Starting View Manager ............................................................................................................................ 28
View Manager Interface........................................................................................................................... 29
Manage Views ......................................................................................................................................... 29
View Volume Limits ................................................................................................................................. 29
Define Clipping from Key-in Clipping Points............................................................................................ 30
Define Clipping from Modelspace “Pick Points” ...................................................................................... 30
OrthoGen User’s Guide 3
Key Plans: Define Clipping from raster overviews .................................................................................. 30
Moving a volume using the Sliders and Adjustments .............................................................................. 31
Clip 3D ..................................................................................................................................................... 31
Clear 3D Clip ........................................................................................................................................... 31
Save As viewport ..................................................................................................................................... 31
Orientation ............................................................................................................................................... 31
Scale ........................................................................................................................................................ 31
Annotate – 2D, 3D high, 3D low or True 3D ............................................................................................ 31
The OrthoGen environment ........................................................................................................................ 32
Starting with CADWorx ............................................................................................................................ 32
Starting OrthoGen outside of CADWorx.................................................................................................. 32
Starting OrthoGen from inside of CADWorx............................................................................................ 32
Annotate command batch and script files ............................................................................................... 33
OrthoGen 10 User Interface .................................................................................................................... 34
Menu Bar - Configuration ........................................................................................................................ 35
Project Settings ....................................................................................................................................... 35
System Settings ....................................................................................................................................... 37
Convert Version 9 Styles (SDI) ............................................................................................................... 38
Files Group Current CAD drawing file folder ........................................................................................... 39
Files Group Current CAD drawing file(s) ................................................................................................. 39
Open/Edit Current CAD Drawing file ....................................................................................................... 40
Annotate “Connected” CAD Drawing File................................................................................................ 40
“VIEWPORTSTYE” Key in Command ..................................................................................................... 40
Update/Append Existing Labels .............................................................................................................. 41
Refresh Data ........................................................................................................................................... 41
Annotation Z ............................................................................................................................................ 42
Label Properties .......................................................................................................................................... 44
Interior and Exterior ................................................................................................................................. 44
Static or Dynamic Labels ......................................................................................................................... 44
Interior...................................................................................................................................................... 44
Interior Placement Methods..................................................................................................................... 45
Exterior .................................................................................................................................................... 48
Exterior Placement Methods ................................................................................................................... 49
Offsetting 5-Point labels from the view edge ........................................................................................... 51
Label Formats .......................................................................................................................................... 52
Coordinate Positions ............................................................................................................................... 53
Blocks ...................................................................................................................................................... 54
Enclosures ............................................................................................................................................... 56
CAD Properties ........................................................................................................................................ 56
Elevation Prefixes .................................................................................................................................... 57
Label Updates ......................................................................................................................................... 57
Label Repositioning ................................................................................................................................. 57
Dimension Properties .................................................................................................................................. 59
OrthoGen User’s Guide 4
Exterior – Interior ..................................................................................................................................... 59
Static or Dynamic Dimensions................................................................................................................. 59
Interior Dimensioning ............................................................................................................................... 60
Offsetting Dimension strings from the view edge .................................................................................... 60
Exterior Dimensioning ............................................................................................................................. 61
Linear Dimensions ................................................................................................................................... 61
Composite Dimensions ............................................................................................................................ 62
Native CAD Dimensions .......................................................................................................................... 62
Defining Composite Dimension Strings ................................................................................................... 62
Defining Component (Interior) Dimension Strings ................................................................................... 64
Dimension Arrowhead Blocks.................................................................................................................. 65
Extension Line Trimming ......................................................................................................................... 65
Reports ........................................................................................................................................................ 67
Report Naming ........................................................................................................................................ 67
Automatic Table Placement..................................................................................................................... 67
Report Formats ........................................................................................................................................ 68
View Style Group ........................................................................................................................................ 69
Starting the View Style Editor .................................................................................................................. 69
Discipline ................................................................................................................................................. 69
View Styles .............................................................................................................................................. 69
Style Preview ........................................................................................................................................... 69
Current Settings for Active Style ............................................................................................................. 70
Style Editor .................................................................................................................................................. 71
View (Annotation) Styles ......................................................................................................................... 71
ViewStyle.INI file ...................................................................................................................................... 71
View Styles Folder Structure ................................................................................................................... 71
Master Block Libraries ............................................................................................................................. 72
View Style folders .................................................................................................................................... 72
Create/Delete Styles ................................................................................................................................ 73
Entity Type ............................................................................................................................................... 73
Annotation Options Tab ........................................................................................................................... 74
Exterior Labels Tab ................................................................................................................................. 75
Exterior 5-Point ........................................................................................................................................ 75
Exterior Spread ........................................................................................................................................ 76
Linear Dimensions ................................................................................................................................... 76
Composite Dimensions ............................................................................................................................ 76
Line Options Tab ..................................................................................................................................... 77
Text Options Tab ..................................................................................................................................... 78
Propagate Line or Text Options .............................................................................................................. 79
Entity Options .......................................................................................................................................... 79
View Entity Options ................................................................................................................................. 79
Dimension Entity Options ........................................................................................................................ 81
Grid Entity Options .................................................................................................................................. 83
OrthoGen User’s Guide 5
Equipment Entity Options ........................................................................................................................ 85
Nozzle Entity Options .............................................................................................................................. 86
Instrument Entity Options ........................................................................................................................ 88
Routes (Straights) Entity Options ............................................................................................................ 90
Pipe Support, Turns, Valves and Flange Options ................................................................................... 97
Structural Entity Options .......................................................................................................................... 97
Appendix ................................................................................................................................................... 101
FAQ ....................................................................................................................................................... 101
We welcome comments or suggestions about this documentation. You can send us an email at:
support@3ds.net.
3DS gives you permission to print as many copies of this document as needed for non-
commercial use at your company. You cannot print this document for resale or redistribution
outside your company
Technical Support
For the latest information on OrthoGen for please visit 3DS (http://www.3ds.net).
In order to provide technical support, 3DS and Intergraph ICAS need to know what version of
OrthoGen, CADWorx, and AutoCAD you are using.
Each run made by the OrthoGen annotator will write a log file into the drawing file’s "log" folder.
There are other files also created. By selecting the Debug option before submitting the batch
jobs, you have enabled the output and retention of debug files to the /log sub folder off of the
drawing file folder.
Notes
• Email the OrthoGen CADWorx drawing, the CADWorx model drawings, and all files in the /log
folder.
• If you are attaching large or multiple files to your eCustomer log or email, please use a
compression utility such as WinZIP.
• If you cannot attach your drawing files, then try to duplicate the issue in a new drawing with as
few components as possible.
• If the issue can be duplicated in a new drawing, attach the duplicate drawing. For 3DS issued
licensing problems, please contact us at support@3ds.net.
• For hardware lock issues or SPLM licensing issues, please contact ICAS General Support
(http://support.intergraph.com/Default.asp)
Software Enhancements:
System:
• Added support for new version of Smart Plant License Manager
• Added support for AutoCAD 2017
• Updated language-translation files for most languages
Software Enhancements:
View Manager:
• Interactively clip view volumes in modelspace
• Save current modelspace clipping as viewports on layouts.
Save and recall clipped views as ACAD Saved Views.
3D Annotations:
• Place name labels in modelspace in 3D locations.
• Place 3D dimensions in modelspace.
CADWorx Structure:
• Initial support for new “CADWorx Structure” steel models.
• Initial support for “CADWorx Structure” grid models
Software Enhancements:
Reporting capabilities:
• Most Entities selected for labeling now is also written to an ASCII report file.
• Reports can be automatically placed on the drawing.
• New “Report Colum Chooser” dialog allows users to select the properties to be
included in the reports and define their order.
This user's guide has had the following changes for this release.
Users Guide:
• Completely re-organized
• Now delivered as a text searchable PDF with Navigation Bookmarks.
Software Enhancements:
User Interface:
• Simplified and easier to use.
• New “Style Editor” provides access to options for all entities.
• Incorporates drawing configuration and generation into a single interface.
• “Active Settings” display allows you to quickly see the options selected for the current
style.
• All view style settings are stored in a single .INI file.
• Support for multiple languages
• Seamless translations of v9.x view styles to new format.
OrthoGen runs on Microsoft Windows 7, 8, 10 Windows Vista and Windows XP SP3 (all both 32
and 64 bit)
• .NET 4.0
• .NET 3.5 (for OrthoGen Drawing Connector for MicroStation only)
• Intergraph CADWorx 2013-2016
• AutoCAD 2012-2017
• SmartPlant License Manager (for SPLM license only)
• ESL Drivers (hardware lock only)
Hardware:
C Dependencies:
If the OrthoGen ARX will not load into AutoCAD, refer to the following table of Visual C++
Notes redistributables dependencies:
AutoCAD 2008 (64-bit) Microsoft Visual C++ 2005 Service Pack 1 Redistributable Package MFC
Security Update (64-bit)
AutoCAD 2009 (64-bit)
http://www.microsoft.com/en-us/download/details.aspx?id=26347
AutoCAD 2010 (64-bit) Microsoft Visual C++ 2008 Service Pack 1 Redistributable Package ATL
Security Update (32-bit)
AutoCAD 2011 (64-bit)
AutoCAD 2013 (32-bit) Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC
Security Update (32-bit)
AutoCAD 2014 (32-bit)
http://www.microsoft.com/en-us/download/details.aspx?id=26999
AutoCAD 2013 (64-bit) Microsoft Visual C++ 2010 Service Pack 1 Redistributable Package MFC
Security Update (32-bit)
http://www.microsoft.com/en-us/download/details.aspx?id=26999
AutoCAD 2014 (64-bit)
AutoCAD 2015 (32-bit) Microsoft Visual C++ 2012 Redistributable Package (32-bit)
http://www.microsoft.com/en-us/download/details.aspx?id=30679
http://www.microsoft.com/en-us/download/details.aspx?id=30679
OrthoGen program files are delivered as an installation program and the default
installation folder is “c:\Program Files\3DS Net\OrthoGen for CADWorx”.
In addition to the program files we also deliver “View Styles” and Documentation.
View Styles as a set of “Style” files (.INI). These INI files are where OrthoGen stores all
graphic parameters, (color, weight, etc.) as well as all other configuration settings.
By selecting Configuration” from the menu bar, then selecting “Project Settings” you can
define a path to a different “viewstyles” folder. You can define view style locations for
each project.
Software can be delivered via CD or FTP down load. Depending on the security system
Notes at your site, you may need system administrator privileges to install OrthoGen.
Installing
64 Bit:
32 Bit:
Select the appropriate install file. You will need to agree to the “License Agreement”. Next,
choose the install directory for OrthoGen. The default directory for a 64 bit machine is
“c:\Program Files\3DS Net\OrthoGen for CADWorx\” for a 32 bit machine “c:\Program Files\3DS
Net\OrthoGen for CADWorx\”.
View Styles:
View Styles will also be delivered to your “C:\ProgramData\3DS Net\OrthoGen folder. If a view
styles folder already exists in your c”\ProgramData\3DS Net\OrthoGen, OrthoGen will not install
the view styles.
Documentation:
The User’s Guide is delivered as a PDF file. It is located in the OrthoGen Product folder.
Software Upgrades:
Periodically program enhancements or problem fixes will result in the release of new versions of
OrthoGen. Provided that your company has an active software maintenance agreement with 3DS
in effect, updated files containing fixes/enhancements can be e-mailed to the software contact at
your company.
If the e-mailed upgrade contains only a few files, they can be copied into the OrthoGen product
folder and the update is complete.
If the e-mailed upgrade contains an installer file, this is a major upgrade. If you receive a new
installer file, you will have to re-install it. You do not have to remove the prior version.
There are 2 different licenses types for OrthoGen for CADWorx: Intergraph CAS ESL (Hardware
Lock Key) or an SPLM (SmartPlant License Manager) license.
For hardware lock issues, first verify that you have an Intergraph CAS hardware lock. For more
information about hardware locks or SPLM licenses, please refer to the CADWorx Installation
Guide.
You can change the units of your View Styles to Imperial distance units using the Configuration-
>Project Settings form.
Trouble Shooting
This section covers the common configuration problems and the log files needed to track down
problems.
Each run made by the OrthoGen annotator will write a log file into the drawing file’s "log"
(created off of the drawing’s folder) folder. There are other files also created.
By selecting Configuration” from the menu bar, then selecting “System Settings” and
selecting the “Debug” checkbox to “On” before selecting the “Annotate” command,
OrthoGen will log additional information that can help find issues.
If Debug is turned on, additional information will be written to the .log file.
Notes
The creation, revision and propagate functions of the Style Editor writes a LOG file in the
folder above your “viewstyles” folder named “OrthoGenLog.txt”.
Engineering drawing (the activity) produces engineering drawings (the documents). More than
just the drawing of pictures, it is also a language, a graphical language that communicates ideas
and information from one mind to another. Most especially, it communicates all needed
information from the engineers who designed a plant to the workers who will build it.
OrthoGen assists the effort of producing complex plant design drawings by placing and updating
annotations and dimensions to reflect current model conditions for the volume of plant defined in
your view(s).
CAD Systems
OrthoGen operates in both AutoCAD and MicroStation.
Paper Space
When you are in Paper Space mode, OrthoGen for CADWorx currently annotates viewports in
your active Layout.
Model Space
When you are in Model Space mode, OrthoGen for CADWorx currently annotates clipped xRefs
in modelspace.
Start OrthoGen.
Step 1: Use the Configuration->Project Settings menu to define your Project’s Distance
and Diameter units.
Step 2: Select the drawing to annotate, select a layout. The selected layout must have a
viewport in order for OrthoGen to annotate.
OrthoGen will open the selected drawing and annotate it based on the selected discipline and
style selected in the “View Style” group.
After OrthoGen has successfully annotated a layout, the view style can be adjusted by selecting
from a variety of previously defined styles or by modifying a style using the Style Editor. You can
select an Entity and see the options available to be used with it and quickly create custom styles.
You can define the CAD Properties, placement properties and select additional options on an
entity by entity basis using the Line Options and Text Options tabs.
OrthoGen User’s Guide 20
CADWorx Interface
Model and Entities
It all starts with your models. On larger projects each discipline will probably have their own
models. Each discipline model will be populated with CADWorx “Entities”. The discipline models
are “Referenced” together and viewports are defined.
The main interface on the Style Editor is a list of the model “Entities” that can be
annotated/dimensioned.
The XML file is re-generated from the model DWGs based on the selection of the “Refresh Data”
checkbox. If the “Refresh Data” checkbox is not selected, OrthoGen will use the last generated
XML (label) file. If the “Refresh Data” checkbox is selected, OrthoGen will regenerate the XML file
from the model.
Notes If “Refresh Data” is not checked and there is no previously generated XML file, OrthoGen
will generate a new XML file.
At run time OrthoGen first searches model space of the drawing file for CADWorx entities. Next it
searches the xrefs attached to the drawing. If the xref is an “attachment”, OrthoGen will also
search its xrefs. If the reference is an “Overlay”, OrthoGen will NOT search its xrefs.
Notes If each discipline uses a “Master Model” approach, the master models must be attached
as attachments” or their attachments will not be searched.
Entities in models that you want to see but not label, such as stair treads, handrails,
existing/future plant etc. can be attached to an Overlay.
Naming:
Grid models MUST contain the word “grid” somewhere in the name. This name triggers OrthoGen
to generate grid labels.
The grid lines should be “clean”. No overlapping, duplicate, or “end to end” lines should be drawn
as these can produce duplicate labels.
Refer to Style Editor Grid Entity Options topic for more details on grids…
ISOGEN Supplementals
OrthoGen will read ISOGEN Supplemental instruments from CADWorx models and place them
as labels on the drawing view(s).
OrthoGen supports the placement of instrument labels from the following ISOGEN supplemental
entries
f1s.dwg Local Instrument (2 level) graph2 "ISOGEN_Instrument_1" 2
f2s.dwg Local Instrument (3 level) graph2 "ISOGEN_Instrument_2" 3
OrthoGen supports the placement “Break In” Locations from the following ISOGEN supplemental
entries
B1S.dwg Break In Location (1 level) graph2 "ISOGEN_BreakIn_1" 9
B2S.dwg Break In Location (2 level) graph2 "ISOGEN_BreakIn_2" 10
OrthoGen operates on individual views. The Engineer, Designer or Draftsman composes the
views of the model on the sheet and then adds OrthoGen Annotations/Dimensions, notes and
additional details to the views to create a finished drawing.
Folder Structure
OrthoGen CAD drawing files are stored in Windows folders making them easy to access,
backup/restore and share. You should be able to implement the same folder structure for your
drawings that you have always used in the past.
A folder named “Reports” is now automatically created off of the drawing folder and is used to
store all reports.
Drawings can be created by the user from templates with pre-loaded attributed title blocks,
standard settings, etc. Models are attached to the drawing as xrefs in Model Space. When the
Annotation command is selected, OrthoGen will annotate the viewports in your active layout tab
with the settings from the active view style.
In the creation of a viewport in AutoCAD you should assign a “Visual Style” to the viewport. The
Visual Style controls how the objects are to be displayed from the model. The standard ACAD
Visual styles of “Hidden Line”, Realistic, Shaded, etc. are all supported. In addition, you can use
layers on/off to control what is displayed from the model(s).
By default, when you run the “Annotate” command OrthoGen will apply the currently selected
view style to all viewports in your layout. You can permanently assign view styles to viewports
allowing each different viewport to use a different style using the “VPORTSTYLE” key in
command.
You can also use the CADWorx “2D Representation” command to generate the “Visible Edges” of
the viewport in your layout. You can then turn off the display of the viewport to produce a
traditional orthographic projection of the view.
OrthoGen’s “Clear Space” Positioning options will avoid placing labels on top of these edges
producing better label positions.
You can set the scale of the viewport in ACAD Using the viewport’s “Standard Scale” property.
In order to create a viewport with front and back clipping, you should use the CADWorx “View
Box” command to create named views which are then used to create the viewport.
OrthoGen User’s Guide 23
You can also use the ACAD 3DCLIP command to define front and back clipping planes for your
viewport.
Borders - Frames
When you create a layout in a CADWorx DWG you can reference or insert your normal border to
the layout space.
MicroStation:
These seed files are 3D and the units in the OrthoGen (S3D) MicroStation seed files are set as
follows (the units should not be changed):
A Metric MicroStation drawing file should be set to the following working units:
1 m 1000 mm 80 uors
An Imperial MicroStation drawing file should be set to the following working units:
1’ 12” 2032 uors
In the past you may have created section views that were very "deep" and only annotated items
that were visible in the front part of the view by interactively “picking” them. OrthoGen will
annotate all items within the view volume. After annotation, if a drawing is "overloaded" with
labels, you might consider reducing the depth of the view and if necessary for coverage, creating
an additional drawing and/or view.
The “Refresh Data” checkbox in the View Styles group controls whether a new XML file is
extracted from the models at annotate time. If it is unchecked, the annotator will use the existing
XML file from the LOG sub-folder without re-generating it. Setting the Refresh Data control to
“Append” allows multiple passes of annotations to be combined.
Examples: You may need to label one type of equipment interior and another type (lights)
exterior.
You may want to label the pipelines that do not leave the view “Interior” using the
labeling method named “Lines Staying” and then you may want to label pipelines
that leave the view “Exterior” using the “Lines Leaving” labeling method.
Rotated Views
Rotated Plan Views:
The annotator reads the rotation angle from the “Active” user coordinate system (UCS) selected
in your viewport and applies it to the annotations.
UCS
For example, this model is rotated -62 degrees about the Z axis.
To create a rotated plan you must set your View Control to a Standard top view.
After the UCS is created it should also be “Active”. The next image shows that “62” is the active
UCS and the view cube reflects the z rotation. Next select the rotation arrow one time to rotate
the model so that it is parallel to the screen.
Top view
To create a rotated section you must set your View Control to a Standard view such as front,
right, etc. and then select the rotated UCS.
OrthoGen will allow you to clip volumes of your model data set. Once a volume is clipped you can
add annotations in 3D modelspace or save the volume as viewport(s) in a layout where they can
be annotated.
You must set the Insert Units of your master model to either “inches” or “mm”.
Notes
If OrthoGen is not already started, you can select the “Launch OrthoGen” icon to start it.
The “Viewport Styles” button allows you to permanently assign view styles to viewports. A
viewport can have multiple styles assigned to it.
To start View Manager Select the “VM” icon, the flowing dialog should appear.
Manage Views
Views can be created, saved and re-called. They are saved as the same format as the views
created via the ACAD “VIEW” command.
You can Save-Load views using the “Save” and “Load” commands. If you want to delete a view
you have to use the ACAD “VIEW” command.
Once a view volume has been defined, you select the “CLIP 3D” button to apply the clip to
models. To “un-clip” the models you will use the “Clear 3D” command.
To save the current clip volume to a viewport in a layout you need to define the orientation for the
viewport and the initial scale. Next switch to the layout for your viewport and select the “New
Viewport” command. The viewport will be created around the left-bottom area of your layout. You
will have to move it where you want it on your layout.
You will have to “Capture” the Key Plans for your data set. Prepare your modelspace view by
setting it to either TOP or FRONT and then select the appropriate “Capture” command. As your
models are revised you can “re-capture” your key plans at any time.
To define a clipping volumes using the key plans use your cursor to define a box in the plan and a
depth in the elevation. Select the “Clip3D command to apply the clipping.
In order to capture a PLAN overview, you must set your modelspace view direction to
Notes “TOP”.
In order to capture an ELEV overview, you must set your modelspace view direction to
“FRONT”.
Clip 3D
Using any of the volume commands only updates the coordinates displayed in the View Volume
Limits group. To actually clip the volume you must select the “Clip 3D” command.
This command executes the ACAD “xclip” command against all current xrefs.
Clear 3D Clip
This command will clear the clipping from the models.
Save As viewport
Switch to a layout and use the Save as viewport command to create viewports on your layout
using the current clipping limits and Orientation and scale.
Orientation
When you save a volume as a viewport you can define the orientation of the new viewport.
Scale
When you save a volume as a viewport you can define the “Standard Scale” of the new viewport.
The opened drawing must be selected from the drawing list on the OrthoGen menu.
Notes
If you have copied view styles to a new location you must browse to the new view style
folder.
Orthogen.exe file is delivered in and MUST be started from the OrthoGen product folder.
You can create a shortcut to this executable and place it on your desktop.
You can also select the “Launch OrthoGen command from the OrthoGen ribbon menu.
Notes If the OrthoGen interface is already loaded, ORTHOGENLAUCH will “Connect” the
OrthoGen interface with your current CADWorx/AutoCAD session.
These batch, script and XML files are stored in the folder named “LOG” that is created off
of your drawing folder. Once you have a script file you can run it via the ACAD script
command or via the ORTHOGENOUT command.
Exits OrthoGen.
Help
Configuration:
Allows users to define Project parameters, define your 3D modeling system and you CAD
system.
Project Settings
You can create OrthoGen “Projects” where you define CAD Systems, 3D Systems, and
Units etc.
For S3D and PDS projects the data base type, ODBC connections, schema names and
filters are all stored in the “PROJECTS .INI” file.
The “Distance Units”, “Diameter units”, “Last Drawing path” and View Styles path are also
stored as part of the project data.
You should define a project to before you use OrthoGen. The default is a Metric distance
Notes project with Metric diameters.
Project Name:
Enter the name of the OrthoGen project you wish to create or work with.
Distance Units:
A project can have distance units defined as either Metric or Imperial.
Diameter Units:
A project can have diameter units defined as either Millimeters or Inches.
Refer to the Style Editor->Nozzle Entity Options section for more details…
After editing project settings, you must “Save Selected Project” before exiting.
When switching to a new project, be sure to also re-define the path to the view styles
used by the new project.
Database type:
Select either SQL Server or Oracle database.
Model Schema:
Enter the name model schema in an Oracle S3D Catalog database.
Catalog Schema:
Enter the name catalog schema in an Oracle S3D Catalog database.
Filter Settings:
Filter Depth:
The Filter Depth defines how many levels of the S3D “System” Hierarchy” are to
be included in with any of the following systems
Equipment System(s):
Enter a name from the S3D “System” Hierarchy to be used as the equipment
filter.
Coordinate System:
Enter a name from the S3D “Coordinate” System to be used.
Structural System(s):
Enter a name from the S3D “System” Hierarchy to be used as the structural filter.
Routed System(s):
Enter a name from the S3D “System” Hierarchy to be used as the filter when
labeling routes.
System Settings
Debug Mode:
Turns on the logging of detailed information from the annotator.
License:
Define the license type being used.
Select the option to browse to your version 9 sdiMetric or sdiImperial folder. If both
folders exist in the same location the conversion will convert all of the settings for the
selected folder and then add all the spacing, offsets, heights, etc. from the view styles in
the other folder.
The view style folder can be any name. The presence of the file named viewstyles.ini
Notes two folders below a current folder signals OrthoGen that the current folder is a view style
folder.
Each time a drawing is “Annotated” a file with the same name as the drawing with an
“.INI” extension is created in the LOG sub folder. This file contains the last settings used
to annotate this drawing.
As you select drawings from the Files list, if a drawing has .INI file in the LOG subfolder
Notes from a previous Annotate command, OrthoGen will read the settings from the file and
make them active.
If a view port has a permanently assigned view style(s), it will be used for the “Annotate”
command.
When you select an Annotate operation OrthoGen will operate on the drawing file
selected in the GUI even if you are currently in a different drawing.
Double clicking on a drawing file opens the currently selected drawing and “Connects”
OrthoGen to the AutoCAD session for viewing/annotation/editing.
Annotates the currently “Connected” drawing. If the drawing is not already opened, it will
open it. By default the currently selected style is used to annotate the view ports in your
active layout.
If you start CADWorx and then OrthoGen, the opened drawing must be selected from the
Notes drawing list on the OrthoGen menu before it will be annotated.
You can assign view styles to individual view ports using the “VPORTSTYE” command.
You can run the viewportstyle command by keying it in or selecting it from the OrthoGen
ribbon menu.
When you “Add” a view style, you will be prompted to navigate to your view style folder,
select your discipline, your view style folder and then the file named “viewstyles.ini”.
You can add multiple styles to a viewport. They will all be processed with the “Existing
Labels” mode of “Append”.
Update - Deletes the previously placed labels and re-draws them while preserving edits
to “Interior” labels.
Append – Appends additional labels to the current drawing without deleting anything.
This is used to implement “multiple pass” view styles.
Refresh Data
This dropdown list controls whether a new XML file is extracted from the models at
annotate time. If it is unchecked, the annotator will use the existing XML file from the
LOG sub-folder without re-generating it.
This setting is defaulted to “ON”. Once OrthoGen is used, this setting will be saved as
Notes last set by the user.
OrthoGen User’s Guide 41
Annotation Z
Currently all annotations placed in modelspace are placed in the top view. This dropdown
list controls the Z Plane that the labels will be placed on.
The “True Z” setting sets the Z value of the labels to match the geometry the label is
associated with.
The “View Low” setting sets the Z value of the labels to place in the bottom plane of the
current clipping volume.
“Component” labels also referred to as “Tags”, identify entity names and/or coordinates
locations. Instruments, pipe supports, etc. (“single point” items) are good examples of tag labels.
Tags can be placed on the “Interior” of the view or “Exterior”. Tags can have no leader, 2-pt or 3-
pt leader lines.
“Route” labels identity entity locations “Exterior”, identifying and locating Routed Objects (pipes,
trays, ducts) with coordinates and/or dimensions.
“Composite Dimensions” can be placed for any “route” entity. Composite Dimensioning places
no Identification labels, only dimensions strings.
These three specialized labeling categories are used together create the finished
annotated/dimensioned drawing.
Locating Route entities around the Exterior of the view and then placing equipment numbers and
instrument tags Interior is a common combination of interior and exterior labels has proven to be
a very efficient approach to highly automated annotation and updates.
The default order for OrthoGen is to place any “Exterior” labels first and then place any
Notes “Clear Spaced” labels. Placing the exterior labels first results in the leader lines and
centerlines being drawn into the view and when the interior labels are placed they can
avoid placing labels on top of them.
Currently, only the view entity (match line) labels are static.
Notes
Interior
Interior labels are placed close to the objects in the view(s).
OrthoGen has specialized “Placement Methods” for labeling items inside the match line.
On updates, the interior labels are deleted and completely redrawn (regenerated) from the
models and then re-placed using the latest data while preserving any re-positioning work.
Clear Space:
OrthoGen is capable of finding “clear” areas inside the drawing view to place labels in.
As the labeler is searching for an open area it attempts to place the label and then if the area is
not clear, it will “look” around the item to be labeled. The offset distances can be used as a
tolerance.
These offsets are read from the "X and Y Offsets” field of the entity’s Text Options form." The
offset distances are used as a tolerance to control how tight the clear space search is. Smaller
numbers result in labels being closer to the objects but increases search times.
This functionality works best off the “Visible Edges” graphics generated by the CADWorx “2D
Rep” command. Even if you don’t use the 2D Rep graphics for your final plot, you can generate
the 2D Rep, run your interior labels, and then turn the 2D Rep off for the final plot.
If you do not run 2D Rep on the drawing the clear space search will work against OrthoGen
leader/centerlines and other labels.
Fixed Offsets:
This placement method will place the labels inside the view match line and the label will be offset
from the object using the offsets read from the "X and Y Offsets” field of the entities’ Text Options
form. This option makes NO attempt to make sure the area is open before placing the labels.
When using placing tags in fixed offset mode, if you set your X offset to zero, the label
Notes will be placed at 90 degrees and 1/2 of a text height will be used for the X offset.
If the Text Options” offsets are zeros, the labeler will use 1/2 of the text height as offset
tolerance.
This placement method places a leader along each axis as well as the equipment number and
appropriate coordinate. This option will search “away” from the equipment item's location point
until it finds an open area for the text. Equipment item's that share a common axis will have the
individual labels combined into a single label for that "row" of equipment.
This placement method places lines "marking" the radial angle for each nozzle, the nozzle tags in
a circle enclosure and the angle of the leader line.
Exterior
The labels for any entity can be placed around the Exterior of the view.
On updates, the exterior labels are deleted and completely redrawn (regenerated) from the
models and then re-placed using the latest data.
Exterior 5 Point:
This placement method will place the labels outside the view with straight leader lines pointing to
the objects. This is typically used to label General Arrangement drawings with “Names” only or
“Names + Coordinates”. If there are crowded areas or coincident labels, they will be offset so that
they are legible.
“Exterior Spread” will place the labels outside the viewport with a “Three Point” (never straight)
leader line drawn to the component. This is typically used to tag pipe supports or instruments with
names and coordinates.
Linear Dimensions:
This placement method will place the labels outside the view with straight leader lines pointing to
the objects and draw a single dimension string between entities. This is typically used to label
General Arrangement drawings with line numbers and dimensions. This method will offset
leaders in crowded areas so that all dimensions are legible. This method will require the least
amount of touchup time, especially on updates.
Refer to the Dimension Properties Linear Dimensions topic for more details…
Composite Dimensions:
This placement method will place the labels outside the view with straight leader lines pointing to
the objects and can draw up to 3 dimension strings. No identification labels are placed with
composite dimensions. This is typically used to label General Arrangement drawings with
dimensions only. The Route “names” can be added on the interior or “Appended” with a second
“Exterior” annotate. This method can place the dimension leaders in “linear” mode with offsets in
crowded areas or as “Native CAD Dimensions” in “absolute” mode with no offsets applied in
crowded areas.
Refer to the Dimension Properties Composite Dimensions topic for more details…
OrthoGen User’s Guide 50
Offsetting 5-Point labels from the view edge
You can control the distance from the view edge to the start of the “name” labels leaders using
the Style Editor->View Entity->Line Options form and setting the “Offset A” value to the negative
distance. This distance will be from the view edge to the start of the label’s/dimension’s leader
line.
This allows you to place a set of dimensions and then place exterior name labels outside of them.
If ample "Margins" are planned for, "Maintenance Free" drawings, (drawings which can
Notes be confidently regenerated without cleanup) can be achieved.
Name
Name + Coordinates
Name + Elevation
Coordinates Only
Coordinate Positions
When coordinates are placed as part of the label, their position relative to the leader line and/or
name label can be defined.
The following shows examples of the coordinate positions relative to the name label or leader
line.
Below Name
Above Leader
Below Leader
The "Above Leader" option is only valid for labels placed "External".
Notes
Blocks
Discipline Master Block Drawing:
In your delivered view styles folder in the discipline sub-folders, you will find your “Master Block
Drawing” files, one for each system of units. These are AutoCAD drawing files named
metric_drawing.dwg and imperial_drawing.dwg. These drawing files contain the block definitions
used by OrthoGen.
When the Annotator runs, the definitions for the blocks placed in the drawing are read from
metric_drawing.dwg or imperial_drawing.dwg depending on the units selected in the Style Editor.
If you have created blocks in a different drawing file that you want to use, you will have to
recreate them in the appropriate discipline-units drawing.dwg file.
Using the master block drawing is a good way to keep your OrthoGen annotation blocks
organized.
When labels and leader lines are placed, OrthoGen will attempt to place "terminator blocks" at the
ends of leader lines and optionally "Enclosures" on the label text. The block that will be used is for
the terminator is defined using the Style Editor->Entity->Text Options form. If for example, you
do not want terminator blocks on the ends of pipe label leader lines, then do not define a
terminator block for pipe leader lines.
Pipe Cross-Sections:
Also delivered in Master Block Drawing files is a block named “EYEBALL”. This block will be
placed on, and scaled to fit, any section of pipe that intersects the drawing’s front clipping plane.
This block is currently applied to pipe or duct only, not fittings. The scale of this block in the
Master Block Drawing file is fixed. You can recreate it as any symbol you wish to see placed to
represent pipe cross sections.
If your diameter units are not correct the cross-section blocks will place at an incorrect
Notes size and BOP values will be incorrect.
Refer to the Drawings and Views->Units Format topic for more details…
The Annotator will attempt to place a block at the end of the label's leader line that is defined on
the Line Options form, “Terminator” field. Leaving this field blank will suppress the placement of
the terminator block.
There is a drop down list on the Text Options form where you can select the label
enclosure type.
There is a drop down list on the Text Options form where you can select the label
enclosure type.
There is a drop down list on the Text Options form where you can select the label
enclosure type.
Currently the following interior label types have a hard coded enclosure types.
Notes
Instruments (Interior) Circle
Nozzle Orientations Circle
CAD Properties
Every label has a full set of CAD specifications defined for it, Text sizes, Fonts, Layers, Styles,
etc. The specifications for leader lines and centerlines as well as the layer are defined on the
“Line Options” form. Text parameters such as color, weight, font etc. are defined on the “Text”
Options forms.
Using the Style Editor, select your entity and then the “Text Options” form to define coordinate
prefixes.
Prefixes beginning with a “B” will generate Bottom of pipe, duct or tray.
Prefixes beginning with a “C” will generate Centerline elevation of pipe, duct or trays.
Prefixes beginning with a “T” will generate Top of pipe elevations.
Label Updates
As the model changes, the user will need to “Update” the labels to reflect items being moved,
added, or deleted, etc.
View (match line) labels are Static labels. The user will use OrthoGen to generate these labels
one time and then embellish and maintain them using AutoCAD.
Other labels are defined as "Dynamic", and are deleted by the Update command.
Exterior Route labels and Interior instrument labels are good examples of “Dynamic” labels
(deleted and redrawn on each update).
Label Repositioning
"Interior" labels placed using the "Clear Space", “Anchored” or "Fixed Offsets" options can be
repositioned using your CAD system’s move and rotate commands. In order for the edits to be
remembered, OrthoGen’s ARX must be loaded.
When an “Interior” label has been repositioned by the user, these edits are preserved on Updates
(repeatability).
To move labels you can use the AutoCAD selector tool and just “drag and drop” the labels
Notes to new locations.
To rotate labels, use the AutoCAD “rotate” command.
Use caution when moving a viewport after label positioning work has been done. The
edited label locations are stored relative to the viewport’s location.
When a drawing is re-run, the Annotator will handle different modification cases differently.
The Annotator will dimension entities modeled using the different CADWorx Plant modeling tasks.
There are two different “styles” of dimensions, “Composite” and “Linear”.
Linear Dimensions:
This dimensioning style places a single dimension string that will locate pipes, equipment and
grids. In addition to the dimension string, linear dimensions will also place the “name” labels for
the objects being located.
Composite Dimensions:
This dimensioning style only places dimension strings. Column Grid name labels can be placed
but no other identification labels (line numbers, equipment numbers, etc.) are placed.
You can use the “Composite” dimensioning option in combination with the appropriate
"Component Tags" option to add name labels on the inside of the view. You can also use the
Annotator’s “Offset from View Edge” option to add name labels to the exterior of the drawing view
that place outside of the dimensions.
The Dimension labeler with ‘Native CAD Dimensions” turned OFF will also spread out
Notes dimensions in crowded areas.
The Dimension labeler with ‘Native CAD Dimensions” turned ON will not spread out
dimensions in crowded areas.
“Linear” dimensions are deleted and completely re-drawn without preserving any edited
dimensions that were not exploded.
“Composite” dimensions can be much more detailed and require touch up so these may be best
treated as static. Composite dimensions are likely to be drawn as “Native” ACAD rotated
dimension objects.
If the dimension labeling option is turned on, the Update” command will delete all dimensions and
then re-dimension the view.
Exterior Route labels and Interior Instrument labels are good examples of “Dynamic” labels.
Coming Soon…
“Native CAD” Dimensions can be treated as static (drawn once and managed manually) or
dynamic (deleted and re-drawn).
It’s recommended that “Component Level” (Interior) Dimensioning be used with the
Notes CADWorx “LineView” and “Isolate” commands.
Exterior Mode will place dimensions around the outside edge of the view(s). You can place up to
3 dimension strings with Column Grid labels.
Linear Dimensions
Linear dimensions are drawn as a single dimension string and will offset leader lines and text
strings in crowded areas to ensure labels are legible.
Notes When using Native CAD dimensions, the annotator will use the active AutoCAD
“Dimension Style” defined in the drawing file.
The inclusion of an entity in a dimension string is defined on the “Annotation Options” form by
defining the entity to be labeled “Exterior”. Next use the “Exterior Labels” form to define the type
of dimension string the entity is to be located in.
To control the spacing of the dimension string, you will select the “Dimensions” entity and use the
“Line Options” from to define the spacing using the values in the “Leader Line Offsets” group.
The dimension line graphic parameters are read from the “Dimensions” entity and the “Line
Options” form.
The graphic parameters for the "Extension" lines are read from the appropriate entity’s “Line
Options” form.
You can define a dimension style by selecting the items that you want in your dimension string on
the individual entity Annotation Options forms.
Next, using the Dimensions entity you can select which dimension string they are to be located in.
The following example is locating all pipes in the first string, equipment in the second string and
grids in the third.
When using the “Dimension” labeler’s options with “Native CAD Dimensions”, dimension
Notes witness lines are not offset in crowded areas.
Entity being located, controlling the extension line distance “passed” object being located
When placing “Native CAD Dimensions” all properties for the dimensions are defined in the active
Dimension Style.
When placing “Linear” dimensions, if the spacing between dimensions is too crowded to fit the
terminator, a block named "DOT" is placed instead.
This is controlled on an entity by entity basis. You will have to set this value on the Line
Notes Options form for every entity that you want to have the extension lines trimmed.
Report Names:
Report files are never deleted. They are renamed to the same name with a time-date stamp
appended to the names. These report files will be used to compare with the current report and
display any-all changes made between the two labeling runs.
Equipment EBOM
Nozzles NBOM
Piping PBOM
Instruments IBOM
Valves VBOM
Supports SBOM
Cableway CBOM
HVAC HBOM
Column Spacing – Currently the space between columns is fixed at 2 character heights.
Notes
If you create your “BOM” blocks very small, the text masking should hide them.
When placing the report on the drawing, only the report data is placed. It is up to the user
to draw the “Chart” including the headings; OrthoGen will populate it for you.
Selecting this button brings up the “Report Column Chooser” dialog which will allow you to select
the columns to be included in your report and the order of the columns.
Selecting the icon to the right of the “Report Columns” field will bring up the Column Chooser
dialog.
Discipline
The discipline list is derived from the folders that exist off of the current “viewstyles”
folder. Once you select a discipline, the styles defined under it will be displayed.
View Styles
You can double click on an entity in the Active Settings list and the style editor will open.
Notes View Styles can now be permanently assigned to viewports using the OrthoGen
“VPORTSTYLE” key in command. To create Multi-Pass view styles, multiple styles can
be assigned to a viewport and the Annotate command will annotate the view with each
view style defined using the “Existing Labels” “Append” mode.
If no view style has been assigned to the viewport, OrthoGen uses the currently selected
view style for the “Annotate” command.
Style Preview
You have the option to create a .GIF file with the name “viewstyle.gif” and save it
as a “Preview” image in the view style folder. These files can show typical output results
for the selected style. Select the “Preview” icon to display the preview image for a
selected style.
You can double click on an entity in the Active Settings list and the style editor will open
Notes on that entities’ Annotation Options form.
Just as you assign a “Visual” style to a viewport in AutoCAD, you will select a “View” or
“Annotation” style to be used by OrthoGen for Annotations.
You can create a single ‘Composite” view style where you define all of the entities to be
labeled and their label formats. This is the easiest to implement but sometimes you may
want to label an entity two different ways such as pipelines that leave the view exterior
and pipelines that do not leave the view interior.
You can create a view style for the interior pipelines and one for the exterior pipelines
and assign them both to the same viewport.
You can also treat each view style as a “Feature” and have a view style file for each
discipline that is to be labeled on your drawing. On complicated drawings many times the
user wants to control the order that labels are placed. For example, this would allow you
to place your Equipment labels and do the repositioning work on them before adding the
other labels.
ViewStyle.INI file
Disciplines and View Styles are stored in a simple folder structure. To define your active
view style folder, use the Menu Bar’s Configuration->System Settings->View Styles
Path command and browse to a new view styles folder.
Each view style is stored in a separate folder. The folder name is the view style name.
The INI file is stored in this folder and named “viewstyle.INI”. When the view style is
selected the selections for that view style are loaded.
The view styles folders allows users to either use the delivered standard view styles or
create their own view styles by copying and modifying a delivered style.
In order to use the delivered view styles, first navigate to the top level view styles
folder. By default, the view style folder is delivered in
c:\ProgramData\3DSNet\OrthoGen\viewstyles.
Once you have browsed to a valid view styles folder the Discipline and View Style lists
will be populated.
All settings files, seed files, and block libraries are located under the view styles folder.
After selecting a discipline from the discipline drop down list, the View Styles list will be
populated by reading all folders under it.
OrthoGen User’s Guide 71
The following shows a sample view styles folder structure showing the disciplines,
instrument annotation styles, and discipline Master Block Drawings and cell libraries.
You can create a new discipline entry by creating a folder at the “discipline” level and
Notes copying a style folder into it.
There are two “cell librarys” named metric_drawing.cel and imperial_drawing.cel in every
discipline folder. These cell libraries contain all of the cells used by OrthoGen in
MicroStation.
If you define a new name for terminator in the style editor, you also need to add the
Notes block to the appropriate master block drawing file or a cell to the cell library.
The following shows a sample view styles folder structure showing the disciplines and
instrument annotation styles.
The folder for the Instrument Style named “InstrumentOptionA” contains the “preview
image” .GIF file, the .INI (Style) file, and the discipline seed files used when creating new
drawing files. There are seed files for both Imperial and Metric units.
Entity Type
After you have selected your Discipline and Annotation Style you can activate the
Style Editor.
The interface to your CADWorx model entities is the “Entity List”. You will always first
select the “Entity” (views, pipes, equipment, etc.) that you want to customize.
There are four tabs on the Style Editor form. The “Annotation Options”, “Exterior
Labels”, “Line Options” and “Text Options”.
Using the “Annotation Options” form you can select whether the label will be placed
“Exterior” or “Interior” or both.
When you select to label an entity Exterior or Interior you can also define the Label
Format, whether or not to place coordinates and their format. On Interior labels you can
also select the “Placement” method.
Refer to the Label Properties->Exterior Placement methods topic for more details…
There are four “radio” buttons on the left side of the form that control the exterior style to
be used.
Exterior 5-Point
The method places all the labels on the exterior of the view using a “5-point” leader. You
can label with just the names or also add coordinates. The leaders are drawn from the
object in the view to the view edge and the labels are placed relative to the view edge
using the “Leader Line Offsets” settings on the “Line Options” tab. In crowded areas the
labels will be offset from each other to guarantee that the labels will be legible.
Linear Dimensions
The method places all the labels and dimensions exterior to the view. The leaders are
drawn from the object in the view to the view edge and the labels are placed relative to
the view edge using the “Leader Line Offsets” settings on the “Line Options” tab. In
crowded areas the labels will be offset from each other to guarantee that the label will be
legible.
This method can be “names and dimensions” or “names, dimensions and coordinates”.
Composite Dimensions
The method places only dimensions exterior to the view. The leaders are drawn from the
object in the view to the view edge and the labels are placed relative to the view edge
using the “Leader Line Offsets” settings on the “Line Options” tab. In crowded areas the
labels will be offset from each other.
If this method is used with “Native CAD Dimensions” option which generates AutoCAD or
MicroStation Dimension elements, the leader lines will NOT be offset in crowded areas.
Center Lines:
You can define the color, weight and style of the centerlines generated for piping entities
(straights and turns).
You can define the layer, color, weight, style and terminator (arrow) to be used for each
entity’s labels.
You can set these to “By Layer” and control the color and weight of the labels and
Notes dimensions using Layers in AutoCAD.
You can select the characteristics of the label’s text on this form. Color, weight, font,
sizes for both Primary and Secondary text as well as coordinate prefixes, enclosures,
units and offsets used by the Clear Space and Fixed offsets placement methods.
Text Styles:
You can enter the name of an AutoCAD “Text Style” into the font field and OrthoGen will
use all the parameters defined in the style instead of the individual parameters defined on
the form.
Propagate to all Entity Types in ALL View Styles and all Disciplines:
Propagates the value of the current field to All entities in ALL View Styles in All
Disciplines.
Entity Options
Most Entities have additional specialized options.
This form allows the user to define additional parts of the view title and match line labels
and coordinate “Shift” values.
Coordinate Shift:
Projects sometimes use Coordinate shifts. OrthoGen uses the coordinates directly from
the model. If you edit these values and enter the "shift" offset values for East, North, and
Elevation, the values are added to the model coordinates resulting in "shifted" coordinate
labels being placed on the drawing.
When placing match line labels the annotator reads the distance input into View Entity -
Notes >Text Options-> Line Spacing value. This distance will be used as the distance from
the match line to the center of the match line text strings.
The match line label is “Appended” regardless of the “Existing Labels” setting.
Dimensioning Options
Exterior Dimensions drawn from the outermost plant object to the corner of the viewport
can be suppressed.
You can define a “Minimum Distance to Dimension”. If the distance between two objects
is less than the minimum setting, one of the objects will be discarded. There are detailed
rules applied to decide the priorities of the objects to retain. For example if grid line and a
pipe are within the minimum distance of each other, the grid will be retained and the pipe
discarded.
If you configure either one or two dimension strings, you can also add an overall
dimension. The overall dimension is now your third dimension string. All other entities
that you want to locate with a dimension will have to be defined in dimension string one
or two.
This option on the grid entity suppresses the placement of grid labels and coordinates on
the dimension string. This is useful mode where the Route labels are offset outside of the
dimension string(s) and places name labels for routes as well as grid labels.
The column grid text in the bubble can be sized differently than the column coordinate
text. The column bubble text size is read from the Grid Entity’s Text Options form’s
“Primary” text size settings and the coordinate text size from the Text Options form’s
“Secondary” text size settings.
When labeling routes, the Annotator will also generate column grid labels from grid
model(s) attached as an Xref.
The leader lines on column grid labels can be offset further from the view edge than the
leader lines on other entity labels.
The value in the field labeled “E” in the “Leader Line Offsets” group is read from the grid
entity for grid labels. Grid leaders will extended by this amount.
Name Format:
“Equipment Name”
If the equipment item is in an xref attached as an “overlay”, the coordinate location placed
for an equipment item is it’s “xref insert point” defined at attachment time plus any offset
between 0,0,0 and the “xatb” block in the equipment model.
The “xatb” block is required for CADWorx equipment items and must not be removed.
Notes
If you want to adjust the “Label Point” for an equipment item, you can move the “xatb”
block to a different location.
Refer to the Label Properties Exterior Placement Methods topic for more details…
Refer to the Label Properties Interior Placement Methods topic for more details…
The property currently available for placement as labels for nozzle is:
“Description”
In order for nozzle diameters to be reported correctly in projects using Millimeters NPD
Notes you must use Configuration->Project Settings, select your project and define your
diameter units.
Refer to the Label Properties Exterior Placement Methods topic for more details…
Refer to the Label Properties Interior Placement Methods topic for more details…
The Annotator places the default block named INLINE at the center of the in-line
instruments, and places a block named OFLINE on the center or origin point of an off-line
instrument.
The Instrument labels can be placed exterior to the drawing view (margin) with a “Three
Point” leader line drawn to the component’s center (Exterior Spread); in the margin with
straight leader lines (Exterior); alongside of the model object using a fixed offset distance
(Fixed Offsets); or on the interior of the drawing view using “Clear Space". All applicable
components whose points fall within the drawing view will be labeled.
Refer to the Label Properties Exterior Placement Methods topic for more details…
Refer to the Label Properties Interior Placement Methods topic for more details…
Label Definition:
The attributes currently available for placement as labels on instruments and piping
components are:
Short annotation
OrthoGen User’s Guide 88
Long annotation
Line number
Tag
The “IN-LINE” Instrument currently being labeled from CADWorx piping models is
“Control Valves”.
OrthoGen will also read ISOGEN Supplemental instruments and place them as labels on
the drawing view(s).
Now placing instrument labels from the following ISOGEN supplemental entries
F1s.dwg Local Instrument (2 level) graph2 "ISOGEN_Instrument_1" 2
F2s.dwg Local Instrument (3 level) graph2 "ISOGEN_Instrument_2" 3
Naming:
OrthoGen expects instrument tags to include either one or two hyphens. A tag with one
hyphen will be separated into 2 lines. A tag with two hyphens will be separated into three
lines. When running Clear Space mode, the tags will be placed inside a balloon (bubble)
enclosure.
Balloon/Bubble Size:
The size of the bubble is controlled using the Style Editor->Instrument Entity->Text
Options->Bubble Radius field.
Hyphenation:
Instrument labels are currently broken into separate lines at each “hyphen”. A label such
as “PI-100” will be placed in a balloon as two lines.
Pipes, Tray Straights, Conduits and HVAC straights are all classified as “Routed”
systems. Each system is comprised of “Straight” features (pipes, ducts, trays) and “Turn”
features (elbows, tees, etc.). The Annotator processes the straight features in a routed
system.
On the “Annotations Options” form for Pipes, there are multiple methods that can produce
different “Styles” of annotation. This is where you select the style of annotation for the
Routed System (pipe, tray or duct) drawing you wish to process. Only one style of
Exterior annotation can be selected to be run at a time, but you can combine multiple
style “Passes” together using the “Append” option from the “Existing Labels” dropdown
on the main form.
The Annotator is designed to place route labels around the outside edges of the
viewport(s). It can place labels only, labels with coordinates, labels with dimensions or
labels with dimensions and coordinates.
Refer to the Label Properties Exterior Placement Methods topic for more details…
Refer to the Label Properties Interior Placement Methods topic for more details…
When running the Route labeler in “Longest Largest Leaving mode”, OrthoGen can place
one label for every unique pipeline that exists within the view volume. This guarantees
that every unique line number in the view is labeled.
General Options:
“Name Format” is the field where you enter the property that you want to be used as the
label.
The format of the “Line Number” property is controlled entirely within CADWorx through
the use of naming rules. OrthoGen reads the “Line Number” property from the pipes in
the DWG files.
General Options:
“Name Format” is the field where you enter the property that you want to be used as the
label.
The format of the “Line Number” property is controlled entirely within CADWorx through
the use of naming rules. OrthoGen reads the “Line Number” property from the tray
straights in the DWG files.
General Options:
“Name Format” is the field where you enter the property that you want to be used as the
label.
The format of the “Line Number” property is controlled entirely within CADWorx through
the use of naming rules. OrthoGen reads the “Line Number” property from the HVAC
straights in the DWG files.
The Annotator places a label for each located straight according to additional rules based
on the active selection of the Route Labeling Method.
“Longest-Largest or Leaving” method places a single label for each Route having a
unique DIAMETER and LINE NUMBER combination that is found within the drawing view
volume. The item to be labeled is determined by locating, for each unique Route number,
the longest Straight object of the largest diameter or size. If a Route also leaves the view,
this Route will be treated as if it is the longest, and will be labeled at the point it leaves
the view.
“Longest-Largest and all Leaving” method places a single label for each Route having
a unique DIAMETER and LINE NUMBER combination that is found within the drawing
view volume. The item to be labeled is determined by locating, for each unique Route,
the longest Straight object of the largest diameter or size. If a straight object also leaves
the view, this straight will be treated as if it is the longest, and will be labeled at the point
it leaves the view. All non-vertical straights that leave the view will also be labeled.
“Direction Changes” method labels each run (horizontal direction change) of a Route.
This method labels all direction changes with a single line number. This method is useful
for production of pipe rack drawings, particularly if the rack drawing has any expansion
loops on it.
“Leaving Only” places a label identifying each Route that leaves the drawing view at the
point it leaves the view.
“Staying Only” places a label identifying each unique Route that does NOT leave the
drawing view. This is useful to label routes that do not leave the view “Interior” and routes
that do leave the view “Exterior”.
“Verticals (normal) Only” labels each straight feature that is vertical (normal) to the
drawing border plane. This option is used for creating penetration drawings.
“ALL” labels every Route straight feature. This method labels all Route straight features.
A run made up of multiple line numbers will have a line number label placed on the
drawing for each straight feature in the run. This option is usually only used for
debugging.
The Annotator will label vertical straight features according to the selection from the Label
Verticals drop down list.
"Top/Bottom" labels any vertical straight features on the top or bottom of the view,
whichever the straight feature is closest to.
"Sides" labels any vertical straight features on the side of the view that the straight
feature is closest to.
"Both" labels any vertical straight features on either the top or bottom of the view, and
the sides.
When labeling vertical (normal) straights you have the option to place a standard name
label with them. Enter a text string into this field and it will be placed as the label. Leaving
this label blank suppresses the placement of a name label on a vertical pipe.
If you are running the Longest Largest mode with “Verticals” set to “None” and the
Notes longest largest section of the route happens to be in the vertical, the line will NOT be
labeled.
If you are running the Lines-Leaving mode and there are lines leaving the view in the
vertical you must have your "Label Verticals" option set to something other than "None"
for OrthoGen to place labels for the vertical lines.
To configure your Piping Diameter units you must use Configuration->Project Settings,
select your project and select your diameter units.
Failure to make this setting to the correct units could result in incorrect Bottom of Pipe
Notes labels and pipe Cross-section blocks/cells placing at incorrect sizes.
A setting named "Minimum Length" provides a mechanism through which the number of
Routes that are labeled on a Route drawing can be reduced.
For example, by defining a value of 2.0, labels can excluded for any Route Straight
feature that is not at least 2 master units long. This can result in a substantial reduction in
the number of labels placed, while still leaving the majority of Routes annotated with a
line number, coordinates, and optional BOP elevations. This setting, when used with
"ALL" mode, creates very detailed Route drawings.
The value defined must be entered in decimal master unit’s format.
Route Straight feature Extension Factor:
This setting allows you to label the Bottom of Pipe of all sloping lines where they intersect
the match lines.
Piping BOP Option (Bottom of Pipe) Cableway BOT Option (Bottom of Tray) HVAC
BOD (Bottom of Duct):
The settings files for each annotation style contain fields for prefixes that will be used with
coordinate values. If you set your elevation coordinate prefix on a Routed Object to BOP
or BOD, or BOT, the system will place Bottom elevations on plan views in addition to
Northing and Easting coordinates. On section drawings the system will place Bottom
elevations instead of centerline-of-route elevations.
The settings files for each annotation style contain fields for prefixes that can be applied
to coordinate values. If you set your elevation coordinate prefix in routes parameter file to
CL, the system will place centerline elevations on plan views in addition to Northing and
Easting coordinates. On section drawings the system will place centerline elevations.
Refer to Style Editor->Text Options for more information.
When labeling sloped straights you have the option to place a standard name label with
them. Enter a text string into this field and it will be placed as the label. Leaving this label
blank suppresses the placement of a name label on a sloped pipe.
When labeling pipes, selecting the “Label Percent Slope” checkbox will calculate and
place the “Percent Slope” on sloping lines.
Place Route Centerlines:
When you select the “Annotate” button the Annotator can only apply one style. The
sample styles named “Exterior Inner margin” and “Exterior Outer margin “can be
combined together using the “Existing Labels” “Append” mode to generate a complex
style.
The Route Labeler places the line number, grid and equipment labels in the outside area
of the Exterior “outer margin” and then dimensions are “Appended” by the Dimension
Labeler option in the Exterior “inner margin”.
The Dimension labeler does not offset the dimension “extension” lines. The offsets are on
the name label leaders.
Refer to the Dimension Properties Exterior Dimensioning topic for more details…
Refer to the Dimension Properties Interior Dimensioning topic for more details…
Using the Style Editor and selecting the entity named “Tray Straights” allows you to
define tray straight information to annotate-dimension.
Tray Parts:
Using the Style Editor and selecting the entity named “Tray Parts” allows you to define
tray fitting information to annotate-dimension.
The attributes currently available for placement as labels on Tray components are:
Long annotation
Part number
Tag
HVAC Parts:
Using the Style Editor and selecting the entity named “HVAC Parts” allows you to define
the HVAC fitting information to annotate-dimension.
The attributes currently available for placement as labels on HVAC components are:
Long annotation
Part number
Tag
HVAC are modeled using the CADWorx HVAC module. Any component or straight
Notes placed that does NOT have the “Open top” property set will be treated as HVAC.
The Annotator can also read steel models (including CADWorx Structure) for the labeling
of steel members with the member Section.
Label Formats:
The attribute placed from steel models as the label can be defined in Style Editor-
>Structural Entity->Annotations Options form’s General Options group.
The attributes currently available for placement as labels on steel members are:
Short annotation
Long annotation
Part number
When placing steel labels, the Component labeler will not place a label on any steel
Notes member for which the member’s Center of Gravity is NOT inside of the drawing view
volume.
OrthoGen has additional options for labeling and dimensioning steel members.
This option will collect the endpoints of beams and send them to the dimensioning
command. This option is useful on pipe support details where you want to know the
length of a beam.
This option will place a name label for columns on plan views. This option is useful for
tagging piles on plan views.
Using the “Disable Offset Dimensions” checkbox, you can disable placement of offset
dimensions when labeling steel members.
Baseline Elevation:
On steel plan views with members at different elevations OrthoGen can place “Offset
Dimensions”. The offsets are calculated from the ACAD “Elevation” Setting defined in the
current drawing.
Coming Soon:
The first part of the title of the view is extracted from the drawing files viewport name. The
second part of the title is extracted based on the baseline elevation for plans and for
section views the column line that intersects the view.
View titles are placed on a level that is NOT deleted (defined by the view entity) by the
Update Labels command. You can move and edit the title to your liking. If something
changes you can delete the title and regenerate a new one at any time.
When labeling members with section names using the “Fixed Offsets” placement option
the following label offset rules are applied.
Members running Up/Down on the page will use the X offset value. Setting this to a
negative numbers places the label to the left of the member.
Members running Left/Right on the page will use the Y offset value. Setting this to a
positive number places the label above the member.
Members running diagonal on the page will use the X offset value.
On member labels that have more than one line, the offset value will be multiplied times
the number of lines in the label.
You have a distance unit’s mismatch between the drawing distance units and OrthoGen
Project Distance units setting.
You have a diameter unit’s mismatch between the diameter units defined in the model
and the diameter units defined in the Project Settings Diameter Units definition.
Labeling pipes in a view using “Longest Largest Lines Leaving” method and
getting just 1 label:
The pipes in the viewport do not have different “COUNT” and “SERVICE” settings. Try
using the Pipe labeling method named “Direction Changes”.