Settings
Provides static properties and events for central Grasshopper settings.
Fields
AnimationFolder
#Gets the folder new animations put their output folders underneath. An empty value means the pictures folder is used.
AutomaticDocumentationContent
#Gets whether the documentation includes automatically generated content.
AutoSaveReasons
#Gets the list of reasons which will trigger an autosave.
BalancedThreads
#Gets the number of threads to use during balanced multithreading calculations. A value of zero means a default value will be picked based on the number of available processors.
CacheAutoSaveData
#Gets whether autosaves reuse the serialised form of persistent data that has not changed since the previous autosave.
CanvasAutoSearch
#Gets whether text input is handled internally, or piped into the Rhino command line.
CanvasDrawFullNames
#Gets whether the canvas draws fully blown input and output names for component parameters.
CanvasDrawLabels
#Gets whether the canvas draws object info labels.
CanvasFrameDiagnostics
#Gets whether the canvas draws a small repaint diagnostics overlay showing frame counts and frame durations. This is a troubleshooting tool for runaway redraw loops; a frame counter which keeps climbing while nobody is interacting with the canvas indicates such a loop.
CanvasHints
#Gets whether the canvas draws object hints and tips.
CanvasLabelAbove
#Gets whether the info label is drawn above or below the object.
CanvasLabelName
#Gets whether the info label contains the object name.
CanvasLabelPlugin
#Gets whether the info label contains the object plugin name.
CanvasLabelProfiler
#Gets whether the info label contains the object performance.
CanvasLabelSlowOnly
#Gets whether the info label limits itself to slow objects if CanvasLabelProfiler is true.
CanvasMessages
#Gets whether the canvas draws object message icons.
CanvasShowIcons
#Gets whether components show their name or their icon by default.
CanvasSkin
#The name of the skin the canvas uses, which is a file in the skins folder. Empty means the built-in skin.
CanvasSnapToObjects
#Gets whether objects are snapped to other objects during dragging and resizing.
DarkMode
#Gets whether UI is drawn using Dark Mode themes.
DelayPeriod
#Gets or sets the grace period (in milliseconds) for delayed solutions.
DisplayNewShader
#Gets whether meshes are drawn with the new shader. This setting will eventually go away when the new shader becomes the only one available, or when we decide to discontinue it.
DuplicateInputs
#Gets or sets whether to duplicate data in component inputs during solutions. This is a validation/debugging feature.
FfmpegPath
#Gets the absolute path of the FFmpeg executable used to encode animations. An empty value means it has not been found yet, or is not installed.
The path is absolute and never a bare name. A windowed application does not inherit the PATH a terminal has, so on macOS in particular 'ffmpeg' resolves for the user and not for Rhino.
GlobalClipboard
#Gets whether copied document objects end up in the OS clipboard, or in the static Grasshopper clipboard.
IntenseThreads
#Gets the number of threads to use during intense multithreading calculations. A value of zero means a default value will be picked based on the number of available processors.
LooseWindow
#Gets whether top-level Grasshopper windows remain loose, i.e. are never assigned the Rhino window as their parent. A loose window does not stay on top of Rhino, but it participates fully in operating system window management, in particular docking against screen edges on macOS, which is denied to child windows.
MeritWarning
#Gets or sets the merit level at which conversion warnings appear.
MultiFileUi
#Gets or sets where to show the loaded file UI.
0 = File menu only.
1 = File menu and status bar.
2 = File menu and canvas tabs.
MultiThreading
#Gets the multithreading level to use during solution processes. This will be either 1=reduced, 2=balanced, 3=intense.
PrimaryUiLang
#Gets the primary UI language. At present there is no secondary language any more. This integer ought to be one of the Localisation.SupportedLanguage enumerations.
ReducedThreads
#Gets the number of threads to use during reduced multithreading calculations. A value of zero means a default value will be picked based on the number of available processors.
ReinstateSession
#Gets whether the documents from the previous session should be reinstated on Grasshopper load.
SeededSkins
#The names of the shipped skins that have been copied into the skins folder, one per line. A skin is copied once, so deleting or renaming the copy sticks.
ShowObscure
#Gets whether obscure components are shown on the main tab panels.
TabIconShadows
#Gets whether ribbon icons are drawn with drop shadows.
TabPreview
#Gets whether the contents of ribbon tabs are previewed on mouse hover.
TooltipEnabled
#Gets whether the tooltips are drawn at all.
TranslateMessages
#Gets whether error and informational messages ought to be translated into the primary UI language.
TranslateObjects
#Gets whether object names ought to be translated into the primary UI language.
TranslateTooltips
#Gets whether tooltip messages ought to be translated into the primary UI language.
TypefaceMono
#Family names for the monospaced typeface, most preferred first and comma separated. Empty means the Victor Mono bundled with Grasshopper.
TypefaceSans
#Family names for the sans-serif typeface, most preferred first and comma separated. Empty means the font the OS draws its own interface with.
TypefaceScript
#Family names for the script typeface, most preferred first and comma separated. Empty means the Playpen Sans bundled with Grasshopper.
TypefaceSerif
#Family names for the serif typeface, most preferred first and comma separated. Empty means the platform serif.
UserDays
#Gets the number of days that the user has used Grasshopper. The UI may choose to emphasize or de-emphasize elements based on the user's exposure to the software.
UserName
#Gets the user name, which will be used to store individualised modifications.
ZoomThresholdDetailed
#Gets the zoom threshold above which detailed UI will become visible.
Properties
PrimaryUiLanguage
#public static Language PrimaryUiLanguage { get; }
Gets the primary ui language, cast from the settings integer to an appropriate enum.
SandBox
#Gets or sets whether Grasshopper is in sandbox mode. While in sandbox mode, no setting changes should become persistent.
Methods
IsAutoSaveReason
#Test whether a specific reason is part of the accepted set.
Parameters:
| reason (AutoSaveReason) |