Класс QQuick3DTextureData

Базовый класс для определения пользовательских данных текстуры. Подробнее...

• Список всех членов, включая унаследованные

Типы публичного доступа

Функции публичного доступа

Подробное описание

Класс QQuick3DTextureData может быть использован для указания пользовательских данных текстуры для Texture в сцене Qt Quick 3D.

Хотя это не строго обязательно, типичное использование заключается в наследовании от этого класса. Затем подкласс экспонируется в QML путём его регистрации в системе типов. Свойство textureData объекта Texture может затем быть установлено для ссылки на экземпляр зарегистрированного типа.

Пример реализации:

class CustomTextureData : public QQuick3DTextureData
{
    Q_OBJECT
    ... properties ...

public:
    CustomTextureData() { regenerateTextureData(); }

    void setProperty(...)
    {
        // Change relevant internal data.
        // ...

        // Update the texture data
        regenerateTextureData();

        // Finally, trigger an update. This is relevant in case nothing else
        // is changed in the scene; this way we make sure a new frame will
        // be rendered
        update();
    }
private:
    void regenerateTextureData()
    {
        QByteArray textureData;
        textureData = generateTextureData();
        setTextureData(textureData);
        setSize(QSize(256, 256));
        setFormat(QQuick3DTextureData::Format::RGBA8)
        setHasTransparency(true);
    }
};

Этот класс может быть затем зарегистрирован как тип QML и использован с Texture.

В Qt 5 регистрация типов происходила с помощью qmlRegisterType:

qmlRegisterType<MyCustomTextureData>("Example", 1, 0, "MyCustomTextureData");

В Qt 6 стандартный подход — автоматическая регистрация с помощью системы сборки. Вместо вызова qmlRegisterType, файл .pro теперь может содержать:

CONFIG += qmltypes
QML_IMPORT_NAME = Example
QML_IMPORT_MAJOR_VERSION = 1

С CMake автоматическая регистрация является стандартным поведением, поэтому для настройки модуля QML не нужны никакие дополнительные параметры:

qt_add_qml_module(application
    URI Example
    VERSION 1.0
)

Реализация класса должна добавить QML_NAMED_ELEMENT:

class CustomTextureData : public QQuick3DTextureData
{
    Q_OBJECT
    QML_NAMED_ELEMENT(MyCustomTextureData)
    ...
};

Код QML может затем использовать пользовательский тип:

import Example 1.0

Model {
    source: "#Cube"
    materials: [
        DefaultMaterial {
            diffuseMap: diffuseMapCustomTexture
        }
    ]
    Texture {
        id: diffuseMapCustomTexture
        textureData: MyCustomTextureData { }
    }
}

Документация типов членов

Перечисление QQuick3DTextureData::Format

Возвращает формат цвета данных текстуры, заданных в свойстве textureData.

Документация функций-членов

QQuick3DTextureData::Format QQuick3DTextureData::format() const

Возвращает формат данных текстуры.

См. также setFormat().

bool QQuick3DTextureData::hasTransparency() const

Возвращает true, если данные текстуры имеют прозрачность.

Значение по умолчанию — false.

См. также setHasTransparency().

void QQuick3DTextureData::setFormat(QQuick3DTextureData::Format format)

Устанавливает format данных текстуры.

Формат по умолчанию — /c RGBA8.

См. также format().

void QQuick3DTextureData::setHasTransparency(bool hasTransparency)

Устанавливает hasTransparency в true, если данные текстуры содержат активный альфа-канал с непрозрачными значениями.

Это используется в качестве оптимизации движком, чтобы форматы, которые поддерживают альфа-канал, не проверяли каждое значение на непрозрачность.

См. также hasTransparency().

void QQuick3DTextureData::setSize(const QSize &size)

Устанавливает размер данных текстуры в пикселях.

См. также size().

void QQuick3DTextureData::setTextureData(const QByteArray &data)

Устанавливает данные текстуры. Содержимое data должно соответствовать свойствам size и format, так как бэкенд попытается загрузить и использовать данные как текстуру заданного размера и формата. Отклонения могут привести к некорректному отображению текстуры или к аварийному завершению работы.

См. также textureData().

QSize QQuick3DTextureData::size() const

Возвращает размер данных текстуры в пикселях.

См. также setSize().

const QByteArray QQuick3DTextureData::textureData() const

Возвращает текущие данные текстуры, определённые этим элементом.

См. также setTextureData().