Class CoreInterface
Inherited Members
Namespace: UnityEngine.Pixyz.Core
Assembly: Unity.Pixyz.SDKPlus.Editor.dll
Syntax
public class CoreInterface : InterfaceFields
| Name | Description |
|---|---|
| Epsilon | |
| EpsilonSquare | |
| HalfPi | |
| Infinity | |
| OneDegree | |
| Pi | |
| TwoPi |
Methods
| Name | Description |
|---|---|
| AddAfterCustomPropertyAddedCallback(AfterCustomPropertyAddedDelegate, IntPtr) | |
| AddAfterEntityPropertyChangedCallback(AfterEntityPropertyChangedDelegate, IntPtr) | |
| AddAfterModulePropertyChangedCallback(AfterModulePropertyChangedDelegate, IntPtr) | |
| AddAfterUndoRedoCallback(AfterUndoRedoDelegate, IntPtr) | |
| AddAtExitCallback(AtExitDelegate, IntPtr) | |
| AddBeforeEntityPropertyChangedCallback(BeforeEntityPropertyChangedDelegate, IntPtr) | |
| AddBeforeModulePropertyChangedCallback(BeforeModulePropertyChangedDelegate, IntPtr) | |
| AddBeforeSessionResetCallback(BeforeSessionResetDelegate, IntPtr) | |
| AddBeforeUndoRedoCallback(BeforeUndoRedoDelegate, IntPtr) | |
| AddConsoleVerbose(Verbose) | add a console verbose level |
| AddCurrentFileChangedCallback(CurrentFileChangedDelegate, IntPtr) | |
| AddCustomProperties(EntityList, StringList, StringList, PropertyTypeList) | Add multiple custom property to entities that support custom properties |
| AddCustomProperty(uint, string, string, PropertyType) | Add a custom property to an entity that support custom properties |
| AddDebugEventCallback(DebugEventDelegate, IntPtr) | |
| AddEnteringUnsafeModeCallback(EnteringUnsafeModeDelegate, IntPtr) | |
| AddEntityDestroyedCallback(EntityDestroyedDelegate, IntPtr) | |
| AddLeavingUnsafeModeCallback(LeavingUnsafeModeDelegate, IntPtr) | |
| AddLicenseClientDisconnectedCallback(LicenseClientDisconnectedDelegate, IntPtr) | |
| AddLicenseClientReconnectedCallback(LicenseClientReconnectedDelegate, IntPtr) | |
| AddLogFileVerbose(Verbose) | add a log file verbose level |
| AddOnConsoleMessageCallback(OnConsoleMessageDelegate, IntPtr) | |
| AddOnSessionResetCallback(OnSessionResetDelegate, IntPtr) | |
| AddProgressChangedCallback(ProgressChangedDelegate, IntPtr) | |
| AddProgressStepFinishedCallback(ProgressStepFinishedDelegate, IntPtr) | |
| AddProgressStepStartCallback(ProgressStepStartDelegate, IntPtr) | |
| AddSessionLogFileVerbose(Verbose) | add a session log file (lastSession.log) verbose level |
| AddUndoRedoStackChangedCallback(UndoRedoStackChangedDelegate, IntPtr) | |
| AddWantedToken(string) | 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. |
| AvailableMemory() | returns available memory |
| CheckForUpdates() | check for software update |
| CheckLicense() | Verifies the validity of the current installed license to ensure compliance and access control. |
| CheckWebLogin(string, string) | Check if authentification on the Web license API is sucessfull |
| 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 |
| CreateEntity(uint) | Create an entity |
| DefineCaptchaCallback(CaptchaCallback) | Define a callback function to customize the captha which unlock automated functions in interactive products |
| DeleteEntities(EntityList) | Delete a set of entities |
| EndUndoRedoStep(bool) | End current undo/redo step |
| EntityExists(uint) | returns true if the entity exists |
| GenerateActivationCode(string) | Create an activation code to generate an offline license |
| GenerateDeactivationCode(string) | Create an deactivation code to release the license from this machine |
| GetAllEntities() | returns all the entities on the database |
| GetCurrentLicenseInfos() | get information on current installed license |
| GetCurrentPiXYZFile() | Get current (loaded) Pixyz file path |
| GetCustomVersionTag() | get the Pixyz custom version tag |
| GetEntitiesByType(uint, bool) | get all entities of a given type |
| GetEntityType(uint) | 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() | |
| GetLicenseError() | get errors from license check |
| GetLicenseServer() | Get current license server |
| GetLogFile() | get the path of the log file |
| 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 |
| 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 |
| GetRedoStepUserData(uint) | Get user data for undo step #index |
| GetRemainingSecondsBeforeLicenseTimeout() | get the seconds left before the app force-closes after the license server is disconnected |
| 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 |
| GetUndoStepUserData(uint) | Get user data for undo step #index |
| GetVersion() | get the Pixyz product version |
| HasConsoleVerbose(Verbose) | returns whether a console verbose level is present |
| HasCustomProperty(uint, string) | Return true if the custom property was found on the occurrence |
| 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 |
| InstallLicense(string, bool) | Add a new license. You can use either an activation .bin file from the website or a .lic file. |
| IsCurrentPiXYZFileModified() | Return true, if the current (loaded) file has been modified since last load or save |
| 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 |
| 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 |
| Log(string, Verbose) | log a message to Pixyz output |
| NeedToken(string) | 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. |
| OwnToken(string) | Returns True if we own a token, without requesting it |
| ParallelAddJob(IntPtr, ParallelCallback, IntPtr) | Add a job to a parallel session |
| ParallelFinish(IntPtr) | Ends a parallel session after waiting for all jobs to finish |
| ParallelStart(bool, string, int) | Starts a new parallel session |
| PopProgression() | Leave current progression level |
| 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 |
| RemoveAfterCustomPropertyAddedCallback(uint) | |
| RemoveAfterEntityPropertyChangedCallback(uint) | |
| RemoveAfterModulePropertyChangedCallback(uint) | |
| RemoveAfterUndoRedoCallback(uint) | |
| RemoveAtExitCallback(uint) | |
| RemoveBeforeEntityPropertyChangedCallback(uint) | |
| RemoveBeforeModulePropertyChangedCallback(uint) | |
| RemoveBeforeSessionResetCallback(uint) | |
| RemoveBeforeUndoRedoCallback(uint) | |
| RemoveConsoleVerbose(Verbose) | remove a console verbose level |
| RemoveCurrentFileChangedCallback(uint) | |
| RemoveCustomProperty(uint, string) | Remove a custom property from an entity that support custom properties |
| RemoveDebugEventCallback(uint) | |
| RemoveEnteringUnsafeModeCallback(uint) | |
| RemoveEntityDestroyedCallback(uint) | |
| RemoveLeavingUnsafeModeCallback(uint) | |
| RemoveLicenseClientDisconnectedCallback(uint) | |
| RemoveLicenseClientReconnectedCallback(uint) | |
| RemoveLogFileVerbose(Verbose) | remove a log file verbose level |
| RemoveModule(string) | Remove a module added via getModuleDescFromXML |
| RemoveOnConsoleMessageCallback(uint) | |
| RemoveOnSessionResetCallback(uint) | |
| RemoveProgressChangedCallback(uint) | |
| RemoveProgressStepFinishedCallback(uint) | |
| RemoveProgressStepStartCallback(uint) | |
| RemoveSessionLogFileVerbose(Verbose) | remove a session log file (lastSession.log) verbose level |
| RemoveUndoRedoStackChangedCallback(uint) | |
| 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 |
| SetCoreDumpFile(string) | WARNING: this function is tagged as 'EXPERIMENTAL' |
| 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. |
| SetLogFile(string, bool) | set the path of the log file |
| SetModuleProperty(string, string, string) | Set the value of a module property |
| SetProperties(EntityList, StringList, StringList) | Set multiple properties values on entities |
| SetProperty(uint, string, string) | Set a property value on an entity |
| StartUndoRedoStep(string, 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 |
| Undo(uint) | undo some steps |
| UnlockEntityRegistration() | Unlock Entity registration |
| UnsavedUserChanges() | Returns true if the user has made changes to the project |
| UnsetProperty(uint, string) | Unset an entity's property |