AS_asset_representation.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include <memory>
#include <optional>
#include <string>
#include <variant>
 
#include "BLI_string_ref.hh"
#include "BLI_utility_mixins.hh"
 
#include "DNA_ID_enums.h"
#include "DNA_asset_types.h"
 
struct AssetMetaData;
struct ID;
struct PreviewImage;
 
namespace blender::asset_system {
 
class AssetLibrary;
 
class AssetRepresentation : NonCopyable, NonMovable {
  AssetLibrary &owner_asset_library_;
  /* Mutable to allow lazy updating on name changes in #library_relative_identifier(). */
  mutable std::string relative_identifier_;
 
  struct ExternalAsset {
    std::string name;
    int id_type = 0;
    std::unique_ptr<AssetMetaData> metadata_ = nullptr;
    PreviewImage *preview_ = nullptr;
  };
  std::variant<ExternalAsset, ID *> asset_;
 
  friend class AssetLibrary;
 
 public:
  AssetRepresentation(StringRef relative_asset_path,
                      StringRef name,
                      int id_type,
                      std::unique_ptr<AssetMetaData> metadata,
                      AssetLibrary &owner_asset_library);
  AssetRepresentation(ID &id, AssetLibrary &owner_asset_library);
  ~AssetRepresentation();

  AssetWeakReference make_weak_reference() const;

  void ensure_previewable();
  PreviewImage *get_preview() const;
 
  StringRefNull get_name() const;
  ID_Type get_id_type() const;
  AssetMetaData &get_metadata() const;
 
  StringRefNull library_relative_identifier() const;
  std::string full_path() const;
  std::string full_library_path() const;

  std::optional<eAssetImportMethod> get_import_method() const;
  bool may_override_import_method() const;
  bool get_use_relative_path() const;
  ID *local_id() const;
  bool is_local_id() const;
  AssetLibrary &owner_asset_library() const;
};
 
}  // namespace blender::asset_system