Quantum.Editor.QuantumCodeGenSettings Class Reference

Settings for the Quantum code generation. Extend this class with a partial implementation to customize the settings. More...

Static Public Attributes
const string	DefaultCodeGenQtnFolderPath = "Assets/QuantumUser/Simulation/Generated"
	The default folder path for the Simulation generated code. More...
const string	DefaultCodeGenUnityRuntimeFolderPath = "Assets/QuantumUser/View/Generated"
	The default folder path for the Unity runtime generated code. More...
static GeneratorOptions	DefaultOptions
	The default code generation options. If More...

Properties
static string	CodeGenQtnFolderPath [get]
	Returns the folder path for the Simulation generated code. Uses DefaultCodeGenQtnFolderPath and calls GetCodeGenFolderPathUser to customize the path. More...
static string	CodeGenUnityRuntimeFolderPath [get]
	Returns the folder path for the Unity runtime generated code. Uses DefaultCodeGenUnityRuntimeFolderPath and calls GetCodeGenUnityRuntimeFolderPathUser to customize the path. More...
static GeneratorOptions	Options [get]
	Creates a new instance of GeneratorOptions with the default options. Uses DefaultOptions and calls GetOptionsUser to customize the options. More...

Detailed Description

Settings for the Quantum code generation. Extend this class with a partial implementation to customize the settings.

Member Data Documentation

DefaultCodeGenQtnFolderPath

const string Quantum.Editor.QuantumCodeGenSettings.DefaultCodeGenQtnFolderPath = "Assets/QuantumUser/Simulation/Generated"

static

The default folder path for the Simulation generated code.

DefaultCodeGenUnityRuntimeFolderPath

const string Quantum.Editor.QuantumCodeGenSettings.DefaultCodeGenUnityRuntimeFolderPath = "Assets/QuantumUser/View/Generated"

static

The default folder path for the Unity runtime generated code.

DefaultOptions

GeneratorOptions Quantum.Editor.QuantumCodeGenSettings.DefaultOptions

static

Initial value:

=> new() {
      LegacyCodeGenOptions = 
        (IsMigrationEnabled ? GeneratorLegacyOptions.DefaultMigrationFlags : default) |
        (IsQuantum3PreviewMigrationEnabled ? GeneratorLegacyOptions.BuiltInComponentPrototypeWrappers : default),
    }

The default code generation options. If

QUANTUM_ENABLE_MIGRATION is defined, GeneratorLegacyOptions.DefaultMigrationFlags are used for GeneratorOptions.LegacyCodeGenOptions.

Property Documentation

Options

GeneratorOptions Quantum.Editor.QuantumCodeGenSettings.Options

staticget

Creates a new instance of GeneratorOptions with the default options. Uses DefaultOptions and calls GetOptionsUser to customize the options.

CodeGenQtnFolderPath

string Quantum.Editor.QuantumCodeGenSettings.CodeGenQtnFolderPath

staticget

Returns the folder path for the Simulation generated code. Uses DefaultCodeGenQtnFolderPath and calls GetCodeGenFolderPathUser to customize the path.

CodeGenUnityRuntimeFolderPath

string Quantum.Editor.QuantumCodeGenSettings.CodeGenUnityRuntimeFolderPath

staticget

Returns the folder path for the Unity runtime generated code. Uses DefaultCodeGenUnityRuntimeFolderPath and calls GetCodeGenUnityRuntimeFolderPathUser to customize the path.