Tween

public Tween();

Прямой new Tween() недопустим для рабочей анимации: native-конструктор выдаёт ошибку, объект остаётся невалидным. Используйте Entity.CreateTween() или EntityTree.CreateTween() и сразу добавьте команды до первого шага. Конструктор присутствует в SDK, но это не рекомендация его вызывать.

public Tween BindEntity(Entity node);

Связывает жизненный цикл и режим Bound с Entity, не назначает цель всех TweenProperty. Пока Entity вне дерева, последовательность не продвигается, даже через CustomStep. После удаления объекта последовательность прекращается при обработке деревом. Для автоматической привязки используйте Entity.CreateTween; unbound EntityTree.CreateTween настраивается отдельно.

public Tween Chain();

Только следующий добавляемый Tweener начинает новый последовательный шаг. Полезно после SetParallel(true), чтобы дождаться окончания всей параллельной группы. Не исполняет накопленные команды немедленно и не меняет defaultParallel для всех следующих добавлений.

public bool CustomStep(double delta);

Вручную продвигает последовательность на delta с учётом SpeedScale, в том числе когда она Pause. Не включает постоянное Play и не заменяет требование bound Entity находиться в дереве. Не вызывайте рекурсивно из того же шага. В 1.0.0 шаг, испустивший Finished, ещё возвращает true; следующий вызов для завершённой последовательности — false. Поэтому bool не является точным событием завершения. Для тестов сначала Pause, чтобы избежать параллельного автоматического продвижения.

public int GetLoopsLeft();

Число оставшихся полных проходов с учётом текущего. SetLoops(2) означает два прохода всего, не два дополнительных. −1 для loops<=0. После конечного завершения — 0; это не время и не число шагов.

public double GetTotalElapsedTime();

Накопленная входная delta с учётом SpeedScale, включая циклы и избыточный остаток последнего ручного шага. Не точная длительность анимации и не настенные секунды. Stop сбрасывает значение; Pause сохраняет его.

public bool HasTweeners();

Проверяет, есть ли сохранённые команды. Не означает, что Tween валиден, запущен или ещё выполняет работу: Kill не очищает список немедленно, а последующая очистка дерева очищает.

public static Variant InterpolateValue(Variant initialValue, Variant deltaValue, double elapsedTime, double duration, Tween.TransitionType transType, Tween.EaseType easeType);

Статически вычисляет интерполяцию Variant без создания Tween и изменения объекта. deltaValue — разница конечного и начального значения, не само конечное значение. При duration=0 возвращает initialValue+deltaValue. transType/easeType должны быть допустимыми, типы Variant — поддерживаемыми интерполяцией. В этом проходе проверены скалярные числа; это не универсальная интерполяция любых объектов.

public bool IsRunning();

Возвращает флаг Play. False после Pause/Stop/Kill или конечного завершения. True само по себе не доказывает валидность, прогресс в текущем кадре или доступный bound-объект; учитывайте IsValid и режим паузы.

public bool IsValid();

Показывает, пригодна ли последовательность в её текущем lifecycle. new Tween невалиден; Kill сразу делает false. После естественного Finished очистка деревом может произойти на следующем проходе. Valid не обещает IsRunning и не разрешает добавление после старта без Stop.

public void Kill();

Останавливает и немедленно инвалидирует последовательность, включая её subtweens. Не испускает Finished и не возвращает изменённые свойства к исходным значениям. Не используйте как Pause: убитую последовательность нельзя продолжить Play.

public Tween Parallel();

Только следующий добавляемый Tweener присоединяется к текущему шагу. После добавления снова действует режим SetParallel. Весь шаг заканчивается после наиболее долгого участника; это параллельность анимационных команд, не запуск OS-потоков.

public void Pause();

Приостанавливает автоматическое продвижение, сохраняя текущий шаг, время и свойства. Play продолжает, CustomStep может продвинуть вручную. Не эквивалент Stop, который сбрасывает внутренний старт/счётчик времени.

public void Play();

Разрешает продвижение валидного Tween после Pause/Stop. Не оживляет Kill и не гарантирует обработку при паузе дерева или отсутствии bound Entity в дереве. Для естественно завершённого и очищенного Tween создайте новый объект.

public Tween SetEase(Tween.EaseType ease);

Задаёт easing по умолчанию для добавляемых дальше Property/MethodTweeners. Уже добавленные команды сохраняют захваченные настройки; меняйте их собственными методами при необходимости. Не меняет длительность или режим обработки.

public Tween SetIgnoreTimeScale(bool ignore = true);

Для автоматической обработки выбирает unscaled delta дерева. Не отменяет Pause, tree pause mode или bound lifecycle. CustomStep получает delta от вызывающего кода и отдельно умножает её на SpeedScale. Реальное автоматическое влияние TimeScale здесь сверено по исходникам, не измерено.

public Tween SetLoops(int loops = 0);

Задаёт общее число проходов; 1 — один, 2 — два. Значение по умолчанию при вызове без аргумента равно 0 и включает бесконечное повторение, как и отрицательное значение. Добавьте реальную временную задержку или условие остановки: бесконечные команды нулевой длительности могут вызвать диагностику бесконечного цикла.

public Tween SetParallel(bool parallel = true);

Меняет default-режим группировки следующих добавлений. True добавляет их в один шаг; Chain начинает новый шаг для следующего добавления. False возвращает последовательное добавление. Не выполняет команды одновременно в разных потоках.

public Tween SetPauseMode(Tween.TweenPauseMode mode);

Задаёт реакцию на паузу дерева: Bound ориентируется на привязанную Entity, Stop останавливает продвижение при tree pause, Process допускает его. Это не вызов Pause/Play самого Tween. Bound без привязки не создаёт владельца. Реальные tree-pause переходы здесь только source-reviewed.

public Tween SetProcessMode(Tween.TweenProcessMode mode);

Выбирает Idle или Physics для автоматического продвижения деревом. Physics не делает Tween физической симуляцией и не гарантирует точное время/число отсчётов. Manual CustomStep не ждёт этого callback. Автоматический physics-проход здесь не выполнялся.

public Tween SetSpeedScale(float speed);

Множитель delta и накопленного времени, не новая длительность всех команд. Обычно задавайте положительное конечное значение; 2 проходит время вдвое быстрее. Ноль не продвигает шаги, отрицательное значение не является поддержкой обратного проигрывания. Проверено значение 2 с ручными шагами.

public Tween SetTrans(Tween.TransitionType trans);

Задаёт transition по умолчанию для будущих Property/MethodTweeners. Уже добавленные команды не перенастраиваются автоматически. Для линейной интерполяции используйте Linear; допустимость/качество каждой кривой здесь не оценивались визуально.

public void Stop();

Останавливает и сбрасывает внутренний старт и elapsed time, сохраняя добавленные команды. Не возвращает свойства к исходным значениям и не испускает Finished. При следующем старте PropertyTweener по умолчанию может взять уже изменённое текущее значение. Пока объект валиден, Stop позволяет изменить список перед новым стартом; после очистки дерева используйте новый Tween.

public AwaitTweener TweenAwait(Signal signal);

Добавляет ожидание Signal, не C# Task и не ожидание любого будущего события задним числом. Подключение создаётся при добавлении, а при старте шага received сбрасывается: раннее испускание не гарантирует завершение будущего шага. Сигнал завершается на следующей обработке, а не синхронно заменяет весь Tween. Уничтожение источника/исчезновение соединения также завершает этот Tweener; завершение не доказывает полученный сигнал. Таймаут настраивается у возвращённого AwaitTweener.

public CallbackTweener TweenCallback(Callable callback);

Добавляет Callable без аргументов, который выполняется при достижении шага. Не вызывает его сразу при добавлении. Удерживайте нужные данные/цель; не передавайте результат уже выполненного вызова. Callback не переносится в worker автоматически.

public IntervalTweener TweenInterval(double time);

Добавляет временную паузу внутри последовательности; это не блокирующий sleep главного потока. Время расходуется шагами Tween и зависит от скорости/автоматической time-scale политики. В parallel-группе учитывается вместе с другими участниками.

public MethodTweener TweenMethod(Callable method, Variant from, Variant to, double duration);

Передаёт Callable одно интерполируемое значение от from до to на шагах обработки. Callback должен принимать подходящий тип Variant; это не имя свойства. from/to задают начальное и конечное значения, в отличие от deltaValue у InterpolateValue. Проверен double callback с Linear; неизвестные типы/ошибки вызова не выполнялись.

public PropertyTweener TweenProperty(ReckfellObject @object, EntityPath property, Variant finalVal, double duration);

Добавляет изменение свойства объекта до finalVal. EntityPath здесь путь свойства/компонента, например position:x, а не путь к Entity в дереве. Свойство должно существовать, типы — соответствовать. Начальное значение по умолчанию считывается при старте команды, что важно после Stop или задержки. Привязка жизненного цикла не создаётся автоматически одним указанием target; используйте BindEntity/Entity.CreateTween.

public SubtweenTweener TweenSubtween(Tween subtween);

Встраивает подготовленный Tween в родительскую последовательность и снимает его с независимой обработки деревом. При старте подкоманда сбрасывает subtween через Stop и запускает его; Kill родителя распространяется на потомков. Не используйте одновременно одного subtween в нескольких владельцах и не создавайте циклы. Проверено распространение Kill, точное временное продвижение subtween — только по исходникам.

public event Action Finished;

Сигнал после последнего прохода конечной последовательности. Kill и Stop его не испускают. Бесконечные loops не имеют естественного Finished. Автоматическая очистка дерева делает последовательность невалидной; для новой анимации создайте новый Tween вместо ожидания возможности переиспользовать старый.

public event Tween.LoopFinishedEventHandler LoopFinished;

Выдаётся после завершённого прохода, когда будет ещё один. Финальный проход конечного Tween испускает Finished вместо LoopFinished. loopCount — число уже завершённых проходов, начинается с 1.

public event Tween.StepFinishedEventHandler StepFinished;

Сигнал окончания шага с индексом от 0. Шаг может содержать несколько параллельных Tweeners и заканчивается после всех них. Не означает завершение всего Tween; при loops индексы шагов повторяются.