Qt 3D QML Types

To import and use the module's QML types, use the following statement:


  import Qt3D.Core 2.0

For collision detection, renderer, and input-related QML types, use the following import statements:


  import Qt3D.Render 2.0
  import Qt3D.Input 2.0
  import Qt3D.Logic 2.0
  import Qt3D.Extras 2.0
  import Qt3D.Animation 2.0

QML Types

Qt 3D Core Module

Component3D	Provides the base type for creating Qt 3D components
Transform	Used to perform transforms on meshes
Entity	Node subclass that can aggregate several Component3D instances that will specify its behavior
EntityLoader	Provides a way to dynamically load an Entity subtree
Node	A base QML type that other types inherit. It cannot be directly created
NodeInstantiator	Dynamically creates nodes
QuaternionAnimation	A PropertyAnimation for quaternions

Qt 3D Input Module

AbstractActionInput	QML frontend for the abstract Qt3DInput::QAbstractActionInput C++ class
AbstractAxisInput	QML frontend for abstract QAbstractAxisInput C++ class
AbstractPhysicalDevice	QML frontend for the abstract Qt3DInput::QAbstractPhysicalDevice C++ class
Action	QML frontend for the Qt3DInput::QAction C++ class
ActionInput	QML frontend for the Qt3DInput::QActionInput C++ class
AnalogAxisInput	QML frontend for QAnalogAxisInput C++ class
Axis	QML frontend for the Qt3DInput::QAxis C++ class
AxisAccumulator	QML frontend for the Qt3DInput::QAxisAccumulator C++ class
AxisSetting	QML frontend for the Qt3DInput::QAxisSetting C++ class
ButtonAxisInput	QML frontend for QButtonAxisInput C++ class. The axis value is controlled by buttons rather than a traditional analog input such as a joystick
InputChord	QML frontend for the Qt3DInput::QInputChord C++ class
InputSequence	QML frontend for the Qt3DInput::QInputSequence C++ class
InputSettings	Holds the pointer to an input event source object
KeyboardDevice	QML frontend for QKeyboardDevice C++ class
KeyboardHandler	QML frontend for QKeyboardHandler C++ class
KeyEvent	QML frontend for QKeyEvent C++ class
LogicalDevice	QML frontend for the Qt3DInput::QLogicalDevice C++ class
MouseDevice	Delegates mouse events to the attached MouseHandler objects
MouseEvent	Provides parameters that describe a mouse event
WheelEvent	Contains parameters that describe a mouse wheel event
MouseHandler	Provides mouse event notification

Qt 3D Logic Module

FrameAction

Provides a way to have a synchronous function executed each frame

Qt 3D Render Module

LevelOfDetailLoader	An entity loader that changes depending on distance to camera or screen size
CameraSelector	Class to allow for selection of camera to be used
ClearBuffers	Class to clear buffers
DispatchCompute	FrameGraph node to issue work for the compute shader on GPU
FrameGraphNode	Base class of all FrameGraph configuration nodes
FrustumCulling	Enable frustum culling for the FrameGraph
LayerFilter	Controls layers Drawn in a frame graph branch
MemoryBarrier	Class to place a memory barrier
NoDraw	When a NoDraw node is present in a FrameGraph branch, this prevents the renderer from rendering any primitive
RenderCapture	Capture rendering
RenderCaptureReply	Receives render capture result
RenderSurfaceSelector	Provides a way of specifying the render surface
RenderTargetSelector	Provides a way of specifying a render target
SortPolicy	Provides storage for the sort types to be used
Viewport	A viewport on the Qt3D Scene
Camera	Defines a view point through which the scene will be rendered
CameraLens	Provides the projection matrix that is used to define a Camera for 3D scene
Layer	Way of filtering which entities will be rendered
LevelOfDetail	Way of controlling the complexity of rendered entities based on their size on the screen
LevelOfDetail	LevelOfDetailBoundingSphere class provides a simple spherical volume, defined by it's center and radius
LevelOfDetailSwitch	Provides a way of enabling child entities based on distance or screen size
PickingSettings	Specifies how entity picking is handled
RenderSettings	Type holds settings related to rendering process and host the active FrameGraph
Attribute	Defines an attribute and how data should be read from a Buffer
Buffer	Provides a data store for raw data to later be used as vertices or uniforms
Geometry	Encapsulates geometry
GeometryRenderer	Encapsulates geometry rendering
Mesh	A custom mesh loader
SceneLoader	Provides the facility to load an existing Scene
Light	Encapsulate a QAbstractLight object in a Qt 3D scene
DirectionalLight	Encapsulate a Directional Light object in a Qt 3D scene
EnvironmentLight	Encapsulate an environment light object in a Qt 3D scene
PointLight	Encapsulate a Point Light object in a Qt 3D scene
SpotLight	Encapsulate a Spot Light object in a Qt 3D scene
Effect	Base class for effects in a Qt 3D scene
FilterKey	Stores filter keys and their values
GraphicsApiFilter	For OpenGL identifies the API required for the attached technique
Material	Non-creatable abstract base for materials
Parameter	Provides storage for a name and value pair. This maps to a shader uniform
RenderPass	Encapsulates a Render Pass
ShaderProgram	Encapsulates a Shader Program
Technique	Encapsulates a Technique
ObjectPicker	Instantiates a component that can be used to interact with an Entity by a process known as picking
PickEvent	Holds information when an object is picked. This is received as a parameter in most of the QObjectPicker component signals when picking succeeds
PickTriangleEvent	Holds information when a triangle is picked
AlphaCoverage	Enable alpha-to-coverage multisampling mode
AlphaTest	Specify alpha reference test
BlendEquation	Specifies the equation used for both the RGB blend equation and the Alpha blend equation
BlendEquationArguments	Encapsulates blending information: specifies how the incoming values (what's going to be drawn) are going to affect the existing values (what is already drawn)
ClipPlane	Enables an additional OpenGL clipping plane that can be in shaders using gl_ClipDistance
ColorMask	Allows specifying which color components should be written to the currently bound frame buffer
CullFace	Type specifies whether front or back face culling are enabled
DepthTest	Type tests the fragment shader's depth value against the depth of a sample being written to
Dithering	Enable dithering
FrontFace	Type defines front and back facing polygons
MultiSampleAntiAliasing	Enable multisample antialiasing
NoDepthMask	Disable depth write
PointSize	Specifies the size of rasterized points. May either be set statically or by shader programs
PolygonOffset	Type sets the scale and steps to calculate depth values for polygon offsets
ScissorTest	Type discards fragments that fall outside of a certain rectangular portion of the screen
SeamlessCubemap	Enables seamless cubemap texture filtering
StencilMask	Type controls the front and back writing of individual bits in the stencil planes
StencilOperation	Type specifies stencil operation
StencilOperationArguments	Type sets the actions to be taken when stencil and depth tests fail
StencilTest	Type specifies arguments for the stecil test
StencilTestArguments	Type specifies arguments for stencil test
AbstractTextureImage	Encapsulates the necessary information to create an OpenGL texture image
TextureImage	Encapsulates the necessary information to create an OpenGL texture image from an image source

Qt 3D Extras Module

FirstPersonCameraController	Allows controlling the scene camera from the first person perspective
OrbitCameraController	Allows controlling the scene camera along orbital path
DiffuseMapMaterial	Default implementation of the phong lighting effect where the diffuse light component is read from a texture map
DiffuseSpecularMapMaterial	Default implementation of the phong lighting effect where the diffuse and specular light components are read from texture maps
GoochMaterial	Material that implements the Gooch shading model, popular in CAD and CAM applications
NormalDiffuseMapAlphaMaterial	Specialization of NormalDiffuseMapMaterial with alpha coverage and a depth test performed in the rendering pass
NormalDiffuseMapMaterial	Default implementation of the phong lighting and bump effect where the diffuse light component is read from a texture map and the normals of the mesh being rendered from a normal texture map
NormalDiffuseSpecularMapMaterial	Default implementation of the phong lighting and bump effect where the diffuse and specular light components are read from texture maps and the normals of the mesh being rendered from a normal texture map
PerVertexColorMaterial	Default implementation for rendering the color properties set for each vertex
PhongAlphaMaterial	Default implementation of the phong lighting effect with alpha
PhongMaterial	Default implementation of the phong lighting effect
ExtrudedTextGeometry	Allows creation of a 3D text in 3D space
ExtrudedTextMesh	A 3D extruded Text mesh
ForwardRenderer	Default FrameGraph implementation of a forward renderer
ConeGeometry	Allows creation of a cone in 3D space
ConeMesh	A conical mesh
CuboidGeometry	Allows creation of a cuboid in 3D space
CuboidMesh	A cuboid mesh
CylinderGeometry	Allows creation of a cylinder in 3D space
CylinderMesh	A cylindrical mesh
PlaneGeometry	Allows creation of a plane in 3D space
PlaneMesh	A square planar mesh
SphereGeometry	Allows creation of a sphere in 3D space
SphereMesh	A spherical mesh
TorusGeometry	Allows creation of a torus in 3D space
TorusMesh	A toroidal mesh

Qt 3D Animation Module

AbstractAnimation	An abstract base type for Qt3D animations
AbsractClipAnimator	AbstractClipAnimator is the base class for types providing animation playback capabilities
AbstractClipBlendNode	The base class for types used to construct animation blend trees
AdditiveClipBlend	Performs an additive blend of two animation clips based on an additive factor
AnimationController	A controller type for animations
AnimationGroup	A type grouping animations together
BlendedClipAnimator	Component providing animation playback capabilities of a tree of blend nodes
ClipAnimator	Component providing simple animation playback capabilities
KeyframeAnimation	A type implementing simple keyframe animation to a Transform
LerpBlend	Performs a linear interpolation of two animation clips based on a normalized factor
MorphingAnimation	A type implementing blend-shape morphing animation
MorphTarget	A type providing morph targets to blend-shape animation
VertexBlendAnimation	A type implementing vertex-blend morphing animation

Qt 3D Scene2D Module

Scene2D

This type enables rendering qml into a texture, which then can be used as a part of 3D scene

Contents