CoreInterface
Class
Read time 27 minutesLast updated 8 months ago
Inheritance
Inherited Members
Namespace: UnityEngine.Pixyz.Core
public class CoreInterface : Interface
Fields
Epsilon
public const double Epsilon = 1E-06
Returns
Type | Description |
|---|---|
| double |
EpsilonSquare
public const double EpsilonSquare = 1E-12
Returns
Type | Description |
|---|---|
| double |
HalfPi
public const double HalfPi = 1.5707963267948966
Returns
Type | Description |
|---|---|
| double |
Infinity
public const double Infinity = 1000000000000
Returns
Type | Description |
|---|---|
| double |
OneDegree
public const double OneDegree = 0.017453292519943295
Returns
Type | Description |
|---|---|
| double |
Pi
public const double Pi = 3.141592653589793
Returns
Type | Description |
|---|---|
| double |
TwoPi
public const double TwoPi = 6.283185307179586
Returns
Type | Description |
|---|---|
| double |
Methods
GetLastError
public static string GetLastError()
Returns
Type | Description |
|---|---|
| string |
CloneEntity
Clone an entity.
[HandleProcessCorruptedStateExceptions]public uint CloneEntity(uint entity)
Parameters
Type | Name | Description |
|---|---|---|
| uint | entity | The entity to clone. |
Returns
Type | Description |
|---|---|
| uint |
ConfigureFunctionLogger
[HandleProcessCorruptedStateExceptions]public void ConfigureFunctionLogger(string functionName, bool enableFunction, bool enableParameters, bool enableExecutionTime)
Parameters
Crash
Important
This function is tagged as development.
[HandleProcessCorruptedStateExceptions]public void Crash()
CreateEntity
Create an entity.
[HandleProcessCorruptedStateExceptions]public uint CreateEntity(uint type)
Parameters
Type | Name | Description |
|---|---|---|
| uint | type | The type of entity to create. |
Returns
Type | Description |
|---|---|
| uint |
DeleteEntities
Delete a set of entities.
[HandleProcessCorruptedStateExceptions]public void DeleteEntities(EntityList entities)
Parameters
Type | Name | Description |
|---|---|---|
| EntityList | entities | List of entity to delete. |
GetEntitiesByType
Get all entities of a given type.
[HandleProcessCorruptedStateExceptions]public EntityList GetEntitiesByType(uint type, bool includeUnsubscribed)
Parameters
Type | Name | Description |
|---|---|---|
| uint | type | The type of entities to retrieve. |
| bool | includeUnsubscribed | Include unsubscribed entities. |
Returns
Type | Description |
|---|---|
| EntityList |
GetRemainingSecondsBeforeLicenseTimeout
Get the seconds left before the app force-closes after the license server is disconnected.
[HandleProcessCorruptedStateExceptions]public double GetRemainingSecondsBeforeLicenseTimeout()
Returns
Type | Description |
|---|---|
| double |
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
Type | Description |
|---|---|
| bool |
AddAfterEntityPropertyChangedCallback
public uint AddAfterEntityPropertyChangedCallback(CoreInterface.AfterEntityPropertyChangedDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.AfterEntityPropertyChangedDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveAfterEntityPropertyChangedCallback
public void RemoveAfterEntityPropertyChangedCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddAfterModulePropertyChangedCallback
public uint AddAfterModulePropertyChangedCallback(CoreInterface.AfterModulePropertyChangedDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.AfterModulePropertyChangedDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveAfterModulePropertyChangedCallback
public void RemoveAfterModulePropertyChangedCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddAfterUndoRedoCallback
public uint AddAfterUndoRedoCallback(CoreInterface.AfterUndoRedoDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.AfterUndoRedoDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveAfterUndoRedoCallback
public void RemoveAfterUndoRedoCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddAtExitCallback
public uint AddAtExitCallback(CoreInterface.AtExitDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.AtExitDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveAtExitCallback
public void RemoveAtExitCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddBeforeEntityPropertyChangedCallback
public uint AddBeforeEntityPropertyChangedCallback(CoreInterface.BeforeEntityPropertyChangedDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.BeforeEntityPropertyChangedDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveBeforeEntityPropertyChangedCallback
public void RemoveBeforeEntityPropertyChangedCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddBeforeModulePropertyChangedCallback
public uint AddBeforeModulePropertyChangedCallback(CoreInterface.BeforeModulePropertyChangedDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.BeforeModulePropertyChangedDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveBeforeModulePropertyChangedCallback
public void RemoveBeforeModulePropertyChangedCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddBeforeSessionResetCallback
public uint AddBeforeSessionResetCallback(CoreInterface.BeforeSessionResetDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.BeforeSessionResetDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveBeforeSessionResetCallback
public void RemoveBeforeSessionResetCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddBeforeUndoRedoCallback
public uint AddBeforeUndoRedoCallback(CoreInterface.BeforeUndoRedoDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.BeforeUndoRedoDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveBeforeUndoRedoCallback
public void RemoveBeforeUndoRedoCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddCurrentFileChangedCallback
public uint AddCurrentFileChangedCallback(CoreInterface.CurrentFileChangedDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.CurrentFileChangedDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveCurrentFileChangedCallback
public void RemoveCurrentFileChangedCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddEnteringUnsafeModeCallback
public uint AddEnteringUnsafeModeCallback(CoreInterface.EnteringUnsafeModeDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.EnteringUnsafeModeDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveEnteringUnsafeModeCallback
public void RemoveEnteringUnsafeModeCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddEntityDestroyedCallback
public uint AddEntityDestroyedCallback(CoreInterface.EntityDestroyedDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.EntityDestroyedDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveEntityDestroyedCallback
public void RemoveEntityDestroyedCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddLeavingUnsafeModeCallback
public uint AddLeavingUnsafeModeCallback(CoreInterface.LeavingUnsafeModeDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.LeavingUnsafeModeDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveLeavingUnsafeModeCallback
public void RemoveLeavingUnsafeModeCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddLicenseClientDisconnectedCallback
public uint AddLicenseClientDisconnectedCallback(CoreInterface.LicenseClientDisconnectedDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.LicenseClientDisconnectedDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveLicenseClientDisconnectedCallback
public void RemoveLicenseClientDisconnectedCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddLicenseClientReconnectedCallback
public uint AddLicenseClientReconnectedCallback(CoreInterface.LicenseClientReconnectedDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.LicenseClientReconnectedDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveLicenseClientReconnectedCallback
public void RemoveLicenseClientReconnectedCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddOnConsoleMessageCallback
public uint AddOnConsoleMessageCallback(CoreInterface.OnConsoleMessageDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.OnConsoleMessageDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveOnConsoleMessageCallback
public void RemoveOnConsoleMessageCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddOnSessionResetCallback
public uint AddOnSessionResetCallback(CoreInterface.OnSessionResetDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.OnSessionResetDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveOnSessionResetCallback
public void RemoveOnSessionResetCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddProgressChangedCallback
public uint AddProgressChangedCallback(CoreInterface.ProgressChangedDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.ProgressChangedDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveProgressChangedCallback
public void RemoveProgressChangedCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddProgressStepFinishedCallback
public uint AddProgressStepFinishedCallback(CoreInterface.ProgressStepFinishedDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.ProgressStepFinishedDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveProgressStepFinishedCallback
public void RemoveProgressStepFinishedCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddProgressStepStartCallback
public uint AddProgressStepStartCallback(CoreInterface.ProgressStepStartDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.ProgressStepStartDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveProgressStepStartCallback
public void RemoveProgressStepStartCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
SendDebugMessage
Important
This function is tagged as development.
[HandleProcessCorruptedStateExceptions]public void SendDebugMessage(int event_type)
Parameters
Type | Name | Description |
|---|---|---|
| int | event_type | The type of signal to emit. |
AddDebugEventCallback
public uint AddDebugEventCallback(CoreInterface.DebugEventDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.DebugEventDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveDebugEventCallback
public void RemoveDebugEventCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
GetEvent
Get EventDesc of an event.
[HandleProcessCorruptedStateExceptions]public EventDesc GetEvent(string moduleName, string eventName)
Parameters
Returns
Type | Description |
|---|---|
| EventDesc |
GetEvents
Get events of a group.
[HandleProcessCorruptedStateExceptions]public EventDescList GetEvents(string moduleName, string groupName)
Parameters
Returns
Type | Description |
|---|---|
| EventDescList |
GetFunction
Get FunctionDesc of a function.
[HandleProcessCorruptedStateExceptions]public FunctionDesc GetFunction(string moduleName, string functionName)
Parameters
Returns
Type | Description |
|---|---|
| FunctionDesc |
GetFunctions
Get functions of a group.
[HandleProcessCorruptedStateExceptions]public FunctionDescList GetFunctions(string moduleName, string groupName)
Parameters
Returns
Type | Description |
|---|---|
| FunctionDescList |
GetGroup
Get a group desc from a specific module.
[HandleProcessCorruptedStateExceptions]public GroupDesc GetGroup(string moduleName, string groupName)
Parameters
Returns
Type | Description |
|---|---|
| GroupDesc |
GetGroups
Get all group desc of a module.
[HandleProcessCorruptedStateExceptions]public GroupDescList GetGroups(string moduleName)
Parameters
Type | Name | Description |
|---|---|---|
| string | moduleName | Target module name. |
Returns
Type | Description |
|---|---|
| GroupDescList |
GetModuleTypes
Get TypeDescList from a module name.
[HandleProcessCorruptedStateExceptions]public TypeDescList GetModuleTypes(string moduleName)
Parameters
Type | Name | Description |
|---|---|---|
| string | moduleName | Target module name. |
Returns
Type | Description |
|---|---|
| TypeDescList |
GetModules
Get all modules desc.
[HandleProcessCorruptedStateExceptions]public ModuleDescList GetModules()
Returns
Type | Description |
|---|---|
| ModuleDescList |
GetModulesName
Get all modules name.
[HandleProcessCorruptedStateExceptions]public StringList GetModulesName()
Returns
Type | Description |
|---|---|
| StringList |
GetType
Get TypeDesc from a type name.
[HandleProcessCorruptedStateExceptions]public TypeDesc GetType(string moduleName, string typeNameStr)
Parameters
Returns
Type | Description |
|---|---|
| TypeDesc |
GetTypeAttributes
Get attributes TypeDesc from a type name.
[HandleProcessCorruptedStateExceptions]public StringPairList GetTypeAttributes(string moduleName, string typeNameStr)
Parameters
Returns
Type | Description |
|---|---|
| StringPairList |
DefineCaptchaCallback
Define a callback function to customize the captha which unlock automated functions in interactive products.
[HandleProcessCorruptedStateExceptions]public void DefineCaptchaCallback(CoreInterface.CaptchaCallback callback)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.CaptchaCallback | callback | The callback function. |
EntityExists
Returns true if the entity exists.
[HandleProcessCorruptedStateExceptions]public bool EntityExists(uint entity)
Parameters
Type | Name | Description |
|---|---|---|
| uint | entity | The wanted entity. |
Returns
Type | Description |
|---|---|
| bool |
GetAllEntities
Returns all the entities on the database.
[HandleProcessCorruptedStateExceptions]public EntityList GetAllEntities()
Returns
Type | Description |
|---|---|
| EntityList |
GetCurrentPiXYZFile
Get current (loaded) Pixyz file path.
[HandleProcessCorruptedStateExceptions]public string GetCurrentPiXYZFile()
Returns
Type | Description |
|---|---|
| string |
GetEntityType
Returns the type id of the entity.
[HandleProcessCorruptedStateExceptions]public uint GetEntityType(uint entity)
Parameters
Type | Name | Description |
|---|---|---|
| uint | entity | The wanted entity. |
Returns
Type | Description |
|---|---|
| uint |
GetEntityTypeString
Returns the type name of the entity.
[HandleProcessCorruptedStateExceptions]public string GetEntityTypeString(uint entity)
Parameters
Type | Name | Description |
|---|---|---|
| uint | entity | The wanted entity. |
Returns
Type | Description |
|---|---|
| string |
GetTypeStats
Get the database stats.
[HandleProcessCorruptedStateExceptions]public IntListList GetTypeStats()
Returns
Type | Description |
|---|---|
| IntListList |
IsCurrentPiXYZFileModified
Return true, if the current (loaded) file has been modified since last load or save.
[HandleProcessCorruptedStateExceptions]public bool IsCurrentPiXYZFileModified()
Returns
Type | Description |
|---|---|
| bool |
Load
Load a new scene.
[HandleProcessCorruptedStateExceptions]public void Load(string fileName)
Parameters
Type | Name | Description |
|---|---|---|
| string | fileName | Path to load the file. |
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
Type | Name | Description |
|---|---|---|
| string | fileName | Path to save the file. |
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
Type | Name | Description |
|---|---|---|
| string | tokenName | Wanted token. |
CheckLicense
Verifies the validity of the current installed license to ensure compliance and access control.
[HandleProcessCorruptedStateExceptions]public bool CheckLicense()
Returns
Type | Description |
|---|---|
| bool |
CheckWebLogin
Check if authentification on the Web license API is sucessfull.
[HandleProcessCorruptedStateExceptions]public bool CheckWebLogin(string login, string password)
Parameters
Returns
Type | Description |
|---|---|
| bool |
ConfigureLicenseServer
Configure the license server to use to get floating licenses.
[HandleProcessCorruptedStateExceptions]public void ConfigureLicenseServer(string address, ushort port, bool flexLM = true)
Parameters
Type | Name | Description |
|---|---|---|
| string | address | Server address. |
| ushort | port | Server port. |
| bool | flexLM | Enable FlexLM license server. |
GenerateActivationCode
Create an activation code to generate an offline license.
[HandleProcessCorruptedStateExceptions]public void GenerateActivationCode(string filePath)
Parameters
Type | Name | Description |
|---|---|---|
| string | filePath | Path to write the activation code. |
GenerateDeactivationCode
Create an deactivation code to release the license from this machine.
[HandleProcessCorruptedStateExceptions]public void GenerateDeactivationCode(string filePath)
Parameters
Type | Name | Description |
|---|---|---|
| string | filePath | Path to write the deactivation code. |
GetCurrentLicenseInfos
Get information on current installed license.
[HandleProcessCorruptedStateExceptions]public LicenseInfos GetCurrentLicenseInfos()
Returns
Type | Description |
|---|---|
| LicenseInfos |
GetLicenseError
Get errors from license check.
[HandleProcessCorruptedStateExceptions]public GetLicenseErrorReturn GetLicenseError()
Returns
Type | Description |
|---|---|
| GetLicenseErrorReturn |
GetLicenseServer
Get current license server.
[HandleProcessCorruptedStateExceptions]public GetLicenseServerReturn GetLicenseServer()
Returns
Type | Description |
|---|---|
| GetLicenseServerReturn |
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
Type | Name | Description |
|---|---|---|
| string | licensePath | License file path (.bin or .lic). |
| bool | user | Decide if the .lic license is installed only for this user or for all users. If false, Pixyz must be configured by running 'PiXYZFinishInstall' utility first (only once). |
ListOwnedTokens
Get the list of actually owned license tokens.
[HandleProcessCorruptedStateExceptions]public StringList ListOwnedTokens()
Returns
Type | Description |
|---|---|
| StringList |
ListTokens
Get the list of license tokens for this product.
[HandleProcessCorruptedStateExceptions]public StringList ListTokens(bool onlyMandatory = false)
Parameters
Type | Name | Description |
|---|---|---|
| bool | onlyMandatory | If True, optional tokens will not be returned. |
Returns
Type | Description |
|---|---|
| StringList |
ListWantedTokens
Get the list of license token configured to be requested at initialization.
[HandleProcessCorruptedStateExceptions]public StringList ListWantedTokens()
Returns
Type | Description |
|---|---|
| StringList |
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
Type | Name | Description |
|---|---|---|
| string | tokenName | Token name. |
OwnToken
Returns True if we own a token, without requesting it.
[HandleProcessCorruptedStateExceptions]public bool OwnToken(string tokenName)
Parameters
Type | Name | Description |
|---|---|---|
| string | tokenName | Token name. |
Returns
Type | Description |
|---|---|
| bool |
ReleaseToken
Release an optional license token.
[HandleProcessCorruptedStateExceptions]public void ReleaseToken(string tokenName)
Parameters
Type | Name | Description |
|---|---|---|
| string | tokenName | Token name. |
ReleaseWebLicense
Release License owned by user WEB account.
[HandleProcessCorruptedStateExceptions]public void ReleaseWebLicense(string login, string password, uint id)
Parameters
Type | Name | Description |
|---|---|---|
| string | login | WEB account login. |
| string | password | WEB account password. |
| uint | id | WEB license id. |
RemoveWantedToken
Remove a license token from the list of wanted optional tokens.
[HandleProcessCorruptedStateExceptions]public void RemoveWantedToken(string tokenName)
Parameters
Type | Name | Description |
|---|---|---|
| string | tokenName | Unwanted token. |
RequestWebLicense
Request License owned by user WEB account.
[HandleProcessCorruptedStateExceptions]public void RequestWebLicense(string login, string password, uint id)
Parameters
Type | Name | Description |
|---|---|---|
| string | login | WEB account login. |
| string | password | WEB account password. |
| uint | id | WEB license id. |
RetrieveWebLicenses
Retrieves License owned by user WEB account.
[HandleProcessCorruptedStateExceptions]public WebLicenseInfoList RetrieveWebLicenses(string login, string password)
Parameters
Returns
Type | Description |
|---|---|
| WebLicenseInfoList |
TokenValid
Returns True if a token is owned by the product, request will be done if missing.
[HandleProcessCorruptedStateExceptions]public bool TokenValid(string tokenName)
Parameters
Type | Name | Description |
|---|---|---|
| string | tokenName | Token name. |
Returns
Type | Description |
|---|---|
| bool |
ParallelAddJob
Add a job to a parallel session.
[HandleProcessCorruptedStateExceptions]public void ParallelAddJob(IntPtr session, CoreInterface.ParallelCallback jobCallback, IntPtr dataPtr)
Parameters
Type | Name | Description |
|---|---|---|
| IntPtr | session | |
| CoreInterface.ParallelCallback | jobCallback | |
| IntPtr | dataPtr |
ParallelFinish
Ends a parallel session after waiting for all jobs to finish.
[HandleProcessCorruptedStateExceptions]public void ParallelFinish(IntPtr session)
Parameters
Type | Name | Description |
|---|---|---|
| IntPtr | session |
ParallelStart
Starts a new parallel session.
[HandleProcessCorruptedStateExceptions]public IntPtr ParallelStart(bool progression = false, string name = "Parallel session", int jobCount = -1)
Parameters
Type | Name | Description |
|---|---|---|
| bool | progression | Enable progression for the parallel session. |
| string | name | Name of the parallel session. |
| int | jobCount | Count of parallel jobs if known (for progression). |
Returns
Type | Description |
|---|---|
| IntPtr |
GetModuleDescFromXML
Generate a ModuleDesc from an .xml description.
[HandleProcessCorruptedStateExceptions]public ModuleDesc GetModuleDescFromXML(string xmlPath, bool addToModules)
Parameters
Returns
Type | Description |
|---|---|
| ModuleDesc |
RemoveModule
Remove a module added via getModuleDescFromXML.
[HandleProcessCorruptedStateExceptions]public void RemoveModule(string module)
Parameters
Type | Name | Description |
|---|---|---|
| string | module | Module name. |
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
Type | Name | Description |
|---|---|---|
| int | stepCount | Step count. |
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
Type | Name | Description |
|---|---|---|
| EntityList | entities | Entities that support custom properties. |
| StringList | names | Name of the custom property for each entity. |
| StringList | values | Value of the custom property for each entity. |
| PropertyTypeList | types | Type of the custom property for each entity. |
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
Type | Name | Description |
|---|---|---|
| uint | entity | An entity that support custom properties. |
| string | name | Name of the custom property. |
| string | value | Value of the custom property. |
| PropertyType | type | Type of the custom property. |
GetModuleProperty
Returns the value of a module property.
[HandleProcessCorruptedStateExceptions]public string GetModuleProperty(string module, string propertyName)
Parameters
Returns
Type | Description |
|---|---|
| string |
GetModulePropertyInfo
Returns the value of a module property.
[HandleProcessCorruptedStateExceptions]public PropertyInfo GetModulePropertyInfo(string module, string propertyName)
Parameters
Returns
Type | Description |
|---|---|
| PropertyInfo |
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
Type | Name | Description |
|---|---|---|
| EntityList | entities | List of entities. |
| string | propertyName | The property name. |
| string | defaultValue | Default value to return if the property does not exist on an entity. |
Returns
Type | Description |
|---|---|
| StringList |
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
Type | Description |
|---|---|
| string |
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
Type | Description |
|---|---|
| PropertyInfo |
HasCustomProperty
Return true if the custom property was found on the occurrence.
[HandleProcessCorruptedStateExceptions]public bool HasCustomProperty(uint entityId, string customPropertyName)
Parameters
Type | Name | Description |
|---|---|---|
| uint | entityId | An entity that support properties. |
| string | customPropertyName | Name of the custom property. |
Returns
Type | Description |
|---|---|
| bool |
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
Type | Name | Description |
|---|---|---|
| uint | entity | An entity that support properties. |
| string | propertyName | Name of the property. |
Returns
Type | Description |
|---|---|
| bool |
ListEnumLabels
Returns the informations of a module property.
[HandleProcessCorruptedStateExceptions]public EnumPropertyInfo ListEnumLabels(int enumType)
Parameters
Type | Name | Description |
|---|---|---|
| int | enumType | The real enum type number (ie. The one return in subtype of PropertyInfo). |
Returns
Type | Description |
|---|---|
| EnumPropertyInfo |
ListModuleProperties
Returns all the properties in the given module.
[HandleProcessCorruptedStateExceptions]public PropertyInfoList ListModuleProperties(string module)
Parameters
Type | Name | Description |
|---|---|---|
| string | module | Name of the module. |
Returns
Type | Description |
|---|---|
| PropertyInfoList |
ListProperties
Returns the names and values of the properties available on an entity.
[HandleProcessCorruptedStateExceptions]public PropertyInfoList ListProperties(uint entity)
Parameters
Type | Name | Description |
|---|---|---|
| uint | entity | Entity to list. |
Returns
Type | Description |
|---|---|
| PropertyInfoList |
ListPropertiesBatch
Returns the names and values of the properties available on multiple entities.
[HandleProcessCorruptedStateExceptions]public PropertyInfoListList ListPropertiesBatch(EntityList entities)
Parameters
Type | Name | Description |
|---|---|---|
| EntityList | entities | Entities to list. |
Returns
Type | Description |
|---|---|
| PropertyInfoListList |
RemoveCustomProperty
Remove a custom property from an entity that support custom properties.
[HandleProcessCorruptedStateExceptions]public void RemoveCustomProperty(uint entity, string name)
Parameters
Type | Name | Description |
|---|---|---|
| uint | entity | An entity that support custom properties. |
| string | name | Name of the custom property. |
RestoreModulePropertyDefaultValue
Restore the default value of a module property.
[HandleProcessCorruptedStateExceptions]public string RestoreModulePropertyDefaultValue(string module, string propertyName)
Parameters
Returns
Type | Description |
|---|---|
| string |
SetModuleProperty
Set the value of a module property.
[HandleProcessCorruptedStateExceptions]public string SetModuleProperty(string module, string propertyName, string propertyValue)
Parameters
Type | Name | Description |
|---|---|---|
| string | module | Name of the module. |
| string | propertyName | The property name. |
| string | propertyValue | The property value. |
Returns
Type | Description |
|---|---|
| string |
SetProperties
Set multiple properties values on entities.
[HandleProcessCorruptedStateExceptions]public void SetProperties(EntityList entities, StringList propertyNames, StringList propertyValues)
Parameters
Type | Name | Description |
|---|---|---|
| EntityList | entities | List of entities. |
| StringList | propertyNames | The property name for each entity. |
| StringList | propertyValues | The property value for each entity. |
SetProperty
Set a property value on an entity.
[HandleProcessCorruptedStateExceptions]public string SetProperty(uint entity, string propertyName, string propertyValue)
Parameters
Type | Name | Description |
|---|---|---|
| uint | entity | The entity. |
| string | propertyName | The property name. |
| string | propertyValue | The property value. |
Returns
Type | Description |
|---|---|
| string |
SupportCustomProperties
Return true if an entity support custom properties.
[HandleProcessCorruptedStateExceptions]public bool SupportCustomProperties(uint entity)
Parameters
Type | Name | Description |
|---|---|---|
| uint | entity | An entity. |
Returns
Type | Description |
|---|---|
| bool |
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
Type | Name | Description |
|---|---|---|
| CoreInterface.AfterCustomPropertyAddedDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveAfterCustomPropertyAddedCallback
public void RemoveAfterCustomPropertyAddedCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AvailableMemory
Returns available memory.
[HandleProcessCorruptedStateExceptions]public AvailableMemoryReturn AvailableMemory()
Returns
Type | Description |
|---|---|
| AvailableMemoryReturn |
CheckForUpdates
Check for software update.
[HandleProcessCorruptedStateExceptions]public CheckForUpdatesReturn CheckForUpdates()
Returns
Type | Description |
|---|---|
| CheckForUpdatesReturn |
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
Type | Description |
|---|---|
| string |
GetMemoryUsagePeak
Returns the memory usage peak of the current process in MB ( only available on windows yet ).
[HandleProcessCorruptedStateExceptions]public long GetMemoryUsagePeak()
Returns
Type | Description |
|---|---|
| long |
GetPixyzWebsiteURL
Get the Pixyz website URL.
[HandleProcessCorruptedStateExceptions]public string GetPixyzWebsiteURL()
Returns
Type | Description |
|---|---|
| string |
GetProductName
Get the Pixyz product name.
[HandleProcessCorruptedStateExceptions]public string GetProductName()
Returns
Type | Description |
|---|---|
| string |
GetTempDirectory
Get the Pixyz temp directory (server side directory in case of remote access).
[HandleProcessCorruptedStateExceptions]public string GetTempDirectory()
Returns
Type | Description |
|---|---|
| string |
GetVersion
Get the Pixyz product version.
[HandleProcessCorruptedStateExceptions]public string GetVersion()
Returns
Type | Description |
|---|---|
| string |
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
Type | Name | Description |
|---|---|---|
| bool | deleteIfEmpty | If True, empty step with no modification will be deleted from the stack at the end. |
GetRedoStack
Get the history of actions stack.
[HandleProcessCorruptedStateExceptions]public StringList GetRedoStack()
Returns
Type | Description |
|---|---|
| StringList |
GetRedoStepUserData
Get user data for undo step #index.
[HandleProcessCorruptedStateExceptions]public string GetRedoStepUserData(uint index)
Parameters
Type | Name | Description |
|---|---|---|
| uint | index |
Returns
Type | Description |
|---|---|
| string |
GetUndoStack
Get the history of actions stack.
[HandleProcessCorruptedStateExceptions]public StringList GetUndoStack()
Returns
Type | Description |
|---|---|
| StringList |
GetUndoStepUserData
Get user data for undo step #index.
[HandleProcessCorruptedStateExceptions]public string GetUndoStepUserData(uint index)
Parameters
Type | Name | Description |
|---|---|---|
| uint | index |
Returns
Type | Description |
|---|---|
| string |
HasRecordingStep
Has recording step.
[HandleProcessCorruptedStateExceptions]public bool HasRecordingStep()
Returns
Type | Description |
|---|---|
| bool |
Redo
Redo some steps.
[HandleProcessCorruptedStateExceptions]public void Redo(uint count = 1)
Parameters
Type | Name | Description |
|---|---|---|
| uint | count |
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
Type | Name | Description |
|---|---|---|
| uint | count |
AddUndoRedoStackChangedCallback
public uint AddUndoRedoStackChangedCallback(CoreInterface.UndoRedoStackChangedDelegate callback, IntPtr userData)
Parameters
Type | Name | Description |
|---|---|---|
| CoreInterface.UndoRedoStackChangedDelegate | callback | |
| IntPtr | userData |
Returns
Type | Description |
|---|---|
| uint |
RemoveUndoRedoStackChangedCallback
public void RemoveUndoRedoStackChangedCallback(uint id)
Parameters
Type | Name | Description |
|---|---|---|
| uint | id |
AddConsoleVerbose
Add a console verbose level.
[HandleProcessCorruptedStateExceptions]public void AddConsoleVerbose(Verbose level)
Parameters
Type | Name | Description |
|---|---|---|
| Verbose | level | Verbose level. |
AddLogFileVerbose
Add a log file verbose level.
[HandleProcessCorruptedStateExceptions]public void AddLogFileVerbose(Verbose level)
Parameters
Type | Name | Description |
|---|---|---|
| Verbose | level | Verbose level. |
AddSessionLogFileVerbose
Add a session log file (lastSession{Id}.log) verbose level.
[HandleProcessCorruptedStateExceptions]public void AddSessionLogFileVerbose(Verbose level)
Parameters
Type | Name | Description |
|---|---|---|
| Verbose | level | Verbose level. |
ConfigureInterfaceLogger
Set new configuration for the Interface Logger.
[HandleProcessCorruptedStateExceptions]public void ConfigureInterfaceLogger(bool enableFunction, bool enableParameters, bool enableExecutionTime)
Parameters
Type | Name | Description |
|---|---|---|
| bool | enableFunction | If true, the called function names will be print. |
| bool | enableParameters | If true, the called function parameters will be print (only if enableFunction=true too). |
| bool | enableExecutionTime | If true, the called functions execution times will be print. |
GetInterfaceLoggerConfiguration
Get the current Interface Logger configuration.
[HandleProcessCorruptedStateExceptions]public GetInterfaceLoggerConfigurationReturn GetInterfaceLoggerConfiguration()
Returns
Type | Description |
|---|---|
| GetInterfaceLoggerConfigurationReturn |
GetLogFile
Get the path of the log file.
[HandleProcessCorruptedStateExceptions]public string GetLogFile()
Returns
Type | Description |
|---|---|
| string |
HasConsoleVerbose
Returns whether a console verbose level is present.
[HandleProcessCorruptedStateExceptions]public bool HasConsoleVerbose(Verbose level)
Parameters
Type | Name | Description |
|---|---|---|
| Verbose | level | Verbose level. |
Returns
Type | Description |
|---|---|
| bool |
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
Type | Name | Description |
|---|---|---|
| Verbose | level | Verbose level. |
RemoveLogFileVerbose
Remove a log file verbose level.
[HandleProcessCorruptedStateExceptions]public void RemoveLogFileVerbose(Verbose level)
Parameters
Type | Name | Description |
|---|---|---|
| Verbose | level | Verbose level. |
RemoveSessionLogFileVerbose
Remove a session log file (lastSession{Id}.log) verbose level.
[HandleProcessCorruptedStateExceptions]public void RemoveSessionLogFileVerbose(Verbose level)
Parameters
Type | Name | Description |
|---|---|---|
| Verbose | level | Verbose level. |
SetCoreDumpFile
Important
This function is tagged as experimental.
[HandleProcessCorruptedStateExceptions]public void SetCoreDumpFile(string path)
Parameters
Type | Name | Description |
|---|---|---|
| string | path | Path of the core dump file. |
SetLogFile
Set the path of the log file.
[HandleProcessCorruptedStateExceptions]public void SetLogFile(string path, bool keepHistory = false)
Parameters