ResourceListener.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Base
File: ResourceListener
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/Buffer.h>
#include "DLLInfo.h"
namespace NDEVR
{
    class ResourceListener;
 
    /**--------------------------------------------------------------------------------------------------
    \brief A base class for templated resources.
    **/
    class NDEVR_BASE_API ResourceBase
    {
    public: 
        ResourceBase();
        explicit ResourceBase(const ResourceBase& value);
        virtual ~ResourceBase();
 
        void removeListener(ResourceListener* listener) const;
        ResourceListener* addListener(ResourceListener* listener) const;
        void addListener(ResourceListener* listener, bool silent_add) const;
        void refreshListeners();
    protected:
        mutable Buffer<ResourceListener*> m_listeners;
    };
 
    /**--------------------------------------------------------------------------------------------------
    \brief A class that can subscribe to any number of Resources which will get updates when 
        the Resource(s) have been modified.
    **/
    class NDEVR_BASE_API ResourceListener
    {
    public:
        ResourceListener();
        virtual ~ResourceListener();
        void changeValue();
        void disconnectListener();
        virtual void addInfoParent(const ResourceBase* info);
        virtual void removeInfoParent(const ResourceBase* info)
        {
            m_parents.removeElement(info);
        }
        uint04 getInfoParentSize() const
        {
            return m_parents.size();
        }
        void disable(bool disable)
        {
            m_is_active = disable;
        }
        virtual void onValueChanged() = 0;
    private:
        Buffer<const ResourceBase*> m_parents;//the info we are listening to.
        bool m_is_active;
    };
};