/*
 * This file is part of the Illarion project.
 *
 * Copyright © 2014 - Illarion e.V.
 *
 * Illarion is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Illarion is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */
package org.illarion.engine.backend.gdx;

import org.illarion.engine.sound.Sound;

import javax.annotation.Nonnull;

/**
 * This is the wrapper class for a libGDX sound so it can be used properly by the game engine.
 *
 * @author Martin Karing <nitram@illarion.org>
 */
class GdxSound implements Sound {
    /**
     * The sound instance that is wrapped by this class.
     */
    @Nonnull
    private final com.badlogic.gdx.audio.Sound wrappedSound;

    @Nonnull
    private final String ref;

    /**
     * Create a new sound effect wrapper.
     *
     * @param wrappedSound the sound that is wrapped
     */
    GdxSound(@Nonnull String ref, @Nonnull com.badlogic.gdx.audio.Sound wrappedSound) {
        this.ref = ref;
        this.wrappedSound = wrappedSound;
    }

    @Override
    public void dispose() {
        wrappedSound.dispose();
    }

    /**
     * Get the internal sound that is wrapped by this class.
     *
     * @return the internal sound
     */
    @Nonnull
    public com.badlogic.gdx.audio.Sound getWrappedSound() {
        return wrappedSound;
    }

    @Nonnull
    @Override
    public String toString() {
        return "GDX Sound: " + ref;
    }
}