Indicator
Summary
This function creates an indicator asset and places it in the virtual environment at a specified position. This is useful for adding markers or notes to guide users towards specific areas or assets.
Parameters
Target
Type: Text Default: None
Specifies the name or ARDI ID of the asset you would like to attach the indicator to. If using an asset ID, begin the target with the '#' character.
Text
Type: Text Default: HERE
This parameter allows you to specify the label of the indicator. The label will appear as text, centered on the indicator itself.
Offset
Type: XYZ Coordinates Default: 1,0,0
This parameter allows you to specify an offset value in XYZ Coordinates for which the indicator will be placed associated with the target asset.
Facing
Type: XYZ Coordinates Default: -1,0,0
This parameter allows you to specify an offset value in XYZ Coordinates for which the indicator will be rotated associated with the target asset.
Scale
Type: Float Default: 1
This parameter allows you to specify a scale value that will allow you to enlarge or shrink the indicator based on the amount specified. Values above 1 increase the size where as values below 1 will decrease the size.
Style
Type: Text Default: Large 2D
This parameter allows you to specify the style of the indicator.
These are the main styles that are available:
| Style | Effect |
|---|---|
| Large 2D | A large styled indicator with a tapering effect. |
| Small Top 2D | A smaller indicator with an indentation pointing from the top of its side. |
| Small Mid 2D | A smaller indicator with an indentation pointing from the middle of its side. |
| Speech Mid | A speech bubble effect. |
Color
Type: RGB Default: 0,1,0
This parameter allows you to specify a color for the indicator. Color is defined as normalized RGB values (values from 0.0 to 1.0) delimited by a ',' .
For example: A value of “0.5,0,1” will create a color with 50% red, 0% green and 100% blue applied to it.
LockToCamera
Type: Boolean Default: True
If true, this parameter will force the indicator to lock itself to the facing direction of the camera, making it so that the indicator always appears fully visible.
See Also
Examples
<indicator target="TankA" text="Primary Tank" offset="0,10,0" facing="-90,0,0" />
The above code will search for the asset named TankA and create an indicator attached to it positioned locally at 0,10,0 and rotated -90 on the X axis. It will have the text Primary Tank.