CoreInterface

---

Inheritance

• object
• Interface
• CoreInterface

---

Inherited Members

• Equals(object)
• Equals(object, object)
• GetHashCode()
• GetType()
• MemberwiseClone()
• ReferenceEquals(object, object)
• ToString()

---

Namespace: UnityEngine.Pixyz.Core

public class CoreInterface : Interface

Fields

Epsilon

public const double Epsilon = 1E-06

Returns

EpsilonSquare

public const double EpsilonSquare = 1E-12

Returns

HalfPi

public const double HalfPi = 1.5707963267948966

Returns

Infinity

public const double Infinity = 1000000000000

Returns

OneDegree

public const double OneDegree = 0.017453292519943295

Returns

Pi

public const double Pi = 3.141592653589793

Returns

TwoPi

public const double TwoPi = 6.283185307179586

Returns

Methods

GetLastError

public static string GetLastError()

Returns

CloneEntity

Clone an entity.

[HandleProcessCorruptedStateExceptions]public uint CloneEntity(uint entity)

Parameters Returns

ConfigureFunctionLogger

[HandleProcessCorruptedStateExceptions]public void ConfigureFunctionLogger(string functionName, bool enableFunction, bool enableParameters, bool enableExecutionTime)

Parameters

CreateEntity

Create an entity.

[HandleProcessCorruptedStateExceptions]public uint CreateEntity(uint type)

Parameters Returns

DeleteEntities

Delete a set of entities.

[HandleProcessCorruptedStateExceptions]public void DeleteEntities(EntityList entities)

Parameters

GetEntitiesByType

Get all entities of a given type.

[HandleProcessCorruptedStateExceptions]public EntityList GetEntitiesByType(uint type, bool includeUnsubscribed)

Parameters Returns

GetRemainingSecondsBeforeLicenseTimeout

Get the seconds left before the app force-closes after the license server is disconnected.

[HandleProcessCorruptedStateExceptions]public double GetRemainingSecondsBeforeLicenseTimeout()

Returns

ResetSession

Clear all the current session (all unsaved work will be lost).

[HandleProcessCorruptedStateExceptions]public void ResetSession()

UnsavedUserChanges

Returns true if the user has made changes to the project.

[HandleProcessCorruptedStateExceptions]public bool UnsavedUserChanges()

Returns

AddAfterEntityPropertyChangedCallback

public uint AddAfterEntityPropertyChangedCallback(CoreInterface.AfterEntityPropertyChangedDelegate callback, IntPtr userData)

Parameters Returns

RemoveAfterEntityPropertyChangedCallback

public void RemoveAfterEntityPropertyChangedCallback(uint id)

Parameters

AddAfterModulePropertyChangedCallback

public uint AddAfterModulePropertyChangedCallback(CoreInterface.AfterModulePropertyChangedDelegate callback, IntPtr userData)

Parameters Returns

RemoveAfterModulePropertyChangedCallback

public void RemoveAfterModulePropertyChangedCallback(uint id)

Parameters

AddAfterUndoRedoCallback

public uint AddAfterUndoRedoCallback(CoreInterface.AfterUndoRedoDelegate callback, IntPtr userData)

Parameters Returns

RemoveAfterUndoRedoCallback

public void RemoveAfterUndoRedoCallback(uint id)

Parameters

AddAtExitCallback

public uint AddAtExitCallback(CoreInterface.AtExitDelegate callback, IntPtr userData)

Parameters Returns

RemoveAtExitCallback

public void RemoveAtExitCallback(uint id)

Parameters

AddBeforeEntityPropertyChangedCallback

public uint AddBeforeEntityPropertyChangedCallback(CoreInterface.BeforeEntityPropertyChangedDelegate callback, IntPtr userData)

Parameters Returns

RemoveBeforeEntityPropertyChangedCallback

public void RemoveBeforeEntityPropertyChangedCallback(uint id)

Parameters

AddBeforeModulePropertyChangedCallback

public uint AddBeforeModulePropertyChangedCallback(CoreInterface.BeforeModulePropertyChangedDelegate callback, IntPtr userData)

Parameters Returns

RemoveBeforeModulePropertyChangedCallback

public void RemoveBeforeModulePropertyChangedCallback(uint id)

Parameters

AddBeforeSessionResetCallback

public uint AddBeforeSessionResetCallback(CoreInterface.BeforeSessionResetDelegate callback, IntPtr userData)

Parameters Returns

RemoveBeforeSessionResetCallback

public void RemoveBeforeSessionResetCallback(uint id)

Parameters

AddBeforeUndoRedoCallback

public uint AddBeforeUndoRedoCallback(CoreInterface.BeforeUndoRedoDelegate callback, IntPtr userData)

Parameters Returns

RemoveBeforeUndoRedoCallback

public void RemoveBeforeUndoRedoCallback(uint id)

Parameters

AddCurrentFileChangedCallback

public uint AddCurrentFileChangedCallback(CoreInterface.CurrentFileChangedDelegate callback, IntPtr userData)

Parameters Returns

RemoveCurrentFileChangedCallback

public void RemoveCurrentFileChangedCallback(uint id)

Parameters

AddEnteringUnsafeModeCallback

public uint AddEnteringUnsafeModeCallback(CoreInterface.EnteringUnsafeModeDelegate callback, IntPtr userData)

Parameters Returns

RemoveEnteringUnsafeModeCallback

public void RemoveEnteringUnsafeModeCallback(uint id)

Parameters

AddEntityDestroyedCallback

public uint AddEntityDestroyedCallback(CoreInterface.EntityDestroyedDelegate callback, IntPtr userData)

Parameters Returns

RemoveEntityDestroyedCallback

public void RemoveEntityDestroyedCallback(uint id)

Parameters

AddLeavingUnsafeModeCallback

public uint AddLeavingUnsafeModeCallback(CoreInterface.LeavingUnsafeModeDelegate callback, IntPtr userData)

Parameters Returns

RemoveLeavingUnsafeModeCallback

public void RemoveLeavingUnsafeModeCallback(uint id)

Parameters

AddLicenseClientDisconnectedCallback

public uint AddLicenseClientDisconnectedCallback(CoreInterface.LicenseClientDisconnectedDelegate callback, IntPtr userData)

Parameters Returns

RemoveLicenseClientDisconnectedCallback

public void RemoveLicenseClientDisconnectedCallback(uint id)

Parameters

AddLicenseClientReconnectedCallback

public uint AddLicenseClientReconnectedCallback(CoreInterface.LicenseClientReconnectedDelegate callback, IntPtr userData)

Parameters Returns

RemoveLicenseClientReconnectedCallback

public void RemoveLicenseClientReconnectedCallback(uint id)

Parameters

AddOnConsoleMessageCallback

public uint AddOnConsoleMessageCallback(CoreInterface.OnConsoleMessageDelegate callback, IntPtr userData)

Parameters Returns

RemoveOnConsoleMessageCallback

public void RemoveOnConsoleMessageCallback(uint id)

Parameters

AddOnSessionResetCallback

public uint AddOnSessionResetCallback(CoreInterface.OnSessionResetDelegate callback, IntPtr userData)

Parameters Returns

RemoveOnSessionResetCallback

public void RemoveOnSessionResetCallback(uint id)

Parameters

AddProgressChangedCallback

public uint AddProgressChangedCallback(CoreInterface.ProgressChangedDelegate callback, IntPtr userData)

Parameters Returns

RemoveProgressChangedCallback

public void RemoveProgressChangedCallback(uint id)

Parameters

AddProgressStepFinishedCallback

public uint AddProgressStepFinishedCallback(CoreInterface.ProgressStepFinishedDelegate callback, IntPtr userData)

Parameters Returns

RemoveProgressStepFinishedCallback

public void RemoveProgressStepFinishedCallback(uint id)

Parameters

AddProgressStepStartCallback

public uint AddProgressStepStartCallback(CoreInterface.ProgressStepStartDelegate callback, IntPtr userData)

Parameters Returns

RemoveProgressStepStartCallback

public void RemoveProgressStepStartCallback(uint id)

Parameters

AddDebugEventCallback

public uint AddDebugEventCallback(CoreInterface.DebugEventDelegate callback, IntPtr userData)

Parameters Returns

RemoveDebugEventCallback

public void RemoveDebugEventCallback(uint id)

Parameters

GetEvent

Get EventDesc of an event.

[HandleProcessCorruptedStateExceptions]public EventDesc GetEvent(string moduleName, string eventName)

Parameters Returns

GetEvents

Get events of a group.

[HandleProcessCorruptedStateExceptions]public EventDescList GetEvents(string moduleName, string groupName)

Parameters Returns

GetFunction

Get FunctionDesc of a function.

[HandleProcessCorruptedStateExceptions]public FunctionDesc GetFunction(string moduleName, string functionName)

Parameters Returns

GetFunctions

Get functions of a group.

[HandleProcessCorruptedStateExceptions]public FunctionDescList GetFunctions(string moduleName, string groupName)

Parameters Returns

GetGroup

Get a group desc from a specific module.

[HandleProcessCorruptedStateExceptions]public GroupDesc GetGroup(string moduleName, string groupName)

Parameters Returns

GetGroups

Get all group desc of a module.

[HandleProcessCorruptedStateExceptions]public GroupDescList GetGroups(string moduleName)

Parameters Returns

GetModuleTypes

Get TypeDescList from a module name.

[HandleProcessCorruptedStateExceptions]public TypeDescList GetModuleTypes(string moduleName)

Parameters Returns

GetModules

Get all modules desc.

[HandleProcessCorruptedStateExceptions]public ModuleDescList GetModules()

Returns

GetModulesName

Get all modules name.

[HandleProcessCorruptedStateExceptions]public StringList GetModulesName()

Returns

GetType

Get TypeDesc from a type name.

[HandleProcessCorruptedStateExceptions]public TypeDesc GetType(string moduleName, string typeNameStr)

Parameters Returns

GetTypeAttributes

Get attributes TypeDesc from a type name.

[HandleProcessCorruptedStateExceptions]public StringPairList GetTypeAttributes(string moduleName, string typeNameStr)

Parameters Returns

DefineCaptchaCallback

Define a callback function to customize the captha which unlock automated functions in interactive products.

[HandleProcessCorruptedStateExceptions]public void DefineCaptchaCallback(CoreInterface.CaptchaCallback callback)

Parameters

EntityExists

Returns true if the entity exists.

[HandleProcessCorruptedStateExceptions]public bool EntityExists(uint entity)

Parameters Returns

GetAllEntities

Returns all the entities on the database.

[HandleProcessCorruptedStateExceptions]public EntityList GetAllEntities()

Returns

GetCurrentPiXYZFile

Get current (loaded) Pixyz file path.

[HandleProcessCorruptedStateExceptions]public string GetCurrentPiXYZFile()

Returns

GetEntityType

Returns the type id of the entity.

[HandleProcessCorruptedStateExceptions]public uint GetEntityType(uint entity)

Parameters Returns

GetEntityTypeString

Returns the type name of the entity.

[HandleProcessCorruptedStateExceptions]public string GetEntityTypeString(uint entity)

Parameters Returns

GetTypeStats

Get the database stats.

[HandleProcessCorruptedStateExceptions]public IntListList GetTypeStats()

Returns

IsCurrentPiXYZFileModified

Return true, if the current (loaded) file has been modified since last load or save.

[HandleProcessCorruptedStateExceptions]public bool IsCurrentPiXYZFileModified()

Returns

Load

Load a new scene.

[HandleProcessCorruptedStateExceptions]public void Load(string fileName)

Parameters

LockEntityRegistration

Lock Entity registration, use with Caution. All entities created after this call will not be saved on .pxz file and will not be listed as existing entities on the Database. Be careful to not references these entities with other registered entities.

[HandleProcessCorruptedStateExceptions]public void LockEntityRegistration()

Save

Save the scene.

[HandleProcessCorruptedStateExceptions]public void Save(string fileName)

Parameters

UnlockEntityRegistration

Unlock Entity registration.

[HandleProcessCorruptedStateExceptions]public void UnlockEntityRegistration()

AddWantedToken

Add a license token to the list of wanted tokens. The wanted tokens list is saved on disk in program data and is used at initialization. Prefer using 'core.needToken' instead.

[HandleProcessCorruptedStateExceptions]public void AddWantedToken(string tokenName)

Parameters

CheckLicense

Verifies the validity of the current installed license to ensure compliance and access control.

[HandleProcessCorruptedStateExceptions]public bool CheckLicense()

Returns

CheckWebLogin

Check if authentification on the Web license API is sucessfull.

[HandleProcessCorruptedStateExceptions]public bool CheckWebLogin(string login, string password)

Parameters Returns

ConfigureLicenseServer

Configure the license server to use to get floating licenses.

[HandleProcessCorruptedStateExceptions]public void ConfigureLicenseServer(string address, ushort port, bool flexLM = true)

Parameters

GenerateActivationCode

Create an activation code to generate an offline license.

[HandleProcessCorruptedStateExceptions]public void GenerateActivationCode(string filePath)

Parameters

GenerateDeactivationCode

Create an deactivation code to release the license from this machine.

[HandleProcessCorruptedStateExceptions]public void GenerateDeactivationCode(string filePath)

Parameters

GetCurrentLicenseInfos

Get information on current installed license.

[HandleProcessCorruptedStateExceptions]public LicenseInfos GetCurrentLicenseInfos()

Returns

GetLicenseError

Get errors from license check.

[HandleProcessCorruptedStateExceptions]public GetLicenseErrorReturn GetLicenseError()

Returns

GetLicenseServer

Get current license server.

[HandleProcessCorruptedStateExceptions]public GetLicenseServerReturn GetLicenseServer()

Returns

InstallLicense

Add a new license. You can use either an activation .bin file from the website or a .lic file.

[HandleProcessCorruptedStateExceptions]public void InstallLicense(string licensePath, bool user = false)

Parameters

ListOwnedTokens

Get the list of actually owned license tokens.

[HandleProcessCorruptedStateExceptions]public StringList ListOwnedTokens()

Returns

ListTokens

Get the list of license tokens for this product.

[HandleProcessCorruptedStateExceptions]public StringList ListTokens(bool onlyMandatory = false)

Parameters Returns

ListWantedTokens

Get the list of license token configured to be requested at initialization.

[HandleProcessCorruptedStateExceptions]public StringList ListWantedTokens()

Returns

NeedToken

Requests a license token for the current session. This step should be done after configuring license server. Throws an exception if the token is not available.

[HandleProcessCorruptedStateExceptions]public void NeedToken(string tokenName)

Parameters

OwnToken

Returns True if we own a token, without requesting it.

[HandleProcessCorruptedStateExceptions]public bool OwnToken(string tokenName)

Parameters Returns

ReleaseToken

Release an optional license token.

[HandleProcessCorruptedStateExceptions]public void ReleaseToken(string tokenName)

Parameters

ReleaseWebLicense

Release License owned by user WEB account.

[HandleProcessCorruptedStateExceptions]public void ReleaseWebLicense(string login, string password, uint id)

Parameters

RemoveWantedToken

Remove a license token from the list of wanted optional tokens.

[HandleProcessCorruptedStateExceptions]public void RemoveWantedToken(string tokenName)

Parameters

RequestWebLicense

Request License owned by user WEB account.

[HandleProcessCorruptedStateExceptions]public void RequestWebLicense(string login, string password, uint id)

Parameters

RetrieveWebLicenses

Retrieves License owned by user WEB account.

[HandleProcessCorruptedStateExceptions]public WebLicenseInfoList RetrieveWebLicenses(string login, string password)

Parameters Returns

TokenValid

Returns True if a token is owned by the product, request will be done if missing.

[HandleProcessCorruptedStateExceptions]public bool TokenValid(string tokenName)

Parameters Returns

ParallelAddJob

Add a job to a parallel session.

[HandleProcessCorruptedStateExceptions]public void ParallelAddJob(IntPtr session, CoreInterface.ParallelCallback jobCallback, IntPtr dataPtr)

Parameters

ParallelFinish

Ends a parallel session after waiting for all jobs to finish.

[HandleProcessCorruptedStateExceptions]public void ParallelFinish(IntPtr session)

Parameters

ParallelStart

Starts a new parallel session.

[HandleProcessCorruptedStateExceptions]public IntPtr ParallelStart(bool progression = false, string name = "Parallel session", int jobCount = -1)

Parameters Returns

GetModuleDescFromXML

Generate a ModuleDesc from an .xml description.

[HandleProcessCorruptedStateExceptions]public ModuleDesc GetModuleDescFromXML(string xmlPath, bool addToModules)

Parameters Returns

RemoveModule

Remove a module added via getModuleDescFromXML.

[HandleProcessCorruptedStateExceptions]public void RemoveModule(string module)

Parameters

PopProgression

Leave current progression level.

[HandleProcessCorruptedStateExceptions]public void PopProgression()

PushProgression

Create a new progression level.

[HandleProcessCorruptedStateExceptions]public void PushProgression(int stepCount, string progressName = "")

Parameters

StepProgression

Add a step to current progression level.

[HandleProcessCorruptedStateExceptions]public void StepProgression(int stepCount = 1)

Parameters

AddCustomProperties

Add multiple custom property to entities that support custom properties.

[HandleProcessCorruptedStateExceptions]public void AddCustomProperties(EntityList entities, StringList names, StringList values = null, PropertyTypeList types = null)

Parameters

AddCustomProperty

Add a custom property to an entity that support custom properties.

[HandleProcessCorruptedStateExceptions]public void AddCustomProperty(uint entity, string name, string value = "", PropertyType type = PropertyType.STRING)

Parameters

GetModuleProperty

Returns the value of a module property.

[HandleProcessCorruptedStateExceptions]public string GetModuleProperty(string module, string propertyName)

Parameters Returns

GetModulePropertyInfo

Returns the value of a module property.

[HandleProcessCorruptedStateExceptions]public PropertyInfo GetModulePropertyInfo(string module, string propertyName)

Parameters Returns

GetProperties

Get the property value on entities (if the property is not set on an entity, defaultValue is returned).

[HandleProcessCorruptedStateExceptions]public StringList GetProperties(EntityList entities, string propertyName, string defaultValue = "")

Parameters Returns

GetProperty

Get a property value as String on an entity (error if the property does not exist on the entity).

[HandleProcessCorruptedStateExceptions]public string GetProperty(uint entity, string propertyName)

Parameters Returns

GetPropertyInfo

Get a property info on an entity (error if the property does not exist on the entity).

[HandleProcessCorruptedStateExceptions]public PropertyInfo GetPropertyInfo(uint entity, string propertyName)

Parameters Returns

HasCustomProperty

Return true if the custom property was found on the occurrence.

[HandleProcessCorruptedStateExceptions]public bool HasCustomProperty(uint entityId, string customPropertyName)

Parameters Returns

HasProperty

Return true if the property was found on the occurrence, will not throw any exception except if the entity does not exist.

[HandleProcessCorruptedStateExceptions]public bool HasProperty(uint entity, string propertyName)

Parameters Returns

ListEnumLabels

Returns the informations of a module property.

[HandleProcessCorruptedStateExceptions]public EnumPropertyInfo ListEnumLabels(int enumType)

Parameters Returns

ListModuleProperties

Returns all the properties in the given module.

[HandleProcessCorruptedStateExceptions]public PropertyInfoList ListModuleProperties(string module)

Parameters Returns

ListProperties

Returns the names and values of the properties available on an entity.

[HandleProcessCorruptedStateExceptions]public PropertyInfoList ListProperties(uint entity)

Parameters Returns

ListPropertiesBatch

Returns the names and values of the properties available on multiple entities.

[HandleProcessCorruptedStateExceptions]public PropertyInfoListList ListPropertiesBatch(EntityList entities)

Parameters Returns

RemoveCustomProperty

Remove a custom property from an entity that support custom properties.

[HandleProcessCorruptedStateExceptions]public void RemoveCustomProperty(uint entity, string name)

Parameters

RestoreModulePropertyDefaultValue

Restore the default value of a module property.

[HandleProcessCorruptedStateExceptions]public string RestoreModulePropertyDefaultValue(string module, string propertyName)

Parameters Returns

SetModuleProperty

Set the value of a module property.

[HandleProcessCorruptedStateExceptions]public string SetModuleProperty(string module, string propertyName, string propertyValue)

Parameters Returns

SetProperties

Set multiple properties values on entities.

[HandleProcessCorruptedStateExceptions]public void SetProperties(EntityList entities, StringList propertyNames, StringList propertyValues)

Parameters

SetProperty

Set a property value on an entity.

[HandleProcessCorruptedStateExceptions]public string SetProperty(uint entity, string propertyName, string propertyValue)

Parameters Returns

SupportCustomProperties

Return true if an entity support custom properties.

[HandleProcessCorruptedStateExceptions]public bool SupportCustomProperties(uint entity)

Parameters Returns

UnsetProperty

Unset an entity's property.

[HandleProcessCorruptedStateExceptions]public void UnsetProperty(uint entity, string propertyName)

Parameters

AddAfterCustomPropertyAddedCallback

public uint AddAfterCustomPropertyAddedCallback(CoreInterface.AfterCustomPropertyAddedDelegate callback, IntPtr userData)

Parameters Returns

RemoveAfterCustomPropertyAddedCallback

public void RemoveAfterCustomPropertyAddedCallback(uint id)

Parameters

AvailableMemory

Returns available memory.

[HandleProcessCorruptedStateExceptions]public AvailableMemoryReturn AvailableMemory()

Returns

CheckForUpdates

Check for software update.

[HandleProcessCorruptedStateExceptions]public CheckForUpdatesReturn CheckForUpdates()

Returns

ClearOtherTemporaryDirectories

Remove all other session temporary directories (warning: make sure that no other instance of pixyz is running.

[HandleProcessCorruptedStateExceptions]public void ClearOtherTemporaryDirectories()

GetCustomVersionTag

Get the Pixyz custom version tag.

[HandleProcessCorruptedStateExceptions]public string GetCustomVersionTag()

Returns

GetMemoryUsagePeak

Returns the memory usage peak of the current process in MB ( only available on windows yet ).

[HandleProcessCorruptedStateExceptions]public long GetMemoryUsagePeak()

Returns

GetPixyzWebsiteURL

Get the Pixyz website URL.

[HandleProcessCorruptedStateExceptions]public string GetPixyzWebsiteURL()

Returns

GetProductName

Get the Pixyz product name.

[HandleProcessCorruptedStateExceptions]public string GetProductName()

Returns

GetTempDirectory

Get the Pixyz temp directory (server side directory in case of remote access).

[HandleProcessCorruptedStateExceptions]public string GetTempDirectory()

Returns

GetVersion

Get the Pixyz product version.

[HandleProcessCorruptedStateExceptions]public string GetVersion()

Returns

SetCurrentThreadAsProcessThread

Set the process thread. Use this function when you want to get progress changed callbacks from another thread as the one you initialized Pixyz on.

[HandleProcessCorruptedStateExceptions]public void SetCurrentThreadAsProcessThread()

ClearUndoRedo

Clear undo/redo history.

[HandleProcessCorruptedStateExceptions]public void ClearUndoRedo()

EndUndoRedoStep

End current undo/redo step.

[HandleProcessCorruptedStateExceptions]public void EndUndoRedoStep(bool deleteIfEmpty = true)

Parameters

GetRedoStack

Get the history of actions stack.

[HandleProcessCorruptedStateExceptions]public StringList GetRedoStack()

Returns

GetRedoStepUserData

Get user data for undo step #index.

[HandleProcessCorruptedStateExceptions]public string GetRedoStepUserData(uint index)

Parameters Returns

GetUndoStack

Get the history of actions stack.

[HandleProcessCorruptedStateExceptions]public StringList GetUndoStack()

Returns

GetUndoStepUserData

Get user data for undo step #index.

[HandleProcessCorruptedStateExceptions]public string GetUndoStepUserData(uint index)

Parameters Returns

HasRecordingStep

Has recording step.

[HandleProcessCorruptedStateExceptions]public bool HasRecordingStep()

Returns

Redo

Redo some steps.

[HandleProcessCorruptedStateExceptions]public void Redo(uint count = 1)

Parameters

StartUndoRedoStep

Start a new undo/redo step.

[HandleProcessCorruptedStateExceptions]public void StartUndoRedoStep(string stepName, string userData = "")

Parameters

StopProcess

Stop process (works if there is recording step).

[HandleProcessCorruptedStateExceptions]public void StopProcess()

ToggleUndoRedo

Toggle undo/redo.

[HandleProcessCorruptedStateExceptions]public void ToggleUndoRedo()

Undo

Undo some steps.

[HandleProcessCorruptedStateExceptions]public void Undo(uint count = 1)

Parameters

AddUndoRedoStackChangedCallback

public uint AddUndoRedoStackChangedCallback(CoreInterface.UndoRedoStackChangedDelegate callback, IntPtr userData)

Parameters Returns

RemoveUndoRedoStackChangedCallback

public void RemoveUndoRedoStackChangedCallback(uint id)

Parameters

AddConsoleVerbose

Add a console verbose level.

[HandleProcessCorruptedStateExceptions]public void AddConsoleVerbose(Verbose level)

Parameters

AddLogFileVerbose

Add a log file verbose level.

[HandleProcessCorruptedStateExceptions]public void AddLogFileVerbose(Verbose level)

Parameters

AddSessionLogFileVerbose

Add a session log file (lastSession{Id}.log) verbose level.

[HandleProcessCorruptedStateExceptions]public void AddSessionLogFileVerbose(Verbose level)

Parameters

ConfigureInterfaceLogger

Set new configuration for the Interface Logger.

[HandleProcessCorruptedStateExceptions]public void ConfigureInterfaceLogger(bool enableFunction, bool enableParameters, bool enableExecutionTime)

Parameters

GetInterfaceLoggerConfiguration

Get the current Interface Logger configuration.

[HandleProcessCorruptedStateExceptions]public GetInterfaceLoggerConfigurationReturn GetInterfaceLoggerConfiguration()

Returns

GetLogFile

Get the path of the log file.

[HandleProcessCorruptedStateExceptions]public string GetLogFile()

Returns

HasConsoleVerbose

Returns whether a console verbose level is present.

[HandleProcessCorruptedStateExceptions]public bool HasConsoleVerbose(Verbose level)

Parameters Returns

Log

Log a message to Pixyz output.

[HandleProcessCorruptedStateExceptions]public void Log(string message, Verbose level)

Parameters

RemoveConsoleVerbose

Remove a console verbose level.

[HandleProcessCorruptedStateExceptions]public void RemoveConsoleVerbose(Verbose level)

Parameters

RemoveLogFileVerbose

Remove a log file verbose level.

[HandleProcessCorruptedStateExceptions]public void RemoveLogFileVerbose(Verbose level)

Parameters

RemoveSessionLogFileVerbose

Remove a session log file (lastSession{Id}.log) verbose level.

[HandleProcessCorruptedStateExceptions]public void RemoveSessionLogFileVerbose(Verbose level)

Parameters

SetCoreDumpFile

WARNING: this function is tagged as 'EXPERIMENTAL'
set the path of the core dump file that will be written when a crash occurs (default=none).

[HandleProcessCorruptedStateExceptions]public void SetCoreDumpFile(string path)

Parameters

SetLogFile

Set the path of the log file.

[HandleProcessCorruptedStateExceptions]public void SetLogFile(string path, bool keepHistory = false)

Parameters