KisRequiredResourcesOperators Namespace Reference

Namespaces
namespace	detail

Functions
template<typename TypeSP , typename T = typename KisSharedPointerTraits<TypeSP>::ValueType>
TypeSP	cloneWithResourcesSnapshot (const T *object, KisResourcesInterfaceSP globalResourcesInterface=nullptr)
	creates an exact copy of the object and loads all the linked resources into the local storage.
template<typename T >
void	createLocalResourcesSnapshot (T *object, KisResourcesInterfaceSP globalResourcesInterface=nullptr)
template<typename T >
bool	hasLocalResourcesSnapshot (const T *object)

Function Documentation

cloneWithResourcesSnapshot()

template<typename TypeSP , typename T = typename KisSharedPointerTraits<TypeSP>::ValueType>

TypeSP KisRequiredResourcesOperators::cloneWithResourcesSnapshot	(	const T *	object,
		KisResourcesInterfaceSP	globalResourcesInterface = nullptr )

creates an exact copy of the object and loads all the linked resources into the local storage.

Parameters

globalResourcesInterface

is an optional override for the resources interface used for fetching linked resources. If globalResourcesInterface is null, then object->resourcesInterface() is used.

If a filter configuration object already has a resources snapshot, then the function just clones the object without reloading anything.

Definition at line 84 of file KisRequiredResourcesOperators.h.

{
    auto clonedStorage = object->clone();
    TypeSP cloned = KisSharedPointerTraits<TypeSP>::template dynamicCastSP<T>(clonedStorage);
 
    if (!hasLocalResourcesSnapshot(cloned.data())) {
        createLocalResourcesSnapshot(cloned.data(), globalResourcesInterface);
        KIS_SAFE_ASSERT_RECOVER_NOOP(hasLocalResourcesSnapshot(cloned.data()));
    }
 
    return cloned;
}

References createLocalResourcesSnapshot(), hasLocalResourcesSnapshot(), and KIS_SAFE_ASSERT_RECOVER_NOOP.

createLocalResourcesSnapshot()

template<typename T >

void KisRequiredResourcesOperators::createLocalResourcesSnapshot	(	T *	object,
		KisResourcesInterfaceSP	globalResourcesInterface = nullptr )

Loads all the required resources either from the current resource interface or from the embedded data. The object first tries to fetch the required resource from the current source, and only if it fails, tries to load it from the embedded data.

Parameters

globalResourcesInterface

if globalResourcesInterface is not null, the resources are fetched from there, not from the internally stored resources interface

Definition at line 51 of file KisRequiredResourcesOperators.h.

{
    detail::assertInGuiThread();
 
    KisResourcesInterfaceSP effectiveResourcesInterface =
        globalResourcesInterface ?
            globalResourcesInterface :
            object->resourcesInterface();
 
    QList<KoResourceLoadResult> loadedResources =
        object->requiredResources(effectiveResourcesInterface);
 
    QList<KoResourceSP> resources;
 
    Q_FOREACH(const KoResourceLoadResult &loadedResource, loadedResources) {
        detail::addResourceOrWarnIfNotLoaded(loadedResource, &resources, effectiveResourcesInterface);
    }
 
    object->setResourcesInterface(detail::createLocalResourcesStorage(resources));
}

References KisRequiredResourcesOperators::detail::addResourceOrWarnIfNotLoaded(), KisRequiredResourcesOperators::detail::assertInGuiThread(), and KisRequiredResourcesOperators::detail::createLocalResourcesStorage().

hasLocalResourcesSnapshot()

template<typename T >

bool KisRequiredResourcesOperators::hasLocalResourcesSnapshot

(

const T *

object

)

Returns

true if the configuration has all the necessary resources in local storage. It mean it can be used in a threaded environment.

See also

createLocalResourcesSnapshot()

Definition at line 35 of file KisRequiredResourcesOperators.h.

{
    return detail::isLocalResourcesStorage(object->resourcesInterface());
}

References KisRequiredResourcesOperators::detail::isLocalResourcesStorage().