The <Application> class is used to manipulate and store application-related data and values.
Class Hierarchy | No registered superclass. |
Function members are as follows:
Return Type | Function Name | Documentation |
---|---|---|
string | AppendToPath | Appends a path with a string value, such as another path, or a filename. |
string | BrowseFileOpen | Displays the Win32 common file open dialog and allows you to select a file on disk. |
string | BrowseFileSave | Displays the Win32 common file save dialog and allows you to save a file to disk. |
int32 | CaptureScreen | Internal use only. |
int32 | CopyFile | Copies a file from the source location to the destination location. The source and destination paths must be an absolute (C:\\MyFolder\\MyFile.txt) and all the folders in the entire directory tree of the destination path must exist (This function does not create destination directories.). |
int32 | CreateDirectory | Creates a directory. |
int32 | DeleteFile | Deletes a file from the hard disk. |
int32 | ExecuteCommand | Executes a Scenome command based on its category and name. |
int32 | Exit | Engages application shutdown. You will be prompted to save any unsaved work if applicable. |
int32 | FileExists | Returns true if a file exists at the specified path. Otherwise returns false. |
int32 | FindNext | Finds the next instance of the specified string. |
int32 | FindPrevious | Finds the previous instance of the specified string. |
int32 | FlushModelReferences | Flushes or refreshes a document. Typically used to refresh content pointed at via <NodeLink>. |
<Render3D> | GetAccelerate3D | Returns a pointer to an <Accelerate3D> object that implements the OpenGL rendering device. This is used to access the OpenGL device from Scenome Scripting Language code. |
string | GetActiveApplicationFile | Returns the name of the active application file. For example: shader.scenomeapp. |
string | GetActiveApplicationFileComplete | Returns the absolute path of the active application file. For example: D:\release6\content\applications\shader\shader.scenomeapp. |
<EditModel3D> | GetActiveModel | Returns a pointer to the active <EditModel3D> object. |
string | GetAppDataFilePath | Populates a string with the absolute path of the directory containing Scenome.exe, application DLLs, and most of the application scripts. Typically, something like C:\Program Files\Scenomics or wherever the binaries are installed. |
string | GetAppDataPath | Returns a string with the absolute path of the Scenome data file path. This is the directory containing Scenome.exe. |
string | GetAppDocsFilePath | Populates a string with the absolute path of the application documents file path. This is the directory containing the Scenome documents such as shader files, application shells for the Shader app, user scripts, and textures. Typically, something like C:\Users\UserName\My Documents\Scenomics. |
string | GetAppDocsPath | Returns the absolute path of the application documents file path. This is the directory containing the Scenome documents such as shader files, application shells for the Shader app, user scripts, and textures. Typically, something like C:\Users\UserName\My Documents\Scenomics. |
string | GetAppPath | Returns the absolute path to the directory containing Scenome.exe and DLL plugins. |
string | GetApplicationDataFilePath | Populates a string with the absolute path of the Scenome installation data file path. This is the directory containing the Scenome binaries. Typically, something like C:\Program Files\Scenomics or wherever the binaries are installed. |
string | GetApplicationDataPath | Returns a string with the absolute path of the directory that contains the Scenome binaries. |
string | GetApplicationDocumentsFilePath | Populates a string with the absolute path of the Scenome documents file path. This is the directory containing the Scenome documents such as shader files, application shells for the Shader app, user scripts, and textures. Typically, something like C:\Users\UserName\My Documents\Scenomics. |
string | GetApplicationDocumentsPath | Returns the absolute path of the application documents file path. This is the directory containing the Scenome documents such as shader files, application shells for the Shader app, user scripts, and textures. Typically, something like C:\Users\UserName\My Documents\Scenomics. |
string | GetApplicationPath | Returns the absolute path to the directory containing Scenome.exe and DLL plugins. |
int32 | GetCurrentProcessID | Returns the Windows Process ID for the process assigned to the current instance of Scenome.exe used by the application. |
<DrawMode> | GetDrawMode | Returns a pointer to a <DrawMode> object based on its GUID. |
<Editor> | GetEditor | Returns a specific editor based on its GUID. |
string | GetFileExtension | Deprecated. Prefer the <FilePath> data interface of the same name. |
string | GetFileName | Deprecated. Prefer the <FilePath> data interface of the same name. |
string | GetFilePath | Deprecated. Prefer the <FilePath> data interface of the same name. |
string | GetInterfaceDefinitionFile | Returns the absolute path to the current .XML interface definition. |
int32 | GetLocalTimeHours | Returns the local machine time in hours. |
int32 | GetLocalTimeMilliseconds | Returns the local machine time in milliseconds. |
int32 | GetLocalTimeMinutes | Returns the local machine time in minutes. |
int32 | GetLocalTimeSeconds | Returns the local machine time in seconds. |
string | GetStrippedFileName | Deprecated. Prefer the <FilePath> data interface called GetFileNameNoExtension. |
string | GetTempPath | Returns a temporary file path, including 'Name', and optionally including the ID of the current Scenome process. |
string | GetTitle | Returns the application's title string. |
int32 | IsApplicationFileLoaded | Returns true if the specified application file is loaded. |
int32 | LaunchHtmlPage | Loads any HTML file hosted on https://www.scenomics.com/. |
int32 | LoadApplicationFile | Loads the specified application shell. This changes the title, UI, and app icons to use the resources specified in the app file. |
string | MakeRelativePath | Deprecated. Prefer the <FilePath> data interface of the same name. |
int32 | MessageBeep | Emits a message beep from the application. This refers to the MessageBeep enumeration. Please see TYPE_SERVICE_ENUMERATION_UTIL.SSL in the application scripts folder for more information. See also: Microsoft message beep documentation. |
int32 | MessageBox | Displays a message box terminated with Yes/No or OK. |
int32 | OpenFile | Opens a file in Scenome, replacing the existing file. |
int32 | PlaySound | Plays a wave sound. |
string | ResolveModelRelativePath | Converts a relative file path to an absolute file path based on the current file open in Scenome. |
string | ResolveNodeRelativePath | Converts a relative file path to an absolute file path based on the filename of <Model3D> pointer of the node submitted to this function. You can also submit a <Model3D> pointer since <Model3D> is a type of <Node> (it's the document root node). |
string | ResolveRelativePath | Deprecated. Prefer the <FilePath> data interfaces ResolveToModel or ResolveToPath. |
int32 | RunProgram | Executes a program or command. |
int32 | SaveFile | Saves the current document to disk using the specified filename. Use this to save the current active document with another filename. |
int32 | SaveFileAs | Saves the current document to disk using the specified filename. Use this to save the current active document with another filename. |
int32 | SetActiveInterfaceFile | Sets the active interface file to the specified interface definition file. This is a file with a .XML extension such as v0_shader.xml or v1_shader.xml. |
int32 | SetBoxOpenDirectory | Sets the default directory location when the Windows common file dialog is used to open a file. Typically this is used to implement custom file open commands that open documents from a specific location. |
int32 | SetBoxSaveDirectory | Sets the default directory location when the Windows common file dialog is used to save a file. Typically this is used to implement custom file saving commands that save documents in a specific location. |
int32 | SetDefaultBoxFile | Sets the default .BOX file for this application instance. The contents of this .BOX file are what you see when you first start an instance of a specific application. |
int32 | SetIcon | Sets the icons used by the application instance. This must be a valid Windows .ICO file. The small icon is displayed in the upper left corner of the application, and the large icon is displayed when you use ALT+TAB to switch between applications, as well as other places. |
int32 | SetInterfaceDefinitionFile | Sets the active interface definition file for this application. |
int32 | SetTitle | Sets the application's title text. |
int32 | ShellExec | This function opens a document based on its file path, using the current default Windows application that is associated with the file type. |
int32 | ShellExecEx | Opens a file or executes an operating system command. |
int32 | ShowFindWindow | Shows the Windows common 'Find' dialog. |
Object members are as follows:
Type Name | Accessor Name | Documentation |
---|---|---|
<MainWindow> | Window | Returns a pointer to the application's <MainWindow> object. This object provides access to panels, tabbed controls inside panels, and the application's rendered views. |
string | CurrentFindText | Sets or gets the Find dialog's current find text. |