RangedDynamicProperty cannot set value and range atomically.

[pixelzoom]

In RangedDynamicProperty:

  /**
   * Convenience function for setting the rangeProperty. Note: be careful using this function, as validation will occur
   * immediately, and if the value is outside of this new Range an error will occur. See this.setValueAndRange() for
   *  way to set both at once without assertion errors.
   */
  public set range( range: Range ) {
    this.rangeProperty.value = range;
  }

Note that the doc says:

See this.setValueAndRange() for way to set both at once without assertion errors.

But there is no setValueAndRange method on this class or its ancestors. Is that an oversight or a documentation copy-paste error from NumberProperty?

In QBS we have a RangedDynamicProperty whose value and range needs to change atomically. How can that be accomplished.

Assigning to @jonathanolson since he is the author of RangedDynamicProperty and is superclass DynamicProperty. High-priority on a response please, since I need to know where this is possible for QBS, or whether I need to use a different approach.

[pixelzoom]

Is that an oversight or a documentation copy-paste error from NumberProperty?

I see the identical set range method in NumberProperty, with identical documentation. And NumberProperty does have method setValueAndRange. So I'm 99% certain that this was a copy-paste error.

[pixelzoom]

It looks like RangedDynamicProperty also lacks these methods from NumberProperty, which are required for resetting value and range atomically.

  public override reset(): void {
    this.resetValueAndRange(); // even if we don't own the range, reset them together to prevent assertions, https://github.com/phetsims/axon/issues/427
    super.reset();
  }

  /**
   * Resets the value and range atomically.
   * If you use setValueAndRange, you'll likely need to use this instead of reset.
   */
  public resetValueAndRange(): void {
    this.setValueAndRange( this.initialValue, this.rangeProperty.initialValue );
  }

[jonathanolson]

It looks like a bad copy-paste. Would it work to add in the setValueAndRange from NumberProperty as an equivalent to RangedDynamicProperty?

[pixelzoom]

Would it work to add in the setValueAndRange from NumberProperty as an equivalent to RangedDynamicProperty?

@jonathanolson I'm not clear on how that would work. Wouldn't map and inverseMap need to handle mapping of both value and range? Or maybe I don't understand the use case for RangedDynamicProperty.

And should TRangeProperty also be updated to include setValueAndRange and resetValueAndRange methods?

[pixelzoom]

@jonathanolson pinging you again on this issue. Questions in previous comment.

[jonathanolson]

@pixelzoom I applied a bunch of range improvements to RangedDynamicProperty, can you see how it works now?