• Home

Scene3D

The root element for rendering 3D objects within a 2D GameWindow. More...

• List of all members, including inherited members

Properties

• camera : alias
• cameraFarPlane : alias
• cameraNearPlane : alias
• cameraPosition : alias
• cameraUpVector : alias
• cameraViewCenter : alias
• isControlledCamera : bool
• rootEntity : alias
• skybox : alias
• skyboxBaseName : alias
• skyboxCameraRotationAngle : alias
• skyboxCameraRotationAxis : alias
• skyboxExtension : alias

Detailed Description

The Scene3D component is the root element to display 3D objects within a 2D GameWindow.

In the Qt3D module, you have several options to display 3D content. However, using the Scene3D component is the most flexible one because you can then mix 2D UI with 3D rendering.

It is based on a Scene3D component with these additional benefits:

• It combines a Camera, FrameGraph and a SkyboxEntity within one component. This has the benefit that you save code to define them in every project, as they will be used in the majority of applications. If you do not need a SkyboxEntity for example, just leave the skyboxBaseName property empty and none will be used.
• It provides a rootEntity property to use together with the Render3D component. The Render3D component allows to put a Qt3D Entity anywhere in the scene graph. This enables a flexible entity-component system approach for your game logic.

Note: Qt3D and also the Felgo 3D Components are in a Tech Preview state and may change its API in future versions.

Example Usage

Here is an example how to use Scene3D and Render3D in a Felgo project:

 import Felgo 3.0
 import QtQuick 2.0

 GameWindow {

   // is needed by the Render3D component - to this entity the Entity objects are added to
   property alias rootEntity: scene3D.rootEntity

   Scene {
     id: gameScene

     Level {

       EntityBase {
         entityType: "car"

         // this Box2D physics component modifies the entity position by applying forces
         // when the entity position changes, the Render and Image components change too
         BoxCollider {}

         // allows loading a Mesh and a texture
         // registers itself at the rootEntity
         Render3D {
           source: "assets/3d/car_model.obj"
           texture: "assets/3d/car_texture.png"
         }

         // you could mix 2D images with the 3D renderer like this
         Image {
           source: "assets/2d/car.png"
         }
       }// EntityBase
     }// Level

   }// GameScene

   Scene3D {
     id: scene3D
   }

   Scene {
     id: hudScene
     // put user elements like buttons here
   }

 }

For a complete game how to use Scene3D together with the Render3D component, see the CarChallenge 3D Demo.

Property Documentation