|
|
@@ -6,12 +6,32 @@ using BansheeEngine;
|
|
|
|
|
|
namespace BansheeEditor
|
|
|
{
|
|
|
+ /// <summary>
|
|
|
+ /// The primary location for interacting with all the resources in the current project. A complete hierarchy of
|
|
|
+ /// resources is provided which can be interacted with by importing new ones, deleting them, moving, renaming and similar.
|
|
|
+ /// </summary>
|
|
|
public sealed class ProjectLibrary : ScriptObject
|
|
|
{
|
|
|
+ /// <summary>
|
|
|
+ /// Root entry of the project library, referencing the top level resources folder.
|
|
|
+ /// </summary>
|
|
|
public static DirectoryEntry Root { get { return Internal_GetRoot(); } }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Absolute path to the current project's project library resource folder.
|
|
|
+ /// </summary>
|
|
|
public static string ResourceFolder { get { return Internal_GetResourceFolder(); } }
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Triggered when a new entry is added to the project library. Provided path relative to the project library
|
|
|
+ /// resources folder.
|
|
|
+ /// </summary>
|
|
|
public static event Action<string> OnEntryAdded;
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Triggered when an entry is removed from the project library. Provided path relative to the project library
|
|
|
+ /// resources folder.
|
|
|
+ /// </summary>
|
|
|
public static event Action<string> OnEntryRemoved;
|
|
|
|
|
|
private static HashSet<string> queuedForImport = new HashSet<string>();
|
|
|
@@ -20,6 +40,9 @@ namespace BansheeEditor
|
|
|
|
|
|
private const float TIME_SLICE_SECONDS = 0.030f;
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Checks the project library folder for any modifications and reimports the required resources.
|
|
|
+ /// </summary>
|
|
|
public static void Refresh()
|
|
|
{
|
|
|
string[] modifiedPaths = Internal_Refresh(ResourceFolder, false);
|
|
|
@@ -30,6 +53,11 @@ namespace BansheeEditor
|
|
|
}
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Checks the specified folder for any modifications and reimports the required resources.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="path">Path to a file or folder to refresh. Relative to the project library resources folder or
|
|
|
+ /// absolute.</param>
|
|
|
public static void Refresh(string path)
|
|
|
{
|
|
|
string[] modifiedPaths = Internal_Refresh(path, false);
|
|
|
@@ -40,81 +68,172 @@ namespace BansheeEditor
|
|
|
}
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Registers a new resource in the library.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="resource">Resource instance to add to the library. A copy of the resource will be saved at the
|
|
|
+ /// provided path.</param>
|
|
|
+ /// <param name="path">Path where where to store the resource. Absolute or relative to the resources folder.</param>
|
|
|
public static void Create(Resource resource, string path)
|
|
|
{
|
|
|
Internal_Create(resource, path);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Updates a resource that is already in the library.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="resource">Resource to save.</param>
|
|
|
public static void Save(Resource resource)
|
|
|
{
|
|
|
Internal_Save(resource);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Loads a resource from the project library.
|
|
|
+ /// </summary>
|
|
|
+ /// <typeparam name="T">Type of the resource to load.</typeparam>
|
|
|
+ /// <param name="path">Path of the resource to load. Absolute or relative to the resources folder.</param>
|
|
|
+ /// <returns>Instance of the loaded resource, or null if not found.</returns>
|
|
|
public static T Load<T>(string path) where T : Resource
|
|
|
{
|
|
|
return (T) Internal_Load(path);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Triggers a reimport of a resource using the provided import options, if needed.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="path">Path to the resource to reimport, absolute or relative to resources folder.</param>
|
|
|
+ /// <param name="options">ptional import options to use when importing the resource. Caller must ensure the import
|
|
|
+ /// options are of the correct type for the resource in question. If null is provided default
|
|
|
+ /// import options are used.</param>
|
|
|
+ /// <param name="force">Should the resource be reimported even if no changes are detected.</param>
|
|
|
public static void Reimport(string path, ImportOptions options = null, bool force = false)
|
|
|
{
|
|
|
Internal_Reimport(path, options, force);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Checks does the project library contain a resource at the specified path.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="path">Path to the resource to check, absolute or relative to resources folder.</param>
|
|
|
+ /// <returns>True if the resourc exists, false otherwise.</returns>
|
|
|
public static bool Exists(string path)
|
|
|
{
|
|
|
return GetEntry(path) != null;
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Attempts to locate a library entry that describes a file or a folder in the project library.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="path">Path to the entry to retrieve, absolute or relative to resources folder.</param>
|
|
|
+ /// <returns>Library entry if found, null otherwise. This object can become invalid on the next library refresh
|
|
|
+ /// and you are not meant to hold a permanent reference to it.</returns>
|
|
|
public static LibraryEntry GetEntry(string path)
|
|
|
{
|
|
|
return Internal_GetEntry(path);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Searches the library for a pattern and returns all entries matching it.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="pattern">Pattern to search for. Use wildcard * to match any character(s).</param>
|
|
|
+ /// <param name="types">Type of resources to search for. If null all entries will be searched.</param>
|
|
|
+ /// <returns>A set of entries matching the pattern. These objects can become invalid on the next library refresh
|
|
|
+ /// and you are not meant to hold a permanent reference to them.</returns>
|
|
|
public static LibraryEntry[] Search(string pattern, ResourceType[] types = null)
|
|
|
{
|
|
|
return Internal_Search(pattern, types);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Returns a path to a resource stored in the project library.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="resource">Resource to find the path for.</param>
|
|
|
+ /// <returns>Path to relative to the project library resources folder if resource was found, null otherwise.
|
|
|
+ /// </returns>
|
|
|
public static string GetPath(Resource resource)
|
|
|
{
|
|
|
return Internal_GetPath(resource);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Returns a path to a resource with the specified UUID stored in the project library.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="uuid">Unique identifier of the resources to retrieve the path of.</param>
|
|
|
+ /// <returns>Path to relative to the project library resources folder if resource was found, null otherwise.
|
|
|
+ /// </returns>
|
|
|
public static string GetPath(string uuid)
|
|
|
{
|
|
|
return Internal_GetPathFromUUID(uuid);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Deletes a resource in the project library.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="path">Path to the entry to delete, absolute or relative to resources folder.</param>
|
|
|
public static void Delete(string path)
|
|
|
{
|
|
|
Internal_Delete(path);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Creates a new folder in the library.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="path">Path of the folder to create. Absolute or relative to the resources folder.</param>
|
|
|
public static void CreateFolder(string path)
|
|
|
{
|
|
|
Internal_CreateFolder(path);
|
|
|
}
|
|
|
|
|
|
- public static void Rename(string path, string name)
|
|
|
+ /// <summary>
|
|
|
+ /// Renames an entry in the project library.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="path">Path of the entry to rename, absolute or relative to resources folder.</param>
|
|
|
+ /// <param name="name">New name of the entry with an extension.</param>
|
|
|
+ /// <param name="overwrite">Determines should the entry be deleted if one with the provided name already exists. If
|
|
|
+ /// this is false and an entry already exists, no rename operation will be performed.</param>
|
|
|
+ public static void Rename(string path, string name, bool overwrite = false)
|
|
|
{
|
|
|
- Internal_Rename(path, name);
|
|
|
+ Internal_Rename(path, name, false);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Moves an entry in the project library from one path to another.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="oldPath">Source path of the entry, absolute or relative to resources folder.</param>
|
|
|
+ /// <param name="newPath">Destination path of the entry, absolute or relative to resources folder.</param>
|
|
|
+ /// <param name="overwrite">Determines should the entry be deleted if one at the destination path already exists. If
|
|
|
+ /// this is false and an entry already exists, no move operation will be performed.</param>
|
|
|
public static void Move(string oldPath, string newPath, bool overwrite = false)
|
|
|
{
|
|
|
Internal_Move(oldPath, newPath, overwrite);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Copies an entry in the project library from one path to another.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="source">Source path of the entry, absolute or relative to resources folder.</param>
|
|
|
+ /// <param name="destination">Destination path of the entry, absolute or relative to resources folder.</param>
|
|
|
+ /// <param name="overwrite">Determines should the entry be deleted if one at the destination path already exists. If
|
|
|
+ /// this is false and an entry already exists, no copy operation will be performed.</param>
|
|
|
public static void Copy(string source, string destination, bool overwrite = false)
|
|
|
{
|
|
|
Internal_Copy(source, destination, overwrite);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Controls should a resource be included an a build. All dependant resources will also be included.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="path">Path of the resource to include, absolute or relative to resources folder.</param>
|
|
|
+ /// <param name="include">True if it should be included, false otherwise.</param>
|
|
|
public static void SetIncludeInBuild(string path, bool include)
|
|
|
{
|
|
|
Internal_SetIncludeInBuild(path, include);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Triggers reimport for queued resource. Should be called once per frame.
|
|
|
+ /// </summary>
|
|
|
internal static void Update()
|
|
|
{
|
|
|
if (queuedForImport.Count > 0)
|
|
|
@@ -166,12 +285,20 @@ namespace BansheeEditor
|
|
|
}
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Triggered internally by the runtime when a new entry is added to the project library.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="path">Path relative to the project library resources folder.</param>
|
|
|
private static void Internal_DoOnEntryAdded(string path)
|
|
|
{
|
|
|
if (OnEntryAdded != null)
|
|
|
OnEntryAdded(path);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Triggered internally by the runtime when an entry is removed from the project library.
|
|
|
+ /// </summary>
|
|
|
+ /// <param name="path">Path relative to the project library resources folder.</param>
|
|
|
private static void Internal_DoOnEntryRemoved(string path)
|
|
|
{
|
|
|
if (OnEntryRemoved != null)
|
|
|
@@ -215,7 +342,7 @@ namespace BansheeEditor
|
|
|
private static extern void Internal_CreateFolder(string path);
|
|
|
|
|
|
[MethodImpl(MethodImplOptions.InternalCall)]
|
|
|
- private static extern void Internal_Rename(string path, string name);
|
|
|
+ private static extern void Internal_Rename(string path, string name, bool overwrite);
|
|
|
|
|
|
[MethodImpl(MethodImplOptions.InternalCall)]
|
|
|
private static extern void Internal_Move(string oldPath, string newPath, bool overwrite);
|
|
|
@@ -230,24 +357,45 @@ namespace BansheeEditor
|
|
|
private static extern void Internal_SetIncludeInBuild(string path, bool force);
|
|
|
}
|
|
|
|
|
|
- // Note: Must be the same as C++ enum ProjectLibrary::LibraryEntryType
|
|
|
- public enum LibraryEntryType
|
|
|
+ /// <summary>
|
|
|
+ /// Type of project library entries.
|
|
|
+ /// </summary>
|
|
|
+ public enum LibraryEntryType // Note: Must match the C++ enum ProjectLibrary::LibraryEntryType
|
|
|
{
|
|
|
File, Directory
|
|
|
}
|
|
|
|
|
|
- // Note: Must be the same as C++ enum ScriptResourceType
|
|
|
- public enum ResourceType
|
|
|
+ /// <summary>
|
|
|
+ /// Type of resources supported by the project library.
|
|
|
+ /// </summary>
|
|
|
+ public enum ResourceType // Note: Must match the C++ enum ScriptResourceType
|
|
|
{
|
|
|
Texture, SpriteTexture, Mesh, Font, Shader, Material, Prefab, PlainText, ScriptCode, StringTable, GUISkin, Undefined
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// A generic project library entry that may be a file or a folder.
|
|
|
+ /// </summary>
|
|
|
public class LibraryEntry : ScriptObject
|
|
|
{
|
|
|
+ /// <summary>
|
|
|
+ /// Path of the library entry, relative to the project library resources folder.
|
|
|
+ /// </summary>
|
|
|
public string Path { get { return Internal_GetPath(mCachedPtr); } }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Name of the library entry.
|
|
|
+ /// </summary>
|
|
|
public string Name { get { return Internal_GetName(mCachedPtr); } }
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// Type of the library entry.
|
|
|
+ /// </summary>
|
|
|
public LibraryEntryType Type { get { return Internal_GetType(mCachedPtr); } }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Directory entry that contains this entry. This may be null for the root entry.
|
|
|
+ /// </summary>
|
|
|
public DirectoryEntry Parent { get { return Internal_GetParent(mCachedPtr); } }
|
|
|
|
|
|
[MethodImpl(MethodImplOptions.InternalCall)]
|
|
|
@@ -263,20 +411,48 @@ namespace BansheeEditor
|
|
|
private static extern DirectoryEntry Internal_GetParent(IntPtr thisPtr);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// A project library entry representing a directory that contains other entries.
|
|
|
+ /// </summary>
|
|
|
public class DirectoryEntry : LibraryEntry
|
|
|
{
|
|
|
+ /// <summary>
|
|
|
+ /// A set of entries contained in this entry.
|
|
|
+ /// </summary>
|
|
|
public LibraryEntry[] Children { get { return Internal_GetChildren(mCachedPtr); } }
|
|
|
|
|
|
[MethodImpl(MethodImplOptions.InternalCall)]
|
|
|
private static extern LibraryEntry[] Internal_GetChildren(IntPtr thisPtr);
|
|
|
}
|
|
|
|
|
|
+ /// <summary>
|
|
|
+ /// A library entry representing a resource.
|
|
|
+ /// </summary>
|
|
|
public class FileEntry : LibraryEntry
|
|
|
{
|
|
|
+ /// <summary>
|
|
|
+ /// Import options used for importing the resource.
|
|
|
+ /// </summary>
|
|
|
public ImportOptions Options { get { return Internal_GetImportOptions(mCachedPtr); } }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Unique identifier of the resource.
|
|
|
+ /// </summary>
|
|
|
public string UUID { get { return Internal_GetUUID(mCachedPtr); } }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Custom icon for the resource to display in the editor, if the resource has one.
|
|
|
+ /// </summary>
|
|
|
public Texture2D Icon { get { return Internal_GetIcon(mCachedPtr); } }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Type of the resource referenced by this entry.
|
|
|
+ /// </summary>
|
|
|
public ResourceType ResType { get { return Internal_GetResourceType(mCachedPtr); } }
|
|
|
+
|
|
|
+ /// <summary>
|
|
|
+ /// Determines will the resource be included in the project build.
|
|
|
+ /// </summary>
|
|
|
public bool IncludeInBuild { get { return Internal_GetIncludeInBuild(mCachedPtr); } }
|
|
|
|
|
|
[MethodImpl(MethodImplOptions.InternalCall)]
|
BearishSun