V2/CMS Tutorial/User Tools/Creating Content/Asset/Asset/Annotation

Add Asset Annotation

An annotation is used to add visual information to an asset. Senfi supports 4 types of annotation, namely:

• Line
• Volume
• 3D Text
• 2D Text

An asset can have more than one annotation.

Steps to Adding Line Annotation

Steps 1 to 4 to add line annotation to an Asset

1. Go to "Annotation" tab.
2. Click on "Show Asset" if you wish to place the line annotation at where the asset is located. This will help hide the 3D model above the asset's location. Else you can select to choose Building, Block and Level where the line annotation is to be placed on.
3. Click on the right of "Line Annotation".
4. Click "Edit in 3D" to start creating line.
   

   Steps 5 to 7 to add line annotation to an Asset
5. Click on 3D view to create a vertex.
   1. Click to go into first person view.
   2. Click to change camera interactions.
      1. Click to fit to view.
      2. Click to change camera's focal length.
      3. Click to change camera roll.
   3. Click to add a point.
   4. Click to select and/or move a point.
   5. Click to delete a point.
   6. Click to change line edit settings.
   7. Click to configure translate settings.
6. You need to create at least 2 vertices before the line appears.
7. Click "Editing" to finish creating line.
   

   Steps 8 to 13 to add line annotation to an Asset
8. Select a Color.
9. Set "Opacity" (value from 0 to 1).
10. Set "Thickness".
11. Check "Use Dashed" if you want a dashed line. If Dashed line is chosen, you can set the "Dash size" and "Dash ratio".
12. Set "Offset X", "Offset Y" and/or "Offset Z" if offset of line annotation from original plotted position is required.
    1. The larger the Dash size, the longer the pattern.
    2. When Dash ratio is set to 0.05, the gap covers very little of the line.
    3. When Dash ratio is set to 1.0, the gap covers the whole line.
13. Select "Follow Asset" if you require the line annotation to follow the asset as it moves.
14. For properties with the button, you will be able to add dynamic content to the selected property instead of static content. View "Adding Annotations with Dynamic Content" for more information on how to add dynamic content.

Steps to Adding Volume Annotation

Steps 1 to 4 to add volume annotation to an Asset

1. Go to "Annotation" tab.
2. Click on "Show Asset" if you wish to place the volume annotation at where the asset is located. This will help hide the 3D model above the asset's location. Else you can select to choose Building, Block and Level where the volume annotation is to be placed on.
3. Click on the right of "Volume Annotation".
4. Click "Edit in 3D" to start creating volume.
   

   Steps 5 to 7 to add volume annotation to an Asset
5. Click on 3D view on the right to create a vertex.
   1. Click to go into first person view.
   2. Click to change camera interactions.
      1. Click to fit to view.
      2. Click to change camera's focal length.
      3. Click to change camera roll.
   3. Click to add a point.
   4. Click to select and/or move a point.
   5. Click to delete a point.
   6. Click to change line edit settings.
   7. Click to configure translate settings.
6. You need to create at least 3 vertices before the volume appears.
7. Click "Editing" to finish creating volume.
   

   Steps 8 to 13 to add volume annotation to an Asset
8. Select a Color.
9. Set "Opacity" (value from 0 to 1).
10. Set "Height".
11. Set "Offset X", "Offset Y" and/or "Offset Z" if offset of volume annotation from original plotted position is required.
12. Change "Rotation" to adjust volume orientation.
13. Select "Follow Asset" if you require the volume annotation to follow the asset as it moves.
14. For properties with the button, you will be able to add dynamic content to the selected property instead of static content. View "Adding Annotations with Dynamic Content" for more information on how to add dynamic content.

Steps to Adding 3D Text Annotation

Steps 1 to 3 to add 3D Text annotation to an Asset

1. Go to "Annotation" tab.
2. Click on "Show Asset" if you wish to place the 3D text annotation at where the asset is located. This will help hide the 3D model above the asset's location. Else you can select to choose Building, Block and Level where the 3D text annotation is to be placed on.
3. Click on the right of "3D Text Annotation".
   

   Steps 4 to 14 to add 3D Text annotation to an Asset
4. Type text in "Content".
5. Select a color.
6. Set "Opacity" (value from 0 to 1).
7. Select the "Plane" you want the text to be in.
8. Set "Alignment".
9. You can flip the direction of the text by checking "Flip Direction".
10. Adjust "Size" till desired.
11. Adjust "Thickness" till desired.
12. Set "Offset X", "Offset Y" and/or "Offset Z" if offset of 3D text annotation from original position is required.
13. Change "Rotation" to adjust 3D text orientation.
14. Select "Follow Asset" if you require the 3D text annotation to follow the asset as it moves.
15. For properties with the button, you will be able to add dynamic content to the selected property instead of static content. View "Adding Annotations with Dynamic Content" for more information on how to add dynamic content.

Steps to Adding 2D Text Annotation

Steps 1 to 3 to add 2D Text annotation to an Asset

1. Go to "Annotation" tab.
2. Click on "Show Asset" if you wish to place the 2D text annotation at where the asset is located. This will help hide the 3D model above the asset's location. Else you can select to choose Building, Block and Level where the 2D text annotation is to be placed on.
3. Click on the right of "2D Text Annotation".
   

   Steps 4 to 12 to add 2D Text annotation to an Asset
4. Set "Alignment".
5. Select a color.
6. Select text outline color.
7. Type a text in "Content".
8. Set "Opacity" (value from 0 to 1).
9. Set "Size".
10. Set "Offset X" and/or "Offset Y" if offset of 2D text annotation from original position is required.
11. Change "Rotation" to adjust 2D text orientation.
12. Select "Follow Asset" if you require the 2D text annotation to follow the asset as it moves.
13. For properties with the button, you will be able to add dynamic content to the selected property instead of static content. View "Adding Annotations with Dynamic Content" for more information on how to add dynamic content.

Adding Annotations with Dynamic Content

The annotation's properties can be set dynamically, e.g. change in color of volume according to asset's temperature variation. To do so, click on the button in the property field.

Example of dialog box for dynamic color property

A dialog box will appear to allow you to set the dynamic content. To do so, you will need to select the source where the annotation property will get it's value from. Annotation properties can be set dynamically from the value of:

1. Asset Property (Available for 2D and 3D text annotation content)
   1. Asset Name
   2. Asset Description
   3. Asset Coordinate
2. Asset Attribute (Available if asset possess attribute data)
3. Metric Data (Available if asset possess metric data)

Using value from Asset Property

Example of using value from asset property

For 2D and 3D text annotation content property, the content value can be dynamically retrieved from the asset's name, description or coordinate. To do so,

1. Select "Get value from" Asset Property
2. Select Asset Property (Name/Description/Coordinate)
3. Click "Apply" to save all settings

Example of using value from asset name as content

Using value from Asset Attribute

Example of using value from asset attribute

For all annotation properties that allows dynamic content, the property value can be dynamically retrieved from the asset's attribute(s) if attribute data is available. To do so,

1. Select "Get value from" Asset Attribute.
2. Select Asset Attribute from list (Attribute list varies according to available data).
3. It is optional to have a mapping table. If mapping table is not enabled after an asset's attribute is chosen, the attribute's value will directly be applied as the property's value.
4. A mapping table is compulsory if the asset attribute's data type (string) does not match the property's data type.
5. To enable Mapping Table, toggle on Mapping Table switch
6. Perform value mapping by:
   

   Example of value mapping of attribute's value to content's value
   1. Mapping each attribute value to property's value.
   2. Providing default property's value (to be used when attribute value do not match any of the values stated in the mapping table).
   3. Adding additional value mappings (as needed) by clicking on the "Add New" button.
7. Click "Apply" to save all settings.

Using value from Metric

Example of using value from asset metric

For all annotation properties that allows dynamic content, the property value can be dynamically retrieved from the asset's metric(s) if metric data is available. To do so,

1. Select "Get value from" Metric.
2. Select Measurement from list (Measurement list varies according to available data).
3. Select Metric from list (Metric list varies according to available data).
4. It is optional to have a mapping table. If mapping table is not enabled after a metric is chosen, the metric's value will directly be applied as the property's value.
5. A mapping table is compulsory if the metric's data type does not match the property's data type.
6. To enable Mapping Table, toggle on Mapping Table switch
7. There are two types of mapping table available (choose either one):
   1. Value Mapping: Maps a specific metric value to a property value.
   2. Range Mapping: Maps a range of metric values to a property value.
8. Perform value mapping by:
   

   Example of value mapping of specific metric's values to property's value (1 to 1)
   1. Mapping each metric value to property's value.
   2. Providing default property's value (to be used when metric value does not match any of the values stated in the mapping table).
   3. Adding additional value mappings (as needed) by clicking on the "Add New" button.
9. Perform range mapping by:
   

   Example of range mapping of metric's values to property's value (range to 1)
   1. Adding a threshold.
   2. Providing property's value to be used for each range.
   3. Using swap button to change notations used for the range (<, <=, >, >=).
   4. Repeating steps 9.1 to 9.3 as necessary.
10. Click "Apply" to save all settings.

Acceptable values & default values for annotation's properties

Following are the acceptable values and default values for annotation's properties.

Property	Value Type	Value Range	Default Value
color	string	#000000 to #ffffff	#ffffff (2D Text, 3D Text); #000000 (Line, Volume)
outline_color	string	#000000 to #ffffff	#000000
opacity, dash_ratio	float	0.0 to 1.0	1.0 (opacity), 0.5 (dash_ratio)
thickness, height, size	float	0.0 to Infinity	18 (2D Text size); 1.0 (everything else)
dash_size	float	0.0 to Infinity	0.05
rotation	float	-Infinity to Infinity	0.0
content	string	N.A.	""