SequenceEntry.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright 2009-2015 Jörg Müller
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/

#pragma once

#include "sequence/AnimateableProperty.h"
#include "util/ILockable.h"

#include <mutex>
#include <memory>

AUD_NAMESPACE_BEGIN

class ISound;

class AUD_API SequenceEntry : public ILockable
{
    friend class SequenceHandle;
private:
    int m_status;

    int m_pos_status;

    int m_sound_status;

    int m_id;

    std::shared_ptr<ISound> m_sound;

    float m_begin;

    float m_end;

    float m_skip;

    bool m_muted;

    bool m_relative;

    float m_volume_max;

    float m_volume_min;

    float m_distance_max;

    float m_distance_reference;

    float m_attenuation;

    float m_cone_angle_outer;

    float m_cone_angle_inner;

    float m_cone_volume_outer;

    std::recursive_mutex m_mutex;

    AnimateableProperty m_volume;

    AnimateableProperty m_panning;

    AnimateableProperty m_pitch;

    AnimateableProperty m_location;

    AnimateableProperty m_orientation;

    // delete copy constructor and operator=
    SequenceEntry(const SequenceEntry&) = delete;
    SequenceEntry& operator=(const SequenceEntry&) = delete;

public:
    SequenceEntry(std::shared_ptr<ISound> sound, float begin, float end, float skip, int id);
    virtual ~SequenceEntry();

    virtual void lock();

    virtual void unlock();

    std::shared_ptr<ISound> getSound();

    void setSound(std::shared_ptr<ISound> sound);

    void move(float begin, float end, float skip);

    bool isMuted();

    void mute(bool mute);

    int getID() const;

    AnimateableProperty* getAnimProperty(AnimateablePropertyType type);

    bool isRelative();

    void setRelative(bool relative);

    float getVolumeMaximum();

    void setVolumeMaximum(float volume);

    float getVolumeMinimum();

    void setVolumeMinimum(float volume);

    float getDistanceMaximum();

    void setDistanceMaximum(float distance);

    float getDistanceReference();

    void setDistanceReference(float distance);

    float getAttenuation();

    void setAttenuation(float factor);

    float getConeAngleOuter();

    void setConeAngleOuter(float angle);

    float getConeAngleInner();

    void setConeAngleInner(float angle);

    float getConeVolumeOuter();

    void setConeVolumeOuter(float volume);
};

AUD_NAMESPACE_END