IUIElementUpdate.cs

Go to the documentation of this file.

// Copyright (c) 2014 Silicon Studio Corp. (http://siliconstudio.co.jp)
// This file is distributed under GPL v3. See LICENSE.md for details.
using SiliconStudio.Core.Mathematics;
using SiliconStudio.Paradox.Games;

namespace SiliconStudio.Paradox.UI
{
    /// <summary>
    /// Interface for the update of the UIElements.
    /// </summary>
    public interface IUIElementUpdate
    {
        /// <summary>
        /// Update the time-based state of the <see cref="UIElement"/>.
        /// </summary>
        /// <param name="time">The current time of the game</param>
        void Update(GameTime time);

        /// <summary>
        /// Recursively update the world matrix of the <see cref="UIElement"/>. 
        /// </summary>
        /// <param name="parentWorldMatrix">The world matrix of the parent.</param>
        /// <param name="parentWorldChanged">Boolean indicating if the world matrix provided by the parent changed</param>
        void UpdateWorldMatrix(ref Matrix parentWorldMatrix, bool parentWorldChanged);

        /// <summary>
        /// Recursively update the <see cref="UIElement.RenderOpacity"/>, <see cref="UIElement.DepthBias"/> and <see cref="UIElement.IsHierarchyEnabled"/> state fields of the <see cref="UIElement"/>. 
        /// </summary>
        /// <param name="elementBias">The depth bias value for the current element computed by the parent</param>
        void UpdateElementState(int elementBias);
        
        /// <summary>
        /// Recursively update the reference to the <see cref="UISystem"/> managing the <see cref="UIElement"/>.
        /// </summary>
        /// <param name="system"></param>
        void UpdateUISystemReference(UISystem system);
    }
}