ViewportCollection.cs :  » Game » RealmForge » Axiom » Collections » C# / CSharp Open Source

#region LGPL License
/*
Axiom Game Engine Library
Copyright (C) 2003  Axiom Project Team

The overall design, and a majority of the core engine and rendering code 
contained within this library is a derivative of the open source Object Oriented 
Graphics Engine OGRE, which can be found at http://ogre.sourceforge.net.  
Many thanks to the OGRE team for maintaining such a high quality project.

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#endregion

using System;
using System.Collections;
using System.Diagnostics;

using Axiom.Core;

// type of the object to be inserted into the collection
using TAxiom.Core.Viewport;
// type of object to be used for the key
using KSystem.Int32;
// type of parent of this collection (if any)
using PAxiom.Graphics.RenderTarget;

namespace Axiom.Collections{
    /// <summary>
    /// Summary description for ViewportCollection.
    /// </summary>
    public class ViewportCollection : AxiomCollection {
        #region Constructors

        /// <summary>
        ///    Default constructor.
        /// </summary>
        public ViewportCollection() : base() {}

        /// <summary>
        ///    Constructor that takes a parent object to, and calls the base class constructor to 
        /// </summary>
        /// <param name="entity"></param>
        public ViewportCollection(P parent) : base(parent) {}

        #endregion

        #region Strongly typed methods and indexers

        /// <summary>
        ///    Get/Set indexer that allows access to the collection by index.
        /// </summary>
        new public T this[int index] {
            get { return (T)base[index]; }
            set { base[index] = value; }
        }

        /// <summary>
        ///    Adds an object to the collection.
        /// </summary>
        /// <param name="item"></param>
        public void Add(T item) {
            Debug.Assert(!objectList.ContainsKey(item.ZOrder), "A viewport with the specified ZOrder " + item.ZOrder + " already exists.");

            // assign this viewport to the parent RenderTarget
            item.Target = (P)parent;

            // add the viewport
            base.Add(item.ZOrder, item);
        }

        /// <summary>
        ///    Adds a named object to the collection.
        /// </summary>
        /// <param name="name"></param>
        /// <param name="item"></param>
        //public void Add(string name, T item)
        //{
        //  base.Add(name, item);
        //}

        #endregion

    }
}