Pathfinding Tools in the Second Life Viewer
 |
Note: The Viewer tools described here are available only in the Second Life Viewer Beta build. Look under the "Other Viewers" section on the Second Life Viewer download page |
Introduction
For pathfinding, each region has a navigation mesh, commonly referred to as a "navmesh". The navmesh is a representation of the region's geometry generated and used by the physics simulator to determine paths for the pathfinding characters. The navmesh may be in one of the following three states:
- Up-to-date
- Has pending changes
- Building (a.k.a. rebaking)
The navmesh will transition through these states according to the following diagram:
Six new elements have been added to the SL Viewer interface to communicate the navmesh state for the current region. These new elements are:
- icon representations of the pathfinding region state for the SLURL bar
- a "Rebake region" button that appears above the lower toolbar
- a right-click context menu option addition
- an additional field on the Build floater
- an additional field on the Object Profile floater
- additional simulator metrics on the Statistics floater
In addition to these new elements, three new floaters allow users to more efficiently create, visualize, test, and debug pathfinding-enabled characters. These tools are not required to create pathfinding behaviors but are particularly useful to builders and experienced creators in Second Life. These new floaters are:
- Pathfinding linksets
- Pathfinding characters
- Pathfinding view / test
Pathfinding UI Elements
Note that other residents editing pathfinding objects on the same region may create pending changes to the navmesh. When this occurs, all residents on the same region and with build rights will see the appropriate SLURL bar icons and rebake region button.
Pathfinding Icons in SLURL Bar
The SLURL bar indicates the three pathfinding states of the current region.
- Navmesh is up-to-date The current region's navmesh is up-to-date. No icon is shown as this is the expected default state.
- Navmesh has pending changes The region has pending changes that have not yet been baked into the navmesh. A pathfinding icon with a construction symbol is shown.
- Dynamic pathfinding is disabled The region has dynamic pathfinding disabled. Pathfinding characters will not work as expected. A pathfinding icon with a disabled symbol is shown.
Rebake Region Button
When a region has pending changes, the appropriate icon will be shown in the SLURL bar, as described above. In addition, if the user has build rights for any parcel on the current region, the user will also be able to see a "Rebake region" button that displays above the lower toolbar.
When the user clicks this button, a request is sent to the region to rebake the navmesh for the current region. As rebaking a region may be a time intensive process, the button will change to indicate "Region is rebaking" during this server process. After the rebaking is complete, this button on the viewer will vanish.
When right-clicking on an object in-world, pathfinding-specific menu options may be included in the pop-up context menu.
If the user right-clicks on a linkset object in-world, a menu option "Show in linksets" will allow the user to open the Pathfinding Linksets floater with the current object selected.
If the user right-clicks on a pathfinding character object in-world, a menu option "Show in characters" will allow the user to open the Pathfinding Characters floater with the current object selected.
Additional field on the Build floater
The Build floater has also been updated with an additional field indicating the pathfinding attributes of the current object.
The following image is a screenshot of the Build floater with a character object selected.
The following image is a screenshot of the Build floater with an object that affects navmesh selected. This object could be a walkable, static obstacle, material volume, or exclusion volume.
 |
Warning: For linksets that do affect the navmesh, it will be impossible to modify the object across the region boundary. The user and the object affecting a navmesh must be in the same region to enable modification of the object. This will be indicated on the General tab of the Build floater as illustrated in the following screenshot. |
Additional field on the Object Profile floater
Similar to the afore-described Build floater, the Object Profile floater has also been updated with an additional field indicating the pathfinding attributes of the current object.
The following image is a screenshot of the Object Profile floater with an affects navmesh object selected.
Additional simulator metrics on the Statistics floater
For advanced users, additional simulator metrics have been added to the Statistics floater. The Statistics floater, available from the main menu Advanced > Performance Tools > Statistics Bar, has the following 3 additional fields reporting statistics from the simulator regarding pathfinding activity:
- AI Step Time - The average time spent during each frame computing character AI events.
- Skipped Silhouette Steps - The number of steps that are skipped per second in computing the influence of objects of type Movable Obstacles on the navmesh. A high value here means that objects on the region are marked as Movable Obstacles and could be contributing to improper pathfinding behavior on the region. To lower this value, set all objects that do not move to either type Walkable or Static Obstacle, and optimize any Movable Obstacle shapes to meet the Good Building Practices Guide.
- Characters Updated - The average percentage of characters updated during each frame. A low value here means that character AI computations are taking too long during each frame, and thus some character updates are skipped during subsequent frames. This could be contributing to improper pathfinding behavior on the region. To increase this value, decrease the number of characters on the region, and optimize any Movable Obstacle shapes to meet the Good Building Practices Guide. Note that the Pathfinding Characters floater (described below) may also be used to determine which characters on the region are contributing the most to the region's CPU time.
Pathfinding Floaters
These three pathfinding floaters may all be accessed through the Build->Pathfinding menu in the Project Viewer - Pathfinding.
Pathfinding Linksets Floater
Overview
The intent of the Pathfinding Linksets floater is to give advanced users and builders the ability to customize an area to achieve interesting effects with pathfinding-enabled characters.
The floater displays information for all linksets within the current region for which the user has the ability to alter. The table reports useful information including
- Linkset Name
- Description
- Owner
- Land Impact
- Distance from the resident's avatar
- Linkset Use
- Potential values
- Walkable
- Static Obstacle
- Movable Obstacle
- Material Volume
- Exclusion Volume
- Movable Phantom
- Potential values
- Walkability Coefficients
- Character Type A (example use: humanoid)
- Character Type B (example use: creature)
- Character Type C (example use: mechanical)
- Character Type D (example use: other)
Additionally, selecting any linksets within the floater will also select the object(s) within the Viewer.
Controls
Filter by:
| Filter by Name | Enter text by which to filter the linkset list based on Name attribute. |
| Filter by Description | Enter text by which to filter the linkset based on the Description attribute. |
| Filter by linkset use... | Click to display only the linksets that match selected use. |
| Apply | Click to apply the filters to the linkset list. |
| Clear | Click to clear the filters and return the linkset list back to the original un-filtered contents. |
| Refresh list | Click to refresh the linkset list from the server. Use after you add or delete a linkset inworld. |
| Select all | Click to select all linksets in the list. |
| Select none | Click to deselect all selected linksets in the list. |
| Show Beacon | Select to display a beacon indicating the inworld location of each selected linkset. Use to locate hard-to-find or invisible linksets in the region. |
| Take | Click to take the selected linkset(s) into your inventory. |
| Take Copy | Click to take a copy of the selected linkset(s) into your inventory. |
| Teleport Me To It | Teleports you to the selected linkset. Useful to find faraway linksets. Note this button is only enabled when you have selected one linkset. |
| Return | Click to returns the selected linkset(s) to the owner's inventory. |
| Delete | Click to delete the selected linkset(s) from the region. |
| Choose Linkset Use | Change the linkset use attribute of the selected linkset(s). |
| Walkability Coefficients | Enter individual walkability coefficients for each character type (A, B, C, D).
Walkability coefficients range from 0% to 100% to determine the influence the effect the linkset has on a character's speed while the character is traversing across the linkset object. For example, a linkset with Walkability Coefficient of 50% for character type A will cause characters of type A to reduce their speed by half while the character is traversing the object. |
| Apply Changes | Click to apply changes to the selected linkset(s) use type and/or walkability coefficients. |
Notes
- For linksets with use fields marked as "[restricted]", only certain linkset use modes are available. This restriction is the result of the object not having modifiable permission enabled for the user.
- For linksets with use fields marked as "[concave]", the linkset use modes for Material Volume and Exclusion Volume are not available. This restriction is the result of the shape object not being convex. All pathfinding volumes must be convex.
- The "[Terrain]" linkset is available to be viewed and edited by the estate managers only. Additionally, while the walkability coefficients for the "[Terrain]" linkset are modifiable by estate managers, the Linkset Use field of "[Terrain]" linkset is not modifiable by anyone and will always be "Walkable".
Example use
The advanced users and builders will use the Pathfinding Linksets floater to customize areas to create interesting effects for pathfinding-enabled characters.
For instance, imagine the scenario of a builder constructing a single room in a pathfinding-enabled house. For the single room, the builder would use the following types as follows:
| Linkset Use | Description |
|---|---|
| Walkable | The floor linkset would be set to be Walkable to allow characters to move across the floor. |
| Static Obstacle | A desk linkset in the room would be set to be Static Obstacle to block characters from walking through or across the object.
NOTE Any object that should block character movement and that does not move should be marked as Static Obstacle to improve performance of pathfinding characters. |
| Movable Obstacle | A door linkset in the room would be set to be Movable Obstacle. This will still block characters but, in contrast to Static Obstacles, Movable Obstacles will allow the linkset itself to move. In the case of the door, this will allow the door to open and close, but will still prevent characters from walking through the door. |
| Material Volume | Material Volumes are phantom objects that can be used to affect the walkability coefficients of intersecting objects. Imagine that the builder applied a texture to the floor. Also, imagine that the floor texture includes small throw rug in the middle of the room. (The builder did not want to create a separate object for the rug, so is using a texture on the floor to give the appearance of a rug). The builder can then create a Material Volume object intersecting the floor at the location of the rug. Then, by setting a lower walkability coefficient for the Material Volume, the builder will create the affect of slowing down characters as the characters traverse across the painted rug area. |
| Exclusion Volume | Exclusion Volumes are phantom objects that can be used to create areas where characters are prevented from moving. For instance, the builder can use an Exclusion Volume to create a section of the room where avatars would be able to move, but characters would be blocked from following. |
| Movable Phantom | Movable Phantoms are phantom objects that have no affect on pathfinding-enabled characters. |
In addition to linkset use attributes, builders can achieve additional effects by modifying the walkability coefficients for linksets. The walkability coefficients are values, ranging from 0% to 100%, that affect a characters speed. A walkability coefficient of 50% will reduce a character's speed by half while the character is traversing across the linkset.
Pathfinding Characters Floater
Overview
The intent of Pathfinding Characters floater is primarily for users to locate characters moving throughout a region and to identify the CPU cost of characters affecting the performance of a region.
The floater displays information for all characters within the current region for which the user has the ability to manipulate. The table reports useful information including
- Character Name
- Description
- Owner
- CPU Time
- Altitude
Controls
| Refresh List | Click to refresh the character list from the server. Typically used after a character is added or deleted in-world. |
| Select All | Click to select all characters in the list. |
| Select None | Click to deselect all selected characters in the list. |
| Show Beacon | Select to display a beacon indicating the in-world location of each selected character. Use this option to locate hard-to-find or invisible characters in the region. |
| Show Physics Capsule | Select to display the physics capsule representation of the currently selected character. Use this option to illustrate how the pathfinding physics engine sees the character shape for collisions. Note: this checkbox is only enabled when you select one character. |
| Take | Click to take the selected character(s) into the user's inventory. |
| Take Copy | Click to take a copy of the selected character(s) into the user's inventory. |
| Teleport Me To It | Click to teleport to the selected character. Use this function to rapidly find faraway characters. Note: this button is only enabled when you select one character. |
| Return | Click to return the selected character(s) to the owner's inventory. |
| Delete | Click to delete the selected character(s) from the region. |
Example use
- If a region owner has created a pathfinding-enabled character but is unable to find the character within the region, the Characters floater can be used to locate and select the character.
- Additionally, the Pathfinding Characters floater reports the CPU time cost for each character within the region. This functionality can be used by advanced users to identify which characters are impacting performance the most.
Pathfinding View/Test Floater
Overview
The intent of the Pathfinding View/Test floater is for advanced users who are building pathfinding-enabled objects and characters.
This floater consists of 3 basic areas.
- Status area (illustrating both the Viewer and Simulator status of the region's navmesh)
- View tab Controls
- Test Path tab Controls
The following image is a screenshot of the Pathfinding View/Test floater with the navmesh displayed.
The following image is a screenshot of the Pathfinding View/Test floater with the pathfinding object types displayed.
The following image is a screenshot of the Pathfinding View/Test floater with a test path displayed.
Controls
| Viewer Status | Reports the status of the pathfinding navmesh including the download process of retrieving the navmesh data from the simulator. |
| Simulator Status | Reports the status of the region's navmesh on the simulator including when the navmesh has pending changes, is building, or is up-to-date. |
View tab
Show
| World | Select to display the normal world view of the region's objects. |
| Movables Only | Select to display only the region's objects that are not marked as affecting the navmesh (Walkable, Static Obstacle, Material Volume, or Exclusion Volume). This is useful to determine which objects on the region are still movable and thus contributing to increase pathfinding time on the simulator. Note: this checkbox is only enabled when World is also selected. |
| Navmesh | Toggles the display of the navmesh within the Viewer. |
| Show Walkability Map | If the navmesh is displayed, the drop-down enables you to view the navmesh as a heatmap. This mode enables you to view the walkability values baked into the navmesh in the style of a heatmap illustrating the respective values across the navmesh. |
| Walkables | Select to display the walkables used when the navmesh was generated. Use this option to visualize how objects of type walkable affected the navmesh generation. |
| Material Volumes | Select to display of material volumes used when the navmesh was generated. Use this option to visualize how objects of type material volume affected the navmesh generation. |
| Static Obstacles | Select to display static obstacles used when the navmesh was generated. Use this option to visualize how objects of type static obstacle affected the navmesh generation. |
| Exclusion Volumes | Select to display exclusion volumes used when the navmesh was generated. Use this option to visualize how objects of type exclusion volume affected the navmesh generation. |
| Water Plane | Select to display a simple plane representation of the water. Use this option when the World is hidden to visualize where the water-line is in the world. |
| With X-ray Vision | Select to alter the rendering into x-ray mode allowing for partial visibility through other objects. Use this option to get a better visualization of the world in complex situations. |
Test tab
To specify the starting point of the test character path, hold down the <CTRL> key and click the left mouse button in the Viewer window.
To specify the ending point of the test character path, hold down the <SHIFT> key and click the left mouse button in the Viewer window.
| Character Width | Use the slider to specify the width of the test character, ranging from 0.1 meter to 2 meters. |
| Character Type | Specify the character type of the test character. |
| Clear Path | Click to clear a path generated and displayed in the Viewer. |
Example Use
- The advanced user will use the Visualization controls to visualize how the navmesh and related permanent objects have been generated. By seeing this visualization of how the physics engine interprets the navigation information, the advanced user can understand how to better customize the pathfinding-enabled objects to obtain the desired behaviors of characters.
- The advanced user will use the Test Tab to visualize how a test character would choose the path between selected start and end points.
Known Issues
| JIRA | Summary | Hardware | Fixed in Version |
|---|---|---|---|
| MAINT-1291 | Enable Debug GL crashes the viewer to the desktop | Mac Pro running 10.7.4 with AMD Radeon HD5770 iMac running Mac OS X Lion 10.7.4 (11E53) with AMD Radeon HD 6770M (512 MB) PC Clone running XP Pro with GeForce2 Ultra |
|
VWR-29491 |
3.4.0 (263727) | ||
VWR-29497 |
3.4.0 (263727) | ||
| 3.4.0 (263727) | |||
| 3.4.0 (263727) | |||
| PATH-572 | Underwater 'Walkables' shapes are reflected about the water plane | ||
PATHBUG-174 |
3.4.0 (263727) | ||
| PATH-659 | navmesh being drawn over worn flexi prims and under avatar | ||
| PATH-790 | Physics capsule rendering of character shapes is broken after zooming | ||
| PATH-812 | Show capsules option creates black capsule instead of blue | ATI Radeon X300 Video card ATI Radeon X600 Video card |
|
| 3.4.0 (262596) | |||
| PATH-821 | Toshiba Satellite L645 laptop displays black environment | Toshiba Satellite L645 laptop with AMD Radeon HD 4200 Mobile graphics | |
| PATH-822 | Configuration with ATI Radeon 7500 can launch Viewer, serious GFx issues | AMD Athlon64 3000+ with ATI Radeon 7500 video card | |
| 3.4.0 (262596) | |||
VWR-29431 MAINT-1362 |
3.4.0 (263727) | ||
| 3.4.0 (263727) | |||
| 3.4.0 (263727) | |||
| 3.4.0 (263727) | |||
| 3.4.0 (263727) |