Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SDK-984] - move bodytype to settings #290

Merged
merged 8 commits into from
Jun 14, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions Editor/Core/Scripts/Analytics/AmplitudeEditorLogger.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,16 @@ public class AmplitudeEditorLogger : IAnalyticsEditorLogger
{
private const string SDK_TARGET = "Unity";

private readonly Dictionary<HelpSubject, string> helpDataMap = new Dictionary<HelpSubject, string>
private readonly Dictionary<HelpSubject, string> helpDataMap = new()
{
{ HelpSubject.AvatarCaching, "avatar caching" },
{ HelpSubject.Subdomain, "subdomain" },
{ HelpSubject.AvatarConfig, "avatar config" },
{ HelpSubject.GltfDeferAgent, "gltf defer agent" },
{ HelpSubject.LoadingAvatars, "download avatar into scene" }
{ HelpSubject.LoadingAvatars, "download avatar into scene" },
{
HelpSubject.Avatars, "avatars body type"
}
};

private bool isEnabled;
Expand Down Expand Up @@ -238,7 +241,7 @@ public void LogPackageInstalled(string id, string name)
LogEvent(EventName.INSTALL_PACKAGE, new Dictionary<string, object>
{
{ "id", id },
{ "name", name },
{ "name", name }
});
}

Expand All @@ -256,9 +259,9 @@ private void SetUserProperties()
{ Properties.ALLOW_ANALYTICS, true }
};

Dictionary<string, string> modules = ModuleList.GetInstalledModuleVersionDictionary();
var modules = ModuleList.GetInstalledModuleVersionDictionary();

foreach (KeyValuePair<string, string> module in modules)
foreach (var module in modules)
{
userProperties.Add(module.Key, module.Value);
}
Expand Down
1 change: 1 addition & 0 deletions Editor/Core/Scripts/Analytics/Constants.cs
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ public static class Links
public const string DOCS_AVATAR_LOADER_WINDOW = "https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-loader-window";
public const string DOCS_AVATAR_CONFIG_LINK = "https://docs.readyplayer.me/ready-player-me/integration-guides/unity/optimize/avatar-configuration";
public const string DOCS_AVATAR_CACHING = "https://docs.readyplayer.me/ready-player-me/integration-guides/unity/optimize/avatar-caching";
public const string AVATARS = "https://docs.readyplayer.me/ready-player-me/api-reference/avatars";
public const string APP_ID = "https://docs.readyplayer.me/ready-player-me/integration-guides/unity/avatar-creator/custom-avatar-creator#prerequisites";
}
}
Expand Down
3 changes: 2 additions & 1 deletion Editor/Core/Scripts/Analytics/HelpSubject.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ public enum HelpSubject
Subdomain,
AvatarConfig,
GltfDeferAgent,
LoadingAvatars
LoadingAvatars,
Avatars
}
}
6 changes: 6 additions & 0 deletions Editor/Core/Scripts/Settings/CoreSettingsSetter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ public static void SaveAppId(string appId)
Save();
}

public static void SaveBodyType(BodyType bodyType)
{
CoreSettingsHandler.CoreSettings.BodyType = bodyType;
Save();
}

public static void Save()
{
EditorUtility.SetDirty(CoreSettingsHandler.CoreSettings);
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" xsi="http://www.w3.org/2001/XMLSchema-instance" engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../UIElementsSchema/UIElements.xsd" editor-extension-mode="True">
<ui:Template name="HeaderTemplate" src="../Templates/HeaderTemplate.uxml" />
<Style src="../CommonStyle.uss" />
<ui:Template name="HeaderTemplate" src="project://database/Assets/Ready%20Player%20Me/Core/Editor/Core/Scripts/UI/EditorWindows/Templates/HeaderTemplate.uxml?fileID=9197481963319205126&amp;guid=07a53a11b73eff34685f226bf17a42d4&amp;type=3#HeaderTemplate" />
<Style src="project://database/Assets/Ready%20Player%20Me/Core/Editor/Core/Scripts/UI/EditorWindows/CommonStyle.uss?fileID=7433441132597879392&amp;guid=af10d225241bded4188e82d92db9230f&amp;type=3#CommonStyle" />
<ui:VisualElement style="align-items: center; width: 500px; margin-left: auto; margin-right: auto; margin-top: 0; margin-bottom: auto;">
<ui:Instance template="HeaderTemplate" name="HeaderTemplate" />
<ui:VisualElement name="PartnerSettingsHeading" class="heading">
Expand All @@ -13,6 +13,7 @@
<ui:Label text="Avatar Settings" display-tooltip-when-elided="true" class="headingText" />
</ui:VisualElement>
<ReadyPlayerMe.Core.Editor.AvatarConfigTemplate />
<ReadyPlayerMe.Core.Editor.AvatarBodyTypeTemplate />
<ReadyPlayerMe.Core.Editor.GltfDeferAgentTemplate />
</ui:VisualElement>
<ui:VisualElement name="AvatarCaching" style="flex-grow: 0; background-color: rgba(0, 0, 0, 0); flex-shrink: 0;">
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
using System;
using System.Linq;
using JetBrains.Annotations;
using ReadyPlayerMe.Core.Analytics;
using UnityEditor.UIElements;
using UnityEngine;
using UnityEngine.UIElements;
using Object = UnityEngine.Object;

namespace ReadyPlayerMe.Core.Editor
{
public class AvatarBodyTypeTemplate : VisualElement
{
private const string XML_PATH = "AvatarBodyTypeTemplate";
[CanBeNull] private const string AVATAR_BODY_TYPE_DROPDOWN_FIELD = "DropdownField";
private const string AVATAR_BODY_TYPE_HELP_BUTTON = "BodyTypeHelpButton";

public new class UxmlFactory : UxmlFactory<AvatarBodyTypeTemplate, UxmlTraits>
{
}
public new class UxmlTraits : VisualElement.UxmlTraits
{
}

public AvatarBodyTypeTemplate()
{
var visualTree = Resources.Load<VisualTreeAsset>(XML_PATH);
visualTree.CloneTree(this);

var bodyType = CoreSettingsHandler.CoreSettings.BodyType;

var field = this.Q<DropdownField>(AVATAR_BODY_TYPE_DROPDOWN_FIELD);
field.choices = Enum.GetNames(typeof(BodyType)).AsEnumerable().Where(bodyType => bodyType != BodyType.None.ToString()).ToList();
field.value = bodyType.ToString();
field.RegisterValueChangedCallback(OnBodyTypeChanged);
this.Q<Button>(AVATAR_BODY_TYPE_HELP_BUTTON).clicked += OnHelpButtonClicked;
}

private void OnHelpButtonClicked()
{
AnalyticsEditorLogger.EventLogger.LogFindOutMore(HelpSubject.Avatars);
Application.OpenURL(Constants.Links.AVATARS);
}

private void OnBodyTypeChanged(ChangeEvent<string> evt)
{
var newBodyType = Enum.Parse<BodyType>(evt.newValue);
CoreSettingsSetter.SaveBodyType(newBodyType);
}
}
}

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" xsi="http://www.w3.org/2001/XMLSchema-instance" engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../../../../../../../UIElementsSchema/UIElements.xsd" editor-extension-mode="True">
<ui:VisualElement name="Container" style="flex-grow: 0; background-color: rgba(0, 0, 0, 0); flex-direction: row; align-items: center; justify-content: flex-start; align-self: flex-start; margin-left: 15px; margin-right: 15px; flex-shrink: 1;">
<ui:VisualElement name="LabelAndHelpButton" style="flex-grow: 0; background-color: rgba(0, 0, 0, 0); flex-direction: row; align-items: center; justify-content: flex-start; align-self: center; min-width: 145px;">
<ui:Label tabindex="-1" text="Avatar Body Type" display-tooltip-when-elided="true" enable-rich-text="true" name="BodyTypeLabel" style="height: 33px; -unity-text-align: middle-left;" />
<ui:Button text="?" display-tooltip-when-elided="true" name="BodyTypeHelpButton" class="button2" style="margin-left: 0; margin-right: 0; margin-top: 0; margin-bottom: 0; padding-left: 0; padding-right: 0; padding-top: 0; padding-bottom: 0; width: 20px; height: 20px; border-top-left-radius: 15px; border-bottom-left-radius: 15px; border-top-right-radius: 15px; border-bottom-right-radius: 15px; -unity-text-align: middle-center; white-space: nowrap;" />
</ui:VisualElement>
<ui:DropdownField index="-1" name="DropdownField" style="width: 318px; max-width: initial; min-width: initial; margin-left: 0;" />
</ui:VisualElement>
</ui:UXML>

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions Runtime/AvatarCreator/Scripts/InCreatorAvatarLoader.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ namespace ReadyPlayerMe.AvatarCreator
public class InCreatorAvatarLoader
{
private readonly AvatarConfig avatarConfig;

public InCreatorAvatarLoader(AvatarConfig avatarConfig = null)
{
if (avatarConfig == null)
Expand All @@ -19,11 +19,11 @@ public InCreatorAvatarLoader(AvatarConfig avatarConfig = null)
}
this.avatarConfig = avatarConfig;
}
public async Task<GameObject> Load(string avatarId, BodyType bodyType, OutfitGender gender, byte[] data)

public async Task<GameObject> Load(string avatarId, OutfitGender gender, byte[] data)
{
var avatarMetadata = new AvatarMetadata();
avatarMetadata.BodyType = bodyType;
avatarMetadata.BodyType = CoreSettingsHandler.CoreSettings.BodyType;
avatarMetadata.OutfitGender = gender;

var context = new AvatarContext();
Expand All @@ -37,7 +37,7 @@ public async Task<GameObject> Load(string avatarId, BodyType bodyType, OutfitGen
new GltFastAvatarImporter(),
new AvatarProcessor()
});

try
{
context = await executor.Execute(context);
Expand Down
95 changes: 15 additions & 80 deletions Runtime/AvatarCreator/Scripts/Managers/AvatarManager.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public AvatarCreationResponse(GameObject avatarObject, AvatarProperties properti
public class AvatarManager : IDisposable
{
private const string ERROR_BODYSHAPES_NOT_ENABLED = "Failed to apply body shapes to the avatar. Please ensure body shapes are enabled in your studio application.";

private const string TAG = nameof(AvatarManager);
private readonly AvatarAPIRequests avatarAPIRequests;
private readonly string avatarConfigParameters;
Expand Down Expand Up @@ -72,7 +72,7 @@ public async Task<AvatarCreationResponse> CreateAvatarAsync(AvatarProperties ava
}

avatarId = avatarProperties.Id;
avatar = await GetAvatar(avatarId, avatarProperties.BodyType, true);
avatar = await GetAvatar(avatarId, true);
}
catch (Exception e)
{
Expand All @@ -83,79 +83,13 @@ public async Task<AvatarCreationResponse> CreateAvatarAsync(AvatarProperties ava
return new AvatarCreationResponse(avatar, avatarProperties);
}

/// <summary>
/// Create a new avatar.
/// </summary>
/// <param name="avatarProperties">Properties which describes avatar</param>
/// <returns>A tuple in the form of (GameObject, AvatarProperties)</returns>
[Obsolete("This method is deprecated. Use CreateAvatarAsync instead.")]
public async Task<(GameObject avatarGameObject, AvatarProperties avatarProperties)> CreateAvatar(AvatarProperties avatarProperties)
{
GameObject avatar = null;
try
{
avatarProperties = await avatarAPIRequests.CreateNewAvatar(avatarProperties);
gender = avatarProperties.Gender;
if (ctxSource.IsCancellationRequested)
{
return (null, avatarProperties);
}

avatarId = avatarProperties.Id;
avatar = await GetAvatar(avatarId, avatarProperties.BodyType, true);
}
catch (Exception e)
{
HandleException(e);
return (avatar, avatarProperties);
}

return (avatar, avatarProperties);
}

/// <summary>
/// Create a new avatar from a provided template.
/// </summary>
/// <param name="id">Template id</param>
/// <param name="bodyType">Avatar body type</param>
/// <returns>A tuple in the form of (GameObject, AvatarProperties)</returns>
[Obsolete("This method is deprecated. Use CreateAvatarFromTemplateAsync instead.")]
public async Task<(GameObject, AvatarProperties)> CreateAvatarFromTemplate(string id, BodyType bodyType)
{
GameObject avatar = null;
var avatarProperties = new AvatarProperties();
try
{
avatarProperties = await avatarAPIRequests.CreateFromTemplateAvatar(
id,
CoreSettingsHandler.CoreSettings.Subdomain,
bodyType
);
gender = avatarProperties.Gender;
if (ctxSource.IsCancellationRequested)
{
return (null, avatarProperties);
}
avatarProperties.isDraft = true;
avatarId = avatarProperties.Id;
avatar = await GetAvatar(avatarId, bodyType, true);
}
catch (Exception e)
{
HandleException(e);
return (avatar, avatarProperties);
}

return (avatar, avatarProperties);
}

/// <summary>
/// Create a new avatar from a provided template.
/// </summary>
/// <param name="id">Template id</param>
/// <param name="bodyType">Avatar body type</param>
/// <returns>AvatarCreationResponse: Result of avatar creation including the GameObject and its properties</returns>
public async Task<AvatarCreationResponse> CreateAvatarFromTemplateAsync(string id, BodyType bodyType)
///
public async Task<AvatarCreationResponse> CreateAvatarFromTemplateAsync(string id)
{
GameObject avatar = null;
var avatarProperties = new AvatarProperties();
Expand All @@ -164,7 +98,7 @@ public async Task<AvatarCreationResponse> CreateAvatarFromTemplateAsync(string i
avatarProperties = await avatarAPIRequests.CreateFromTemplateAvatar(
id,
CoreSettingsHandler.CoreSettings.Subdomain,
bodyType
CoreSettingsHandler.CoreSettings.BodyType
);
gender = avatarProperties.Gender;
if (ctxSource.IsCancellationRequested)
Expand All @@ -173,7 +107,7 @@ public async Task<AvatarCreationResponse> CreateAvatarFromTemplateAsync(string i
}
avatarProperties.isDraft = true;
avatarId = avatarProperties.Id;
avatar = await GetAvatar(avatarProperties.Id, bodyType, true);
avatar = await GetAvatar(avatarProperties.Id, true);
}
catch (Exception e)
{
Expand Down Expand Up @@ -218,7 +152,7 @@ public async void PrecompileAvatar(string id, PrecompileData precompileData)
/// <param name="id">Avatar id</param>
/// <param name="isPreview">Whether its a preview avatar</param>
/// <returns>Avatar gameObject</returns>
public async Task<GameObject> GetAvatar(string id, BodyType bodyType, bool isPreview = false)
public async Task<GameObject> GetAvatar(string id, bool isPreview = false)
{
avatarId = id;
byte[] data;
Expand All @@ -237,7 +171,7 @@ public async Task<GameObject> GetAvatar(string id, BodyType bodyType, bool isPre
return null;
}

return await inCreatorAvatarLoader.Load(avatarId, bodyType, gender, data);
return await inCreatorAvatarLoader.Load(avatarId, gender, data);
}

public async Task<AvatarProperties> GetAvatarProperties(string id)
Expand All @@ -262,7 +196,7 @@ public async Task<AvatarProperties> GetAvatarProperties(string id)
/// <param name="assetId"></param>
/// <param name="assetType"></param>
/// <returns>Avatar gameObject</returns>
public async Task<GameObject> UpdateAsset(AssetType assetType, BodyType bodyType, object assetId)
public async Task<GameObject> UpdateAsset(AssetType assetType, object assetId)
{
var payload = new AvatarProperties
{
Expand Down Expand Up @@ -293,9 +227,9 @@ public async Task<GameObject> UpdateAsset(AssetType assetType, BodyType bodyType
await ValidateBodyShapeUpdate(assetType, assetId);


return await inCreatorAvatarLoader.Load(avatarId, bodyType, gender, data);
return await inCreatorAvatarLoader.Load(avatarId, gender, data);
}

/// <summary>
/// Function that checks if body shapes are enabled in the studio. This validation is performed only in the editor.
/// </summary>
Expand All @@ -307,16 +241,16 @@ private async Task ValidateBodyShapeUpdate(AssetType assetType, object assetId)
{
return;
}

var data = await avatarAPIRequests.GetAvatarMetadata(avatarId, true);
var hasUpdatedAvatarWithAsset = data.Assets.ContainsKey(assetType) && data.Assets[assetType] == assetId;
var hasUpdatedAvatarWithAsset = data.Assets.ContainsKey(assetType) && (string) data.Assets[assetType] == (string) assetId;
if (hasUpdatedAvatarWithAsset)
{
return;
}
Debug.LogError(ERROR_BODYSHAPES_NOT_ENABLED);
}


public async Task<Dictionary<AssetType, AssetColor[]>> LoadAvatarColors()
{
Expand Down Expand Up @@ -372,6 +306,7 @@ public async Task Delete(bool isDraft)
public void Dispose()
{
ctxSource?.Cancel();
ctxSource?.Dispose();
}

private void HandleException(Exception e)
Expand Down
Loading