Documentation for New Methods, Classes, Interfaces in GMax

Interface Methods

Interface: colorMan (new methods)

<boolean>SaveIconFile <filename>szFilename <filename>szIconPath

This method saves the szIconPath path string to the specified file. If no path is specified in szFilename, the file will be stored in current CUI directory. The maximum allowed string length for szIconPath is 260 characters. If the specified file already exists, its contents will be overwritten. This method return true if the file was successfully written, false otherwise.

<boolean>LoadIconFile <filename>szFilename

This method reads a string from the specified file. If no path is specified in szFilename, the file will be read from the current CUI directory. This method return true if the file was successfully read, false otherwise.

<string>ReadIconFile()

This method returns the string read in the colorMan.LoadIconFile method.

Interface: quadMenuSettings (new methods)

<void>SaveSettingsFile <filename>szFilename

This method saves the current quad menu settings to the specified file. If no path is specified in szFilename, the file will be stored in current CUI directory. This method return true if the file was successfully written, false otherwise.

<void>LoadSettingsFile <filename>szFilename

This method loads the quad menu settings from the specified file. If no path is specified in szFilename, the file will be read from the current CUI directory. This method return true if the file was successfully read, false otherwise.

Interface: gridPrefs (new interface)

This interface exposes properties related to the construction grid.

Properties

.spacing : float : Read|Write

This property exposes the Grid Spacing value. This property corresponds to the Grid Spacing spinner in the Grid and Snap Settings dialog, Home Grid tab

.majorLines : integer : Read|Write

This property exposes the Major Lines value. This property corresponds to the Major Lines every Nth spinner in the Grid and Snap Settings dialog, Home Grid tab

Notes

Setting these properties does not update the Grid and Snap Settings dialog, Home Grid tab displayed values if the dialog is open.

Interface: statusPanel (new interface)

This interface exposes methods for hiding the status panel, and seeing if the status panel is hidden.

<void>setVisible <boolean>visible

If visible is true, the status panel will be set visible. If false, the status panel will be hidden.

<boolean>isVisible()

Returns true if the status panel is visible, false if hidden.