The main application object.

More...

Inherits :

• QObject

Derived from QApplication, this class embodies the main event loop, and owns application-wide settings and objects not directly related to the user interface.

Can be directly accessed using the global variable App.

---

: GraphicsMode

The current graphical systems available in the application.

• NoInterface - No interface or graphical subsystem is initialized.
• NoInterfaceWithOpenGL - The OpenGL subsystem is initialized without a user interface.
• FullInterface - The user interface and all graphical subsystems are initialized.

—–

: OperatingSystem

The operating system.

• Unknown - An unknown operating system.
• WindowsUnknown - An unknown version of Windows.
• Windows95 - The Windows 95 operating system.
• Windows98 - The Windows 98 operating system.
• WindowsMe - The Windows Me operating system.
• Windows2000 - The Windows 2000 operating system.
• WindowsXP - The Windows XP operating system.
• Windows2003 - The Windows 2003 operating system.
• WindowsVista - The Windows Vista operating system.
• Windows7 - The Windows 7 operating system.
• Windows8 - The Windows 8 operating system.
• Windows8_1 - The Windows 8.1 operating system.
• Windows10 - The Windows 10 operating system.
• MacUnknown - An unknown version of the Macintosh operating system.
• Mac10_0 - The OS X 10.0 (Cheetah) operating system.
• Mac10_1 - The OS X 10.1 (Puma) operating system.
• Mac10_2 - The OS X 10.2 (Jaguar) operating system.
• Mac10_3 - The OS X 10.3 (Panther) operating system.
• Mac10_4 - The OS X 10.4 (Tiger) operating system.
• Mac10_5 - The OS X 10.5 (Leopard) operating system.
• Mac10_6 - The OS X 10.6 (Snow Leopard) operating system.
• Mac10_7 - The OS X 10.7 (Lion) operating system.
• Mac10_8 - The OS X 10.8 (Mountain Lion) operating system.
• Mac10_9 - The OS X 10.9 (Mavericks) operating system.
• Mac10_10 - The OS X 10.10 (Yosemite) operating system.
• Mac10_11 - The OSX 10.11 (El Capitan) operating system.
• Mac10_12 - The OSX 10.12 (Sierra) operating system.

—–

: Platform

The platforms the application can run on.

• Windows - Supported Microsoft Windows Operating Systems.
• MacOSX - Supported Apple Macintosh OS X Operating Systems.

—–

: ReleaseCycle

• GeneralRelease - TODO: Add description.
• PublicBuild - TODO: Add description.
• PublishingBuild - TODO: Add description.
• PrivateBuild - TODO: Add description.
• DevBuild - TODO: Add description.

—–

: ReleaseEdition

The available editions of the application.

• Free - The free edition of the application.
• Standard - The standard edition of the application.
• Advanced - The advanced edition of the application.
• Pro - The pro edition of the application.
• Alpha - The alpha edition of the application.
• Beta - The beta edition of the application.

---

String : appName

Holds the name of the application; i.e., “DAZ Studio”. (Read Only)

---

String : cloudName

Holds the name of the cloud service; i.e., “Daz Connect”. (Read Only)

Since:

• 4.9.0.26

---

Number : exitCode

Holds the exit code returned by the application. (Read Only)

Since:

• 4.9.3.51

---

Number : logSize

Holds the size, in bytes, of the log file.

Since:

• 4.9.4.70

---

String : longVersionString

Holds a string representation of the full product version number; i.e., major.minor.revision.build. (Read Only)

---

String : orgName

Holds the name of the organization; i.e., “DAZ 3D”. (Read Only)

---

Array : scriptArgs

Holds the arguments passed to the application on launch. (Read Only)

Since:

• 4.9.3.39

---

Number : version

Holds the full product version number as an encoded 32-bit integer. (Read Only) Deprecated

Use version64 instead.

---

Number : version64

Holds the full product version number as an encoded 64-bit integer. (Read Only)

---

String : versionString

Holds a string representation of the product version number; i.e., major.minor. (Read Only)

---

void : addSessionFileLoad( String name )

---

Number : bitArchitecture()

Return Value:

• A numeric representation of the bit architecture the application was compiled for.

---

String : bitArchitectureString()

Return Value:

• A user-friendly string representation of the bit architecture the application was compiled for.

---

String : byteSizeToString( Number bytes )

Parameter(s):

• bytes - The numeric value to convert into a string.

Return Value:

• A string representation of the byte size.

Example:

// The message will be written to the log file
print( App.byteSizeToString( 1073741824 ) ); //1.0 GB

---

Boolean : canShowSceneBuilder( Object definition=undefined )

Parameter(s):

• definition - If empty, the default SceneBuilder.json file (if any) in getResourcesPath() will be checked. If a string, the full path of a Scene Builder configuration file to check is expected. If an object, a map of Scene Builder configuration data is expected. (since 4.6.4.62)

Return Value:

• true if the Scene Builder dialog would be displayed, otherwise false.

Since:

• 4.6.2.69

---

void : clearDelayedDeleteStack( Boolean doProgress )

Forces a deletion of all objects currently waiting to be deleted to free up more memory. If you are using this to clear memory you will generally want to clear the Undo Stack first.

See Also:

• DzUndoStack::clearAll()

Parameter(s):

• doProgress - If true, a progress dialog will be shown to the user while the operation is taking place.

---

String : createDigest( Array tokens )

Return Value:

• A string representing a message digest. The string is formatted as five hexadecimal fields separated by '-', i.e. “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx” where 'x' is a hexidecimal digit.

---

String : createDigest( ByteArray data )

Return Value:

• A string representing a message digest. The string is formatted as five hexadecimal fields separated by a hyphen ('-'), i.e. “xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx” where 'x' is a hexidecimal digit.

---

String : createUuid()

Return Value:

• A string representing a randomly generated Universally Unique IDentifier (UUID). The string is formatted as five hexadecimal fields separated by '-' and enclosed in curly braces, i.e. “{xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}” where 'x' is a hexidecimal digit.

---

void : debug( String msg )

Write a debug message to the application log file.

Parameter(s):

• msg - The debug message to write to the log.

See Also:

• log(), warning()

---

void : delayedExit( Number exitCode=0 )

Posts an event that causes the application to exit.

Parameter(s):

• exitCode - The exit code to set. (since 4.9.3.51)

Since:

• 4.6.2.55

---

void : enableMultiThreading( Boolean onOff )

Parameter(s):

• onOff - If true, multi-threaded features are enabled, otherwise multi-threaded features are disabled.

---

Boolean : flushLogBuffer()

Writes any currently buffered log messages to the log file. This is automatically called whenever the log buffer has more than 512 characters of data, but can be called at any time to force all messages to be written out.

---

String : getAbsoluteScriptPath( String scriptName )

Searches in default locations for a script file of the given name.

Parameter(s):

• scriptName - The name/path of a script file to find. This can be a file name, a relative file path, or an absoulte file path.

Return Value:

• The absolute path of the found script file (if any), otherwise an empty string.

See Also:

• getGeneratedScriptsPath()
• getScriptsPath()

---

String : getAppDataPath()

Return Value:

• The absolute path of the application data directory for the current machine user, the current major version of the application and the current release cycle of the application.

Attention:

• This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

See Also:

• getDAZDataPath()
• getApplicationBaseName()
• versionString
• releaseCycleSuffix()

---

String : getApplicationBaseName()

Return Value:

• The base name of the application; e.g., “Studio”.

Since:

• 4.9.2.33

---

DzAppSettingsMgr : getAppSettingsMgr()

Deprecated

Use the DzAppSettings class now instead.

Return Value:

• The application-wide persistent Settings Manager - used to set and retrieve application settings.

---

DzAssetIOMgr : getAssetIOMgr()

Return Value:

• The application-wide Asset I/O Manager in charge of native format assets.

---

DzAssetMgr : getAssetMgr()

Return Value:

• The application-wide Asset Manager.

---

DzAuthenticationMgr : getAuthenticationMgr()

Return Value:

• The application-wide Authentication Manager - responsible for tracking user authentication.

---

DzCallBackMgr : getCallBackMgr()

Return Value:

• The application-wide Call Back Manager - responsible for tracking call back objects.

---

String : getCommonUserDocumentPath()

Return Value:

• The absolute path of the public/shared user documents folder.

Attention:

• This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

---

DzContentMgr : getContentMgr()

Return Value:

• The application-wide Content Manager.

---

DzAuthor : getCurrentAuthor()

Return Value:

• The current author (user that is currently running the app).

---

String : getDataFolderName()

Return Value:

• The name of the data folder under the content directory.

---

String : getDataFolderPath()

Return Value:

• The full path for the location where data is stored.

---

String : getDataFolderPathBase()

Return Value:

• The base path for the location where data is stored.

---

String : getDAZDataPath()

Return Value:

• The absolute path of the data directory for DAZ 3D.

Attention:

• This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

See Also:

• orgName

---

DzDeviceMgr : getDeviceMgr()

Return Value:

• The application-wide Device Manager - responsible for devices supported by the application.

---

QWidget : getDialogParent()

Return Value:

• The active modal widget or the application main window if one exists.

---

String : getDocumentationPath()

Return Value:

• The absolute path of the directory where application documentation files are stored.

See Also:

• getHomePath()

---

String : getDocumentsPath()

Return Value:

• The absolute path of the user documents folder for the application.

Attention:

• This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

---

DzExportMgr : getExportMgr()

Return Value:

• The application-wide Export Manager in charge of file exporters.

---

DzFileIOPresetMgr : getFileIOPresetMgr()

Return Value:

• The application-wide File I/O Preset Manager.

---

String : getGeneratedScriptsPath()

Return Value:

• The absolute path of the directory where support script files that are automatically generated are stored.

See Also:

• getAppDataPath()

---

String : getGeneratedShadersPath()

Return Value:

• The absolute path of the application data directory for automatically generated shaders.

See Also:

• getAppDataPath()

---

GraphicsMode : getGraphicsMode()

Return Value:

• An enumerated value representing the current graphics mode.

---

DzHelpMgr : getHelpMgr()

Return Value:

• The application-wide Help Manager.

---

String : getHomePath()

Return Value:

• The absolute path of the directory that contains the application executable.

---

DzImageMgr : getImageMgr()

Return Value:

• The application-wide Image Manager - responsible for image I/O and tracking of currently loaded images.

---

DzImportMgr : getImportMgr()

Return Value:

• The application-wide Import Manager in charge of file importers.

---

DzMainWindow : getInterface()

Return Value:

• The main interface widget if the application is running with an interface, otherwise NULL.

See Also:

• Global::MainWindow

---

String : getLoadSavePath()

Last directory that files were loaded or saved to/from.

See Also:

• setLoadSavePath()

---

DzMultiMediaMgr : getMultiMediaMgr()

Return Value:

• The application-wide Video and Audio Manager - responsible for video and audio I/O.

---

DzPluginMgr : getPluginMgr()

Return Value:

• The application-wide Plug-in Manager - responsible for tracking plug-ins.

---

String : getPluginsPath()

Return Value:

• The absolute path of the base directory where plug-ins are loaded from.

See Also:

• getHomePath()

---

String : getProgramDataPath()

Return Value:

• The absolute path of the machine's global program data directory for the organization.

Attention:

• This path is dynamically constructed using calls to the underlying operating system. If the call to the OS fails, getHomePath() is used as a fallback.

See Also:

• orgName

---

DzRenderMgr : getRenderMgr()

Return Value:

• The application-wide Render Manager.

---

String : getResourcesPath()

Return Value:

• The absolute path of the directory where application resource files are stored.

See Also:

• getHomePath()

---

DzSaveFilterMgr : getSaveFilterMgr()

Return Value:

• The application-wide Save Filter Manager in charge of save filters.

---

String : getScriptsPath()

Return Value:

• The absolute path of the directory where support script files are stored.

See Also:

• getHomePath()

---

String : getShadersPath()

Return Value:

• The absolute path of the base directory for all shaders.

See Also:

• getHomePath()

---

DzStyle : getStyle()

Get the application wide style.

Return Value:

• The application-wide style object. This pointer is subject to becoming invalid if the application style changes.

---

String : getStyleDefinition()

Return Value:

• The name of the style definition currently in use.

---

Array : getStyleDefinitionList()

Return Value:

• A list of the available style definitions.

---

String : getTempFilename()

Get a filename for temporary storage.

Return Value:

• A unique filename (with no extension) whose path will be in the current temporary working folder. (All files in this folder will be deleted when shutdown() is called)

---

String : getTempPath()

Return Value:

• The absolute path of the directory where temporary files are stored.

See Also:

• getAppDataPath()
• setTempPath()
• restoreDefaultTempPath()

---

String : getTempRenderFilename()

Get a filename for temporary storage of rendered images.

Return Value:

• A filename (with no extension) whose path will be in the current temporary working folder. (All files in this folder will be deleted when shutdown() is called)

---

String : getUtilitiesPath()

Return Value:

• The absolute path of the base directory for all binary utilities.

See Also:

• getHomePath()

---

Boolean : isClosing()

Return Value:

• true if the application is in the process of shutting down, otherwise false.

---

Boolean : isKeyDown( Number key )

Parameter(s):

• key - The Qt::Key value for the key to check.

Return Value:

• true if key is currently pressed, otherwise false.

---

Boolean : isKeySequenceDown( String sequence )

Parameter(s):

• sequence - A string consistent with {QKeySequence, fromString}, in the PortableText format.

Return Value:

• true if sequence is currently pressed, otherwise false.

---

Boolean : isMultiThreadingEnabled()

Return Value:

• true if the user has chosen to enable multi-threaded features, otherwise false.

---

Boolean : isRegistered()

Return Value:

• true if a valid serial number has been provided, otherwise false.

---

Boolean : isRunning()

Return Value:

• true if the main event loop is running and events that are posted can be expected to be delivered, otherwise false.

---

Boolean : isSlave()

Return Value:

• true if the application is running as a slave to another application, otherwise false.

---

Boolean : isStarting()

Return Value:

• true if the application is in the process of starting up, otherwise false.

---

void : log( String buffer )

Write a message to the application log file.

Parameter(s):

• buffer - The string to write to the log file.

Example:

//The message will be written to the log file
App.log( "Hello World!" );

See Also:

• statusLine()

---

Number : modifierKeyState()

SHIFT		   = 0x02000000
CTRL			= 0x04000000
ALT			 = 0x08000000
META			= 0x10000000
 
META + SHIFT	= 0x12000000
META + CTRL	 = 0x14000000
META + ALT	  = 0x18000000
SHIFT + CTRL	= 0x06000000
SHIFT + ALT	 = 0x0A000000
CTRL + ALT	  = 0x0C000000

Return Value:

• The current modifier key state - this value is a bitwise or of the Qt::Modifier flags for the active keys, if any.

Example:

var shftKey = App.modifierKeyState() & 0x02000000;
var ctrlKey = App.modifierKeyState() & 0x04000000;
var altKey = App.modifierKeyState() & 0x08000000;
var metaKey = App.modifierKeyState() & 0x10000000;
 
if( shftKey ){
	print( "Shift pressed." );
}
 
if( ctrlKey ){
	print("Control pressed.");
}
 
if( altKey ){
	print("Alt pressed.");
}
 
if( metaKey ){
	print("Meta pressed.");
}

---

OperatingSystem : operatingSystem()

Return Value:

• The enumerated value associated with the OperatingSystem that the application is running under.

---

String : operatingSystemString()

Return Value:

• A user-readable string that describes the current Operating System.

---

Platform : platform()

The application is intended to be as platform independent as possible, but there are cases where something needs to be done differently on one platform or another. This function provides a simple way to check which platform the application is running under.

Return Value:

• The enumerated value associated with the Platform that the application is running under.

Example:

var nPlatform = App.platform();
if( nPlatform == App.Windows ){
	//doWinSomething();
} else if( nPlatform == App.MacOSX ){
	//doMacSomething();
}

---

void : postScriptEvent( Boolean evaluate, String script, Array args=[] )

Posts an event that causes execution of a script as it is encountered in the event stack.

Parameter(s):

• evaluate - If script is actual code, set this to true, otherwise set this to false.
• script - This can be a file name, a relative file path, an absoulte file path or code. If passed a file name or path, getAbsoluteScriptPath() is used to resolve it. If passed actual code, evaluate must also be set to true.
• args - The list of arguments to pass to the script.

Since:

• 4.10.0.101

---

ReleaseCycle : releaseCycle()

Return Value:

• The enumerated value associated with the ReleaseCycle of the application.

---

String : releaseCycleString()

Return Value:

• A user-friendly string describing the release cycle of the application.

---

ReleaseEdition : releaseEdition()

Return Value:

• The enumerated value associated with the ReleaseEdition of the application.

---

String : releaseEditionString()

Return Value:

• A user-friendly string describing the release edition of the application.

---

void : restoreDefaultTempPath()

Restores the temporary files directory to the default location.

See Also:

• setTempPath()
• getTempPath()

---

void : setLoadSavePath( String dir )

Set the default directory for loading or saving files.

Parameter(s):

• dir - The default directory for loading/saving files.

Example:

//Set the load/save path to our favorite folder
App.setLoadSavePath( "c:/MyScenes" );

See Also:

• getLoadSavePath()

---

Boolean : setStyleDefinition( String name )

Sets the current style for the application.

Parameter(s):

• name - The name of the style definition to use.

Return Value:

• true if the application switched to the given style, otherwise false.

---

Boolean : setTempPath( String tempPath )

Sets the directory path where temporary files are stored. The path provided needs to be an absolute path. A directory will be created at the new location if it does not already exist.

Parameter(s):

• tempPath - The path of the new temporary files directory.

Return Value:

• true if the path provided is valid and changing the temporary path succeeded. false if any errors occurred.

See Also:

• getTempPath()
• restoreDefaultTempPath()

---

Boolean : showInNativeBrowser( String absFilePath )

A convenience method for opening a showing a file/directory in the OS file browser.

Parameter(s):

• absFilePath - The absolute file path to a file or folder to show.

Return Value:

• true if the file exists and the OS file browser could be launched, otherwise false.

---

Boolean : showPrompts()

Return Value:

• true if the application should prompt the user for input, otherwise false.

---

Array : showSceneBuilder( Object definition=undefined, Boolean asEvent=false )

Displays the Scene Builder dialog.

Parameter(s):

• definition - If empty, the default SceneBuilder.json file (if any) in getResourcesPath() will be used. If a string, the full path of a Scene Builder configuration file to check is expected. If an object, a map of Scene Builder configuration data is expected. (since 4.6.4.62)
• asEvent - If false (default), the Scene Builder configuration data is processed immediately. If false, the the Scene Builder configuration data is posted to an event and processed as it is encountered in the event stack. (since 4.6.4.62)

Return Value:

• If asEvent is false, a list of the selections made by the user in the Scene Builder dialog, otherwise an empty list. (since 4.6.4.62)

See Also:

• sceneBuilderRejected(), sceneBuilderAccepted()

Since:

• 4.6.2.69

---

void : showURL( String url )

A convenience method for browsing to a given URL.

Parameter(s):

• url - The url to open in the system's default browser. Be sure to specify the scheme of the url (e.g., 'http:' or 'file:').

Example:

---

void : statusLine( String msg, Boolean writeToLog=true )

Display a message in the current status interface.

Parameter(s):

• msg - The string to be displayed (and logged if logging is enabled)
• writeToLog - If true, the message will also be written the the log file.

Example:

//The message will be displayed in status bar and written to the log file
App.statusLine( "Hello World!" );

See Also:

• log()

---

Boolean : usingInterface()

Return Value:

• true if the application is using a user interface.

---

void : warning( String msg )

Write a warning message to the application log file.

Parameter(s):

• msg - The message to write to the log as a warning.

See Also:

• log(), debug()

---

Boolean : writeConfigScript( String configScriptFilename=“” )

Saves out a user configuration script to the given filename. If no filename is given, the script is saved to the same file read from in startup(). The run() function calls this at the end of each execution.

Parameter(s):

• filename - The name of the file to save a configuration script to.

Return Value:

• true if the file was written successfully.

---

void : closing()

Signature:“closing()”

Emitted immediately after the main event loop exits.

---

void : debugMsg( String msg )

Signature:“debugMsg(const QString&)”

Emitted when a debug message is sent to the application.

---

void : eventLoopStarted()

Signature:“eventLoopStarted()”

Emitted when the event loop is started on the application.

---

void : mouseEvent()

Signature:“mouseEvent()”

Emitted when a MouseButtonDblClick or MouseButtonRelease event occurs on the application.

---

void : multiThreadingChanged( Boolean onOff )

Signature:“multiThreadingChanged(bool)”

Emitted when multi-threading has changed on the application.

---

void : sceneBuilderAccepted( Array selections )

Signature:“sceneBuilderAccepted(const QStringList&)”

Emitted when the Scene Builder dialog has been rejected by the user, or when none of the files specified in the Scene Builder definition can be found.

Since:

• 4.6.4.62

---

void : sceneBuilderRejected()

Signature:“sceneBuilderRejected()”

Emitted when the Scene Builder dialog has been rejected by the user, or when none of the files specified in the Scene Builder definition can be found.

Since:

• 4.6.4.62

---

void : starting()

Signature:“starting()”

Emitted after the application has finished its startup just before the main event loop begins.

---

void : styleAboutToChange()

Signature:“styleAboutToChange()”

Emitted when a the style is about to change on the application.

---

void : styleChanged( DzStyle newStyle )

Signature:“styleChanged(DzStyle*)”

Emitted when the application wide style has changed.

---

void : warningMsg( String msg )

Signature:“warningMsg(const QString&)”

Emitted when a warning message is sent to the application.