Interface IProject

The project data used by the editor.

Inherited Members
Namespace: Gorgon.Editor.ProjectData
Assembly: Gorgon.Editor.API.dll
Syntax
public interface IProject : IProjectMetadata

Properties

| Edit this page View Source

FileSystemDirectory

Property to return the directory that houses the file system for the project files.

Declaration
[JsonIgnore]
DirectoryInfo FileSystemDirectory { get; }
Property Value
Type Description
DirectoryInfo
Remarks

This directory contains all the files and directories imported by the user into the project.

Files/directories added, or deleted from this via the operating system (e.g. windows explorer), are not tracked and may cause issues. Do not manipulate the data in this directory outside of the application.

| Edit this page View Source

ProjectWorkSpace

Property to return the workspace used by the project.

Declaration
[JsonIgnore]
DirectoryInfo ProjectWorkSpace { get; }
Property Value
Type Description
DirectoryInfo
Remarks

A project work space is a folder on the local file system that contains a copy of the project content. This is the location of data required for the project, but should not be part of the file system.

| Edit this page View Source

SourceDirectory

Property to return the directory for original files that may have been converted during the import process.

Declaration
[JsonIgnore]
DirectoryInfo SourceDirectory { get; }
Property Value
Type Description
DirectoryInfo
| Edit this page View Source

TempDirectory

Property to return the temporary directory for the project.

Declaration
[JsonIgnore]
DirectoryInfo TempDirectory { get; }
Property Value
Type Description
DirectoryInfo
Remarks

The temporary directory is for plug ins and the editor to store transitory data that only needs to exist during the lifetime of the application or plug in. Nothing in this directory is saved into the project.

Extension Methods