[Unity-Native] A proposal to support UserData type "Rectangle" and "Position"

[JustusPan]

Could you please add a feature to support "Rectangle" and "Position" type of UserData?

UserDataScript.cs

using UnityEngine;

[System.Serializable]
public class UserDataRectangle
{
    public int Left;
    public int Top;
    public int Right;
    public int Bottom;

    public static UserDataRectangle CreateFromJSON(string jsonString)
    {
        return JsonUtility.FromJson<UserDataRectangle>(jsonString);
    }
}

[System.Serializable]
public class UserDataPosition
{
    public int X;
    public int Y;

    public static UserDataPosition CreateFromJSON(string jsonString)
    {
        return JsonUtility.FromJson<UserDataPosition>(jsonString);
    }
}

public class UserDataScript : MonoBehaviour
{
	void FunctionEventText(string value)
	{
	}

	void FunctionEventInt(int value)
	{
	}

    void FunctionEventRectangle(string jsonString)
    {
        UserDataRectangle rect = UserDataRectangle.CreateFromJSON(jsonString);
        Debug.Log("rect.Left: " + rect.Left);
        Debug.Log("rect.Top: " + rect.Top);
        Debug.Log("rect.Right: " + rect.Right);
        Debug.Log("rect.Bottom: " + rect.Bottom);
    }

    void FunctionEventPosition(string jsonString)
    {
        UserDataPosition pos = UserDataPosition.CreateFromJSON(jsonString);
        Debug.Log("pos.X: " + pos.X);
        Debug.Log("pos.Y: " + pos.Y);
    }
}

[MasamiYitsuse]

Sorry.
I once returned the following comment, but I withdraw it.
I misread your request.

---

Thank you for your assistance always.
This is in charge of developing "SS6Player for Unity".

Currently, it should be possible to get the "Rectangle" and "Position (Coordinate)" in UserData in the usual way.

Class: Library_SpriteStudio6.Data.Animation.Attribute.UserData

- Properties
public bool IsRectangle;
    Returns true if UserData has "Rectangle" data.

public bool IsCoordinate;
    Returns true if UserData has "Cooridinate(Position)" data.

- Variables
public UnityEngine.Rect Rectangle;
    When "IsRectangle" is true, valid "Rectangle" value is stored.

public UnityEngine.Vector2 Coordinate;
    When "IsCoordinate" is true, valid "Coordinate(Position)" value is stored.

You can receive "UserData" in now-playing animation by setting a delegate function to "Script_SpriteStudio6_Root.FunctionUserData".

{
   .....

    Script_SpriteStudio6_Root scriptRoot;  /* Class-Instance to playing animation*/

    scriptRoot.FunctionUserData = FunctionUserDataDecode;
    scriptRoot.AnimationPlay(.........);

    ....
}

private void FunctionUserDataDecode(
    Script_SpriteStudio6_Root scriptRoot,
    string nameParts,
    int indexParts,
    int indexAnimation,
    int frameDecode,
    int frameKeyData,
    ref Library_SpriteStudio6.Data.Animation.Attribute.UserData userData,
    bool flagWayBack
)
{
   if(userData.IsRectangle == true)
   { /* Has Rectangle data */
   }
   if(userData.IsCoordinate == true)
   { /* Has Coordinate data */
   }
}

If this method does not meet your objectives, would be very helpful if you could tell us why.
(I will refer when version-up-s.)

Best Regards,

[MasamiYitsuse]

Once again, ......

Thank you for your request.
This is in charge of developing "SS6Player for Unity".

I'm stuck in the middle of other work right now, so I can't get to it right away.

However, I will try to implement in the next version.

Once implemented, I will let you know in this issue.

Best Regards,

[MasamiYitsuse]

Thank you for your patience.

I have implemented your request.
Please pull "Ver. 2.1.19" from the branch "develop"(or "sampledevelop") in repository.

The relevant classes are

• "Script_SpriteStudio6_RootUnityNative.UserDataCoordinate" (for Coordinate)
• "Script_SpriteStudio6_RootUnityNative.UserDataRectangle" (for Rectangle)

... in "Script_SpriteStudio6_RootUnityNative.cs".

---

For event-receiving functions, create the following function in the "Script_SpriteStudio6_RootUnityNative" class.

public partial class Script_SpriteStudio6_RootUnityNative
{
	public void FunctionEventCoordinate(string value)
	{
		Script_SpriteStudio6_RootUnityNative.UserDataCoordinate coordinate = new Script_SpriteStudio6_RootUnityNative.UserDataCoordinate();
		coordinate.DeserializeJSON(value);

		/* MEMO: When want to operate in Unity's "Vector2". */
		Vector2 coordinateUnityVector2 = Vector2.zero;
		coordinate.Vector2Get(ref coordinateUnityVector2);
	}

	public void FunctionEventRectangle(string value)
	{
		Script_SpriteStudio6_RootUnityNative.UserDataRectangle rectangle = new Script_SpriteStudio6_RootUnityNative.UserDataRectangle();
		rectangle.DeserializeJSON(value);

		/* MEMO: When want to operate in Unity's "Rect". */
		Rect rectangleUnityRectangle = Rect.zero;
		rectangle.RectGet(ref rectangleUnityRectangle);
	}
}

These events are set in the "AnimationClip" by making the following settings on the Importer UI.

• (Option Basic) [Integrate "UserData" event Callback-Function] = false (Unchecked)
• (Option Basic) [Convert parameter"Rectangle" in "UserData"] = true (Checked)
• (Option Basic) [Convert parameter"Coordinate" in "UserData"] = true (Checked)

*) The importer setting is a bit cumbersome, but please bear with us as it needs to be compatible with the usage of other users.

---

In addition, new classes and functions are added to receive and handle "UserData" in bulk as a new method.
*) Operation of this class is mostly as same as "Library_SpriteStudio6.Data.Animation.Attribute.UserData".

For event-receiving functions, create the following function in the "Script_SpriteStudio6_RootUnityNative" class.

public partial class Script_SpriteStudio6_RootUnityNative
{
	/* New method */
	public void FunctionEventUserData(string value)
	{
		Script_SpriteStudio6_RootUnityNative.UserData userData = new Script_SpriteStudio6_RootUnityNative.UserData();
		userData.DeserializeJSON(value);

		if(true == userData.IsNumber)
		{	/* Has Number(int) */
			int valueInt = userData.NumberInt;
		}

		if(true == userData.IsCoordinate)
		{	/* Has Coordinate */
			Vector2 valueCoordinate = userData.Coordinate;
		}

		if(true == userData.IsRectangle)
		{	/* Has Rectangle */
			Rect valueRectangle = userData.Rectangle;
		}

		if(true == userData.IsText)
		{	/* Has Text */
			string valueText = userData.Text;
		}
	}
}

These events are set in the "AnimationClip" by making the following settings on the Importer UI.

• (Option Basic) [Integrate "UserData" event Callback-Function] = true (Checked)

---

I am looking forward to working with you.

Best Regards,