QEntity Class

class Qt3DCore::QEntity

Qt3DCore::QEntity is a Qt3DCore::QNode subclass that can aggregate several Qt3DCore::QComponent instances that will specify its behavior. More...

Header: #include <QEntity>
CMake: find_package(Qt6 COMPONENTS 3dcore REQUIRED)
target_link_libraries(mytarget PRIVATE Qt6::3dcore)
qmake: QT += 3dcore
Since: Qt 5.5
Instantiated By: Entity
Inherits: Qt3DCore::QNode
Inherited By:

Qt3DExtras::QAbstractCameraController, Qt3DExtras::QSkyboxEntity, Qt3DExtras::QText2DEntity, and Qt3DRender::QCamera

Public Functions

QEntity(Qt3DCore::QNode *parent = nullptr)
void addComponent(Qt3DCore::QComponent *comp)
Qt3DCore::QComponentVector components() const
QList<T *> componentsOfType() const
Qt3DCore::QEntity *parentEntity() const
void removeComponent(Qt3DCore::QComponent *comp)

Detailed Description

By itself a Qt3DCore::QEntity is an empty shell. The behavior of a Qt3DCore::QEntity object is defined by the Qt3DCore::QComponent objects it references. Each Qt3D backend aspect will be able to interpret and process an Entity by recognizing which components it is made up of. One aspect may decide to only process entities composed of a single Qt3DCore::QTransform component whilst another may focus on Qt3DInput::QMouseHandler.

See also Qt3DCore::QComponent and Qt3DCore::QTransform.

Member Function Documentation

QEntity::QEntity(Qt3DCore::QNode *parent = nullptr)

Constructs a new Qt3DCore::QEntity instance with parent as parent.

void QEntity::addComponent(Qt3DCore::QComponent *comp)

Adds a new reference to the component comp.

Note: If the Qt3DCore::QComponent has no parent, the Qt3DCore::QEntity will set itself as its parent thereby taking ownership of the component.

Qt3DCore::QComponentVector QEntity::components() const

Returns the list of Qt3DCore::QComponent instances the entity is referencing.

template <typename T> QList<T *> QEntity::componentsOfType() const

Returns all the components added to this entity that can be cast to type T or an empty vector if there are no such components.

Qt3DCore::QEntity *QEntity::parentEntity() const

Returns the parent Qt3DCore::QEntity instance of this entity. If the immediate parent isn't a Qt3DCore::QEntity, this function traverses up the scene hierarchy until a parent Qt3DCore::QEntity is found. If no Qt3DCore::QEntity parent can be found, returns null.

void QEntity::removeComponent(Qt3DCore::QComponent *comp)

Removes the reference to comp.

Related Non-Members

[alias] QComponentVector

List of QComponent pointers.

© 2024 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.