Class CoreInterface
Inherited Members
Namespace: UnityEngine.Pixyz.Core
Assembly: Unity.Pixyz.SDKPlus.Runtime.dll
Syntax
public class CoreInterface : InterfaceMethods
| Name | Description |
|---|---|
| AddConsoleVerbose(Verbose) | add a console verbose level |
| AddCustomProperty(uint, string, string, PropertyType) | Add a custom property to an entity that support custom properties |
| AddLogFileVerbose(Verbose) | add a log file verbose level |
| AddPreset(PresetDesc) | Add a user-defined preset |
| AddSessionLogFileVerbose(Verbose) | add a session log file (lastSession.log) verbose level |
| AddWantedToken(string) | Add a license token to the list of wanted optional tokens |
| AskString(string, string) | Invite the user to enter a string |
| AskYesNo(string, bool) | Ask a question which need a Yes/No answer |
| AvailableMemory() | returns available memory |
| CheckForUpdates() | check for software update |
| CheckLicense() | check the current license |
| CheckWebLogin(string, string) | Check if authentification on the Web license API is sucessfull |
| Choose(string, StringList, int) | Invite the user to choose one value between multiple choice |
| ClearOtherTemporaryDirectories() | remove all other session temporary directories (warning: make sure that no other instance of pixyz is running |
| ClearUndoRedo() | Clear undo/redo history |
| CloneEntity(uint) | Clone an entity |
| ConfigureFunctionLogger(string, bool, bool, bool) | |
| ConfigureInterfaceLogger(bool, bool, bool) | Set new configuration for the Interface Logger |
| ConfigureLicenseServer(string, ushort, bool) | Configure the license server to use to get floating licenses |
| Crash() | The only function in Pixyz to crash except undo/redo |
| DeleteEntities(EntityList) | Delete a set of entities |
| EndUndoRedoStep() | End current undo/redo step |
| EntityExists(uint) | |
| ExecuteCommand(string) | Execute a command |
| ExportFunctionDialogScreen(string, string, string) | Test documentation GUI dialog print |
| ExportPresets(string) | Export all presets |
| GenerateActivationCode(string) | Create an activation code to generate an offline license |
| GenerateDeactivationCode(string) | Create an deactivation code to release the license from this machine |
| GenerateHTMLDocumentation(string) | Generate the documentation of available functions in HTML format |
| GetAllEntities() | returns all the entities on the database |
| GetColorFromIndex(int) | Returns a unique color associated with an index |
| GetCurrentLicenseInfos() | get information on current installed license |
| GetCurrentPiXYZFile() | Get current (loaded) Pixyz file path |
| GetCustomVersionTag() | get the Pixyz custom version tag |
| GetEntityType(uint) | returns the type id of the entity |
| GetEntityTypeFromString(string) | returns the type id of the entity |
| GetEntityTypeString(uint) | returns the type name of the entity |
| GetEvent(string, string) | get EventDesc of an event |
| GetEvents(string, string) | get events of a group |
| GetFunction(string, string) | get FunctionDesc of a function |
| GetFunctions(string, string) | get functions of a group |
| GetGroup(string, string) | get a group desc from a specific module |
| GetGroups(string) | get all group desc of a module |
| GetInterfaceLoggerConfiguration() | Get the current Interface Logger configuration |
| GetLastError() | |
| GetLicenseServer() | Get current license server |
| GetMemoryUsagePeak() | Returns the memory usage peak of the current process in MB ( only available on windows yet ) |
| GetModuleDescFromXML(string, bool) | Generate a ModuleDesc from an .xml description |
| GetModuleProperty(string, string) | Returns the value of a module property |
| GetModulePropertyInfo(string, string) | Returns the value of a module property |
| GetModuleTypes(string) | get TypeDescList from a module name |
| GetModules() | get all modules desc |
| GetModulesName() | get all modules name |
| GetOutputFilePath(string, string) | Return a complete output file path for Pixyz Pipeline, this function is useful for online usage when you know where is the output directory |
| GetPixyzWebsiteURL() | get the Pixyz website URL |
| GetProductName() | get the Pixyz product name |
| GetProperties(EntityList, string, string) | Get the property value on entities (if the property is not set on an entity, defaultValue is returned) |
| GetProperty(uint, string) | Get a property value as String on an entity (error if the property does not exist on the entity) |
| GetPropertyInfo(uint, string) | Get a property info on an entity (error if the property does not exist on the entity) |
| GetRedoStack() | Get the history of actions stack |
| GetTempDirectory() | get the Pixyz temp directory (server side directory in case of remote access) |
| GetType(string, string) | get TypeDesc from a type name |
| GetTypeAttributes(string, string) | get attributes TypeDesc from a type name |
| GetTypeStats() | Get the database stats |
| GetUndoStack() | Get the history of actions stack |
| GetVersion() | get the Pixyz product version |
| HasProperty(uint, string) | Return true if the property was found on the occurrence, will not throw any exception except if the entity does not exist. |
| HasRecordingStep() | Has recording step |
| ImportPresets(string) | Import presets from file |
| InstallLicense(string) | install a new license |
| IsCurrentPiXYZFileModified() | Return true, if the current (loaded) file has been modified since last load or save |
| IsFloatingLicense() | Tells if license is floating |
| IsInteractiveMode() | Returns True if the script is in interactive mode, else returns false |
| ListEnumLabels(int) | Returns the informations of a module property |
| ListModuleProperties(string) | Returns all the properties in the given module |
| ListOwnedTokens() | Get the list of actually owned license tokens |
| ListProperties(uint) | Returns the names and values of the properties available on an entity |
| ListPropertiesBatch(EntityList) | Returns the names and values of the properties available on multiple entities |
| ListTokens(bool) | Get the list of license tokens for this product |
| ListWantedTokens() | Get the list of license token configured to be requested at initialization |
| Load(string) | Load a new scene |
| LockProcessing() | Lock the mutex that ensure no processing is done between lock/unlock |
| Message(string) | Display a message (or a MessageBox in GUI) |
| NeedToken(string) | Ensure that a license token is available, useful to be sure to own floatting licence tokens |
| OnAfterEntityPropertyChanged(Action<Params>, CancellationTokenSource) | |
| OnAfterModulePropertyChanged(Action<Params>, CancellationTokenSource) | |
| OnAtExit(Action<Params>, CancellationTokenSource) | |
| OnBeforeEntityPropertyChanged(Action<Params>, CancellationTokenSource) | |
| OnBeforeModulePropertyChanged(Action<Params>, CancellationTokenSource) | |
| OnBeforeSessionReset(Action<Params>, CancellationTokenSource) | |
| OnCurrentFileChanged(Action<Params>, CancellationTokenSource) | |
| OnDebugEvent(Action<Params>, CancellationTokenSource) | |
| OnOnConsoleMessage(Action<Params>, CancellationTokenSource) | |
| OnOnSessionReset(Action<Params>, CancellationTokenSource) | |
| OnProgressChanged(Action<Params>, CancellationTokenSource) | |
| OnProgressStepFinished(Action<Params>, CancellationTokenSource) | |
| OnProgressStepStart(Action<Params>, CancellationTokenSource) | |
| OwnToken(string) | Returns True if we own a token, without requesting it |
| PopProgression() | Leave current progression level |
| PushAnalytic(string, string) | push custom analytic event (Only for authorized products) |
| PushProgression(int, string) | Create a new progression level |
| Redo(uint) | redo some steps |
| ReleaseToken(string) | Release an optional license token |
| ReleaseWebLicense(string, string, uint) | release License owned by user WEB account |
| RemoveAllPresets() | Remove all presets |
| RemoveConsoleVerbose(Verbose) | remove a console verbose level |
| RemoveCustomProperty(uint, string) | Remove a custom property from an entity that support custom properties |
| RemoveLogFileVerbose(Verbose) | remove a log file verbose level |
| RemovePreset(PresetDesc) | Remove a user-defined preset |
| RemoveSessionLogFileVerbose(Verbose) | remove a session log file (lastSession.log) verbose level |
| RemoveWantedToken(string) | remove a license token from the list of wanted optional tokens |
| RequestWebLicense(string, string, uint) | request License owned by user WEB account |
| ResetSession() | Clear all the current session (all unsaved work will be lost) |
| RestoreModulePropertyDefaultValue(string, string) | Restore the default value of a module property |
| RetrieveWebLicenses(string, string) | Retrieves License owned by user WEB account |
| Save(string) | Save the scene |
| SavePreset(PresetDesc) | Add a user-defined preset |
| SendDebugMessage(int) | Sends a debug event |
| SetCoreDumpFile(string) | set the path of the core dump file that will be written when a crash occurs (default=none) |
| 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. |
| SetInteractiveMode(bool) | Switch between interactive mode and non-interactive mode, UI functions will no ask user on non-interactive mode and will return default values |
| SetLogFile(string) | set the path of the log file |
| SetModuleProperty(string, string, string) | Set the value of a module property |
| SetProperty(uint, string, string) | Set a property value on an entity |
| SoftStopAsyncEventManager() | Ask the async EventManager to join the main thread, enableEventManagerAsync must be enable |
| StartUndoRedoStep(string) | Start a new undo/redo step |
| StepProgression(int) | Add a step to current progression level |
| StopProcess() | Stop process (works if there is recording step) |
| SupportCustomProperties(uint) | Return true if an entity support custom properties |
| ToggleUndoRedo() | Toggle undo/redo |
| TokenValid(string) | Returns True if a token is owned by the product, request will be done if missing |
| TryLockProcessing() | Try to lock the mutex that ensure no processing is done between lock/unlock, returns true if the mutex has been locked, false if it was already locked |
| Undo(uint) | undo some steps |
| UnlockProcessing() | Unlock the mutex that ensure no processing is done between lock/unlock |
| UnsavedUserChanges() | Returns true if the user has made changes to the project |
| UnsetProperty(uint, string) | Unset an entity's property |
| UpdateDocumentation() | Update the documentation of available functions and plugins in HTML format |
| WaitAfterEntityPropertyChanged(CancellationTokenSource) | |
| WaitAfterModulePropertyChanged(CancellationTokenSource) | |
| WaitAtExit(CancellationTokenSource) | |
| WaitBeforeEntityPropertyChanged(CancellationTokenSource) | |
| WaitBeforeModulePropertyChanged(CancellationTokenSource) | |
| WaitBeforeSessionReset(CancellationTokenSource) | |
| WaitCurrentFileChanged(CancellationTokenSource) | |
| WaitDebugEvent(CancellationTokenSource) | |
| WaitOnConsoleMessage(CancellationTokenSource) | |
| WaitOnSessionReset(CancellationTokenSource) | |
| WaitProgressChanged(CancellationTokenSource) | |
| WaitProgressStepFinished(CancellationTokenSource) | |
| WaitProgressStepStart(CancellationTokenSource) |