// Copyright (C) Stichting Deltares 2023. All rights reserved.
// 
// This file is part of the Dam Engine.
// 
// The Dam Engine is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program 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 Affero General Public License for more details.
// 
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
// 
// All names, logos, and references to "Deltares" are registered trademarks of
// Stichting Deltares and remain full property of Stichting Deltares at all times.
// All rights reserved.

using System;
using Deltares.DamEngine.Data.Standard;

namespace Deltares.DamEngine.Data.Geometry;

/// <summary>
/// Base class for all Geometry objects
/// </summary>
[Serializable]
public abstract class GeometryObject : IGeometryObject, IName
{
    private string name = "";

    #region IGeometryObject Members

    /// <summary>
    /// Gets or sets the name.
    /// </summary>
    /// <value>
    /// The name.
    /// </value>
    public virtual string Name
    {
        get
        {
            return name;
        }
        set
        {
            name = value;
        }
    }

    #endregion

    /// <summary>
    /// Sets the name.
    /// </summary>
    /// <param name="newName">The new name.</param>
    public virtual void SetName(string newName)
    {
        name = newName; // TODO: Name is virtual. Is this really expected behavior?
    }

    /// <summary>
    /// Gets the geometry bounds.
    /// </summary>
    /// <returns></returns>
    public virtual GeometryBounds GetGeometryBounds()
    {
        return null;
    }

    /// <summary>
    /// Returns a <see cref="System.String" /> that represents this instance.
    /// </summary>
    /// <returns>
    /// A <see cref="System.String" /> that represents this instance.
    /// </returns>
    public override string ToString()
    {
        return Name;
    }
}