• Home

Render3D

A 3D model with a texture and material to be rendered in a Scene3D. More...

• List of all members, including inherited members

Properties

• ambient : alias
• components : alias
• material : alias
• renderTransform : alias
• rotationAxis : alias
• rotationAxisOffset : alias
• rotationOffset : alias
• scaleOffset : alias
• sceneRootEntity : Entity
• shininess : alias
• source : alias
• specular : alias
• texture : alias
• textureScale : alias
• xOffset : alias
• yOffset : alias
• zOffset : alias

Detailed Description

The Render3D component is the visual component of a 3D model with a texture and a material. It is added as a child of Scene3D::rootEntity and then rendered with OpenGL.

Usually you will use Render3D to load a Mesh with the source property and set a texture. However, you can customize to display custom Qt3D Entity instances like a PlaneMesh.

The Render3D and Scene3D concept has the advantage that you can add the Render3D component as a child of your EntityBase. It will then register automatically itself with the Scene3D::rootEntity and gets the position and rotation of the parent entity applied.

The Render3D component also makes working with often-needed functionality easier like changing the material settings like shininess, ambient or specular colors.

It is flexible enough to use custom materials or Qt3D Entity instances as its children - do so by changing the components property. By default, it uses a DiffuseMapMaterial, a Mesh and a Transform component internally.

The specialty of the Render3D component is that its transform gets set to the parent position automatically. This means if you change in the example below the position of the EntityBase, the position of the Qt3D Entity will also change. Specifically, the x, y, z, rotation and scale properties of the parent are forwarded to the Entity.

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