Qt 3D C++ Classes
The Qt 3D module provides the foundations and core types used for near-realtime simulations built on the Qt 3D framework.
Namespaces
Contains classes from the Qt3DAnimation module | |
Contains classes that are the foundation for Qt 3D simulation framework, as well as classes that provide the ability to render using the Qt 3D framework | |
Contains classes used for implementing QML functionality into Qt3D applications | |
Contains classes from the Qt3DExtras module | |
Contains classes that enable user input | |
Contains classes that enable frame synchronization | |
Contains classes that enable 2D and 3D rendering |
Classes
Qt 3D Core Module
The base class for aspects that provide a vertical slice of behavior | |
Abstract base class for all functors | |
A skeleton contains the joints for a skinned mesh | |
Used to calculate skinning transform matrices and set them on shaders | |
Responsible for handling all the QAbstractAspect subclasses that have been registered with the scene | |
Base class for jobs executed in an aspect | |
Defines an attribute and how data should be read from a QBuffer | |
Base class for all Qt3D backend nodes | |
Creates and maps backend nodes to their respective frontend nodes | |
Can be used to override the bounding volume of an entity | |
Provides a data store for raw data to later be used as vertices or uniforms | |
Base class of scene nodes that can be aggregated by Qt3DCore::QEntity instances as a component | |
Holds settings related to core data handling process | |
Qt3DCore::QEntity is a Qt3DCore::QNode subclass that can aggregate several Qt3DCore::QComponent instances that will specify its behavior | |
Encapsulates geometry | |
Encapsulates geometry details | |
Used to transforms parts of skinned meshes | |
The base class of all Qt3D node classes used to build a Qt3D scene | |
Uniquely identifies a QNode | |
Holds the data for a skeleton to be used with skinned meshes | |
Used to load a skeleton of joints from file | |
Used to perform transforms on meshes | |
Environment for the QAspectEngine and a method for instantiating QML components |
Qt 3D Input Module
The base class for the Action Input and all Aggregate Action Inputs | |
QAbstractActionInput is the base class for all Axis Input | |
The base class used by Qt3d to interact with arbitrary input devices | |
Qt3DInput::QAbstractPhysicalDeviceProxy acts as a proxy for an actual Qt3DInput::QQAbstractPhysicalDevice device | |
Links a set of QAbstractActionInput that trigger the same event | |
Stores Device and Buttons used to trigger an input event | |
An axis input controlled by an analog input The axis value is controlled like a traditional analog input such as a joystick | |
Stores QAbstractAxisInputs used to trigger an input event | |
Processes velocity or acceleration data from a QAxis | |
Stores settings for the specified list of Axis | |
An axis input controlled by buttons The axis value is controlled by buttons rather than a traditional analog input such as a joystick | |
Responsible for creating physical devices and handling associated jobs | |
Represents a set of QAbstractActionInput's that must be triggerd at once | |
Abstract base class used to define new input methods such as game controllers | |
Represents a set of QAbstractActionInput's that must be triggerd one after the other | |
Holds the pointer to an input event source object | |
Event type send by KeyBoardHandler | |
In charge of dispatching keyboard events to attached QQKeyboardHandler objects | |
Provides keyboard event notification | |
Allows the user to define a set of actions that they wish to use within an application | |
Delegates mouse events to the attached MouseHandler objects | |
Qt3DCore::QMouseEvent contains parameters that describe a mouse event | |
Provides a means of being notified about mouse events when attached to a QMouseDevice instance | |
Contains parameters that describe a mouse wheel event |
Qt 3D Logic Module
Provides a way to have a synchronous function executed each frame | |
Responsible for handling frame synchronization jobs |
Qt 3D Render Module
Encapsulate a QAbstractLight object in a Qt 3D scene | |
An abstract base class for ray casting in 3d scenes | |
A base class to be used to provide textures | |
Encapsulates the necessary information to create an OpenGL texture image | |
Enable alpha-to-coverage multisampling mode | |
Specify alpha reference test | |
Specifies the equation used for both the RGB blend equation and the Alpha blend equation | |
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) | |
FrameGraph node to transfer a rectangle of pixel values from one region of a render target to another | |
Exchanges buffer data between GPU and CPU | |
Defines a view point through which the scene will be rendered | |
Qt3DRender::QCameraLens specifies the projection matrix that will be used to define a Camera for a 3D scene | |
Class to allow for selection of camera to be used | |
Class to clear buffers | |
Enables an additional OpenGL clipping plane that can be in shaders using gl_ClipDistance | |
Allows specifying which color components should be written to the currently bound frame buffer | |
QComponent to issue work for the compute shader on GPU | |
Specifies whether front or back face culling is enabled | |
Enables a visual overlay with scene details | |
Enables remapping depth values written into the depth buffer | |
Tests the fragment shader's depth value against the depth of a sample being written to | |
Encapsulate a Directional Light object in a Qt 3D scene | |
FrameGraph node to issue work for the compute shader on GPU | |
Enable dithering | |
Base class for effects in a Qt 3D scene | |
Encapsulate an environment light object in a Qt 3D scene | |
Storage for filter keys and their values | |
Base class of all FrameGraph configuration nodes | |
Defines front and back facing polygons | |
Enable frustum culling for the FrameGraph | |
Encapsulates geometry rendering | |
Identifies the API required for the attached QTechnique | |
Way of filtering which entities will be rendered | |
Controls layers drawn in a frame graph branch | |
Way of controlling the complexity of rendered entities based on their size on the screen | |
Simple spherical volume, defined by its center and radius | |
Provides a way of enabling child entities based on distance or screen size | |
Specifies the width of rasterized lines | |
Provides an abstract class that should be the base of all material component classes in a scene | |
Class to emplace a memory barrier | |
A custom mesh loader | |
Enable multisample antialiasing | |
Disable depth write | |
When a Qt3DRender::QNoDraw node is present in a FrameGraph branch, this prevents the renderer from rendering any primitive | |
When a Qt3DRender::QNoPicking node is present in a FrameGraph branch, this prevents the render aspect from performing picking selection for the given branch | |
Instantiates a component that can be used to interact with a QEntity by a process known as picking | |
A QAbstractTextureImage that can be written through a QPainter | |
Provides storage for a name and value pair. This maps to a shader uniform | |
Holds information when an object is picked | |
Holds information when a segment of a line is picked | |
Holds information when a segment of a point cloud is picked | |
Holds information when a triangle is picked | |
Can be used to provide an alternate QGeometryView used only for picking | |
Specifies how entity picking is handled | |
Encapsulate a Point Light object in a Qt 3D scene | |
Specifies the size of rasterized points. May either be set statically or by shader programs | |
Sets the scale and steps to calculate depth values for polygon offsets | |
Select entities which are within a distance threshold of a target entity | |
Render state allows to control the type of rasterization to be performed | |
Qt3DRender::QRayCaster is used to perform ray casting tests in 3d world coordinates | |
Details of a hit when casting a ray through a model | |
Class | |
Holds settings related to available rendering engines | |
Frame graph node for render capture | |
Receives the result of render capture request | |
Encapsulates a Render Pass | |
Provides storage for vectors of Filter Keys and Parameters | |
Holds settings related to rendering process and host the active FrameGraph | |
An abstract base class for all render states | |
FrameGraph node offers a way of specifying a set of QRenderState objects to be applied during the execution of a framegraph branch | |
Provides a way of specifying the render surface | |
Encapsulates a target (usually a frame buffer object) which the renderer can render into | |
Allows the specification of an attachment of a render target (whether it is a color texture, a depth texture, etc... ) | |
Provides a way of specifying a render target | |
Provides the facility to load an existing Scene | |
Discards fragments that fall outside of a certain rectangular portion of the screen | |
Performe ray casting test based on screen coordinates | |
Enables seamless cubemap texture filtering | |
FrameGraphNode used to insert a fence in the graphics command stream | |
Provides a way of specifying values of a Uniform Block or a shader structure | |
Provides Image access to shader programs | |
Encapsulates a Shader Program | |
Generates a Shader Program content from loaded graphs | |
Allows to use a textureId from a separate OpenGL context in a Qt 3D scene | |
Provides storage for the sort types to be used | |
Encapsulate a Spot Light object in a Qt 3D scene | |
Controls the front and back writing of individual bits in the stencil planes | |
Specifies stencil operation | |
Sets the actions to be taken when stencil and depth tests fail | |
Specifies arguments for the stecil test | |
Specifies arguments for stencil test | |
Enables or disables entire subtrees of framegraph nodes | |
Encapsulates a Technique | |
A QFrameGraphNode used to select QTechniques to use | |
A QAbstractTexture with a Target1D target format | |
A QAbstractTexture with a Target1DArray target format | |
A QAbstractTexture with a Target2D target format | |
A QAbstractTexture with a Target2DArray target format | |
A QAbstractTexture with a Target2DMultisample target format | |
A QAbstractTexture with a Target2DMultisampleArray target format | |
A QAbstractTexture with a Target3D target format | |
A QAbstractTexture with a TargetBuffer target format | |
A QAbstractTexture with a TargetCubeMap target format | |
A QAbstractTexture with a TargetCubeMapArray target format | |
Stores texture information such as the target, height, width, depth, layers, wrap, and if mipmaps are enabled | |
Holds content and information required to perform partial updates of a texture content | |
Provides the image data for a texture | |
Encapsulates the necessary information to create an OpenGL texture image from an image source | |
Stores data representing a texture | |
Provides texture image data for QAbstractTextureImage | |
Handles the texture loading and setting the texture's properties | |
A QAbstractTexture with a TargetRectangle target format | |
Defines the wrap mode a Qt3DRender::QAbstractTexture should apply to a texture | |
A viewport on the Qt3D Scene | |
FrameGraphNode used to wait for a fence in the graphics command stream to become signaled |
Qt 3D Extras Module
Basic functionality for camera controllers | |
Allows creation of a cone in 3D space. * * * * * The QConeGeometry class is most commonly used internally by the QConeMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses. The class * allows for creation of both a cone and a truncated cone | |
A conical mesh | |
A conical mesh | |
Allows creation of a cuboid in 3D space. * * * * * The QCuboidGeometry class is most commonly used internally by the QCuboidMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses | |
A cuboid mesh | |
A cuboid mesh | |
Allows creation of a cylinder in 3D space. * * * * * The QCylinderGeometry class is most commonly used internally by the QCylinderMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses | |
A cylindrical mesh | |
A cylindrical mesh | |
Default implementation of the phong lighting effect | |
Allows creation of a 3D extruded text in 3D space | |
A 3D extruded Text mesh | |
Allows controlling the scene camera from the first person perspective | |
Default FrameGraph implementation of a forward renderer | |
Material that implements the Gooch shading model, popular in CAD and CAM applications | |
Default implementation of PBR lighting | |
Default implementation of the phong lighting effect | |
Allows controlling the scene camera along orbital path | |
Default implementation for rendering the color properties set for each vertex | |
Allows creation of a plane in 3D space. * * * * The QPlaneGeometry class is most commonly used internally by the QPlaneMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses | |
A square planar mesh | |
A square planar mesh | |
Qt3DExtras::QSkyboxEntity is a convenience Qt3DCore::QEntity subclass that can be used to insert a skybox in a 3D scene | |
Allows creation of a sphere in 3D space. * * * * * The QSphereGeometry class is most commonly used internally by the QSphereMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses | |
A spherical mesh | |
A spherical mesh | |
Allows creation of a 2D text in 3D space | |
Default implementation of a simple unlit texture material | |
Allows creation of a torus in 3D space. * * * * * The QTorusGeometry class is most commonly used internally by the QTorusMesh * but can also be used in custom Qt3DRender::QGeometryRenderer subclasses | |
A toroidal mesh | |
A toroidal mesh |
Qt 3D Animation Module
An abstract base class for Qt3D animations | |
The base class for types providing key frame animation data | |
The base class for types providing animation playback capabilities | |
The base class for types used to construct animation blend trees | |
Performs an additive blend of two animation clips based on an additive factor | |
Provides key-frame animation capabilities to Qt 3D | |
Represents an animation callback object | |
Specifies key frame animation data | |
Class containing the animation data | |
Enables loading key frame animation data from a file | |
A controller class for animations | |
A class grouping animations together | |
Component providing animation playback capabilities of a tree of blend nodes | |
Allows to map the channels within the clip onto an invocation of a callback object | |
Defines a channel for a QAnimationClipData. The animation system interpolates each channel component independently except in the case the QChannel is called "Rotation" (case sensitive), it has four QChannelComponents and the same number of keyframes for each QChannelComponent. In that case the interpolation will be performed using SLERP | |
Allows to map the channels within the clip onto properties of objects in the application | |
Allows to map the channels within the clip onto properties of objects in the application | |
Component providing simple animation playback capabilities | |
Class used for including a clip in a blend tree | |
A base class for handling keyframes | |
A class implementing simple keyframe animation to a QTransform | |
Performs a linear interpolation of two animation clips based on a normalized factor | |
A class providing morph targets to blend-shape animation | |
A class implementing blend-shape morphing animation | |
A class implementing vertex-blend morphing animation |
Qt 3D Scene2D Module
This class enables rendering qml into a texture, which then can be used as a part of 3D scene |
© 2023 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.