Class CoreInterface

Inheritance

object

Interface

CoreInterface

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEngine.Pixyz.Core

Syntax

public class CoreInterface : Interface

Fields

Epsilon

Declaration

public const double Epsilon = 1E-06

Field Value

Type	Description
double

EpsilonSquare

Declaration

public const double EpsilonSquare = 1E-12

Field Value

Type	Description
double

HalfPi

Declaration

public const double HalfPi = 1.5707963267948966

Field Value

Type	Description
double

Infinity

Declaration

public const double Infinity = 1000000000000

Field Value

Type	Description
double

OneDegree

Declaration

public const double OneDegree = 0.017453292519943295

Field Value

Type	Description
double

Pi

Declaration

public const double Pi = 3.141592653589793

Field Value

Type	Description
double

TwoPi

Declaration

public const double TwoPi = 6.283185307179586

Field Value

Type	Description
double

Methods

AddAfterCustomPropertyAddedCallback(AfterCustomPropertyAddedDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.AfterCustomPropertyAddedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddAfterEntityPropertyChangedCallback(AfterEntityPropertyChangedDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.AfterEntityPropertyChangedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddAfterModulePropertyChangedCallback(AfterModulePropertyChangedDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.AfterModulePropertyChangedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddAfterUndoRedoCallback(AfterUndoRedoDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.AfterUndoRedoDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddAtExitCallback(AtExitDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.AtExitDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddBeforeEntityPropertyChangedCallback(BeforeEntityPropertyChangedDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.BeforeEntityPropertyChangedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddBeforeModulePropertyChangedCallback(BeforeModulePropertyChangedDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.BeforeModulePropertyChangedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddBeforeSessionResetCallback(BeforeSessionResetDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.BeforeSessionResetDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddBeforeUndoRedoCallback(BeforeUndoRedoDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.BeforeUndoRedoDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddConsoleVerbose(Verbose)

add a console verbose level

Declaration

[HandleProcessCorruptedStateExceptions]
public void AddConsoleVerbose(Verbose level)

Parameters

Type	Name	Description
Verbose	level	Verbose level

AddCurrentFileChangedCallback(CurrentFileChangedDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.CurrentFileChangedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddCustomProperties(EntityList, StringList, StringList, PropertyTypeList)

Add multiple custom property to entities that support custom properties

Declaration

[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(uint, string, string, PropertyType)

Add a custom property to an entity that support custom properties

Declaration

[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

AddDebugEventCallback(DebugEventDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.DebugEventDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddEnteringUnsafeModeCallback(EnteringUnsafeModeDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.EnteringUnsafeModeDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddLeavingUnsafeModeCallback(LeavingUnsafeModeDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.LeavingUnsafeModeDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddLogFileVerbose(Verbose)

add a log file verbose level

Declaration

[HandleProcessCorruptedStateExceptions]
public void AddLogFileVerbose(Verbose level)

Parameters

Type	Name	Description
Verbose	level	Verbose level

AddOnConsoleMessageCallback(OnConsoleMessageDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.OnConsoleMessageDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddOnSessionResetCallback(OnSessionResetDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.OnSessionResetDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddProgressChangedCallback(ProgressChangedDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.ProgressChangedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddProgressStepFinishedCallback(ProgressStepFinishedDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.ProgressStepFinishedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddProgressStepStartCallback(ProgressStepStartDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.ProgressStepStartDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

AddSessionLogFileVerbose(Verbose)

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

Declaration

[HandleProcessCorruptedStateExceptions]
public void AddSessionLogFileVerbose(Verbose level)

Parameters

Type	Name	Description
Verbose	level	Verbose level

AddUndoRedoStackChangedCallback(UndoRedoStackChangedDelegate, IntPtr)

Declaration

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

Parameters

Type	Name	Description
CoreInterface.UndoRedoStackChangedDelegate	callback
IntPtr	userData

Returns

Type	Description
uint

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.

Declaration

[HandleProcessCorruptedStateExceptions]
public void AddWantedToken(string tokenName)

Parameters

Type	Name	Description
string	tokenName	Wanted token

AvailableMemory()

returns available memory

Declaration

[HandleProcessCorruptedStateExceptions]
public AvailableMemoryReturn AvailableMemory()

Returns

Type	Description
AvailableMemoryReturn

CheckForUpdates()

check for software update

Declaration

[HandleProcessCorruptedStateExceptions]
public CheckForUpdatesReturn CheckForUpdates()

Returns

Type	Description
CheckForUpdatesReturn

CheckLicense()

check the current license

Declaration

[HandleProcessCorruptedStateExceptions]
public bool CheckLicense()

Returns

Type	Description
bool

CheckWebLogin(string, string)

Check if authentification on the Web license API is sucessfull

Declaration

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

Parameters

Type	Name	Description
string	login	WEB account login
string	password	WEB account password

Returns

Type	Description
bool

ClearOtherTemporaryDirectories()

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

Declaration

[HandleProcessCorruptedStateExceptions]
public void ClearOtherTemporaryDirectories()

ClearUndoRedo()

Clear undo/redo history

Declaration

[HandleProcessCorruptedStateExceptions]
public void ClearUndoRedo()

CloneEntity(uint)

Clone an entity

Declaration

[HandleProcessCorruptedStateExceptions]
public uint CloneEntity(uint entity)

Parameters

Type	Name	Description
uint	entity	The entity to clone

Returns

Type	Description
uint

ConfigureFunctionLogger(string, bool, bool, bool)

Declaration

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

Parameters

Type	Name	Description
string	functionName
bool	enableFunction
bool	enableParameters
bool	enableExecutionTime

ConfigureInterfaceLogger(bool, bool, bool)

Set new configuration for the Interface Logger

Declaration

[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

ConfigureLicenseServer(string, ushort, bool)

Configure the license server to use to get floating licenses

Declaration

[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

CreateEntity(uint)

Create an entity

Declaration

[HandleProcessCorruptedStateExceptions]
public uint CreateEntity(uint type)

Parameters

Type	Name	Description
uint	type	The type of entity to create

Returns

Type	Description
uint

DefineCaptchaCallback(CaptchaCallback)

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

Declaration

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

Parameters

Type	Name	Description
CoreInterface.CaptchaCallback	callback	The callback function

DeleteEntities(EntityList)

Delete a set of entities

Declaration

[HandleProcessCorruptedStateExceptions]
public void DeleteEntities(EntityList entities)

Parameters

Type	Name	Description
EntityList	entities	List of entity to delete

EndUndoRedoStep(bool)

End current undo/redo step

Declaration

[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

EntityExists(uint)

returns true if the entity exists

Declaration

[HandleProcessCorruptedStateExceptions]
public bool EntityExists(uint entity)

Parameters

Type	Name	Description
uint	entity	The wanted entity

Returns

Type	Description
bool

GenerateActivationCode(string)

Create an activation code to generate an offline license

Declaration

[HandleProcessCorruptedStateExceptions]
public void GenerateActivationCode(string filePath)

Parameters

Type	Name	Description
string	filePath	Path to write the activation code

GenerateDeactivationCode(string)

Create an deactivation code to release the license from this machine

Declaration

[HandleProcessCorruptedStateExceptions]
public void GenerateDeactivationCode(string filePath)

Parameters

Type	Name	Description
string	filePath	Path to write the deactivation code

GetAllEntities()

returns all the entities on the database

Declaration

[HandleProcessCorruptedStateExceptions]
public EntityList GetAllEntities()

Returns

Type	Description
EntityList

GetCurrentLicenseInfos()

get information on current installed license

Declaration

[HandleProcessCorruptedStateExceptions]
public LicenseInfos GetCurrentLicenseInfos()

Returns

Type	Description
LicenseInfos

GetCurrentPiXYZFile()

Get current (loaded) Pixyz file path

Declaration

[HandleProcessCorruptedStateExceptions]
public string GetCurrentPiXYZFile()

Returns

Type	Description
string

GetCustomVersionTag()

get the Pixyz custom version tag

Declaration

[HandleProcessCorruptedStateExceptions]
public string GetCustomVersionTag()

Returns

Type	Description
string

GetEntitiesByType(uint, bool)

get all entities of a given type

Declaration

[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

GetEntityType(uint)

returns the type id of the entity

Declaration

[HandleProcessCorruptedStateExceptions]
public uint GetEntityType(uint entity)

Parameters

Type	Name	Description
uint	entity	The wanted entity

Returns

Type	Description
uint

GetEntityTypeString(uint)

returns the type name of the entity

Declaration

[HandleProcessCorruptedStateExceptions]
public string GetEntityTypeString(uint entity)

Parameters

Type	Name	Description
uint	entity	The wanted entity

Returns

Type	Description
string

GetEvent(string, string)

get EventDesc of an event

Declaration

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

Parameters

Type	Name	Description
string	moduleName	Target module name
string	eventName

Returns

Type	Description
EventDesc

GetEvents(string, string)

get events of a group

Declaration

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

Parameters

Type	Name	Description
string	moduleName	Target module name
string	groupName	Target group name

Returns

Type	Description
EventDescList

GetFunction(string, string)

get FunctionDesc of a function

Declaration

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

Parameters

Type	Name	Description
string	moduleName	Target module name
string	functionName	Target function name

Returns

Type	Description
FunctionDesc

GetFunctions(string, string)

get functions of a group

Declaration

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

Parameters

Type	Name	Description
string	moduleName	Target module name
string	groupName	Target group name

Returns

Type	Description
FunctionDescList

GetGroup(string, string)

get a group desc from a specific module

Declaration

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

Parameters

Type	Name	Description
string	moduleName	Target module name
string	groupName	Target group name

Returns

Type	Description
GroupDesc

GetGroups(string)

get all group desc of a module

Declaration

[HandleProcessCorruptedStateExceptions]
public GroupDescList GetGroups(string moduleName)

Parameters

Type	Name	Description
string	moduleName	Target module name

Returns

Type	Description
GroupDescList

GetInterfaceLoggerConfiguration()

Get the current Interface Logger configuration

Declaration

[HandleProcessCorruptedStateExceptions]
public GetInterfaceLoggerConfigurationReturn GetInterfaceLoggerConfiguration()

Returns

Type	Description
GetInterfaceLoggerConfigurationReturn

GetLastError()

Declaration

public static string GetLastError()

Returns

Type	Description
string

GetLicenseError()

get errors from license check

Declaration

[HandleProcessCorruptedStateExceptions]
public GetLicenseErrorReturn GetLicenseError()

Returns

Type	Description
GetLicenseErrorReturn

GetLicenseServer()

Get current license server

Declaration

[HandleProcessCorruptedStateExceptions]
public GetLicenseServerReturn GetLicenseServer()

Returns

Type	Description
GetLicenseServerReturn

GetLogFile()

get the path of the log file

Declaration

[HandleProcessCorruptedStateExceptions]
public string GetLogFile()

Returns

Type	Description
string

GetMemoryUsagePeak()

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

Declaration

[HandleProcessCorruptedStateExceptions]
public long GetMemoryUsagePeak()

Returns

Type	Description
long

GetModuleDescFromXML(string, bool)

Generate a ModuleDesc from an .xml description

Declaration

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

Parameters

Type	Name	Description
string	xmlPath	.xml file path
bool	addToModules

Returns

Type	Description
ModuleDesc

GetModuleProperty(string, string)

Returns the value of a module property

Declaration

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

Parameters

Type	Name	Description
string	module	Name of the module
string	propertyName	The property name

Returns

Type	Description
string

GetModulePropertyInfo(string, string)

Returns the value of a module property

Declaration

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

Parameters

Type	Name	Description
string	module	Name of the module
string	propertyName	The property name

Returns

Type	Description
PropertyInfo

GetModuleTypes(string)

get TypeDescList from a module name

Declaration

[HandleProcessCorruptedStateExceptions]
public TypeDescList GetModuleTypes(string moduleName)

Parameters

Type	Name	Description
string	moduleName	Target module name

Returns

Type	Description
TypeDescList

GetModules()

get all modules desc

Declaration

[HandleProcessCorruptedStateExceptions]
public ModuleDescList GetModules()

Returns

Type	Description
ModuleDescList

GetModulesName()

get all modules name

Declaration

[HandleProcessCorruptedStateExceptions]
public StringList GetModulesName()

Returns

Type	Description
StringList

GetPixyzWebsiteURL()

get the Pixyz website URL

Declaration

[HandleProcessCorruptedStateExceptions]
public string GetPixyzWebsiteURL()

Returns

Type	Description
string

GetProductName()

get the Pixyz product name

Declaration

[HandleProcessCorruptedStateExceptions]
public string GetProductName()

Returns

Type	Description
string

GetProperties(EntityList, string, string)

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

Declaration

[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(uint, string)

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

Declaration

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

Parameters

Type	Name	Description
uint	entity	The entity
string	propertyName	The property name

Returns

Type	Description
string

GetPropertyInfo(uint, string)

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

Declaration

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

Parameters

Type	Name	Description
uint	entity	The entity
string	propertyName	The property name

Returns

Type	Description
PropertyInfo

GetRedoStack()

Get the history of actions stack

Declaration

[HandleProcessCorruptedStateExceptions]
public StringList GetRedoStack()

Returns

Type	Description
StringList

GetRedoStepUserData(uint)

Get user data for undo step #index

Declaration

[HandleProcessCorruptedStateExceptions]
public string GetRedoStepUserData(uint index)

Parameters

Type	Name	Description
uint	index

Returns

Type	Description
string

GetTempDirectory()

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

Declaration

[HandleProcessCorruptedStateExceptions]
public string GetTempDirectory()

Returns

Type	Description
string

GetType(string, string)

get TypeDesc from a type name

Declaration

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

Parameters

Type	Name	Description
string	moduleName	Target module name
string	typeNameStr	Target type name

Returns

Type	Description
TypeDesc

GetTypeAttributes(string, string)

get attributes TypeDesc from a type name

Declaration

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

Parameters

Type	Name	Description
string	moduleName	Target module name
string	typeNameStr	Target type name

Returns

Type	Description
StringPairList

GetTypeStats()

Get the database stats

Declaration

[HandleProcessCorruptedStateExceptions]
public IntListList GetTypeStats()

Returns

Type	Description
IntListList

GetUndoStack()

Get the history of actions stack

Declaration

[HandleProcessCorruptedStateExceptions]
public StringList GetUndoStack()

Returns

Type	Description
StringList

GetUndoStepUserData(uint)

Get user data for undo step #index

Declaration

[HandleProcessCorruptedStateExceptions]
public string GetUndoStepUserData(uint index)

Parameters

Type	Name	Description
uint	index

Returns

Type	Description
string

GetVersion()

get the Pixyz product version

Declaration

[HandleProcessCorruptedStateExceptions]
public string GetVersion()

Returns

Type	Description
string

HasCustomProperty(uint, string)

Return true if the custom property was found on the occurrence

Declaration

[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(uint, string)

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

Declaration

[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

HasRecordingStep()

Has recording step

Declaration

[HandleProcessCorruptedStateExceptions]
public bool HasRecordingStep()

Returns

Type	Description
bool

InstallLicense(string)

install a new license

Declaration

[HandleProcessCorruptedStateExceptions]
public void InstallLicense(string licensePath)

Parameters

Type	Name	Description
string	licensePath	Path of the license file

IsCurrentPiXYZFileModified()

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

Declaration

[HandleProcessCorruptedStateExceptions]
public bool IsCurrentPiXYZFileModified()

Returns

Type	Description
bool

ListEnumLabels(int)

Returns the informations of a module property

Declaration

[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(string)

Returns all the properties in the given module

Declaration

[HandleProcessCorruptedStateExceptions]
public PropertyInfoList ListModuleProperties(string module)

Parameters

Type	Name	Description
string	module	Name of the module

Returns

Type	Description
PropertyInfoList

ListOwnedTokens()

Get the list of actually owned license tokens

Declaration

[HandleProcessCorruptedStateExceptions]
public StringList ListOwnedTokens()

Returns

Type	Description
StringList

ListProperties(uint)

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

Declaration

[HandleProcessCorruptedStateExceptions]
public PropertyInfoList ListProperties(uint entity)

Parameters

Type	Name	Description
uint	entity	Entity to list

Returns

Type	Description
PropertyInfoList

ListPropertiesBatch(EntityList)

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

Declaration

[HandleProcessCorruptedStateExceptions]
public PropertyInfoListList ListPropertiesBatch(EntityList entities)

Parameters

Type	Name	Description
EntityList	entities	Entities to list

Returns

Type	Description
PropertyInfoListList

ListTokens(bool)

Get the list of license tokens for this product

Declaration

[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

Declaration

[HandleProcessCorruptedStateExceptions]
public StringList ListWantedTokens()

Returns

Type	Description
StringList

Load(string)

Load a new scene

Declaration

[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

Declaration

[HandleProcessCorruptedStateExceptions]
public void LockEntityRegistration()

Log(string, Verbose)

log a message to Pixyz output

Declaration

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

Parameters

Type	Name	Description
string	message	Message to log
Verbose	level	Verbose level

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.

Declaration

[HandleProcessCorruptedStateExceptions]
public void NeedToken(string tokenName)

Parameters

Type	Name	Description
string	tokenName	Token name

OwnToken(string)

Returns True if we own a token, without requesting it

Declaration

[HandleProcessCorruptedStateExceptions]
public bool OwnToken(string tokenName)

Parameters

Type	Name	Description
string	tokenName	Token name

Returns

Type	Description
bool

ParallelAddJob(IntPtr, ParallelCallback, IntPtr)

Add a job to a parallel session

Declaration

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

Parameters

Type	Name	Description
IntPtr	session
CoreInterface.ParallelCallback	jobCallback
IntPtr	dataPtr

ParallelFinish(IntPtr)

Ends a parallel session after waiting for all jobs to finish

Declaration

[HandleProcessCorruptedStateExceptions]
public void ParallelFinish(IntPtr session)

Parameters

Type	Name	Description
IntPtr	session

ParallelStart(bool, string, int)

Starts a new parallel session

Declaration

[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

PopProgression()

Leave current progression level

Declaration

[HandleProcessCorruptedStateExceptions]
public void PopProgression()

PushProgression(int, string)

Create a new progression level

Declaration

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

Parameters

Type	Name	Description
int	stepCount	Step count
string	progressName	Name of the progression step

Redo(uint)

redo some steps

Declaration

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

Parameters

Type	Name	Description
uint	count

ReleaseToken(string)

Release an optional license token

Declaration

[HandleProcessCorruptedStateExceptions]
public void ReleaseToken(string tokenName)

Parameters

Type	Name	Description
string	tokenName	Token name

ReleaseWebLicense(string, string, uint)

release License owned by user WEB account

Declaration

[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

RemoveAfterCustomPropertyAddedCallback(uint)

Declaration

public void RemoveAfterCustomPropertyAddedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveAfterEntityPropertyChangedCallback(uint)

Declaration

public void RemoveAfterEntityPropertyChangedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveAfterModulePropertyChangedCallback(uint)

Declaration

public void RemoveAfterModulePropertyChangedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveAfterUndoRedoCallback(uint)

Declaration

public void RemoveAfterUndoRedoCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveAtExitCallback(uint)

Declaration

public void RemoveAtExitCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveBeforeEntityPropertyChangedCallback(uint)

Declaration

public void RemoveBeforeEntityPropertyChangedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveBeforeModulePropertyChangedCallback(uint)

Declaration

public void RemoveBeforeModulePropertyChangedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveBeforeSessionResetCallback(uint)

Declaration

public void RemoveBeforeSessionResetCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveBeforeUndoRedoCallback(uint)

Declaration

public void RemoveBeforeUndoRedoCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveConsoleVerbose(Verbose)

remove a console verbose level

Declaration

[HandleProcessCorruptedStateExceptions]
public void RemoveConsoleVerbose(Verbose level)

Parameters

Type	Name	Description
Verbose	level	Verbose level

RemoveCurrentFileChangedCallback(uint)

Declaration

public void RemoveCurrentFileChangedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveCustomProperty(uint, string)

Remove a custom property from an entity that support custom properties

Declaration

[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

RemoveDebugEventCallback(uint)

Declaration

public void RemoveDebugEventCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveEnteringUnsafeModeCallback(uint)

Declaration

public void RemoveEnteringUnsafeModeCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveLeavingUnsafeModeCallback(uint)

Declaration

public void RemoveLeavingUnsafeModeCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveLogFileVerbose(Verbose)

remove a log file verbose level

Declaration

[HandleProcessCorruptedStateExceptions]
public void RemoveLogFileVerbose(Verbose level)

Parameters

Type	Name	Description
Verbose	level	Verbose level

RemoveModule(string)

Remove a module added via getModuleDescFromXML

Declaration

[HandleProcessCorruptedStateExceptions]
public void RemoveModule(string module)

Parameters

Type	Name	Description
string	module	Module name

RemoveOnConsoleMessageCallback(uint)

Declaration

public void RemoveOnConsoleMessageCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveOnSessionResetCallback(uint)

Declaration

public void RemoveOnSessionResetCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveProgressChangedCallback(uint)

Declaration

public void RemoveProgressChangedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveProgressStepFinishedCallback(uint)

Declaration

public void RemoveProgressStepFinishedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveProgressStepStartCallback(uint)

Declaration

public void RemoveProgressStepStartCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveSessionLogFileVerbose(Verbose)

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

Declaration

[HandleProcessCorruptedStateExceptions]
public void RemoveSessionLogFileVerbose(Verbose level)

Parameters

Type	Name	Description
Verbose	level	Verbose level

RemoveUndoRedoStackChangedCallback(uint)

Declaration

public void RemoveUndoRedoStackChangedCallback(uint id)

Parameters

Type	Name	Description
uint	id

RemoveWantedToken(string)

remove a license token from the list of wanted optional tokens

Declaration

[HandleProcessCorruptedStateExceptions]
public void RemoveWantedToken(string tokenName)

Parameters

Type	Name	Description
string	tokenName	Unwanted token

RequestWebLicense(string, string, uint)

request License owned by user WEB account

Declaration

[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

ResetSession()

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

Declaration

[HandleProcessCorruptedStateExceptions]
public void ResetSession()

RestoreModulePropertyDefaultValue(string, string)

Restore the default value of a module property

Declaration

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

Parameters

Type	Name	Description
string	module	Name of the module
string	propertyName	The property name

Returns

Type	Description
string

RetrieveWebLicenses(string, string)

Retrieves License owned by user WEB account

Declaration

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

Parameters

Type	Name	Description
string	login	WEB account login
string	password	WEB account password

Returns

Type	Description
WebLicenseInfoList

Save(string)

Save the scene

Declaration

[HandleProcessCorruptedStateExceptions]
public void Save(string fileName)

Parameters

Type	Name	Description
string	fileName	Path to save the file

SetCoreDumpFile(string)

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)

Declaration

[HandleProcessCorruptedStateExceptions]
public void SetCoreDumpFile(string path)

Parameters

Type	Name	Description
string	path	Path of the core dump file

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.

Declaration

[HandleProcessCorruptedStateExceptions]
public void SetCurrentThreadAsProcessThread()

SetLogFile(string, bool)

set the path of the log file

Declaration

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

Parameters

Type	Name	Description
string	path	Path of the log file
bool	keepHistory	Keep session log history in new log file.

SetModuleProperty(string, string, string)

Set the value of a module property

Declaration

[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(EntityList, StringList, StringList)

Set multiple properties values on entities

Declaration

[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(uint, string, string)

Set a property value on an entity

Declaration

[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

StartUndoRedoStep(string, string)

Start a new undo/redo step

Declaration

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

Parameters

Type	Name	Description
string	stepName
string	userData

StepProgression(int)

Add a step to current progression level

Declaration

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

Parameters

Type	Name	Description
int	stepCount	Step count

StopProcess()

Stop process (works if there is recording step)

Declaration

[HandleProcessCorruptedStateExceptions]
public void StopProcess()

SupportCustomProperties(uint)

Return true if an entity support custom properties

Declaration

[HandleProcessCorruptedStateExceptions]
public bool SupportCustomProperties(uint entity)

Parameters

Type	Name	Description
uint	entity	An entity

Returns

Type	Description
bool

ToggleUndoRedo()

Toggle undo/redo

Declaration

[HandleProcessCorruptedStateExceptions]
public void ToggleUndoRedo()

TokenValid(string)

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

Declaration

[HandleProcessCorruptedStateExceptions]
public bool TokenValid(string tokenName)

Parameters

Type	Name	Description
string	tokenName	Token name

Returns

Type	Description
bool

Undo(uint)

undo some steps

Declaration

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

Parameters

Type	Name	Description
uint	count

UnlockEntityRegistration()

Unlock Entity registration

Declaration

[HandleProcessCorruptedStateExceptions]
public void UnlockEntityRegistration()

UnsavedUserChanges()

Returns true if the user has made changes to the project

Declaration

[HandleProcessCorruptedStateExceptions]
public bool UnsavedUserChanges()

Returns

Type	Description
bool

UnsetProperty(uint, string)

Unset an entity's property

Declaration

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

Parameters

Type	Name	Description
uint	entity	The entity
string	propertyName	The property name