Qt3DCore Namespace | Qt 3D 5.12.5

Qt 5.12 | Qt 3D | Qt3DCore Namespace

Qt 5.12.5 Reference Documentation

# Qt3DCore Namespace

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. More...

Header: | #include <Qt3DCore>
qmake: | QT += 3dcore

## Namespaces

namespace | Quick

## Classes

class | QAbstractAspect
class | QAbstractSkeleton
class | QArmature
class | QAspectEngine
class | QAspectJob
class | QBackendNode
class | QBackendNodeMapper
class | QComponent
class | QComponentAddedChange
class | QComponentRemovedChange
class | QDynamicPropertyUpdatedChange
class | QEntity
class | QJoint
class | QNode
class | QNodeCommand
class | QNodeCreatedChange
class | QNodeCreatedChangeBase
class | QNodeDestroyedChange
class | QNodeId
class | QNodeIdTypePair
class | QPropertyNodeAddedChange
class | QPropertyNodeRemovedChange
class | QPropertyUpdatedChange
class | QPropertyUpdatedChangeBase
class | QPropertyValueAddedChange
class | QPropertyValueAddedChangeBase
class | QPropertyValueRemovedChange
class | QPropertyValueRemovedChangeBase
class | QSceneChange
class | QSkeleton
class | QSkeletonLoader
class | QStaticPropertyUpdatedChangeBase
class | QStaticPropertyValueAddedChangeBase
class | QStaticPropertyValueRemovedChangeBase
class | QTransform

## Types

enum | ChangeFlag { NodeCreated, NodeDeleted, PropertyUpdated, PropertyValueAdded, ..., AllChanges }
flags | ChangeFlags
typedef | QAspectJobPtr
typedef | QBackendNodeMapperPtr
typedef | QComponentAddedChangePtr
typedef | QComponentRemovedChangePtr
typedef | QComponentVector
typedef | QDynamicPropertyUpdatedChangePtr
typedef | QEntityPtr
typedef | QNodeCommandPtr
typedef | QNodeCreatedChangeBasePtr
typedef | QNodeDestroyedChangePtr
typedef | QNodeIdVector
typedef | QNodePtr
typedef | QNodeVector
typedef | QPropertyNodeAddedChangePtr
typedef | QPropertyNodeRemovedChangePtr
typedef | QPropertyUpdatedChangeBasePtr
typedef | QPropertyUpdatedChangePtr
typedef | QPropertyValueAddedChangeBasePtr
typedef | QPropertyValueAddedChangePtr
typedef | QPropertyValueRemovedChangeBasePtr
typedef | QPropertyValueRemovedChangePtr
typedef | QSceneChangePtr
typedef | QStaticPropertyUpdatedChangeBasePtr

## Functions

uint | qHash(Qt3DCore::QNodeId id, uint seed = ...)
Qt3DCore::QNodeId | qIdForNode(Qt3DCore::QNode *node)
Qt3DCore::QNodeIdVector | qIdsForNodes(const T &nodes)
const QMetaObject * | qt_getEnumMetaObject(Qt3DCore::QNode::PropertyTrackingMode)
const QMetaObject * | qt_getEnumMetaObject(Qt3DCore::QSkeletonLoader::Status)
const char * | qt_getEnumName(Qt3DCore::QNode::PropertyTrackingMode)
const char * | qt_getEnumName(Qt3DCore::QSkeletonLoader::Status)
QDebug | operator<<(QDebug d, Qt3DCore::QNodeId id)
int | operator|(int, int)

## Detailed Description

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.

## Namespaces

### namespace Qt3DCore::Quick

Contains classes used for implementing QML functionality into Qt3D applications.

## Classes

### class QAbstractAspect

QAbstractAspect is the base class for aspects that provide a vertical slice of behavior. More...

### class QAbstractSkeleton

A skeleton contains the joints for a skinned mesh. More...

### class QArmature

Used to calculate skinning transform matrices and set them on shaders. More...

### class QAspectEngine

Responsible for handling all the QAbstractAspect subclasses that have been registered with the scene. More...

### class QAspectJob

The base class for jobs executed in an aspect. More...

### class QBackendNode

The base class for all Qt3D backend nodes. More...

### class QBackendNodeMapper

Creates and maps backend nodes to their respective frontend nodes. More...

### class QComponent

The base class of scene nodes that can be aggregated by Qt3DCore::QEntity instances as a component. More...

### class QComponentAddedChange

The QComponentAddedChange class is used to notify when a component is added to an entity. More...

### class QComponentRemovedChange

The QComponentRemovedChange class is used to notify when a component is removed from an entity. More...

### class QDynamicPropertyUpdatedChange

The QDynamicPropertyUpdatedChange class is used to notify when a dynamic property value is updated. More...

### class QEntity

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

### class QJoint

Used to transforms parts of skinned meshes. More...

### class QNode

QNode is the base class of all Qt3D node classes used to build a Qt3D scene. More...

### class QNodeCommand

The QNodeCommand class is the base class for all CommandRequested QSceneChange events. More...

### class QNodeCreatedChange

Used to notify when a node is created. More...

### class QNodeCreatedChangeBase

The QNodeCreatedChangeBase class is the base class for all NodeCreated QSceneChange events. More...

### class QNodeDestroyedChange

Used to notify when a node is destroyed. More...

### class QNodeId

Uniquely identifies a QNode. More...

### class QNodeIdTypePair

### class QPropertyNodeAddedChange

Used to notify when a node is added to a property. More...

### class QPropertyNodeRemovedChange

The QPropertyNodeRemovedChange class is used to notify when a node is removed from a property. More...

### class QPropertyUpdatedChange

The QPropertyUpdatedChange class is used to notify when a property value is updated. More...

### class QPropertyUpdatedChangeBase

The QPropertyUpdatedChangeBase class is the base class for all PropertyUpdated QSceneChange events. More...

### class QPropertyValueAddedChange

Used to notify when a value is added to a property. More...

### class QPropertyValueAddedChangeBase

The QPropertyValueAddedChangeBase class is the base class for all PropertyValueAdded QSceneChange events. More...

### class QPropertyValueRemovedChange

Used to notify when a value is added to a property. More...

### class QPropertyValueRemovedChangeBase

The QPropertyValueRemovedChangeBase class is the base class for all PropertyValueRemoved QSceneChange events. More...

### class QSceneChange

The base class for changes that can be sent and received by Qt3D's change notification system. More...

### class QSkeleton

Holds the data for a skeleton to be used with skinned meshes. More...

### class QSkeletonLoader

Used to load a skeleton of joints from file. More...

### class QStaticPropertyUpdatedChangeBase

The QStaticPropertyUpdatedChangeBase class is the base class for all static PropertyUpdated QSceneChange events. More...

### class QStaticPropertyValueAddedChangeBase

The QStaticPropertyValueAddedChangeBase class is the base class for all static PropertyValueAdded QSceneChange events. More...

### class QStaticPropertyValueRemovedChangeBase

The QStaticPropertyValueRemovedChangeBase class is the base class for all static PropertyValueRemoved QSceneChange events. More...

### class QTransform

Used to perform transforms on meshes. More...

## Type Documentation

### enum Qt3DCore::ChangeFlag
flags Qt3DCore::ChangeFlags

The types of change that can be sent and received by Qt3D's change notification system.

Constant | Value | Description
--- | --- | ---
`Qt3DCore::NodeCreated` | `1 << 0` | A new instance of a QNode subclass has been created.
`Qt3DCore::NodeDeleted` | `1 << 1` | A QNode has been deleted.
`Qt3DCore::PropertyUpdated` | `1 << 2` | A QNode property has been updated.
`Qt3DCore::PropertyValueAdded` | `1 << 3` | A QNode has been added to the scene.
`Qt3DCore::PropertyValueRemoved` | `1 << 4` | A QNode has been removed from the scene.
`Qt3DCore::CommandRequested` | `1 << 7` | A QNodeCommand has been sent between a node and its backend.
`Qt3DCore::ComponentAdded` | `1 << 5` | A QComponent has been added to a QEntity.
`Qt3DCore::ComponentRemoved` | `1 << 6` | A QComponent has been removed from a QEntity.
`Qt3DCore::CallbackTriggered` | `1 << 8` | A QNode triggered a callback.
`Qt3DCore::AllChanges` | `0xFFFFFFFF` | Allows an observer to monitor for any of the above changes.

The ChangeFlags type is a typedef for QFlags<ChangeFlag>. It stores an OR combination of ChangeFlag values.

### typedef Qt3DCore::QAspectJobPtr

A shared pointer for QAspectJob.

### typedef Qt3DCore::QBackendNodeMapperPtr

A shared pointer for QBackendNodeMapper.

### typedef Qt3DCore::QComponentAddedChangePtr

A shared pointer for QComponentAddedChange.

### typedef Qt3DCore::QComponentRemovedChangePtr

A shared pointer for QComponentRemovedChange.

### typedef Qt3DCore::QComponentVector

List of QComponent pointers.

### typedef Qt3DCore::QDynamicPropertyUpdatedChangePtr

A shared pointer for QDynamicPropertyUpdatedChange.

### typedef Qt3DCore::QEntityPtr

A shared pointer for QEntity.

### typedef Qt3DCore::QNodeCommandPtr

A shared pointer for QNodeCommand.

### typedef Qt3DCore::QNodeCreatedChangeBasePtr

A shared pointer for QNodeCreatedChangeBase.

### typedef Qt3DCore::QNodeDestroyedChangePtr

A shared pointer for QNodeDestroyedChange.

### typedef Qt3DCore::QNodeIdVector

A vector of QNodeIds.

### typedef Qt3DCore::QNodePtr

A shared pointer for QNode.

### typedef Qt3DCore::QNodeVector

List of QNode pointers.

### typedef Qt3DCore::QPropertyNodeAddedChangePtr

A shared pointer for QPropertyNodeAddedChange.

### typedef Qt3DCore::QPropertyNodeRemovedChangePtr

A shared pointer for QPropertyNodeRemovedChange.

### typedef Qt3DCore::QPropertyUpdatedChangeBasePtr

A shared pointer for QPropertyUpdatedChangeBase.

### typedef Qt3DCore::QPropertyUpdatedChangePtr

A shared pointer for QPropertyUpdatedChange.

### typedef Qt3DCore::QPropertyValueAddedChangeBasePtr

A shared pointer for QPropertyValueAddedChangeBase.

### typedef Qt3DCore::QPropertyValueAddedChangePtr

A shared pointer for QPropertyValueAddedChange.

### typedef Qt3DCore::QPropertyValueRemovedChangeBasePtr

A shared pointer for QPropertyValueRemovedChangeBase.

### typedef Qt3DCore::QPropertyValueRemovedChangePtr

A shared pointer for QPropertyValueRemovedChange.

### typedef Qt3DCore::QSceneChangePtr

A shared pointer for QSceneChange.

### typedef Qt3DCore::QStaticPropertyUpdatedChangeBasePtr

A shared pointer for QStaticPropertyUpdatedChangeBase.

## Function Documentation

### uint Qt3DCore::qHash(Qt3DCore::QNodeId id, uint seed = ...)

Returns hash of node with id and optional seed.

### Qt3DCore::QNodeId Qt3DCore::qIdForNode(Qt3DCore::QNode *node)

Returns node id for node.

### Qt3DCore::QNodeIdVector Qt3DCore::qIdsForNodes(const T &nodes)

Returns vector of node ids for nodes.

### const QMetaObject *Qt3DCore::qt_getEnumMetaObject(Qt3DCore::QNode::PropertyTrackingMode)

### const QMetaObject *Qt3DCore::qt_getEnumMetaObject(Qt3DCore::QSkeletonLoader::Status)

### const char *Qt3DCore::qt_getEnumName(Qt3DCore::QNode::PropertyTrackingMode)

### const char *Qt3DCore::qt_getEnumName(Qt3DCore::QSkeletonLoader::Status)

### QDebug Qt3DCore::operator<<(QDebug d, Qt3DCore::QNodeId id)

<< with d and id. Returns QDebug.

### int Qt3DCore::operator|(int, int)