3DCoat Python API
The 3DCoat Python API documentation.
Loading...
Searching...
No Matches
Public Member Functions | List of all members
coat.settings Class Reference

Public Member Functions

bool valueExists (ID=str)
 returns true if the value in settings exists
 
bool getBool (ID=str)
 get the boolen value from the settings
 
str getString (ID=str)
 get the string value from the settings
 
float getFloat (ID=str)
 get the float value from the settings
 
int getInt (ID=str)
 get the integer value from the settings
 
 setBool (ID=str, value=bool)
 set the boolean value to the settings
 
 setString (ID=str, value=str)
 set the string value to the settings
 
 setFloat (ID=str, value=float)
 set the float value to the settings
 
 setInt (ID=str, value=int)
 set the integer value to the settings
 
 saveSettings ()
 save all changed settings
 
 resetSettings (ResetGeneralSettings=bool, ResetHiddenSet=bool, ResetHotkeys=bool, RestNavigation=bool, ResetPresets=bool, ResetTheme=bool, ResetWindows=bool)
 reset all settings to default values, application will restart
 

Member Function Documentation

◆ getBool()

bool coat.settings.getBool (   ID = str)

get the boolen value from the settings

Parameters
IDthe identisier, go to Documents/3DCoat/UserPrefs/Preferences/, look for files Options #.xml, open and look for required identifier, use it as ID
Returns
the boolean value, false if not exists or casting impossible

◆ getFloat()

float coat.settings.getFloat (   ID = str)

get the float value from the settings

Parameters
IDthe identisier, go to Documents/3DCoat/UserPrefs/Preferences/, look for files Options #.xml, open and look for required identifier, use it as ID
Returns
the float value, 0 if not exists or casting impossible

◆ getInt()

int coat.settings.getInt (   ID = str)

get the integer value from the settings

Parameters
IDthe identisier, go to Documents/3DCoat/UserPrefs/Preferences/, look for files Options #.xml, open and look for required identifier, use it as ID
Returns
the integer value, 0 if not exists or casting impossible

◆ getString()

str coat.settings.getString (   ID = str)

get the string value from the settings

Parameters
IDthe identisier, go to Documents/3DCoat/UserPrefs/Preferences/, look for files Options #.xml, open and look for required identifier, use it as ID
Returns
the string value, empty if not exists

◆ resetSettings()

coat.settings.resetSettings (   ResetGeneralSettings = bool,
  ResetHiddenSet = bool,
  ResetHotkeys = bool,
  RestNavigation = bool,
  ResetPresets = bool,
  ResetTheme = bool,
  ResetWindows = bool 
)

reset all settings to default values, application will restart

Parameters
ResetGeneralSettingsreset general settings
ResetHiddenSetreset the hidden UI elements list
ResetHotkeysreset the hotkeys
RestNavigationreset the navigation settings
ResetPresetsreset the presets
ResetThemereset the theme
ResetWindowsreset the floating windows placement

◆ saveSettings()

coat.settings.saveSettings ( )

save all changed settings

◆ setBool()

coat.settings.setBool (   ID = str,
  value = bool 
)

set the boolean value to the settings

Parameters
IDthe identisier, go to Documents/3DCoat/UserPrefs/Preferences/, look for files Options #.xml, open and look for required identifier, use it as ID
valuethe value to set

◆ setFloat()

coat.settings.setFloat (   ID = str,
  value = float 
)

set the float value to the settings

Parameters
IDthe identisier, go to Documents/3DCoat/UserPrefs/Preferences/, look for files Options #.xml, open and look for required identifier, use it as ID
valuethe value to set

◆ setInt()

coat.settings.setInt (   ID = str,
  value = int 
)

set the integer value to the settings

Parameters
IDthe identisier, go to Documents/3DCoat/UserPrefs/Preferences/, look for files Options #.xml, open and look for required identifier, use it as ID
valuethe value to set

◆ setString()

coat.settings.setString (   ID = str,
  value = str 
)

set the string value to the settings

Parameters
IDthe identisier, go to Documents/3DCoat/UserPrefs/Preferences/, look for files Options #.xml, open and look for required identifier, use it as ID
valuethe value to set

◆ valueExists()

bool coat.settings.valueExists (   ID = str)

returns true if the value in settings exists

Parameters
IDthe identisier, go to Documents/3DCoat/UserPrefs/Preferences/, look for files Options #.xml, open and look for required identifier, use it as ID
Returns
true if identifier exists

The documentation for this class was generated from the following file: