aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Scripting/Tango.Scripting.Editors/CachedUsing.cs
diff options
context:
space:
mode:
authorMirta <mirta@twine-s.com>2020-11-04 13:43:05 +0200
committerMirta <mirta@twine-s.com>2020-11-04 13:43:05 +0200
commit71e6a2bcd4082c6c85eeeb6cd3048b12ed149500 (patch)
tree3d554f5b87d3897496454be22cbc9c8c4f977f2a /Software/Visual_Studio/Scripting/Tango.Scripting.Editors/CachedUsing.cs
parentc2098e8720e2cf3cda17831b76fbb82147950a32 (diff)
downloadTango-71e6a2bcd4082c6c85eeeb6cd3048b12ed149500.tar.gz
Tango-71e6a2bcd4082c6c85eeeb6cd3048b12ed149500.zip
Low Volume threshold implementation on both single colors and gradients
Diffstat (limited to 'Software/Visual_Studio/Scripting/Tango.Scripting.Editors/CachedUsing.cs')
0 files changed, 0 insertions, 0 deletions
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows;
using System.Windows.Media.Imaging;
using Tango.Core;
using Tango.BL.Entities;
using Tango.BL.Enumerations;

namespace Tango.MachineStudio.Common
{
    /// <summary>
    /// Represents a base class for studio modules.
    /// </summary>
    /// <seealso cref="Tango.MachineStudio.Common.IStudioModule" />
    public abstract class StudioModuleBase : ExtendedObject, IStudioModule
    {
        private bool _isInitialized;
        private bool _isLoaded;

        /// <summary>
        /// Occurs when the user has navigated into or out of this module.
        /// </summary>
        public event EventHandler<bool> IsLoadedChanged;

        /// <summary>
        /// Gets the module name.
        /// </summary>
        public abstract string Name { get; }

        /// <summary>
        /// Gets the module description.
        /// </summary>
        public abstract string Description { get; }

        /// <summary>
        /// Gets the module cover image.
        /// </summary>
        public abstract BitmapSource Image { get; }

        /// <summary>
        /// Gets the module entry point view type.
        /// </summary>
        public abstract Type MainViewType { get; }

        /// <summary>
        /// Gets the permission required to see and load this module.
        /// </summary>
        public abstract Permissions Permission { get; }

        /// <summary>
        /// Gets a value indicating whether this module has been initialized.
        /// </summary>
        public bool IsInitialized
        {
            get
            {
                return _isInitialized;
            }
            private set
            {
                _isInitialized = value;
            }
        }

        /// <summary>
        /// Sets a value indicating whether this module is loaded.
        /// </summary>
        public bool IsLoaded
        {
            get
            {
                return _isLoaded;
            }
            set
            {
                _isLoaded = value;
                IsLoadedChanged?.Invoke(this, value);
            }
        }

        private bool _inNewWindow;
        /// <summary>
        /// Gets or sets a value indicating whether this module is shown under a new window.
        /// </summary>
        public bool InNewWindow
        {
            get { return _inNewWindow; }
            set { _inNewWindow = value; RaisePropertyChangedAuto(); }
        }

        /// <summary>
        /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
        /// </summary>
        public abstract void Dispose();

        /// <summary>
        /// Perform any operations required to initialize this module.
        /// </summary>
        public void Initialize()
        {
            OnInitialized();
            IsInitialized = true;
        }

        /// <summary>
        /// Called when machine studio initializes this module.
        /// </summary>
        protected virtual void OnInitialized()
        {

        }

        /// <summary>
        /// Raises the <see cref="IsLoadedChanged"/> event.
        /// </summary>
        /// <param name="loaded">if set to <c>true</c> the module is loaded.</param>
        protected virtual void OnLoadedChanged(bool loaded)
        {

        }
    }
}