Viewport Feature

Viewport Feature

The viewport renders the map inside a rectangular area, allowing proper cropping during pan and zoom. This is essential when embedding the map into a UI layout.

Setting Up the Viewport

1. Go to GameObject > 3D Object > World Map 2D Edition – Viewport (or drag the prefab from Resources/Prefabs).
2. In the WorldMap2D inspector, assign the new Viewport GameObject to the Render Viewport field.
3. The map now renders inside the viewport.

Removing the Viewport

1. Clear the Render Viewport field in the WorldMap2D inspector.
2. Delete the Viewport GameObject from the scene.

Screen Overlay Mode

When a viewport is assigned, you can enable Screen Overlay Mode to position the map like a Canvas UI element. This works by parenting the viewport in front of the main camera at a position and size defined by a normalized rectangle (0 = left/bottom, 1 = right/top).

To enable it:

1. Assign a Render Viewport to the map.
2. Check the Screen Overlay Mode toggle.
3. Specify the screen rectangle using the normalized coordinates.

Positioning the Map on Screen

While the map can be positioned anywhere using transform properties, the viewport with Screen Overlay Mode provides precise UI-like positioning with proper cropping. This is the recommended approach for HUD-style map displays.