Artemis logo
Search Results for

    Show / Hide Table of Contents

    Class PluginFeature

    Represents an feature of a certain type provided by a plugin

    Inheritance
    System.Object
    CorePropertyChanged
    PluginFeature
    DeviceProvider
    LayerBrushProvider
    LayerEffectProvider
    Module
    ScriptingProvider
    Implements
    System.IDisposable
    Inherited Members
    CorePropertyChanged.PropertyChanged
    CorePropertyChanged.RequiresUpdate<T>(T, T)
    CorePropertyChanged.SetAndNotify<T>(T, T, String)
    CorePropertyChanged.OnPropertyChanged(String)
    Namespace: Artemis.Core
    Assembly: Artemis.Core.dll
    Syntax
    public abstract class PluginFeature : CorePropertyChanged, INotifyPropertyChanged, IDisposable

    Properties

    | Improve this Doc View Source

    Id

    Gets the identifier of this plugin feature

    Declaration
    public string Id { get; }
    Property Value
    Type Description
    System.String
    | Improve this Doc View Source

    Info

    Gets the plugin feature info related to this feature

    Declaration
    public PluginFeatureInfo Info { get; }
    Property Value
    Type Description
    PluginFeatureInfo
    | Improve this Doc View Source

    IsEnabled

    Gets whether the plugin is enabled

    Declaration
    public bool IsEnabled { get; }
    Property Value
    Type Description
    System.Boolean
    | Improve this Doc View Source

    Plugin

    Gets the plugin that provides this feature

    Declaration
    public Plugin Plugin { get; }
    Property Value
    Type Description
    Plugin
    | Improve this Doc View Source

    Profiler

    Gets the profiler that can be used to take profiling measurements

    Declaration
    public Profiler Profiler { get; }
    Property Value
    Type Description
    Profiler

    Methods

    | Improve this Doc View Source

    AddTimedUpdate(TimeSpan, Action<Double>, String)

    Registers a timed update that whenever the plugin is enabled calls the provided action at the provided interval

    Declaration
    public TimedUpdateRegistration AddTimedUpdate(TimeSpan interval, Action<double> action, string name = null)
    Parameters
    Type Name Description
    System.TimeSpan interval

    The interval at which the update should occur

    System.Action<System.Double> action

    The action to call every time the interval has passed. The delta time parameter represents the time passed since the last update in seconds

    System.String name

    An optional name used in exceptions and profiling

    Returns
    Type Description
    TimedUpdateRegistration

    The resulting plugin update registration which can be used to stop the update

    | Improve this Doc View Source

    AddTimedUpdate(TimeSpan, Func<Double, Task>, String)

    Registers a timed update that whenever the plugin is enabled calls the provided asyncAction at the provided interval

    Declaration
    public TimedUpdateRegistration AddTimedUpdate(TimeSpan interval, Func<double, Task> asyncAction, string name = null)
    Parameters
    Type Name Description
    System.TimeSpan interval

    The interval at which the update should occur

    System.Func<System.Double, System.Threading.Tasks.Task> asyncAction

    The async action to call every time the interval has passed. The delta time parameter represents the time passed since the last update in seconds

    System.String name

    An optional name used in exceptions and profiling

    Returns
    Type Description
    TimedUpdateRegistration

    The resulting plugin update registration

    | Improve this Doc View Source

    Disable()

    Called when the feature is deactivated or when Artemis shuts down

    Declaration
    public abstract void Disable()
    | Improve this Doc View Source

    Dispose()

    Declaration
    public void Dispose()
    | Improve this Doc View Source

    Dispose(Boolean)

    Releases the unmanaged resources used by the plugin feature and optionally releases the managed resources.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    true to release both managed and unmanaged resources; false to release only unmanaged resources.

    | Improve this Doc View Source

    Enable()

    Called when the feature is activated

    Declaration
    public abstract void Enable()
    | Improve this Doc View Source

    OnDisabled()

    Triggers the Disabled event

    Declaration
    protected virtual void OnDisabled()
    | Improve this Doc View Source

    OnEnabled()

    Triggers the Enabled event

    Declaration
    protected virtual void OnEnabled()

    Events

    | Improve this Doc View Source

    Disabled

    Occurs when the feature is disabled

    Declaration
    public event EventHandler Disabled
    Event Type
    Type Description
    System.EventHandler
    | Improve this Doc View Source

    Enabled

    Occurs when the feature is enabled

    Declaration
    public event EventHandler Enabled
    Event Type
    Type Description
    System.EventHandler

    Implements

    System.IDisposable
    • Improve this Doc
    • View Source
    In This Article
    Back to top Generated by DocFX