CentralSettings

public sealed class CentralSettings
Represents a collection of program wide settings and events for when those settings change. This should probably be the bottleneck for all program wide settings, but stuff is still littered about for now.

Properties

AuthorAddress

#
public static string AuthorAddress { get; set; }
Gets or sets the default author address to be used for all data generated by this Grasshopper installation.

AuthorCompany

#
public static string AuthorCompany { get; set; }
Gets or sets the default author company to be used for all data generated by this Grasshopper installation.

AuthorCopyright

#
public static string AuthorCopyright { get; set; }
Gets or sets the default author copyright to be used for all data generated by this Grasshopper installation.

AuthorCopyrightFormatted

#
public static string AuthorCopyrightFormatted { get; }
Gets the authorCopyright message formatted to match the current date.

AuthorDetails

#
public static IGH_Author AuthorDetails { get; }
Gets a new GH_AuthorDetails instance populated with the current settings. Changing this instance does not affect the settings.

AuthorEMail

#
public static string AuthorEMail { get; set; }
Gets or sets the default author e-mail to be used for all data generated by this Grasshopper installation.

AuthorName

#
public static string AuthorName { get; set; }
Gets or sets the default author name to be used for all data generated by this Grasshopper installation.

AuthorPhone

#
public static string AuthorPhone { get; set; }
Gets or sets the default author phone to be used for all data generated by this Grasshopper installation.

AuthorWebsite

#
public static string AuthorWebsite { get; set; }
Gets or sets the default author website to be used for all data generated by this Grasshopper installation.

CanvasFancyWires

#
public static bool CanvasFancyWires { get; set; }
Gets or sets whether or not fancy wires will be drawn. This is a global setting.

CanvasFullNames

#
public static bool CanvasFullNames { get; set; }
Gets or sets the global default for verbose UI. When CanvasFullNames=True, parameter nicknames are set to their actual (long) names upon addition.

CanvasMaxSearchResults

#
public static int CanvasMaxSearchResults { get; set; }
Gets or sets the maximum number of search results for populating the Create menu.

CanvasObjectIcons

#
public static bool CanvasObjectIcons { get; set; }
Gets or sets the global default for icon display.

CanvasObsoleteTags

#
public static bool CanvasObsoleteTags { get; set; }
Gets or sets the global default for obsolete tags.

CanvasRadialMenu

#
public static bool CanvasRadialMenu { get; set; }
Gets or sets the global default for whether the canvas should use Radial or olds-kool menus.

CanvasSpaceIsRadialMenu

#
public static bool CanvasSpaceIsRadialMenu { get; set; }
Gets or sets whether the space bar triggers the radial menu (pre Rhino 6.3 behaviour) or the Create menu (post Rhino 6.3 behaviour).

CanvasSpaceSearchRadialMessage

#
public static int CanvasSpaceSearchRadialMessage { get; set; }
Gets or sets the number of times the space-is-now-search-and-not-radial message has been shown.

CanvasToolbar

#
public static bool CanvasToolbar { get; set; }
Gets or sets whether or not the canvas toolbar will be visible. This is a global setting.

CanvasZuiZoomLevel

#
public static float CanvasZuiZoomLevel { get; set; }
Gets or sets the global Zui zoom threshold.

CapsuleHighlight

#
public static bool CapsuleHighlight { get; set; }
Gets or sets the global setting for drawing highlight bars on capsules.

CapsuleShine

#
public static bool CapsuleShine { get; set; }
Gets or sets the global setting for drawing shiny edges on capsules.

CheckPluginCompatibility

#
public static bool CheckPluginCompatibility { get; set; }
Gets or sets whether GHA libraries are checked for compatibility with this version of Grasshopper when they load. Takes effect on next startup.

ComponentCascadeMenus

#
public static bool ComponentCascadeMenus { get; set; }
Gets or sets whether Grasshopper document solutions are wrapped in undo records.

CreateSolutionUndoRecord

#
public static bool CreateSolutionUndoRecord { get; set; }
Gets or sets whether Grasshopper document solutions are wrapped in undo records.

FormatDecimalDigits

#
public static int FormatDecimalDigits { get; set; }
Gets or sets how many digits ought to be used for decimal formatted numbers.

FormatENotationDigits

#
public static int FormatENotationDigits { get; set; }
Gets or sets how many digits ought to be used for scientific notation formatted numbers.

FormatENotationLowerLimit

#
public static int FormatENotationLowerLimit { get; set; }
Gets or sets at what power of ten decimal formatting of numbers switches to E notation for small numbers.

FormatENotationLowerThreshold

#
public static double FormatENotationLowerThreshold { get; }
Gets at what actual threshold numeric formatting switches from decimal to E-Notation.

FormatENotationUpperLimit

#
public static int FormatENotationUpperLimit { get; set; }
Gets or sets at what power of ten decimal formatting of numbers switches to E notation for large numbers.

FormatENotationUpperThreshold

#
public static double FormatENotationUpperThreshold { get; }
Gets at what actual threshold numeric formatting switches from decimal to E-Notation.

FormatMultiplesOfOne

#
public static bool FormatMultiplesOfOne { get; set; }
Gets or sets whether floating point numbers close to whole integers should be special cased.

FormatMultiplesOfPi

#
public static bool FormatMultiplesOfPi { get; set; }
Gets or sets whether multiples of 0.5*Pi ought to be special cased.

InvalidBakeAllow

#
public static bool InvalidBakeAllow { get; set; }
Gets or sets the default choice for baking invalid objects.

InvalidBakeAsk

#
public static bool InvalidBakeAsk { get; set; }
Gets or sets whether a warning ought to be displayed prior to baking invalid geometry. By default this is always TRUE when Grasshopper starts.

IsTemplateFile

#
public static bool IsTemplateFile { get; }
Gets whether a template file has been defined and whether that file ectually exists.

PanelDefaultFontFamily

#
public static string PanelDefaultFontFamily { get; set; }
Gets or sets the font family name of the default font for panels.

PanelDefaultFontSize

#
public static float PanelDefaultFontSize { get; set; }
Gets or sets the font family name of the default font for panels.

PreviewBumpZBuffer

#
public static bool PreviewBumpZBuffer { get; set; }
Gets or sets whether the Document preview bumps the Z-Buffer. Setting this value automatically causes a redraw of the Rhino viewports.

PreviewGumballs

#
public static bool PreviewGumballs { get; set; }
Gets or sets whether the gumballs will be visible for selected preview geometry.

PreviewMeshEdges

#
public static bool PreviewMeshEdges { get; set; }
Gets or sets the Mesh Wire display flag.

PreviewPlaneRadius

#
public static double PreviewPlaneRadius { get; set; }
Gets or sets the global Plane radius.

PreviewPointRadius

#
public static int PreviewPointRadius { get; }
Gets the default radius of the point objects given the current style.

PreviewPointStyle

#
public static PointStyle PreviewPointStyle { get; set; }
Gets or sets the point style for Grasshopper preview points.

PreviewSelectionThickening

#
public static int PreviewSelectionThickening { get; set; }
Gets or sets the amount of thickening to apply to selected wires.

PruderyLevel

#
public static GH_PruderyFilter PruderyLevel { get; set; }
Gets or sets the Grasshopper UI prudery level.

RibbonDrawTabIcons

#
public static bool RibbonDrawTabIcons { get; set; }
Gets or sets whether tab icons are drawn for the ribbon.

RibbonSeparators

#
public static bool RibbonSeparators { get; set; }
Gets or sets whether there are separators between different exposures on the component Ribbon.

RibbonShowObscure

#
public static bool RibbonShowObscure { get; set; }
Gets or sets a value indicating whether components marked with DropDown exposure are drawn on the main toolbar anyway.

RibbonVisible

#
public static bool RibbonVisible { get; set; }
Gets or sets a value indicating whether components marked with DropDown exposure are drawn on the main toolbar anyway.

ShowTutorials

#
public static bool ShowTutorials { get; set; }
Gets or sets whether the tutorial browser is shown on Grasshopper load.

TemplateFile

#
public static string TemplateFile { get; set; }
Gets or sets the template file path. Use String.Empty or Nothing to disable the template file.

TooltipVisible

#
public static bool TooltipVisible { get; set; }
Gets or sets whether the tooltip is shown.

TooltipWiggleRadius

#
public static int TooltipWiggleRadius { get; set; }
Gets or sets the wiggle radius (in pixels) which the mouse is allowed to move before the tooltip is nuked.

TrackFileStamps

#
public static bool TrackFileStamps { get; set; }

TrackPluginLoading

#
public static bool TrackPluginLoading { get; set; }
Gets or sets whether plugins are tracked during loading in order to detect plugins causing fatal crashes during load.

TryDownloadMissingPlugins

#
public static bool TryDownloadMissingPlugins { get; set; }
Gets or sets whether the 'Unrecognized Objects' dialog pops up on file load.

Methods

GetLoadMechanism

#
public static GH_LoadingDemand GetLoadMechanism(string pluginName)
Gets what load mechanism has been specified for a certain plugin.
Parameters:
pluginName (string)The name of the plugin file (without the extension).
Returns: The user-defined load mechanism.

IsLoadProtected

#
public static bool IsLoadProtected(string pluginName)
Gets whether a certain plugin is load protected.
Parameters:
pluginName (string)The name of the plugin file (without the extension).
Returns: True if the plugin is load protected, false if not.

SetLoadMechanism

#
public static void SetLoadMechanism(string pluginName, GH_LoadingDemand mechanism)
Sets the user defined load mechanism for a certain plugin.
Parameters:
pluginName (string)The name of the plugin file (without the extension).
mechanism (GH_LoadingDemand)Load mechanism for this plugin.

SetLoadProtected

#
public static void SetLoadProtected(string pluginName, bool loadProtect)
Sets whether a certain plugin is load protected.
Parameters:
pluginName (string)The name of the plugin file (without the extension).
loadProtect (bool)Load protection flag for this plugin.

UserOkayWithBakingInvalidObject

#
public static bool UserOkayWithBakingInvalidObject(string objectType = "object")
Show the warning for baking invalid objects, or return the default choice if the warning is disabled.
Parameters:
objectType (string = "object")
Returns: True if object ought to be baked, false if not.

Events

AuthorAddressChanged

#
public static event CentralSettings.AuthorAddressChangedEventHandler AuthorAddressChanged
Raised whenever the AuthorAddress field is changed.

AuthorCompanyChanged

#
public static event CentralSettings.AuthorCompanyChangedEventHandler AuthorCompanyChanged
Raised whenever the AuthorCompany field is changed.

AuthorCopyrightChanged

#
public static event CentralSettings.AuthorCopyrightChangedEventHandler AuthorCopyrightChanged
Raised whenever the AuthorCopyright field is changed.

AuthorEMailChanged

#
public static event CentralSettings.AuthorEMailChangedEventHandler AuthorEMailChanged
Raised whenever the AuthorEMail field is changed.

AuthorNameChanged

#
public static event CentralSettings.AuthorNameChangedEventHandler AuthorNameChanged
Raised whenever the AuthorName field is changed.

AuthorPhoneChanged

#
public static event CentralSettings.AuthorPhoneChangedEventHandler AuthorPhoneChanged
Raised whenever the AuthorPhone field is changed.

AuthorWebsiteChanged

#
public static event CentralSettings.AuthorWebsiteChangedEventHandler AuthorWebsiteChanged
Raised whenever the AuthorWebsite field is changed.

CanvasFancyWiresChanged

#
public static event CentralSettings.CanvasFancyWiresChangedEventHandler CanvasFancyWiresChanged
Raised whenever the CanvasFancyWires setting changes.

CanvasFullNamesChanged

#
public static event CentralSettings.CanvasFullNamesChangedEventHandler CanvasFullNamesChanged
Raised whenever the CanvasFullNames setting changes.

CanvasObjectIconsChanged

#
public static event CentralSettings.CanvasObjectIconsChangedEventHandler CanvasObjectIconsChanged
Raised whenever the CanvasObjectIcons setting changes.

CanvasObsoleteTagsChanged

#
public static event CentralSettings.CanvasObsoleteTagsChangedEventHandler CanvasObsoleteTagsChanged
Raised whenever the CanvasObsoleteTags setting changes.

CanvasRadialMenuChanged

#
public static event CentralSettings.CanvasRadialMenuChangedEventHandler CanvasRadialMenuChanged
Raised whenever the CanvasRadialMenu setting changes.

CanvasToolbarChanged

#
public static event CentralSettings.CanvasToolbarChangedEventHandler CanvasToolbarChanged
Raised whenever the CanvasToolbar setting changes.

CanvasZuiZoomLevelChanged

#
public static event CentralSettings.CanvasZuiZoomLevelChangedEventHandler CanvasZuiZoomLevelChanged
Raised whenever the CanvasZuiZoomLevel setting changes.

ComponentCascadeMenusChanged

#
public static event CentralSettings.ComponentCascadeMenusChangedEventHandler ComponentCascadeMenusChanged
Raised whenever the ComponentCascadeMenus setting changes.

CreateSolutionUndoRecordChanged

#
public static event CentralSettings.CreateSolutionUndoRecordChangedEventHandler CreateSolutionUndoRecordChanged
Raised whenever the CreateSolutionUndoRecord setting changes.

FormattingChanged

#
public static event CentralSettings.FormattingChangedEventHandler FormattingChanged
Raised whenever a formatting setting is changed.

LoadMechanismChanged

#
public static event CentralSettings.LoadMechanismChangedEventHandler LoadMechanismChanged
Raised whenever the load mechanism of a certain plugin changes.

LoadProtectionChanged

#
public static event CentralSettings.LoadProtectionChangedEventHandler LoadProtectionChanged
Raised whenever the load protection of a certain plugin changes.

PanelDefaultFontChanged

#
public static event CentralSettings.PanelDefaultFontChangedEventHandler PanelDefaultFontChanged
Raised whenever the PanelDefaultFontFamily or PanelDefaultFontSize settings change.

PreviewBumpZBufferChanged

#
public static event CentralSettings.PreviewBumpZBufferChangedEventHandler PreviewBumpZBufferChanged
Raised whenever the PreviewBumpZBuffer setting changes.

PreviewGumballsChanged

#
public static event CentralSettings.PreviewGumballsChangedEventHandler PreviewGumballsChanged
Raised whenever the PreviewGumballs setting changes.

PreviewMeshEdgesChanged

#
public static event CentralSettings.PreviewMeshEdgesChangedEventHandler PreviewMeshEdgesChanged
Raised whenever the PreviewMeshEdges setting changes.

PreviewPlaneRadiusChanged

#
public static event CentralSettings.PreviewPlaneRadiusChangedEventHandler PreviewPlaneRadiusChanged
Raised whenever the PreviewPlaneRadius setting changes.

PreviewPointStyleChanged

#
public static event CentralSettings.PreviewPointStyleChangedEventHandler PreviewPointStyleChanged
Raised whenever the PreviewPointStyle setting changes.

PruderyLevelChanged

#
public static event CentralSettings.PruderyLevelChangedEventHandler PruderyLevelChanged
Raised whenever the PruderyLevel setting changes.

RibbonAllIconsChanged

#
public static event CentralSettings.RibbonAllIconsChangedEventHandler RibbonAllIconsChanged
Raised whenever the RibbonAllIcons setting changes.

RibbonDrawTabIconsChanged

#
public static event CentralSettings.RibbonDrawTabIconsChangedEventHandler RibbonDrawTabIconsChanged
Raised whenever the RibbonDrawTabIcons setting changes.

RibbonSeparatorsChanged

#
public static event CentralSettings.RibbonSeparatorsChangedEventHandler RibbonSeparatorsChanged
Raised whenever the RibbonSeparators setting changes.

RibbonVisibleChanged

#
public static event CentralSettings.RibbonVisibleChangedEventHandler RibbonVisibleChanged
Raised whenever the RibbonVisible setting changes.

TemplateFileChanged

#
public static event CentralSettings.TemplateFileChangedEventHandler TemplateFileChanged
Raised whenever the TemplateFile property is changed.

TooltipWiggleRadiusChanged

#
public static event CentralSettings.TooltipWiggleRadiusChangedEventHandler TooltipWiggleRadiusChanged
Raised whenever the TooltipWiggleRadius setting changes.

UiScaleChanged

#
public static event CentralSettings.UiScaleChangedEventHandler UiScaleChanged
Raised whenever the UiScale setting changes.