feature: Add [Read From Running Profile] Button to AnimatableVolumeComponent
or maybe VolumeHelper.

• for better Animation keying?

Sync or Read

Claim

this is optional feature that may not be implement, because currently there's no class other than TextureCurve / AnimationCurve that is built-in Unity VolumeParameter, both URP and HDRP.
(technically ,TextureCurve and AnimationCurve can't be animated)

if you want to animate class, just use struct.

Detail

Unity can't animate class (even though it can serialize it 😢 ), but unity can animate struct!
see → Animating serialized class properties with animation clip?

So, if there's a class VolumeParameter (VolumeParameter<SomeClass>), we can maybe generate a struct for it, and link between them.

example:

    /// <summary>
    /// User class, not animatable
    /// </summary>
    [Serializable]
    public class MyClass
    {
        public int intField;
        public float floatField;
        public bool boolField;
    }

// -> generates...

    /// <summary>
    /// generated struct; this is animatable!
    /// </summary>
    [Serializable]
    public struct MyStruct
    {
        public int intField;
        public float floatField;
        public bool boolField;
    }

• Remove VolumeParameter<Class> Support
  • Like AnimationCurveParameter
• Remove VolumeParameter<Array> Support
  • Like VolumeParameter<DiffusionProfileSettings[]> in HDRP

problem and solution:

• currently, when generating code, it took 1 compilation to compile new AnimationComponents and 1 compilation to update AnimatableVolumeComponentMapping.g.cs (because we search new components by reflection)
  • to avoid this, after generating code for new AnimationComponent, use their expected class name to generate the map (before the script compilation of new components).

another solution:

• Also, it seems like the package does not need any mapping any more, since I deleted the runtime "add corresponding component" method
• so we can just delete the mapping, and when pressing "Add Corresponding Component" button, just search on the fly by reflection
• let me think about it

When [Read from Profile] is on, current system is constantly writing back to animatable.
When animation window is in recording state, and user drags the playback head, the system will overwrite keyed value by current value.
(this is base on imagination)

example:

1. key 0 at 0(s), 1.5 at 1(s)
2. drag from 1(s) to 0.5(s)
3. →all frame between 0.5(s) and 1(s) keys 1 (unless user jumps)

reason:

when dragging, animation will set current value to new value, but Read-from-Profile reads profile value (which is old value!) and overwrites values in animation.

solution:

• even though reading from profile, write back to profile when animation previewing (OnDidApplyAnimationProperties)
  • "write" only, don't read?
• check EditorUtility.IsDirty(profile) before reading from profile

Japanese Support

• At least for long sentences
• e.g. description of Animatable Component Wizard

No comment is not good for me and others!

The AnimatableVolumeComponent seems to work in HDRP, but code-gen generates classes with errors.

Errors:

• nested enums/classes in classes
  • reason: type name will be "ParentClass+ChildEnum", which is not valid
  • solution: replace + -> . in type name
• internal classes
  • reason: deprecated, or used by other VolumeComponent only (internal use)
  • solution: exclude code generation for internal classes
• class with HideInInspector, Obsolete attributes
  • reason: deprecated
  • solution: exclude code generation of classes that has above attributes
• internal types of VolumeParameter<>
  • reason: deprecated parameters
  • solution: exclude code generation of internal types
• private parameters
  • reason: ??? / parameters that should only be set in quality settings (not sure)
  • solution: exclude code generation of private parameters / set by public properties (if any)

fix me.