AddBeacon
Summary
Adds a beacon to the 3D world attached to an asset, illuminating it with a ray of light and allowing the user to focus their attention towards the Target/ asset.
Parameters
Target
Type: Path Default: None
Specifies the name or ARDI ID of the asset you would like to have a beacon added to. If using an asset ID, begin the target with the '#' character.
Color
Type: RGB or RGBA Default: 1,1,1,1
This parameter sets the color of the beacon. Color must be defined as “r,g,b” or “r,g,b,a” using normalized values (values ranging from 0.0 to 1.0)
| Parameter | Meaning |
|---|---|
| r | The value for the amount of red to be applied. Must be a value ranging from 0.0 to 1.0 |
| g | The value for the amount of green to be applied. Must be a value ranging from 0.0 to 1.0 |
| b | The value for the amount of blue to be applied. Must be a value ranging from 0.0 to 1.0 |
| a | The value for the amount of alpha transparency to be applied. Must be a value ranging from 0.0 to 1.0. This parameter is optional |
See Also
Examples
<addbeacon Target="TestShape" Color="0,1,0,0.1"/>
This will find the asset that has the name TestShape and create a beacon attached to it. The beacon has a color value of 0,1,0 which will make it green, with a 0.1 alpha transparency.