Billboard System
The components inside this group (Billboard and Billboard Element) lets you create custom Billboards. To work in the procedure, the Billboard object needs:
- The Billboard component: allows managing the billboard as an object in the scene.
- Canvas as a child: contains the elements (texts, images, etc.) of the billboard. To set these elements in the procedure, each element needs to have the Billboard Element component.
note
You can find Billboard examples inside WEAVR\Essential\Assets\Prefabs\Billboards.
Billboard Element
Billboard Component
The Billboard component allows managing the billboard as an object in the scene by customizing the following properties.
| Property | Function |
|---|---|
| Ignore Render Depth | If enabled, the billboard is not occluded by other objects in the scene |
| Start Point Offset | If enabled, the start position of the billboard line is set in respect to the transform of the focused object (this setting can be set in the Billboard actions) |
| End Point Offset | If enabled, the end position of the billboard line is set in respect to the transform of the focused object (this setting can be set in the Billboard action) |
| Text Component / Text Element | The GameObject containing the billboard text. If it is a TextMeshPro – Text (UI) it is referenced in Text Component, if it is a Text it is referenced in Text Element |
| Show Connecting Line | If enabled, the line connecting the billboard and the object is shown |
| Animate Duration | How long the billboard animates when it appears in the scene |
| Keep Relative Position | If enabled, the billboard keeps the same relative position with respect to the focused object and does not rotate |
| Look at Camera | If enabled, the billboard always faces the camera |
| Pivot Axis | Rotational axis of the billboard when facing the camera. Camera Align = Billboard rotates with the camera view. Up = Billboard rotates only on a vertical axis. Free = Billboard rotates on three axes |
| Dynamic Size | If enabled, the billboard size changes regarding the camera distance |
| Springy Resize | If enabled, the billboard animates when resized |
| Size to Screen Ratio | Percentage of the camera view that the billboard occupies. It is with respect to the screen width and restricted to the minimum and maximum world sizes |
| Word Size Limits | Billboard size in the virtual world will be constrained between the min. and max. limits (in meters) |
| Distance Limits | Billboard will be visible to the camera if their distance is between the specified range (in meters) |
| Fade Distance | Distance from the Distance Limits property at which the billboard starts to fade |
| Line Settings | Various settings regarding the line connecting the billboard and the object |