SequenceData.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 "respec/Specification.h"
#include "sequence/AnimateableProperty.h"
#include "devices/I3DDevice.h"
#include "util/ILockable.h"

#include <list>
#include <memory>
#include <mutex>

AUD_NAMESPACE_BEGIN

class SequenceEntry;
class ISound;

class AUD_API SequenceData : public ILockable
{
    friend class SequenceReader;
private:
    Specs m_specs;

    int m_status;

    int m_entry_status;

    int m_id;

    std::list<std::shared_ptr<SequenceEntry> > m_entries;

    bool m_muted;

    float m_fps;

    float m_speed_of_sound;

    float m_doppler_factor;

    DistanceModel m_distance_model;

    AnimateableProperty m_volume;

    AnimateableProperty m_location;

    AnimateableProperty m_orientation;

    std::recursive_mutex m_mutex;

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

public:
    SequenceData(Specs specs, float fps, bool muted);
    virtual ~SequenceData();

    virtual void lock();

    virtual void unlock();

    Specs getSpecs();

    void setSpecs(Specs specs);

    float getFPS() const;

    void setFPS(float fps);

    void mute(bool muted);

    bool isMuted() const;

    float getSpeedOfSound() const;

    void setSpeedOfSound(float speed);

    float getDopplerFactor() const;

    void setDopplerFactor(float factor);

    DistanceModel getDistanceModel() const;

    void setDistanceModel(DistanceModel model);

    AnimateableProperty* getAnimProperty(AnimateablePropertyType type);

    std::shared_ptr<SequenceEntry> add(std::shared_ptr<ISound> sound, float begin, float end, float skip);

    void remove(std::shared_ptr<SequenceEntry> entry);
};

AUD_NAMESPACE_END