KisKraLoadVisitor Class Reference

#include <kis_kra_load_visitor.h>

Inheritance diagram for KisKraLoadVisitor:

Public Member Functions
QStringList	errorMessages () const
	KisKraLoadVisitor (KisImageSP image, KoStore *store, KoShapeControllerBase *shapeController, QMap< KisNode *, QString > &layerFilenames, QMap< KisNode *, QString > &keyframeFilenames, const QString &name, int syntaxVersion)
void	setExternalUri (const QString &uri)
bool	visit (KisAdjustmentLayer *layer) override
bool	visit (KisCloneLayer *layer) override
bool	visit (KisColorizeMask *mask) override
bool	visit (KisExternalLayer *) override
bool	visit (KisFilterMask *mask) override
bool	visit (KisGeneratorLayer *layer) override
bool	visit (KisGroupLayer *layer) override
bool	visit (KisNode *) override
bool	visit (KisPaintLayer *layer) override
bool	visit (KisSelectionMask *mask) override
bool	visit (KisTransformMask *mask) override
bool	visit (KisTransparencyMask *mask) override
QStringList	warningMessages () const
Public Member Functions inherited from KisNodeVisitor
	KisNodeVisitor ()
virtual	~KisNodeVisitor ()

Private Member Functions
void	fixOldFilterConfigurations (KisFilterConfigurationSP kfc)
QString	getLocation (const QString &filename, const QString &suffix=QString())
QString	getLocation (KisNode *node, const QString &suffix=QString())
void	initSelectionForMask (KisMask *mask)
void	loadDeprecatedFilter (KisFilterConfigurationSP cfg)
bool	loadFilterConfiguration (KisFilterConfigurationSP kfc, const QString &location)
bool	loadMetaData (KisNode *node)
void	loadNodeKeyframes (KisNode *node)
bool	loadPaintDevice (KisPaintDeviceSP device, const QString &location)
template<class DevicePolicy >
bool	loadPaintDeviceFrame (KisPaintDeviceSP device, const QString &location, DevicePolicy policy)
const KoColorProfile *	loadProfile (const QString &location, const QString &colorModelId, const QString &colorDepthId)
bool	loadProfile (KisPaintDeviceSP device, const QString &location)
bool	loadSelection (const QString &location, KisSelectionSP dstSelection)

Private Attributes
QStringList	m_errorMessages
bool	m_external
KisImageSP	m_image
QMap< KisNode *, QString >	m_keyframeFilenames
QMap< KisNode *, QString >	m_layerFilenames
QString	m_name
QMap< QString, const KoColorProfile * >	m_profileCache
KoShapeControllerBase *	m_shapeController
KoStore *	m_store
int	m_syntaxVersion
QString	m_uri
QStringList	m_warningMessages

Additional Inherited Members
Protected Member Functions inherited from KisNodeVisitor
bool	visitAll (KisNode *node, bool breakOnFail=false)
bool	visitAllInverse (KisNode *node, bool breakOnFail=false)

Detailed Description

Definition at line 25 of file kis_kra_load_visitor.h.

Constructor & Destructor Documentation

KisKraLoadVisitor()

KisKraLoadVisitor::KisKraLoadVisitor	(	KisImageSP	image,
		KoStore *	store,
		KoShapeControllerBase *	shapeController,
		QMap< KisNode *, QString > &	layerFilenames,
		QMap< KisNode *, QString > &	keyframeFilenames,
		const QString &	name,
		int	syntaxVersion )

Definition at line 85 of file kis_kra_load_visitor.cpp.

    : KisNodeVisitor()
    , m_image(image)
    , m_store(store)
    , m_external(false)
    , m_layerFilenames(layerFilenames)
    , m_keyframeFilenames(keyframeFilenames)
    , m_name(name)
    , m_shapeController(shapeController)
{
    m_store->pushDirectory();
 
    if (!m_store->enterDirectory(m_name)) {
        QStringList directories = m_store->directoryList();
        dbgKrita << directories;
        if (directories.size() > 0) {
            dbgFile << "Could not locate the directory, maybe some encoding issue? Grab the first directory, that'll be the image one." << m_name << directories;
            m_name = directories.first();
        }
        else {
            dbgFile << "Could not enter directory" << m_name << ", probably an old-style file with 'part' added.";
            m_name = expandEncodedDirectory(m_name);
        }
    }
    else {
        m_store->popDirectory();
    }
    m_syntaxVersion = syntaxVersion;
}

References dbgFile, dbgKrita, KoStore::directoryList(), KoStore::enterDirectory(), expandEncodedDirectory(), m_name, m_store, m_syntaxVersion, KoStore::popDirectory(), and KoStore::pushDirectory().

Member Function Documentation

errorMessages()

QStringList KisKraLoadVisitor::errorMessages

(

)

const

Definition at line 519 of file kis_kra_load_visitor.cpp.

{
    return m_errorMessages;
}

References m_errorMessages.

fixOldFilterConfigurations()

void KisKraLoadVisitor::fixOldFilterConfigurations ( KisFilterConfigurationSP kfc )

private

Definition at line 693 of file kis_kra_load_visitor.cpp.

{
    KisFilterSP filter = KisFilterRegistry::instance()->value(kfc->name());
    KIS_SAFE_ASSERT_RECOVER_RETURN(filter);
 
    if (!filter->configurationAllowedForMask(kfc)) {
        filter->fixLoadedFilterConfigurationForMasks(kfc);
    }
 
    KIS_SAFE_ASSERT_RECOVER_NOOP(filter->configurationAllowedForMask(kfc));
}

References KisFilter::configurationAllowedForMask(), KisFilter::fixLoadedFilterConfigurationForMasks(), KisFilterRegistry::instance(), KIS_SAFE_ASSERT_RECOVER_NOOP, KIS_SAFE_ASSERT_RECOVER_RETURN, and KoGenericRegistry< T >::value().

getLocation() [1/2]

QString KisKraLoadVisitor::getLocation ( const QString & filename, const QString & suffix = QString() )

private

Definition at line 803 of file kis_kra_load_visitor.cpp.

{
    QString location = m_external ? QString() : m_uri;
    location += m_name + LAYER_PATH + filename + suffix;
    return location;
}

References KRA::LAYER_PATH, m_external, m_name, and m_uri.

getLocation() [2/2]

QString KisKraLoadVisitor::getLocation ( KisNode * node, const QString & suffix = QString() )

private

Definition at line 798 of file kis_kra_load_visitor.cpp.

{
    return getLocation(m_layerFilenames[node], suffix);
}

References getLocation(), and m_layerFilenames.

initSelectionForMask()

void KisKraLoadVisitor::initSelectionForMask ( KisMask * mask )

private

Definition at line 330 of file kis_kra_load_visitor.cpp.

{
    KisLayer *cloneLayer = dynamic_cast<KisCloneLayer*>(mask->parent().data());
    if (cloneLayer) {
        // the clone layers should be initialized out of order
        // and lazily, because their original() is still not
        // initialized
        cloneLayer->accept(*this);
    }
 
    KisLayer *parentLayer = qobject_cast<KisLayer*>(mask->parent().data());
    // the KisKraLoader must have already set the parent for us
    Q_ASSERT(parentLayer);
    mask->initSelection(parentLayer);
}

References KisNode::accept(), KisWeakSharedPtr< T >::data(), KisMask::initSelection(), and KisNode::parent.

loadDeprecatedFilter()

void KisKraLoadVisitor::loadDeprecatedFilter ( KisFilterConfigurationSP cfg )

private

Load deprecated filters. Most deprecated filters can be handled by this, but the brightnesscontact to perchannels conversion needs to be handled in the perchannel class because those filters have their own xml loading functionality.

Definition at line 855 of file kis_kra_load_visitor.cpp.

{
    if (cfg->getString("legacy") == "left edge detections") {
        cfg->setProperty("horizRadius", 1);
        cfg->setProperty("vertRadius", 1);
        cfg->setProperty("type", "prewitt");
        cfg->setProperty("output", "yFall");
        cfg->setProperty("lockAspect", true);
        cfg->setProperty("transparency", false);
    } else if (cfg->getString("legacy") == "right edge detections") {
        cfg->setProperty("horizRadius", 1);
        cfg->setProperty("vertRadius", 1);
        cfg->setProperty("type", "prewitt");
        cfg->setProperty("output", "yGrowth");
        cfg->setProperty("lockAspect", true);
        cfg->setProperty("transparency", false);
    } else if (cfg->getString("legacy") == "top edge detections") {
        cfg->setProperty("horizRadius", 1);
        cfg->setProperty("vertRadius", 1);
        cfg->setProperty("type", "prewitt");
        cfg->setProperty("output", "xGrowth");
        cfg->setProperty("lockAspect", true);
        cfg->setProperty("transparency", false);
    } else if (cfg->getString("legacy") == "bottom edge detections") {
        cfg->setProperty("horizRadius", 1);
        cfg->setProperty("vertRadius", 1);
        cfg->setProperty("type", "prewitt");
        cfg->setProperty("output", "xFall");
        cfg->setProperty("lockAspect", true);
        cfg->setProperty("transparency", false);
    }
}

loadFilterConfiguration()

bool KisKraLoadVisitor::loadFilterConfiguration ( KisFilterConfigurationSP kfc, const QString & location )

private

Definition at line 669 of file kis_kra_load_visitor.cpp.

{
    if (m_store->hasFile(location)) {
        QByteArray data;
        m_store->open(location);
        data = m_store->read(m_store->size());
        m_store->close();
        if (!data.isEmpty()) {
            QDomDocument doc;
            doc.setContent(data);
            QDomElement e = doc.documentElement();
            if (e.tagName() == "filterconfig") {
                kfc->fromLegacyXML(e);
            } else {
                kfc->fromXML(e);
            }
            loadDeprecatedFilter(kfc);
            return true;
        }
    }
    m_warningMessages << i18n("Could not filter configuration %1.", location);
    return true;
}

References KoStore::close(), KoStore::hasFile(), loadDeprecatedFilter(), m_store, m_warningMessages, KoStore::open(), KoStore::read(), and KoStore::size().

loadMetaData()

bool KisKraLoadVisitor::loadMetaData ( KisNode * node )

private

Definition at line 705 of file kis_kra_load_visitor.cpp.

{
    KisLayer* layer = qobject_cast<KisLayer*>(node);
    if (!layer) return true;
 
    KisMetaData::IOBackend *backend = KisMetadataBackendRegistry::instance()->get("xmp");
 
    if (!backend || !backend->supportLoading()) {
        if (backend)
            dbgFile << "Backend " << backend->id() << " does not support loading.";
        else
            dbgFile << "Could not load the XMP backend at all";
        return true;
    }
 
    QString location = getLocation(node, QString(".") + backend->id() +  DOT_METADATA);
    dbgFile << "going to load " << backend->id() << ", " << backend->name() << " from " << location;
 
    if (m_store->hasFile(location)) {
        QByteArray data;
        m_store->open(location);
        data = m_store->read(m_store->size());
        m_store->close();
        QBuffer buffer(&data);
        if (!backend->loadFrom(layer->metaData(), &buffer)) {
            m_warningMessages << i18n("Could not load metadata for layer %1.", layer->name());
        }
    }
    return true;
}

References KoStore::close(), dbgFile, KRA::DOT_METADATA, KoGenericRegistry< T >::get(), getLocation(), KoStore::hasFile(), KisMetaData::IOBackend::id(), KisMetadataBackendRegistry::instance(), KisMetaData::IOBackend::loadFrom(), m_store, m_warningMessages, KisLayer::metaData(), KisBaseNode::name(), KisMetaData::IOBackend::name(), KoStore::open(), KoStore::read(), KoStore::size(), and KisMetaData::IOBackend::supportLoading().

loadNodeKeyframes()

void KisKraLoadVisitor::loadNodeKeyframes ( KisNode * node )

private

Definition at line 810 of file kis_kra_load_visitor.cpp.

{
    if (!m_keyframeFilenames.contains(node)) return;
 
    node->enableAnimation();
 
    const QString &location = getLocation(m_keyframeFilenames[node]);
 
    if (!m_store->open(location)) {
        m_errorMessages << i18n("Could not load keyframes from %1.", location);
        return;
    }
 
    QString errorMsg;
    int errorLine;
    int errorColumn;
 
    QDomDocument dom;
    bool ok = dom.setContent(m_store->device(), &errorMsg, &errorLine, &errorColumn);
    m_store->close();
 
 
    if (!ok) {
        m_errorMessages << i18n("parsing error in the keyframe file %1 at line %2, column %3\nError message: %4", location, errorLine, errorColumn, i18n(errorMsg.toUtf8()));
        return;
    }
 
    QDomElement root = dom.firstChildElement();
 
    for (QDomElement child = root.firstChildElement(); !child.isNull(); child = child.nextSiblingElement()) {
        if (child.nodeName().toUpper() == "CHANNEL") {
            QString id = child.attribute("name");
 
            KisKeyframeChannel *channel = node->getKeyframeChannel(id, true);
 
            if (!channel) {
                m_warningMessages << i18n("unknown keyframe channel type: %1 in %2", id, location);
                continue;
            }
 
            channel->loadXML(child);
        }
    }
}

References KoStore::close(), KoStore::device(), KisBaseNode::enableAnimation(), KisBaseNode::getKeyframeChannel(), getLocation(), KisKeyframeChannel::loadXML(), m_errorMessages, m_keyframeFilenames, m_store, m_warningMessages, and KoStore::open().

loadPaintDevice()

bool KisKraLoadVisitor::loadPaintDevice ( KisPaintDeviceSP device, const QString & location )

private

Definition at line 556 of file kis_kra_load_visitor.cpp.

{
    // Layer data
    KisPaintDeviceFramesInterface *frameInterface = device->framesInterface();
    QList<int> frames;
 
    if (frameInterface) {
        frames = device->framesInterface()->frames();
    }
 
    if (!frameInterface || frames.count() <= 1) {
        return loadPaintDeviceFrame(device, location, SimpleDevicePolicy());
    } else {
        KisRasterKeyframeChannel *keyframeChannel = device->keyframeChannel();
 
        for (int i = 0; i < frames.count(); i++) {
            int id = frames[i];
            if (keyframeChannel->frameFilename(id).isEmpty()) {
                m_warningMessages << i18n("Could not find keyframe pixel data for frame %1 in %2.", id, location);
            }
            else {
                Q_ASSERT(!keyframeChannel->frameFilename(id).isEmpty());
                QString frameFilename = getLocation(keyframeChannel->frameFilename(id));
                Q_ASSERT(!frameFilename.isEmpty());
 
                if (!loadPaintDeviceFrame(device, frameFilename, FramedDevicePolicy(id))) {
                    m_warningMessages << i18n("Could not load keyframe pixel data for frame %1 in %2.", id, location);
                }
            }
        }
    }
 
    return true;
}

References KisRasterKeyframeChannel::frameFilename(), KisPaintDeviceFramesInterface::frames(), KisPaintDevice::framesInterface(), getLocation(), KisPaintDevice::keyframeChannel(), loadPaintDeviceFrame(), and m_warningMessages.

loadPaintDeviceFrame()

template<class DevicePolicy >

bool KisKraLoadVisitor::loadPaintDeviceFrame ( KisPaintDeviceSP device, const QString & location, DevicePolicy policy )

private

Definition at line 592 of file kis_kra_load_visitor.cpp.

{
    {
        const int pixelSize = device->colorSpace()->pixelSize();
        KoColor color = KoColor::createTransparent(device->colorSpace());
 
        if (m_store->open(location + ".defaultpixel")) {
            if (m_store->size() == pixelSize) {
                m_store->read((char*)color.data(), pixelSize);
            }
 
            m_store->close();
        }
 
        policy.setDefaultPixel(device, color);
    }
 
    if (m_store->open(location)) {
        if (!policy.read(device, m_store->device())) {
            m_warningMessages << i18n("Could not read pixel data: %1.", location);
            device->disconnect();
            m_store->close();
            return true;
        }
        m_store->close();
    } else {
        m_warningMessages << i18n("Could not load pixel data: %1.", location);
        return true;
    }
 
    return true;
}

References KoStore::close(), KisPaintDevice::colorSpace(), KoColor::createTransparent(), KoColor::data(), KoStore::device(), m_store, m_warningMessages, KoStore::open(), KoColorSpace::pixelSize(), KoStore::read(), and KoStore::size().

loadProfile() [1/2]

const KoColorProfile * KisKraLoadVisitor::loadProfile ( const QString & location, const QString & colorModelId, const QString & colorDepthId )

private

Definition at line 640 of file kis_kra_load_visitor.cpp.

{
    const KoColorProfile *result = 0;
 
    if (m_store->hasFile(location)) {
        m_store->open(location);
        QByteArray data;
        data.resize(m_store->size());
        dbgFile << "Data to load: " << m_store->size() << " from " << location << " with color space " << colorModelId << colorDepthId;
        int read = m_store->read(data.data(), m_store->size());
        dbgFile << "Profile size: " << data.size() << " " << m_store->atEnd() << " " << m_store->device()->bytesAvailable() << " " << read;
        m_store->close();
 
        QString hash = KoMD5Generator::generateHash(data);
 
        if (m_profileCache.contains(hash)) {
            result = m_profileCache[hash];
        }
        else {
            // Create a colorspace with the embedded profile
            const KoColorProfile *profile = KoColorSpaceRegistry::instance()->createColorProfile(colorModelId, colorDepthId, data);
            m_profileCache[hash] = profile;
            result = profile;
        }
    }
 
    return result;
}

References KoStore::atEnd(), KoStore::close(), KoColorSpaceRegistry::createColorProfile(), dbgFile, KoStore::device(), KoMD5Generator::generateHash(), KoStore::hasFile(), KoColorSpaceRegistry::instance(), m_profileCache, m_store, KoStore::open(), KoStore::read(), and KoStore::size().

loadProfile() [2/2]

bool KisKraLoadVisitor::loadProfile ( KisPaintDeviceSP device, const QString & location )

private

Definition at line 626 of file kis_kra_load_visitor.cpp.

{
    const KoColorProfile *profile = loadProfile(location, device->colorSpace()->colorModelId().id(), device->colorSpace()->colorDepthId().id());
 
    if (profile) {
        // TODO: check result!
        device->setProfile(profile, 0);
    } else {
        m_warningMessages << i18n("Could not load profile: %1.", location);
    }
 
    return true;
}

References KoColorSpace::colorDepthId(), KoColorSpace::colorModelId(), KisPaintDevice::colorSpace(), KoID::id(), loadProfile(), m_warningMessages, and KisPaintDevice::setProfile().

loadSelection()

bool KisKraLoadVisitor::loadSelection ( const QString & location, KisSelectionSP dstSelection )

private

We need to explicitly call updateProjection() here, because KisUpdateSelectionJob that is put into the queue will not update actual layers that own this selection. In normal situation, the setDirty() call is done explicitly while painting.

TODO: consider adding a proper setDirty() call to KisUpdateSelectionJob. Though it doesn't seem to be needed until we allow modifying vector selections on non-selection masks.

NOTE: since loading a vector selection discards all the contents of a raster projection by reincarnating the paint device, there is no need to load pixel selection in case any vector selection is present.

Definition at line 736 of file kis_kra_load_visitor.cpp.

{
    // by default the selection is expected to be fully transparent
    {
        KisPixelSelectionSP pixelSelection = dstSelection->pixelSelection();
        KoColor transparent = KoColor::createTransparent(pixelSelection->colorSpace());
        pixelSelection->setDefaultPixel(transparent);
    }
 
    bool result = true;
 
    // Shape selection
    QString shapeSelectionLocation = location + DOT_SHAPE_SELECTION;
    if (m_store->hasFile(shapeSelectionLocation + "/content.svg") ||
        m_store->hasFile(shapeSelectionLocation + "/content.xml")) {
 
        m_store->pushDirectory();
        m_store->enterDirectory(shapeSelectionLocation) ;
 
        KisShapeSelection* shapeSelection = new KisShapeSelection(m_shapeController, dstSelection);
        dstSelection->convertToVectorSelectionNoUndo(shapeSelection);
        result = shapeSelection->loadSelection(m_store, m_image->bounds());
 
        dstSelection->updateProjection();
        m_store->popDirectory();
        if (!result) {
            m_warningMessages << i18n("Could not load vector selection %1.", location);
        }
    } else {
        // Pixel selection
        QString pixelSelectionLocation = location + DOT_PIXEL_SELECTION;
        if (m_store->hasFile(pixelSelectionLocation)) {
            KisPixelSelectionSP pixelSelection = dstSelection->pixelSelection();
            result = loadPaintDevice(pixelSelection, pixelSelectionLocation);
            if (!result) {
                m_warningMessages << i18n("Could not load raster selection %1.", location);
            }
            pixelSelection->invalidateOutlineCache();
        }
    }
 
    return true;
}

References KisImage::bounds(), KisPaintDevice::colorSpace(), KisSelection::convertToVectorSelectionNoUndo(), KoColor::createTransparent(), KRA::DOT_PIXEL_SELECTION, KRA::DOT_SHAPE_SELECTION, KoStore::enterDirectory(), KoStore::hasFile(), KisPixelSelection::invalidateOutlineCache(), loadPaintDevice(), KisShapeSelection::loadSelection(), m_image, m_shapeController, m_store, m_warningMessages, KisSelection::pixelSelection, KoStore::popDirectory(), KoStore::pushDirectory(), KisPaintDevice::setDefaultPixel(), and KisSelection::updateProjection().

setExternalUri()

void KisKraLoadVisitor::setExternalUri

(

const QString &

uri

)

Definition at line 121 of file kis_kra_load_visitor.cpp.

{
    m_external = true;
    m_uri = uri;
}

References m_external, and m_uri.

visit() [1/12]

bool KisKraLoadVisitor::visit ( KisAdjustmentLayer * layer )

overridevirtual

Implements KisNodeVisitor.

Definition at line 237 of file kis_kra_load_visitor.cpp.

{
    loadNodeKeyframes(layer);
 
    // Adjustmentlayers are tricky: there's the 1.x style and the 2.x
    // style, which has selections with selection components
    bool result = true;
    if (m_syntaxVersion == 1) {
        KisSelectionSP selection = new KisSelection();
        KisPixelSelectionSP pixelSelection = selection->pixelSelection();
        result = loadPaintDevice(pixelSelection, getLocation(layer, ".selection"));
        layer->setInternalSelection(selection);
    } else if (m_syntaxVersion == 2) {
        result = loadSelection(getLocation(layer), layer->internalSelection());
 
    } else {
        // We use the default, empty selection
    }
 
    if (!result) {
        m_warningMessages.append(i18nc("Warning during loading a kra file with a filter layer",
                                       "Selection on layer %s couldn't be loaded. It will be replaced by an empty selection.", layer->name()));
        // otherwise ignore and just use what is there already
        // (most probably an empty selection)
    }
 
    if (!loadMetaData(layer)) {
        return false;
    }
 
    KisFilterSP filter = KisFilterRegistry::instance()->value(layer->filter()->name());
    KisFilterConfigurationSP  kfc = filter->factoryConfiguration(KisGlobalResourcesInterface::instance());
 
    loadFilterConfiguration(kfc, getLocation(layer, DOT_FILTERCONFIG));
    fixOldFilterConfigurations(kfc);
    kfc->createLocalResourcesSnapshot();
 
    layer->setFilter(kfc);
 
    result = visitAll(layer);
    return result;
}

References KRA::DOT_FILTERCONFIG, KisBaseProcessor::factoryConfiguration(), KisNodeFilterInterface::filter(), fixOldFilterConfigurations(), getLocation(), KisFilterRegistry::instance(), KisGlobalResourcesInterface::instance(), KisSelectionBasedLayer::internalSelection(), loadFilterConfiguration(), loadMetaData(), loadNodeKeyframes(), loadPaintDevice(), loadSelection(), m_syntaxVersion, m_warningMessages, KisBaseNode::name(), KisSelection::pixelSelection, KisAdjustmentLayer::setFilter(), KisSelectionBasedLayer::setInternalSelection(), KoGenericRegistry< T >::value(), and KisNodeVisitor::visitAll().

visit() [2/12]

bool KisKraLoadVisitor::visit ( KisCloneLayer * layer )

overridevirtual

Implements KisNodeVisitor.

Definition at line 302 of file kis_kra_load_visitor.cpp.

{
    if (!loadMetaData(layer)) {
        return false;
    }
 
    // the layer might have already been lazily initialized
    // from the mask loading code
    if (layer->copyFrom()) {
        return true;
    }
 
    KisNodeSP srcNode = layer->copyFromInfo().findNode(m_image->rootLayer());
    if (!srcNode.isNull()) {
        KisLayerSP srcLayer = qobject_cast<KisLayer*>(srcNode.data());
        Q_ASSERT(srcLayer);
 
        layer->setCopyFrom(srcLayer);
    } else {
        m_warningMessages.append(i18nc("Loading a .kra file", "The file contains a clone layer that has an incorrect source node id. "
                                                              "This layer will be converted into a paint layer."));
    }
 
    // Clone layers have no data except for their masks
    bool result = visitAll(layer);
    return result;
}

References KisCloneLayer::copyFrom, KisCloneLayer::copyFromInfo, KisSharedPtr< T >::data(), KisNodeUuidInfo::findNode(), KisSharedPtr< T >::isNull(), loadMetaData(), m_image, m_warningMessages, KisImage::rootLayer(), KisCloneLayer::setCopyFrom(), and KisNodeVisitor::visitAll().

visit() [3/12]

bool KisKraLoadVisitor::visit ( KisColorizeMask * mask )

overridevirtual

Implements KisNodeVisitor.

Definition at line 452 of file kis_kra_load_visitor.cpp.

{
    m_store->pushDirectory();
    QString location = getLocation(mask, DOT_COLORIZE_MASK);
    m_store->enterDirectory(location) ;
 
    QByteArray data;
    if (!m_store->extractFile("content.xml", data))
        return false;
 
    QDomDocument doc;
    if (!doc.setContent(data))
        return false;
 
    QVector<KisLazyFillTools::KeyStroke> strokes;
    if (!KisDomUtils::loadValue(doc.documentElement(),
                                COLORIZE_KEYSTROKES_SECTION,
                                &strokes,
                                mask->colorSpace(),
                                QPoint(mask->x(), mask->y()))) {
        return false;
    }
 
    int i = 0;
    Q_FOREACH (const KisLazyFillTools::KeyStroke &stroke, strokes) {
        const QString fileName = QString("%1_%2").arg(COLORIZE_KEYSTROKE).arg(i++);
        loadPaintDevice(stroke.dev, fileName);
    }
 
    mask->setKeyStrokesDirect(QList<KisLazyFillTools::KeyStroke>::fromVector(strokes));
 
    loadPaintDevice(mask->coloringProjection(), COLORIZE_COLORING_DEVICE);
 
    const KoColorProfile *profile =
        loadProfile(getLocation(mask, DOT_ICC), mask->colorSpace()->colorModelId().id(), mask->colorSpace()->colorDepthId().id());
 
    if (!profile) {
        KisNodeSP parent = mask->parent();
        KIS_SAFE_ASSERT_RECOVER(parent) {
            parent = m_image->root();
        }
 
        if (parent->colorSpace()->colorModelId() == mask->colorSpace()->colorModelId() &&
            parent->colorSpace()->colorDepthId() == mask->colorSpace()->colorDepthId()) {
 
            profile = parent->colorSpace()->profile();
        }
    }
 
    if (!profile) {
        if (m_image->colorSpace()->colorModelId() == mask->colorSpace()->colorModelId() &&
            m_image->colorSpace()->colorDepthId() == mask->colorSpace()->colorDepthId()) {
 
            profile = m_image->colorSpace()->profile();
        }
    }
 
    if (profile) {
        mask->setProfile(profile, 0);
    }
 
    mask->resetCache();
 
    m_store->popDirectory();
    return true;
}

References KoColorSpace::colorDepthId(), KisColorizeMask::coloringProjection(), KRA::COLORIZE_COLORING_DEVICE, KRA::COLORIZE_KEYSTROKE, KRA::COLORIZE_KEYSTROKES_SECTION, KoColorSpace::colorModelId(), KisImage::colorSpace(), KisColorizeMask::colorSpace(), KisLazyFillTools::KeyStroke::dev, KRA::DOT_COLORIZE_MASK, KRA::DOT_ICC, KoStore::enterDirectory(), KoStore::extractFile(), getLocation(), KoID::id(), KIS_SAFE_ASSERT_RECOVER, loadPaintDevice(), loadProfile(), m_image, m_store, KisNode::parent, KoStore::popDirectory(), KoColorSpace::profile(), KoStore::pushDirectory(), KisColorizeMask::resetCache(), KisNodeFacade::root, KisColorizeMask::setKeyStrokesDirect(), KisColorizeMask::setProfile(), KisColorizeMask::x(), and KisColorizeMask::y().

visit() [4/12]

bool KisKraLoadVisitor::visit ( KisExternalLayer * layer )

overridevirtual

Implements KisNodeVisitor.

Definition at line 127 of file kis_kra_load_visitor.cpp.

{
    bool result = false;
 
    if (auto *referencesLayer = dynamic_cast<KisReferenceImagesLayer*>(layer)) {
        Q_FOREACH(KoShape *shape, referencesLayer->shapes()) {
            auto *reference = dynamic_cast<KisReferenceImage*>(shape);
            KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(reference, false);
 
            while (!reference->loadImage(m_store)) {
                if (reference->embed()) {
                    m_errorMessages << i18n("Could not load embedded reference image %1 ", reference->internalFile());
                    break;
                } else {
                    QString msg = i18nc(
                        "@info",
                        "A reference image linked to an external file could not be loaded.\n\n"
                        "Path: %1\n\n"
                        "Do you want to select another location?", reference->filename());
 
                    // qApp->activeWindow() doesn't work here
                    int locateManually = QMessageBox::warning(qApp->activeWindow(), i18nc("@title:window", "File not found"), msg, QMessageBox::Yes | QMessageBox::No, QMessageBox::Yes);
 
                    QString url;
                    if (locateManually == QMessageBox::Yes) {
                        KoFileDialog dialog(0, KoFileDialog::OpenFile, "OpenDocument");
                        dialog.setMimeTypeFilters(KisImportExportManager::supportedMimeTypes(KisImportExportManager::Import));
                        url = dialog.filename();
                    }
 
                    if (url.isEmpty()) {
                        break;
                    } else {
                        reference->setFilename(url);
                        reference->setEmbed(false);
                    }
                }
            }
        }
    } else if (KisShapeLayer *shapeLayer = dynamic_cast<KisShapeLayer*>(layer)) {
        loadNodeKeyframes(shapeLayer);
 
        if (!loadMetaData(layer)) {
            return false;
        }
 
        QStringList vectorWarnings;
 
        m_store->pushDirectory();
        m_store->enterDirectory(getLocation(layer, DOT_SHAPE_LAYER)) ;
        result =  shapeLayer->loadLayer(m_store, &vectorWarnings);
        m_store->popDirectory();
 
        m_warningMessages << vectorWarnings;
    }
 
    result = visitAll(layer) && result;
    return result;
}

References KRA::DOT_SHAPE_LAYER, KoStore::enterDirectory(), getLocation(), KisImportExportManager::Import, KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, loadMetaData(), loadNodeKeyframes(), m_errorMessages, m_store, m_warningMessages, KoFileDialog::OpenFile, KoStore::popDirectory(), KoStore::pushDirectory(), KisImportExportManager::supportedMimeTypes(), and KisNodeVisitor::visitAll().

visit() [5/12]

bool KisKraLoadVisitor::visit ( KisFilterMask * mask )

overridevirtual

Implements KisNodeVisitor.

Definition at line 346 of file kis_kra_load_visitor.cpp.

{
    initSelectionForMask(mask);
 
    loadNodeKeyframes(mask);
 
    bool result = true;
    result = loadSelection(getLocation(mask), mask->selection());
 
    KisFilterSP filter = KisFilterRegistry::instance()->value(mask->filter()->name());
    KisFilterConfigurationSP  kfc = filter->factoryConfiguration(KisGlobalResourcesInterface::instance());
    result = loadFilterConfiguration(kfc, getLocation(mask, DOT_FILTERCONFIG));
    fixOldFilterConfigurations(kfc);
    kfc->createLocalResourcesSnapshot();
 
    mask->setFilter(kfc);
 
    return result;
}

References KRA::DOT_FILTERCONFIG, KisBaseProcessor::factoryConfiguration(), KisNodeFilterInterface::filter(), fixOldFilterConfigurations(), getLocation(), initSelectionForMask(), KisFilterRegistry::instance(), KisGlobalResourcesInterface::instance(), loadFilterConfiguration(), loadNodeKeyframes(), loadSelection(), KisMask::selection, KisFilterMask::setFilter(), and KoGenericRegistry< T >::value().

visit() [6/12]

bool KisKraLoadVisitor::visit ( KisGeneratorLayer * layer )

overridevirtual

Implements KisNodeVisitor.

Definition at line 280 of file kis_kra_load_visitor.cpp.

{
    if (!loadMetaData(layer)) {
        return false;
    }
    bool result = true;
 
    loadNodeKeyframes(layer);
    result = loadSelection(getLocation(layer), layer->internalSelection());
 
    KisGeneratorSP filter = KisGeneratorRegistry::instance()->value(layer->filter()->name());
    KisFilterConfigurationSP  kfc = filter->factoryConfiguration(KisGlobalResourcesInterface::instance());
 
    result = loadFilterConfiguration(kfc, getLocation(layer, DOT_FILTERCONFIG));
    kfc->createLocalResourcesSnapshot();
 
    layer->setFilter(kfc);
 
    result = visitAll(layer);
    return result;
}

References KRA::DOT_FILTERCONFIG, KisBaseProcessor::factoryConfiguration(), KisNodeFilterInterface::filter(), getLocation(), KisGeneratorRegistry::instance(), KisGlobalResourcesInterface::instance(), KisSelectionBasedLayer::internalSelection(), loadFilterConfiguration(), loadMetaData(), loadNodeKeyframes(), loadSelection(), KisGeneratorLayer::setFilter(), KoGenericRegistry< T >::value(), and KisNodeVisitor::visitAll().

visit() [7/12]

bool KisKraLoadVisitor::visit ( KisGroupLayer * layer )

overridevirtual

Implements KisNodeVisitor.

Definition at line 225 of file kis_kra_load_visitor.cpp.

{
    loadNodeKeyframes(layer);
 
    if (!loadMetaData(layer)) {
        return false;
    }
 
    bool result = visitAll(layer);
    return result;
}

References loadMetaData(), loadNodeKeyframes(), and KisNodeVisitor::visitAll().

visit() [8/12]

bool KisKraLoadVisitor::visit ( KisNode * )

inlineoverridevirtual

Implements KisNodeVisitor.

Definition at line 41 of file kis_kra_load_visitor.h.

                                  {
        return true;
    }

visit() [9/12]

bool KisKraLoadVisitor::visit ( KisPaintLayer * layer )

overridevirtual

Implements KisNodeVisitor.

Definition at line 187 of file kis_kra_load_visitor.cpp.

{
    loadNodeKeyframes(layer);
 
    if (!loadPaintDevice(layer->paintDevice(), getLocation(layer))) {
        return false;
    }
    if (!loadProfile(layer->paintDevice(), getLocation(layer, DOT_ICC))) {
        return false;
    }
    if (!loadMetaData(layer)) {
        return false;
    }
 
    if (m_syntaxVersion == 1) {
        // Check whether there is a file with a .mask extension in the
        // layer directory, if so, it's an old-style transparency mask
        // that should be converted.
        QString location = getLocation(layer, ".mask");
 
        if (m_store->open(location)) {
 
            KisSelectionSP selection = KisSelectionSP(new KisSelection());
            KisPixelSelectionSP pixelSelection = selection->pixelSelection();
            if (!pixelSelection->read(m_store->device())) {
                pixelSelection->disconnect();
            } else {
                KisTransparencyMask* mask = new KisTransparencyMask(m_image, i18n("Transparency Mask"));
                mask->setSelection(selection);
                m_image->addNode(mask, layer, layer->firstChild());
            }
            m_store->close();
        }
    }
    bool result = visitAll(layer);
    return result;
}

References KisNodeFacade::addNode(), KoStore::close(), KoStore::device(), KRA::DOT_ICC, KisNode::firstChild(), getLocation(), loadMetaData(), loadNodeKeyframes(), loadPaintDevice(), loadProfile(), m_image, m_store, m_syntaxVersion, KoStore::open(), KisPaintLayer::paintDevice, KisSelection::pixelSelection, KisPixelSelection::read(), KisMask::setSelection(), and KisNodeVisitor::visitAll().

visit() [10/12]

bool KisKraLoadVisitor::visit ( KisSelectionMask * mask )

overridevirtual

Implements KisNodeVisitor.

Definition at line 446 of file kis_kra_load_visitor.cpp.

{
    initSelectionForMask(mask);
    return loadSelection(getLocation(mask), mask->selection());
}

References getLocation(), initSelectionForMask(), loadSelection(), and KisMask::selection.

visit() [11/12]

bool KisKraLoadVisitor::visit ( KisTransformMask * mask )

overridevirtual

Workaround for the dumbparams that we used in older versions of Krita for simple translations. The dumbparams were deprecated with the proper implementation of the param holder, so now we should convert the old definition into the new format somehow.

See: https://bugs.kde.org/show_bug.cgi?id=492320

Implements KisNodeVisitor.

Definition at line 366 of file kis_kra_load_visitor.cpp.

{
    QString location = getLocation(mask, DOT_TRANSFORMCONFIG);
    if (m_store->hasFile(location)) {
        QByteArray data;
        m_store->open(location);
        data = m_store->read(m_store->size());
        m_store->close();
        if (!data.isEmpty()) {
            QDomDocument doc;
            doc.setContent(data);
 
            QDomElement rootElement = doc.documentElement();
 
            QDomElement main;
 
            if (!KisDomUtils::findOnlyElement(rootElement, "main", &main/*, &m_errorMessages*/)) {
                return false;
            }
 
            QString id = main.attribute("id", "not-valid");
 
            // backward compatibility
            if (id == "animatedtransformparams") {
                id = "tooltransformparams";
            }
            if (id == "not-valid") {
                m_errorMessages << i18n("Could not load \"id\" of the transform mask");
                return false;
            }
 
            QDomElement data;
 
            if (!KisDomUtils::findOnlyElement(rootElement, "data", &data, &m_errorMessages)) {
                m_errorMessages << i18n("Could not find transform mask XML element");
                return false;
            }
 
            KisTransformMaskParamsInterfaceSP params =
                KisTransformMaskParamsFactoryRegistry::instance()->createParams(id, data);
 
            if (id == "dumbparams") {
                const QPointF center = m_image->bounds().center();
                params->transformSrcAndDst(QTransform::fromTranslate(center.x(), center.y()));
            }
 
            if (!params) {
                m_errorMessages << i18n("Could not create transform mask params");
                return false;
            }
 
            mask->setTransformParams(params);
 
            loadNodeKeyframes(mask);
 
            return true;
        }
    }
 
    return false;
}

References KisImage::bounds(), KoStore::close(), KisTransformMaskParamsFactoryRegistry::createParams(), KRA::DOT_TRANSFORMCONFIG, KisDomUtils::findOnlyElement(), getLocation(), KoStore::hasFile(), KisTransformMaskParamsFactoryRegistry::instance(), loadNodeKeyframes(), m_errorMessages, m_image, m_store, main(), KoStore::open(), KoStore::read(), KisTransformMask::setTransformParams(), and KoStore::size().

visit() [12/12]

bool KisKraLoadVisitor::visit ( KisTransparencyMask * mask )

overridevirtual

Implements KisNodeVisitor.

Definition at line 437 of file kis_kra_load_visitor.cpp.

{
    initSelectionForMask(mask);
 
    loadNodeKeyframes(mask);
 
    return loadSelection(getLocation(mask), mask->selection());
}

References getLocation(), initSelectionForMask(), loadNodeKeyframes(), loadSelection(), and KisMask::selection.

warningMessages()

QStringList KisKraLoadVisitor::warningMessages

(

)

const

Definition at line 524 of file kis_kra_load_visitor.cpp.

{
    return m_warningMessages;
}

References m_warningMessages.

Member Data Documentation

m_errorMessages

QStringList KisKraLoadVisitor::m_errorMessages

private

Definition at line 94 of file kis_kra_load_visitor.h.

m_external

bool KisKraLoadVisitor::m_external

private

Definition at line 88 of file kis_kra_load_visitor.h.

m_image

KisImageSP KisKraLoadVisitor::m_image

private

Definition at line 86 of file kis_kra_load_visitor.h.

m_keyframeFilenames

QMap<KisNode *, QString> KisKraLoadVisitor::m_keyframeFilenames

private

Definition at line 91 of file kis_kra_load_visitor.h.

m_layerFilenames

QMap<KisNode *, QString> KisKraLoadVisitor::m_layerFilenames

private

Definition at line 90 of file kis_kra_load_visitor.h.

m_name

QString KisKraLoadVisitor::m_name

private

Definition at line 92 of file kis_kra_load_visitor.h.

m_profileCache

QMap<QString, const KoColorProfile *> KisKraLoadVisitor::m_profileCache

private

Definition at line 97 of file kis_kra_load_visitor.h.

m_shapeController

KoShapeControllerBase* KisKraLoadVisitor::m_shapeController

private

Definition at line 96 of file kis_kra_load_visitor.h.

m_store

KoStore* KisKraLoadVisitor::m_store

private

Definition at line 87 of file kis_kra_load_visitor.h.

m_syntaxVersion

int KisKraLoadVisitor::m_syntaxVersion

private

Definition at line 93 of file kis_kra_load_visitor.h.

m_uri

QString KisKraLoadVisitor::m_uri

private

Definition at line 89 of file kis_kra_load_visitor.h.

m_warningMessages

QStringList KisKraLoadVisitor::m_warningMessages

private

Definition at line 95 of file kis_kra_load_visitor.h.

---

The documentation for this class was generated from the following files:

• plugins/impex/libkra/kis_kra_load_visitor.h
• plugins/impex/libkra/kis_kra_load_visitor.cpp