MonoGame.Extended/Source/MonoGame.Extended.Entities/PoolableComponent.cs

// Original code dervied from:
// https://github.com/thelinuxlich/artemis_CSharp/blob/master/Artemis_XNA_INDEPENDENT/ComponentPoolable.cs

// --------------------------------------------------------------------------------------------------------------------
// <copyright file="ComponentPoolable.cs" company="GAMADU.COM">
//     Copyright © 2013 GAMADU.COM. Contains rights reserved.
//
//     Redistribution and use in source and binary forms, with or without modification, are
//     permitted provided that the following conditions are met:
//
//        1. Redistributions of source code must retain the above copyright notice, this list of
//           conditions and the following disclaimer.
//
//        2. Redistributions in binary form must reproduce the above copyright notice, this list
//           of conditions and the following disclaimer in the documentation and/or other materials
//           provided with the distribution.
//
//     THIS SOFTWARE IS PROVIDED BY GAMADU.COM 'AS IS' AND ANY EXPRESS OR IMPLIED
//     WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
//     FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GAMADU.COM OR
//     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//     CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
//     ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
//     NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
//     ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//     The views and conclusions contained in the software and documentation are those of the
//     authors and should not be interpreted as representing official policies, either expressed
//     or implied, of GAMADU.COM.
// </copyright>
// <summary>
//   Class ComponentPool-able.
// </summary>
// --------------------------------------------------------------------------------------------------------------------

using MonoGame.Extended.Collections;

namespace MonoGame.Extended.Entities
{
    public abstract class PoolableComponent : IPoolable
    {
        private ReturnToPoolDelegate _returnToPool;
        IPoolable IPoolable.NextNode { get; set; }
        IPoolable IPoolable.PreviousNode { get; set; }

        protected PoolableComponent()
        {
        }

        public virtual void Reset()
        {
        }

        void IPoolable.Initialize(ReturnToPoolDelegate returnDelegate)
        {
            _returnToPool = returnDelegate;
            Reset();
        }

        void IPoolable.Return()
        {
            Return();
        }

        internal void Return()
        {
            Reset();

            if (_returnToPool == null)
                return;

            _returnToPool.Invoke(this);
            _returnToPool = null;
        }
    }
}