a6ebfb05ad
Adds a new asset shelf option (`STORE_ENABLED_CATALOGS_IN_PREFERENCES` option in RNA) to use the Preferences for storing the enabled catalogs. This way asset shelf types can decide if for their use-case, they want to synchronize the enabled catalogs over Blender sessions and files, or keep the stored locally in the file. This is important because for example on one hand, it would be annoying if for brush assets you'd have to enable the visible catalog tabs for every 3D View and every file, while on the other hand you need that level of control for the pose library where the catalogs the rigger/ animator cares about varies from project to project, character to character and shot to shot. Conceptually this also makes some sense: The new brush assets workflow synchronizes brush assets and their catalogs across Blender sessions and files, basically making them globally accessible independent of the current file/project, so treating the enabled catalogs the same is consistent. Previously reviewed in #120264 Pull Request: https://projects.blender.org/blender/blender/pulls/121363
150 lines
6.5 KiB
C
150 lines
6.5 KiB
C
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup bke
|
|
*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "BLI_compiler_attrs.h"
|
|
#include "BLI_sys_types.h"
|
|
|
|
struct UserDef;
|
|
struct bUserExtensionRepo;
|
|
struct bUserAssetLibrary;
|
|
struct bUserAssetShelfSettings;
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Assert Libraries
|
|
* \{ */
|
|
|
|
/** Name of the asset library added by default. Needs translation with `DATA_()` still. */
|
|
#define BKE_PREFS_ASSET_LIBRARY_DEFAULT_NAME N_("User Library")
|
|
|
|
struct bUserAssetLibrary *BKE_preferences_asset_library_add(struct UserDef *userdef,
|
|
const char *name,
|
|
const char *dirpath) ATTR_NONNULL(1);
|
|
/**
|
|
* Unlink and free a library preference member.
|
|
* \note Free's \a library itself.
|
|
*/
|
|
void BKE_preferences_asset_library_remove(struct UserDef *userdef,
|
|
struct bUserAssetLibrary *library) ATTR_NONNULL();
|
|
|
|
void BKE_preferences_asset_library_name_set(struct UserDef *userdef,
|
|
struct bUserAssetLibrary *library,
|
|
const char *name) ATTR_NONNULL();
|
|
|
|
/**
|
|
* Set the library path, ensuring it is pointing to a directory.
|
|
* Single blend files can only act as "Current File" library; libraries on disk
|
|
* should always be directories. If the path does not exist, that's fine; it can
|
|
* created as directory if necessary later.
|
|
*/
|
|
void BKE_preferences_asset_library_path_set(struct bUserAssetLibrary *library, const char *path)
|
|
ATTR_NONNULL();
|
|
|
|
struct bUserAssetLibrary *BKE_preferences_asset_library_find_index(const struct UserDef *userdef,
|
|
int index)
|
|
ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
|
|
struct bUserAssetLibrary *BKE_preferences_asset_library_find_by_name(const struct UserDef *userdef,
|
|
const char *name)
|
|
ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
|
|
|
|
/**
|
|
* Return the bUserAssetLibrary that contains the given file/directory path. The given path can be
|
|
* the library's top-level directory, or any path inside that directory.
|
|
*
|
|
* When more than one asset libraries match, the first matching one is returned (no smartness when
|
|
* there nested asset libraries).
|
|
*
|
|
* Return NULL when no such asset library is found.
|
|
*/
|
|
struct bUserAssetLibrary *BKE_preferences_asset_library_containing_path(
|
|
const struct UserDef *userdef, const char *path) ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
|
|
|
|
int BKE_preferences_asset_library_get_index(const struct UserDef *userdef,
|
|
const struct bUserAssetLibrary *library)
|
|
ATTR_NONNULL() ATTR_WARN_UNUSED_RESULT;
|
|
|
|
void BKE_preferences_asset_library_default_add(struct UserDef *userdef) ATTR_NONNULL();
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name Extension Repositories
|
|
* \{ */
|
|
|
|
bUserExtensionRepo *BKE_preferences_extension_repo_add(UserDef *userdef,
|
|
const char *name,
|
|
const char *module,
|
|
const char *custom_dirpath);
|
|
void BKE_preferences_extension_repo_remove(UserDef *userdef, bUserExtensionRepo *repo);
|
|
bUserExtensionRepo *BKE_preferences_extension_repo_add_default(UserDef *userdef);
|
|
bUserExtensionRepo *BKE_preferences_extension_repo_add_default_user(UserDef *userdef);
|
|
|
|
void BKE_preferences_extension_repo_name_set(UserDef *userdef,
|
|
bUserExtensionRepo *repo,
|
|
const char *name);
|
|
void BKE_preferences_extension_repo_module_set(UserDef *userdef,
|
|
bUserExtensionRepo *repo,
|
|
const char *module);
|
|
|
|
void BKE_preferences_extension_repo_custom_dirpath_set(bUserExtensionRepo *repo, const char *path);
|
|
size_t BKE_preferences_extension_repo_dirpath_get(const bUserExtensionRepo *repo,
|
|
char *dirpath,
|
|
int dirpath_maxncpy);
|
|
|
|
bUserExtensionRepo *BKE_preferences_extension_repo_find_index(const UserDef *userdef, int index);
|
|
bUserExtensionRepo *BKE_preferences_extension_repo_find_by_module(const UserDef *userdef,
|
|
const char *module);
|
|
/**
|
|
* Using a full URL/remote path to find a repository that shares its prefix.
|
|
*/
|
|
bUserExtensionRepo *BKE_preferences_extension_repo_find_by_remote_path_prefix(
|
|
const UserDef *userdef, const char *remote_path_full, const bool only_enabled);
|
|
/**
|
|
* Skip the `https` or `http` part of a URL `https://`, return zero if none is found.
|
|
*/
|
|
int BKE_preferences_extension_repo_remote_scheme_end(const char *url);
|
|
/**
|
|
* Set a name based on a URL, e.g. `https://www.example.com/path` -> `www.example.com`.
|
|
*/
|
|
void BKE_preferences_extension_remote_to_name(const char *remote_path, char name[64]);
|
|
|
|
int BKE_preferences_extension_repo_get_index(const UserDef *userdef,
|
|
const bUserExtensionRepo *repo);
|
|
|
|
/** \} */
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
/** \name #bUserAssetShelvesSettings
|
|
* \{ */
|
|
|
|
bUserAssetShelfSettings *BKE_preferences_asset_shelf_settings_get(const UserDef *userdef,
|
|
const char *shelf_idname);
|
|
bool BKE_preferences_asset_shelf_settings_is_catalog_path_enabled(const UserDef *userdef,
|
|
const char *shelf_idname,
|
|
const char *catalog_path);
|
|
/**
|
|
* Enable a catalog path for a asset shelf identified by \a shelf_idname. Will create the shelf
|
|
* settings in the Preferences if necessary.
|
|
* \return Return true if the catalog was newly enabled. The Preferences should be tagged as dirty
|
|
* then.
|
|
*/
|
|
bool BKE_preferences_asset_shelf_settings_ensure_catalog_path_enabled(UserDef *userdef,
|
|
const char *shelf_idname,
|
|
const char *catalog_path);
|
|
|
|
/** \} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|