Skip to content

Commit 381cd82

Browse files
avr757flossyfolsom
andauthored
Bring consistency to sample titles (#161)
* Bring consistency to sample titles * Update readme.md * Apply suggestions from code review Co-authored-by: Rebekah Folsom <rfolsom@esri.com> * Apply suggestions from code review Co-authored-by: Rebekah Folsom <rfolsom@esri.com> --------- Co-authored-by: Rebekah Folsom <rfolsom@esri.com>
1 parent 946f60a commit 381cd82

File tree

9 files changed

+30
-29
lines changed

9 files changed

+30
-29
lines changed

sample_project/Content/SampleViewer/Samples/BuildingFilter/readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Building Filter
1+
# Filter building scene layers
22

3-
Allows users to toggle the visibility of different levels, construction phases, disciplines, and categories within a building scene layer. This sample demonstrates how to explore building scene layers and filter based on various criteria.
3+
Allows users to toggle the visibility of different levels, construction phases, disciplines, and categories within a building scene layer. This sample shows how to explore building scene layers and apply filters using different criteria.
44

55
![image](https://github.com/user-attachments/assets/f35d80c0-4d71-4af6-b462-44ef3a5d2d66)
66

sample_project/Content/SampleViewer/Samples/FeatureLayer/readme.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,28 @@ Query objects from the feature layer provided, or provide your own, in order to
44

55
![Image of Feature Layer Sample](FeatureLayer.png)
66

7-
## How to Setup (Feature Layer Level)
7+
## How to setup (Feature Layer Level)
88

99
1. Open the **FeatureLayer_lvl** level.
1010
2. Click on the **ArcGISMapActor** in the Outliner panel.
11-
3. Set your API key under Authentication section in the Details panel.
11+
3. Set your API key under the Authentication section in the Details panel.
1212
4. Click play and select a stadium from the list.
1313

14-
## How to Setup (Sample Viewer)
14+
## How to setup (Sample Viewer)
1515

1616
1. Click Play in Unreal Editor.
17-
2. Input your API key under the **API Key Drop down**.
18-
3. Click the **Sample Drop Down** and select **Feature Layer**.
17+
2. Input your API key under the **API Key Drop-down**.
18+
3. Click the **Sample Drop-down** and select **Feature Layer**.
1919

20-
## How to Use
20+
## How to use the sample
2121

22-
1. Already available is a Feature Layer of park trees, upon running the scene, these feature items will be spawned in at their default latitude and longitude and with all of the properties associated with that feature item.
23-
2. Clicking on any of these objects under the **Outliner** in unreal to see it's latatude, longitude, and any properties recieved by the query.
24-
3. Under the outfields drop down, by default it will be set to "Get All Outfields". Clicking on any of the other outfields will deselect "Get All Outfields" and will only get the outfield selected. Multi-select is supported. Outfields are the properties associated with the individual features.
22+
1. A Feature Layer of park trees is already available. When you run the scene, these feature items are spawned at their default latitude and longitude with all their associated properties.
23+
2. Click on any of these objects under the **Outliner** drop-down in Unreal Engine to see its latitude, longitude, and any properties received by the query.
24+
3. The Outfields drop-down is set by default to **Get All Outfields**. Click on any other outfield to deselect **Get All Outfields** and return only the outfield selected; multi-select is supported. Outfields are the properties associated with individual features.
2525

26-
## Important Note
27-
If the user would like to change the default link, they may place the link into the input field on screen. However if the link they plan to use has different **Request Headers** than the default ones we have set (/0/, query?, f=geojson, where=1=1, outfields=*), then the user will need to change them on the bp_feature game object in the **Outliner**. Each header has a different job for the link and gets added to the link once the user enters it into the input field.
26+
## Important note
27+
28+
To change the default link, users can update the link in the input field. However, if the link they provide has different **Request Headers** than the default ones provided (/0/, query?, f=geojson, where=1=1, outfields=*), the user must update these on the `bp_feature` game object in the **Outliner**. Each header performs a different function for the link and is added to the link once the user enters it into the input field.
2829

2930
## How it works
3031

sample_project/Content/SampleViewer/Samples/Flythrough/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Cinematic Camera Flythrough
1+
# Showcase a smooth, automated camera fly-through
22

33
Showcase a smooth, automated camera fly-through along a path of stop points. The path can be predefined or built at runtime from the current camera position, including mode switching (flythrough vs. free navigation), basic obstacle avoidance, and smooth position/rotation interpolation. The path can be saved to the disk for reuse.
44

sample_project/Content/SampleViewer/Samples/Geocoding/readme.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ This sample demonstrates the capability of the [Geocoding service](https://devel
1212
2. Click on the **ArcGISMap Actor** in the **Outliner**.
1313
3. Set your API key in the **Details** panel.
1414
4. Click play.
15-
5. To find a place, put a place name or address in the search bar and press Enter. For information about the type of locations that are supported by the Geocoding service, see the [ArcGIS REST APIs documentation](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm).
16-
6. To find an address of a place, drop the marker to your point of interest by clicking in the viewport while holding Shift, and you will see the address displayed above the marker.
15+
5. Use the search bar to find a place by name or address. For information about the type of locations that are supported by the Geocoding service, see the [ArcGIS REST APIs documentation](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm).
16+
6. To find a place's address, drop the marker on your point of interest by clicking in the viewport while holding Shift. The address will be displayed above the marker.
1717

18-
**Note:** This sample is only set up to work with mouse and keyboard.
18+
Note: This sample is only set up to work with mouse and keyboard.
1919

2020
## How it works
2121

sample_project/Content/SampleViewer/Samples/HitTest/readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Visualize 3DObject IDs
1+
# Identify 3D object scene layer feature object IDs
22

33
Get the ID for individual buildings in a Level.
44

sample_project/Content/SampleViewer/Samples/MaterialByAttribute/readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Visualize different attributes through render filtering
1+
# Render a 3D object scene layer by attribute values
22

3-
Apply shaders to 3DObject Scene layer based on different attributes.
3+
Apply shaders to 3D Object Scene layer based on different attributes.
44

55
![Image of MaterialByAttribute](MaterialByAttribute.png)
66

sample_project/Content/SampleViewer/Samples/OverviewMap/readme.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
# Visualize your position in an Overview Map
1+
# Visualize your position in an overview map
22

33
![Image of Overview Map](OverviewMap.png)
44

5-
## How to Setup (Overview Map Level)
5+
## How to setup (Overview Map Level)
66

77
1. Open the **OverviewMap_bp** or **OverviewMap_cpp** level.
88
2. Click on the **ArcGISMapActor** in the Outliner panel.
99
3. Set your API key under the Authentication section in the Details panel.
1010
4. Click Play and select a city from the list.
1111

12-
## How to Setup (Sample Viewer)
12+
## How to setup (Sample Viewer)
1313

1414
1. Click Play in Unreal Editor.
1515
2. Input your API key under the **API Key Drop-down**.

sample_project/Content/SampleViewer/Samples/StreamLayer/readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Subscribe to a stream service
1+
# Subscribe to an ArcGIS stream service
22

3-
Subscribe to the stream service's WebSocket and receive information through to update information in real time.
3+
Subscribe to the stream service's WebSocket and receive information to update information in real time.
44

55
![Stream layer](StreamLayer.png)
66

sample_project/Content/SampleViewer/Samples/TimeOfDay/readme.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
1-
# Visualize Time of Day
1+
# Visualize and control the time of day
22

3-
Control the Time of Day manually, simulate it at a given speed, or animate it from one time to anoter.
3+
Control the Time of Day manually, simulate it at a given speed, or animate it from one time to another.
44

55
![Image of Time of Day Sample](TimeOfDay.png)
66

7-
## How to Setup (Time of Day Sample Level)
7+
## How to setup (Time of Day Sample Level)
88

99
1. Open the **TimeOfDay** level.
1010
2. Click on the **ArcGISMapActor** in the Outliner panel.
1111
3. Set your API key under the Authentication section in the Details panel.
1212
4. Click Play and change the time of day using the settings panel.
1313

14-
## How to Setup (Sample Viewer)
14+
## How to setup (Sample Viewer)
1515

1616
1. Click Play in Unreal Editor.
1717
2. Input your API key under the **API Key Drop-down**.

0 commit comments

Comments
 (0)