Interface IToolPlugInService

Provides access to the various tool plugins in the application.

Inherited Members
Namespace: Gorgon.Editor.Services
Assembly: Gorgon.Editor.API.dll
Syntax
public interface IToolPlugInService : IDisabledPlugInService

Properties

| Edit this page View Source

PlugIns

Property to return the list of tool plugins loaded in to the application.

Declaration
IReadOnlyDictionary<string, ToolPlugIn> PlugIns { get; }
Property Value
Type Description
IReadOnlyDictionary<string, ToolPlugIn>
| Edit this page View Source

RibbonButtons

Property to return the UI buttons for the tool plug in.

Declaration
IReadOnlyDictionary<string, IReadOnlyList<IToolPlugInRibbonButton>> RibbonButtons { get; }
Property Value
Type Description
IReadOnlyDictionary<string, IReadOnlyList<IToolPlugInRibbonButton>>

Methods

| Edit this page View Source

ProjectActivated(IContentFileManager, IGorgonFileSystemWriter<Stream>)

Function called when a project is loaded/created.

Declaration
void ProjectActivated(IContentFileManager fileManager, IGorgonFileSystemWriter<Stream> temporaryFileSystem)
Parameters
Type Name Description
IContentFileManager fileManager

The content file manager for the project.
IGorgonFileSystemWriter<Stream> temporaryFileSystem

The file system used to hold temporary working data.
| Edit this page View Source

ProjectDeactivated()

Function called when a project is unloaded.

Declaration
void ProjectDeactivated()
| Edit this page View Source

ReadContentSettings<T>(string, params JsonConverter[])

Funcion to read the settings for a content plug in from a JSON file.

Declaration
T ReadContentSettings<T>(string name, params JsonConverter[] converters) where T : class
Parameters
Type Name Description
string name

The name of the file.
JsonConverter[] converters

A list of JSON data converters.
Returns
Type Description
T

The settings object for the plug in, or null if no settings file was found for the plug in.
Type Parameters
Name Description
T

The type of settings to read. Must be a reference type.
Remarks

This will read in the settings for a content plug from the same location where the editor stores its application settings file.

| Edit this page View Source

WriteContentSettings<T>(string, T, params JsonConverter[])

Function to write out the settings for a content plug in as a JSON file.

Declaration
void WriteContentSettings<T>(string name, T contentSettings, params JsonConverter[] converters) where T : class
Parameters
Type Name Description
string name

The name of the file.
T contentSettings

The content settings to persist as JSON file.
JsonConverter[] converters

A list of JSON converters.
Type Parameters
Name Description
T

The type of settings to write. Must be a reference type.
Remarks

This will write out the settings for a content plug in to the same location where the editor stores its application settings file.

Extension Methods