Class Core

Inheritance
Core
Namespace:
Syntax

Methods

cloneEntity

Clone an entity

Declaration
core.cloneEntity(entity) -> core.Entity
Parameters
Type Name Description
Entity entity

The entity to clone
Returns
Type Description
Entity

The cloned entity

configureFunctionLogger

Declaration
core.configureFunctionLogger(functionName, enableFunction, enableParameters, enableExecutionTime)
Parameters
Type Name Description
String functionName
Boolean enableFunction
Boolean enableParameters
Boolean enableExecutionTime

createEntity

Create an entity

Declaration
core.createEntity(type) -> core.Entity
Parameters
Type Name Description
EntityType type

The type of entity to create
Returns
Type Description
Entity

The created entity id

deleteEntities

Delete a set of entities

Declaration
core.deleteEntities(entities)
Parameters
Type Name Description
EntityList entities

List of entity to delete

getEntitiesByType

get all entities of a given type

Declaration
core.getEntitiesByType(type, includeUnsubscribed) -> core.EntityList
Parameters
Type Name Description
EntityType type

The type of entities to retrieve
Boolean includeUnsubscribed

Include unsubscribed entities
Returns
Type Description
EntityList

The returned entity list

resetSession

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

Declaration
core.resetSession()

unsavedUserChanges

Returns true if the user has made changes to the project

Declaration
core.unsavedUserChanges() -> core.Bool
Returns
Type Description
Bool

Boolean checking if the project has been modified

getEvent

get EventDesc of an event

See also:

Declaration
core.getEvent(moduleName, eventName) -> core.EventDesc
Parameters
Type Name Description
String moduleName

Target module name
String eventName
Returns
Type Description
EventDesc

getEvents

get events of a group

See also:

Declaration
core.getEvents(moduleName, groupName) -> core.EventDescList
Parameters
Type Name Description
String moduleName

Target module name
String groupName

Target group name
Returns
Type Description
EventDescList

getFunction

get FunctionDesc of a function

See also:

Declaration
core.getFunction(moduleName, functionName) -> core.FunctionDesc
Parameters
Type Name Description
String moduleName

Target module name
String functionName

Target function name
Returns
Type Description
FunctionDesc

getFunctions

get functions of a group

See also:

Declaration
core.getFunctions(moduleName, groupName) -> core.FunctionDescList
Parameters
Type Name Description
String moduleName

Target module name
String groupName

Target group name
Returns
Type Description
FunctionDescList

getGroup

get a group desc from a specific module

See also:

Declaration
core.getGroup(moduleName, groupName) -> core.GroupDesc
Parameters
Type Name Description
String moduleName

Target module name
String groupName

Target group name
Returns
Type Description
GroupDesc

getGroups

get all group desc of a module

See also:

Declaration
core.getGroups(moduleName) -> core.GroupDescList
Parameters
Type Name Description
String moduleName

Target module name
Returns
Type Description
GroupDescList

getModuleTypes

get TypeDescList from a module name

See also:

Declaration
core.getModuleTypes(moduleName) -> core.TypeDescList
Parameters
Type Name Description
String moduleName

Target module name
Returns
Type Description
TypeDescList

getModules

get all modules desc

See also:

Declaration
core.getModules() -> core.ModuleDescList
Returns
Type Description
ModuleDescList

getModulesName

get all modules name

See also:

Declaration
core.getModulesName() -> core.StringList
Returns
Type Description
StringList

getType

get TypeDesc from a type name

See also:

Declaration
core.getType(moduleName, typeNameStr) -> core.TypeDesc
Parameters
Type Name Description
String moduleName

Target module name
String typeNameStr

Target type name
Returns
Type Description
TypeDesc

getTypeAttributes

get attributes TypeDesc from a type name

See also:

Declaration
core.getTypeAttributes(moduleName, typeNameStr) -> core.StringPairList
Parameters
Type Name Description
String moduleName

Target module name
String typeNameStr

Target type name
Returns
Type Description
StringPairList

askString

Invite the user to enter a string

See also:

Declaration
core.askString(msg, defaultValue) -> core.String
Parameters
Type Name Description
String msg

Message to display
String defaultValue

Message to display
Returns
Type Description
String

The string entered by the user

askYesNo

Ask a question which need a Yes/No answer

See also:

Declaration
core.askYesNo(question, defaultValue) -> core.Boolean
Parameters
Type Name Description
String question

Question to display
Boolean defaultValue

Default value (if interfactive mode is disabled)
Returns
Type Description
Boolean

True if the user say Yes, else False

choose

Invite the user to choose one value between multiple choice

See also:

Declaration
core.choose(message, values, defaultValue) -> core.Int
Parameters
Type Name Description
String message

Message to display
StringList values

Possible values to choose
Int defaultValue

Default value index
Returns
Type Description
Int

Index of the chosen value in the values list

defineCaptchaCallback

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

See also:

Declaration
core.defineCaptchaCallback(callback)
Parameters
Type Name Description
CaptchaCallback callback

The callback function

isInteractiveMode

Returns True if the script is in interactive mode, else returns false

See also:

Declaration
core.isInteractiveMode() -> core.Boolean
Returns
Type Description
Boolean

True if interactive, else false

message

Display a message (or a MessageBox in GUI)

See also:

Declaration
core.message(msg)
Parameters
Type Name Description
String msg

Message to display

setInteractiveMode

Switch between interactive mode and non-interactive mode, UI functions will no ask user on non-interactive mode and will return default values

See also:

Declaration
core.setInteractiveMode(interactive=True)
Parameters
Type Name Description
Boolean interactive

True if you want to enter interactive mode, else False

entityExists

returns true if the entity exists

See also:

Declaration
core.entityExists(entity) -> core.Boolean
Parameters
Type Name Description
Entity entity

The wanted entity
Returns
Type Description
Boolean

True if it exists.

getAllEntities

returns all the entities on the database

See also:

Declaration
core.getAllEntities() -> core.EntityList
Returns
Type Description
EntityList

All entities

getCurrentPiXYZFile

Get current (loaded) Pixyz file path

See also:

Declaration
core.getCurrentPiXYZFile() -> core.FilePath
Returns
Type Description
FilePath

The current Pixyz file

getEntityType

returns the type id of the entity

See also:

Declaration
core.getEntityType(entity) -> core.EntityType
Parameters
Type Name Description
Entity entity

The wanted entity
Returns
Type Description
EntityType

Type type of the entity

getEntityTypeString

returns the type name of the entity

See also:

Declaration
core.getEntityTypeString(entity) -> core.String
Parameters
Type Name Description
Entity entity

The wanted entity
Returns
Type Description
String

Name of the entity type

getTypeStats

Get the database stats

See also:

Declaration
core.getTypeStats() -> core.IntListList
Returns
Type Description
IntListList

isCurrentPiXYZFileModified

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

See also:

Declaration
core.isCurrentPiXYZFileModified() -> core.Boolean
Returns
Type Description
Boolean

True if the file is modified

load

Load a new scene

See also:

Declaration
core.load(fileName)
Parameters
Type Name Description
FilePath 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

See also:

Declaration
core.lockEntityRegistration()

save

Save the scene

See also:

Declaration
core.save(fileName)
Parameters
Type Name Description
OutputFilePath fileName

Path to save the file

unlockEntityRegistration

Unlock Entity registration

See also:

Declaration
core.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.

See also:

Declaration
core.addWantedToken(tokenName)
Parameters
Type Name Description
String tokenName

Wanted token

checkLicense

check the current license

See also:

Declaration
core.checkLicense() -> core.Boolean
Returns
Type Description
Boolean

checkWebLogin

Check if authentification on the Web license API is sucessfull

See also:

Declaration
core.checkWebLogin(login, password) -> core.Boolean
Parameters
Type Name Description
String login

WEB account login
Password password

WEB account password
Returns
Type Description
Boolean

configureLicenseServer

Configure the license server to use to get floating licenses

See also:

Declaration
core.configureLicenseServer(address, port, flexLM=True)
Parameters
Type Name Description
String address

Server address
UShort port

Server port
Boolean flexLM

Enable FlexLM license server

generateActivationCode

Create an activation code to generate an offline license

See also:

Declaration
core.generateActivationCode(filePath)
Parameters
Type Name Description
OutputFilePath filePath

Path to write the activation code

generateDeactivationCode

Create an deactivation code to release the license from this machine

See also:

Declaration
core.generateDeactivationCode(filePath)
Parameters
Type Name Description
OutputFilePath filePath

Path to write the deactivation code

getCurrentLicenseInfos

get information on current installed license

See also:

Declaration
core.getCurrentLicenseInfos() -> core.LicenseInfos
Returns
Type Description
LicenseInfos

getLicenseServer

Get current license server

See also:

Declaration
core.getLicenseServer() -> core.String, core.UShort, core.Bool
Returns
Type Description
String

Server host name or IP

installLicense

install a new license

See also:

Declaration
core.installLicense(licensePath)
Parameters
Type Name Description
FilePath licensePath

Path of the license file

listOwnedTokens

Get the list of actually owned license tokens

See also:

Declaration
core.listOwnedTokens() -> core.StringList
Returns
Type Description
StringList

Owned token list

listTokens

Get the list of license tokens for this product

See also:

Declaration
core.listTokens(onlyMandatory) -> core.StringList
Parameters
Type Name Description
Bool onlyMandatory

If True, optional tokens will not be returned
Returns
Type Description
StringList

Token list

listWantedTokens

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

See also:

Declaration
core.listWantedTokens() -> core.StringList
Returns
Type Description
StringList

Token list

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.

See also:

Declaration
core.needToken(tokenName)
Parameters
Type Name Description
String tokenName

Token name

ownToken

Returns True if we own a token, without requesting it

See also:

Declaration
core.ownToken(tokenName) -> core.Boolean
Parameters
Type Name Description
String tokenName

Token name
Returns
Type Description
Boolean

True if the token is owned

releaseToken

Release an optional license token

See also:

Declaration
core.releaseToken(tokenName)
Parameters
Type Name Description
String tokenName

Token name

releaseWebLicense

release License owned by user WEB account

See also:

Declaration
core.releaseWebLicense(login, password, id)
Parameters
Type Name Description
String login

WEB account login
Password password

WEB account password
Ident id

WEB license id

removeWantedToken

remove a license token from the list of wanted optional tokens

See also:

Declaration
core.removeWantedToken(tokenName)
Parameters
Type Name Description
String tokenName

Unwanted token

requestWebLicense

request License owned by user WEB account

See also:

Declaration
core.requestWebLicense(login, password, id)
Parameters
Type Name Description
String login

WEB account login
Password password

WEB account password
Ident id

WEB license id

retrieveWebLicenses

Retrieves License owned by user WEB account

See also:

Declaration
core.retrieveWebLicenses(login, password) -> core.WebLicenseInfoList
Parameters
Type Name Description
String login

WEB account login
Password password

WEB account password
Returns
Type Description
WebLicenseInfoList

tokenValid

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

See also:

Declaration
core.tokenValid(tokenName) -> core.Bool
Parameters
Type Name Description
String tokenName

Token name
Returns
Type Description
Bool

parallelAddJob

Add a job to a parallel session

See also:

Declaration
core.parallelAddJob(session, jobCallback, dataPtr)
Parameters
Type Name Description
ParallelSession session
ParallelCallback jobCallback
Ptr dataPtr

parallelFinish

Ends a parallel session after waiting for all jobs to finish

See also:

Declaration
core.parallelFinish(session)
Parameters
Type Name Description
ParallelSession session

parallelStart

Starts a new parallel session

See also:

Declaration
core.parallelStart(progression, name, jobCount) -> core.ParallelSession
Parameters
Type Name Description
Boolean 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
ParallelSession

getModuleDescFromXML

Generate a ModuleDesc from an .xml description

See also:

Declaration
core.getModuleDescFromXML(xmlPath, addToModules) -> core.ModuleDesc
Parameters
Type Name Description
FilePath xmlPath

.xml file path
Boolean addToModules
Returns
Type Description
ModuleDesc

removeModule

Remove a module added via getModuleDescFromXML

See also:

Declaration
core.removeModule(module)
Parameters
Type Name Description
String module

Module name

popProgression

Leave current progression level

See also:

Declaration
core.popProgression()

pushProgression

Create a new progression level

See also:

Declaration
core.pushProgression(stepCount, progressName="")
Parameters
Type Name Description
Int stepCount

Step count
String progressName

Name of the progression step

stepProgression

Add a step to current progression level

See also:

Declaration
core.stepProgression(stepCount=1)
Parameters
Type Name Description
Int stepCount

Step count

addCustomProperties

Add multiple custom property to entities that support custom properties

See also:

Declaration
core.addCustomProperties(entities, names, values, types)
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

See also:

Declaration
core.addCustomProperty(entity, name, value="", type=0)
Parameters
Type Name Description
Entity 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

See also:

Declaration
core.getModuleProperty(module, propertyName) -> core.String
Parameters
Type Name Description
String module

Name of the module
String propertyName

The property name
Returns
Type Description
String

The property value

getModulePropertyInfo

Returns the value of a module property

See also:

Declaration
core.getModulePropertyInfo(module, propertyName) -> core.PropertyInfo
Parameters
Type Name Description
String module

Name of the module
String propertyName

The property name
Returns
Type Description
PropertyInfo

The property info

getProperties

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

See also:

Declaration
core.getProperties(entities, propertyName, defaultValue) -> core.StringList
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

Property value on each entity

getProperty

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

See also:

Declaration
core.getProperty(entity, propertyName) -> core.String
Parameters
Type Name Description
Entity entity

The entity
String propertyName

The property name
Returns
Type Description
String

The property value as String

getPropertyInfo

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

See also:

Declaration
core.getPropertyInfo(entity, propertyName) -> core.PropertyInfo
Parameters
Type Name Description
Entity entity

The entity
String propertyName

The property name
Returns
Type Description
PropertyInfo

The property info

hasCustomProperty

Return true if the custom property was found on the occurrence

See also:

Declaration
core.hasCustomProperty(entityId, customPropertyName) -> core.Boolean
Parameters
Type Name Description
Entity entityId

An entity that support properties
String customPropertyName

Name of the custom property
Returns
Type Description
Boolean

True if the enity has the custom propery, else False

hasProperty

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

See also:

Declaration
core.hasProperty(entity, propertyName) -> core.Boolean
Parameters
Type Name Description
Entity entity

An entity that support properties
String propertyName

Name of the property
Returns
Type Description
Boolean

True if the entity has the property asked, else False

listEnumLabels

Returns the informations of a module property

See also:

Declaration
core.listEnumLabels(enumType) -> core.EnumPropertyInfo
Parameters
Type Name Description
Int enumType

The real enum type number (ie. The one return in subtype of PropertyInfo)
Returns
Type Description
EnumPropertyInfo

The enum property info

listModuleProperties

Returns all the properties in the given module

See also:

Declaration
core.listModuleProperties(module) -> core.PropertyInfoList
Parameters
Type Name Description
String module

Name of the module
Returns
Type Description
PropertyInfoList

List of module properties info

listProperties

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

See also:

Declaration
core.listProperties(entity) -> core.PropertyInfoList
Parameters
Type Name Description
Entity entity

Entity to list
Returns
Type Description
PropertyInfoList

List of available properties info

listPropertiesBatch

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

See also:

Declaration
core.listPropertiesBatch(entities) -> core.PropertyInfoListList
Parameters
Type Name Description
EntityList entities

Entities to list
Returns
Type Description
PropertyInfoListList

List of available properties info

removeCustomProperty

Remove a custom property from an entity that support custom properties

See also:

Declaration
core.removeCustomProperty(entity, name)
Parameters
Type Name Description
Entity entity

An entity that support custom properties
String name

Name of the custom property

restoreModulePropertyDefaultValue

Restore the default value of a module property

See also:

Declaration
core.restoreModulePropertyDefaultValue(module, propertyName) -> core.String
Parameters
Type Name Description
String module

Name of the module
String propertyName

The property name
Returns
Type Description
String

The property value as String

setModuleProperty

Set the value of a module property

See also:

Declaration
core.setModuleProperty(module, propertyName, propertyValue) -> core.String
Parameters
Type Name Description
String module

Name of the module
String propertyName

The property name
String propertyValue

The property value
Returns
Type Description
String

The property value as String

setProperties

Set multiple properties values on entities

See also:

Declaration
core.setProperties(entities, propertyNames, 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

See also:

Declaration
core.setProperty(entity, propertyName, propertyValue) -> core.String
Parameters
Type Name Description
Entity entity

The entity
String propertyName

The property name
String propertyValue

The property value
Returns
Type Description
String

The property value as String

supportCustomProperties

Return true if an entity support custom properties

See also:

Declaration
core.supportCustomProperties(entity) -> core.Boolean
Parameters
Type Name Description
Entity entity

An entity
Returns
Type Description
Boolean

True if the entity support custom properties, else False

unsetProperty

Unset an entity's property

See also:

Declaration
core.unsetProperty(entity, propertyName)
Parameters
Type Name Description
Entity entity

The entity
String propertyName

The property name

availableMemory

returns available memory

See also:

Declaration
core.availableMemory() -> core.Long, core.Long, core.Long, core.Long
Returns
Type Description
Long

Available virtual memory in bytes

checkForUpdates

check for software update

See also:

Declaration
core.checkForUpdates() -> core.Bool, core.String, core.String, core.String
Returns
Type Description
Bool

True if there is a new version available of this product

clearOtherTemporaryDirectories

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

See also:

Declaration
core.clearOtherTemporaryDirectories()

getCustomVersionTag

get the Pixyz custom version tag

See also:

Declaration
core.getCustomVersionTag() -> core.String
Returns
Type Description
String

getMemoryUsagePeak

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

See also:

Declaration
core.getMemoryUsagePeak() -> core.Long
Returns
Type Description
Long

Maximum physical memory used by the process until now (in MB)

getPixyzWebsiteURL

get the Pixyz website URL

See also:

Declaration
core.getPixyzWebsiteURL() -> core.String
Returns
Type Description
String

getProductName

get the Pixyz product name

See also:

Declaration
core.getProductName() -> core.String
Returns
Type Description
String

getTempDirectory

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

See also:

Declaration
core.getTempDirectory() -> core.String
Returns
Type Description
String

getVersion

get the Pixyz product version

See also:

Declaration
core.getVersion() -> core.String
Returns
Type Description
String

pushAnalytic

push custom analytic event (Only for authorized products)

See also:

Declaration
core.pushAnalytic(name, data="")
Parameters
Type Name Description
String name

Analytic event name
String data

Analytic event data

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.

See also:

Declaration
core.setCurrentThreadAsProcessThread()

clearUndoRedo

Clear undo/redo history

See also:

Declaration
core.clearUndoRedo()

endUndoRedoStep

End current undo/redo step

See also:

Declaration
core.endUndoRedoStep(deleteIfEmpty=True)
Parameters
Type Name Description
Boolean deleteIfEmpty

If True, empty step with no modification will be deleted from the stack at the end

getRedoStack

Get the history of actions stack

See also:

Declaration
core.getRedoStack() -> core.StringList
Returns
Type Description
StringList

getRedoStepUserData

Get user data for undo step #index

See also:

Declaration
core.getRedoStepUserData(index) -> core.String
Parameters
Type Name Description
UInt index
Returns
Type Description
String

getUndoStack

Get the history of actions stack

See also:

Declaration
core.getUndoStack() -> core.StringList
Returns
Type Description
StringList

getUndoStepUserData

Get user data for undo step #index

See also:

Declaration
core.getUndoStepUserData(index) -> core.String
Parameters
Type Name Description
UInt index
Returns
Type Description
String

hasRecordingStep

Has recording step

See also:

Declaration
core.hasRecordingStep() -> core.Boolean
Returns
Type Description
Boolean

True if there is recoding step, else False

redo

redo some steps

See also:

Declaration
core.redo(count=1)
Parameters
Type Name Description
UInt count

startUndoRedoStep

Start a new undo/redo step

See also:

Declaration
core.startUndoRedoStep(stepName, userData="")
Parameters
Type Name Description
String stepName
String userData

stopProcess

Stop process (works if there is recording step)

See also:

Declaration
core.stopProcess()

toggleUndoRedo

Toggle undo/redo

See also:

Declaration
core.toggleUndoRedo()

undo

undo some steps

See also:

Declaration
core.undo(count=1)
Parameters
Type Name Description
UInt count

addConsoleVerbose

add a console verbose level

See also:

Declaration
core.addConsoleVerbose(level)
Parameters
Type Name Description
Verbose level

Verbose level

addLogFileVerbose

add a log file verbose level

See also:

Declaration
core.addLogFileVerbose(level)
Parameters
Type Name Description
Verbose level

Verbose level

addSessionLogFileVerbose

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

See also:

Declaration
core.addSessionLogFileVerbose(level)
Parameters
Type Name Description
Verbose level

Verbose level

configureInterfaceLogger

Set new configuration for the Interface Logger

See also:

Declaration
core.configureInterfaceLogger(enableFunction=True, enableParameters=True, enableExecutionTime=True)
Parameters
Type Name Description
Boolean enableFunction

If true, the called function names will be print
Boolean enableParameters

If true, the called function parameters will be print (only if enableFunction=true too)
Boolean enableExecutionTime

If true, the called functions execution times will be print

getInterfaceLoggerConfiguration

Get the current Interface Logger configuration

See also:

Declaration
core.getInterfaceLoggerConfiguration() -> core.Boolean, core.Boolean, core.Boolean
Returns
Type Description
Boolean

True if the called function names are printed

getLogFile

get the path of the log file

See also:

Declaration
core.getLogFile() -> core.OutputFilePath
Returns
Type Description
OutputFilePath

Path of the log file

log

log a message to Pixyz output

See also:

Declaration
core.log(message, level)
Parameters
Type Name Description
String message

Message to log
Verbose level

Verbose level

removeConsoleVerbose

remove a console verbose level

See also:

Declaration
core.removeConsoleVerbose(level)
Parameters
Type Name Description
Verbose level

Verbose level

removeLogFileVerbose

remove a log file verbose level

See also:

Declaration
core.removeLogFileVerbose(level)
Parameters
Type Name Description
Verbose level

Verbose level

removeSessionLogFileVerbose

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

See also:

Declaration
core.removeSessionLogFileVerbose(level)
Parameters
Type Name Description
Verbose level

Verbose level

setCoreDumpFile

set the path of the core dump file that will be written when a crash occurs (default=none)

Warning

This function is tagged as EXPERIMENTAL.

See also:

Declaration
core.setCoreDumpFile(path)
Parameters
Type Name Description
OutputFilePath path

Path of the core dump file

setLogFile

set the path of the log file

See also:

Declaration
core.setLogFile(path)
Parameters
Type Name Description
OutputFilePath path

Path of the log file

AfterEntityPropertyChanged

Declaration
def onAfterEntityPropertyChanged(entity, property, entityType):
    pass


id = core.addAfterEntityPropertyChangedCallback(onAfterEntityPropertyChanged)


...


core.removeAfterEntityPropertyChangedCallback(id)
Parameters
Type Name Description
Entity entity

Entity changed
String property

Property changed
Int entityType

Type of the entity changed

AfterModulePropertyChanged

Declaration
def onAfterModulePropertyChanged(module, property):
    pass


id = core.addAfterModulePropertyChangedCallback(onAfterModulePropertyChanged)


...


core.removeAfterModulePropertyChangedCallback(id)
Parameters
Type Name Description
String module

Module changed
String property

Property changed

AfterUndoRedo

Declaration
def onAfterUndoRedo():
    pass


id = core.addAfterUndoRedoCallback(onAfterUndoRedo)


...


core.removeAfterUndoRedoCallback(id)

AtExit

Declaration
def onAtExit():
    pass


id = core.addAtExitCallback(onAtExit)


...


core.removeAtExitCallback(id)

BeforeEntityPropertyChanged

Declaration
def onBeforeEntityPropertyChanged(entity, property):
    pass


id = core.addBeforeEntityPropertyChangedCallback(onBeforeEntityPropertyChanged)


...


core.removeBeforeEntityPropertyChangedCallback(id)
Parameters
Type Name Description
Entity entity

Entity changed
String property

Property changed

BeforeModulePropertyChanged

Declaration
def onBeforeModulePropertyChanged(module, property):
    pass


id = core.addBeforeModulePropertyChangedCallback(onBeforeModulePropertyChanged)


...


core.removeBeforeModulePropertyChangedCallback(id)
Parameters
Type Name Description
String module

Module changed
String property

Property changed

BeforeSessionReset

Declaration
def onBeforeSessionReset():
    pass


id = core.addBeforeSessionResetCallback(onBeforeSessionReset)


...


core.removeBeforeSessionResetCallback(id)

BeforeUndoRedo

Declaration
def onBeforeUndoRedo():
    pass


id = core.addBeforeUndoRedoCallback(onBeforeUndoRedo)


...


core.removeBeforeUndoRedoCallback(id)

CurrentFileChanged

Declaration
def onCurrentFileChanged():
    pass


id = core.addCurrentFileChangedCallback(onCurrentFileChanged)


...


core.removeCurrentFileChangedCallback(id)

EnteringUnsafeMode

Declaration
def onEnteringUnsafeMode():
    pass


id = core.addEnteringUnsafeModeCallback(onEnteringUnsafeMode)


...


core.removeEnteringUnsafeModeCallback(id)

LeavingUnsafeMode

Declaration
def onLeavingUnsafeMode():
    pass


id = core.addLeavingUnsafeModeCallback(onLeavingUnsafeMode)


...


core.removeLeavingUnsafeModeCallback(id)

OnConsoleMessage

Declaration
def onOnConsoleMessage(text, verboseLevel):
    pass


id = core.addOnConsoleMessageCallback(onOnConsoleMessage)


...


core.removeOnConsoleMessageCallback(id)
Parameters
Type Name Description
String text

Message content
Verbose verboseLevel

Verbose level

OnSessionReset

Declaration
def onOnSessionReset():
    pass


id = core.addOnSessionResetCallback(onOnSessionReset)


...


core.removeOnSessionResetCallback(id)

ProgressChanged

Declaration
def onProgressChanged(progress):
    pass


id = core.addProgressChangedCallback(onProgressChanged)


...


core.removeProgressChangedCallback(id)
Parameters
Type Name Description
Int progress

Current progression

ProgressStepFinished

Declaration
def onProgressStepFinished():
    pass


id = core.addProgressStepFinishedCallback(onProgressStepFinished)


...


core.removeProgressStepFinishedCallback(id)

ProgressStepStart

Declaration
def onProgressStepStart(stepName):
    pass


id = core.addProgressStepStartCallback(onProgressStepStart)


...


core.removeProgressStepStartCallback(id)
Parameters
Type Name Description
String stepName

Name of the started step

DebugEvent

Declaration
def onDebugEvent(event_type):
    pass


id = core.addDebugEventCallback(onDebugEvent)


...


core.removeDebugEventCallback(id)
Parameters
Type Name Description
Int event_type

The type of signal to emit

AfterCustomPropertyAdded

Declaration
def onAfterCustomPropertyAdded(entity, property, entityType):
    pass


id = core.addAfterCustomPropertyAddedCallback(onAfterCustomPropertyAdded)


...


core.removeAfterCustomPropertyAddedCallback(id)
Parameters
Type Name Description
Entity entity

Entity with custom property
String property

Custom property that has been added
Int entityType

Type of the entity

UndoRedoStackChanged

Declaration
def onUndoRedoStackChanged():
    pass


id = core.addUndoRedoStackChangedCallback(onUndoRedoStackChanged)


...


core.removeUndoRedoStackChangedCallback(id)