Node Copied to Clipboard!

Editor Documentation


Viewports

Modest3D contains a Main Viewport by default, which is what is displayed in the Player. This Main Viewport displays what is seen by the Main Camera.

It’s possible to create more than one camera and viewport in Modest3D to allow the user to view more than one scene at a time in their lesson.

You can add a Viewport to your lesson while inside a Setup node by right-clicking and selecting UI -> Viewport from the list. The Viewport is editable via the Editor or the Properties tabs.

From the Properties tab, many options are available for customization.

Properties Tab - Customization

  • 2D Properties
    • Anchor. Anchor will choose a location on the screen to “anchor” the Viewport, and further offsets and adjustments can be made from that location. The options available are TopLeft, Top, TopRight, Left, Center, Right, BottomLeft, Bottom, and BottomRight; all corresponding to a location in the Player.
    • Offset (X, Y). The Offset properties allow the Viewport to be offset from their anchored location. The A and R buttons indicated absolute vs. relative measurement. If set to A, the offset is a pixel value. If set to R, the offset is relative to the size of the viewport (i.e. an Offset Y value of 0.5 will offset it by half of the viewport’s height).
    • Height and Width. These properties dictate the measurements of the viewport. Similar to the Offsets, they can be modified in either absolute or relative measurements using the A and R buttons.
  • Appearance
    • Is Highlighted. This checkbox indicates whether the Viewport will be Highlighted or not.
    • Highlight Color. Clicking the color box will display a color picker.
    • Is Visible. This checkbox indicates whether the Viewport will be hidden or shown.
    • Tooltip. Enter text here for a tooltip pop-up when hovering over the Viewport in your lesson.
  • Miscellaneous
    • Action Type. Setup node property that indicates whether the Viewport is being created, changed, or destroyed.
    • Name. Allows naming of the Viewport.

Note that when you create a viewport, it will display a blank screen by default – this is because there is no Camera assigned to it. For instructions on how to connect a Camera to a Viewport, see the Cameras documentation.

Connecting a Viewport to a Camera

To assign a Viewport to a Camera, open the Properties tab of the Camera. Drag the Viewport from the Scene tab to the Viewport Name box in the Properties tab of the Camera. This will display the camera’s view in the Viewport.