io.opentimeline.opentimelineio.Transition Maven / Gradle / Ivy

Go to download
// SPDX-License-Identifier: Apache-2.0
// Copyright Contributors to the OpenTimelineIO Project.

package io.opentimeline.opentimelineio;

import io.opentimeline.OTIONative;
import io.opentimeline.opentime.RationalTime;
import io.opentimeline.opentime.TimeRange;

/**
 * Represents a transition between two items.
 */
public class Transition extends Composable {

    /**
     * Encoding types of transitions.
     * This is for representing "Dissolves" and "Wipes" defined by the
     * multi-source effect as defined by SMPTE 258M-2004 7.6.3.2
     * Other effects are handled by the `Effect` class.
     */
    public static class Type {
        public static String SMPTE_Dissolve = "SMPTE_Dissolve";
        public static String Custom = "Custom_Transition";
    }

    protected Transition() {
    }

    Transition(OTIONative otioNative) {
        this.nativeManager = otioNative;
    }

    public Transition(
            String name,
            String transitionType,
            RationalTime inOffset,
            RationalTime outOffset,
            AnyDictionary metadata) {
        this.initObject(
                name,
                transitionType,
                inOffset,
                outOffset,
                metadata);
    }

    public Transition(Transition.TransitionBuilder builder) {
        this.initObject(
                builder.name,
                builder.transitionType,
                builder.inOffset,
                builder.outOffset,
                builder.metadata);
    }

    private void initObject(String name,
                            String transitionType,
                            RationalTime inOffset,
                            RationalTime outOffset,
                            AnyDictionary metadata) {
        this.initialize(
                name,
                transitionType,
                inOffset,
                outOffset,
                metadata);
        this.nativeManager.className = this.getClass().getCanonicalName();
    }

    private native void initialize(String name,
                                   String transitionType,
                                   RationalTime inOffset,
                                   RationalTime outOffset,
                                   AnyDictionary metadata);

    public static class TransitionBuilder {
        private String name = "";
        private String transitionType = "";
        private RationalTime inOffset = new RationalTime();
        private RationalTime outOffset = new RationalTime();
        private AnyDictionary metadata = new AnyDictionary();

        public TransitionBuilder() {
        }

        public Transition.TransitionBuilder setName(String name) {
            this.name = name;
            return this;
        }

        public Transition.TransitionBuilder setTransitionType(String transitionType) {
            this.transitionType = transitionType;
            return this;
        }

        public Transition.TransitionBuilder setInOffset(RationalTime inOffset) {
            this.inOffset = inOffset;
            return this;
        }

        public Transition.TransitionBuilder setOutOffset(RationalTime outOffset) {
            this.outOffset = outOffset;
            return this;
        }

        public Transition.TransitionBuilder setMetadata(AnyDictionary metadata) {
            this.metadata = metadata;
            return this;
        }

        public Transition build() {
            return new Transition(this);
        }
    }

    public native boolean isOverlapping();

    public native String getTransitionType();

    public native void setTransitionType(String transitionType);

    /**
     * Get amount of the previous clip this transition overlaps, exclusive.
     *
     * @return amount of the previous clip this transition overlaps, exclusive.
     */
    public native RationalTime getInOffset();

    /**
     * Set amount of the previous clip this transition overlaps, exclusive.
     *
     * @param inOffset amount of the previous clip this transition overlaps, exclusive.
     */
    public native void setInOffset(RationalTime inOffset);

    /**
     * Get amount of the next clip this transition overlaps, exclusive.
     *
     * @return amount of the next clip this transition overlaps, exclusive.
     */
    public native RationalTime getOutOffset();

    /**
     * Set amount of the next clip this transition overlaps, exclusive.
     *
     * @param outOffset amount of the next clip this transition overlaps, exclusive.
     */
    public native void setOutOffset(RationalTime outOffset);

    public native RationalTime getDuration(ErrorStatus errorStatus);

    /**
     * Find and return the range of this item in the parent.
     *
     * @param errorStatus errorStatus to report error while fetching range
     * @return the range of this item in the parent
     */
    public native TimeRange getRangeInParent(ErrorStatus errorStatus);

    /**
     * Find and return the trimmed range of this item in the parent.
     *
     * @param errorStatus errorStatus to report error while fetching trimmed range
     * @return the trimmed range of this item in the parent.
     */
    public native TimeRange getTrimmedRangeInParent(ErrorStatus errorStatus);

    @Override
    public String toString() {
        return this.getClass().getCanonicalName() +
                "(" +
                "name=" + this.getName() +
                ", transitionType=" + this.getTransitionType() +
                ", inOffset=" + this.getInOffset().toString() +
                ", outOffset=" + this.getOutOffset().toString() +
                ", metadata=" + this.getMetadata().toString() +
                ")";
    }
}