AnimateableProperty.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright 2009-2016 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 "util/Buffer.h"
#include "util/ILockable.h"

#include <mutex>
#include <list>

AUD_NAMESPACE_BEGIN

enum AnimateablePropertyType
{
    AP_VOLUME,
    AP_PANNING,
    AP_PITCH,
    AP_LOCATION,
    AP_ORIENTATION,
    AP_TIME_STRETCH,
    AP_PITCH_SCALE
};

class AUD_API AnimateableProperty : private Buffer
{
private:
    struct Unknown {
        int start;
        int end;

        Unknown(int start, int end) :
            start(start), end(end) {}
    };

    const int m_count;

    bool m_isAnimated;

    std::recursive_mutex m_mutex;

    std::list<Unknown> m_unknown;

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

    void AUD_LOCAL updateUnknownCache(int start, int end);

public:
    AnimateableProperty(int count = 1);

    AnimateableProperty(int count, float value);

    ~AnimateableProperty();

    int getCount() const;

    void write(const float* data);

    void write(const float* data, int position, int count);

    void writeConstantRange(const float* data, int position_start, int position_end);

    void read(float position, float* out);

    float readSingle(float position);

    bool isAnimated() const;

    const Buffer& getBuffer();
};

AUD_NAMESPACE_END