Symbol Label Suit Features

Overview

For Symbol Label Suit 21 version 1.04 ; This suit comprises 3 files, Symbol Label, Symbol Legend and Model View Options object (IFSL21_mvo.gsm)

For older versions ; This suit comprises 2 files, Symbol Label and Symbol Legend.

The Symbol Label is a label that extracts content from an associated object (Wall, Slab, etc.) and, if enabled, creates log files (simple .txt files) that can be read by Symbol Legend to automatically create table of legend.

After loading all files to the library, you can access Symbol Label via the Label Tool, Symbol Legend via the Object Tool and Model View Options object via “Document > Model View > Model View Options” menu.

Symbol Label

Before going ahead and use this label, here are some useful tips.

1. Naming the symbol content.

For example, use “W01” or “W-01” instead of “W1” or “W-1”, if you expect that the numbers will not go beyond 100. This ensure that the data will be sorted and displayed correctly with the Symbol Legend .

2. Creating layer specifically for the label.

Creating layer for the labels makes selecting the labels easier. You can also choose to create layers for each symbol’s shape. It will benefit the workflow later when you need to change the parameters for all labels, whether to change the display content or to change the log file.

3. Minimizing the writing log file process.

Writing data to log file can slow down your computer when the project file contains many objects/labels. After setting appropriate log file’s path, you can disable the Enable Log check-box. To re-enable it, click the check-box again and click OK.

4. Using Backslash “\”

Backslash “\” has special meanings in GDL, for examples, “\n” = new line, “\t” = tabulator or “\\” = the character “\” itself. If using backslash if required, putting “ ” (space) right after it to avoid its effects. Use “ wood \ timber ” instead of “ wood\timber ”.

General Settings

Scale Method

Due to the current GDL Standards, the parameters regarding Length, Width, Height, etc. for each of the Scale Method need to be set separately.

Static (Paper)

With this option selected, symbol size and text size will be scale-independent. If the current working Model Unit is metric, the unit display in dialog will be in millimeter. If the current working Model Unit is imperial, the unit display in dialog will be in point. (To see the current working Model Unit : Options > Project Preferences > Working Units > Model Unit)

Proportional (Model)

With this option selected, symbol size and text size will be scale-dependent. The unit display in dialog box will be the same as the current working Model Unit. (To see the current working Model Unit : Options > Project Preferences > Working Units > Model Unit)

Symbol Shape

This option contains shapes as follows; Triangle, Circle, Ellipse, Square, Square Rotated, Rectangle, Pointed Rectangle, Diamond, Hexagon, Hexagon Rotated, Octagon, Octagon Rotated and None.

For Rectangle and Pointed Rectangle, there is an additional option “Auto Adjust Width”. If selected, symbol width will be automatically adjusted and the symbol width setting dialog box will be locked.

Text Alignment

This option contains the followings; Always Horizontal, Always Readable, Align with Symbol, Free Rotate.

Always Horizontal

The symbol text will be aligned horizontally regardless of the symbol’s rotation angle.

Always Readable

If the symbol’s rotation angle is causing the symbol text to be upside-down or the symbol text is pointing to the right, the symbol text will be flipped.

Align with Symbol

The symbol text will be aligned with the symbol’s rotation angle.

Free Rotate

If selected, an additional hotspot will be available. Use the hotspot to rotate symbol text freely.

Symbol Size

Height setting will always be available for all symbol shapes but Width setting will only be available if Ellipse, Rectangle, Pointed Rectangle and Diamond is selected.

If symbol shape is set to “None”, the width and height setting will be locked.

Offset from Origin

Set offset distance from the symbol’s origin point (the point represented with a black dot when you select the symbol).

Symbol 2D Representation

Set Outline pen, Outline line type, Fill, Fill pen and Background pen. These settings can also affect the Opaque and Frame options in the “Full Name Text” settings if the “Use Symbol’s Settings” is enabled.

Display Content

This label supports various types of elements in ArchiCad. The available display contents correspond with the type of element. Please see the table “Content Options” for more information.

Symbol Content

Number of Characters (No. of Characters)

The number of characters to be shown in symbol. For example, if the name of the surface selected is “W1 Brick Double Plastered with Exterior Paint no.123” and No. of Characters is set to 2. “W1” will be displayed in the symbol. If No. of Characters is set to 1, “W” will be displayed in the symbol.

If the symbol content is set to display Building Material ID, Surface ID, Surface ID (Manual Select) or ID, the “No. of Characters” will be locked and the value will be automatically set.

Content Options

Element Type Available Display Content
Main Content Additional Content
Label (Independent) Surface (Manual Select)
Surface ID (Manual Select)
Custom Custom Text
Object, Lamp, Window, Door, Skylight Object Name
Surface (Manual Select)
Surface ID (Manual Select)
Material Parameter
ID
Custom Custom Text
Wall Basic Building Material Outside Face, Inside Face
Building Material ID Outside Face, Inside Face
Surface Outside Face, Inside Face, Edge
Surface ID Outside Face, Inside Face, Edge
ID
Custom Custom Text
Composites Building Material Outside Face, Inside Face
Building Material ID Outside Face, Inside Face
Composites
Surface Outside Face, Inside Face, Edge
Surface ID Outside Face, Inside Face, Edge
ID
Custom Custom Text
Complex Profile Building Material Outside Face, Inside Face
Building Material ID Outside Face, Inside Face
Surface (*Override Surface) Outside Face, Inside Face, Edge
Surface ID (*Override Surface) Outside Face, Inside Face, Edge
Surface (Manual Select)
Surface ID (Manual Select)
Profile
ID
Custom Custom Text
Column Rectangular, Circular Building Material Core, Veneer
Building Material ID Core, Veneer
Surface
Surface ID
ID
Custom Custom Text
Complex Profile Building Material Core, Veneer
Building Material ID Core, Veneer
Surface (*Override Surface)
Surface ID (*Override Surface)
Profile
Surface (Manual Select)
Surface ID (Manual Select)
ID
Custom Custom Text
Slab Basic Building Material
Building Material ID
Surface Top Side, Bottom Side, Edge
Surface ID Top Side, Bottom Side, Edge
ID
Custom Custom Text
Composites Building Material Top Side, Bottom Side
Building Material ID Top Side, Bottom Side
Composites
Surface Top Side, Bottom Side, Edge
Surface ID Top Side, Bottom Side, Edge
ID
Custom Custom Text
Roof Basic Building Material
Building Material ID
Surface Top Side, Bottom Side
Surface ID Top Side, Bottom Side
ID
Custom Custom Text
Composites Building Material Top Side, Bottom Side
Building Material ID Top Side, Bottom Side
Composites
Surface Top Side, Bottom Side, Edge
Surface ID Top Side, Bottom Side, Edge
ID
Custom Custom Text
Fill Cut Building Material
Fill Name
ID
Custom Custom Text
Draft, Cover Fill Name
ID
Custom Custom Text
Mesh Closed Body Building Material
Building Material ID
Surface Top Side, Bottom Side, Edge
Surface ID Top Side, Bottom Side, Edge
ID
Custom Custom Text
Top & Edge Building Material
Building Material ID
Surface Top Side, Edge
Surface ID Top Side, Edge
ID
Custom Custom Text
Top Surface Only Building Material
Building Material ID
Surface Top Side
Surface ID Top Side
ID
Custom Custom Text
Beam Rectangular Building Material
Building Material ID
Surface Left Side, Top Side, Right Side, Bottom Side, End Side
Surface ID Left Side, Top Side, Right Side, Bottom Side, End Side
ID
Custom Custom Text
Complex Profile Building Material
Building Material ID
Surface (*Override Surface) Extrusion Surface, End Surface
Surface ID (*Override Surface) Extrusion Surface, End Surface
Profile
Surface (Manual Select)
Surface ID (Manual Select)
ID
Custom Custom Text
Curtain Wall ID
Custom Custom Text
Curtain Wall Frame Frame Type
Surface
Surface ID
ID
Custom Custom Text
Curtain Wall Panel Panel Type
Surface Outside Face, Inside Face, Edge
Surface ID Outside Face, Inside Face, Edge
ID
Custom Custom Text
Curtain Wall Junction Junction Type
ID
Custom Custom Text
Curtain Wall Accessory Accessory Type
ID
Custom Custom Text
Shell Basic Building Material
Building Material ID
Surface Reference Side, Opposite Side, Edge
Surface ID Reference Side, Opposite Side, Edge
ID
Custom Custom Text
Composites Building Material Reference Side, Opposite Side
Building Material ID Reference Side, Opposite Side
Composites
Surface Reference Side, Opposite Side, Edge
ID
Custom Custom Text
Morph Building Material
Building Material ID
Default Surface
Default Surface ID
Surface (Manual Select)
Surface ID (Manual Select)
ID
Custom Custom Text

 

Full Name Content

To enable this option, click the “Display Full Name” check box.

If enabled, the label will show the rest of the content. For example, if the name of the surface selected is “W1_Brick Double Plastered with Exterior Paint no.123” and No. of Characters is set to 2. “_Brick Double Plastered with Exterior Paint no.123” will be displayed next to the symbol text.

To get rid of the “_”(underscore) or “ “(space), enable the “Omit the 1st Character” check box.

Upon selecting Building Material ID or Surface ID as content for symbol, the “No. of Characters” will be locked and the Building Material or Surface Name will be automatically displayed as Full Name Content. While selecting ID, a text-input dialog box will appear for Custom Text for ID. For more information, see the table below.

Symbol Content Full Name Content
Accessory Type The rest of the Accessory Type’s name
Building Material The rest of Building Material’s name
Building Material ID Building Material’s name
Composites The rest of the Composites’ name
Custom The rest of the Custom Text
Default Surface The rest of the Default Surface’s name
Default Surface ID The Default Surface’s name
Fill Name The rest of the Fill’s name
Frame Type The rest of the Frame Type’s name
ID Custom Text (ID)
Junction Type The rest of the Junction Type’s name
Material Parameter The rest of the Surface’s name
Object Name The rest of the Object’s name
Panel Type The rest of the Panel Type’s name
Profile The rest of the Profile’s name
Surface, Surface (Manual Select) The rest of the Surface’s name
Surface ID, Surface ID (Manual Select) The Surface’s name

 

* Special Characters such as “\n”, “\t” can be used in the content.

\n new line

\t tabulator

For more information, please see the “GDL Reference Guide” in the ArchiCad’s Help menu.

Extension Line

To enable this option, click the “Enable” check box.

Extension Line 2D Representation

Set pen and line type for extension line.

If the Use Symbol’s Settings is selected, the settings for symbol’s outline pen and symbol’s line type will be used.

Symbol Text

Select Font, Size, Pen, Font Face, Width Factor and Spacing Factor for Symbol Text.

Full Name Text

Select Font, Size, Pen, Font Face, Width Factor and Spacing Factor for Full Name Text.

If the Use Symbol Text’s Settings is selected, the settings for Font, Size, Pen, Font Face, Width Factor and Spacing Factor of the symbol text will be used.

Initial Offset

There are two options for Initial Offset, “Use Offset Distance” and “No Offset Distance”.

If “Use Offset Distance” is selected, the Full Name Text will be displayed to the right of the Symbol Text according to the distance set by the Initial Offset Distance. Use the Offset Distance hotspot to further adjust the Offset Distance to the desired location.

If “No Offset Distance” is selected, the label will automatically place the Full Name Text right next to the Symbol Text. Use the Offset Distance hotspot to further adjust the Offset Distance to the desired location.

Auto Adjust Textblock Width

If enabled, the Textblock Width is set via the input dialog. The Textblock Width unit change accordingly to Symbol Method and the current working Model Unit (To see the current working Model Unit : Options > Project Preferences > Working Units > Model Unit).

If disabled, the Textblock Width is automatically calculated according to length and size of the Full Name Text.

Indent Method

There are two options for Indent Method, “Left, Right”, “Left, Right, Top Bottom”. The Indent unit changes according to Symbol Method and the current working Model Unit (To see the current working Model Unit : Options > Project Preferences > Working Units > Model Unit).

There are four options for the alignment of the Full Name Text, “Left”, “Center”, “Right” and “Justified”.

There are five options for the Anchor Position, “Top Line”, “Bottom Line”, “Upper Point”, “Middle Point”, “Lower Point”.

Opaque

This option enables Fill for Full Name Text.

If “Use Symbol’s Settings” is enabled, Fill, Fill Pen and Background Pen will use the same settings as Symbol’s settings (“Symbol 2D Representation” in the “General Settings” page).

Frame

This option enables outline for Full Name Text.

If “Use Symbol’s Settings” is enabled, Line type and Outline pen will use the same settings as Symbol’s settings (“Symbol 2D Representation” in the “General Settings” page).

Use Log File for Legend

To enable this option, click the “Enable Log” check box.

Specify the log file’s path to be read by Symbol Legend. Enter only full path with file name and “.txt” extension.

Restriction : Log file’s path can not be within loaded library.

The File Path 1 is designed to be used as an overall log file, a log file that contains data from all labels in the project file. The File Path 2 is designed to store data for specific View Map, if you want to create table of legend that contains only the labels on the specific view.

Example for File Path 1 : C:\Project Folder\logfile_overall.txt

Example for File Path 2 : C:\Project Folder\logfile_sectionA01.txt

Symbol Legend

Before going ahead and using this object, here is a useful tip.

To avoid an error message from ArchiCad created from unfinished log file’s path while typing, go to Options > Work Environment > Dialog Boxes and Palettes > Dialog Box Auto-Update Delay and set a higher value (longer time).

General / Uniform Settings

Enter Log File Path

Use full path only. If the file path doesn’t exist or if the log file doesn’t contain appropriate data, an error message will appear.

Effects from the settings regarding Content Row and Content Text (Number , Symbol and Full Name) can only be visible when an appropriate log file’s path is entered.

Scale Method

All of the settings are the same as Symbol Label.

Symbol Shape

Select the Symbol Shape to be displayed. If the log file doesn’t contain the Symbol Shape selected, an error message will appear. The rest of the settings are the same as Symbol Label.

Reset Log File

After long period of working on the project file, labels will be added or deleted. An up-to-date log file is needed.

For Indigo Figs Symbol Label Suit 21 version 1.04+, see here.

For previous versions, see below.

There are 2 methods to reset log file. Each method has additional steps.

Method 1 :

  1. Click on the Reset Log File check box. The Object Selection Settings window will update briefly. This action creates a new blank file with the same name and then override the old file.
  2. Click OK to close the Object Selection Settings window.
  3. Refresh the Symbol Label by using “Rebuild & Regenerate” command (Ctrl + Shift + Alt + “R” on Windows). For ArchiCad19, you can pan or zoom in-out a few times. This process enables the labels to re-write data to the log file. You need to do this for all the views ( plans, elevations, sections, etc. )
  4. Refresh the Symbol Legend or the table of legend by simply select the object > open Object Selection Settings (Ctrl + T) and click OK to close. Or, Double clicking on one of the pink hotspots (except the lowest-middle one that will “Adjust height for maximum No. of rows per table”) also refresh the object (without changing the maximum No. of rows per table).

Method 2 :

  1. Minimize ArchiCad window and delete the log file directly from your drive. ! BE VERY CAREFULL. DON’T DELETE THE WRONG FILE !
  2. Go back to ArchiCad.
  3. Refresh the Symbol Label by using “Rebuild & Regenerate” command (Ctrl + Shift + Alt + “R” on Windows). For ArchiCad19, you can pan or zoom in-out a few times. This process enables the labels to re-write data to the log file. You need to do this for all the views ( plans, elevations, sections, etc. )

Symbol Legend or the table of legend will be updated automatically.

Uniform Settings

To use Uniform Settings for 2D Representation and Text, enable the check-boxes.

Symbol / Extension Line Settings

All of the settings are the same as Symbol Label.

Table Settings

Set the dimensions for the table.

If the “Even Content Row Height” is enabled, the highest values calculated will be used.

Table Settings (2D Representation)

Set Outline Pen, Line Type, Frame Type, Fill Pen, Fill, Fill Background Pen for Header (Title), Column Header, Content and Table Outline.

Header Text Settings

Set Header Text and Suffix. The suffix will be displayed after Header Text if there are more than one table.

Select Font, Text Alignment, Size, Pen, Font Face, Width Factor, Spacing Factor and Indents for Header Text. To set Indent Size, select options from a drop-down dialog box first, and then type in a desired size.

Column Header Text Settings

Set Column Header Text and Suffix. The suffix will be displayed after Column Header Text if there are more than one table. All 3 Column Header Texts need to be enter separately.

Select Font, Text Alignment, Size, Pen, Font Face, Width Factor, Spacing Factor and Indents for Column Header Text. To set Indent Size, select options from a drop-down dialog box first, and then type in a desired size.

Content Text Settings

Select edit options for Number Text, Symbol Text and Full Name Text.

Select Font, Text Alignment, Size, Pen, Font Face, Width Factor, Spacing Factor and Indents for Content Text. Text Alignment and Indents are only available for Full Name Text.