You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/studio/guides/xr/image-targets.mdx
+92-50Lines changed: 92 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,15 +5,15 @@ description: Image Targets allow you to set a flat, cylindrical or conical shape
5
5
6
6
# Image Targets
7
7
8
+
:::tip
9
+
Use the [image target example project](https://github.com/8thwall/studio-image-targets-example) as a reference to get started and confirm your project structure is set up correctly.
10
+
:::
11
+
8
12
## Introduction
9
13
{frontMatter.description}
10
14
<br></br>
11
15
<br></br>
12
16
13
-

14
-
15
-
---
16
-
17
17
## Enabling Image Targets
18
18
19
19
To enable image targets in your project, you must use a World camera.
@@ -25,80 +25,122 @@ To enable image targets in your project, you must use a World camera.
To use image targets in your project, you must generate some required assets with a command line interface (CLI). These files contain image target metadata needed by the engine.
33
33
34
-
Locate the **Image Targets** panel at the bottom left of the Studio Interface. Click on the **( + )** to add a flat, cylindrical, or conical image target.
34
+
:::tip
35
+
See [documentation on Image Target CLI](https://github.com/8thwall/8thwall/blob/main/apps/image-target-cli/README.md) for more details on cropping and cylindrical/conical image targets.
On generation, the following will be outputted to the specified folder:
75
+
76
+
* Metadata within a JSON file
77
+
* Original image
78
+
* Cropped image
79
+
* Thumbnail image (263x350)
80
+
* Luminance image (grayscale, 480x640)
81
+
* Geometry image (for conical)
82
+
83
+
:::note[Important]
84
+
Make sure the output folder was specified as a folder named `image-targets` at the root of your 8th Wall project. See [Verifying Project Structure](#verifying-project-structure) for more details.
85
+
:::
64
86
65
-
### Linking the Image Target
87
+
##Configuring Image Targets
66
88
67
-
Link the image target entity to an uploaded image target.
89
+
Create a file named `app.js` in the `src` folder (if you don't have one already). At the top of the file, configure image targets by providing paths to each image target's metadata JSON file.
When you add an image target to your project, an image target mesh will appear so that you can align and position other 3D content against the image target.
117
+
## Adding the Image Target Entity
79
118
80
-
---
119
+
To add an image target to your scene:
120
+
1. Click **( + )** in the Scene Hierarchy and select **Image Target**.
The name of the image target entered in the inspector should match what was entered in the CLI when generating the image target files. You can double check the name of the image target by looking at the prefix of the image target assets and/or in the JSON file associated with the image target.
87
133
88
-
To simulate movement and content placement around an image target added to your scene:
134
+
## Using Image Targets
89
135
90
-
1. Make sure your **Camera Settings** are set to **World**
91
-
2. Press **Play** to open the Simulator
92
-
3. Use the **Simulator environment options** (bottom left selector) to find your desired Image Target
93
-
4. Use the **WASD keyboard shortcuts** to simulate movement. *(You must first click on the Simulator panel before using the keyboard)*
136
+
When you add an image target to your project, an image target mesh will appear so that you can align and position other 3D content against the image target.
0 commit comments