[
{
"name": "dotnetstart",
"dataType": "namespace"
},
{
"name": "Rhino",
"dataType": "namespace",
"summary": "Contains commonly-used value types and classes used in Rhino."
},
{
"name": "Rhino.ApplicationSettings",
"dataType": "namespace",
"summary": "Static settings global to the entire Rhino application"
},
{
"name": "Rhino.Collections",
"dataType": "namespace"
},
{
"name": "Rhino.Commands",
"dataType": "namespace"
},
{
"name": "Rhino.Display",
"dataType": "namespace"
},
{
"name": "Rhino.DocObjects",
"dataType": "namespace",
"summary": "The DocObjects namespace contains types that correspond to geometry that is found in a document. \nGenerally, these types reference an attribute and have a distinctive ID."
},
{
"name": "Rhino.DocObjects.Custom",
"dataType": "namespace"
},
{
"name": "Rhino.DocObjects.SnapShots",
"dataType": "namespace"
},
{
"name": "Rhino.DocObjects.Tables",
"dataType": "namespace"
},
{
"name": "Rhino.FileIO",
"dataType": "namespace"
},
{
"name": "Rhino.FileIO.Nrbf",
"dataType": "namespace"
},
{
"name": "Rhino.Geometry",
"dataType": "namespace",
"summary": "The Geometry namespace contains geometric types used in Rhino. \nExamples are lines, curves, meshes and boundary representations."
},
{
"name": "Rhino.Geometry.Collections",
"dataType": "namespace"
},
{
"name": "Rhino.Geometry.Intersect",
"dataType": "namespace"
},
{
"name": "Rhino.Geometry.MeshRefinements",
"dataType": "namespace"
},
{
"name": "Rhino.Geometry.Morphs",
"dataType": "namespace"
},
{
"name": "Rhino.Input",
"dataType": "namespace",
"summary": "Classes related to getting user input for things like points, objects, and numbers"
},
{
"name": "Rhino.Input.Custom",
"dataType": "namespace"
},
{
"name": "Rhino.NodeInCode",
"dataType": "namespace"
},
{
"name": "Rhino.Notifications",
"dataType": "namespace"
},
{
"name": "Rhino.ObjectManager",
"dataType": "namespace"
},
{
"name": "Rhino.PlugIns",
"dataType": "namespace"
},
{
"name": "Rhino.Render",
"dataType": "namespace"
},
{
"name": "Rhino.Render.ChangeQueue",
"dataType": "namespace"
},
{
"name": "Rhino.Render.ChildSlotNames",
"dataType": "namespace"
},
{
"name": "Rhino.Render.CustomRenderMeshes",
"dataType": "namespace"
},
{
"name": "Rhino.Render.DataSources",
"dataType": "namespace"
},
{
"name": "Rhino.Render.Fields",
"dataType": "namespace"
},
{
"name": "Rhino.Render.ParameterNames",
"dataType": "namespace"
},
{
"name": "Rhino.Render.PostEffects",
"dataType": "namespace"
},
{
"name": "Rhino.Render.UI",
"dataType": "namespace"
},
{
"name": "Rhino.Runtime",
"dataType": "namespace"
},
{
"name": "Rhino.Runtime.InProcess",
"dataType": "namespace"
},
{
"name": "Rhino.Runtime.InteropWrappers",
"dataType": "namespace"
},
{
"name": "Rhino.Runtime.Notifications",
"dataType": "namespace"
},
{
"name": "Rhino.Runtime.RhinoAccounts",
"dataType": "namespace"
},
{
"name": "Rhino.UI",
"dataType": "namespace"
},
{
"name": "Rhino.UI.Controls",
"dataType": "namespace"
},
{
"name": "Rhino.UI.Controls.DataSource",
"dataType": "namespace"
},
{
"name": "Rhino.UI.Controls.Thumbnaillist",
"dataType": "namespace"
},
{
"name": "Rhino.UI.Controls.ThumbnailUI",
"dataType": "namespace"
},
{
"name": "Rhino.UI.Gumball",
"dataType": "namespace"
},
{
"namespace": "dotnetstart",
"name": "DotNetInitialization",
"dataType": "class",
"constructors": [
{
"signature": "DotNetInitialization()",
"summary": "Initializes a new instance of the DotNetInitialization class"
}
],
"methods": [
{
"signature": "System.Int32 Start(System.String args)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino",
"name": "AngleUnitSystem",
"dataType": "enum",
"summary": "ON::AngleUnitSystem identifies an angle unit system",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "ON::AngleUnitSystem::None indicates no angle unit system is specified and model angle unit system should be used."
},
{
"signature": "Turns = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "1 turn = 2pi radians."
},
{
"signature": "Radians = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "1 turn = 2pi radians."
},
{
"signature": "Degrees = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "360 arc degrees = 1 turn = 2pi radians"
},
{
"signature": "Minutes = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "60 arc minutes = 1 arc degree"
},
{
"signature": "Seconds = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "60 arc seconds = 1 arc minute"
},
{
"signature": "Gradians = 6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "400 gradians = 2pi radians."
},
{
"signature": "Unset = 255",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The ON::AngleUnitSystem::Unset is used to indicates no angle unit system has been specified in user interface code."
}
]
},
{
"namespace": "Rhino",
"name": "AntialiasLevel",
"dataType": "enum",
"summary": "Provides the anti-alias levels used for render quality",
"since": "6.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Low quality"
},
{
"signature": "Draft = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Draft quality"
},
{
"signature": "Good = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Good quality"
},
{
"signature": "High = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "High quality"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "AppearanceSettings",
"dataType": "class",
"summary": "Provides static methods and properties to deal with the appearance of the application.",
"constructors": [
{
"signature": "AppearanceSettings()",
"summary": "Initializes a new instance of the AppearanceSettings class"
}
],
"properties": [
{
"signature": "bool BlackWhiteSwitching",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Mode where white objects are drawn black when on a light background and black objects are drawn white when on a dark background",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color CommandPromptBackgroundColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the command prompt background.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int CommandPromptFontSize",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Size of font used in command prompt (in points)",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Color CommandPromptHypertextColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the command prompt hypertext.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "CommandPromptPosition CommandPromptPosition",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the command prompt position.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color CommandPromptTextColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the command prompt text.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color CrosshairColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the crosshair icon.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool CrosshairsAlignedToScreen",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines if the cross hairs are drawn horizontally and vertically on the screen (as if fixed to the camera) instead of running along the construction plane's x and y axes. When enabled, the cross hairs stay vertical and horizontal as the view is rotated, for example in a perspective viewport.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double CrosshairScreenLength",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines the length, in pixels, of the cross hairs if they are visible.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color CurrentLayerBackgroundColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color used by the layer manager dialog as the background color for the current layer.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string DefaultFontFaceName",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the default font face name used in Rhino.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Color DefaultLayerColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the default layer color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color DefaultObjectColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the default color for new objects.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int DirectionArrowIconHeadSize",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "length of direction arrowhead icon in pixels.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int DirectionArrowIconShaftSize",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "length of direction arrow shaft icon in pixels.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool EchoCommandsToHistoryWindow",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines if command names are written to the history window.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool EchoPromptsToHistoryWindow",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines if prompt messages are written to the history window.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color EditCandidateColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of objects that are eligible to be edited.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Color FeedbackColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the feedback color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color FrameBackgroundColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the background color of the frame.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridThickLineColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the thick line of the grid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridThinLineColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the thin line of the grid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridXAxisLineColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the X axis of the grid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridYAxisLineColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the Y axis of the grid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridZAxisLineColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the Z axis of the grid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int LanguageIdentifier",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the language identifier.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color LockedObjectColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "color used to draw locked objects.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool MenuVisible",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines if the File menu is visible.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color PageviewPaperColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the paper background. A rectangle is drawn into the background of page views to represent the printed area. The alpha portion of the color is used to draw the paper blended into the background",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int PreviousLanguageIdentifier",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the previous language identifier.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color SelectedObjectColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The color used to draw selected objects. The default is yellow, but this can be customized by the user.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color SelectionWindowCrossingFillColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Color used to fill selection crossing window",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Color SelectionWindowCrossingStrokeColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Color used to draw stroke for selection crossing window",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Color SelectionWindowFillColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Color used to fill selection window",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Color SelectionWindowStrokeColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Color used to draw stroke for selection window",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowCrosshairs",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines if cross hairs are visible.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowCursorWhenCrosshairsVisible",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowFullPathInTitleBar",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines if the full path of the document is shown in the Rhino title bar.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowLayoutDropShadow",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Display the drop shadow of layouts",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowOsnapBar",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Shows or hides the object snap user interface.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowSelectionFilterBar",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Shows or hides the selection filter user interface.",
"since": "8.2",
"property": ["get", "set"]
},
{
"signature": "bool ShowSideBar",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Shows or hides the side bar user interface.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowStatusBar",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Shows or hides the status bar user interface.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowTitleBar",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Shows or hides title bar.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowViewportTitles",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Shows or hides viewport titles.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color TrackingColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the tracking color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool UsePaintColors",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating if logical paint colors should be used.",
"since": "5.0",
"obsolete": "custom colors are always used",
"property": ["get"]
},
{
"signature": "Color ViewportBackgroundColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the viewport background color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ViewportTabsVisibleAtStart",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Display viewport tabs at start",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color WorldCoordIconXAxisColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the world coordinate X axis.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color WorldCoordIconYAxisColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the world coordinate Y axis.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color WorldCoordIconZAxisColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the world coordinate Z axis.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "Color DefaultPaintColor(PaintColor whichColor, System.Boolean darkMode)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get a default paint color for Rhino. The current paint color may be different than the default",
"since": "8.0",
"parameters": [
{
"name": "whichColor",
"type": "PaintColor",
"summary": "The color to retrieve"
},
{
"name": "darkMode",
"type": "System.Boolean",
"summary": "If True gets the default dark mode color otherwise return the default light mode color"
}
]
},
{
"signature": "Color DefaultPaintColor(PaintColor whichColor)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get a default paint color for Rhino. The current paint color may be different than the default",
"since": "7.0",
"parameters": [
{
"name": "whichColor",
"type": "PaintColor",
"summary": "The color to retrieve"
}
]
},
{
"signature": "Color DefaultWidgetColor(WidgetColor whichColor)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get a default widget color for Rhino. The current widget color may be different than the default",
"since": "8.0",
"parameters": [
{
"name": "whichColor",
"type": "WidgetColor",
"summary": "The color to retrieve"
}
],
"returns": "A .Net library color."
},
{
"signature": "AppearanceSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "5.0",
"returns": "An instance of a class that represents all the settings as they appear in the Rhino _Options dialog, joined in a single class."
},
{
"signature": "AppearanceSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "5.0",
"returns": "An instance of a class that represents all the default settings joined together."
},
{
"signature": "AppearanceSettingsState GetDefaultState(System.Boolean darkMode)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "8.0",
"returns": "An instance of a class that represents all the default settings joined together."
},
{
"signature": "Color GetPaintColor(PaintColor whichColor, System.Boolean compute)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gat a paint color. This overload provides a compute option for cases where colors are computed when they are \"unset\" colors.",
"since": "7.1",
"parameters": [
{
"name": "whichColor",
"type": "PaintColor",
"summary": ""
},
{
"name": "compute",
"type": "System.Boolean",
"summary": "if true, a color is computed in some cases"
}
]
},
{
"signature": "Color GetPaintColor(PaintColor whichColor)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the color that is currently associated with a paint color.",
"since": "5.0",
"parameters": [
{
"name": "whichColor",
"type": "PaintColor",
"summary": "A color association."
}
],
"returns": "A .Net library color."
},
{
"signature": "Color GetWidgetColor(WidgetColor whichColor)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the .Net library color that is currently associated with a widget color.",
"since": "6.0",
"parameters": [
{
"name": "whichColor",
"type": "WidgetColor",
"summary": "A color association."
}
],
"returns": "A .Net library color."
},
{
"signature": "System.Boolean InitialMainWindowPosition(out Rectangle bounds)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Location where the Main Rhino window attempts to show when the application is first started.",
"since": "6.0",
"parameters": [
{
"name": "bounds",
"type": "Rectangle",
"summary": "The rectangle in which the main window attempts to shows is assigned to this out parameter during the call."
}
],
"returns": "False if the information could not be retrieved."
},
{
"signature": "System.Void RestoreDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Commits the default settings as the current settings.",
"since": "5.0"
},
{
"signature": "System.Void SetPaintColor(PaintColor whichColor, Color c, System.Boolean forceUiUpdate)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets the logical paint color association to a specific .Net library color.",
"since": "5.0",
"parameters": [
{
"name": "whichColor",
"type": "PaintColor",
"summary": "A logical color association."
},
{
"name": "c",
"type": "Color",
"summary": "A .Net library color."
},
{
"name": "forceUiUpdate",
"type": "System.Boolean",
"summary": "True if the UI should be forced to update."
}
]
},
{
"signature": "System.Void SetPaintColor(PaintColor whichColor, Color c)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets the logical paint color association to a specific .Net library color, without forced UI update.",
"since": "5.0",
"parameters": [
{
"name": "whichColor",
"type": "PaintColor",
"summary": "A logical color association."
},
{
"name": "c",
"type": "Color",
"summary": "A .Net library color."
}
]
},
{
"signature": "System.Boolean SetToDarkMode()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Set UI to the default dark mode color scheme",
"since": "8.2",
"returns": "True on sucess"
},
{
"signature": "System.Boolean SetToLightMode()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Set UI to the default light mode color scheme",
"since": "8.2",
"returns": "True on sucess"
},
{
"signature": "System.Void SetWidgetColor(WidgetColor whichColor, Color c, System.Boolean forceUiUpdate)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets the logical widget color association to a specific .Net library color.",
"since": "6.0",
"parameters": [
{
"name": "whichColor",
"type": "WidgetColor",
"summary": "A logical color association."
},
{
"name": "c",
"type": "Color",
"summary": "A .Net library color."
},
{
"name": "forceUiUpdate",
"type": "System.Boolean",
"summary": "True if the UI should be forced to update."
}
]
},
{
"signature": "System.Void SetWidgetColor(WidgetColor whichColor, Color c)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets the logical widget color association to a specific .Net library color, without forced UI update.",
"since": "6.0",
"parameters": [
{
"name": "whichColor",
"type": "WidgetColor",
"summary": "A logical color association."
},
{
"name": "c",
"type": "Color",
"summary": "A .Net library color."
}
]
},
{
"signature": "System.Void UpdateFromState(AppearanceSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets all settings to a particular defined joined state.",
"since": "5.0",
"parameters": [
{
"name": "state",
"type": "AppearanceSettingsState",
"summary": "A joined settings object."
}
]
},
{
"signature": "System.Boolean UsingDefaultDarkModeColors()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Determine if Rhino is running with default dark mode color settings",
"since": "8.2"
},
{
"signature": "System.Boolean UsingDefaultLightModeColors()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Determine if Rhino is running with default light mode color settings",
"since": "8.2"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "AppearanceSettingsState",
"dataType": "class",
"summary": "snapshot of the values in AppearanceSettings",
"properties": [
{
"signature": "Color CommandPromptBackgroundColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the command prompt background color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string CommandPromptFontName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Name of the font used in the command prompt",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int CommandPromptFontSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Size of the font used in the command prompt (in points)",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Color CommandPromptHypertextColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the command prompt hypertext color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color CommandPromptTextColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the command prompt text color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color CrosshairColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the crosshair color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool CrosshairsAlignedToScreen",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines if the cross hairs are drawn horizontally and vertically on the screen instead of running along the construction plane's x and y axes.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double CrosshairScreenLength",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines the length, in pixels, of the cross hairs if they are visible.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color CurrentLayerBackgroundColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color used by the layer manager dialog as the background color for the current layer.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string DefaultFontFaceName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the name of the default font face.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color DefaultLayerColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the default layer color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color DefaultObjectColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the default object color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int DirectionArrowIconHeadSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the arrow icon head size.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int DirectionArrowIconShaftSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the arrow icon shaft size.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool EchoCommandsToHistoryWindow",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines if command names are written to the history window.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool EchoPromptsToHistoryWindow",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines if prompt messages are written to the history window.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color EditCandidateColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of objects that are eligible to be edited.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Color FeedbackColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the feedback color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color FrameBackgroundColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the frame background color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridThickLineColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the thick line in the grid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridThinLineColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the thin line in the grid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridXAxisLineColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of X axis line in the grid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridYAxisLineColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of Y axis line in the grid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridZAxisLineColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of Z axis line in the grid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color LockedObjectColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color used to draw locked objects.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool MenuVisible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get/Set menu visibility",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color PageviewPaperColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "CRhinoPageView paper background. A rectangle is drawn into the background of page views to represent the printed area. The alpha portion of the color is used to draw the paper blended into the background",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color SelectedObjectColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The color used to draw selected objects. The default is yellow, but this can be customized by the user.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color SelectionWindowCrossingFillColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color used to fill a crossing selection window",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Color SelectionWindowCrossingStrokeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color used to draw the stroke of a crossing selection window",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Color SelectionWindowFillColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color used to fill a selection window",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Color SelectionWindowStrokeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color used to draw the stroke of a selection window",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowCrosshairs",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines if cross hairs are visible.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowCursorWhenCrosshairsVisible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowFullPathInTitleBar",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines if the full path of the document is shown in the Rhino title bar.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowLayoutDropShadow",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Display the drop shadow of layouts",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowStatusBar",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get/Set status bar visibility",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowTitleBar",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shows or hides title bar.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowViewportTitles",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get/Set viewport title visibility",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color TrackingColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the tracking color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color ViewportBackgroundColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the viewport background color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ViewportTabsVisibleAtStart",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Display viewport tabs at start",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color WorldCoordIconXAxisColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the world X axis of the world coordinates icon, appearing usually bottom left in viewports.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color WorldCoordIconYAxisColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the world Y axis of the world coordinate icon, appearing usually bottom left in viewports.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color WorldCoordIconZAxisColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the world Z axis of the world coordinate icon, appearing usually bottom left in viewports.",
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ChooseOneObjectSettings",
"dataType": "class",
"summary": "Contains static methods and properties to modify \"choose one object\" settings.",
"since": "8.0",
"constructors": [
{
"signature": "ChooseOneObjectSettings()",
"summary": "Initializes a new instance of the ChooseOneObjectSettings class"
}
],
"properties": [
{
"signature": "bool AutomaticResize",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "AutomaticResize",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool DynamicHighlight",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "DynamicHighlight",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool FollowCursor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "FollowCursor",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color HighlightColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "HighlightColor",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int MaxAutoResizeItems",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "MaxAutoResizeItems",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowAllOption",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "ShowAllOption",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowObjectColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "ShowObjectColor",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowObjectLayer",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "ShowObjectLayer",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowObjectName",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "ShowObjectName",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowObjectType",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "ShowObjectType",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowObjectTypeDetails",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "ShowObjectTypeDetails",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowTitlebarAndBorder",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "ShowTitlebarAndBorder",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool UseCustomColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "UseCustomColor",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int XOffset",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "XOffset",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int YOffset",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "YOffset",
"since": "8.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ChooseOneObjectSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "8.0"
},
{
"signature": "ChooseOneObjectSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "8.0"
},
{
"signature": "System.Void RestoreDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Commits the default settings as the current settings.",
"since": "8.0"
},
{
"signature": "System.Void UpdateFromState(ChooseOneObjectSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets all settings to a particular defined joined state.",
"since": "8.0",
"parameters": [
{
"name": "state",
"type": "ChooseOneObjectSettingsState",
"summary": "The particular state."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ChooseOneObjectSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of ChooseOneObjectSettings .",
"since": "8.0",
"properties": [
{
"signature": "bool AutomaticResize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "AutomaticResize",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool DynamicHighlight",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "DynamicHighlight",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool FollowCursor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "FollowCursor",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color HighlightColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "HighlightColor",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int MaxAutoResizeItems",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "MaxAutoResizeItems",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowAllOption",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "ShowAllOption",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowObjectColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "ShowObjectColor",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowObjectLayer",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "ShowObjectLayer",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowObjectName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "ShowObjectName",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowObjectType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "ShowObjectType",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowObjectTypeDetails",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "ShowObjectTypeDetails",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowTitlebarAndBorder",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "ShowTitlebarAndBorder",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool UseCustomColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "UseCustomColor",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int XOffset",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "XOffset",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int YOffset",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "YOffset",
"since": "8.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ClipboardState",
"dataType": "enum",
"summary": "Defines enumerated constant values for different behavior that is related to clipboard data.",
"since": "5.0",
"values": [
{
"signature": "KeepData = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Always keep clipboard data, regardless of size and never prompt the user."
},
{
"signature": "DeleteData",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Always delete clipboard data, regardless of size and never prompt the user."
},
{
"signature": "PromptWhenBig",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Prompt user when clipboard memory is large."
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "CommandAlias",
"dataType": "class",
"summary": "A command alias is a set of characters that can be defined to run a macro",
"constructors": [
{
"signature": "CommandAlias(string alias, string macro, bool instant)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Create a new command alias",
"since": "9.0"
}
],
"properties": [
{
"signature": "string Alias",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "String that represents an alias",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool Instant",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Is the command alias instant? Instant aliases run without the need for spacebar or enter",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "string Macro",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Macro to run when an alias is input",
"since": "9.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "CommandAliasList",
"dataType": "class",
"summary": "Contains static methods and properties to access command aliases.",
"constructors": [
{
"signature": "CommandAliasList()",
"summary": "Initializes a new instance of the CommandAliasList class"
}
],
"properties": [
{
"signature": "int Count",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns the number of command alias in Rhino.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "int InstantAliasDelayMilliseconds",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Timer delay to use before triggering instant aliases",
"since": "9.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Boolean Add(System.String alias, System.String macro)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Adds a new command alias to Rhino.",
"since": "5.0",
"parameters": [
{
"name": "alias",
"type": "System.String",
"summary": "[in] The name of the command alias."
},
{
"name": "macro",
"type": "System.String",
"summary": "[in] The command macro to run when the alias is executed."
}
],
"returns": "True if successful."
},
{
"signature": "System.Void Clear()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Removes all aliases from the list.",
"since": "5.0"
},
{
"signature": "System.Boolean Delete(System.String alias)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Deletes an existing command alias from Rhino.",
"since": "5.0",
"parameters": [
{
"name": "alias",
"type": "System.String",
"summary": "[in] The name of the command alias."
}
],
"returns": "True if successful."
},
{
"signature": "CommandAlias FindAlias(System.String alias)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Find an existing CommandAlias given the alias string",
"since": "9.0"
},
{
"signature": "CommandAlias GetAlias(System.Int32 index)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get command alias from the list",
"since": "9.0",
"returns": "None is index is out of range"
},
{
"signature": "System.Collections.Generic.Dictionary GetDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs a dictionary containing as keys the default names and as value the default macro. \nThe returned dictionary contains a copy of the settings.",
"since": "5.0",
"returns": "A new dictionary with the default name/macro combinations."
},
{
"signature": "System.String GetMacro(System.String alias)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns the macro of a command alias.",
"since": "5.0",
"parameters": [
{
"name": "alias",
"type": "System.String",
"summary": "[in] The name of the command alias."
}
]
},
{
"signature": "System.String[] GetNames()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns a list of command alias names.",
"since": "5.0",
"returns": "An array of strings. This can be empty."
},
{
"signature": "System.Boolean IsAlias(System.String alias)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Verifies that a command alias exists in Rhino.",
"since": "5.0",
"parameters": [
{
"name": "alias",
"type": "System.String",
"summary": "[in] The name of the command alias."
}
],
"returns": "True if the alias exists."
},
{
"signature": "System.Boolean IsDefault()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Computes a value indicating if the current alias list is the same as the default alias list.",
"since": "5.0",
"returns": "True if the current alias list is exactly equal to the default alias list; False otherwise."
},
{
"signature": "System.Boolean SetMacro(System.String alias, System.String macro)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Modifies the macro of a command alias.",
"since": "5.0",
"parameters": [
{
"name": "alias",
"type": "System.String",
"summary": "[in] The name of the command alias."
},
{
"name": "macro",
"type": "System.String",
"summary": "[in] The new command macro to run when the alias is executed."
}
],
"returns": "True if successful."
},
{
"signature": "System.Collections.Generic.Dictionary ToDictionary()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs a new dictionary that contains: as keys all names and as values all macros. \nModifications to this dictionary do not affect any Rhino command alias.",
"since": "5.0",
"returns": "The new dictionary."
},
{
"signature": "System.Void Update(IEnumerable aliases, System.Boolean replaceAll)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Add or modify the command aliases with a list of aliases",
"since": "9.0"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "CommandPromptPosition",
"dataType": "enum",
"summary": "Defines enumerated constant values for default positions of the command prompt inside the frame of the full editor window.",
"since": "5.0",
"values": [
{
"signature": "Top = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The command prompt is shown on top."
},
{
"signature": "Bottom = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The command prompt is shown at the bottom."
},
{
"signature": "Floating = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The command prompt is shown floating."
},
{
"signature": "Hidden = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The command prompt is shown hidden."
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "CursorMode",
"dataType": "enum",
"summary": "Defines enumerated constant values for particular OSnap cursor colors.",
"since": "5.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No OSnap cursor."
},
{
"signature": "BlackOnWhite",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Black on white OSnap cursor."
},
{
"signature": "WhiteOnBlack",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "White on black OSnap cursor."
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "CursorTooltipSettings",
"dataType": "class",
"summary": "Cursor tooltips place information at the cursor location. Note: Turning on cursor tooltips turns off object snap cursors.",
"constructors": [
{
"signature": "CursorTooltipSettings()",
"summary": "Initializes a new instance of the CursorTooltipSettings class"
}
],
"properties": [
{
"signature": "bool AutoSuppress",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Attempts to display only the most useful tooltip.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color BackgroundColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Tooltip background color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool CommandPromptPane",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Displays the current command prompt.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DistancePane",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Displays the distance from the last picked point.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool EnableGumballToolTips",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Turns on/off gumball tooltips",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Point Offset",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The x and y distances in pixels from the cursor location to the tooltip.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool OsnapPane",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Displays the current object snap selection.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool PointPane",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Displays the current construction plane coordinates.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool RelativePointPane",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Displays the relative construction plane coordinates and angle from the last picked point.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color TextColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Tooltip text color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool TooltipsEnabled",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Turns on/off cursor tooltips.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "CursorTooltipSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings.",
"since": "5.0",
"returns": "A new cursor tooltip state with current settings."
},
{
"signature": "CursorTooltipSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the cursor tooltip factory settings.",
"since": "5.0",
"returns": "A new cursor tooltip state with factory settings."
},
{
"signature": "System.Void UpdateFromState(CursorTooltipSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "9.0"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "CursorTooltipSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of CursorTooltipSettings .",
"constructors": [
{
"signature": "CursorTooltipSettingsState()",
"summary": "Initializes a new instance of the CursorTooltipSettingsState class"
}
],
"properties": [
{
"signature": "bool AutoSuppress",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Attempts to display only the most useful tooltip.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color BackgroundColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Tooltip background color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool CommandPromptPane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Displays the current command prompt.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DistancePane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Displays the distance from the last picked point.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool EnableGumballToolTips",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turns on/off gumball tooltips",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Point Offset",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The x and y distances in pixels from the cursor location to the tooltip.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool OsnapPane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Displays the current object snap selection.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool PointPane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Displays the current construction plane coordinates.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool RelativePointPane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Displays the relative construction plane coordinates and angle from the last picked point.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color TextColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Tooltip text color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool TooltipsEnabled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turns on/off cursor tooltips.",
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "CurvatureAnalysisSettings",
"dataType": "class",
"summary": "Contains static methods and properties to modify curvature analysis-related commands.",
"constructors": [
{
"signature": "CurvatureAnalysisSettings()",
"summary": "Initializes a new instance of the CurvatureAnalysisSettings class"
}
],
"properties": [
{
"signature": "Interval GaussRange",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Gaussian curvature range.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Interval MaxRadiusRange",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Maximum Radius curvature range.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Interval MeanRange",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Mean curvature range.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Interval MinRadiusRange",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Minimum Radius curvature range.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowIsoCurves",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to show isocurves.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "CurvatureStyle Style",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the curvature analysis style.",
"since": "6.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Boolean CalculateCurvatureAutoRange(IEnumerable meshes, ref CurvatureAnalysisSettingsState settings)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "CurvatureAnalysisSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "6.0"
},
{
"signature": "CurvatureAnalysisSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "6.0"
},
{
"signature": "System.Void RestoreDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Commits the default settings as the current settings.",
"since": "6.0"
},
{
"signature": "System.Void UpdateFromState(CurvatureAnalysisSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets all settings to a particular defined joined state.",
"since": "6.0",
"parameters": [
{
"name": "state",
"type": "CurvatureAnalysisSettingsState",
"summary": "The particular state."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "CurvatureAnalysisSettings.CurvatureStyle",
"dataType": "enum",
"summary": "Curvature analysis styles",
"since": "6.0",
"values": [
{
"signature": "Gaussian = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Gaussian curvature"
},
{
"signature": "Mean = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Mean curvature"
},
{
"signature": "MinRadius = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Minimum radius curvature"
},
{
"signature": "MaxRadius = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Maximum radius curvature"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "CurvatureAnalysisSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of CurvatureAnalysisSettings .",
"properties": [
{
"signature": "Interval GaussRange",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Gaussian curvature range.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Interval MaxRadiusRange",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Maximum Radius curvature range.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Interval MeanRange",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Mean curvature range.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Interval MinRadiusRange",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Minimum Radius curvature range.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowIsoCurves",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to show isocurves.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "CurvatureStyle Style",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the curvature analysis style.",
"since": "6.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "CurvatureGraphSettings",
"dataType": "class",
"summary": "Contains static methods and properties to modify curvature graph commands.",
"since": "8.0",
"constructors": [
{
"signature": "CurvatureGraphSettings()",
"summary": "Initializes a new instance of the CurvatureGraphSettings class"
}
],
"properties": [
{
"signature": "Color CurveHairColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the curve hair color;",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int HairDensity",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the hair density;",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int HairScale",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the hair scale;",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int SampleDensity",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the sampling density;",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool SrfUHair",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the surface U hairs are on;",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool SrfVHair",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the surface V hairs are on;",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color SurfaceUHairColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the surface U hair color;",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color SurfaceVHairColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the surface V hair color;",
"since": "8.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "CurvatureGraphSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "8.0"
},
{
"signature": "CurvatureGraphSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "8.0"
},
{
"signature": "System.Void RestoreDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Commits the default settings as the current settings.",
"since": "8.0"
},
{
"signature": "System.Void UpdateFromState(CurvatureGraphSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets all settings to a particular defined joined state.",
"since": "8.0",
"parameters": [
{
"name": "state",
"type": "CurvatureGraphSettingsState",
"summary": "The particular state."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "CurvatureGraphSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of CurvatureGraphSettings .",
"since": "8.0",
"properties": [
{
"signature": "Color CurveHairColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the curve hair color.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int HairDensity",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the hair density.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int HairScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the hair scale.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int SampleDensity",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the sample density.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool SrfUHair",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the whether to show surface U hairs",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool SrfVHair",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the whether to show surface V hairs",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color SurfaceUHairColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the surface U hair color.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color SurfaceVHairColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the surface V hair color.",
"since": "8.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "DirectionAnalysisSettings",
"dataType": "class",
"summary": "Contains static methods and properties to modify the visibility of edges in edge-related commands.",
"constructors": [
{
"signature": "DirectionAnalysisSettings()",
"summary": "Initializes a new instance of the DirectionAnalysisSettings class"
}
],
"properties": [
{
"signature": "Color Color",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a color used to show curve or surface direction.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool Direction",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the direction.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool U",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the U dir.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool V",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the V dir.",
"since": "9.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "DirectionAnalysisSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "9.0"
},
{
"signature": "DirectionAnalysisSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "9.0"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "DirectionAnalysisSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of DirectionAnalysisSettings .",
"properties": [
{
"signature": "Color Color",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a color used to display the direction.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool Direction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the direction.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool U",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the U dir.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool V",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the V dir.",
"since": "9.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "DraftAngleAnalysisSettings",
"dataType": "class",
"constructors": [
{
"signature": "DraftAngleAnalysisSettings()",
"summary": "Initializes a new instance of the DraftAngleAnalysisSettings class"
}
],
"properties": [
{
"signature": "Interval AngleRange",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The angle range.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowIsoCurves",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Show isoparametric curves.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Vector3d UpDirection",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The up direction.",
"since": "7.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "DraftAngleAnalysisSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "7.0"
},
{
"signature": "DraftAngleAnalysisSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "7.0"
},
{
"signature": "System.Void RestoreDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Commits the default settings as the current settings.",
"since": "7.0"
},
{
"signature": "System.Void UpdateFromState(DraftAngleAnalysisSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets all settings to a particular defined joined state.",
"since": "7.0",
"parameters": [
{
"name": "state",
"type": "DraftAngleAnalysisSettingsState",
"summary": "The particular state."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "DraftAngleAnalysisSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of DraftAngleAnalysisSettings",
"properties": [
{
"signature": "Interval AngleRange",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The angle range.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowIsoCurves",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show isoparametric curves.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Vector3d UpDirection",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The up direction.",
"since": "7.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "EdgeAnalysisSettings",
"dataType": "class",
"summary": "Contains static methods and properties to modify the visibility of edges in edge-related commands.",
"constructors": [
{
"signature": "EdgeAnalysisSettings()",
"summary": "Initializes a new instance of the EdgeAnalysisSettings class"
}
],
"properties": [
{
"signature": "Color ShowEdgeColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a color used to enhance display edges in commands like _ShowEdges and _ShowNakedEdges.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int ShowEdges",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value referring to the group of edges that are targeted. \n0 = all. \n1 = naked. \n2 = non-manifold.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "EdgeAnalysisSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "5.0"
},
{
"signature": "EdgeAnalysisSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "5.0"
},
{
"signature": "System.Void RestoreDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Commits the default settings as the current settings.",
"since": "5.0"
},
{
"signature": "System.Void UpdateFromState(EdgeAnalysisSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets all settings to a particular defined joined state.",
"since": "5.0",
"parameters": [
{
"name": "state",
"type": "EdgeAnalysisSettingsState",
"summary": "The particular state."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "EdgeAnalysisSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of EdgeAnalysisSettings .",
"properties": [
{
"signature": "Color ShowEdgeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a color used to enhance display edges in commands like _ShowEdges and _ShowNakedEdges.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int ShowEdges",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value referring to the group of edges that are targeted. \n0 = all. \n1 = naked. \n2 = non-manifold.",
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "EmapAnalysisSettings",
"dataType": "class",
"summary": "Contains static methods and properties to modify the visibility of curve ends.",
"constructors": [
{
"signature": "EmapAnalysisSettings()",
"summary": "Initializes a new instance of the EmapAnalysisSettings class"
}
],
"properties": [
{
"signature": "bool BlendWithObjectColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to blend the image with the object's color.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "string FileName",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the current emap file name.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowIsoparams",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display iso curves.",
"since": "9.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "EmapAnalysisSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "9.0"
},
{
"signature": "System.String[] GetDefaultFileNames()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get list of emap's Default MRU filenames",
"since": "9.0"
},
{
"signature": "EmapAnalysisSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "9.0"
},
{
"signature": "System.String[] GetFileNames()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get available list of emap filenames",
"since": "9.0"
},
{
"signature": "System.Void SetFileNames(IEnumerable filenames)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Set available list of emap filenames",
"since": "9.0"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "EmapAnalysisSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of EmapAnalysisSettings .",
"properties": [
{
"signature": "bool BlendWithObjectColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to blend the image with the object's color.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "String FileName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the current emap file name.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowIsoparams",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display iso curves.",
"since": "9.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "EndAnalysisSettings",
"dataType": "class",
"summary": "Contains static methods and properties to modify the visibility of curve ends.",
"constructors": [
{
"signature": "EndAnalysisSettings()",
"summary": "Initializes a new instance of the EndAnalysisSettings class"
}
],
"properties": [
{
"signature": "bool ClosedSeams",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the closed curve seam points.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color Color",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a color used to display the points.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool OpenEnds",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the open curve end points.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool OpenStarts",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the open curve start points.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool PolycurveJoints",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the polycurve joint points.",
"since": "9.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "EndAnalysisSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "9.0"
},
{
"signature": "EndAnalysisSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "9.0"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "EndAnalysisSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of EndAnalysisSettings .",
"properties": [
{
"signature": "bool ClosedSeams",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the closed curve seam points.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color Color",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a color used to display the points.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool OpenEnds",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the open curve end points.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool OpenStarts",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the open curve start points.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool PolycurveJoints",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the polycurve joint points.",
"since": "9.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "FileSettings",
"dataType": "class",
"summary": "Contains static methods and properties relating Rhino files.",
"constructors": [
{
"signature": "FileSettings()",
"summary": "Initializes a new instance of the FileSettings class"
}
],
"properties": [
{
"signature": "bool AutoSaveEnabled",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Enables or disables Rhino's automatic file saving mechanism.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string AutoSaveFile",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "the file name used by Rhino's automatic file saving mechanism.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "TimeSpan AutoSaveInterval",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "how often the document will be saved when Rhino's automatic file saving mechanism is enabled.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool AutoSaveMeshes",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "save render and display meshes in autosave file.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string BackupFileFolder",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns or sets the location of Rhino's backup files.",
"property": ["get", "set"]
},
{
"signature": "bool ClipboardCopyToPreviousRhinoVersion",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that decides if copies to the clipboard are performed in both the current and previous Rhino clipboard formats. This means you will double the size of what is saved in the clipboard but will be able to copy from the current to the previous version using the clipboard.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ClipboardState ClipboardOnExit",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines what to do with clipboard data on exit.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool CreateBackupFiles",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that controls the creation of backup files.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool CreateOtherBackupFiles",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that controls the creation of other types of backup files.",
"property": ["get", "set"]
},
{
"signature": "string DefaultRuiFile",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the path to the default RUI file.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string ExecutableFolder",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns the directory where the main Rhino executable is located.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool FileLockingEnabled",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Ensure that only one person at a time can have a file open for saving.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool FileLockingOpenWarning",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether to display the information dialog which identifies computer files.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string HelpFilePath",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the Rhino help file path.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "DirectoryInfo InstallFolder",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns Rhino's installation folder.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string LocalProfileDataFolder",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get full path to a Rhino specific sub-folder under the per-user Local (non-roaming) Profile folder. This is the folder where user-specific data is stored. On Windows 7, 8, usually someplace like: \"C:\\Users\\[USERNAME]\\AppData\\Local\\McNeel\\Rhinoceros\\[VERSION_NUMBER]\\\"",
"since": "5.8",
"property": ["get"]
},
{
"signature": "bool SaveViewChanges",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "True for users who consider view changes a document change.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int SearchPathCount",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the amount of search paths that are currently defined.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string TemplateFile",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns or sets the location of Rhino's template file.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string TemplateFolder",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns or sets the location of Rhino's template files.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string WorkingFolder",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns or sets Rhino's working directory, or folder. The working folder is the default folder for all file operations.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Int32 AddSearchPath(System.String folder, System.Int32 index)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Adds a new imagePath to Rhino's search imagePath list. See \"Options Files settings\" in the Rhino help file for more details.",
"since": "5.0",
"parameters": [
{
"name": "folder",
"type": "System.String",
"summary": "[in] The valid folder, or imagePath, to add."
},
{
"name": "index",
"type": "System.Int32",
"summary": "[in] A zero-based position index in the search imagePath list to insert the string. If -1, the imagePath will be appended to the end of the list."
}
],
"returns": "The index where the item was inserted if success. \n-1 on failure."
},
{
"signature": "System.String[] AutoSaveBeforeCommands()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Input list of commands that force AutoSave prior to running.",
"since": "5.0"
},
{
"signature": "System.String DefaultTemplateFolderForLanguageID(System.Int32 languageID)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns the default template folder for a given language id.",
"since": "8.0",
"returns": "The default template folder as string."
},
{
"signature": "System.Boolean DeleteSearchPath(System.String folder)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Removes an existing imagePath from Rhino's search imagePath list. See \"Options Files settings\" in the Rhino help file for more details.",
"since": "5.0",
"parameters": [
{
"name": "folder",
"type": "System.String",
"summary": "[in] The valid folder, or imagePath, to remove."
}
],
"returns": "True or False indicating success or failure."
},
{
"signature": "System.String FindFile(System.String fileName)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Searches for a file using Rhino's search imagePath. Rhino will look for a file in the following locations: 1. The current document's folder. 2. Folder's specified in Options dialog, File tab. 3. Rhino's System folders.",
"since": "5.0",
"parameters": [
{
"name": "fileName",
"type": "System.String",
"summary": "short file name to search for."
}
],
"returns": "full imagePath on success; None on error."
},
{
"signature": "FileSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns the current state.",
"since": "5.0",
"returns": "A new instance containing the current state."
},
{
"signature": "System.String GetDataFolder(System.Boolean currentUser)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the data folder for machine or current user.",
"since": "5.0",
"parameters": [
{
"name": "currentUser",
"type": "System.Boolean",
"summary": "True if the query relates to the current user."
}
],
"returns": "A directory to user or machine data."
},
{
"signature": "FileSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns the default state.",
"since": "5.0",
"returns": "A new instance containing the default state."
},
{
"signature": "System.String[] GetSearchPaths()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns all of the imagePath items in Rhino's search imagePath list. See \"Options Files settings\" in the Rhino help file for more details.",
"since": "5.0"
},
{
"signature": "System.String[] RecentlyOpenedFiles()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns a list of recently opened files. Note that this function does not check to make sure that these files still exist.",
"since": "5.0",
"returns": "An array of strings with the paths to the recently opened files."
},
{
"signature": "System.Void SetAutoSaveBeforeCommands(System.String[] commands)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Set list of commands that force AutoSave prior to running.",
"since": "5.0"
},
{
"signature": "System.Void UpdateFromState(FileSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets all settings to a particular defined joined state.",
"since": "8.0",
"parameters": [
{
"name": "state",
"type": "FileSettingsState",
"summary": "A joined settings object."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "FileSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of FileSettings .",
"properties": [
{
"signature": "bool AutoSaveEnabled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Enables or disables Rhino's automatic file saving mechanism.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "TimeSpan AutoSaveInterval",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "How often the document will be saved when Rhino's automatic file saving mechanism is enabled.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool AutoSaveMeshes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Saves render and display meshes in autosave file.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ClipboardCopyToPreviousRhinoVersion",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that decides if copies to the clipboard are performed in both the current and previous Rhino clipboard formats. This means you will double the size of what is saved in the clipboard but will be able to copy from the current to the previous version using the clipboard.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ClipboardState ClipboardOnExit",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value that determines what to do with clipboard data on exit.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool CreateBackupFiles",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating whether to create backup files.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool FileLockingEnabled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Ensures that only one person at a time can have a file open for saving.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool FileLockingOpenWarning",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Displays an information dialog which identifies computer file is open on.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SaveViewChanges",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True for users who consider view changes a document change.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string TemplateFileDir",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the directory used for template files.",
"since": "8.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "GeneralSettings",
"dataType": "class",
"summary": "Contains static methods and properties to give access to Rhinoceros settings.",
"constructors": [
{
"signature": "GeneralSettings()",
"summary": "Initializes a new instance of the GeneralSettings class"
}
],
"properties": [
{
"signature": "bool AutoUpdateCommandHelp",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Command help dialog auto-update feature.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "TimeSpan ContextMenuDelay",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Time to wait before permitting context menu display.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool EnableContextMenu",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "True if right mouse down + delay will pop up context menu on a mouse up if no move happens.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int MaximumPopupMenuLines",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the maximum number of popup menu lines.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int MaximumUndoMemoryMb",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the minimum undo memory Mb. \nUndo records will be purged if there are more than MinimumUndoSteps and they use more than MaximumUndoMemoryMb.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string MiddleMouseMacro",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the toolbar to popup when the middle mouse is clicked on a view, this value is only used when MiddleMouseMode is set to PopupToolbar.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "MiddleMouseMode MiddleMouseMode",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets what happens when the user clicks the middle mouse.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string MiddleMousePopupToolbar",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the toolbar to popup when the middle mouse is clicked on a view, this value is only used when MiddleMouseMode is set to PopupToolbar.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int MinimumUndoSteps",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the minimum undo steps. \nUndo records will be purged if there are more than MinimumUndoSteps and they use more than MaximumUndoMemoryMb.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "MouseSelectMode MouseSelectMode",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the current selection mode.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int NewObjectIsoparmCount",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the number of isoparm curves to show on new objects.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SplitCreasedSurfaces",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Should surfaces be split into polysurfaces with smooth faces. This setting is read-only.",
"since": "9.0",
"property": ["get"]
},
{
"signature": "bool UseExtrusions",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Should extrusion objects be created for things like cylinders",
"since": "6.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "GeneralSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings.",
"since": "5.0",
"returns": "A new general state with current settings."
},
{
"signature": "GeneralSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings.",
"since": "5.0",
"returns": "A new general state with factory settings."
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "GeneralSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of GeneralSettings .",
"properties": [
{
"signature": "bool AutoUpdateCommandHelp",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the command help dialog auto-update feature.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "TimeSpan ContextMenuDelay",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the time to wait before permitting context menu display.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool EnableContextMenu",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True if right mouse down + delay will pop up context menu on a mouse up if no move happens.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int MaximumPopupMenuLines",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the maximum number of popup menu lines.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int MaximumUndoMemoryMb",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the minimum undo memory Mb. \nUndo records will be purged if there are more than MinimumUndoSteps and they use more than MaximumUndoMemoryMb.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string MiddleMouseMacro",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the toolbar to popup when the middle mouse is clicked on a view, this value is only used when MiddleMouseMode is set to PopupToolbar.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "MiddleMouseMode MiddleMouseMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets what happens when the user clicks the middle mouse.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string MiddleMousePopupToolbar",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the toolbar to popup when the middle mouse is clicked on a view, this value is only used when MiddleMouseMode is set to PopupToolbar.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int MinimumUndoSteps",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the minimum undo steps. \nUndo records will be purged if there are more than MinimumUndoSteps and they use more than MaximumUndoMemoryMb.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "MouseSelectMode MouseSelectMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the current selection mode.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int NewObjectIsoparmCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the number of isoparm curves to show on new objects.",
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "GumballSettings",
"dataType": "class",
"summary": "Contains static metthods and properties to modify Rhino gumball settings.",
"since": "9.0",
"constructors": [
{
"signature": "GumballSettings()",
"summary": "Initializes a new instance of the GumballSettings class"
}
],
"properties": [
{
"signature": "int ArcThickness",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the thickness of the rotation arcs in pixels. Set arc thickness to zero to turn off rotation handles.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int AxisThickness",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the thickness of the axis arrows in pixels. Set axis thickness to zero to turn of move handles.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool EnableGumball",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Turns the gumball widget on any time objects are selected.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int ExtrudeBallSize",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the size of the extrude dots in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int GumballRadius",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the radius of the gumball widget in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color MenuBallColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the gumball menu ball color.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int MenuBallLocation",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the distance of the menu ball from the gumball origin in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int MenuBallSize",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the size of the menu dots in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool MergeFacesAfterExtrude",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Merges faces after extruding.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int PlaneLocation",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the distance of the plane indicators from the gumball origin in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int PlaneSize",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the size of the plane indicators in pixels. Set plane size to zero to turn off the plane indicators. 9.0",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double PlaneVisibilityAngle",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets the angle of view for the plane to be visible. The range is from 0 to 90 degrees. 0 degrees means the plane only shows if the gumball is perfectly aligned to the view, 90 means the plane always shows. The default is 50 degrees.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool RotateViewAroundGumball",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets the view rotation center to the gumball origin.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int ScaleHandleSize",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the size of the scale handles in pixels. Set scale handle size to zero to turn off scale handles.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SnappyGumball",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "If true, snaps to object snap locations. if false, ignores object snap locations.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int TipLength",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the length of the direction arrows in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int TipWidth",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the width of the direction arrows in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color XAxisColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the gumball x axis color.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color YAxisColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the gumball y axis color.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color ZAxisColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Specifies the gumball z axis color.",
"since": "9.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "GumballSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "9.0"
},
{
"signature": "GumballSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "9.0"
},
{
"signature": "System.Void RestoreDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Commits the default settings as the current settings.",
"since": "9.0"
},
{
"signature": "System.Void UpdateFromState(GumballSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets all settings to a particular defined joined state.",
"since": "9.0",
"parameters": [
{
"name": "state",
"type": "GumballSettingsState",
"summary": "The particular state."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "GumballSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of GumballSettings .",
"since": "9.0",
"properties": [
{
"signature": "int ArcThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the thickness of the rotation arcs in pixels. Set arc thickness to zero to turn off rotation handles.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int AxisThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the thickness of the axis arrows in pixels. Set axis thickness to zero to turn of move handles.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool EnableGumball",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turns the gumball widget on any time objects are selected.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int ExtrudeBallSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the size of the extrude dots in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int GumballRadius",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the radius of the gumball widget in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color MenuBallColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the gumball menu ball color.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int MenuBallLocation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the distance of the menu ball from the gumball origin in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int MenuBallSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the size of the menu dots in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool MergeFacesAfterExtrude",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Merges faces after extruding.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int PlaneLocation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the distance of the plane indicators from the gumball origin in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int PlaneSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the size of the plane indicators in pixels. Set plane size to zero to turn off the plane indicators. 9.0",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double PlaneVisibilityAngle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the angle of view for the plane to be visible. The range is from 0 to 90 degrees. 0 degrees means the plane only shows if the gumball is perfectly aligned to the view, 90 means the plane always shows. The default is 50 degrees.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool RotateViewAroundGumball",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the view rotation center to the gumball origin.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int ScaleHandleSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the size of the scale handles in pixels. Set scale handle size to zero to turn off scale handles.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SnappyGumball",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If true, snaps to object snap locations. if false, ignores object snap locations.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int TipLength",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the length of the direction arrows in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int TipWidth",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the width of the direction arrows in pixels.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color XAxisColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the gumball x axis color.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color YAxisColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the gumball y axis color.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color ZAxisColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the gumball z axis color.",
"since": "9.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "HistorySettings",
"dataType": "class",
"summary": "Provides static (Shared in Vb.Net) properties to modify Rhino History settings.",
"constructors": [
{
"signature": "HistorySettings()",
"summary": "Initializes a new instance of the HistorySettings class"
}
],
"properties": [
{
"signature": "bool BrokenRecordWarningEnabled",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Displays a warning dialog when an action is taken that breaks the link between the output and input objects.",
"since": "6.10",
"property": ["get", "set"]
},
{
"signature": "bool ObjectLockingEnabled",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "When history object locking is enabled, objects with history on them act as if they were locked and the only way to modify these objects is to edit their inputs.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool RecordingEnabled",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "When history recording is enabled, new objects keep a record of how they were constructed so that they can be updated if an input object changes.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool RecordNextCommand",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Enable history recording until the end of the next command",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool UpdateEnabled",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "When history update is enabled, dependent objects are automatically updated when an antecedent is modified.",
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "Installation",
"dataType": "enum",
"summary": "The type of Rhino executable that is executing",
"since": "5.0",
"values": [
{
"signature": "Undefined = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Unknown"
},
{
"signature": "Commercial",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Educational",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "EducationalLab",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "NotForResale",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "NotForResaleLab",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Beta",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "BetaLab",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Evaluation",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "25 Save limit evaluation version of Rhino"
},
{
"signature": "Corporate",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "EvaluationTimed",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "90 day time limit evaluation version of Rhino"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "KeyboardShortcut",
"dataType": "class",
"summary": "A shortcut is a key plus modifier combination that executes a macro",
"constructors": [
{
"signature": "KeyboardShortcut()",
"summary": "Initializes a new instance of the KeyboardShortcut class"
}
],
"properties": [
{
"signature": "KeyboardKey Key",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Key used for shortcut",
"since": "8.12",
"property": ["get", "set"]
},
{
"signature": "string Macro",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Macro to execute when key plus modifier are pressed",
"since": "8.12",
"property": ["get", "set"]
},
{
"signature": "ModifierKey Modifier",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Modifier key used for shortcut",
"since": "8.12",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "LicenseNode",
"dataType": "enum",
"summary": "License node types.",
"since": "5.0",
"values": [
{
"signature": "Standalone = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "An independent node."
},
{
"signature": "Network = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Network (obtains license from Zoo server)"
},
{
"signature": "NetworkCheckedOut = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Network (has license checked out from Zoo server)"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "MiddleMouseMode",
"dataType": "enum",
"summary": "Defines enumerated constant values to define what happens when either the middle mouse button on a three-button mouse is clicked or after pressing the wheel on a wheeled mouse.",
"since": "5.0",
"values": [
{
"signature": "PopupMenu = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Pops up two-part menu at the cursor location. You can list your favorite commands in the top section. The bottom section is the list of most recent commands used."
},
{
"signature": "PopupToolbar = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Choose a toolbar to pop up at the cursor location. Create a toolbar containing your favorite commands or object snaps to use as a pop-up toolbar."
},
{
"signature": "RunMacro = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Lists a series of commands that run when you click the middle mouse button."
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ModelAidSettings",
"dataType": "class",
"summary": "Contains static methods and properties to modify model aid settings.",
"constructors": [
{
"signature": "ModelAidSettings()",
"summary": "Initializes a new instance of the ModelAidSettings class"
}
],
"properties": [
{
"signature": "bool AltPlusArrow",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "True means Alt+arrow is used for nudging.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool AutoAlignCPlane",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether the cplane will automatically align to the selection",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int AutoCPlaneAlignment",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "//0 = object, 1 = world, 2 = view",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool AutoGumballEnabled",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "When AutoGumball is on, a gumball automatically appears when objects are pre-picked.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool CenterSnapToApproximations",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int ControlPolygonDisplayDensity",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the control polygon display density.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double CtrlNudgeKeyStep",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Ctrl-key based nudge step amount.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double DigitizerOsnapPickboxRadius",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool DisplayControlPolygon",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's display control polygon.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool EnableOsnapHighlight",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ExtendToApparentIntersection",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's extend to apparent intersections.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ExtendTrimLines",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's extend trim lines.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool GridSnap",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's grid snap modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool GumballAutoReset",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "When GumballAutoReset is on the gumball resets its orientation after a drag When GumballAutoReset is off the gumball orientation is kept to where it was dragged",
"since": "8.10",
"property": ["get", "set"]
},
{
"signature": "bool GumballExtrudeMergeFaces",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "When ExtrudeMergeFaces is True the gumball will attempt to merge faces if possible after extruding a face",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool HighlightControlPolygon",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's highlight dialog modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int MousePickboxRadius",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "radius of mouse pick box in pixels.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool NearMidIntPerpSnapToMeshes",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double NudgeKeyStep",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the nudge step amount.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int NudgeMode",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "0 = world, 1 = cplane, 2 = view, 3 = UVN, -1 = not set.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool OnlySnapToSelected",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool OrientAutoCPlaneToView",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether the auto cplane will rotate towards the view after aligning to the selection",
"since": "8.7",
"property": ["get", "set"]
},
{
"signature": "bool Ortho",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's ortho modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double OrthoAngle",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the base orthogonal angle.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool OrthoUseZ",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether Ortho will snap to the CPlane Z axis",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool Osnap",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Enables or disables Rhino's object snap modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "CursorMode OsnapCursorMode",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the OSnap cursor mode.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "OsnapModes OsnapModes",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns or sets Rhino's current object snap mode. The mode is a bitwise value based on the OsnapModes enumeration.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int OsnapPickboxRadius",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Enables or disables Rhino's planar modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool Planar",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's Planar modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "PointDisplayMode PointDisplay",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the point display mode.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ProjectSnapToCPlane",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's Project modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ProjectToCPlaneInPlanParallelViews",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double ShiftNudgeKeyStep",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Shift-key based nudge step amount.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SnappyGumballEnabled",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "When SnappyGumball is on, a dragging a gumball moves the center point. When snappy gumball is off, dragging a gumball moves the mouse down point.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SnapToFiltered",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool SnapToLocked",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the locked state of the snap modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SnapToOccluded",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool StickyAutoCPlane",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or set whether the auto cplane will stay even after deselection",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool UniversalConstructionPlaneMode",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the locked state of the snap modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool UseHorizontalDialog",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's use horizontal dialog modeling aid.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ModelAidSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings.",
"since": "5.0",
"returns": "A new model aid state with current settings."
},
{
"signature": "ModelAidSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings.",
"since": "5.0",
"returns": "A new model aid state with factory settings."
},
{
"signature": "System.Void UpdateFromState(ModelAidSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Updates from a particular setting state.",
"since": "5.0",
"parameters": [
{
"name": "state",
"type": "ModelAidSettingsState",
"summary": "The new states that will be set."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ModelAidSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of ModelAidSettings .",
"properties": [
{
"signature": "bool AltPlusArrow",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True mean Alt+arrow is used for nudging.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool AutoAlignCPlane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int AutoCPlaneAlignment",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "//0 = object, 1 = world, 2 = view",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool AutoGumballEnabled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool CenterSnapToApproximations",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int ControlPolygonDisplayDensity",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the control polygon display density.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double CtrlNudgeKeyStep",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Ctrl-key based nudge step amount.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double DigitizerOsnapPickboxRadius",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool DisplayControlPolygon",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's display control polygon.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool EnableOsnapHighlight",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ExtendToApparentIntersection",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's extend to apparent intersections.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ExtendTrimLines",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's extend trim lines.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool GridSnap",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's grid snap modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool GumballExtrudeMergeFaces",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool HighlightControlPolygon",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's highlight dialog modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int MousePickboxRadius",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the radius of the mouse pick box in pixels.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool NearMidIntPerpSnapToMeshes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double NudgeKeyStep",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the nudge step amount.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int NudgeMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "0 = world, 1 = cplane, 2 = view, 3 = UVN, -1 = not set.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool OnlySnapToSelected",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool OrientAutoCPlaneToView",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether the auto cplane will rotate towards the view after aligning to the selection",
"since": "8.7",
"property": ["get", "set"]
},
{
"signature": "bool Ortho",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's ortho modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double OrthoAngle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the base orthogonal angle.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool OrthoUseZ",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether Ortho will snap to the CPlane Z axis",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool Osnap",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's object snap modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "CursorMode OsnapCursorMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the OSnap cursor mode.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "OsnapModes OsnapModes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns or sets Rhino's current object snap mode. \nThe mode is a bitwise value based on the OsnapModes enumeration.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int OsnapPickboxRadius",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Enables or disables Rhino's planar modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool Planar",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's Planar modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "PointDisplayMode PointDisplay",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the point display mode.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ProjectSnapToCPlane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's Project modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ProjectToCPlaneInPlanParallelViews",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double ShiftNudgeKeyStep",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Shift-key based nudge step amount.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SnappyGumballEnabled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SnapToFiltered",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool SnapToLocked",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the locked state of the snap modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SnapToOccluded",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool StickyAutoCPlane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or set whether the auto cplane will stay even after deselection",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool UniversalConstructionPlaneMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the locked state of the snap modeling aid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool UseHorizontalDialog",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the enabled state of Rhino's use horizontal dialog modeling aid.",
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "MouseSelectMode",
"dataType": "enum",
"summary": "Defines enumerated constant values to indicate a particular window selection mode.",
"since": "5.0",
"values": [
{
"signature": "Crossing = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Anything that crosses this window will be selected."
},
{
"signature": "Window = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Anything that is inside this window will be selected."
},
{
"signature": "Combo = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Drag a rectangle from left to right for window select. Drag a rectangle from right to left for crossing select."
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "NeverRepeatList",
"dataType": "class",
"summary": "Contains static methods and properties relating to the list of commands that are never repeated.",
"constructors": [
{
"signature": "NeverRepeatList()",
"summary": "Initializes a new instance of the NeverRepeatList class"
}
],
"properties": [
{
"signature": "bool UseNeverRepeatList",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Only use the list if somebody modifies it via CRhinoAppSettings::SetDontRepeatCommands(). Return value of True means CRhinoCommand don't repeat flags will be ignored and the m_dont_repeat_list will be used instead. False means the individual CRhinoCommands will determine if they are repeatable.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.String[] CommandNames()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The list of commands to not repeat.",
"since": "5.0"
},
{
"signature": "System.Int32 SetList(System.String[] commandNames)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Puts the command name tokens in m_dont_repeat_list.",
"since": "5.0",
"returns": "Number of items added to m_dont_repeat_list."
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "OpenGLSettings",
"dataType": "class",
"summary": "Static methods and properties to control OpenGL settings",
"constructors": [
{
"signature": "OpenGLSettings()",
"summary": "Initializes a new instance of the OpenGLSettings class"
}
],
"properties": [
{
"signature": "AntialiasLevel AntialiasLevel",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the anti-alias level used by OpenGL viewports",
"since": "6.1",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "OpenGLSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings.",
"since": "6.1",
"returns": "A new OpenGL state with current settings."
},
{
"signature": "OpenGLSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the OpenGL factory settings.",
"since": "6.1",
"returns": "A new OpenGL state with factory settings."
},
{
"signature": "System.Void RestoreDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Updates from the default setting state.",
"since": "6.1"
},
{
"signature": "System.Void UpdateFromState(OpenGLSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Updates from a particular setting state.",
"since": "6.1",
"parameters": [
{
"name": "state",
"type": "OpenGLSettingsState",
"summary": "The new state that will be set."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "OpenGLSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of OpenGLSettings",
"properties": [
{
"signature": "AntialiasLevel AntialiasLevel",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "AA level used in OpenGL viewports",
"since": "6.1",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "OsnapModes",
"dataType": "enum",
"summary": "Defines several bit masks for each of the OSnap that are defined. \nRefer to the Rhino Help file for further information.",
"since": "5.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No OSnap."
},
{
"signature": "Near = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Near OSnap."
},
{
"signature": "Focus = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Focus OSnap."
},
{
"signature": "Center = 0x20",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Center OSnap."
},
{
"signature": "Vertex = 0x40",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Vertex OSnap."
},
{
"signature": "Knot = 0x80",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Knot OSnap."
},
{
"signature": "Quadrant = 0x200",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Quadrant OSnap."
},
{
"signature": "Midpoint = 0x800",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Midpoint OSnap."
},
{
"signature": "Intersection = 0x2000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Intersection OSnap."
},
{
"signature": "End = 0x20000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "End OSnap."
},
{
"signature": "Perpendicular = 0x80000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Perpendicular OSnap."
},
{
"signature": "Tangent = 0x200000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Tangent OSnap."
},
{
"signature": "Point = 0x8000000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Point OSnap."
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "PackageManagerSettings",
"dataType": "class",
"summary": "Settings specific to Rhino's package manager",
"constructors": [
{
"signature": "PackageManagerSettings()",
"summary": "Initializes a new instance of the PackageManagerSettings class"
}
],
"properties": [
{
"signature": "string Sources",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "semicolon separated list of paths/urls that the package manager uses for sources",
"since": "7.1",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "PaintColor",
"dataType": "enum",
"summary": "Contains enumerated constant values to represent logical colors associated with elements of the user interface.",
"values": [
{
"signature": "NormalStart = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Gradient start for active toolbar tab and non-client area of Rhino."
},
{
"signature": "NormalEnd = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Gradient end for active toolbar tab and non-client area of Rhino."
},
{
"signature": "NormalBorder = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Edge color used for grippers, toolbar border, resize bars, status bar pane borders."
},
{
"signature": "HotStart = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Gradient start for inactive toolbar tab."
},
{
"signature": "HotEnd = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Gradient end for inactive toolbar tab."
},
{
"signature": "HotBorder = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Inactive toolbar tab border."
},
{
"signature": "PressedStart = 6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Pressed gradient start."
},
{
"signature": "PressedEnd = 7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Pressed gradient end."
},
{
"signature": "PressedBorder = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Pressed border."
},
{
"signature": "TextEnabled = 9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Toolbar tab text and status bar text."
},
{
"signature": "TextDisabled = 10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Disabled text color."
},
{
"signature": "MouseOverControlStart = 11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Color for hovering gradient start."
},
{
"signature": "MouseOverControlEnd = 12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Color for hovering gradient end."
},
{
"signature": "MouseOverControlBorder = 13",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Color for hovering border."
},
{
"signature": "ActiveCaption = 14",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Active floating window non-client area"
},
{
"signature": "InactiveCaption = 15",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Inactive floating window non-client area"
},
{
"signature": "PanelBackground = 16",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Background color of panels"
},
{
"signature": "ActiveViewportTitle = 17",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Active viewport title."
},
{
"signature": "InactiveViewportTitle = 18",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Inactive viewport title."
},
{
"signature": "ModifiedValueControlColor = 19",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Modified property value label text color"
},
{
"signature": "EditBoxBackground = 20",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Background fill for input elements (edit box, checkbox)"
},
{
"signature": "GridLinesOnPanelBackground = 21",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Grid lines on panel background color"
},
{
"signature": "GridLinesOnEditBoxBackground = 22",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Grid lines on edit box background color"
},
{
"signature": "InactiveTabBackground = 23",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Fill for inactive tabs"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "PointDisplayMode",
"dataType": "enum",
"summary": "Defines enumerated constant values for world coordinates and CPlane point display modes.",
"since": "5.0",
"values": [
{
"signature": "WorldPoint = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Points are displayed in world coordinates."
},
{
"signature": "CplanePoint",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Points are displayed in CPlane coordinates."
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "SelectionFilterSettings",
"dataType": "class",
"summary": "Selection filter settings restrict any selection mode (SelWindow, SelCrossing, SelAll, etc.) to specified object types. Note, selection filter settings are not persistent.",
"constructors": [
{
"signature": "SelectionFilterSettings()",
"summary": "Initializes a new instance of the SelectionFilterSettings class"
}
],
"properties": [
{
"signature": "bool Enabled",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Enables or disables the global object selection filter.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "ObjectType GlobalGeometryFilter",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The global geometry type filter controls which types of geometry will be filtered. Note, the filter can be a bitwise combination of multiple object types.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "ObjectType OneShotGeometryFilter",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The one-shot geometry type filter controls which types of geometry will be filtered for one selection. Note, the filter can be a bitwise combination of multiple object types.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "bool SubObjectSelect",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Enables or disabled sub-object selection.",
"since": "7.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "SelectionFilterSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "7.0"
},
{
"signature": "SelectionFilterSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "7.0"
},
{
"signature": "System.Void RestoreDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Commits the default settings as the current settings.",
"since": "7.0"
},
{
"signature": "System.Void UpdateFromState(SelectionFilterSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets all settings to a particular defined joined state.",
"since": "7.0",
"parameters": [
{
"name": "state",
"type": "SelectionFilterSettingsState",
"summary": "The particular state."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "SelectionFilterSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of SelectionFilterSettings .",
"properties": [
{
"signature": "bool Enabled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Enables or disables the global object selection filter.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "ObjectType GlobalGeometryFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The global geometry type filter controls which types of geometry will be filtered. Note, the filter can be a bitwise combination of multiple object types.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "ObjectType OneShotGeometryFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The one-shot geometry type filter controls which types of geometry will be filtered for one selection. Note, the filter can be a bitwise combination of multiple object types.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "bool SubObjectSelect",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Enables or disabled sub-object selection.",
"since": "7.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ShortcutKey",
"dataType": "enum",
"summary": "Shortcut key combinations",
"since": "5.0",
"values": [
{
"signature": "F1 = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "F1"
},
{
"signature": "F2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "F2"
},
{
"signature": "F3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "F3"
},
{
"signature": "F4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "F4"
},
{
"signature": "F5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "F5"
},
{
"signature": "F6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "F6"
},
{
"signature": "F7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "F7"
},
{
"signature": "F8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "F8"
},
{
"signature": "F9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "F9"
},
{
"signature": "F10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "F10"
},
{
"signature": "F11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "F11"
},
{
"signature": "F12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "F12"
},
{
"signature": "CtrlF1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F1"
},
{
"signature": "CtrlF2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F2"
},
{
"signature": "CtrlF3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F3"
},
{
"signature": "CtrlF4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F4"
},
{
"signature": "CtrlF5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F5"
},
{
"signature": "CtrlF6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F6"
},
{
"signature": "CtrlF7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F7"
},
{
"signature": "CtrlF8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F8"
},
{
"signature": "CtrlF9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F9"
},
{
"signature": "CtrlF10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F10"
},
{
"signature": "CtrlF11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F11"
},
{
"signature": "CtrlF12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F12"
},
{
"signature": "ShiftCtrlF1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F1"
},
{
"signature": "ShiftCtrlF2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F2"
},
{
"signature": "ShiftCtrlF3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F3"
},
{
"signature": "ShiftCtrlF4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F4"
},
{
"signature": "ShiftCtrlF5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F5"
},
{
"signature": "ShiftCtrlF6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F6"
},
{
"signature": "ShiftCtrlF7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F7"
},
{
"signature": "ShiftCtrlF8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F8"
},
{
"signature": "ShiftCtrlF9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F9"
},
{
"signature": "ShiftCtrlF10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F10"
},
{
"signature": "ShiftCtrlF11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F11"
},
{
"signature": "ShiftCtrlF12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F12"
},
{
"signature": "AltCtrlF1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F1"
},
{
"signature": "AltCtrlF2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F2"
},
{
"signature": "AltCtrlF3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F3"
},
{
"signature": "AltCtrlF4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F4"
},
{
"signature": "AltCtrlF5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F5"
},
{
"signature": "AltCtrlF6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F6"
},
{
"signature": "AltCtrlF7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F7"
},
{
"signature": "AltCtrlF8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F8"
},
{
"signature": "AltCtrlF9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F9"
},
{
"signature": "AltCtrlF10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F10"
},
{
"signature": "AltCtrlF11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F11"
},
{
"signature": "AltCtrlF12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F12"
},
{
"signature": "CtrlA",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + A"
},
{
"signature": "CtrlB",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + B"
},
{
"signature": "CtrlC",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + C"
},
{
"signature": "CtrlD",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + D"
},
{
"signature": "CtrlE",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + E"
},
{
"signature": "CtrlF",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + F"
},
{
"signature": "CtrlG",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + G"
},
{
"signature": "CtrlH",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + H"
},
{
"signature": "CtrlI",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + I"
},
{
"signature": "CtrlJ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + J"
},
{
"signature": "CtrlK",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + K"
},
{
"signature": "CtrlL",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + L"
},
{
"signature": "CtrlM",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + M"
},
{
"signature": "CtrlN",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + N"
},
{
"signature": "CtrlO",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + O"
},
{
"signature": "CtrlP",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + P"
},
{
"signature": "CtrlQ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + Q"
},
{
"signature": "CtrlR",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + R"
},
{
"signature": "CtrlS",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + S"
},
{
"signature": "CtrlT",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + T"
},
{
"signature": "CtrlU",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + U"
},
{
"signature": "CtrlV",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + V"
},
{
"signature": "CtrlW",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + W"
},
{
"signature": "CtrlX",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + X"
},
{
"signature": "CtrlY",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + Y"
},
{
"signature": "CtrlZ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + Z"
},
{
"signature": "ShiftCtrlA",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + A"
},
{
"signature": "ShiftCtrlB",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + B"
},
{
"signature": "ShiftCtrlC",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + C"
},
{
"signature": "ShiftCtrlD",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + D"
},
{
"signature": "ShiftCtrlE",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + E"
},
{
"signature": "ShiftCtrlF",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + F"
},
{
"signature": "ShiftCtrlG",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + G"
},
{
"signature": "ShiftCtrlH",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + H"
},
{
"signature": "ShiftCtrlI",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + I"
},
{
"signature": "ShiftCtrlJ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + J"
},
{
"signature": "ShiftCtrlK",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + K"
},
{
"signature": "ShiftCtrlL",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + L"
},
{
"signature": "ShiftCtrlM",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + M"
},
{
"signature": "ShiftCtrlN",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + N"
},
{
"signature": "ShiftCtrlO",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + O"
},
{
"signature": "ShiftCtrlP",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + P"
},
{
"signature": "ShiftCtrlQ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + Q"
},
{
"signature": "ShiftCtrlR",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + R"
},
{
"signature": "ShiftCtrlS",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + S"
},
{
"signature": "ShiftCtrlT",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + T"
},
{
"signature": "ShiftCtrlU",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + U"
},
{
"signature": "ShiftCtrlV",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + V"
},
{
"signature": "ShiftCtrlW",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + W"
},
{
"signature": "ShiftCtrlX",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + X"
},
{
"signature": "ShiftCtrlY",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + Y"
},
{
"signature": "ShiftCtrlZ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + Z"
},
{
"signature": "AltCtrlA",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + A"
},
{
"signature": "AltCtrlB",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + B"
},
{
"signature": "AltCtrlC",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + C"
},
{
"signature": "AltCtrlD",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + D"
},
{
"signature": "AltCtrlE",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + E"
},
{
"signature": "AltCtrlF",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + F"
},
{
"signature": "AltCtrlG",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + G"
},
{
"signature": "AltCtrlH",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + H"
},
{
"signature": "AltCtrlI",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + I"
},
{
"signature": "AltCtrlJ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + J"
},
{
"signature": "AltCtrlK",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + K"
},
{
"signature": "AltCtrlL",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + L"
},
{
"signature": "AltCtrlM",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + M"
},
{
"signature": "AltCtrlN",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + N"
},
{
"signature": "AltCtrlO",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + O"
},
{
"signature": "AltCtrlP",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + P"
},
{
"signature": "AltCtrlQ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + Q"
},
{
"signature": "AltCtrlR",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + R"
},
{
"signature": "AltCtrlS",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + S"
},
{
"signature": "AltCtrlT",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + T"
},
{
"signature": "AltCtrlU",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + U"
},
{
"signature": "AltCtrlV",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + V"
},
{
"signature": "AltCtrlW",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + W"
},
{
"signature": "AltCtrlX",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + X"
},
{
"signature": "AltCtrlY",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + Y"
},
{
"signature": "AltCtrlZ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + Z"
},
{
"signature": "Ctrl0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + 0"
},
{
"signature": "Ctrl1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + 1"
},
{
"signature": "Ctrl2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + 2"
},
{
"signature": "Ctrl3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + 3"
},
{
"signature": "Ctrl4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + 4"
},
{
"signature": "Ctrl5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + 5"
},
{
"signature": "Ctrl6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + 6"
},
{
"signature": "Ctrl7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + 7"
},
{
"signature": "Ctrl8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + 8"
},
{
"signature": "Ctrl9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + 9"
},
{
"signature": "ShiftCtrl0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + 0"
},
{
"signature": "ShiftCtrl1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + 1"
},
{
"signature": "ShiftCtrl2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + 2"
},
{
"signature": "ShiftCtrl3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + 3"
},
{
"signature": "ShiftCtrl4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + 4"
},
{
"signature": "ShiftCtrl5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + 5"
},
{
"signature": "ShiftCtrl6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + 6"
},
{
"signature": "ShiftCtrl7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + 7"
},
{
"signature": "ShiftCtrl8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + 8"
},
{
"signature": "ShiftCtrl9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + 9"
},
{
"signature": "AltCtrl0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + 0"
},
{
"signature": "AltCtrl1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + 1"
},
{
"signature": "AltCtrl2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + 2"
},
{
"signature": "AltCtrl3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + 3"
},
{
"signature": "AltCtrl4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + 4"
},
{
"signature": "AltCtrl5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + 5"
},
{
"signature": "AltCtrl6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + 6"
},
{
"signature": "AltCtrl7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + 7"
},
{
"signature": "AltCtrl8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + 8"
},
{
"signature": "AltCtrl9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + 9"
},
{
"signature": "Home",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Home"
},
{
"signature": "End",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "End"
},
{
"signature": "CtrlHome",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + Home"
},
{
"signature": "CtrlEnd",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + End"
},
{
"signature": "ShiftHome",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Home"
},
{
"signature": "ShiftEnd",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + End"
},
{
"signature": "ShiftCtrlHome",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + Home"
},
{
"signature": "ShiftCtrlEnd",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + End"
},
{
"signature": "AltCtrlHome",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + Home"
},
{
"signature": "AltCtrlEnd",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + End"
},
{
"signature": "Tab",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Tab"
},
{
"signature": "PageUp",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Page Up"
},
{
"signature": "PageDown",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Page Down"
},
{
"signature": "ShiftPageUp",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Page Up"
},
{
"signature": "ShiftPageDown",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Page Down"
},
{
"signature": "CtrlPageUp",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + Page Up"
},
{
"signature": "CtrlPageDown",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl + Page Down"
},
{
"signature": "ShiftCtrlPageUp",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + Page Up"
},
{
"signature": "ShiftCtrlPageDown",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shift + Ctrl + Page Down"
},
{
"signature": "AltCtrlPageUp",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + Page Up"
},
{
"signature": "AltCtrlPageDown",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Ctrl + Page Down"
},
{
"signature": "None",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No shortcut key"
},
{
"signature": "AltHome",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Home"
},
{
"signature": "AltEnd",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Home"
},
{
"signature": "AltA",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + A"
},
{
"signature": "AltB",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + B"
},
{
"signature": "AltC",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + C"
},
{
"signature": "AltD",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + D"
},
{
"signature": "AltE",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + E"
},
{
"signature": "AltF",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F"
},
{
"signature": "AltG",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + G"
},
{
"signature": "AltH",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + H"
},
{
"signature": "AltI",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + I"
},
{
"signature": "AltJ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + J"
},
{
"signature": "AltK",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + K"
},
{
"signature": "AltL",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + L"
},
{
"signature": "AltM",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + M"
},
{
"signature": "AltN",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + N"
},
{
"signature": "AltO",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + O"
},
{
"signature": "AltP",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + P"
},
{
"signature": "AltQ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Q"
},
{
"signature": "AltR",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + R"
},
{
"signature": "AltS",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + S"
},
{
"signature": "AltT",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + T"
},
{
"signature": "AltU",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + U"
},
{
"signature": "AltV",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + V"
},
{
"signature": "AltW",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + W"
},
{
"signature": "AltX",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + X"
},
{
"signature": "AltY",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Y"
},
{
"signature": "AltZ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Z"
},
{
"signature": "Alt0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + 0"
},
{
"signature": "Alt1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + 1"
},
{
"signature": "Alt2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + 2"
},
{
"signature": "Alt3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + 3"
},
{
"signature": "Alt4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + 4"
},
{
"signature": "Alt5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + 5"
},
{
"signature": "Alt6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + 6"
},
{
"signature": "Alt7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + 7"
},
{
"signature": "Alt8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + 8"
},
{
"signature": "Alt9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + 9"
},
{
"signature": "AltF1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F1"
},
{
"signature": "AltF2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F2"
},
{
"signature": "AltF3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F3"
},
{
"signature": "AltF4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F4"
},
{
"signature": "AltF5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F5"
},
{
"signature": "AltF6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F6"
},
{
"signature": "AltF7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F7"
},
{
"signature": "AltF8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F8"
},
{
"signature": "AltF9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F9"
},
{
"signature": "AltF10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F10"
},
{
"signature": "AltF11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F11"
},
{
"signature": "AltF12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + F12"
},
{
"signature": "AltShiftHome",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + Home"
},
{
"signature": "AltShiftEnd",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + End"
},
{
"signature": "AltShiftA",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + A"
},
{
"signature": "AltShiftB",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + B"
},
{
"signature": "AltShiftC",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + C"
},
{
"signature": "AltShiftD",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + D"
},
{
"signature": "AltShiftE",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + E"
},
{
"signature": "AltShiftF",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F"
},
{
"signature": "AltShiftG",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + G"
},
{
"signature": "AltShiftH",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + H"
},
{
"signature": "AltShiftI",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + I"
},
{
"signature": "AltShiftJ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + J"
},
{
"signature": "AltShiftK",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + K"
},
{
"signature": "AltShiftL",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + L"
},
{
"signature": "AltShiftM",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + M"
},
{
"signature": "AltShiftN",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + N"
},
{
"signature": "AltShiftO",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + O"
},
{
"signature": "AltShiftP",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + P"
},
{
"signature": "AltShiftQ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + Q"
},
{
"signature": "AltShiftR",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + R"
},
{
"signature": "AltShiftS",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + S"
},
{
"signature": "AltShiftT",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + T"
},
{
"signature": "AltShiftU",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + U"
},
{
"signature": "AltShiftV",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + V"
},
{
"signature": "AltShiftW",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + W"
},
{
"signature": "AltShiftX",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + X"
},
{
"signature": "AltShiftY",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + Y"
},
{
"signature": "AltShiftZ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + Z"
},
{
"signature": "AltShift0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + 0"
},
{
"signature": "AltShift1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + 1"
},
{
"signature": "AltShift2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + 2"
},
{
"signature": "AltShift3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + 3"
},
{
"signature": "AltShift4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + 4"
},
{
"signature": "AltShift5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + 5"
},
{
"signature": "AltShift6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + 6"
},
{
"signature": "AltShift7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + 7"
},
{
"signature": "AltShift8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + 8"
},
{
"signature": "AltShift9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + 9"
},
{
"signature": "AltShiftF1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F1"
},
{
"signature": "AltShiftF2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F2"
},
{
"signature": "AltShiftF3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F3"
},
{
"signature": "AltShiftF4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F4"
},
{
"signature": "AltShiftF5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F5"
},
{
"signature": "AltShiftF6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F6"
},
{
"signature": "AltShiftF7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F7"
},
{
"signature": "AltShiftF8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F8"
},
{
"signature": "AltShiftF9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F9"
},
{
"signature": "AltShiftF10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F10"
},
{
"signature": "AltShiftF11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F11"
},
{
"signature": "AltShiftF12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alt + Shift + F12"
},
{
"signature": "MacControlHome",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Home (Mac)"
},
{
"signature": "MacControlEnd",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + End (Mac)"
},
{
"signature": "MacControlA",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + A (Mac)"
},
{
"signature": "MacControlB",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + B (Mac)"
},
{
"signature": "MacControlC",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + C (Mac)"
},
{
"signature": "MacControlD",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + D (Mac)"
},
{
"signature": "MacControlE",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + E (Mac)"
},
{
"signature": "MacControlF",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F (Mac)"
},
{
"signature": "MacControlG",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + G (Mac)"
},
{
"signature": "MacControlH",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + H (Mac)"
},
{
"signature": "MacControlI",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + I (Mac)"
},
{
"signature": "MacControlJ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + J (Mac)"
},
{
"signature": "MacControlK",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + K (Mac)"
},
{
"signature": "MacControlL",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + L (Mac)"
},
{
"signature": "MacControlM",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + M (Mac)"
},
{
"signature": "MacControlN",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + N (Mac)"
},
{
"signature": "MacControlO",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + O (Mac)"
},
{
"signature": "MacControlP",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + P (Mac)"
},
{
"signature": "MacControlQ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Q (Mac)"
},
{
"signature": "MacControlR",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + R (Mac)"
},
{
"signature": "MacControlS",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + S (Mac)"
},
{
"signature": "MacControlT",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + T (Mac)"
},
{
"signature": "MacControlU",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + U (Mac)"
},
{
"signature": "MacControlV",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + V (Mac)"
},
{
"signature": "MacControlW",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + W (Mac)"
},
{
"signature": "MacControlX",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + X (Mac)"
},
{
"signature": "MacControlY",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Y (Mac)"
},
{
"signature": "MacControlZ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Z (Mac)"
},
{
"signature": "MacControl0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + 0 (Mac)"
},
{
"signature": "MacControl1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + 1 (Mac)"
},
{
"signature": "MacControl2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + 2 (Mac)"
},
{
"signature": "MacControl3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + 3 (Mac)"
},
{
"signature": "MacControl4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + 4 (Mac)"
},
{
"signature": "MacControl5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + 5 (Mac)"
},
{
"signature": "MacControl6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + 6 (Mac)"
},
{
"signature": "MacControl7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + 7 (Mac)"
},
{
"signature": "MacControl8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + 8 (Mac)"
},
{
"signature": "MacControl9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + 9 (Mac)"
},
{
"signature": "MacControlF1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F1 (Mac)"
},
{
"signature": "MacControlF2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F2 (Mac)"
},
{
"signature": "MacControlF3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F3 (Mac)"
},
{
"signature": "MacControlF4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F4 (Mac)"
},
{
"signature": "MacControlF5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F5 (Mac)"
},
{
"signature": "MacControlF6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F6 (Mac)"
},
{
"signature": "MacControlF7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F7 (Mac)"
},
{
"signature": "MacControlF8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F8 (Mac)"
},
{
"signature": "MacControlF9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F9 (Mac)"
},
{
"signature": "MacControlF10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F10 (Mac)"
},
{
"signature": "MacControlF11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F11 (Mac)"
},
{
"signature": "MacControlF12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + F12 (Mac)"
},
{
"signature": "MacControlAltHome",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + Home (Mac)"
},
{
"signature": "MacControlAltEnd",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + End (Mac)"
},
{
"signature": "MacControlAltA",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + A (Mac)"
},
{
"signature": "MacControlAltB",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + B (Mac)"
},
{
"signature": "MacControlAltC",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + C (Mac)"
},
{
"signature": "MacControlAltD",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + D (Mac)"
},
{
"signature": "MacControlAltE",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + E (Mac)"
},
{
"signature": "MacControlAltF",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F (Mac)"
},
{
"signature": "MacControlAltG",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + G (Mac)"
},
{
"signature": "MacControlAltH",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + H (Mac)"
},
{
"signature": "MacControlAltI",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + I (Mac)"
},
{
"signature": "MacControlAltJ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + J (Mac)"
},
{
"signature": "MacControlAltK",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + K (Mac)"
},
{
"signature": "MacControlAltL",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + L (Mac)"
},
{
"signature": "MacControlAltM",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + M (Mac)"
},
{
"signature": "MacControlAltN",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + N (Mac)"
},
{
"signature": "MacControlAltO",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + O (Mac)"
},
{
"signature": "MacControlAltP",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + P (Mac)"
},
{
"signature": "MacControlAltQ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + Q (Mac)"
},
{
"signature": "MacControlAltR",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + R (Mac)"
},
{
"signature": "MacControlAltS",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + S (Mac)"
},
{
"signature": "MacControlAltT",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + T (Mac)"
},
{
"signature": "MacControlAltU",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + U (Mac)"
},
{
"signature": "MacControlAltV",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + Alt + V (Mac)"
},
{
"signature": "MacControlAltW",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + W (Mac)"
},
{
"signature": "MacControlAltX",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + X (Mac)"
},
{
"signature": "MacControlAltY",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + Y (Mac)"
},
{
"signature": "MacControlAltZ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + Z (Mac)"
},
{
"signature": "MacControlAlt0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + 0 (Mac)"
},
{
"signature": "MacControlAlt1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + 1 (Mac)"
},
{
"signature": "MacControlAlt2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + 2 (Mac)"
},
{
"signature": "MacControlAlt3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + 3 (Mac)"
},
{
"signature": "MacControlAlt4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + 4 (Mac)"
},
{
"signature": "MacControlAlt5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + 5 (Mac)"
},
{
"signature": "MacControlAlt6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + 6 (Mac)"
},
{
"signature": "MacControlAlt7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + 7 (Mac)"
},
{
"signature": "MacControlAlt8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + 8 (Mac)"
},
{
"signature": "MacControlAlt9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + 9 (Mac)"
},
{
"signature": "MacControlAltF1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F1 (Mac)"
},
{
"signature": "MacControlAltF2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F2 (Mac)"
},
{
"signature": "MacControlAltF3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F3 (Mac)"
},
{
"signature": "MacControlAltF4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F4 (Mac)"
},
{
"signature": "MacControlAltF5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F5 (Mac)"
},
{
"signature": "MacControlAltF6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F6 (Mac)"
},
{
"signature": "MacControlAltF7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F7 (Mac)"
},
{
"signature": "MacControlAltF8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F8 (Mac)"
},
{
"signature": "MacControlAltF9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F9 (Mac)"
},
{
"signature": "MacControlAltF10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F10 (Mac)"
},
{
"signature": "MacControlAltF11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F11 (Mac)"
},
{
"signature": "MacControlAltF12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Alt + F12 (Mac)"
},
{
"signature": "MacControlOptionHome",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + Home (Mac)"
},
{
"signature": "MacControlOptionEnd",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + End (Mac)"
},
{
"signature": "MacControlOptionA",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + A (Mac)"
},
{
"signature": "MacControlOptionB",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + B (Mac)"
},
{
"signature": "MacControlOptionC",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + C (Mac)"
},
{
"signature": "MacControlOptionD",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + D (Mac)"
},
{
"signature": "MacControlOptionE",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + E (Mac)"
},
{
"signature": "MacControlOptionF",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F (Mac)"
},
{
"signature": "MacControlOptionG",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + G (Mac)"
},
{
"signature": "MacControlOptionH",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + H (Mac)"
},
{
"signature": "MacControlOptionI",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + I (Mac)"
},
{
"signature": "MacControlOptionJ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + J (Mac)"
},
{
"signature": "MacControlOptionK",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + K (Mac)"
},
{
"signature": "MacControlOptionL",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + L (Mac)"
},
{
"signature": "MacControlOptionM",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + M (Mac)"
},
{
"signature": "MacControlOptionN",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + N (Mac)"
},
{
"signature": "MacControlOptionO",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + O (Mac)"
},
{
"signature": "MacControlOptionP",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + P (Mac)"
},
{
"signature": "MacControlOptionQ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + Q (Mac)"
},
{
"signature": "MacControlOptionR",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + R (Mac)"
},
{
"signature": "MacControlOptionS",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + S (Mac)"
},
{
"signature": "MacControlOptionT",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + T (Mac)"
},
{
"signature": "MacControlOptionU",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + U (Mac)"
},
{
"signature": "MacControlOptionV",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + V (Mac)"
},
{
"signature": "MacControlOptionW",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + W (Mac)"
},
{
"signature": "MacControlOptionX",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + X (Mac)"
},
{
"signature": "MacControlOptionY",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + Y (Mac)"
},
{
"signature": "MacControlOptionZ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + Z (Mac)"
},
{
"signature": "MacControlOption0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + 0 (Mac)"
},
{
"signature": "MacControlOption1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + 1 (Mac)"
},
{
"signature": "MacControlOption2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + 2 (Mac)"
},
{
"signature": "MacControlOption3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + 3 (Mac)"
},
{
"signature": "MacControlOption4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + 4 (Mac)"
},
{
"signature": "MacControlOption5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + 5 (Mac)"
},
{
"signature": "MacControlOption6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + 6 (Mac)"
},
{
"signature": "MacControlOption7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + 7 (Mac)"
},
{
"signature": "MacControlOption8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + 8 (Mac)"
},
{
"signature": "MacControlOption9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + 9 (Mac)"
},
{
"signature": "MacControlOptionF1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F1 (Mac)"
},
{
"signature": "MacControlOptionF2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F2 (Mac)"
},
{
"signature": "MacControlOptionF3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F3 (Mac)"
},
{
"signature": "MacControlOptionF4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F4 (Mac)"
},
{
"signature": "MacControlOptionF5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F5 (Mac)"
},
{
"signature": "MacControlOptionF6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F6 (Mac)"
},
{
"signature": "MacControlOptionF7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F7 (Mac)"
},
{
"signature": "MacControlOptionF8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F8 (Mac)"
},
{
"signature": "MacControlOptionF9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F9 (Mac)"
},
{
"signature": "MacControlOptionF10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F10 (Mac)"
},
{
"signature": "MacControlOptionF11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F11 (Mac)"
},
{
"signature": "MacControlOptionF12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Option + F12 (Mac)"
},
{
"signature": "MacControlShiftHome",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + Home (Mac)"
},
{
"signature": "MacControlShiftEnd",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + End (Mac)"
},
{
"signature": "MacControlShiftA",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + A (Mac)"
},
{
"signature": "MacControlShiftB",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + B (Mac)"
},
{
"signature": "MacControlShiftC",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + C (Mac)"
},
{
"signature": "MacControlShiftD",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + D (Mac)"
},
{
"signature": "MacControlShiftE",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + E (Mac)"
},
{
"signature": "MacControlShiftF",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F (Mac)"
},
{
"signature": "MacControlShiftG",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + G (Mac)"
},
{
"signature": "MacControlShiftH",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + H (Mac)"
},
{
"signature": "MacControlShiftI",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + I (Mac)"
},
{
"signature": "MacControlShiftJ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + J (Mac)"
},
{
"signature": "MacControlShiftK",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + K (Mac)"
},
{
"signature": "MacControlShiftL",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + L (Mac)"
},
{
"signature": "MacControlShiftM",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + M (Mac)"
},
{
"signature": "MacControlShiftN",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + N (Mac)"
},
{
"signature": "MacControlShiftO",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + O (Mac)"
},
{
"signature": "MacControlShiftP",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + P (Mac)"
},
{
"signature": "MacControlShiftQ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + Q (Mac)"
},
{
"signature": "MacControlShiftR",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + R (Mac)"
},
{
"signature": "MacControlShiftS",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + S (Mac)"
},
{
"signature": "MacControlShiftT",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + T (Mac)"
},
{
"signature": "MacControlShiftU",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + U (Mac)"
},
{
"signature": "MacControlShiftV",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + V (Mac)"
},
{
"signature": "MacControlShiftW",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + W (Mac)"
},
{
"signature": "MacControlShiftX",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + X (Mac)"
},
{
"signature": "MacControlShiftY",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + Y (Mac)"
},
{
"signature": "MacControlShiftZ",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + Z (Mac)"
},
{
"signature": "MacControlShift0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + 0 (Mac)"
},
{
"signature": "MacControlShift1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + 1 (Mac)"
},
{
"signature": "MacControlShift2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + 2 (Mac)"
},
{
"signature": "MacControlShift3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + 3 (Mac)"
},
{
"signature": "MacControlShift4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + 4 (Mac)"
},
{
"signature": "MacControlShift5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + 5 (Mac)"
},
{
"signature": "MacControlShift6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + 6 (Mac)"
},
{
"signature": "MacControlShift7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + 7 (Mac)"
},
{
"signature": "MacControlShift8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + 8 (Mac)"
},
{
"signature": "MacControlShift9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + 9 (Mac)"
},
{
"signature": "MacControlShiftF1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F1 (Mac)"
},
{
"signature": "MacControlShiftF2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F2 (Mac)"
},
{
"signature": "MacControlShiftF3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F3 (Mac)"
},
{
"signature": "MacControlShiftF4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F4 (Mac)"
},
{
"signature": "MacControlShiftF5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F5 (Mac)"
},
{
"signature": "MacControlShiftF6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F6 (Mac)"
},
{
"signature": "MacControlShiftF7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F7 (Mac)"
},
{
"signature": "MacControlShiftF8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F8 (Mac)"
},
{
"signature": "MacControlShiftF9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F9 (Mac)"
},
{
"signature": "MacControlShiftF10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F10 (Mac)"
},
{
"signature": "MacControlShiftF11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F11 (Mac)"
},
{
"signature": "MacControlShiftF12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Control + Shift + F12 (Mac)"
},
{
"signature": "CtrlPlus",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl/Command + Plus"
},
{
"signature": "CtrlMinus",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ctrl/Command + Minus"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ShortcutKeySettings",
"dataType": "class",
"summary": "Contains static methods and properties to control keyboard shortcut keys",
"constructors": [
{
"signature": "ShortcutKeySettings()",
"summary": "Initializes a new instance of the ShortcutKeySettings class"
}
],
"methods": [
{
"signature": "KeyboardShortcut[] GetDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get all the default shortcuts registered with Rhino",
"since": "8.13"
},
{
"signature": "System.String GetLabel(ShortcutKey key)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get the macro label associated with a given keyboard shortcut",
"since": "8.0"
},
{
"signature": "System.String GetMacro(ShortcutKey key)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get macro associated with a given keyboard shortcut",
"since": "5.0"
},
{
"signature": "KeyboardShortcut[] GetShortcuts()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get all shortcuts registered with Rhino",
"since": "8.12"
},
{
"signature": "System.Boolean IsAcceptableKeyCombo(Rhino.UI.KeyboardKey key, Rhino.UI.ModifierKey modifier)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Is a key plus modifier combination one that can be used with Rhino",
"since": "8.12"
},
{
"signature": "System.Void SetMacro(Rhino.UI.KeyboardKey key, Rhino.UI.ModifierKey modifier, System.String macro)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Set a macro for a given key and modifier combination",
"since": "8.12"
},
{
"signature": "System.Void SetMacro(ShortcutKey key, System.String macro)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Set macro associated with a keyboard shortcut",
"since": "5.0"
},
{
"signature": "System.Void Update(IEnumerable shortcuts, System.Boolean replaceAll)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Add or modify shortcuts with a list or KeyboardShortcut elements",
"since": "8.12"
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "SmartTrackSettings",
"dataType": "class",
"summary": "Contains static methods and properties that target the Smart Track feature behavior.",
"constructors": [
{
"signature": "SmartTrackSettings()",
"summary": "Initializes a new instance of the SmartTrackSettings class"
}
],
"properties": [
{
"signature": "int ActivationDelayMilliseconds",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the activation delay in milliseconds.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color ActivePointColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the active point color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GuideColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the active guide color.",
"since": "8.21",
"property": ["get", "set"]
},
{
"signature": "Color LineColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the smart track line color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool MarkerSmartPoint",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "TODO - Figure out what this does.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int MaxSmartPoints",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the maximum number of smart points.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool Parallels",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Turns on and off the ability to draw parallel tracking lines.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color PointColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the point color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SemiPermanentPoints",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Toggles the retaining of captured points for the duration of a command as opposed to discarding them after each mouse click. For example, when you use the Copy command, clicking the mouse to place an object does not clear the existing smart points.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowMultipleTypes",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "TODO - Figure out what this does.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SmartBasePoint",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "See Implied from. When a single Smart point is active, you will see the cursor tooltip with a distance.You can either type a distance or enter relative coordinates (e.g. @10,5) to place a point relative to the active smart point.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SmartOrtho",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating if the 'Smart Ortho' feature is active. \nOrthogonal lines are then drawn automatically.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SmartPointAtCPlaneOrigin",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The active viewport construction plane origin is automatically tagged as a smart point, making it possible to snap to it, and snap to ortho lines radiating from it.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SmartSuppress",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "TODO - Figure out what this does.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SmartTangents",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating if the 'Smart Tangents' feature is active.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool StrongOrtho",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "TODO - Figure out what this does.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color TanPerpLineColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the tangent and perpendicular line color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool UseDottedLines",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating if lines are drawn dotted.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool UseSmartTrack",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets if the Smart Track feature is active.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "SmartTrackSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings.",
"since": "5.0",
"returns": "A new Smart Track state with current settings."
},
{
"signature": "SmartTrackSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the Smart Track factory settings.",
"since": "5.0",
"returns": "A new Smart Track state with factory settings."
},
{
"signature": "System.Void UpdateFromState(SmartTrackSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Updates from a particular setting state.",
"since": "5.0",
"parameters": [
{
"name": "state",
"type": "SmartTrackSettingsState",
"summary": "The new state that will be set."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "SmartTrackSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of SmartTrackSettings .",
"properties": [
{
"signature": "int ActivationDelayMilliseconds",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the activation delay in milliseconds.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color ActivePointColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the active point color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GuideColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the active guide color",
"since": "8.21",
"property": ["get", "set"]
},
{
"signature": "Color LineColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the smart track line color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool MarkerSmartPoint",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "TODO - Figure out what this does.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int MaxSmartPoints",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the maximum number of smart points.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool Parallels",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turns on and off the ability to draw parallel tracking lines.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color PointColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the point color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SemiPermanentPoints",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Toggles the retaining of captured points for the duration of a command as opposed to discarding them after each mouse click. For example, when you use the Copy command, clicking the mouse to place an object does not clear the existing smart points.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowMultipleTypes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "TODO - Figure out what this does.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SmartBasePoint",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "See Implied from. When a single Smart point is active, you will see the cursor tooltip with a distance.You can either type a distance or enter relative coordinates (e.g. @10,5) to place a point relative to the active smart point.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SmartOrtho",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating if the 'Smart Ortho' feature is active.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SmartPointAtCPlaneOrigin",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The active viewport construction plane origin is automatically tagged as a smart point, making it possible to snap to it, and snap to ortho lines radiating from it.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SmartSuppress",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "TODO - Figure out what this does.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SmartTangents",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating if the 'Smart Tangents' feature is active.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool StrongOrtho",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "TODO - Figure out what this does.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color TanPerpLineColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the tangent and perpendicular line color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool UseDottedLines",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating if lines are drawn dotted.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool UseSmartTrack",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets if the 'smart track' feature is active.",
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "SoftTransformSettings",
"dataType": "class",
"summary": "Contains static methods and properties to modify soft transform settings",
"constructors": [
{
"signature": "SoftTransformSettings()",
"summary": "Initializes a new instance of the SoftTransformSettings class"
}
],
"properties": [
{
"signature": "int CvCountU",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Controls the number of control vertices affected by soft transform for surfaces in the U direction.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int CvCountV",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Controls the number of control vertices affected by soft transform for surfaces in the V direction.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool Enabled",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "When enabled other unselected components on an object will be moved during a transformation within the specified radius according to the falloff shape.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color FalloffColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Controls the color used to shade meshes and edges when an object is affected by soft transform.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool MeasureDistanceAlong",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "When True the distance for components affected by soft transform is calculated along the object. Otherwise world distance is used.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double Radius",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The radius of effect for soft transform. Other components on the object this distance and closer to selected components will be transformed.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int Shape",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The shape of the falloff curve. 0 = Smooth 1 = Linear 2 = Round 3 = Sharp",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowConstraintWidgets",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Enables or disables constraint widgets on the edges of surfaces when points are on.",
"since": "9.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ThicknessAnalysisSettings",
"dataType": "class",
"summary": "Contains static methods and properties to modify Zebra analysis-related commands.",
"since": "9.0",
"constructors": [
{
"signature": "ThicknessAnalysisSettings()",
"summary": "Initializes a new instance of the ThicknessAnalysisSettings class"
}
],
"properties": [
{
"signature": "Interval DistanceRange",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The distance range.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowIsoCurves",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get or sets the display of surface isocurves.",
"since": "9.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ThicknessAnalysisSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "9.0"
},
{
"signature": "ThicknessAnalysisSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "9.0"
},
{
"signature": "System.Void RestoreDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Commits the default settings as the current settings.",
"since": "9.0"
},
{
"signature": "System.Void UpdateFromState(ThicknessAnalysisSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets all settings to a particular defined joined state.",
"since": "9.0",
"parameters": [
{
"name": "state",
"type": "ThicknessAnalysisSettingsState",
"summary": "The particular state."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ThicknessAnalysisSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of ThicknessAnalysisSettings .",
"since": "9.0",
"properties": [
{
"signature": "Interval DistanceRange",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The distance range.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowIsoCurves",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get or sets the display of surface isocurves.",
"since": "9.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ViewSettings",
"dataType": "class",
"summary": "Contains static methods and properties to control view settings.",
"constructors": [
{
"signature": "ViewSettings()",
"summary": "Initializes a new instance of the ViewSettings class"
}
],
"properties": [
{
"signature": "bool AlwaysPanParallelViews",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'always pan parallel views' value. \nIf the view is not looking straight at the construction plane, then sets parallel viewports so they will not rotate.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool AutoAdjustTargetDepth",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'Auto adjust camera target after Pan and Zoom' value.",
"since": "8.19",
"property": ["get", "set"]
},
{
"signature": "bool DefinedViewSetClippingPlanes",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'Named views set clipping planes' value.",
"since": "8.19",
"property": ["get", "set"]
},
{
"signature": "bool DefinedViewSetCPlane",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'Named views set CPlane' value. \nWhen true, restoring a named view causes the construction plane saved with that view to also restore.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DefinedViewSetDisplayMode",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'Named views set display mode' value.",
"since": "8.19",
"property": ["get", "set"]
},
{
"signature": "bool DefinedViewSetProjection",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'Named views set projection' value. \nWhen true, restoring a named view causes the viewport projection saved with the view to also restore.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool LinkedViewports",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'linked views' activated setting. \nTrue enables real-time view synchronization. When a standard view is manipulated, the camera lens length of all parallel projection viewports are set to match the current viewport.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool PanPlanParallelViewsWithControlShiftRMB",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'Pan plan parallel views with Control+Shift+RMB' value.",
"since": "8.19",
"property": ["get", "set"]
},
{
"signature": "bool PanReverseKeyboardAction",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets if panning with the keyboard is reversed. \nfalse, then Rhino pans the camera in the direction of the arrow key you press. true, then Rhino pans the scene instead.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double PanScreenFraction",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the faction used as multiplier to pan the screen.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int RotateCircleIncrement",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the rotation increment. \nWhen the user rotates a view with the keyboard, Rhino rotates the view in steps. The usual step is 1/60th of a circle, which equals six degrees.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool RotateReverseKeyboard",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the rotation direction. \nIf true, then Rhino rotates the camera around the scene, otherwise, rotates the scene itself.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool RotateToView",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the rotation reference. \nIf true, then the views rotates relative to the view axes; false, than relative to the world x, y, and z axes.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool RotateViewAroundAutogumball",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'Rotate view around auto gumball' value.",
"since": "8.19",
"property": ["get", "set"]
},
{
"signature": "bool RotateViewAroundObjectAtMouseCursor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'Rotate view around object at mouse cursor' value.",
"since": "8.19",
"property": ["get", "set"]
},
{
"signature": "bool SingleClickMaximize",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'single-click maximize' value. \nWhen true, maximizing a viewport needs a single click on the viewport title rather than a double-click.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double ThreePointPerspectiveLensLength",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the three point perspective lens length. The default is 50mm.",
"since": "8.20",
"property": ["get"]
},
{
"signature": "double TwoPointPerspectiveLensLength",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the two point perspective lens length. The default is 20mm.",
"since": "8.20",
"property": ["get"]
},
{
"signature": "ViewRotationStyle ViewRotation",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the view rotation value.",
"since": "8.1",
"property": ["get", "set"]
},
{
"signature": "double ZoomExtentsParallelViewBorder",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Border amount to apply to parallel viewport during zoom extents",
"since": "6.3",
"property": ["get", "set"]
},
{
"signature": "double ZoomExtentsPerspectiveViewBorder",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Border amount to apply to perspective viewport during zoom extents",
"since": "6.3",
"property": ["get", "set"]
},
{
"signature": "double ZoomScale",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the step size for zooming with a wheeled mouse or the Page Up and Page Down keys.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ViewSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings.",
"since": "5.0",
"returns": "A new view state with current settings."
},
{
"signature": "ViewSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the view factory settings.",
"since": "5.0",
"returns": "A new view state with factory settings."
},
{
"signature": "System.Void RestoreDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Updates from the default setting state.",
"since": "5.0"
},
{
"signature": "System.Void UpdateFromState(ViewSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Updates from a particular setting state.",
"since": "5.0",
"parameters": [
{
"name": "state",
"type": "ViewSettingsState",
"summary": "The new state that will be set."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ViewSettings.ViewRotationStyle",
"dataType": "enum",
"summary": "View rotation styles.",
"since": "8.1",
"values": [
{
"signature": "RotateAroundWorldAxes = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Makes the view rotate relative to the world axes. You can use the tilt keys to rotate the view around the view depth axis."
},
{
"signature": "RotateRelativeToView = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Makes the view rotate relative to the view axes rather than the model x, y, and z axes."
},
{
"signature": "RotateRelativeToViewV2Style = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The view rotation is always relative to the previous dynamic view."
},
{
"signature": "RotateAroundCplaneZaxis = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Makes the view (RotateView command) or camera (RotateCamera command) rotate around the construction plane z-axis."
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ViewSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of ViewSettings .",
"since": "5.0",
"properties": [
{
"signature": "bool AlwaysPanParallelViews",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'always pan parallel views' value. \nIf the view is not looking straight at the construction plane, then sets parallel viewports so they will not rotate.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DefinedViewSetCPlane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'named views set CPlane' value. \nWhen true, restoring a named view causes the construction plane saved with that view to also restore.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DefinedViewSetProjection",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'named views set projection' value. \nWhen true, restoring a named view causes the viewport projection saved with the view to also restore.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool LinkedViewports",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'linked views' activated setting. \nTrue enables real-time view synchronization. When a standard view is manipulated, the camera lens length of all parallel projection viewports are set to match the current viewport.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool PanReverseKeyboardAction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets if panning with the keyboard is reversed. \nfalse, then Rhino pans the camera in the direction of the arrow key you press. true, then Rhino pans the scene instead.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double PanScreenFraction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the faction used as multiplier to pan the screen.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int RotateCircleIncrement",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the rotation increment. \nWhen the user rotates a view with the keyboard, Rhino rotates the view in steps. The usual step is 1/60th of a circle, which equals six degrees.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool RotateReverseKeyboard",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the rotation direction. \nIf true, then Rhino rotates the camera around the scene, otherwise, rotates the scene itself.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool RotateToView",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the rotation reference. \nIf true, then the views rotates relative to the view axes; false, than relative to the world x, y, and z axes.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool RotateViewAroundAutogumball",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SingleClickMaximize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'single-click maximize' value. \nWhen true, maximizing a viewport needs a single click on the viewport title rather than a double-click.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double ThreePointPerspectiveLensLength",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the three point perspective lens length. The default is 50mm.",
"since": "8.20",
"property": ["get", "set"]
},
{
"signature": "double TwoPointPerspectiveLensLength",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the two point perspective lens length. The default is 20mm.",
"since": "8.20",
"property": ["get", "set"]
},
{
"signature": "ViewRotationStyle ViewRotation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the view rotation value.",
"since": "8.1",
"property": ["get", "set"]
},
{
"signature": "double ZoomExtentsParallelViewBorder",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Border amount to apply to parallel viewport during zoom extents",
"since": "6.3",
"property": ["get", "set"]
},
{
"signature": "double ZoomExtentsPerspectiveViewBorder",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Border amount to apply to perspective viewport during zoom extents",
"since": "6.3",
"property": ["get", "set"]
},
{
"signature": "double ZoomScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the step size for zooming with a wheeled mouse or the Page Up and Page Down keys.",
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "WidgetColor",
"dataType": "enum",
"summary": "Contains enumerated constant values to represent logical colors associated with elements of the user interface.",
"values": [
{
"signature": "UAxisColor = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The color of the mapping widget u-axis."
},
{
"signature": "VAxisColor = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The color of the mapping widget v-axis.."
},
{
"signature": "WAxisColor = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The color of the mapping widget w-axis."
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ZebraAnalysisSettings",
"dataType": "class",
"summary": "Contains static methods and properties to modify Zebra analysis-related commands.",
"since": "7.8",
"constructors": [
{
"signature": "ZebraAnalysisSettings()",
"summary": "Initializes a new instance of the ZebraAnalysisSettings class"
}
],
"properties": [
{
"signature": "bool ShowIsoCurves",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get or sets the display of surface isocurves.",
"since": "7.8",
"property": ["get", "set"]
},
{
"signature": "Color StripeColor",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the stripe color.",
"since": "7.8",
"property": ["get", "set"]
},
{
"signature": "int StripeThickness",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the stripe thickness, where 0 = thinnest and 6 = thickest.",
"since": "7.8",
"property": ["get", "set"]
},
{
"signature": "bool VerticalStripes",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Set to True for vertical stripes, or False for horizontal stripes.",
"since": "7.8",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ZebraAnalysisSettingsState GetCurrentState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current settings of the application.",
"since": "7.8"
},
{
"signature": "ZebraAnalysisSettingsState GetDefaultState()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the factory settings of the application.",
"since": "7.8"
},
{
"signature": "System.Void RestoreDefaults()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Commits the default settings as the current settings.",
"since": "7.8"
},
{
"signature": "System.Void UpdateFromState(ZebraAnalysisSettingsState state)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Sets all settings to a particular defined joined state.",
"since": "7.8",
"parameters": [
{
"name": "state",
"type": "ZebraAnalysisSettingsState",
"summary": "The particular state."
}
]
}
]
},
{
"namespace": "Rhino.ApplicationSettings",
"name": "ZebraAnalysisSettingsState",
"dataType": "class",
"summary": "Represents a snapshot of ZebraAnalysisSettings .",
"since": "7.8",
"properties": [
{
"signature": "bool ShowIsoCurves",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get or sets the display of surface isocurves.",
"since": "7.8",
"property": ["get", "set"]
},
{
"signature": "Color StripeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the stripe color.",
"since": "7.8",
"property": ["get", "set"]
},
{
"signature": "int StripeThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the stripe thickness, where 0 = thinnest and 6 = thickest.",
"since": "7.8",
"property": ["get", "set"]
},
{
"signature": "bool VerticalStripes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set to True for vertical stripes, or False for horizontal stripes.",
"since": "7.8",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino",
"name": "BitmapExtensions",
"dataType": "class",
"summary": "Rhino specific extension methods for System.Drawing.Bitmap",
"constructors": [
{
"signature": "BitmapExtensions()",
"summary": "Initializes a new instance of the BitmapExtensions class"
}
],
"methods": [
{
"signature": "FileReference BitmapAsTextureFileReference(this System.Drawing.Bitmap bitmap, System.UInt32 crc)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Inserts bitmap into Rhino's texture manager and returns a FileReference.",
"since": "7.7",
"parameters": [
{
"name": "bitmap",
"type": "System.Drawing.Bitmap",
"summary": "The bitmap which will be referenced by the FileReference."
},
{
"name": "crc",
"type": "System.UInt32",
"summary": "The crc of the bitmap. This should be a unique number which changes if the contents of the bitmap changes. NOTE: if a different bitmap is provided using the same crc as a previous bitmap, then the previous bitmap will be overwritten in the texture manager and both previously returned FileReferences will reference the newly provided bitmap."
}
]
},
{
"signature": "System.Drawing.Bitmap ConvertToNormalMap(this System.Drawing.Bitmap bitmap, System.Boolean bLossyCompressionSource, out System.Boolean bPositiveZComponent)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Use this function to convert a System.Drawing.Bitmap from a bump to a normal texture",
"since": "7.5",
"parameters": [
{
"name": "bitmap",
"type": "System.Drawing.Bitmap",
"summary": ""
},
{
"name": "bLossyCompressionSource",
"type": "System.Boolean",
"summary": "True if the source of the bitmap is an image with lossy compression (e.g. jpg). False otherwise. The check will be less strict if the image can contain errors due to lossy compression."
},
{
"name": "bPositiveZComponent",
"type": "System.Boolean",
"summary": "True if the image is a normal map with the z-component mapped to the range 0 .. +1. False if the image is a normal map with the z-component mapped to the range -1 .. +1."
}
]
},
{
"signature": "System.Boolean IsNormalMap(this System.Drawing.Bitmap bitmap, System.Boolean bLossyCompressionSource, out System.Boolean bPositiveZComponent)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Call this method to see if the DIB appears to be a normal map.",
"since": "7.5",
"parameters": [
{
"name": "bitmap",
"type": "System.Drawing.Bitmap",
"summary": ""
},
{
"name": "bLossyCompressionSource",
"type": "System.Boolean",
"summary": "True if the source of the bitmap is an image with lossy compression (e.g. jpg). False otherwise. The check will be less strict if the image can contain errors due to lossy compression."
},
{
"name": "bPositiveZComponent",
"type": "System.Boolean",
"summary": "True if the image is a normal map with the z-component mapped to the range 0 .. +1. False if the image is a normal map with the z-component mapped to the range -1 .. +1."
}
],
"returns": "Returns True if the bitmap appears to be a normal map. False otherwise."
}
]
},
{
"namespace": "Rhino.Collections",
"name": "ArchivableDictionary",
"dataType": "class",
"summary": "Represents a dictionary class that can be attached to objects and can be serialized (saved) at necessity. \nSee remarks for layout.",
"remarks": "This is the layout of this object: \n. \nBEGINCHUNK (TCODE_ANONYMOUS_CHUNK) \n|- version (int) \n|- entry count (int) \nfor entry count entries \n|- BEGINCHUNK (TCODE_ANONYMOUS_CHUNK) \n|- key (string) \n|- entry contents \n|- ENDCHUNK (TCODE_ANONYMOUS_CHUNK) \nENDCHUNK (TCODE_ANONYMOUS_CHUNK)",
"interfaces": ["ICloneable", "IDictionary", "ISerializable"],
"constructors": [
{
"signature": "ArchivableDictionary()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes an instance of a dictionary for writing to a 3dm archive.",
"since": "5.0"
},
{
"signature": "ArchivableDictionary(int version, string name)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes an instance of a dictionary for writing to a 3dm archive.",
"since": "5.0",
"parameters": [
{
"name": "version",
"type": "System.Int32",
"summary": "custom version used to help the plug-in developer determine which version of a dictionary is being written. One good way to write version information is to use a date style integer (YYYYMMDD)"
},
{
"name": "name",
"type": "System.String",
"summary": "Optional name to associate with this dictionary. NOTE: if this dictionary is set as a sub-dictionary, the name will be changed to the sub-dictionary key entry"
}
]
},
{
"signature": "ArchivableDictionary(int version)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes an instance of a dictionary for writing to a 3dm archive.",
"since": "5.0",
"parameters": [
{
"name": "version",
"type": "System.Int32",
"summary": "Custom version used to help the plug-in developer determine which version of a dictionary is being written. One good way to write version information is to use a date style integer (YYYYMMDD)"
}
]
},
{
"signature": "ArchivableDictionary(SerializationInfo info, StreamingContext context)",
"modifiers": ["protected"],
"protected": true,
"virtual": false,
"summary": "Protected constructor for internal use.",
"parameters": [
{
"name": "info",
"type": "System.Runtime.Serialization.SerializationInfo",
"summary": "Serialization data."
},
{
"name": "context",
"type": "System.Runtime.Serialization.StreamingContext",
"summary": "Serialization stream."
}
]
},
{
"signature": "ArchivableDictionary(UserData parentUserData)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes an instance of a dictionary for writing to a 3dm archive",
"since": "5.0",
"parameters": [
{
"name": "parentUserData",
"type": "DocObjects.Custom.UserData",
"summary": "parent user data if this dictionary is associated with user data"
}
]
}
],
"properties": [
{
"signature": "uint ChangeSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Retrieve current change serial number. This is a number that gets increased each time a datum is set or changed.",
"since": "7.8",
"property": ["get"]
},
{
"signature": "int Count",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the number of key/value pairs contained in the dictionary.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string[] Keys",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets all entry names or keys.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string Name",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the name string of this ArchivableDictionary .",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "UserData ParentUserData",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If this dictionary is part of user-data (or is a UserDictionary), then this is the parent user data. None if this dictionary is not part of user-data",
"since": "5.0",
"property": ["get"]
},
{
"signature": "object[] Values",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets all values in this dictionary.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "int Version",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the version of this ArchivableDictionary .",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "object this[string key]",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the value associated with the specified key."
}
],
"methods": [
{
"signature": "System.Boolean AddContentsFrom(ArchivableDictionary source)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Add the contents from the source dictionary.",
"since": "5.4"
},
{
"signature": "System.Void Clear()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes all keys and values from the dictionary.",
"since": "5.0"
},
{
"signature": "ArchivableDictionary Clone()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a deep copy of this object.",
"since": "5.0",
"returns": "The copy of this object."
},
{
"signature": "System.Boolean ContainsKey(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines whether the dictionary contains the specified key.",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The key to locate."
}
],
"returns": "True if the dictionary contains an element with the specified key; otherwise, false."
},
{
"signature": "System.Boolean GetBool(System.String key, System.Boolean defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Boolean, will return defaultValue unless value was created using Set(string key, Boolean value)",
"since": "5.0"
},
{
"signature": "System.Boolean GetBool(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Boolean, will only succeed if value was created using Set(string key, Boolean value)",
"since": "5.0"
},
{
"signature": "System.Byte[] GetBytes(System.String key, System.Byte[] defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as byte[], will return defaultValue unless value was created using Set(string key, byte[] value)",
"since": "5.9"
},
{
"signature": "System.Byte[] GetBytes(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as byte[], will only succeed if value was created using Set(string key, byte[] value)",
"since": "5.9"
},
{
"signature": "ArchivableDictionary GetDictionary(System.String key, ArchivableDictionary defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as ArchivableDictionary, will return defaultValue unless value was created using Set(string key, ArchivableDictionary value)",
"since": "5.9"
},
{
"signature": "ArchivableDictionary GetDictionary(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as ArchivableDictionary, will only succeed if value was created using Set(string key, ArchivableDictionary value)",
"since": "5.9"
},
{
"signature": "System.Double GetDouble(System.String key, System.Double defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as double, will only succeed if value was created using Set(string key, double value)",
"since": "5.10"
},
{
"signature": "System.Double GetDouble(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as double, will only succeed if value was created using Set(string key, double value)",
"since": "5.0"
},
{
"signature": "IEnumerator> GetEnumerator()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the enumerator of this dictionary.",
"since": "5.0",
"returns": "A IEnumerator{T} , where T is an instance of KeyValuePair{T0,T1} , with T0 set as string, and T1 as System.Object."
},
{
"signature": "T GetEnumValue()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get an enum value",
"since": "5.4"
},
{
"signature": "T GetEnumValue(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get an enum value from the dictionary using a custom key.",
"since": "5.4"
},
{
"signature": "System.Single GetFloat(System.String key, System.Single defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as float, will return defaultValue unless value was created using Set(string key, float value)",
"since": "5.0"
},
{
"signature": "System.Single GetFloat(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as float, will only succeed if value was created using Set(string key, float value)",
"since": "5.0"
},
{
"signature": "System.Guid GetGuid(System.String key, System.Guid defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Guid, will return defaultValue unless value was created using Set(string key, Guid value)",
"since": "5.0"
},
{
"signature": "System.Guid GetGuid(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Guid, will only succeed if value was created using Set(string key, Guid value)",
"since": "5.0"
},
{
"signature": "System.Int32 Getint(System.String key, System.Int32 defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as int, will return defaultValue unless value was created using Set(string key, int value)",
"since": "5.0"
},
{
"signature": "System.Int32 GetInteger(System.String key, System.Int32 defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as int, will return defaultValue unless value was created using Set(string key, int value)",
"since": "5.0"
},
{
"signature": "System.Int32 GetInteger(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as int, will only succeed if value was created using Set(string key, int value)",
"since": "5.0"
},
{
"signature": "System.Void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.",
"since": "7.0",
"parameters": [
{
"name": "info",
"type": "System.Runtime.Serialization.SerializationInfo",
"summary": "The System.Runtime.Serialization.SerializationInfo to populate with data."
},
{
"name": "context",
"type": "System.Runtime.Serialization.StreamingContext",
"summary": "The destination (see System.Runtime.Serialization.StreamingContext) for this serialization."
}
]
},
{
"signature": "Geometry.Plane GetPlane(System.String key, Geometry.Plane defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Plane, will return defaultValue unless value was created using Set(string key, Plane value)",
"since": "6.11",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The key."
},
{
"name": "defaultValue",
"type": "Geometry.Plane",
"summary": "The default value."
}
],
"returns": "The value as Plane."
},
{
"signature": "Geometry.Plane GetPlane(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Plane, will return defaultValue unless value was created using Set(string key, Plane value)",
"since": "6.11",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The key."
}
],
"returns": "The value as Plane."
},
{
"signature": "Geometry.Point3d GetPoint3d(System.String key, Geometry.Point3d defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Point3d, will return defaultValue unless value was created using Set(string key, Point3d value)",
"since": "5.0"
},
{
"signature": "Geometry.Point3d GetPoint3d(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Point3d, will only succeed if value was created using Set(string key, Point3d value)",
"since": "5.0"
},
{
"signature": "Geometry.Point3f GetPoint3f(System.String key, Geometry.Point3f defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Point3f, will return defaultValue unless value was created using Set(string key, Point3f value)",
"since": "5.0"
},
{
"signature": "Geometry.Point3f GetPoint3f(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Point3f, will only succeed if value was created using Set(string key, Point3f value)",
"since": "5.0"
},
{
"signature": "System.String GetString(System.String key, System.String defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as string, will return defaultValue unless value was created using Set(string key, string value)",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The key which points to the string"
},
{
"name": "defaultValue",
"type": "System.String",
"summary": "The string"
}
]
},
{
"signature": "System.String GetString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as string, will only succeed if value was created using Set(string key, string value)",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The key which points to the string"
}
],
"returns": "The string"
},
{
"signature": "Geometry.Vector3d GetVector3d(System.String key, Geometry.Vector3d defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Vector3d, will return defaultValue unless value was created using Set(string key, Vector3d value)",
"since": "5.0"
},
{
"signature": "Geometry.Vector3d GetVector3d(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Vector3d, will only succeed if value was created using Set(string key, Vector3d value)",
"since": "5.0"
},
{
"signature": "System.Boolean Remove(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes the value with the specified key from the dictionary.",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The key of the element to remove."
}
],
"returns": "True if the element is successfully found and removed; otherwise, false. This method returns False if key is not found."
},
{
"signature": "System.Boolean RemoveEnumValue()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove an enum value from the dictionary.",
"since": "5.4"
},
{
"signature": "System.Boolean ReplaceContentsWith(ArchivableDictionary source)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Replace the contents of the dictionary with that of the given source dictionary.",
"since": "5.4"
},
{
"signature": "System.Boolean Set(System.String key, ArchivableDictionary val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets another ArchivableDictionary as entry in this dictionary.",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "ArchivableDictionary",
"summary": "An object for that key. \nBecause this class is a reference type and is mutable, changes to this object will propagate to the object inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
]
},
{
"signature": "System.Boolean Set(System.String key, DocObjects.ObjRef val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.DocObjects.ObjRef",
"since": "5.8",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key"
},
{
"name": "val",
"type": "DocObjects.ObjRef",
"summary": "An object for that key \nBecause this class is a reference type and is mutable, changes to this object will propagate to the object inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.BoundingBox val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.BoundingBox .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.BoundingBox",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.GeometryBase val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets any class deriving from the Rhino.Geometry.GeometryBase base class.",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.GeometryBase",
"summary": "A geometry object for that key. \nBecause this class is a reference type and is mutable, changes to this object will propagate to the object inside the dictionary. \nIt is up to the user to clone this entry when appropriate. You can use for this."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.Interval val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets an Rhino.Geometry.Interval .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.Interval",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.Line val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.Line .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.Line",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.MeshingParameters val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.MeshingParameters .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.MeshingParameters",
"summary": "An object for that key. \nBecause this class is a reference type and is mutable, changes to this object will propagate to the object inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.Plane val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.Plane .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.Plane",
"summary": "A plane for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.Point2d val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.Point2d .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.Point2d",
"summary": "A point for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.Point3d val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.Point3d .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.Point3d",
"summary": "A point for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.Point3f val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.Point3f .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.Point3f",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.Point4d val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.Point4d .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.Point4d",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.Ray3d val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.Ray3d .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.Ray3d",
"summary": "A value for that key. \nBecause has value semantics and is immutable, no changes to this object are possible."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.Transform val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.Transform .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.Transform",
"summary": "A transform for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.Vector2d val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.Vector2d .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.Vector2d",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.Vector3d val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.Vector3d .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.Vector3d",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, Geometry.Vector3f val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Rhino.Geometry.Vector3f .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "Geometry.Vector3f",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, IEnumerable val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a list, an array or any enumerable of bool .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "IEnumerable",
"summary": "A value for that key. \nBecause this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, IEnumerable val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a list, an array or any enumerable of byte .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "IEnumerable",
"summary": "A value for that key \nBecause this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, IEnumerable val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a list, an array or any enumerable of double .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "IEnumerable",
"summary": "A value for that key. \nBecause this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, IEnumerable val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a list, an array or any enumerable of float .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "IEnumerable",
"summary": "A value for that key. \nBecause this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, IEnumerable val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets an array of Rhino.Geometry.GeometryBase",
"since": "7.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key"
},
{
"name": "val",
"type": "IEnumerable",
"summary": "An object for that key \nBecause this class is a reference type and is mutable, changes to this object will propagate to the object inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
],
"returns": "True if successful, False otherwise."
},
{
"signature": "System.Boolean Set(System.String key, IEnumerable val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a list, an array or any enumerable of Guid .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "IEnumerable",
"summary": "A value for that key. \nBecause this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, IEnumerable val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a list, an array or any enumerable of int .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "IEnumerable",
"summary": "A value for that key. \nBecause this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, IEnumerable val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets an array of Rhino.DocObjects.ObjRef",
"since": "5.8",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key"
},
{
"name": "val",
"type": "IEnumerable",
"summary": "An object for that key \nBecause this class is a reference type and is mutable, changes to this object will propagate to the object inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
]
},
{
"signature": "System.Boolean Set(System.String key, IEnumerable val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a list, an array or any enumerable of sbyte .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "IEnumerable",
"summary": "A value for that key. \nBecause this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, IEnumerable val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a list, an array or any enumerable of short .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "IEnumerable",
"summary": "A value for that key. \nBecause this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, IEnumerable val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a list, an array or any enumerable of string .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "IEnumerable",
"summary": "A value for that key. \nBecause this interface is a reference type, changes to the assigned object will modify this entry inside the dictionary. \nIt is up to the user to clone this entry when appropriate."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.Boolean val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a bool .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The text key."
},
{
"name": "val",
"type": "System.Boolean",
"summary": "A bool value. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.Byte val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a byte .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The text key."
},
{
"name": "val",
"type": "System.Byte",
"summary": "A byte . \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.Double val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a double .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The text key."
},
{
"name": "val",
"type": "System.Double",
"summary": "A double . \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.Drawing.Color val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a System.Drawing.Color .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "System.Drawing.Color",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.Drawing.Font val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a System.Drawing.Font .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "System.Drawing.Font",
"summary": "A value for that key. \nBecause is immutable, it is not possible to modify the object while it is in this dictionary."
}
]
},
{
"signature": "System.Boolean Set(System.String key, System.Drawing.Point val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a System.Drawing.Point .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "System.Drawing.Point",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, System.Drawing.PointF val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a System.Drawing.PointF .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "System.Drawing.PointF",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, System.Drawing.Rectangle val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a System.Drawing.Rectangle .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "System.Drawing.Rectangle",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, System.Drawing.RectangleF val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a System.Drawing.RectangleF .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "System.Drawing.RectangleF",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, System.Drawing.Size val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a System.Drawing.Size .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "System.Drawing.Size",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, System.Drawing.SizeF val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a System.Drawing.SizeF .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "A text key."
},
{
"name": "val",
"type": "System.Drawing.SizeF",
"summary": "A value for that key. \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
]
},
{
"signature": "System.Boolean Set(System.String key, System.Guid val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a Guid .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The text key."
},
{
"name": "val",
"type": "System.Guid",
"summary": "A Guid . \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.Int16 val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a short .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The text key."
},
{
"name": "val",
"type": "System.Int16",
"summary": "A short . \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.Int32 val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a int .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The text key."
},
{
"name": "val",
"type": "System.Int32",
"summary": "A int . \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.Int64 val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a long .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The text key."
},
{
"name": "val",
"type": "System.Int64",
"summary": "A long . \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.SByte val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a sbyte .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The text key."
},
{
"name": "val",
"type": "System.SByte",
"summary": "A sbyte . \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.Single val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a float .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The text key."
},
{
"name": "val",
"type": "System.Single",
"summary": "A float . \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.String val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a string .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The text key."
},
{
"name": "val",
"type": "System.String",
"summary": "A string . \nBecause is immutable, it is not possible to modify the object while it is in this dictionary."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.UInt16 val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a ushort .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The text key."
},
{
"name": "val",
"type": "System.UInt16",
"summary": "A ushort . \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean Set(System.String key, System.UInt32 val)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a uint .",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The text key."
},
{
"name": "val",
"type": "System.UInt32",
"summary": "A uint . \nBecause has value semantics, changes to the assigning value will leave this entry unchanged."
}
],
"returns": "True if set operation succeeded, otherwise false."
},
{
"signature": "System.Boolean SetEnumValue(System.String key, T enumValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set an enum value in the dictionary with a custom key.",
"since": "5.4"
},
{
"signature": "System.Boolean SetEnumValue(T enumValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set an enum value",
"since": "5.4"
},
{
"signature": "System.Boolean TryGetBool(System.String key, out System.Boolean value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Boolean, will only succeed if value was created using Set(string key, Boolean value)",
"since": "5.0"
},
{
"signature": "System.Boolean TryGetBytes(System.String key, out System.Byte[] value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as byte[], will only succeed if value was created using Set(string key, byte[] value)",
"since": "5.9"
},
{
"signature": "System.Boolean TryGetDictionary(System.String key, out ArchivableDictionary value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as ArchivableDictionary, will only succeed if value was created using Set(string key, ArchivableDictionary value)",
"since": "5.9"
},
{
"signature": "System.Boolean TryGetDouble(System.String key, out System.Double value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as double, will only succeed if value was created using Set(string key, double value)",
"since": "5.0"
},
{
"signature": "System.Boolean TryGetEnumValue(System.String key, out T enumValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Attempt to get an enum value from the dictionary using a custom key.",
"since": "5.4"
},
{
"signature": "System.Boolean TryGetFloat(System.String key, out System.Single value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as float, will only succeed if value was created using Set(string key, float value)",
"since": "5.0"
},
{
"signature": "System.Boolean TryGetGuid(System.String key, out System.Guid value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Guid, will only succeed if value was created using Set(string key, Guid value)",
"since": "5.0"
},
{
"signature": "System.Boolean TryGetInteger(System.String key, out System.Int32 value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as int, will only succeed if value was created using Set(string key, int value)",
"since": "5.0"
},
{
"signature": "System.Boolean TryGetPlane(System.String key, out Geometry.Plane value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Plane, will only succeed if value was created using Set(string key, Plane value)",
"since": "6.11",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The key."
},
{
"name": "value",
"type": "Geometry.Plane",
"summary": "The value."
}
],
"returns": "The value as Plane."
},
{
"signature": "System.Boolean TryGetPoint3d(System.String key, out Geometry.Point3d value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Point3d, will only succeed if value was created using Set(string key, Point3d value)",
"since": "5.0"
},
{
"signature": "System.Boolean TryGetPoint3f(System.String key, out Geometry.Point3f value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Point3f, will only succeed if value was created using Set(string key, Point3f value)",
"since": "5.0"
},
{
"signature": "System.Boolean TryGetString(System.String key, out System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as string, will only succeed if value was created using Set(string key, string value)",
"since": "5.0"
},
{
"signature": "System.Boolean TryGetValue(System.String key, out System.Object value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the value associated with the specified key.",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "The key of the value to get."
},
{
"name": "value",
"type": "System.Object",
"summary": "When this method returns and if the key is found, contains the value associated with the specified key; otherwise, null. This parameter is passed uninitialized."
}
],
"returns": "True if the dictionary contains an element with the specified key; otherwise, false."
},
{
"signature": "System.Boolean TryGetVector3d(System.String key, out Geometry.Vector3d value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get value as Vector3d, will only succeed if value was created using Set(string key, Vector3d value)",
"since": "5.0"
}
]
},
{
"namespace": "Rhino.Collections",
"name": "CurveList",
"dataType": "class",
"summary": "Represents a list of curves.",
"baseclass": "RhinoList",
"constructors": [
{
"signature": "CurveList()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new empty list of curves.",
"since": "5.0"
},
{
"signature": "CurveList(IEnumerable collection)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new list that is filled with all items of the input enumerable. \nInput items are not explicitly duplicated (this is a shallow copy).",
"since": "5.0",
"parameters": [
{
"name": "collection",
"type": "IEnumerable",
"summary": "A list, an array or any enumerable set of Curve ."
}
]
},
{
"signature": "CurveList(int initialCapacity)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new empty list of curves with a predefined capacity. \nThis is the amount of items the list will accept before resizing.",
"since": "5.0"
}
],
"methods": [
{
"signature": "System.Void Add(Arc arc)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds an arc to this list.",
"since": "5.0",
"parameters": [
{
"name": "arc",
"type": "Arc",
"summary": "An arc value that will be the model of the new internal curve."
}
]
},
{
"signature": "System.Void Add(Circle circle)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a circle to this list.",
"since": "5.0",
"parameters": [
{
"name": "circle",
"type": "Circle",
"summary": "A circle value that will be the model of the new internal curve."
}
]
},
{
"signature": "System.Void Add(Ellipse ellipse)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds an ellipse to this list.",
"since": "5.0",
"parameters": [
{
"name": "ellipse",
"type": "Ellipse",
"summary": "An ellipse that will be the model of the new internal curve."
}
]
},
{
"signature": "System.Void Add(IEnumerable polyline)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a polyline to this list.",
"since": "5.0",
"parameters": [
{
"name": "polyline",
"type": "IEnumerable",
"summary": "A polyline value that will be copied in a new polyline. \nThis argument can be null, an array, a list or any enumerable set of ."
}
]
},
{
"signature": "System.Void Add(Line line)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a line to this list.",
"since": "5.0",
"parameters": [
{
"name": "line",
"type": "Line",
"summary": "A line value that will be the model of the new internal curve."
}
]
},
{
"signature": "System.Void Insert(System.Int32 index, Arc arc)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Inserts an arc at a given index of this list.",
"since": "5.0",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "A 0-based position in the list."
},
{
"name": "arc",
"type": "Arc",
"summary": "The arc value from which to construct the new curve."
}
]
},
{
"signature": "System.Void Insert(System.Int32 index, Circle circle)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Inserts a line at a given index of this list.",
"since": "5.0",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "A 0-based position in the list."
},
{
"name": "circle",
"type": "Circle",
"summary": "The circle value from which to construct the new curve."
}
]
},
{
"signature": "System.Void Insert(System.Int32 index, Ellipse ellipse)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Inserts an ellipse at a given index of this list.",
"since": "5.0",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "A 0-based position in the list."
},
{
"name": "ellipse",
"type": "Ellipse",
"summary": "The ellipse value from which to construct the new curve."
}
]
},
{
"signature": "System.Void Insert(System.Int32 index, IEnumerable polyline)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Inserts a polyline at a given index of this list.",
"since": "5.0",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "A 0-based position in the list."
},
{
"name": "polyline",
"type": "IEnumerable",
"summary": "The polyline enumerable from which to construct a copy curve. \nThis argument can be null, an array, a list or any enumerable set of ."
}
]
},
{
"signature": "System.Void Insert(System.Int32 index, Line line)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Inserts a line at a given index of this list.",
"since": "5.0",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "A 0-based position in the list."
},
{
"name": "line",
"type": "Line",
"summary": "The line value from which to construct the new curve."
}
]
},
{
"signature": "System.Boolean Transform(Transform xform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Transform all the curves in this list. If at least a single transform failed this function returns false.",
"since": "5.0",
"parameters": [
{
"name": "xform",
"type": "Transform",
"summary": "Transformation to apply to all curves."
}
]
}
]
},
{
"namespace": "Rhino.Collections",
"name": "IResizableList",
"dataType": "interface",
"summary": "Provides the ability to resize a generic list by setting the Count property.",
"properties": [
{
"signature": "int Count",
"modifiers": ["new"],
"protected": true,
"virtual": false,
"summary": "Gets or sets the length of the list. This hides (Shadows in Vb.Net) the read-only Count property of the generic list.",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.Collections",
"name": "Point3dList",
"dataType": "class",
"summary": "Represents a list of Point3d .",
"baseclass": "RhinoList",
"interfaces": ["ICloneable", "IEquatable"],
"constructors": [
{
"signature": "Point3dList()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new empty list with default capacity.",
"since": "5.0"
},
{
"signature": "Point3dList(IEnumerable collection)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new point list by copying the values from another set.",
"since": "5.0",
"parameters": [
{
"name": "collection",
"type": "IEnumerable",
"summary": "The collection to copy from."
}
]
},
{
"signature": "Point3dList(int initialCapacity)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new point list with a preallocated initial capacity.",
"since": "5.0",
"parameters": [
{
"name": "initialCapacity",
"type": "System.Int32",
"summary": "The number of added items before which the underlying array will be resized."
}
]
},
{
"signature": "Point3dList(Point3d[] initialPoints)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new point list from values in a point array.",
"since": "5.0",
"parameters": [
{
"name": "initialPoints",
"type": "Point3d[]",
"summary": "Points to add to the list."
}
]
}
],
"properties": [
{
"signature": "BoundingBox BoundingBox",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Even though this is a property, it is not a \"fast\" calculation. Every point is evaluated in order to get the bounding box of the list.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "XAccess X",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns an indexer with all X coordinates in this list.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "YAccess Y",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns an indexer with all Y coordinates in this list.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "ZAccess Z",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns an indexer with all Z coordinates in this list.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Int32 ClosestIndexInList(IList list, Point3d testPoint)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Finds the index of the point in a list of points that is closest to a test point.",
"since": "5.0",
"parameters": [
{
"name": "list",
"type": "IList",
"summary": "A list of points."
},
{
"name": "testPoint",
"type": "Point3d",
"summary": "Point to compare against."
}
],
"returns": "Index of closest point in the list on success or -1 on error."
},
{
"signature": "Point3d ClosestPointInList(IList list, Point3d testPoint)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Finds the point in a list of points that is closest to a test point.",
"since": "5.0",
"parameters": [
{
"name": "list",
"type": "IList",
"summary": "A list of points."
},
{
"name": "testPoint",
"type": "Point3d",
"summary": "Point to compare against."
}
],
"returns": "A point."
},
{
"signature": "System.Void Add(System.Double x, System.Double y, System.Double z)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a Point3d to the end of the list with given x,y,z coordinates.",
"since": "5.0",
"parameters": [
{
"name": "x",
"type": "System.Double",
"summary": "The X coordinate."
},
{
"name": "y",
"type": "System.Double",
"summary": "The Y coordinate."
},
{
"name": "z",
"type": "System.Double",
"summary": "The Z coordinate."
}
]
},
{
"signature": "System.Int32 ClosestIndex(Point3d testPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Finds the index of the point that is closest to a test point in this list.",
"since": "5.0",
"parameters": [
{
"name": "testPoint",
"type": "Point3d",
"summary": "point to compare against."
}
],
"returns": "index of closest point in the list on success. -1 on error."
},
{
"signature": "Point3dList Duplicate()",
"modifiers": ["public", "new"],
"protected": false,
"virtual": false,
"summary": "Returns a deep copy of this point list instance.",
"since": "6.0",
"returns": "The duplicated list."
},
{
"signature": "System.Boolean Equals(Point3dList other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines if the point lists are exactly equal.",
"since": "7.1",
"returns": "True is objects are exactly equal in value."
},
{
"signature": "System.Boolean Equals(System.Object obj)",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Overrides the default object equality to compare lists by value.",
"returns": "True is objects are exactly equal in value."
},
{
"signature": "System.Int32 GetHashCode()",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Creates a hash code for this object.",
"returns": "An int that serves as an hash code. This is currently a XOR of all doubles, XORed in line."
},
{
"signature": "System.Void SetAllX(System.Double xValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set all the X values for the points to a single value",
"since": "5.6"
},
{
"signature": "System.Void SetAllY(System.Double yValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set all the Y values for the points to a single value",
"since": "5.6"
},
{
"signature": "System.Void SetAllZ(System.Double zValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set all the Z values for the points to a single value",
"since": "5.6"
},
{
"signature": "System.Void Transform(Transform xform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Applies a transform to all the points in the list.",
"since": "5.0",
"parameters": [
{
"name": "xform",
"type": "Transform",
"summary": "Transform to apply."
}
]
}
]
},
{
"namespace": "Rhino.Collections",
"name": "Point3dList.XAccess",
"dataType": "class",
"summary": "Utility class for easy-access of x-components of points inside an ON_3dPointList.",
"properties": [
{
"signature": "double this[int index]",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the x-coordinate of the specified point."
}
]
},
{
"namespace": "Rhino.Collections",
"name": "Point3dList.YAccess",
"dataType": "class",
"summary": "Utility class for easy-access of x-components of points inside an ON_3dPointList.",
"properties": [
{
"signature": "double this[int index]",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the y-coordinate of the specified point."
}
]
},
{
"namespace": "Rhino.Collections",
"name": "Point3dList.ZAccess",
"dataType": "class",
"summary": "Utility class for easy-access of z-components of points inside an ON_3dPointList.",
"properties": [
{
"signature": "double this[int index]",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the z-coordinate of the specified point."
}
]
},
{
"namespace": "Rhino.Collections",
"name": "RhinoList",
"dataType": "class",
"summary": "Provides helper methods to work with RhinoList and other collections.",
"constructors": [
{
"signature": "RhinoList()",
"summary": "Initializes a new instance of the RhinoList class"
}
],
"methods": [
{
"signature": "IEnumerable Point2dKNeighbors(IEnumerable hayPoints, IEnumerable needlePoints, System.Int32 amount)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Finds a certain amour of points in a list of single-precision 2D points that are the k-closest to a test point. This method searches needlePoints by computing all distances from each point cloud point and keeping a \"short list\".",
"since": "6.0",
"parameters": [
{
"name": "hayPoints",
"type": "IEnumerable",
"summary": "A point cloud to be searched."
},
{
"name": "needlePoints",
"type": "IEnumerable",
"summary": "Points to search for."
},
{
"name": "amount",
"type": "System.Int32",
"summary": "The required amount of closest neighbors to find."
}
],
"returns": "An enumerable of arrays of indices; each array contains the indices for each of the needlePts."
},
{
"signature": "IEnumerable Point2fKNeighbors(IEnumerable hayPoints, IEnumerable needlePoints, System.Int32 amount)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Finds a certain amour of points in a list of single-precision 2D points that are the k-closest to a test point. This method searches needlePoints by computing all distances from each point cloud point and keeping a \"short list\".",
"since": "6.0",
"parameters": [
{
"name": "hayPoints",
"type": "IEnumerable",
"summary": "A point cloud to be searched."
},
{
"name": "needlePoints",
"type": "IEnumerable",
"summary": "Points to search for."
},
{
"name": "amount",
"type": "System.Int32",
"summary": "The required amount of closest neighbors to find."
}
],
"returns": "An enumerable of arrays of indices; each array contains the indices for each of the needlePts."
},
{
"signature": "IEnumerable Point3dKNeighbors(IEnumerable hayPoints, IEnumerable needlePoints, System.Int32 amount)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Finds a certain amour of points in a list of 3D points that are the k-closest to a test point. This method searches needlePoints by computing all distances from each point cloud point and keeping a \"short list\". See RTree KNeighbors for alternatives.",
"since": "6.0",
"parameters": [
{
"name": "hayPoints",
"type": "IEnumerable",
"summary": "A point cloud to be searched."
},
{
"name": "needlePoints",
"type": "IEnumerable",
"summary": "Points to search for."
},
{
"name": "amount",
"type": "System.Int32",
"summary": "The required amount of closest neighbors to find."
}
],
"returns": "An enumerable of arrays of indices; each array contains the indices for each of the needlePts."
},
{
"signature": "IEnumerable Point3fKNeighbors(IEnumerable hayPoints, IEnumerable needlePoints, System.Int32 amount)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Finds a certain amour of points in a list of single-precision 3D points that are the k-closest to a test point. This method searches needlePoints by computing all distances from each point cloud point and keeping a \"short list\".",
"since": "6.0",
"parameters": [
{
"name": "hayPoints",
"type": "IEnumerable",
"summary": "A point cloud to be searched."
},
{
"name": "needlePoints",
"type": "IEnumerable",
"summary": "Points to search for."
},
{
"name": "amount",
"type": "System.Int32",
"summary": "The required amount of closest neighbors to find."
}
],
"returns": "An enumerable of arrays of indices; each array contains the indices for each of the needlePts."
},
{
"signature": "IEnumerable PointCloudKNeighbors(PointCloud pointcloud, IEnumerable needlePoints, System.Int32 amount)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Finds a certain amount of points in a list of 3D points that are the k-closest to a test point. This method searches needlePoints by computing all distances from each point cloud point and keeping a short list.",
"since": "6.0",
"parameters": [
{
"name": "pointcloud",
"type": "PointCloud",
"summary": "A point cloud to be searched."
},
{
"name": "needlePoints",
"type": "IEnumerable",
"summary": "Points to search for."
},
{
"name": "amount",
"type": "System.Int32",
"summary": "The required amount of closest neighbors to find."
}
],
"returns": "An enumerable of arrays of indices; each array contains the indices for each of the needlePts."
}
]
},
{
"namespace": "Rhino.Collections",
"name": "RhinoList",
"dataType": "class",
"summary": "Represents a list of generic data. This class is similar to System.Collections.Generic.List(T) but exposes a few more methods.",
"interfaces": ["IList", "IList", "ICloneable"],
"constructors": [
{
"signature": "RhinoList()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new, empty list."
},
{
"signature": "RhinoList(IEnumerable collection)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes this list as a shallow duplicate of another list, array or any other enumerable set of T.",
"parameters": [
{
"name": "collection",
"type": "IEnumerable",
"summary": "Collection of items to duplicate."
}
]
},
{
"signature": "RhinoList(int amount, T defaultValue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new list with a specified amount of values.",
"parameters": [
{
"name": "amount",
"type": "System.Int32",
"summary": "Number of values to add to this list. Must be equal to or larger than zero."
},
{
"name": "defaultValue",
"type": "T",
"summary": "Value to add, for reference types, the same item will be added over and over again."
}
]
},
{
"signature": "RhinoList(int initialCapacity)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes an empty list with a certain capacity.",
"parameters": [
{
"name": "initialCapacity",
"type": "System.Int32",
"summary": "Number of items this list can store without resizing."
}
]
},
{
"signature": "RhinoList(RhinoList list)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes an new list by shallow duplicating another list.",
"parameters": [
{
"name": "list",
"type": "RhinoList",
"summary": "List to mimic."
}
]
}
],
"properties": [
{
"signature": "int Capacity",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the total number of elements the internal data structure can hold without resizing.",
"property": ["get", "set"]
},
{
"signature": "int Count",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the number of elements actually contained in the List.",
"property": ["get"]
},
{
"signature": "T First",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the first item in the list. This is synonymous to calling List[0].",
"property": ["get", "set"]
},
{
"signature": "T Last",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the last item in the list. This is synonymous to calling List[Count-1].",
"property": ["get", "set"]
},
{
"signature": "int NullCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the number of None references (Nothing in Visual Basic) in this list. If T is a ValueType, this property always return zero.",
"property": ["get"]
},
{
"signature": "T this[int index]",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the element at the specified index."
}
],
"methods": [
{
"signature": "System.Void Add(T item)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds an object to the end of the List.",
"parameters": [
{
"name": "item",
"type": "T",
"summary": "Item to append."
}
]
},
{
"signature": "System.Void AddRange(IEnumerable collection)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds the elements of the specified collection to the end of the List.",
"parameters": [
{
"name": "collection",
"type": "IEnumerable",
"summary": "The collection whose elements should be added to the end of the List. The collection itself cannot be a None reference (Nothing in Visual Basic), but it can contain elements that are a None reference (Nothing in Visual Basic), if type T is a reference type."
}
]
},
{
"signature": "System.Void AddRange(System.Collections.IEnumerable collection)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds the elements of the specified collection to the end of the List.",
"parameters": [
{
"name": "collection",
"type": "System.Collections.IEnumerable",
"summary": "The collection whose elements should be added to the end of the List. The collection itself cannot be a None reference (Nothing in Visual Basic), but it can contain elements that are a None reference (Nothing in Visual Basic). Objects in collection which cannot be represented as T will throw exceptions."
}
]
},
{
"signature": "ReadOnlyCollection AsReadOnly()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a read-only wrapper of this class.",
"returns": "A wrapper."
},
{
"signature": "System.Int32 BinarySearch(System.Int32 index, System.Int32 count, T item, IComparer comparer)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches the entire sorted List for an element using the specified comparer and returns the zero-based index of the element.",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based starting index of the range to search."
},
{
"name": "count",
"type": "System.Int32",
"summary": "The length of the range to search."
},
{
"name": "item",
"type": "T",
"summary": "The object to locate. The value can be a None reference (Nothing in Visual Basic) for reference types."
},
{
"name": "comparer",
"type": "IComparer",
"summary": "The IComparer(T) implementation to use when comparing elements. Or a None reference (Nothing in Visual Basic) to use the default comparer Comparer(T)::Default."
}
],
"returns": "The zero-based index of item in the sorted List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of Count."
},
{
"signature": "System.Int32 BinarySearch(T item, IComparer comparer)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches the entire sorted List for an element using the specified comparer and returns the zero-based index of the element.",
"parameters": [
{
"name": "item",
"type": "T",
"summary": "The object to locate. The value can be a None reference (Nothing in Visual Basic) for reference types."
},
{
"name": "comparer",
"type": "IComparer",
"summary": "The IComparer(T) implementation to use when comparing elements. Or a None reference (Nothing in Visual Basic) to use the default comparer Comparer(T)::Default."
}
],
"returns": "The zero-based index of item in the sorted List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of Count."
},
{
"signature": "System.Int32 BinarySearch(T item)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches the entire sorted List for an element using the default comparer and returns the zero-based index of the element.",
"parameters": [
{
"name": "item",
"type": "T",
"summary": "The object to locate. The value can be a None reference (Nothing in Visual Basic) for reference types."
}
],
"returns": "The zero-based index of item in the sorted List, if item is found; otherwise, a negative number that is the bitwise complement of the index of the next element that is larger than item or, if there is no larger element, the bitwise complement of Count."
},
{
"signature": "System.Void Clear()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes all elements from the List."
},
{
"signature": "System.Boolean Contains(T item)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines whether an element is in the List.",
"parameters": [
{
"name": "item",
"type": "T",
"summary": "The object to locate in the List. The value can be a None reference (Nothing in Visual Basic) for reference types."
}
],
"returns": "True if item is found in the List; otherwise, false."
},
{
"signature": "RhinoList ConvertAll(Converter converter)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Aggregates all results of a conversion function over this table into a new list.",
"parameters": [
{
"name": "converter",
"type": "Converter",
"summary": "A conversion function that can transform from T to TOutput."
}
],
"returns": "The new list."
},
{
"signature": "System.Void CopyTo(System.Int32 index, T[] array, System.Int32 arrayIndex, System.Int32 count)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Copies a range of elements from the List to a compatible one-dimensional array, starting at the specified index of the target array.",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based index in the source List at which copying begins."
},
{
"name": "array",
"type": "T[]",
"summary": "The one-dimensional Array that is the destination of the elements copied from List. The Array must have zero-based indexing."
},
{
"name": "arrayIndex",
"type": "System.Int32",
"summary": "The zero-based index in array at which copying begins."
},
{
"name": "count",
"type": "System.Int32",
"summary": "The number of elements to copy."
}
]
},
{
"signature": "System.Void CopyTo(T[] array, System.Int32 arrayIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Copies the entire List to a compatible one-dimensional array, starting at the specified index of the target array.",
"parameters": [
{
"name": "array",
"type": "T[]",
"summary": "The one-dimensional Array that is the destination of the elements copied from List. The Array must have zero-based indexing."
},
{
"name": "arrayIndex",
"type": "System.Int32",
"summary": "The zero-based index in array at which copying begins."
}
]
},
{
"signature": "System.Void CopyTo(T[] array)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Copies the entire List to a compatible one-dimensional array, starting at the beginning of the target array.",
"parameters": [
{
"name": "array",
"type": "T[]",
"summary": "The one-dimensional Array that is the destination of the elements copied from List. The Array must have zero-based indexing."
}
]
},
{
"signature": "RhinoList Duplicate()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns a shallow copy of this instance. If the generic type is comprised of only value types (struct, enum, ptr), then the result will be a deep copy.",
"returns": "The duplicated list."
},
{
"signature": "System.Boolean Exists(Predicate match)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines whether the List contains elements that match the conditions defined by the specified predicate.",
"parameters": [
{
"name": "match",
"type": "Predicate",
"summary": "The Predicate(T) delegate that defines the conditions of the elements to search for."
}
],
"returns": "True if the List contains one or more elements that match the conditions defined by the specified predicate; otherwise, false."
},
{
"signature": "T Find(Predicate match)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence within the entire List.",
"parameters": [
{
"name": "match",
"type": "Predicate",
"summary": "The Predicate(T) delegate that defines the conditions of the element to search for."
}
],
"returns": "The first element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T."
},
{
"signature": "RhinoList FindAll(Predicate match)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Retrieves all the elements that match the conditions defined by the specified predicate.",
"parameters": [
{
"name": "match",
"type": "Predicate",
"summary": "The Predicate(T) delegate that defines the conditions of the elements to search for."
}
],
"returns": "A ON_List(T) containing all the elements that match the conditions defined by the specified predicate, if found; otherwise, an empty ON_List(T)."
},
{
"signature": "System.Int32 FindIndex(Predicate match)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire List.",
"parameters": [
{
"name": "match",
"type": "Predicate",
"summary": "The Predicate(T) delegate that defines the conditions of the element to search for."
}
],
"returns": "The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, -1."
},
{
"signature": "System.Int32 FindIndex(System.Int32 startIndex, Predicate match)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the entire List.",
"parameters": [
{
"name": "startIndex",
"type": "System.Int32",
"summary": "The zero-based starting index of the search."
},
{
"name": "match",
"type": "Predicate",
"summary": "The Predicate(T) delegate that defines the conditions of the element to search for."
}
],
"returns": "The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, -1."
},
{
"signature": "System.Int32 FindIndex(System.Int32 startIndex, System.Int32 count, Predicate match)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the first occurrence within the range of elements in the List that extends from the specified index to the last element.",
"parameters": [
{
"name": "startIndex",
"type": "System.Int32",
"summary": "The zero-based starting index of the search."
},
{
"name": "count",
"type": "System.Int32",
"summary": "The number of elements in the section to search."
},
{
"name": "match",
"type": "Predicate",
"summary": "The Predicate(T) delegate that defines the conditions of the element to search for."
}
],
"returns": "The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, -1."
},
{
"signature": "T FindLast(Predicate match)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for an element that matches the conditions defined by the specified predicate, and returns the last occurrence within the entire List.",
"parameters": [
{
"name": "match",
"type": "Predicate",
"summary": "The Predicate(T) delegate that defines the conditions of the element to search for."
}
],
"returns": "The last element that matches the conditions defined by the specified predicate, if found; otherwise, the default value for type T."
},
{
"signature": "System.Int32 FindLastIndex(Predicate match)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List.",
"parameters": [
{
"name": "match",
"type": "Predicate",
"summary": "The Predicate(T) delegate that defines the conditions of the element to search for."
}
],
"returns": "The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, -1."
},
{
"signature": "System.Int32 FindLastIndex(System.Int32 startIndex, Predicate match)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List.",
"parameters": [
{
"name": "startIndex",
"type": "System.Int32",
"summary": "The zero-based starting index of the backward search."
},
{
"name": "match",
"type": "Predicate",
"summary": "The Predicate(T) delegate that defines the conditions of the element to search for."
}
],
"returns": "The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, -1."
},
{
"signature": "System.Int32 FindLastIndex(System.Int32 startIndex, System.Int32 count, Predicate match)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for an element that matches the conditions defined by the specified predicate, and returns the zero-based index of the last occurrence within the entire List.",
"parameters": [
{
"name": "startIndex",
"type": "System.Int32",
"summary": "The zero-based starting index of the backward search."
},
{
"name": "count",
"type": "System.Int32",
"summary": "The number of elements in the section to search."
},
{
"name": "match",
"type": "Predicate",
"summary": "The Predicate(T) delegate that defines the conditions of the element to search for."
}
],
"returns": "The zero-based index of the last occurrence of an element that matches the conditions defined by match, if found; otherwise, -1."
},
{
"signature": "System.Void ForEach(Action action)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Performs the specified action on each element of the List.",
"parameters": [
{
"name": "action",
"type": "Action",
"summary": "The Action(T) delegate to perform on each element of the List."
}
]
},
{
"signature": "IEnumerator GetEnumerator()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs an enumerator that is capable of iterating over all items in this list.",
"returns": "The new enumerator."
},
{
"signature": "RhinoList GetRange(System.Int32 index, System.Int32 count)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a shallow copy of a range of elements in the source List.",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based List index at which the range starts."
},
{
"name": "count",
"type": "System.Int32",
"summary": "The number of elements in the range."
}
],
"returns": "A shallow copy of a range of elements in the source List."
},
{
"signature": "System.Int32 IndexOf(T item, System.Int32 index, System.Int32 count)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List that starts at the specified index and contains the specified number of elements.",
"parameters": [
{
"name": "item",
"type": "T",
"summary": "The object to locate in the List. The value can be a None reference (Nothing in Visual Basic) for reference types."
},
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based starting index of the search."
},
{
"name": "count",
"type": "System.Int32",
"summary": "The number of elements in the section to search."
}
],
"returns": "The zero-based index of the first occurrence of item within the entire List, if found; otherwise, -1."
},
{
"signature": "System.Int32 IndexOf(T item, System.Int32 index)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for the specified object and returns the zero-based index of the first occurrence within the range of elements in the List that extends from the specified index to the last element.",
"parameters": [
{
"name": "item",
"type": "T",
"summary": "The object to locate in the List. The value can be a None reference (Nothing in Visual Basic) for reference types."
},
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based starting index of the search."
}
],
"returns": "The zero-based index of the first occurrence of item within the entire List, if found; otherwise, -1."
},
{
"signature": "System.Int32 IndexOf(T item)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for the specified object and returns the zero-based index of the first occurrence within the entire List.",
"parameters": [
{
"name": "item",
"type": "T",
"summary": "The object to locate in the List. The value can be a None reference (Nothing in Visual Basic) for reference types."
}
],
"returns": "The zero-based index of the first occurrence of item within the entire List, if found; otherwise, -1."
},
{
"signature": "System.Void Insert(System.Int32 index, T item)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Inserts an element into the List at the specified index.",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based index at which item should be inserted."
},
{
"name": "item",
"type": "T",
"summary": "The object to insert. The value can be a None reference (Nothing in Visual Basic) for reference types."
}
]
},
{
"signature": "System.Void InsertRange(System.Int32 index, IEnumerable collection)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Inserts the elements of a collection into the List at the specified index.",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based index at which the new elements should be inserted."
},
{
"name": "collection",
"type": "IEnumerable",
"summary": "The collection whose elements should be inserted into the List. The collection itself cannot be a None reference (Nothing in Visual Basic), but it can contain elements that are a None reference (Nothing in Visual Basic), if type T is a reference type."
}
]
},
{
"signature": "System.Int32 LastIndexOf(T item, System.Int32 index, System.Int32 count)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that contains the specified number of elements and ends at the specified index.",
"parameters": [
{
"name": "item",
"type": "T",
"summary": "The object to locate in the List. The value can be a None reference (Nothing in Visual Basic) for reference types."
},
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based starting index of the backward search."
},
{
"name": "count",
"type": "System.Int32",
"summary": "The number of elements in the section to search."
}
],
"returns": "The zero-based index of the last occurrence of item within the entire the List, if found; otherwise, -1."
},
{
"signature": "System.Int32 LastIndexOf(T item, System.Int32 index)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for the specified object and returns the zero-based index of the last occurrence within the range of elements in the List that extends from the first element to the specified index.",
"parameters": [
{
"name": "item",
"type": "T",
"summary": "The object to locate in the List. The value can be a None reference (Nothing in Visual Basic) for reference types."
},
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based starting index of the backward search."
}
],
"returns": "The zero-based index of the last occurrence of item within the entire the List, if found; otherwise, -1."
},
{
"signature": "System.Int32 LastIndexOf(T item)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Searches for the specified object and returns the zero-based index of the last occurrence within the entire List.",
"parameters": [
{
"name": "item",
"type": "T",
"summary": "The object to locate in the List. The value can be a None reference (Nothing in Visual Basic) for reference types."
}
],
"returns": "The zero-based index of the last occurrence of item within the entire the List, if found; otherwise, -1."
},
{
"signature": "System.Int32 RemapIndex(System.Int32 index)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remap an index in the infinite range onto the List index range.",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "Index to remap."
}
],
"returns": "Remapped index."
},
{
"signature": "System.Boolean Remove(T item)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes the first occurrence of a specific object from the List.",
"parameters": [
{
"name": "item",
"type": "T",
"summary": "The object to remove from the List. The value can be a None reference (Nothing in Visual Basic) for reference types."
}
],
"returns": "True if item is successfully removed; otherwise, false. This method also returns False if item was not found in the List."
},
{
"signature": "System.Int32 RemoveAll(Predicate match)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes the all the elements that match the conditions defined by the specified predicate.",
"parameters": [
{
"name": "match",
"type": "Predicate",
"summary": "The Predicate(T) delegate that defines the conditions of the elements to remove."
}
],
"returns": "The number of elements removed from the List."
},
{
"signature": "System.Void RemoveAt(System.Int32 index)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes the element at the specified index of the List.",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based index of the element to remove."
}
]
},
{
"signature": "System.Int32 RemoveNulls()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes all elements from the List that are None references (Nothing in Visual Basic). This function will not do anything if T is not a Reference type.",
"returns": "The number of nulls removed from the List."
},
{
"signature": "System.Void RemoveRange(System.Int32 index, System.Int32 count)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes a range of elements from the List.",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based starting index of the range of elements to remove."
},
{
"name": "count",
"type": "System.Int32",
"summary": "The number of elements to remove."
}
]
},
{
"signature": "System.Void Reverse()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Reverses the order of the elements in the entire List."
},
{
"signature": "System.Void Reverse(System.Int32 index, System.Int32 count)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Reverses the order of the elements in the specified range.",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based starting index of the range to reverse."
},
{
"name": "count",
"type": "System.Int32",
"summary": "The number of elements in the range to reverse."
}
]
},
{
"signature": "System.Void Sort()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sorts the elements in the entire List using the default comparer."
},
{
"signature": "System.Void Sort(Comparison comparison)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sorts the elements in the entire list using the specified comparer.",
"parameters": [
{
"name": "comparison",
"type": "Comparison",
"summary": "The System.Comparison(T) to use when comparing elements."
}
]
},
{
"signature": "System.Void Sort(IComparer comparer)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sorts the elements in the entire list using the specified System.Comparison(T)",
"parameters": [
{
"name": "comparer",
"type": "IComparer",
"summary": "The IComparer(T) implementation to use when comparing elements, or a None reference (Nothing in Visual Basic) to use the default comparer Comparer(T).Default."
}
]
},
{
"signature": "System.Void Sort(System.Double[] keys)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sort this list based on a list of numeric keys of equal length. The keys array will not be altered.",
"remarks": "This function does not exist on the DotNET List class. David thought it was a good idea.",
"parameters": [
{
"name": "keys",
"type": "System.Double[]",
"summary": "Numeric keys to sort with."
}
]
},
{
"signature": "System.Void Sort(System.Int32 index, System.Int32 count, IComparer comparer)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sorts the elements in a range of elements in list using the specified comparer.",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "The zero-based starting index of the range to sort."
},
{
"name": "count",
"type": "System.Int32",
"summary": "The length of the range to sort."
},
{
"name": "comparer",
"type": "IComparer",
"summary": "The IComparer(T) implementation to use when comparing elements, or a None reference (Nothing in Visual Basic) to use the default comparer Comparer(T).Default."
}
]
},
{
"signature": "System.Void Sort(System.Int32[] keys)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sort this list based on a list of numeric keys of equal length. The keys array will not be altered.",
"remarks": "This function does not exist on the DotNET List class. David thought it was a good idea.",
"parameters": [
{
"name": "keys",
"type": "System.Int32[]",
"summary": "Numeric keys to sort with."
}
]
},
{
"signature": "T[] ToArray()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs an array that contains all items in this list.",
"returns": "An array containing all items in this list."
},
{
"signature": "System.Void TrimExcess()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the capacity to the actual number of elements in the List, if that number is less than a threshold value.",
"remarks": "This function differs from the DotNET implementation of List since that one only trims the excess if the excess exceeds 10% of the list length."
},
{
"signature": "System.Boolean TrueForAll(Predicate match)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines whether every element in the List matches the conditions defined by the specified predicate.",
"parameters": [
{
"name": "match",
"type": "Predicate",
"summary": "The Predicate(T) delegate that defines the conditions to check against the elements."
}
],
"returns": "True if every element in the List matches the conditions defined by the specified predicate; otherwise, false. If the list has no elements, the return value is true."
}
]
},
{
"namespace": "Rhino.Collections",
"name": "TransformObjectList",
"dataType": "class",
"summary": "A collection of Rhino object, grip objects, and the Rhino objects that owns the grips. Used by the TransformCommand and GetTransform classes.",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "TransformObjectList()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
],
"properties": [
{
"signature": "int Count",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Number of elements in this list",
"since": "5.10",
"property": ["get"]
},
{
"signature": "bool DisplayFeedbackEnabled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int GripCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Number of elements in grip list",
"since": "6.0",
"property": ["get"]
},
{
"signature": "int GripOwnerCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Number of elements in grip owner list",
"since": "6.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Void Add(DocObjects.ObjRef objref)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Add an ObjRef to this list. Use this to add polyedges so the references are properly counted",
"since": "5.10"
},
{
"signature": "System.Void Add(DocObjects.RhinoObject rhinoObject)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Add a RhinoObject to this list",
"since": "5.10"
},
{
"signature": "System.Int32 AddObjects(GetObject go, System.Boolean allowGrips)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Add objects to list with a GetObject",
"since": "6.0",
"parameters": [
{
"name": "go",
"type": "GetObject",
"summary": "Setup the GetObject, i.e. prompt, geometry filter, allow pre/post select before passing it as an argument."
},
{
"name": "allowGrips",
"type": "System.Boolean",
"summary": "Specifically allow grips to be selected. if true, grips must also be included in geometry filter of the GetObject in order to be selected."
}
],
"returns": "Number of objects selected."
},
{
"signature": "System.Void Clear()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove all elements from this list",
"since": "5.10"
},
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true
},
{
"signature": "BoundingBox GetBoundingBox(System.Boolean regularObjects, System.Boolean grips)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the bounding box of all of the objects that this list contains.",
"since": "5.0",
"parameters": [
{
"name": "regularObjects",
"type": "System.Boolean",
"summary": "True if any object except grips should be included; otherwise false."
},
{
"name": "grips",
"type": "System.Boolean",
"summary": "True if grips should be included; otherwise false."
}
],
"returns": "Unset BoundingBox if this list is empty."
},
{
"signature": "GripObject[] GripArray()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets access to the internal GripObject array of the TransformObjectList object.",
"since": "6.0",
"returns": "An array of grip objects, or an empty array if there were no grip objects."
},
{
"signature": "RhinoObject[] GripOwnerArray()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets access to the internal GripOwner array of the TransformObjectList object.",
"since": "6.0",
"returns": "A n array of Rhino objects that are the owners of the grip objects the collection, or an empty array if there were no Rhino objects."
},
{
"signature": "RhinoObject[] ObjectArray()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets access to the internal RhinoObject array of the TransformObjectList object.",
"since": "7.0",
"returns": "An array of Rhino objects, or an empty array if there were no Rhino objects."
},
{
"signature": "System.Boolean UpdateDisplayFeedbackTransform(Transform xform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.Commands",
"name": "Command",
"dataType": "class",
"summary": "Defines a base class for all commands. This class is abstract.",
"constructors": [
{
"signature": "Command()",
"modifiers": ["protected"],
"protected": true,
"virtual": false,
"summary": "Default protected constructor. It only allows instantiation through sub-classing."
}
],
"properties": [
{
"signature": "Guid LastCommandId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the ID of the last commands.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Result LastCommandResult",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the result code of the last command.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string CommandContextHelpUrl",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Gets the URL of the command contextual help. This is usually a location of a local CHM file. \nThe default implementation return an empty string.",
"property": ["get"]
},
{
"signature": "string EnglishName",
"modifiers": ["public", "abstract"],
"protected": false,
"virtual": false,
"summary": "Gets the name of the command. This method is abstract.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool HistoryReplayOnObjectAttributeChange",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "By default, object attribute changes do not trigger history replay. Set this property to true, typically in the command's constructor, if you want objects created with this command to trigger history replay when their attributes change.",
"since": "8.34",
"property": ["get", "set"]
},
{
"signature": "Guid Id",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Gets the unique ID of this command. It is best to use a Guid attribute for each custom derived command class since this will keep the id consistent between sessions of Rhino System.Runtime.InteropServices.GuidAttribute",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string LocalName",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Gets the local name of the command.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "PlugIn PlugIn",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the plug-in where this commands is placed.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "PersistentSettings Settings",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the settings of the command.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Void DisplayHelp(System.Guid commandId)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Displays help for a command.",
"since": "5.0",
"parameters": [
{
"name": "commandId",
"type": "System.Guid",
"summary": "A command ID."
}
]
},
{
"signature": "System.String GetCommandContextHelpUrl(System.Guid commandId)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns a command's context help url.",
"since": "8.18",
"parameters": [
{
"name": "commandId",
"type": "System.Guid",
"summary": "A command ID."
}
],
"returns": "The command's context url if provided."
},
{
"signature": "System.String[] GetCommandNames(System.Boolean english, System.Boolean loaded)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets list of command names in Rhino. This list does not include Test, Alpha, or System commands.",
"since": "5.0",
"parameters": [
{
"name": "english",
"type": "System.Boolean",
"summary": "if true, retrieve the English name for every command. if false, retrieve the local name for every command."
},
{
"name": "loaded",
"type": "System.Boolean",
"summary": "if true, only get names of currently loaded commands. if false, get names of all registered (may not be currently loaded) commands."
}
],
"returns": "An array instance with command names. This array could be empty, but not null."
},
{
"signature": "System.Guid[] GetCommandStack()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Determines if Rhino is currently running a command. Because Rhino allow for transparent commands (commands that can be run from inside of other commands), this method returns the total ids of active commands.",
"since": "5.0",
"returns": "Ids of running commands or None if no commands are currently running. The \"active\" command is at the end of this list."
},
{
"signature": "Style GetCommandStyle(System.Guid commandId)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns a command's style flags.",
"since": "9.0",
"parameters": [
{
"name": "commandId",
"type": "System.Guid",
"summary": "A command ID."
}
],
"returns": "The command's style flags, or Style.None if the command is not found."
},
{
"signature": "MostRecentCommandDescription[] GetMostRecentCommands()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets an array of most recent command descriptions.",
"since": "5.0",
"returns": "An array of command descriptions."
},
{
"signature": "System.Boolean InCommand()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Determines if Rhino is currently running a command.",
"since": "5.0",
"returns": "True if a command is currently running, False if no commands are currently running."
},
{
"signature": "System.Boolean InScriptRunnerCommand()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "This is a low level tool to determine if Rhino is currently running a script running command like \"ReadCommandFile\" or the RhinoScript plug-in's \"RunScript\".",
"since": "5.0",
"returns": "True if a script running command is active."
},
{
"signature": "System.Boolean IsCommand(System.String name)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Determines is a string is a command.",
"since": "5.0",
"parameters": [
{
"name": "name",
"type": "System.String",
"summary": "A string."
}
],
"returns": "True if the string is a command."
},
{
"signature": "System.Boolean IsValidCommandName(System.String name)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Determines if a string is a valid command name.",
"since": "5.0",
"parameters": [
{
"name": "name",
"type": "System.String",
"summary": "A string."
}
],
"returns": "True if the string is a valid command name."
},
{
"signature": "System.Guid LookupCommandId(System.String name, System.Boolean searchForEnglishName)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns the ID of a command.",
"since": "5.0",
"parameters": [
{
"name": "name",
"type": "System.String",
"summary": "The name of the command."
},
{
"name": "searchForEnglishName",
"type": "System.Boolean",
"summary": "True if the name is to searched in English. This ensures that a '_' is prepended to the name."
}
],
"returns": "An of the command, or Guid.Empty on error."
},
{
"signature": "System.String LookupCommandName(System.Guid commandId, System.Boolean englishName)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns the command name given a command ID.",
"since": "5.0",
"parameters": [
{
"name": "commandId",
"type": "System.Guid",
"summary": "A command ID."
},
{
"name": "englishName",
"type": "System.Boolean",
"summary": "True if the requested command is in English."
}
],
"returns": "The command name, or None on error."
},
{
"signature": "System.Void RunProxyCommand(RunCommandDelegate commandCallback, RhinoDoc doc, System.Object data)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Execute some code as if it were running in a command",
"since": "6.13",
"parameters": [
{
"name": "commandCallback",
"type": "RunCommandDelegate",
"summary": ""
},
{
"name": "doc",
"type": "RhinoDoc",
"summary": ""
},
{
"name": "data",
"type": "System.Object",
"summary": "optional extra data to pass to callback"
}
]
},
{
"signature": "System.Void OnHelp()",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Is called when the user needs assistance with this command."
},
{
"signature": "System.Boolean ReplayHistory(Rhino.DocObjects.ReplayHistoryData replayData)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Repeats an operation of a command. \nIn order to make this function work, you will likely need to grab the Result property that gives the list of input objects. Then, you will be able to replace these inputs by using one of the UpdateToX() methods of the ReplayHistoryResult. \nYou should NOT use any document AddX() or ReplaceX() functions, as they will break history.",
"parameters": [
{
"name": "replayData",
"type": "Rhino.DocObjects.ReplayHistoryData",
"summary": "The replay history information."
}
],
"returns": "True if the operation succeeded. \nThe default implementation always returns false."
},
{
"signature": "Result RunCommand(RhinoDoc doc, RunMode mode)",
"modifiers": ["protected", "abstract"],
"protected": true,
"virtual": false,
"summary": "Executes the command.",
"parameters": [
{
"name": "doc",
"type": "RhinoDoc",
"summary": "The current document."
},
{
"name": "mode",
"type": "RunMode",
"summary": "The command running mode."
}
],
"returns": "The command result code."
}
],
"events": [
{
"signature": "EventHandler BeginCommand",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Called just before command.RunCommand().",
"since": "5.0"
},
{
"signature": "EventHandler EndCommand",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Called immediately after command.RunCommand().",
"since": "5.0"
},
{
"signature": "EventHandler UndoRedo",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Used to monitor Rhino's built in undo/redo support.",
"since": "5.0"
}
]
},
{
"namespace": "Rhino.Commands",
"name": "CommandEventArgs",
"dataType": "class",
"baseclass": "EventArgs",
"properties": [
{
"signature": "string CommandEnglishName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the English name of the command that raised this event.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string CommandHelpURL",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the help url of the command that raised this event.",
"since": "8.0",
"remarks": "Null is a possible return. Calling function must check before using result. m_help_url will get set only if the commmand has a ContextHelpURL override.",
"property": ["get"]
},
{
"signature": "Guid CommandId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the ID of the command that raised this event.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string CommandLocalName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the name of the command that raised this event in the local language.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string CommandPluginName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the name of the plug-in that this command belongs to. If the command is internal to Rhino, then this property is an empty string.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Result CommandResult",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the result of the command that raised this event. This value is only meaningful during EndCommand events.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "RhinoDoc Document",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "uint DocumentRuntimeSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.Commands",
"name": "CommandStyleAttribute",
"dataType": "class",
"summary": "Decorates Command to provide styles.",
"baseclass": "Attribute",
"constructors": [
{
"signature": "CommandStyleAttribute(Style styles)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new command style attribute class.",
"since": "5.0",
"parameters": [
{
"name": "styles",
"type": "Style",
"summary": "Set of values combined using a bitwise OR operation to get the desired combination of command styles."
}
]
}
],
"properties": [
{
"signature": "Style Styles",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the associated style.",
"since": "5.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.Commands",
"name": "CustomUndoEventArgs",
"dataType": "class",
"summary": "Argument package that is passed to a custom undo delegate",
"baseclass": "EventArgs",
"properties": [
{
"signature": "string ActionDescription",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid CommandId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool CreatedByRedo",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "RhinoDoc Document",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "object Tag",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "uint UndoSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.Commands",
"name": "MostRecentCommandDescription",
"dataType": "class",
"summary": "Stores the macro and display string of the most recent command.",
"constructors": [
{
"signature": "MostRecentCommandDescription()",
"summary": "Initializes a new instance of the MostRecentCommandDescription class"
}
],
"properties": [
{
"signature": "string DisplayString",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string Macro",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.Commands",
"name": "Result",
"dataType": "enum",
"summary": "Defines enumerated constant values for several command result types.",
"since": "5.0",
"values": [
{
"signature": "Success = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Command worked."
},
{
"signature": "Cancel = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "User canceled command."
},
{
"signature": "Nothing = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Command did nothing but cancel was not pressed."
},
{
"signature": "Failure",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Command failed (bad input, computational problem, etc.)"
},
{
"signature": "UnknownCommand",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Command not found (user probably had a typo in command name)."
},
{
"signature": "CancelModelessDialog",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Commands canceled and modeless dialog."
},
{
"signature": "ExitRhino = 0x0FFFFFFF",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "exit RhinoCommon."
}
]
},
{
"namespace": "Rhino.Commands",
"name": "RunMode",
"dataType": "enum",
"summary": "Provides enumerated constants for a command running mode. This is currently interactive or scripted.",
"since": "5.0",
"values": [
{
"signature": "Interactive = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Can use dialogs for input. Must use message boxes to report serious error conditions."
},
{
"signature": "Scripted = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "All input must come from command line, GetPoint, GetObject, GetString, etc. Must use message boxes to report serious error conditions. Script mode gets used when a command is run with a hyphen (-) prefix."
}
]
},
{
"namespace": "Rhino.Commands",
"name": "SelCommand",
"dataType": "class",
"summary": "For adding nestable whole object and subobject selection commands, derive your command from SelCommand and override the abstract SelFilter and virtual SelSubObjectFilter functions.",
"baseclass": "Rhino.Commands.Command",
"constructors": [
{
"signature": "SelCommand()",
"summary": "Initializes a new instance of the SelCommand class"
}
],
"properties": [
{
"signature": "bool BeQuiet",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool TestGrips",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool TestLights",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "Result RunCommand(RhinoDoc doc, RunMode mode)",
"modifiers": ["protected", "override"],
"protected": true,
"virtual": false
},
{
"signature": "System.Boolean SelFilter(Rhino.DocObjects.RhinoObject rhObj)",
"modifiers": ["protected", "abstract"],
"protected": true,
"virtual": false,
"summary": "Override this abstract function and return True if object should be selected.",
"parameters": [
{
"name": "rhObj",
"type": "Rhino.DocObjects.RhinoObject",
"summary": "The object to check regarding selection status."
}
],
"returns": "True if the object should be selected; False otherwise."
},
{
"signature": "System.Boolean SelSubObjectFilter(Rhino.DocObjects.RhinoObject rhObj, List indicesToSelect)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "To select subobjects, override this virtual function, add component indices of the subobjects that should get selected to indicesToSelect list and return true. This is called only if the SelFilter returns False and the whole object does not get selected.",
"since": "7.9",
"parameters": [
{
"name": "rhObj",
"type": "Rhino.DocObjects.RhinoObject",
"summary": "The object to check regarding selection status."
},
{
"name": "indicesToSelect",
"type": "List",
"summary": "The component indices of the subobjects to select."
}
],
"returns": "True if components added to indicesToSelect should get selected."
}
]
},
{
"namespace": "Rhino.Commands",
"name": "Style",
"dataType": "enum",
"summary": "Defines bitwise mask flags for different styles of commands, such as Style.Hidden or Style.DoNotRepeat .",
"since": "5.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No flag is defined."
},
{
"signature": "Hidden = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Also known as a \"test\" command. The command name does not auto-complete when typed on the command line an is therefore not discoverable. Useful for writing commands that users don't normally have access to."
},
{
"signature": "ScriptRunner = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "For commands that want to run scripts as if they were typed at the command line (like RhinoScript's RunScript command)"
},
{
"signature": "Transparent = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Transparent commands can be run inside of other commands. The command does not modify the contents of the model's geometry in any way. Examples of transparent commands include commands that change views and toggle snap states. Any command that adds or deletes, a view cannot be transparent."
},
{
"signature": "DoNotRepeat = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The command should not be repeated by pressing \"ENTER\" immediately after the command finishes."
},
{
"signature": "NotUndoable = 16",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "By default, all commands are undo-able."
},
{
"signature": "System = 32",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "reserved"
}
]
},
{
"namespace": "Rhino.Commands",
"name": "TransformCommand",
"dataType": "class",
"baseclass": "Rhino.Commands.Command",
"constructors": [
{
"signature": "TransformCommand()",
"summary": "Initializes a new instance of the TransformCommand class"
}
],
"methods": [
{
"signature": "System.Void DuplicateObjects(Rhino.Collections.TransformObjectList list)",
"modifiers": ["protected"],
"protected": true,
"virtual": false
},
{
"signature": "System.Void ResetGrips(Rhino.Collections.TransformObjectList list)",
"modifiers": ["protected"],
"protected": true,
"virtual": false,
"summary": "Sets dynamic grip locations back to starting grip locations. This makes things like the Copy command work when grips are \"copied\".",
"parameters": [
{
"name": "list",
"type": "Rhino.Collections.TransformObjectList",
"summary": "A list of object to transform. This is a special list type."
}
]
},
{
"signature": "Result SelectObjects(System.String prompt, DocObjects.ObjectType filter, Rhino.Collections.TransformObjectList list)",
"modifiers": ["protected"],
"protected": true,
"virtual": false,
"summary": "Selects objects within the command.",
"parameters": [
{
"name": "prompt",
"type": "System.String",
"summary": "The selection prompt."
},
{
"name": "filter",
"type": "DocObjects.ObjectType",
"summary": "Geometry filter to limit selection. Use function above if you do not need specific types."
},
{
"name": "list",
"type": "Rhino.Collections.TransformObjectList",
"summary": "A list of objects to transform. This is a special list type."
}
],
"returns": "The operation result."
},
{
"signature": "Result SelectObjects(System.String prompt, Rhino.Collections.TransformObjectList list)",
"modifiers": ["protected"],
"protected": true,
"virtual": false,
"summary": "Selects objects within the command.",
"parameters": [
{
"name": "prompt",
"type": "System.String",
"summary": "The selection prompt."
},
{
"name": "list",
"type": "Rhino.Collections.TransformObjectList",
"summary": "A list of objects to transform. This is a special list type."
}
],
"returns": "The operation result."
},
{
"signature": "System.Void TransformObjects(Rhino.Collections.TransformObjectList list, Rhino.Geometry.Transform xform, System.Boolean copy, System.Boolean autoHistory)",
"modifiers": ["protected"],
"protected": true,
"virtual": false
}
]
},
{
"namespace": "Rhino.Commands",
"name": "UndoRedoEventArgs",
"dataType": "class",
"summary": "Undo Redo Event Arguments",
"baseclass": "EventArgs",
"since": "5.0",
"properties": [
{
"signature": "Guid CommandId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The id of the Rhino command. This can be Guid.Empty.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "uint DocumentSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The document runtime serial number.",
"since": "9.0",
"property": ["get"]
},
{
"signature": "bool IsBeforeBeginRecording",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get"]
},
{
"signature": "bool IsBeforeEndRecording",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get"]
},
{
"signature": "bool IsBeginRecording",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsBeginRedo",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsBeginUndo",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsEndRecording",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsEndRedo",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsEndUndo",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsPurgeRecord",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "uint UndoSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The undo record serial number.",
"since": "5.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "BackgroundStyle",
"dataType": "enum",
"summary": "Constants that define how the background of a viewport should be filled.",
"since": "5.0",
"values": [
{
"signature": "SolidColor = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Single solid color fill."
},
{
"signature": "WallpaperImage = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Simple image background wallpaper."
},
{
"signature": "Gradient = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Two color top/bottom color gradient."
},
{
"signature": "Environment = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Using a Render Environment."
}
]
},
{
"namespace": "Rhino.Display",
"name": "BlendMode",
"dataType": "enum",
"summary": "Defines enumerated constants for display blend modes.",
"since": "5.0",
"values": [
{
"signature": "Zero = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Blends using 0."
},
{
"signature": "One = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Blends using 1."
},
{
"signature": "SourceColor = 0x0300",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Blends using source color."
},
{
"signature": "OneMinusSourceColor = 0x0301",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Blends using 1-source color."
},
{
"signature": "SourceAlpha = 0x0302",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Blends using the source alpha channel."
},
{
"signature": "OneMinusSourceAlpha = 0x0303",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Blends using 1-the source alpha channel."
},
{
"signature": "DestinationAlpha = 0x0304",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Blends using the destination alpha channel."
},
{
"signature": "OneMinusDestinationAlpha = 0x0305",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Blends using 1-the destination alpha channel."
},
{
"signature": "DestinationColor = 0x0306",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Blends using the destination color."
},
{
"signature": "OneMinusDestinationColor = 0x0307",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Blends using 1-the destination color."
},
{
"signature": "SourceAlphaSaturate = 0x0308",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Blends using the source alpha saturation."
}
]
},
{
"namespace": "Rhino.Display",
"name": "CalculateBoundingBoxEventArgs",
"dataType": "class",
"baseclass": "Rhino.Display.DrawEventArgs",
"properties": [
{
"signature": "BoundingBox BoundingBox",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the current bounding box.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Void IncludeBoundingBox(BoundingBox box)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Unites a bounding box with the current display bounding box in order to ensure dynamic objects in \"box\" are drawn.",
"since": "5.0",
"parameters": [
{
"name": "box",
"type": "BoundingBox",
"summary": "The box to unite."
}
]
}
]
},
{
"namespace": "Rhino.Display",
"name": "Color4f",
"dataType": "struct",
"summary": "Color defined by 4 floating point values.",
"constructors": [
{
"signature": "Color4f(Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Color4f(Color4f color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Color4f(float red, float green, float blue, float alpha)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Color4f(int argb)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0"
}
],
"properties": [
{
"signature": "Color4f Black",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "Color4f Empty",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "Color4f White",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "float A",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "float B",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "float G",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "float L",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.3",
"property": ["get"]
},
{
"signature": "float R",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "Color4f ApplyGamma(Color4f col, System.Single gamma)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "Color4f FromArgb(System.Single a, Color4f color)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.11"
},
{
"signature": "Color4f FromArgb(System.Single a, System.Single r, System.Single g, System.Single b)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.11"
},
{
"signature": "System.Drawing.Color AsSystemColor()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Color4f BlendTo(System.Single t, Color4f col)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean Equals(System.Object obj)",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false
},
{
"signature": "System.Int32 GetHashCode()",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false
}
],
"operators": [
{
"signature": "bool operator !=(Color4f a, Color4f b)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "bool operator ==(Color4f a, Color4f b)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "ColorCMYK",
"dataType": "struct",
"summary": "Represents a CMYK (Cyan, Magenta, Yellow, Key) color with double precision floating point channels. CMYK colors are used primarily in printing environments as they provide a good simulation of physical ink.",
"constructors": [
{
"signature": "ColorCMYK(Color rgb)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new instance of ColorCMYK that is equivalent to an ARGB color.",
"since": "5.0",
"remarks": "Exact conversions between color spaces are often not possible.",
"parameters": [
{
"name": "rgb",
"type": "System.Drawing.Color",
"summary": "ARGB color to mimic."
}
]
},
{
"signature": "ColorCMYK(double alpha, double cyan, double magenta, double yellow, double key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new instance of ColorCMYK with custom channel values.",
"since": "5.0",
"parameters": [
{
"name": "alpha",
"type": "System.Double",
"summary": "Alpha channel value. Alpha channels are limited to the 0.0 and 1.0 range."
},
{
"name": "cyan",
"type": "System.Double",
"summary": "Cyan channel value. Cyan channels are limited to the 0.0 and 1.0 range."
},
{
"name": "magenta",
"type": "System.Double",
"summary": "Magenta channel value. Magenta channels are limited to the 0.0 and 1.0 range."
},
{
"name": "yellow",
"type": "System.Double",
"summary": "Yellow channel value. Yellow channels are limited to the 0.0 and 1.0 range."
},
{
"name": "key",
"type": "System.Double",
"summary": "Key channel value. Key channels are limited to the 0.0 and 1.0 range."
}
]
},
{
"signature": "ColorCMYK(double cyan, double magenta, double yellow, double key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new instance of ColorCMYK with custom channel values.",
"since": "5.0",
"parameters": [
{
"name": "cyan",
"type": "System.Double",
"summary": "Cyan channel value. Cyan channels are limited to the 0.0 and 1.0 range."
},
{
"name": "magenta",
"type": "System.Double",
"summary": "Magenta channel value. Magenta channels are limited to the 0.0 and 1.0 range."
},
{
"name": "yellow",
"type": "System.Double",
"summary": "Yellow channel value. Yellow channels are limited to the 0.0 and 1.0 range."
},
{
"name": "key",
"type": "System.Double",
"summary": "Key channel value. Key channels are limited to the 0.0 and 1.0 range."
}
]
},
{
"signature": "ColorCMYK(double cyan, double magenta, double yellow)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new instance of ColorCMYK with custom channel values. The cyan, magenta and yellow values will be adjusted based on their combined darkness.",
"since": "5.0",
"parameters": [
{
"name": "cyan",
"type": "System.Double",
"summary": "Cyan channel hint."
},
{
"name": "magenta",
"type": "System.Double",
"summary": "Magenta channel hint."
},
{
"name": "yellow",
"type": "System.Double",
"summary": "Yellow channel hint."
}
]
}
],
"properties": [
{
"signature": "double A",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Alpha channel value. Alpha channels are limited to the 0~1 range.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double C",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Cyan channel value. Cyan channels are limited to the 0~1 range.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double K",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Key channel value. Key channels are limited to the 0~1 range.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double M",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Magenta channel value. Magenta channels are limited to the 0~1 range.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double Y",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Yellow channel value. Yellow channels are limited to the 0~1 range.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ColorCMYK CreateFromHSL(ColorHSL hsl)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs the nearest CMYK equivalent of an HSL color.",
"since": "5.0",
"parameters": [
{
"name": "hsl",
"type": "ColorHSL",
"summary": "Target color in HSL space."
}
],
"returns": "The CMYK equivalent of the HSL color."
},
{
"signature": "ColorCMYK CreateFromHSV(ColorHSV hsv)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs the nearest CMYK equivalent of an HSV color.",
"since": "6.0",
"parameters": [
{
"name": "hsv",
"type": "ColorHSV",
"summary": "Target color in HSV space."
}
],
"returns": "The CMYK equivalent of the HSV color."
},
{
"signature": "ColorCMYK CreateFromLAB(ColorLAB lab)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs the nearest CMYK equivalent of a LAB color.",
"since": "5.0",
"parameters": [
{
"name": "lab",
"type": "ColorLAB",
"summary": "Target color in LAB space."
}
],
"returns": "The CMYK equivalent of the LAB color."
},
{
"signature": "ColorCMYK CreateFromLCH(ColorLCH lch)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs the nearest CMYK equivalent of a LCH color.",
"since": "5.0",
"parameters": [
{
"name": "lch",
"type": "ColorLCH",
"summary": "Target color in LCH space."
}
],
"returns": "The CMYK equivalent of the LCH color."
},
{
"signature": "ColorCMYK CreateFromRGBA(ColorRGBA rgba)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest CMYK equivalent of a RGBA color.",
"since": "7.0",
"parameters": [
{
"name": "rgba",
"type": "ColorRGBA",
"summary": "Target color in RGBA space."
}
],
"returns": "The CMYK equivalent of the RGBA color."
},
{
"signature": "ColorCMYK CreateFromXYZ(ColorXYZ xyz)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs the nearest CMYK equivalent of an XYZ color.",
"since": "5.0",
"parameters": [
{
"name": "xyz",
"type": "ColorXYZ",
"summary": "Target color in XYZ space."
}
],
"returns": "The CMYK equivalent of the XYZ color."
}
]
},
{
"namespace": "Rhino.Display",
"name": "ColorGradient",
"dataType": "class",
"constructors": [
{
"signature": "ColorGradient()",
"summary": "Initializes a new instance of the ColorGradient class"
}
],
"properties": [
{
"signature": "Point3d EndPoint",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "End point of gradient",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "GradientType GradientType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gradient fill type associated with this hatch",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double Repeat",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Repeat factor for gradient. Factors greater than 1 define a reflected repeat factor while values less than -1 define a wrapped repeat factor.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Point3d StartPoint",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Start point of gradient",
"since": "7.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ColorGradient Duplicate()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Create a duplicate of this color gradient.",
"since": "8.8",
"returns": "An exact duplicate of this color gradient."
},
{
"signature": "ColorStop[] GetColorStops()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get sorted list of colors / positions that a gradient is defined over",
"since": "7.0"
},
{
"signature": "System.Void SetColorStops(IEnumerable stops)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set color stops for the gradient",
"since": "7.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "ColorHSL",
"dataType": "struct",
"summary": "Represents an HSL (Hue, Saturation, Luminance) color with double precision floating point channels. HSL colors are used primarily in Graphical User Interface environments as they provide a very natural approach to picking colors.",
"constructors": [
{
"signature": "ColorHSL(Color rgb)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorHSL that is equivalent to an ARGB color.",
"since": "5.0",
"remarks": "Exact conversions between color spaces are often not possible.",
"parameters": [
{
"name": "rgb",
"type": "System.Drawing.Color",
"summary": "ARGB color to mimic."
}
]
},
{
"signature": "ColorHSL(double alpha, double hue, double saturation, double luminance)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorHSL with custom channel values.",
"since": "5.0",
"parameters": [
{
"name": "alpha",
"type": "System.Double",
"summary": "Alpha channel value. Channel will be limited to 0~1."
},
{
"name": "hue",
"type": "System.Double",
"summary": "Hue channel value. Hue channels rotate between 0.0 and 1.0."
},
{
"name": "saturation",
"type": "System.Double",
"summary": "Saturation channel value. Channel will be limited to 0~1."
},
{
"name": "luminance",
"type": "System.Double",
"summary": "Luminance channel value. Channel will be limited to 0~1."
}
]
},
{
"signature": "ColorHSL(double hue, double saturation, double luminance)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorHSL with custom channel values.",
"since": "5.0",
"parameters": [
{
"name": "hue",
"type": "System.Double",
"summary": "Hue channel value. Hue channels rotate between 0.0 and 1.0."
},
{
"name": "saturation",
"type": "System.Double",
"summary": "Saturation channel value. Channel will be limited to 0~1."
},
{
"name": "luminance",
"type": "System.Double",
"summary": "Luminance channel value. Channel will be limited to 0~1."
}
]
}
],
"properties": [
{
"signature": "double A",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the alpha channel value. Alpha channels are limited to a 0~1 range.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double H",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the hue channel value. Hue channels rotate between 0.0 and 1.0.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double L",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the luminance channel value. Luminance channels are limited to a 0~1 range.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double S",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the saturation channel value. Saturation channels are limited to a 0~1 range.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ColorHSL CreateFromCMYK(ColorCMYK cmyk)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest HSL equivalent of a CMYK color.",
"since": "5.0",
"parameters": [
{
"name": "cmyk",
"type": "ColorCMYK",
"summary": "Target color in CMYK space."
}
],
"returns": "The HSL equivalent of the CMYK color."
},
{
"signature": "ColorHSL CreateFromHSV(ColorHSV hsv)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs the nearest HSL equivalent of an HSV color.",
"since": "6.0",
"parameters": [
{
"name": "hsv",
"type": "ColorHSV",
"summary": "Target color in HSV space."
}
],
"returns": "The HSL equivalent of the HSV color."
},
{
"signature": "ColorHSL CreateFromLAB(ColorLAB lab)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest HSL equivalent of a LAB color.",
"since": "5.0",
"parameters": [
{
"name": "lab",
"type": "ColorLAB",
"summary": "Target color in LAB space."
}
],
"returns": "The HSL equivalent of the LAB color."
},
{
"signature": "ColorHSL CreateFromLCH(ColorLCH lch)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest HSL equivalent of a LCH color.",
"since": "5.0",
"parameters": [
{
"name": "lch",
"type": "ColorLCH",
"summary": "Target color in LCH space."
}
],
"returns": "The HSL equivalent of the LCH color."
},
{
"signature": "ColorHSL CreateFromRGBA(ColorRGBA rgba)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest HSL equivalent of a RGBA color.",
"since": "7.0",
"parameters": [
{
"name": "rgba",
"type": "ColorRGBA",
"summary": "Target color in RGBA space."
}
],
"returns": "The HSL equivalent of the RGBA color."
},
{
"signature": "ColorHSL CreateFromXYZ(ColorXYZ xyz)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest HSL equivalent of an XYZ color.",
"since": "5.0",
"parameters": [
{
"name": "xyz",
"type": "ColorXYZ",
"summary": "Target color in XYZ space."
}
],
"returns": "The HSL equivalent of the XYZ color."
},
{
"signature": "System.Drawing.Color ToArgbColor()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Convert HSL color to an equivalent System.Drawing.Color.",
"since": "5.0",
"returns": "A .Net framework library color value."
}
]
},
{
"namespace": "Rhino.Display",
"name": "ColorHSV",
"dataType": "struct",
"summary": "Represents an HSV (Hue, Saturation, Value) color with double precision floating point channels. HSV colors (also sometimes called HSB, where B means Brightness) are similar to HSL colors in that they represent colors in a cylindrical color space, and are intended to provide intuitive means to edit the brightness of a particular color over RGB color space where each color channel would need to be modified to affect the color brightness.",
"constructors": [
{
"signature": "ColorHSV(Color rgb)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorHSV that is equivalent to an ARGB color.",
"since": "6.0",
"remarks": "Exact conversions between color spaces are often not possible.",
"parameters": [
{
"name": "rgb",
"type": "System.Drawing.Color",
"summary": "ARGB color to mimic."
}
]
},
{
"signature": "ColorHSV(double alpha, double hue, double saturation, double value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorHSV with custom channel values.",
"since": "6.0",
"parameters": [
{
"name": "alpha",
"type": "System.Double",
"summary": "Alpha channel value. Channel will be limited to 0~1."
},
{
"name": "hue",
"type": "System.Double",
"summary": "Hue channel value. Hue channels rotate between 0.0 and 1.0."
},
{
"name": "saturation",
"type": "System.Double",
"summary": "Saturation channel value. Channel will be limited to 0~1."
},
{
"name": "value",
"type": "System.Double",
"summary": "Value (Brightness) channel value. Channel will be limited to 0~1."
}
]
},
{
"signature": "ColorHSV(double hue, double saturation, double value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorHSV with custom channel values.",
"since": "6.0",
"parameters": [
{
"name": "hue",
"type": "System.Double",
"summary": "Hue channel value. Hue channels rotate between 0.0 and 1.0."
},
{
"name": "saturation",
"type": "System.Double",
"summary": "Saturation channel value. Channel will be limited to 0~1."
},
{
"name": "value",
"type": "System.Double",
"summary": "Value (Brightness) channel value. Channel will be limited to 0~1."
}
]
}
],
"properties": [
{
"signature": "double A",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the alpha channel value. Alpha channels are limited to a 0~1 range.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double H",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the hue channel value. Hue channels rotate between 0.0 and 1.0.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double S",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the saturation channel value. Saturation channels are limited to a 0~1 range.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double V",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the value (brightness) channel value. Value channels are limited to a 0~1 range.",
"since": "6.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ColorHSV CreateFromCMYK(ColorCMYK cmyk)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest HSV equivalent of a CMYK color.",
"since": "6.0",
"parameters": [
{
"name": "cmyk",
"type": "ColorCMYK",
"summary": "Target color in CMYK space."
}
],
"returns": "The HSV equivalent of the CMYK color."
},
{
"signature": "ColorHSV CreateFromHSL(ColorHSL hsl)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs the nearest HSV equivalent of an HSL color.",
"since": "6.0",
"parameters": [
{
"name": "hsl",
"type": "ColorHSL",
"summary": "Target color in HSL space."
}
],
"returns": "The HSV equivalent of the HSL color."
},
{
"signature": "ColorHSV CreateFromLAB(ColorLAB lab)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest HSV equivalent of a LAB color.",
"since": "6.0",
"parameters": [
{
"name": "lab",
"type": "ColorLAB",
"summary": "Target color in LAB space."
}
],
"returns": "The HSV equivalent of the LAB color."
},
{
"signature": "ColorHSV CreateFromLCH(ColorLCH lch)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest HSV equivalent of a LCH color.",
"since": "6.0",
"parameters": [
{
"name": "lch",
"type": "ColorLCH",
"summary": "Target color in LCH space."
}
],
"returns": "The HSV equivalent of the LCH color."
},
{
"signature": "ColorHSV CreateFromRGBA(ColorRGBA rgba)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest HSV equivalent of a RGBA color.",
"since": "7.0",
"parameters": [
{
"name": "rgba",
"type": "ColorRGBA",
"summary": "Target color in RGBA space."
}
],
"returns": "The HSV equivalent of the RGBA color."
},
{
"signature": "ColorHSV CreateFromXYZ(ColorXYZ xyz)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest HSV equivalent of an XYZ color.",
"since": "6.0",
"parameters": [
{
"name": "xyz",
"type": "ColorXYZ",
"summary": "Target color in XYZ space."
}
],
"returns": "The HSV equivalent of the XYZ color."
},
{
"signature": "System.Drawing.Color ToArgbColor()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Convert HSV color to an equivalent System.Drawing.Color.",
"since": "6.0",
"returns": "A .Net framework library color value."
}
]
},
{
"namespace": "Rhino.Display",
"name": "ColorLAB",
"dataType": "struct",
"summary": "Represents a LAB (Lightness, A, B) color with double precision floating point channels. LAB colors are based on nonlinearly compressed CIE XYZ color space coordinates. The A and B parameters of a LAB color represent the opponents.",
"constructors": [
{
"signature": "ColorLAB(Color rgb)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorLAB that is equivalent to an ARGB color.",
"since": "5.0",
"remarks": "Exact conversions between color spaces are often not possible.",
"parameters": [
{
"name": "rgb",
"type": "System.Drawing.Color",
"summary": "ARGB color to mimic."
}
]
},
{
"signature": "ColorLAB(double alpha, double lightness, double a, double b)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorLAB with custom channel values.",
"since": "5.0"
},
{
"signature": "ColorLAB(double lightness, double a, double b)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorLAB with custom channel values.",
"since": "5.0"
}
],
"properties": [
{
"signature": "double A",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Base channel. The channel is limited to -1~+1.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double Alpha",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Alpha channel. The channel is limited to 0~1.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double B",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Opponent channel. The channel is limited to -1~+1.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double L",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the lightness channel. The channel is limited to 0~1.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ColorLAB CreateFromCMYK(ColorCMYK cmyk)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest LAB equivalent of a CMYK color.",
"since": "5.0",
"parameters": [
{
"name": "cmyk",
"type": "ColorCMYK",
"summary": "Target color in CMYK space."
}
],
"returns": "The LAB equivalent of the CMYK color."
},
{
"signature": "ColorLAB CreateFromHSL(ColorHSL hsl)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest LAB equivalent of an HSL color.",
"since": "5.0",
"parameters": [
{
"name": "hsl",
"type": "ColorHSL",
"summary": "Target color in HSL space."
}
],
"returns": "The LAB equivalent of the HSL color."
},
{
"signature": "ColorLAB CreateFromHSV(ColorHSV hsv)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs the nearest LAB equivalent of an HSV color.",
"since": "6.0",
"parameters": [
{
"name": "hsv",
"type": "ColorHSV",
"summary": "Target color in HSV space."
}
],
"returns": "The LAB equivalent of the HSV color."
},
{
"signature": "ColorLAB CreateFromLCH(ColorLCH lch)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest LAB equivalent of an LCH color.",
"since": "5.0",
"parameters": [
{
"name": "lch",
"type": "ColorLCH",
"summary": "Target color in LCH space."
}
],
"returns": "The LAB equivalent of the LCH color."
},
{
"signature": "ColorLAB CreateFromRGBA(ColorRGBA rgb)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest LAB equivalent of an RGBA color.",
"since": "7.1",
"parameters": [
{
"name": "rgb",
"type": "ColorRGBA",
"summary": "Target color in RGBA space."
}
],
"returns": "The LAB equivalent of the RGBA color."
},
{
"signature": "ColorLAB CreateFromXYZ(ColorXYZ xyz)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest LAB equivalent of an XYZ color.",
"since": "5.0",
"parameters": [
{
"name": "xyz",
"type": "ColorXYZ",
"summary": "Target color in XYZ space."
}
],
"returns": "The LAB equivalent of the XYZ color."
}
]
},
{
"namespace": "Rhino.Display",
"name": "ColorLCH",
"dataType": "struct",
"summary": "Represents an LCH (Lightness, A, B) color with double precision floating point channels. LCH colors (also sometimes called CIELUV) are transformation of the 1931 CIE XYZ color space, in order to approach perceptual uniformity. They are primarily used in computer graphics which deal with colored lights.",
"constructors": [
{
"signature": "ColorLCH(Color rgb)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorLCH that is equivalent to an ARGB color.",
"since": "5.0",
"remarks": "Exact conversions between color spaces are often not possible.",
"parameters": [
{
"name": "rgb",
"type": "System.Drawing.Color",
"summary": "ARGB color to mimic."
}
]
},
{
"signature": "ColorLCH(double alpha, double lightness, double chroma, double hue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorLCH with custom channel values.",
"since": "5.0",
"parameters": [
{
"name": "alpha",
"type": "System.Double",
"summary": "Value of Alpha channel. This channel is limited to 0~1."
},
{
"name": "lightness",
"type": "System.Double",
"summary": "Value of Lightness channel. This channel is limited to 0~1."
},
{
"name": "chroma",
"type": "System.Double",
"summary": "Value of Chroma channel. This channel is limited to -1~1."
},
{
"name": "hue",
"type": "System.Double",
"summary": "Value of Hue channel. This channel is limited to 0~360."
}
]
},
{
"signature": "ColorLCH(double lightness, double chroma, double hue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorLCH with custom channel values.",
"since": "5.0",
"parameters": [
{
"name": "lightness",
"type": "System.Double",
"summary": "Value of lightness channel. This channel is limited to 0~1."
},
{
"name": "chroma",
"type": "System.Double",
"summary": "Value of chroma channel. This channel is limited to -1~1."
},
{
"name": "hue",
"type": "System.Double",
"summary": "Value of chroma channel. This channel is limited to 0~360."
}
]
}
],
"properties": [
{
"signature": "double A",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Alpha channel. The Alpha channel is limited to the 0~1 range.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double C",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Chroma channel. Chroma is defined from -1.0 to +1.0.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double H",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Hue channel. The hue channel is limited to the 0~360 degree range.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double L",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Lightness channel.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ColorLCH CreateFromCMYK(ColorCMYK cmyk)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest LCH equivalent of a CMYK color.",
"since": "5.0",
"parameters": [
{
"name": "cmyk",
"type": "ColorCMYK",
"summary": "Target color in CMYK space."
}
],
"returns": "The LCH equivalent of the CMYK color."
},
{
"signature": "ColorLCH CreateFromHSL(ColorHSL hsl)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest LCH equivalent of an HSL color.",
"since": "5.0",
"parameters": [
{
"name": "hsl",
"type": "ColorHSL",
"summary": "Target color in HSL space."
}
],
"returns": "The LCH equivalent of the HSL color."
},
{
"signature": "ColorLCH CreateFromLAB(ColorLAB lab)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest LCH equivalent of a LAB color.",
"since": "5.0",
"parameters": [
{
"name": "lab",
"type": "ColorLAB",
"summary": "Target color in LAB space."
}
],
"returns": "The LCH equivalent of the LAB color."
},
{
"signature": "ColorLCH CreateFromRGBA(ColorRGBA rgb)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest LCH equivalent of an RGBA color.",
"since": "7.1",
"parameters": [
{
"name": "rgb",
"type": "ColorRGBA",
"summary": "Target color in RGBA space."
}
],
"returns": "The LCH equivalent of the RGBA color."
},
{
"signature": "ColorLCH CreateFromXYZ(ColorXYZ xyz)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest LCH equivalent of an XYZ color.",
"since": "5.0",
"parameters": [
{
"name": "xyz",
"type": "ColorXYZ",
"summary": "Target color in XYZ space."
}
],
"returns": "The LCH equivalent of the XYZ color."
},
{
"signature": "System.Void MakePositive()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Ensure the Chromaticity of this color is positive.",
"since": "5.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "ColorRGBA",
"dataType": "struct",
"summary": "Represents a sRGBA (Red, Green, Blue, Alpha) color with double precision floating point channel.",
"constructors": [
{
"signature": "ColorRGBA(Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorRGBA that is equivalent to an ARGB color.",
"since": "7.0",
"parameters": [
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "ARGB color to mimic."
}
]
},
{
"signature": "ColorRGBA(ColorRGBA color, double alpha)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "ColorRGBA(ColorRGBA color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "ColorRGBA(double red, double green, double blue, double alpha)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "ColorRGBA(double red, double green, double blue)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "ColorRGBA(int argb)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorRGBA that is equivalent to an ARGB color.",
"since": "7.0",
"parameters": [
{
"name": "argb",
"type": "System.Int32",
"summary": "ARGB color to mimic."
}
]
}
],
"properties": [
{
"signature": "ColorRGBA Black",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get"]
},
{
"signature": "ColorRGBA Blue",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get"]
},
{
"signature": "ColorRGBA Green",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get"]
},
{
"signature": "ColorRGBA Red",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get"]
},
{
"signature": "ColorRGBA White",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get"]
},
{
"signature": "double A",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the alpha channel value. Alpha channels are limited to a 0~1 range.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double B",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the blue channel value. Blue channels are limited to a 0~1 range.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double G",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the green channel value. Green channels are limited to a 0~1 range.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double R",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the red channel value. Red channels are limited to a 0~1 range.",
"since": "7.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ColorRGBA ApplyGamma(ColorRGBA col, System.Double gamma)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "ColorRGBA CreateFromArgb(System.Byte alpha, System.Byte red, System.Byte green, System.Byte blue)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs a RGBA color from the four ARGB components (alpha, red, green, and blue) values.",
"since": "8.0",
"parameters": [
{
"name": "alpha",
"type": "System.Byte",
"summary": "The alpha component. Valid values are 0 through 255."
},
{
"name": "red",
"type": "System.Byte",
"summary": "The red component. Valid values are 0 through 255."
},
{
"name": "green",
"type": "System.Byte",
"summary": "The green component. Valid values are 0 through 255."
},
{
"name": "blue",
"type": "System.Byte",
"summary": "The blue component. Valid values are 0 through 255."
}
],
"returns": "A RGBA color with the specified component values."
},
{
"signature": "ColorRGBA CreateFromArgb(System.Byte red, System.Byte green, System.Byte blue)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs a RGBA color from the specified 8-bit components (red, green, and blue) values. The alpha value is implicitly 1.0 (fully opaque).",
"since": "8.0",
"parameters": [
{
"name": "red",
"type": "System.Byte",
"summary": "The red component. Valid values are 0 through 255."
},
{
"name": "green",
"type": "System.Byte",
"summary": "The green component. Valid values are 0 through 255."
},
{
"name": "blue",
"type": "System.Byte",
"summary": "The blue component. Valid values are 0 through 255."
}
],
"returns": "A RGBA color with the specified component values."
},
{
"signature": "ColorRGBA CreateFromCMYK(ColorCMYK cmyk)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest RGBA equivalent of a CMYK color.",
"since": "7.0",
"parameters": [
{
"name": "cmyk",
"type": "ColorCMYK",
"summary": "Target color in CMYK space."
}
],
"returns": "The RGBA equivalent of the CMYK color."
},
{
"signature": "ColorRGBA CreateFromHSL(ColorHSL hsl)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs the nearest RGBA equivalent of an HSV color.",
"since": "7.0",
"parameters": [
{
"name": "hsl",
"type": "ColorHSL",
"summary": "Target color in HSL space."
}
],
"returns": "The RGBA equivalent of the HSL color."
},
{
"signature": "ColorRGBA CreateFromHSV(ColorHSV hsv)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs the nearest RGBA equivalent of an HSL color.",
"since": "7.0",
"parameters": [
{
"name": "hsv",
"type": "ColorHSV",
"summary": "Target color in HSL space."
}
],
"returns": "The RGBA equivalent of the HSL color."
},
{
"signature": "ColorRGBA CreateFromLAB(ColorLAB lab)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest RGBA equivalent of a LAB color.",
"since": "7.0",
"parameters": [
{
"name": "lab",
"type": "ColorLAB",
"summary": "Target color in LAB space."
}
],
"returns": "The RGBA equivalent of the LAB color."
},
{
"signature": "ColorRGBA CreateFromLCH(ColorLCH lch)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest RGBA equivalent of a LCH color.",
"since": "7.0",
"parameters": [
{
"name": "lch",
"type": "ColorLCH",
"summary": "Target color in LCH space."
}
],
"returns": "The RGBA equivalent of the LCH color."
},
{
"signature": "ColorRGBA CreateFromXYZ(ColorXYZ xyz)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest RGBA equivalent of an XYZ color.",
"since": "7.0",
"parameters": [
{
"name": "xyz",
"type": "ColorXYZ",
"summary": "Target color in XYZ space."
}
],
"returns": "The RGBA equivalent of the XYZ color."
},
{
"signature": "ColorRGBA BlendTo(ColorRGBA col, System.Double coefficient)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "System.Int32 CompareTo(ColorRGBA other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Compares this ColorRGBA with another ColorRGBA . \nChannels evaluation priority is first A, then R, then G, then B.",
"since": "7.0",
"parameters": [
{
"name": "other",
"type": "ColorRGBA",
"summary": "The other ColorRGBA to use in comparison."
}
],
"returns": "0: if this is identical to other \n-1: if this < other \n+1: if this > other"
},
{
"signature": "System.Boolean EpsilonEquals(ColorRGBA other, System.Double epsilon)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Check that all values in other are within epsilon of the values in this",
"since": "7.0"
},
{
"signature": "System.Boolean Equals(ColorRGBA other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines whether the specified ColorRGBA has the same values as the present color.",
"since": "7.0",
"parameters": [
{
"name": "other",
"type": "ColorRGBA",
"summary": "The specified color."
}
],
"returns": "True if color has the same channel values as this; otherwise false."
},
{
"signature": "System.Boolean Equals(System.Object obj)",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "System.Int32 GetHashCode()",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "System.Int32 ToArgb()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Converts this color to a 32-bit ARGB value.",
"since": "7.35",
"returns": "The 32-bit ARGB value that corresponds to this color"
},
{
"signature": "System.String ToString()",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "System.String ToString(System.String format, System.IFormatProvider formatProvider)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0"
}
],
"operators": [
{
"signature": "bool operator !=(ColorRGBA a, ColorRGBA b)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "bool operator ==(ColorRGBA a, ColorRGBA b)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "7.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "ColorStop",
"dataType": "struct",
"summary": "Combination of a color and position. Used in defining gradient fills",
"constructors": [
{
"signature": "ColorStop(Color color, double t)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Create color stop from a color and position",
"since": "7.0"
}
],
"properties": [
{
"signature": "Color Color",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double Position",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Parameter that Color is defined at",
"since": "7.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "ColorXYZ",
"dataType": "struct",
"summary": "Represents an XYZ (Hue, Saturation, Luminance) color with double precision floating point channels. XYZ colors are based on the CIE 1931 XYZ color space standard and they mimic the natural sensitivity of cones in the human retina.",
"constructors": [
{
"signature": "ColorXYZ(Color rgb)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorXYZ that is equivalent to an ARGB color.",
"since": "5.0",
"remarks": "Exact conversions between color spaces are often not possible.",
"parameters": [
{
"name": "rgb",
"type": "System.Drawing.Color",
"summary": "ARGB color to mimic."
}
]
},
{
"signature": "ColorXYZ(double alpha, double x, double y, double z)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorXYZ with custom channel values.",
"since": "5.0",
"parameters": [
{
"name": "alpha",
"type": "System.Double",
"summary": "Alpha channel value, channel will be limited to 0~1."
},
{
"name": "x",
"type": "System.Double",
"summary": "X channel value, channel will be limited to 0~1."
},
{
"name": "y",
"type": "System.Double",
"summary": "Y channel value, channel will be limited to 0~1."
},
{
"name": "z",
"type": "System.Double",
"summary": "Z channel value, channel will be limited to 0~1."
}
]
},
{
"signature": "ColorXYZ(double x, double y, double z)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of ColorXYZ with custom channel values.",
"since": "5.0",
"parameters": [
{
"name": "x",
"type": "System.Double",
"summary": "X channel value, channel will be limited to 0~1."
},
{
"name": "y",
"type": "System.Double",
"summary": "Y channel value, channel will be limited to 0~1."
},
{
"name": "z",
"type": "System.Double",
"summary": "Z channel value, channel will be limited to 0~1."
}
]
}
],
"properties": [
{
"signature": "double A",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or set the Alpha channel value. Channel will be limited to 0~1.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double X",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or set the X channel value. Channel will be limited to 0~1.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double Y",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or set the Y channel value. Channel will be limited to 0~1.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double Z",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or set the Z channel value. Channel will be limited to 0~1.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ColorXYZ CreateFromCMYK(ColorCMYK cmyk)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest XYZ equivalent of a CMYK color.",
"since": "5.0",
"parameters": [
{
"name": "cmyk",
"type": "ColorCMYK",
"summary": "Target color in CMYK space."
}
],
"returns": "The XYZ equivalent of the CMYK color."
},
{
"signature": "ColorXYZ CreateFromHSL(ColorHSL hsl)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest XYZ equivalent of an HSL color.",
"since": "5.0",
"parameters": [
{
"name": "hsl",
"type": "ColorHSL",
"summary": "Target color in HSL space."
}
],
"returns": "The XYZ equivalent of the HSL color."
},
{
"signature": "ColorXYZ CreateFromHSV(ColorHSV hsv)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs the nearest XYZ equivalent of an HSV color.",
"since": "6.0",
"parameters": [
{
"name": "hsv",
"type": "ColorHSV",
"summary": "Target color in HSV space."
}
],
"returns": "The XYZ equivalent of the HSV color."
},
{
"signature": "ColorXYZ CreateFromLAB(ColorLAB lab)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest XYZ equivalent of a Lab color.",
"since": "5.0",
"parameters": [
{
"name": "lab",
"type": "ColorLAB",
"summary": "Target color in LAB space."
}
],
"returns": "The XYZ equivalent of the LAB color."
},
{
"signature": "ColorXYZ CreateFromLCH(ColorLCH lch)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest XYZ equivalent of an LCH color.",
"since": "5.0",
"parameters": [
{
"name": "lch",
"type": "ColorLCH",
"summary": "Target color in LCH space."
}
],
"returns": "The XYZ equivalent of the LCH color."
},
{
"signature": "ColorXYZ CreateFromRGBA(ColorRGBA rgba)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create the nearest XYZ equivalent of a RGBA color.",
"since": "7.0",
"parameters": [
{
"name": "rgba",
"type": "ColorRGBA",
"summary": "Target color in RGBA space."
}
],
"returns": "The XYZ equivalent of the RGBA color."
}
]
},
{
"namespace": "Rhino.Display",
"name": "CullFaceMode",
"dataType": "enum",
"since": "5.0",
"values": [
{
"signature": "DrawFrontAndBack = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DrawFrontFaces = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DrawBackFaces = 2",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "CullObjectEventArgs",
"dataType": "class",
"baseclass": "Rhino.Display.DrawEventArgs",
"properties": [
{
"signature": "bool CullObject",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3",
"property": ["get", "set"]
},
{
"signature": "RhinoObject RhinoObject",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3",
"property": ["get"]
},
{
"signature": "uint RhinoObjectSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the rhino object runtime serial number.",
"since": "6.14",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "CustomDisplay",
"dataType": "class",
"summary": "Provides some basic (indeed, very basic) mechanisms for drawing custom geometry in viewports.",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "CustomDisplay(bool enable)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new CustomDisplay instance. Youmustcall Dispose() when you are done with this instance, otherwise the display methods will never be switched off.",
"since": "5.0",
"parameters": [
{
"name": "enable",
"type": "System.Boolean",
"summary": "If true, the display will be enabled immediately."
}
]
}
],
"properties": [
{
"signature": "BoundingBox ClippingBox",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the clipping box of this CustomDisplay.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool Enabled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Enabled state of this CustomDisplay instance. If you wish to terminate this CustomDisplay, place a call to Dispose() instead.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool IsDisposed",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a value indicating whether this CustomDisplay instance has been disposed. Once a CustomDisplay has been disposed, you can no longer use it.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Void AddArc(Arc arc, Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, colored arc to the display list.",
"since": "5.0",
"parameters": [
{
"name": "arc",
"type": "Arc",
"summary": "Arc to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of arc."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness of arc."
}
]
},
{
"signature": "System.Void AddArc(Arc arc, Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, colored arc to the display list.",
"since": "5.0",
"parameters": [
{
"name": "arc",
"type": "Arc",
"summary": "Arc to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of arc."
}
]
},
{
"signature": "System.Void AddArc(Arc arc)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, black arc to the display list.",
"since": "5.0",
"parameters": [
{
"name": "arc",
"type": "Arc",
"summary": "Arc to add."
}
]
},
{
"signature": "System.Void AddCircle(Circle circle, Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, colored circle to the display list.",
"since": "5.0",
"parameters": [
{
"name": "circle",
"type": "Circle",
"summary": "Circle to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of circle."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness of circle."
}
]
},
{
"signature": "System.Void AddCircle(Circle circle, Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, colored arc to the display list.",
"since": "5.0",
"parameters": [
{
"name": "circle",
"type": "Circle",
"summary": "Circle to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of circle."
}
]
},
{
"signature": "System.Void AddCircle(Circle circle)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, black circle to the display list.",
"since": "5.0",
"parameters": [
{
"name": "circle",
"type": "Circle",
"summary": "Circle to add."
}
]
},
{
"signature": "System.Void AddCurve(Curve curve, Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, colored curve to the display list. The curve will be duplicated so changes to the original will not affect the display.",
"since": "5.0",
"parameters": [
{
"name": "curve",
"type": "Curve",
"summary": "Curve to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of curve."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness of curve."
}
]
},
{
"signature": "System.Void AddCurve(Curve curve, Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, colored curve to the display list. The curve will be duplicated so changes to the original will not affect the display.",
"since": "5.0",
"parameters": [
{
"name": "curve",
"type": "Curve",
"summary": "Curve to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of curve."
}
]
},
{
"signature": "System.Void AddCurve(Curve curve)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, black curve to the display list. The curve will be duplicated so changes to the original will not affect the display.",
"since": "5.0",
"parameters": [
{
"name": "curve",
"type": "Curve",
"summary": "Curve to add."
}
]
},
{
"signature": "System.Void AddLine(Line line, Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, colored line to the display list.",
"since": "5.0",
"parameters": [
{
"name": "line",
"type": "Line",
"summary": "Line to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of line."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness of line."
}
]
},
{
"signature": "System.Void AddLine(Line line, Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, colored line to the display list.",
"since": "5.0",
"parameters": [
{
"name": "line",
"type": "Line",
"summary": "Line to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of line."
}
]
},
{
"signature": "System.Void AddLine(Line line)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, black line to the display list.",
"since": "5.0",
"parameters": [
{
"name": "line",
"type": "Line",
"summary": "Line to add."
}
]
},
{
"signature": "System.Void AddPoint(Point3d point, Color color, PointStyle style, System.Int32 radius)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new stylized point to the display list.",
"since": "5.0",
"parameters": [
{
"name": "point",
"type": "Point3d",
"summary": "Point to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of point."
},
{
"name": "style",
"type": "PointStyle",
"summary": "Display style of point."
},
{
"name": "radius",
"type": "System.Int32",
"summary": "Radius of point widget."
}
]
},
{
"signature": "System.Void AddPoint(Point3d point, Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new colored point to the display list.",
"since": "5.0",
"parameters": [
{
"name": "point",
"type": "Point3d",
"summary": "Point to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of point."
}
]
},
{
"signature": "System.Void AddPoint(Point3d point)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, black point to the display list.",
"since": "5.0",
"parameters": [
{
"name": "point",
"type": "Point3d",
"summary": "Point to add."
}
]
},
{
"signature": "System.Void AddPoints(IEnumerable points, Color color, PointStyle style, System.Int32 radius)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a collection of stylized points to the display list.",
"since": "5.0",
"parameters": [
{
"name": "points",
"type": "IEnumerable",
"summary": "Points to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of points."
},
{
"name": "style",
"type": "PointStyle",
"summary": "Display style of points."
},
{
"name": "radius",
"type": "System.Int32",
"summary": "Radius of point widgets."
}
]
},
{
"signature": "System.Void AddPoints(IEnumerable points, Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a collection of colored points to the display list.",
"since": "5.0",
"parameters": [
{
"name": "points",
"type": "IEnumerable",
"summary": "Points to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of points."
}
]
},
{
"signature": "System.Void AddPoints(IEnumerable points)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a collection of black points to the display list.",
"since": "5.0",
"parameters": [
{
"name": "points",
"type": "IEnumerable",
"summary": "Points to add."
}
]
},
{
"signature": "System.Void AddPolygon(IEnumerable polygon, Color fillColor, Color edgeColor, System.Boolean drawFill, System.Boolean drawEdge)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a polygon to the drawing list. Polygons are not like Hatches, when you supply a concave polygon, the shading probably won't work.",
"since": "5.0",
"parameters": [
{
"name": "polygon",
"type": "IEnumerable",
"summary": "Points that define the corners of the polygon."
},
{
"name": "fillColor",
"type": "Color",
"summary": "Fill color of polygon."
},
{
"name": "edgeColor",
"type": "Color",
"summary": "Edge color of polygon."
},
{
"name": "drawFill",
"type": "System.Boolean",
"summary": "If true, the polygon contents will be drawn."
},
{
"name": "drawEdge",
"type": "System.Boolean",
"summary": "If true, the polygon edge will be drawn."
}
]
},
{
"signature": "System.Void AddText(System.String text, Plane plane, System.Double size, Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, colored 3D text object to the display list.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "System.String",
"summary": "Text to add."
},
{
"name": "plane",
"type": "Plane",
"summary": "Plane for text orientation."
},
{
"name": "size",
"type": "System.Double",
"summary": "Height (in units) of font."
},
{
"name": "color",
"type": "Color",
"summary": "Color of text."
}
]
},
{
"signature": "System.Void AddText(System.String text, Plane plane, System.Double size)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, black 3D text object to the display list.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "System.String",
"summary": "Text to add."
},
{
"name": "plane",
"type": "Plane",
"summary": "Plane for text orientation."
},
{
"name": "size",
"type": "System.Double",
"summary": "Height (in units) of font."
}
]
},
{
"signature": "System.Void AddText(Text3d text, Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new 3D text object to the display list.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "Text3d",
"summary": "Text object to add."
},
{
"name": "color",
"type": "Color",
"summary": "Color of text object."
}
]
},
{
"signature": "System.Void AddVector(Point3d anchor, Vector3d span, Color color, System.Boolean drawAnchor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, colored vector to the display list.",
"since": "5.0",
"parameters": [
{
"name": "anchor",
"type": "Point3d",
"summary": "Anchor point of vector."
},
{
"name": "span",
"type": "Vector3d",
"summary": "Direction and magnitude of vector."
},
{
"name": "color",
"type": "Color",
"summary": "Color of vector."
},
{
"name": "drawAnchor",
"type": "System.Boolean",
"summary": "Include a point at the vector anchor."
}
]
},
{
"signature": "System.Void AddVector(Point3d anchor, Vector3d span, Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, colored vector to the display list.",
"since": "5.0",
"parameters": [
{
"name": "anchor",
"type": "Point3d",
"summary": "Anchor point of vector."
},
{
"name": "span",
"type": "Vector3d",
"summary": "Direction and magnitude of vector."
},
{
"name": "color",
"type": "Color",
"summary": "Color of vector."
}
]
},
{
"signature": "System.Void AddVector(Point3d anchor, Vector3d span)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a new, black vector to the display list.",
"since": "5.0",
"parameters": [
{
"name": "anchor",
"type": "Point3d",
"summary": "Anchor point of vector."
},
{
"name": "span",
"type": "Vector3d",
"summary": "Direction and magnitude of vector."
}
]
},
{
"signature": "System.Void Clear()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Clear the drawing lists.",
"since": "5.0"
},
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Dispose this CustomDisplay instance. You must call this function in order to properly shut down the CustomDisplay.",
"since": "5.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DefinedViewportProjection",
"dataType": "enum",
"summary": "Parallel and perspective projections that are \"standard\" in Rhino",
"since": "5.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Top = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Bottom = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Left = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Right = 4",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Front = 5",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Back = 6",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Perspective = 7",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TwoPointPerspective = 8",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ParallelReflected = 9",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DepthMode",
"dataType": "enum",
"since": "5.0",
"values": [
{
"signature": "Neutral = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AlwaysInFront = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AlwaysInBack = 2",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayBitmap",
"dataType": "class",
"summary": "A bitmap resource that can be used by the display pipeline (currently only in OpenGL display). Reuse DisplayBitmaps for drawing if possible; it is much more expensive to construct new DisplayBitmaps than it is to reuse existing DisplayBitmaps.",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "DisplayBitmap(Bitmap bitmap)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a DisplayBitmap from an existing bitmap.",
"since": "5.0",
"parameters": [
{
"name": "bitmap",
"type": "System.Drawing.Bitmap",
"summary": "The original bitmap."
}
]
},
{
"signature": "DisplayBitmap(string path, Bitmap bitmap)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Creates a DisplayBitmap either from a path, or a bitmap. If the path is null, a random tag name will be used. If the bitmap is null, the bitmap will be loaded from the path. If both are null, the object is invalid. if both are valid objects, the bitmap will be used and it will be added to Rhino's bitmap cache with the path supplied. In other words, this is a way to add a bitmap from memory directly into Rhino's memory cache.",
"since": "7.16",
"parameters": [
{
"name": "path",
"type": "System.String",
"summary": "If null, use a temporary tag name. If non-null, use that path in Rhino's bitmap cache. Note, this version does not support URLs."
},
{
"name": "bitmap",
"type": "System.Drawing.Bitmap",
"summary": "If null, load the bitmap from the supplied path. If non-null, creates the bitmap from the data supplied."
}
]
}
],
"properties": [
{
"signature": "Size Size",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Size of the underlying bitmap image",
"since": "7.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "DisplayBitmap Load(System.String path)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Load a DisplayBitmap from and image file on disk or from URL. If path starts with http:// or https:// then an attempt is made to load the bitmap from an online resource",
"since": "5.0",
"parameters": [
{
"name": "path",
"type": "System.String",
"summary": "A location from which to load the file."
}
],
"returns": "The new display bitmap, or None on error."
},
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Actively reclaims unmanaged resources that this instance uses.",
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "For derived class implementers. \nThis method is called with argument True when class user calls Dispose(), while with argument False when the Garbage Collector invokes the finalizer, or Finalize() method. \nYou must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true. \nAlso, you must call the base virtual method within your overriding method.",
"parameters": [
{
"name": "disposing",
"type": "System.Boolean",
"summary": "True if the call comes from the Dispose() method; False if it comes from the Garbage Collector finalizer."
}
]
},
{
"signature": "System.Void GetBlendModes(out BlendMode source, out BlendMode destination)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the source and destination blend modes.",
"since": "5.0",
"parameters": [
{
"name": "source",
"type": "BlendMode",
"summary": "The source blend mode is assigned to this out parameter."
},
{
"name": "destination",
"type": "BlendMode",
"summary": "The destination blend mode is assigned to this out parameter."
}
]
},
{
"signature": "System.Void SetBlendFunction(BlendMode source, BlendMode destination)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets blending function used to determine how this bitmap is blended with the current frame buffer color. The default setting is SourceAlpha for source and OneMinusSourceAlpha for destination. See OpenGL's glBlendFunc for details. \nhttp://www.opengl.org/sdk/docs/man/xhtml/glBlendFunc.xml",
"since": "5.0",
"parameters": [
{
"name": "source",
"type": "BlendMode",
"summary": "The source blend mode."
},
{
"name": "destination",
"type": "BlendMode",
"summary": "The destination blend mode."
}
]
},
{
"signature": "System.Void Update(System.Drawing.Bitmap bitmap)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Update the image used for this DisplayBitmap",
"since": "8.14"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayBitmapDrawList",
"dataType": "class",
"constructors": [
{
"signature": "DisplayBitmapDrawList()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
],
"properties": [
{
"signature": "BoundingBox BoundingBox",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "int MaximumCachedSortLists",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Maximum number of cached sort order index lists stored on this class. Default is 10, but depending on the number of points in this list you may get better performance by setting this value to a certain percentage of the point count.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double SortAngleTolerance",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Angle in radians used to determine if an index list is \"parallel enough\" to a viewports camera angle. Default is 0.0873 radians (5 degrees)",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Void SetPoints(IEnumerable points, IEnumerable colors)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void SetPoints(IEnumerable points, System.Drawing.Color blendColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void SetPoints(IEnumerable points)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Int32[] Sort(Geometry.Vector3d cameraDirection)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayConduit",
"dataType": "class",
"constructors": [
{
"signature": "DisplayConduit()",
"modifiers": ["protected"],
"protected": true,
"virtual": false
}
],
"properties": [
{
"signature": "bool Enabled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ObjectType GeometryFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The geometry filter will ensure that your conduit's per-object functions will only be called for objects that are of certain geometry type",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "ActiveSpace SpaceFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If you want this conduit to only work in a specific space (model or page), then set this filter to that specific space. The default is None meaning no filter is applied",
"since": "6.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Void Bind(RhinoViewport viewport)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Bind this conduit to a specific viewport"
},
{
"signature": "System.Void CalculateBoundingBox(CalculateBoundingBoxEventArgs e)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Library developers should override this function to increase the bounding box of scene so it includes the geometry that you plan to draw in the \"Draw\" virtual functions. \nThe default implementation does nothing.",
"parameters": [
{
"name": "e",
"type": "CalculateBoundingBoxEventArgs",
"summary": "The event argument contain the current bounding box state."
}
]
},
{
"signature": "System.Void CalculateBoundingBoxZoomExtents(CalculateBoundingBoxEventArgs e)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "If you want to participate in the Zoom Extents command with your display conduit, then you will need to override ZoomExtentsBoundingBox. Typically you could just call your CalculateBoundingBox override, but you may also want to spend a little more time here and compute a tighter bounding box for your conduit geometry if that is needed. \nThe default implementation does nothing.",
"parameters": [
{
"name": "e",
"type": "CalculateBoundingBoxEventArgs",
"summary": "The event argument contain the current bounding box state."
}
]
},
{
"signature": "System.Void DrawForeground(DrawEventArgs e)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Called after all non-highlighted objects have been drawn and PostDrawObjects has been called. Depth writing and testing are turned OFF. If you want to draw with depth writing/testing, see PostDrawObjects. \nThe default implementation does nothing.",
"parameters": [
{
"name": "e",
"type": "DrawEventArgs",
"summary": "The event argument contains the current viewport and display state."
}
]
},
{
"signature": "System.Void DrawOverlay(DrawEventArgs e)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "If Rhino is in a feedback mode, the draw overlay call allows for temporary geometry to be drawn on top of everything in the scene. This is similar to the dynamic draw routine that occurs with custom get point. \nThe default implementation does nothing.",
"parameters": [
{
"name": "e",
"type": "DrawEventArgs",
"summary": "The event argument contains the current viewport and display state."
}
]
},
{
"signature": "System.Void ExclusiveBind(RhinoViewport viewport)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Exclusively bind this conduit to a specific viewport"
},
{
"signature": "System.Void GetSelectionFilter(out System.Boolean on, out System.Boolean checkSubObjects)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The selection filter will make per-object conduit functions only be called for selected objects (when the filter is turned on)",
"since": "7.0"
},
{
"signature": "System.Void ObjectCulling(CullObjectEventArgs e)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "The default implementation does nothing."
},
{
"signature": "System.Void OnEnable(System.Boolean enable)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Called when the enabled state changes for this class instance",
"since": "7.0"
},
{
"signature": "System.Void PostDrawObjects(DrawEventArgs e)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Called after all non-highlighted objects have been drawn. Depth writing and testing are still turned on. If you want to draw without depth writing/testing, see DrawForeground. \nThe default implementation does nothing.",
"parameters": [
{
"name": "e",
"type": "DrawEventArgs",
"summary": "The event argument contains the current viewport and display state."
}
]
},
{
"signature": "System.Void PreDrawObject(DrawObjectEventArgs e)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Called before every object in the scene is drawn."
},
{
"signature": "System.Void PreDrawObjects(DrawEventArgs e)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Called before objects are been drawn. Depth writing and testing are on. \nThe default implementation does nothing.",
"parameters": [
{
"name": "e",
"type": "DrawEventArgs",
"summary": "The event argument contain the current viewport and display state."
}
]
},
{
"signature": "System.Void SetObjectIdFilter(IEnumerable ids)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set object Ids that this conduit's per-object functions will only be called for",
"since": "7.0"
},
{
"signature": "System.Void SetObjectIdFilter(System.Guid id)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set an object Id that this conduit's per-object functions will only be called for",
"since": "7.0"
},
{
"signature": "System.Void SetSelectionFilter(System.Boolean on, System.Boolean checkSubObjects)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The selection filter will make per-object conduit functions only be called for selected objects (when the filter is turned on)",
"since": "7.0"
},
{
"signature": "System.Void UnbindAll()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove viewport bindings"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayEngine",
"dataType": "class",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "DisplayEngine()",
"modifiers": ["protected"],
"protected": true,
"virtual": false
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Actively reclaims unmanaged resources that this instance uses.",
"since": "6.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayMaterial",
"dataType": "class",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "DisplayMaterial()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a default material.",
"since": "5.0"
},
{
"signature": "DisplayMaterial(Color diffuse, Color specular, Color ambient, Color emission, double shine, double transparency)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a material with custom properties.",
"since": "5.0",
"parameters": [
{
"name": "diffuse",
"type": "Color",
"summary": "Diffuse color of material. The alpha component of the Diffuse color is ignored."
},
{
"name": "specular",
"type": "Color",
"summary": "Specular color of material. The alpha component of the Specular color is ignored."
},
{
"name": "ambient",
"type": "Color",
"summary": "Ambient color of material. The alpha component of the Ambient color is ignored."
},
{
"name": "emission",
"type": "Color",
"summary": "Emission color of material. The alpha component of the Emission color is ignored."
},
{
"name": "shine",
"type": "System.Double",
"summary": "Shine (highlight size) of material."
},
{
"name": "transparency",
"type": "System.Double",
"summary": "Transparency of material (0.0 = opaque, 1.0 = transparent)"
}
]
},
{
"signature": "DisplayMaterial(Color diffuse, double transparency)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a default material with a specific diffuse color and transparency.",
"since": "5.0",
"parameters": [
{
"name": "diffuse",
"type": "Color",
"summary": "Diffuse color of material. The alpha component of the Diffuse color is ignored."
},
{
"name": "transparency",
"type": "System.Double",
"summary": "Transparency factor (0.0 = opaque, 1.0 = transparent)"
}
]
},
{
"signature": "DisplayMaterial(Color diffuse)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a default material with a specific diffuse color.",
"since": "5.0",
"parameters": [
{
"name": "diffuse",
"type": "Color",
"summary": "Diffuse color of material. The alpha component of the Diffuse color is ignored."
}
]
},
{
"signature": "DisplayMaterial(DisplayMaterial other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Duplicate another material.",
"since": "5.0"
},
{
"signature": "DisplayMaterial(Material material)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
],
"properties": [
{
"signature": "Color Ambient",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Ambient color of the Material. The alpha component of the color will be ignored.",
"since": "5.0",
"obsolete": "This property is obsolete: ambient is no longer supported",
"property": ["get", "set"]
},
{
"signature": "Color BackAmbient",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Ambient color of the back side of the Material. The alpha component of the color will be ignored.",
"since": "5.0",
"obsolete": "This property is obsolete: ambient is no longer supported",
"property": ["get", "set"]
},
{
"signature": "Color BackDiffuse",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Diffuse color of the back side of the Material. The alpha component of the color will be ignored.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color BackEmission",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Emissive color of the back side of the Material. The alpha component of the color will be ignored.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double BackShine",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the shine factor of the back side of the material (0.0 to 1.0)",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color BackSpecular",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Specular color of the back side of the Material. The alpha component of the color will be ignored.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double BackTransparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the transparency of the back side material (0.0 = opaque to 1.0 = transparent)",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color Diffuse",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Diffuse color of the Material. The alpha component of the color will be ignored.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color Emission",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Emissive color of the Material. The alpha component of the color will be ignored.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool IsTwoSided",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double Shine",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the shine factor of the material (0.0 to 1.0)",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color Specular",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Specular color of the Material. The alpha component of the color will be ignored.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double Transparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the transparency of the material (0.0 = opaque to 1.0 = transparent)",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true
},
{
"signature": "Rhino.DocObjects.Texture GetBitmapTexture(System.Boolean front)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Rhino.DocObjects.Texture GetBumpTexture(System.Boolean front)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the bump texture for this display material.",
"since": "5.0",
"returns": "The texture, or None if no bump texture has been added to this material."
},
{
"signature": "Rhino.DocObjects.Texture GetEnvironmentTexture(System.Boolean front)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Rhino.DocObjects.Texture GetTransparencyTexture(System.Boolean front)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetBitmapTexture(Rhino.DocObjects.Texture texture, System.Boolean front)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetBitmapTexture(System.String filename, System.Boolean front)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetBumpTexture(Rhino.DocObjects.Texture texture, System.Boolean front)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetBumpTexture(System.String filename, System.Boolean front)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetEnvironmentTexture(Rhino.DocObjects.Texture texture, System.Boolean front)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetEnvironmentTexture(System.String filename, System.Boolean front)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetTransparencyTexture(Rhino.DocObjects.Texture texture, System.Boolean front)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetTransparencyTexture(System.String filename, System.Boolean front)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayModeChangedEventArgs",
"dataType": "class",
"baseclass": "EventArgs",
"properties": [
{
"signature": "Guid ChangedDisplayModeId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.18",
"property": ["get"]
},
{
"signature": "Guid OldDisplayModeId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.18",
"property": ["get"]
},
{
"signature": "RhinoDoc RhinoDoc",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.18",
"property": ["get"]
},
{
"signature": "RhinoViewport Viewport",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.18",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayModeDescription",
"dataType": "class",
"summary": "Description of a how Rhino will display in a viewport. These are the modes that are listed under \"Advanced display\" in the options dialog.",
"interfaces": ["IDisposable", "ISerializable"],
"properties": [
{
"signature": "Guid AmbientOcclusionId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "Guid ArtisticId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.26",
"property": ["get"]
},
{
"signature": "Guid GhostedId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "Guid MonochromeId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "8.14",
"property": ["get"]
},
{
"signature": "Guid PenId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "Guid RaytracedId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "Guid RenderedId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "Guid RenderedShadowsId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "Guid ShadedId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "Guid TechId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "Guid WireframeId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "Guid XRayId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool AllowObjectAssignment",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "DisplayPipelineAttributes DisplayAttributes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "string EnglishName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Guid Id",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool InMenu",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string LocalName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool PipelineLocked",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ShadedPipelineRequired",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SupportsShadeCommand",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SupportsShading",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool WireframePipelineRequired",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Guid AddDisplayMode(DisplayModeDescription displayMode)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Adds a new display mode from an existing description. Note that this only registers the mode in memory; call UpdateDisplayMode to persist it to disk.",
"since": "5.0",
"parameters": [
{
"name": "displayMode",
"type": "DisplayModeDescription",
"summary": "The display mode description to add."
}
],
"returns": "The id of the new display mode if successful. Guid.Empty on error."
},
{
"signature": "System.Guid AddDisplayMode(System.String name)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Adds a new display mode. Note that this only registers the mode in memory; call UpdateDisplayMode to persist it to disk.",
"since": "6.7",
"parameters": [
{
"name": "name",
"type": "System.String",
"summary": "The name of the new display mode."
}
],
"returns": "The id of the new display mode if successful. Guid.Empty on error."
},
{
"signature": "System.Guid CopyDisplayMode(System.Guid id, System.String name)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Copies an existing display mode. Note that this only registers the new mode in memory; call UpdateDisplayMode to persist it to disk.",
"since": "6.7",
"parameters": [
{
"name": "id",
"type": "System.Guid",
"summary": "The id of the existing display mode to copy."
},
{
"name": "name",
"type": "System.String",
"summary": "The name of the new display mode."
}
],
"returns": "The id of the new display mode if successful. Guid.Empty on error."
},
{
"signature": "System.Boolean DeleteDiplayMode(System.Guid id)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Deletes an existing display mode.",
"since": "5.0",
"deprecated": "7.0",
"obsolete": "Use DisplayModeDescription.DeleteDisplayMode",
"parameters": [
{
"name": "id",
"type": "System.Guid",
"summary": "The id of the existing display mode to delete."
}
],
"returns": "True if successful, False otherwise."
},
{
"signature": "System.Boolean DeleteDisplayMode(System.Guid id)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Deletes an existing display mode.",
"since": "7.0",
"parameters": [
{
"name": "id",
"type": "System.Guid",
"summary": "The id of the existing display mode to delete."
}
],
"returns": "True if successful, False otherwise."
},
{
"signature": "System.Boolean ExportToFile(DisplayModeDescription displayMode, System.String filename)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Exports a DisplayModeDescription to a Windows-style .ini file.",
"since": "6.0",
"parameters": [
{
"name": "displayMode",
"type": "DisplayModeDescription",
"summary": "The DisplayModeDescription to export."
},
{
"name": "filename",
"type": "System.String",
"summary": "The name of the file to create."
}
]
},
{
"signature": "DisplayModeDescription FindByName(System.String englishName)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Finds a display mode description by its English name.",
"since": "5.0",
"parameters": [
{
"name": "englishName",
"type": "System.String",
"summary": "The English name of the display mode."
}
],
"returns": "The display mode description if found, None otherwise."
},
{
"signature": "DisplayModeDescription GetDisplayMode(System.Guid id)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets a display mode description by id.",
"since": "5.0",
"parameters": [
{
"name": "id",
"type": "System.Guid",
"summary": "The id of the display mode."
}
],
"returns": "The display mode description if found, None otherwise."
},
{
"signature": "DisplayModeDescription[] GetDisplayModes()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets all display mode descriptions that Rhino currently knows about.",
"since": "5.0",
"returns": "Copies of all of the display mode descriptions. If you want to modify these descriptions, you must call UpdateDisplayMode or AddDisplayMode."
},
{
"signature": "System.Guid ImportFromFile(System.String filename, System.Boolean interactive)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Imports a DisplayModeDescription from a Windows-style .ini file.",
"since": "8.27",
"parameters": [
{
"name": "filename",
"type": "System.String",
"summary": "The name of the file to import."
},
{
"name": "interactive",
"type": "System.Boolean",
"summary": "True to show user interface messages, False to suppress any user interface messages."
}
],
"returns": "The id of the DisplayModeDescription if successful."
},
{
"signature": "System.Guid ImportFromFile(System.String filename)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Imports a DisplayModeDescription from a Windows-style .ini file.",
"since": "6.0",
"parameters": [
{
"name": "filename",
"type": "System.String",
"summary": "The name of the file to import."
}
],
"returns": "The id of the DisplayModeDescription if successful."
},
{
"signature": "System.Boolean UpdateDisplayMode(DisplayModeDescription displayMode)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Updates an existing display mode and immediately saves it to disk. Call this after AddDisplayMode/CopyDisplayMode or changing DisplayAttributes to persist the change; otherwise an unrelated settings save elsewhere in Rhino can reload the display mode list from disk and silently discard the unsaved mode.",
"since": "5.0",
"parameters": [
{
"name": "displayMode",
"type": "DisplayModeDescription",
"summary": "The display mode description to update."
}
],
"returns": "True if successful, False otherwise."
},
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPen",
"dataType": "class",
"summary": "Pen used to define stroke applied to several DisplayPipeline draw functions",
"constructors": [
{
"signature": "DisplayPen()",
"summary": "Initializes a new instance of the DisplayPen class"
}
],
"properties": [
{
"signature": "LineCapStyle CapStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "How caps are drawn at the ends of open curves",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color Color",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Color applied to stroke",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color HaloColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Halos are blended colors drawn around a curve for purposes like selection",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "float HaloThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Halos are blended colors drawn around a curve for purposes like selection",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "LineJoinStyle JoinStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "How corners of curves are joined",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool PatternAutoscale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Scale pattern in detail views",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool PatternBySegment",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Restart patterns at corners in a curve",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool PatternLengthInWorldUnits",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If true, lengths in pattern definition are interpreted to be in world units. If false, screen pixel distances are used.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "float PatternOffset",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Offset to apply to pattern. If RhinoMath.UnsetSingle, then pattern is centered to keep even dash lengths at ends",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "float PatternScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Scale applied to the pattern, use 0.0 to let Rhino apply global scale.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "float Thickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Thickness for stroke",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "CoordinateSystem ThicknessSpace",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Coordinate system for the pen's thickness",
"since": "8.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "DisplayPen FromLinetype(Linetype linetype, System.Drawing.Color color, System.Double patternScale)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create a display pen that matches a linetype definition",
"since": "8.0",
"parameters": [
{
"name": "linetype",
"type": "Linetype",
"summary": ""
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": ""
},
{
"name": "patternScale",
"type": "System.Double",
"summary": "scale to be applied to linetype dash pattern. Typically this is 1.0."
}
]
},
{
"signature": "DisplayPen FromLinetype(Linetype linetype, System.Drawing.Color color)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Create a display pen that matches a linetype definition on any viewport.",
"since": "9.0"
},
{
"signature": "DisplayPen Duplicate()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Create a duplicate of this display pen.",
"since": "8.0",
"returns": "An exact duplicate of this display pen."
},
{
"signature": "System.Single[] PatternAsArray()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the pattern for this pen as an array of dash,gap,dash,gap... values",
"since": "8.0"
},
{
"signature": "System.Void SetPattern(IEnumerable dashesAndGaps)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set pattern to apply for a stroke.",
"since": "8.0",
"parameters": [
{
"name": "dashesAndGaps",
"type": "System.Collections.Generic.IEnumerable",
"summary": "Lengths of dashes and gaps for a pattern. Dash is always assumed the first item. There is a limit to 8 dashes and gaps total"
}
]
},
{
"signature": "System.Void SetTaper(System.Single startThickness, System.Single endThickness, Point2f taperPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Positions and thickness at those positions along a curve that define a taper.",
"since": "8.0"
},
{
"signature": "Point2f[] TaperAsArray()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Collection of positions and thicknesses at those positions to define a taper Rhino currently only supports either no taper or a single taper. An array is used here in case Rhino supports multiple taper values in the future.",
"since": "8.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipeline",
"dataType": "class",
"summary": "The display pipeline calls events during specific phases of drawing During the drawing of a single frame the events are called in the following order. [Begin Drawing of a Frame] - CalculateBoundingBox
- CalculateClippingPanes
- SetupFrustum
- SetupLighting
- InitializeFrameBuffer
- DrawBackground
- If this is a layout and detail objects exist the channels are called in the same order for each detail object (drawn as a nested viewport)
- PreDrawObjects
- For Each Visible Non Highlighted Object
- SetupObjectDisplayAttributes
- PreDrawObject
- DrawObject
- PostDrawObject
- PostDrawObjects - depth writing/testing on
- DrawForeGround - depth writing/testing off
- For Each Visible Highlighted Object
- SetupObjectDisplayAttributes
- PreDrawObject
- DrawObject
- PostDrawObject
- PostProcessFrameBuffer (If a delegate exists that requires this)
- DrawOverlay (if Rhino is in a feedback mode)
[End of Drawing of a Frame] \nNOTE: There may be multiple DrawObject calls for a single object. An example of when this could happen would be with a shaded sphere. The shaded mesh is first drawn and these channels would be processed; then at a later time the isocurves for the sphere would be drawn.",
"properties": [
{
"signature": "RhinoObject ActiveObject",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.7",
"property": ["get"]
},
{
"signature": "int ActiveObjectNestingLevel",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.7",
"property": ["get"]
},
{
"signature": "RhinoObject[] ActiveObjectNestingStack",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.7",
"property": ["get"]
},
{
"signature": "RhinoObject ActiveTopLevelObject",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.7",
"property": ["get"]
},
{
"signature": "int DefaultCurveThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the curve thickness as defined by the current display mode. Note: this only applies to curve objects, Brep and Mesh wires may have different settings.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "DepthMode DepthMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "DisplayPipelineAttributes DisplayPipelineAttributes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3",
"property": ["get"]
},
{
"signature": "float DpiScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Scale factor used for high resolution displays. When a monitor that this pipeline is drawing to is at a DPI of 96, this value is one. On high DPI monitors, this value will commonly be greater than one.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool DrawingGrips",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a value that indicates whether the pipeline is currently in a grip drawing operation.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool DrawingSurfaces",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a value that indicates whether the pipeline is currently in a surface drawing operation. Surface drawing means draw the shaded triangles of a mesh representing the surface (mesh, extrusion, or brep). This is useful when inside of a draw event or display conduit to check and see if the geometry is about to be drawn as a shaded set of triangles representing the geometry. See DrawingWires to check and see if the wireframe representation of the geometry is going to be drawn.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool DrawingWires",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a value that indicates whether the pipeline is currently in a curve drawing operation. This is useful when inside of a draw event or display conduit to check and see if the geometry is about to be drawn is going to be drawing the wire representation of the geometry (mesh, extrusion, or brep). See DrawingSurfaces to check and see if the shaded mesh representation of the geometry is going to be drawn.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Bitmap FrameBuffer",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the contents of the frame buffer that this pipeline is drawing to.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "Size FrameSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the size of the frame buffer that this pipeline is drawing to.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsDynamicDisplay",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a value that indicates whether the viewport is in Dynamic Display state. Dynamic display is the state a viewport is in when it is rapidly redrawing because of an operation like panning or rotating. The pipeline will drop some level of detail while inside a dynamic display state to keep the frame rate as high as possible.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsInViewCapture",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a value that indicates whether this pipeline is currently drawing for ViewCaptureToFile or ViewCaptureToClipboard",
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool IsOpen",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Is True of the pipeline is open, False otherwise.",
"since": "7.0",
"property": ["get"]
},
{
"signature": "bool IsOpenGL",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a value indicating whether or not this pipeline is drawing into an OpenGL context.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsPrinting",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a value that indicates whether this pipeline is currently drawing for printing purposes.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsStereoMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a value that indicates whether this pipeline is currently using an engine that is performing stereo style drawing. Stereo drawing is for providing an \"enhanced 3-D\" effect through stereo viewing devices.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Transform ModelTransform",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the current model transformation that is applied to vertices when drawing.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ModelTransformIsIdentity",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a value that indicates whether the Model Transform is an Identity transformation.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "int NestLevel",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the current nested viewport drawing level. This is used to know if you are currently inside the drawing of a nested viewport (detail object in Rhino). \nNest level = 0 Drawing is occurring in a standard Rhino viewport or on the page viewport. \nNest level = 1 Drawing is occurring inside a detail view object.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "int RenderPass",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the current pass that the pipeline is in for drawing a frame. Typically drawing a frame requires a single pass through the DrawFrameBuffer function, but some special display effects can be achieved through drawing with multiple passes.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool ShadingRequired",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the \"ShadingRequired\" flag. This flag gets set inside the pipeline when a request is made to draw a shaded mesh but the current render engine doesn't support shaded mesh drawing...at this point the redraw mechanism will make sure everything will work the next time around.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int StereoProjection",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the current stereo projection if stereo mode is on. \n0 = left \n1 = right If stereo mode is not enables, this property always returns 0.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool SupportsShading",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets whether or not this pipeline supports shaded meshes.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "RhinoViewport Viewport",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "ZBiasMode ZBiasMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.UInt32 AvailableOpenGLVersion(out System.Boolean coreProfile)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "If Rhino is using OpenGL for display, this function will return major.minor version of OpenGL available for this instance of Rhino",
"since": "6.21",
"parameters": [
{
"name": "coreProfile",
"type": "System.Boolean",
"summary": "If true, OpenGL is being used in \"core profile\" mode"
}
],
"returns": "major version * 10 + minor version For example, OpenGL 4.5 returns 45"
},
{
"signature": "System.Boolean CullControlPolygon()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns a value indicating if only points on the side of the surface that face the camera are displayed.",
"since": "5.0",
"returns": "True if back faces of surface and mesh control polygons are culled. This value is determined by the _CullControlPolygon command."
},
{
"signature": "System.Drawing.Bitmap DrawToBitmap(RhinoViewport viewport, System.Int32 width, System.Int32 height)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Draw a given viewport to an off-screen bitmap.",
"since": "5.0",
"parameters": [
{
"name": "viewport",
"type": "RhinoViewport",
"summary": "Viewport to draw."
},
{
"name": "width",
"type": "System.Int32",
"summary": "Width of target image."
},
{
"name": "height",
"type": "System.Int32",
"summary": "Height of target image."
}
],
"returns": "A bitmap containing the given view, or None on error."
},
{
"signature": "System.Void GetDrawListSerialNumbers(out System.UInt32 modelSerialNumber, out System.UInt32 pageSerialNumber)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the current model and page view draw list serial numbers, which can be used to determine if a model or page view needs to be redrawn.",
"since": "7.0",
"parameters": [
{
"name": "modelSerialNumber",
"type": "System.UInt32",
"summary": "The current model draw list serial number."
},
{
"name": "pageSerialNumber",
"type": "System.UInt32",
"summary": "The current page view draw list serial number."
}
]
},
{
"signature": "System.Boolean MakeDefaultOpenGLContextCurrent()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Make a \"default\" OpenGL context current",
"since": "7.0"
},
{
"signature": "System.Int32[] SupportedMultisamlpleModes(DisplayTechnology technology)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Multisample modes available",
"since": "9.0"
},
{
"signature": "System.Int32 AddClippingPlane(Point3d point, Vector3d normal)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Add a clipping plane to be used during the drawing of this frame",
"since": "6.3",
"parameters": [
{
"name": "point",
"type": "Point3d",
"summary": "point on the plane"
},
{
"name": "normal",
"type": "Vector3d",
"summary": "vector perpendicular to the plane"
}
],
"returns": "index for the added clipping plane"
},
{
"signature": "System.Void ClearFrameBuffer(System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Fill the frame buffer with a single color. This function also clears the depth buffer for engines that support depth buffered drawing.",
"since": "8.0",
"parameters": [
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "the color to fill the frame buffer with"
}
]
},
{
"signature": "DisplayPipeline Clone(RhinoViewport viewport)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Clones the pipeline. Creates an identical copy of \"this\" pipeline. Copies all conduits from \"this\" pipeline to the new pipeline.",
"since": "7.0",
"returns": "The newly cloned pipeline if successful, None otherwise. or failed to close."
},
{
"signature": "System.Boolean Close()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Closes the pipeline.",
"since": "7.0",
"returns": "True if the pipeline was closed, False if it was already closed or failed to close."
},
{
"signature": "System.Void Draw2dLine(System.Drawing.Point from, System.Drawing.Point to, System.Drawing.Color color, System.Single thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void Draw2dLine(System.Drawing.PointF from, System.Drawing.PointF to, System.Drawing.Color color, System.Single thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void Draw2dRectangle(System.Drawing.Rectangle rectangle, System.Drawing.Color strokeColor, System.Int32 thickness, System.Drawing.Color fillColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.10"
},
{
"signature": "System.Void Draw2dText(System.String text, System.Drawing.Color color, Point2d screenCoordinate, System.Boolean middleJustified, System.Int32 height, System.String fontface)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws 2D text on the viewport.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "System.String",
"summary": "the string to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "text color."
},
{
"name": "screenCoordinate",
"type": "Point2d",
"summary": "definition point in screen coordinates (0,0 is top-left corner)"
},
{
"name": "middleJustified",
"type": "System.Boolean",
"summary": "if True text is centered around the definition point, otherwise it is lower-left justified."
},
{
"name": "height",
"type": "System.Int32",
"summary": "height in pixels (good default is 12)"
},
{
"name": "fontface",
"type": "System.String",
"summary": "font name (good default is \"Arial\")"
}
]
},
{
"signature": "System.Void Draw2dText(System.String text, System.Drawing.Color color, Point2d screenCoordinate, System.Boolean middleJustified, System.Int32 height)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws 2D text on the viewport.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "System.String",
"summary": "the string to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "text color."
},
{
"name": "screenCoordinate",
"type": "Point2d",
"summary": "definition point in screen coordinates (0,0 is top-left corner)"
},
{
"name": "middleJustified",
"type": "System.Boolean",
"summary": "if True text is centered around the definition point, otherwise it is lower-left justified."
},
{
"name": "height",
"type": "System.Int32",
"summary": "height in pixels (good default is 12)"
}
]
},
{
"signature": "System.Void Draw2dText(System.String text, System.Drawing.Color color, Point2d screenCoordinate, System.Boolean middleJustified)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws 2D text on the viewport.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "System.String",
"summary": "the string to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "text color."
},
{
"name": "screenCoordinate",
"type": "Point2d",
"summary": "definition point in screen coordinates (0,0 is top-left corner)"
},
{
"name": "middleJustified",
"type": "System.Boolean",
"summary": "if True text is centered around the definition point, otherwise it is lower-left justified."
}
]
},
{
"signature": "System.Void Draw2dText(System.String text, System.Drawing.Color color, Point3d worldCoordinate, System.Boolean middleJustified, System.Int32 height, System.String fontface)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws 2D text on the viewport.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "System.String",
"summary": "The string to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Text color."
},
{
"name": "worldCoordinate",
"type": "Point3d",
"summary": "Definition point in world coordinates."
},
{
"name": "middleJustified",
"type": "System.Boolean",
"summary": "If True text is centered around the definition point, otherwise it is lower-left justified."
},
{
"name": "height",
"type": "System.Int32",
"summary": "Height in pixels (good default is 12)."
},
{
"name": "fontface",
"type": "System.String",
"summary": "Font name (good default is \"Arial\")."
}
]
},
{
"signature": "System.Void Draw2dText(System.String text, System.Drawing.Color color, Point3d worldCoordinate, System.Boolean middleJustified, System.Int32 height)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws 2D text on the viewport.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "System.String",
"summary": "the string to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "text color."
},
{
"name": "worldCoordinate",
"type": "Point3d",
"summary": "definition point in world coordinates."
},
{
"name": "middleJustified",
"type": "System.Boolean",
"summary": "if True text is centered around the definition point, otherwise it is lower-left justified."
},
{
"name": "height",
"type": "System.Int32",
"summary": "height in pixels (good default is 12)"
}
]
},
{
"signature": "System.Void Draw2dText(System.String text, System.Drawing.Color color, Point3d worldCoordinate, System.Boolean middleJustified)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws 2D text on the viewport.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "System.String",
"summary": "the string to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "text color."
},
{
"name": "worldCoordinate",
"type": "Point3d",
"summary": "definition point in world coordinates."
},
{
"name": "middleJustified",
"type": "System.Boolean",
"summary": "if True text is centered around the definition point, otherwise it is lower-left justified."
}
]
},
{
"signature": "System.Void Draw3dText(System.String text, System.Drawing.Color color, Plane textPlane, System.Double height, System.String fontface, System.Boolean bold, System.Boolean italic, DocObjects.TextHorizontalAlignment horizontalAlignment, DocObjects.TextVerticalAlignment verticalAlignment)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.4"
},
{
"signature": "System.Void Draw3dText(System.String text, System.Drawing.Color color, Plane textPlane, System.Double height, System.String fontface, System.Boolean bold, System.Boolean italic)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void Draw3dText(System.String text, System.Drawing.Color color, Plane textPlane, System.Double height, System.String fontface)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void Draw3dText(Text3d text, System.Drawing.Color color, Plane textPlane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws 3d text with a different plane than what is defined in the Text3d class.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "Text3d",
"summary": "The string to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Text color."
},
{
"name": "textPlane",
"type": "Plane",
"summary": "The plane for the text object."
}
]
},
{
"signature": "System.Void Draw3dText(Text3d text, System.Drawing.Color color, Point3d textPlaneOrigin)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws 3d text using the Text3d plane with an adjusted origin.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "Text3d",
"summary": "The string to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Text color."
},
{
"name": "textPlaneOrigin",
"type": "Point3d",
"summary": "The origin of the plane to draw."
}
]
},
{
"signature": "System.Void Draw3dText(Text3d text, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void DrawActivePoint(Point3d point)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a point in style used during \"GetPoint\" operations",
"since": "6.0",
"parameters": [
{
"name": "point",
"type": "Point3d",
"summary": "Location of the point in world coordinates"
}
]
},
{
"signature": "System.Void DrawAnnotation(AnnotationBase annotation, DocObjects.RhinoObject parentObject, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws an annotation geometry while evaluating any embedded text fields (e.g. %%, %%) against the supplied parent DocObjects.RhinoObject . Intended for preview conduits that draw a modified copy of an annotation's geometry while the user is editing it — the regular geometry-only overload skips field evaluation because it has no display cache to anchor to.",
"since": "9.0"
},
{
"signature": "System.Void DrawAnnotation(AnnotationBase annotation, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void DrawAnnotationArrowhead(Arrowhead arrowhead, Transform xform, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void DrawArc(Arc arc, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a single arc object.",
"since": "5.0",
"parameters": [
{
"name": "arc",
"type": "Arc",
"summary": "Arc to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of arc."
}
]
},
{
"signature": "System.Void DrawArc(Arc arc, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a single arc object.",
"since": "5.0",
"parameters": [
{
"name": "arc",
"type": "Arc",
"summary": "Arc to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
}
]
},
{
"signature": "System.Void DrawArrow(Line line, System.Double headSize, System.Drawing.Color color, System.Single shaftWidth)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a Grasshopper 2 style vector arrow. This method is relatively slow as it requires the construction of a DisplayPen and a PolylineCurve. However it is more accurate than other arrow drawing methods in that the tip of the drawn arrow is very close to the actual end of the line, the tip is always sharp, and the arrow head is resized to never be too small or large. Also note this method already takes into account logical pixel scaling.",
"parameters": [
{
"name": "line",
"type": "Line",
"summary": "Vector shaft to draw."
},
{
"name": "headSize",
"type": "System.Double",
"summary": "Size of the head as a factor of arrow length. 0.1 would be a decent size."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of arrow geometry."
},
{
"name": "shaftWidth",
"type": "System.Single",
"summary": "Width of arrow geometry. Note that the shaft is drawn using a method which only supports integer thicknesses and the arrow head is drawn thicker to counter the human perception of seeing angled lines thinner than they really are."
}
]
},
{
"signature": "System.Void DrawArrow(Line line, System.Drawing.Color color, System.Double screenSize, System.Double relativeSize)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single arrow object. An arrow consists of a Shaft and an Arrow head at the end of the shaft.",
"since": "5.0",
"parameters": [
{
"name": "line",
"type": "Line",
"summary": "Arrow shaft."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of arrow."
},
{
"name": "screenSize",
"type": "System.Double",
"summary": "If screenSize != 0.0 then the size (in screen pixels) of the arrow head will be equal to screenSize."
},
{
"name": "relativeSize",
"type": "System.Double",
"summary": "If relativeSize != 0.0 and screen size == 0.0 the size of the arrow head will be proportional to the arrow shaft length."
}
]
},
{
"signature": "System.Void DrawArrow(Line line, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single arrow object. An arrow consists of a Shaft and an Arrow head at the end of the shaft.",
"since": "5.0",
"parameters": [
{
"name": "line",
"type": "Line",
"summary": "Arrow shaft."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of arrow."
}
]
},
{
"signature": "System.Void DrawArrowHead(Point3d tip, Vector3d direction, System.Drawing.Color color, System.Double screenSize, System.Double worldSize)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single arrow head.",
"since": "5.0",
"parameters": [
{
"name": "tip",
"type": "Point3d",
"summary": "Point of arrow head tip."
},
{
"name": "direction",
"type": "Vector3d",
"summary": "Direction in which arrow head is pointing."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of arrow head."
},
{
"name": "screenSize",
"type": "System.Double",
"summary": "If screenSize != 0.0, then the size (in screen pixels) of the arrow head will be equal to the screenSize."
},
{
"name": "worldSize",
"type": "System.Double",
"summary": "If worldSize != 0.0 and screen size == 0.0 the size of the arrow head will be equal to the number of units in worldSize."
}
]
},
{
"signature": "System.Void DrawArrows(IEnumerable lines, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a collection of arrow objects. An arrow consists of a Shaft and an Arrow head at the end of the shaft.",
"since": "5.0",
"parameters": [
{
"name": "lines",
"type": "System.Collections.Generic.IEnumerable",
"summary": "Arrow shafts."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of arrows."
}
]
},
{
"signature": "System.Void DrawArrows(Line[] lines, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a collection of arrow objects. An arrow consists of a Shaft and an Arrow head at the end of the shaft.",
"since": "5.0",
"parameters": [
{
"name": "lines",
"type": "Line[]",
"summary": "Arrow shafts."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of arrows."
}
]
},
{
"signature": "System.Void DrawBitmap(DisplayBitmap bitmap, System.Int32 left, System.Int32 top)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a bitmap in screen coordinates",
"since": "5.10",
"parameters": [
{
"name": "bitmap",
"type": "DisplayBitmap",
"summary": "bitmap to draw"
},
{
"name": "left",
"type": "System.Int32",
"summary": "where top/left corner of bitmap should appear in screen coordinates"
},
{
"name": "top",
"type": "System.Int32",
"summary": "where top/left corner of bitmap should appear in screen coordinates"
}
]
},
{
"signature": "System.Void DrawBox(BoundingBox box, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws the edges of a BoundingBox.",
"since": "5.0",
"parameters": [
{
"name": "box",
"type": "BoundingBox",
"summary": "Box to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw in."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of box edges."
}
]
},
{
"signature": "System.Void DrawBox(BoundingBox box, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws the edges of a BoundingBox.",
"since": "5.0",
"parameters": [
{
"name": "box",
"type": "BoundingBox",
"summary": "Box to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw in."
}
]
},
{
"signature": "System.Void DrawBox(Box box, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws the edges of a Box object.",
"since": "5.0",
"parameters": [
{
"name": "box",
"type": "Box",
"summary": "Box to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw in."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of box edges."
}
]
},
{
"signature": "System.Void DrawBox(Box box, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws the edges of a Box object.",
"since": "5.0",
"parameters": [
{
"name": "box",
"type": "Box",
"summary": "Box to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw in."
}
]
},
{
"signature": "System.Void DrawBoxCorners(BoundingBox box, System.Drawing.Color color, System.Double size, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws corner widgets of a world aligned bounding box.",
"since": "5.0",
"parameters": [
{
"name": "box",
"type": "BoundingBox",
"summary": "Box to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
},
{
"name": "size",
"type": "System.Double",
"summary": "Size (in model units) of the corner widgets."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of the corner widgets."
}
]
},
{
"signature": "System.Void DrawBoxCorners(BoundingBox box, System.Drawing.Color color, System.Double size)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws corner widgets of a world aligned bounding box.",
"since": "5.0",
"parameters": [
{
"name": "box",
"type": "BoundingBox",
"summary": "Box to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
},
{
"name": "size",
"type": "System.Double",
"summary": "Size (in model units) of the corner widgets."
}
]
},
{
"signature": "System.Void DrawBoxCorners(BoundingBox box, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws corner widgets of a world aligned bounding box. Widget size will be 5% of the Box diagonal.",
"since": "5.0",
"parameters": [
{
"name": "box",
"type": "BoundingBox",
"summary": "Box to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
}
]
},
{
"signature": "System.Void DrawBrepShaded(Brep brep, DisplayMaterial material)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a shaded mesh representation of a brep.",
"since": "5.0",
"parameters": [
{
"name": "brep",
"type": "Brep",
"summary": "Brep to draw."
},
{
"name": "material",
"type": "DisplayMaterial",
"summary": "Material to draw faces with."
}
]
},
{
"signature": "System.Void DrawBrepWires(Brep brep, System.Drawing.Color color, System.Int32 wireDensity)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws all the wireframe curves of a brep object.",
"since": "5.0",
"parameters": [
{
"name": "brep",
"type": "Brep",
"summary": "Brep to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of Wireframe curves."
},
{
"name": "wireDensity",
"type": "System.Int32",
"summary": "\"Density\" of wireframe curves. \n-1 = no internal wires. \n0 = default internal wires. \n>0 = custom high density."
}
]
},
{
"signature": "System.Void DrawBrepWires(Brep brep, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws all the wireframe curves of a brep object.",
"since": "5.0",
"parameters": [
{
"name": "brep",
"type": "Brep",
"summary": "Brep to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of Wireframe curves."
}
]
},
{
"signature": "System.Void DrawCircle(Circle circle, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a single circle object.",
"since": "5.0",
"parameters": [
{
"name": "circle",
"type": "Circle",
"summary": "Circle to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of circle."
}
]
},
{
"signature": "System.Void DrawCircle(Circle circle, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a single circle object.",
"since": "5.0",
"parameters": [
{
"name": "circle",
"type": "Circle",
"summary": "Circle to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
}
]
},
{
"signature": "System.Void DrawClippingPlaneWires(ClippingPlaneSurface clippingPlane, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a cipping plane",
"since": "9.0"
},
{
"signature": "System.Void DrawCone(Cone cone, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a wireframe cone.",
"since": "5.0",
"parameters": [
{
"name": "cone",
"type": "Cone",
"summary": "Cone to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of Cone wires."
}
]
},
{
"signature": "System.Void DrawCone(Cone cone, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a wireframe cone.",
"since": "5.0",
"parameters": [
{
"name": "cone",
"type": "Cone",
"summary": "Cone to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
}
]
},
{
"signature": "System.Void DrawConstructionPlane(DocObjects.ConstructionPlane constructionPlane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a construction plane.",
"since": "5.0",
"parameters": [
{
"name": "constructionPlane",
"type": "DocObjects.ConstructionPlane",
"summary": "The construction plane to draw."
}
]
},
{
"signature": "System.Void DrawCurvatureGraph(Curve curve, System.Drawing.Color color, System.Int32 hairScale, System.Int32 hairDensity, System.Int32 sampleDensity)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a typical Rhino Curvature Graph.",
"since": "5.0",
"parameters": [
{
"name": "curve",
"type": "Curve",
"summary": "Base curve for curvature graph."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of curvature graph."
},
{
"name": "hairScale",
"type": "System.Int32",
"summary": "100 = True length, > 100 magnified, < 100 shortened."
},
{
"name": "hairDensity",
"type": "System.Int32",
"summary": ">= 0 larger numbers = more hairs (good default is 1)."
},
{
"name": "sampleDensity",
"type": "System.Int32",
"summary": "Between 1 and 10. Higher numbers draw smoother outer curves. (good default is 2)."
}
]
},
{
"signature": "System.Void DrawCurvatureGraph(Curve curve, System.Drawing.Color color, System.Int32 hairScale)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a typical Rhino Curvature Graph.",
"since": "5.0",
"parameters": [
{
"name": "curve",
"type": "Curve",
"summary": "Base curve for curvature graph."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of curvature graph."
},
{
"name": "hairScale",
"type": "System.Int32",
"summary": "100 = True length, > 100 magnified, < 100 shortened."
}
]
},
{
"signature": "System.Void DrawCurvatureGraph(Curve curve, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a typical Rhino Curvature Graph.",
"since": "5.0",
"parameters": [
{
"name": "curve",
"type": "Curve",
"summary": "Base curve for curvature graph."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of curvature graph."
}
]
},
{
"signature": "System.Void DrawCurvaturePreview(Brep brep, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a Brep in Curvature Analysis preview.",
"since": "9.0",
"parameters": [
{
"name": "brep",
"type": "Brep",
"summary": "Brep to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Objct color."
}
]
},
{
"signature": "System.Void DrawCurvaturePreview(Mesh mesh, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a Mesh in Curvature Analysis preview.",
"since": "9.0",
"parameters": [
{
"name": "mesh",
"type": "Mesh",
"summary": "Mesh to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Objct color."
}
]
},
{
"signature": "System.Void DrawCurve(Curve curve, DisplayPen pen)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void DrawCurve(Curve curve, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a single Curve object.",
"since": "5.0",
"parameters": [
{
"name": "curve",
"type": "Curve",
"summary": "Curve to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of curve."
}
]
},
{
"signature": "System.Void DrawCurve(Curve curve, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a single Curve object.",
"since": "5.0",
"parameters": [
{
"name": "curve",
"type": "Curve",
"summary": "Curve to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
}
]
},
{
"signature": "System.Void DrawCylinder(Cylinder cylinder, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a wireframe cylinder.",
"since": "5.0",
"parameters": [
{
"name": "cylinder",
"type": "Cylinder",
"summary": "Cylinder to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of cylinder wires."
}
]
},
{
"signature": "System.Void DrawCylinder(Cylinder cylinder, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a wireframe cylinder.",
"since": "5.0",
"parameters": [
{
"name": "cylinder",
"type": "Cylinder",
"summary": "Cylinder to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
}
]
},
{
"signature": "System.Void DrawDirectionArrow(Point3d location, Vector3d direction, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void DrawDot(Point3d worldPosition, System.String text, System.Drawing.Color dotColor, System.Drawing.Color textColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a text dot in world coordinates.",
"since": "5.0",
"parameters": [
{
"name": "worldPosition",
"type": "Point3d",
"summary": "Location of dot in world coordinates."
},
{
"name": "text",
"type": "System.String",
"summary": "Text content of dot."
},
{
"name": "dotColor",
"type": "System.Drawing.Color",
"summary": "Dot background color."
},
{
"name": "textColor",
"type": "System.Drawing.Color",
"summary": "Dot foreground color."
}
]
},
{
"signature": "System.Void DrawDot(Point3d worldPosition, System.String text)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a text dot in world coordinates.",
"since": "5.0",
"parameters": [
{
"name": "worldPosition",
"type": "Point3d",
"summary": "Location of dot in world coordinates."
},
{
"name": "text",
"type": "System.String",
"summary": "Text content of dot."
}
]
},
{
"signature": "System.Void DrawDot(System.Single screenX, System.Single screenY, System.String text, System.Drawing.Color dotColor, System.Drawing.Color textColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a text dot in screen coordinates.",
"since": "6.0",
"parameters": [
{
"name": "screenX",
"type": "System.Single",
"summary": "X coordinate (in pixels) of dot center."
},
{
"name": "screenY",
"type": "System.Single",
"summary": "Y coordinate (in pixels) of dot center."
},
{
"name": "text",
"type": "System.String",
"summary": "Text content of dot."
},
{
"name": "dotColor",
"type": "System.Drawing.Color",
"summary": "Dot background color."
},
{
"name": "textColor",
"type": "System.Drawing.Color",
"summary": "Dot foreground color."
}
]
},
{
"signature": "System.Void DrawDot(System.Single screenX, System.Single screenY, System.String text)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a text dot in screen coordinates.",
"since": "6.0",
"parameters": [
{
"name": "screenX",
"type": "System.Single",
"summary": "X coordinate (in pixels) of dot center."
},
{
"name": "screenY",
"type": "System.Single",
"summary": "Y coordinate (in pixels) of dot center."
},
{
"name": "text",
"type": "System.String",
"summary": "Text content of dot."
}
]
},
{
"signature": "System.Void DrawDot(TextDot dot, System.Drawing.Color fillColor, System.Drawing.Color textColor, System.Drawing.Color borderColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a text dot as defined by the text dot class",
"since": "6.0"
},
{
"signature": "System.Void DrawDottedLine(Line line, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single dotted line.",
"since": "5.0",
"parameters": [
{
"name": "line",
"type": "Line",
"summary": "Line to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of line."
}
]
},
{
"signature": "System.Void DrawDottedLine(Point3d from, Point3d to, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single dotted line.",
"since": "5.0",
"parameters": [
{
"name": "from",
"type": "Point3d",
"summary": "Line start point."
},
{
"name": "to",
"type": "Point3d",
"summary": "Line end point."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of line."
}
]
},
{
"signature": "System.Void DrawDottedPolyline(IEnumerable points, System.Drawing.Color color, System.Boolean close)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a set of connected lines (polyline) in a dotted pattern (0x00001111).",
"since": "5.0",
"parameters": [
{
"name": "points",
"type": "System.Collections.Generic.IEnumerable",
"summary": "End points of each line segment."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of polyline."
},
{
"name": "close",
"type": "System.Boolean",
"summary": "Draw a line between the first and last points."
}
]
},
{
"signature": "System.Void DrawDraftAnglePreview(Brep brep, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a Brep in Draft Angle preview.",
"since": "9.0",
"parameters": [
{
"name": "brep",
"type": "Brep",
"summary": "Brep to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Objct color."
}
]
},
{
"signature": "System.Void DrawDraftAnglePreview(Mesh mesh, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a Mesh in Draft Angle preview.",
"since": "9.0",
"parameters": [
{
"name": "mesh",
"type": "Mesh",
"summary": "Mesh to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Objct color."
}
]
},
{
"signature": "System.Void DraweInferencePoint(Point3d P, Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw inference point used in gesture based snapping",
"since": "8.17",
"parameters": [
{
"name": "P",
"type": "Point3d",
"summary": "Location of point in world coordinates"
},
{
"name": "color",
"type": "Color",
"summary": "Color of the point"
}
]
},
{
"signature": "System.Void DrawEmapPreview(Brep brep, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a Brep in Environment Map preview.",
"since": "9.0",
"parameters": [
{
"name": "brep",
"type": "Brep",
"summary": "Brep to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Objct color."
}
]
},
{
"signature": "System.Void DrawEmapPreview(Mesh mesh, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a Mesh in Environment Map preview.",
"since": "9.0",
"parameters": [
{
"name": "mesh",
"type": "Mesh",
"summary": "Mesh to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Objct color."
}
]
},
{
"signature": "System.Void DrawExtrusionWires(Extrusion extrusion, System.Drawing.Color color, System.Int32 wireDensity)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws all the wireframe curves of an extrusion object.",
"since": "6.0",
"parameters": [
{
"name": "extrusion",
"type": "Extrusion",
"summary": "Extrusion to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of Wireframe curves."
},
{
"name": "wireDensity",
"type": "System.Int32",
"summary": "\"Density\" of wireframe curves. \n-1 = no internal wires. \n0 = default internal wires. \n>0 = custom high density."
}
]
},
{
"signature": "System.Void DrawExtrusionWires(Extrusion extrusion, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws all the wireframe curves of an extrusion object.",
"since": "6.0",
"parameters": [
{
"name": "extrusion",
"type": "Extrusion",
"summary": "Extrusion to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of Wireframe curves."
}
]
},
{
"signature": "System.Void DrawGradientHatch(Hatch hatch, IEnumerable stops, Point3d point1, Point3d point2, System.Boolean linearGradient, System.Single repeat, DisplayPen boundary, System.Drawing.Color backgroundFillColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void DrawGradientHatch(Hatch hatch, IEnumerable stops, Point3d point1, Point3d point2, System.Boolean linearGradient, System.Single repeat, System.Single boundaryThickness, System.Drawing.Color boundaryColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "System.Void DrawGradientHatch(Hatch hatch, System.Drawing.Color color1, System.Drawing.Color color2, Point3d point1, Point3d point2, System.Boolean linearGradient, System.Single boundaryThickness, System.Drawing.Color boundaryColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a two point gradient filled hatch",
"since": "7.0"
},
{
"signature": "System.Void DrawGradientLines(IEnumerable lines, System.Single strokeWidth, IEnumerable stops, Point3d point1, Point3d point2, System.Boolean linearGradient, System.Single repeat)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "System.Void DrawGradientMesh(Mesh mesh, IEnumerable stops, Point3d point1, Point3d point2, System.Boolean linearGradient, System.Single repeat)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "System.Void DrawHatch(Hatch hatch, System.Drawing.Color hatchColor, DisplayPen boundary, System.Drawing.Color backgroundFillColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void DrawHatch(Hatch hatch, System.Drawing.Color hatchColor, System.Drawing.Color boundaryColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void DrawInferenceLine(Point3d P, Point3d O, Color color, InferenceLineType type)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw an inference line used in gesture based snapping",
"since": "8.17",
"parameters": [
{
"name": "P",
"type": "Point3d",
"summary": "First point used to define the line in world coordinates"
},
{
"name": "O",
"type": "Point3d",
"summary": "Second point used to define the line in world coordinates"
},
{
"name": "color",
"type": "Color",
"summary": "Color of line"
},
{
"name": "type",
"type": "InferenceLineType",
"summary": "Type of line InferenceLineType"
}
]
},
{
"signature": "System.Void DrawInstanceDefinition(DocObjects.InstanceDefinition instanceDefinition, Transform xform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws an DocObjects.InstanceDefinition .",
"since": "7.15",
"parameters": [
{
"name": "instanceDefinition",
"type": "DocObjects.InstanceDefinition",
"summary": "The instance definition."
},
{
"name": "xform",
"type": "Transform",
"summary": "The transformation."
}
]
},
{
"signature": "System.Void DrawInstanceDefinition(DocObjects.InstanceDefinition instanceDefinition)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws an DocObjects.InstanceDefinition .",
"since": "7.15",
"parameters": [
{
"name": "instanceDefinition",
"type": "DocObjects.InstanceDefinition",
"summary": "The instance definition."
}
]
},
{
"signature": "System.Void DrawInstanceDefinitionShaded(DocObjects.InstanceDefinition instanceDefinition, DisplayMaterial material, Transform xform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a shaded DocObjects.InstanceDefinition .",
"since": "7.15",
"parameters": [
{
"name": "instanceDefinition",
"type": "DocObjects.InstanceDefinition",
"summary": "The instance definition."
},
{
"name": "material",
"type": "DisplayMaterial",
"summary": "Material to draw faces with."
},
{
"name": "xform",
"type": "Transform",
"summary": "The transformation."
}
]
},
{
"signature": "System.Void DrawInstanceDefinitionShaded(DocObjects.InstanceDefinition instanceDefinition, DisplayMaterial material)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a shaded DocObjects.InstanceDefinition .",
"since": "7.15",
"parameters": [
{
"name": "instanceDefinition",
"type": "DocObjects.InstanceDefinition",
"summary": "The instance definition."
},
{
"name": "material",
"type": "DisplayMaterial",
"summary": "Material to draw faces with."
}
]
},
{
"signature": "System.Void DrawLight(Light light, System.Drawing.Color wireframeColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a light.",
"since": "8.4",
"parameters": [
{
"name": "light",
"type": "Light",
"summary": "The light to draw."
},
{
"name": "wireframeColor",
"type": "System.Drawing.Color",
"summary": "The wireframe color."
}
]
},
{
"signature": "System.Void DrawLine(Line line, DisplayPen pen)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void DrawLine(Line line, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single line object.",
"since": "5.0",
"parameters": [
{
"name": "line",
"type": "Line",
"summary": "Line to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw line in."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of line."
}
]
},
{
"signature": "System.Void DrawLine(Line line, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single line object.",
"since": "5.0",
"parameters": [
{
"name": "line",
"type": "Line",
"summary": "Line to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw line in."
}
]
},
{
"signature": "System.Void DrawLine(Point3d from, Point3d to, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single line object.",
"since": "5.0",
"parameters": [
{
"name": "from",
"type": "Point3d",
"summary": "Line from point."
},
{
"name": "to",
"type": "Point3d",
"summary": "Line to point."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw line in."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of line."
}
]
},
{
"signature": "System.Void DrawLine(Point3d from, Point3d to, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single line object.",
"since": "5.0",
"parameters": [
{
"name": "from",
"type": "Point3d",
"summary": "Line from point."
},
{
"name": "to",
"type": "Point3d",
"summary": "Line to point."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw line in."
}
]
},
{
"signature": "System.Void DrawLineArrow(Line line, System.Drawing.Color color, System.Int32 thickness, System.Double size)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws an arrow made up of three line segments.",
"since": "5.0",
"parameters": [
{
"name": "line",
"type": "Line",
"summary": "Base line for arrow."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of arrow."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of the arrow line segments."
},
{
"name": "size",
"type": "System.Double",
"summary": "Size (in world units) of the arrow tip lines."
}
]
},
{
"signature": "System.Void DrawLineNoClip(Point3d from, Point3d to, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single line object .This version of line drawing will draw the segments of the line that extend beyond the near and far planes of the view frustum with depths on those planes",
"since": "7.1",
"parameters": [
{
"name": "from",
"type": "Point3d",
"summary": "Line from point."
},
{
"name": "to",
"type": "Point3d",
"summary": "Line to point."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw line in."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of line."
}
]
},
{
"signature": "System.Void DrawLines(IEnumerable lines, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a set of lines with a given color and thickness. If you want the fastest possible set of lines to be drawn, pass a Line[] for lines.",
"since": "5.0",
"parameters": [
{
"name": "lines",
"type": "System.Collections.Generic.IEnumerable",
"summary": "Lines to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of lines."
}
]
},
{
"signature": "System.Void DrawLines(IEnumerable lines, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a set of lines with a given color and thickness. If you want the fastest possible set of lines to be drawn, pass a Line[] for lines.",
"since": "5.0",
"parameters": [
{
"name": "lines",
"type": "System.Collections.Generic.IEnumerable",
"summary": "Lines to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
}
]
},
{
"signature": "System.Void DrawLines(Line[] lines, DisplayPen pen)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void DrawLinesNoClip(IEnumerable lines, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a multiple lines. This version of line drawing will draw the segments of the line that extend beyond the near and far planes of the view frustum with depths on those planes",
"since": "8.15",
"parameters": [
{
"name": "lines",
"type": "System.Collections.Generic.IEnumerable",
"summary": "the lines to draw"
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw lines in"
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of lines"
}
]
},
{
"signature": "System.Void DrawMarker(Point3d tip, Vector3d direction, System.Drawing.Color color, System.Int32 thickness, System.Double size, System.Double rotation)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws an arrow marker as a view-aligned widget.",
"since": "5.0",
"parameters": [
{
"name": "tip",
"type": "Point3d",
"summary": "Location of arrow tip point."
},
{
"name": "direction",
"type": "Vector3d",
"summary": "Direction of arrow."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of arrow widget."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness of arrow widget lines."
},
{
"name": "size",
"type": "System.Double",
"summary": "Size (in pixels) of the arrow shaft."
},
{
"name": "rotation",
"type": "System.Double",
"summary": "Rotational angle adjustment (in radians, counter-clockwise of direction."
}
]
},
{
"signature": "System.Void DrawMarker(Point3d tip, Vector3d direction, System.Drawing.Color color, System.Int32 thickness, System.Double size)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws an arrow marker as a view-aligned widget.",
"since": "5.0",
"parameters": [
{
"name": "tip",
"type": "Point3d",
"summary": "Location of arrow tip point."
},
{
"name": "direction",
"type": "Vector3d",
"summary": "Direction of arrow."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of arrow widget."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness of arrow widget lines."
},
{
"name": "size",
"type": "System.Double",
"summary": "Size (in pixels) of the arrow shaft."
}
]
},
{
"signature": "System.Void DrawMarker(Point3d tip, Vector3d direction, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws an arrow marker as a view-aligned widget.",
"since": "5.0",
"parameters": [
{
"name": "tip",
"type": "Point3d",
"summary": "Location of arrow tip point."
},
{
"name": "direction",
"type": "Vector3d",
"summary": "Direction of arrow."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of arrow widget."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness of arrow widget lines."
}
]
},
{
"signature": "System.Void DrawMarker(Point3d tip, Vector3d direction, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws an arrow marker as a view-aligned widget.",
"since": "5.0",
"parameters": [
{
"name": "tip",
"type": "Point3d",
"summary": "Location of arrow tip point."
},
{
"name": "direction",
"type": "Vector3d",
"summary": "Direction of arrow."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of arrow widget."
}
]
},
{
"signature": "System.Void DrawMeshFalseColors(Mesh mesh)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws the mesh faces as False color patches. The mesh must have Vertex Colors defined for this to work.",
"since": "5.0",
"parameters": [
{
"name": "mesh",
"type": "Mesh",
"summary": "Mesh to draw."
}
]
},
{
"signature": "System.Void DrawMeshShaded(Mesh mesh, Color diffuseMaterialColor, IsoDrawEffect zebraSettings)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws shaded mesh with isodraw settings applied (zebra)",
"since": "9.0"
},
{
"signature": "System.Void DrawMeshShaded(Mesh mesh, DisplayMaterial material, IEnumerable faceIndices)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws the shaded faces of a given mesh.",
"since": "8.20",
"parameters": [
{
"name": "mesh",
"type": "Mesh",
"summary": "Mesh to draw."
},
{
"name": "material",
"type": "DisplayMaterial",
"summary": "Material to draw faces with."
},
{
"name": "faceIndices",
"type": "IEnumerable",
"summary": "An enumeration of the indices of specific faces to draw."
}
]
},
{
"signature": "System.Void DrawMeshShaded(Mesh mesh, DisplayMaterial material, System.Int32[] faceIndices)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws the shaded faces of a given mesh.",
"since": "5.0",
"parameters": [
{
"name": "mesh",
"type": "Mesh",
"summary": "Mesh to draw."
},
{
"name": "material",
"type": "DisplayMaterial",
"summary": "Material to draw faces with."
},
{
"name": "faceIndices",
"type": "System.Int32[]",
"summary": "Indices of specific faces to draw."
}
]
},
{
"signature": "System.Void DrawMeshShaded(Mesh mesh, DisplayMaterial material)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws the shaded faces of a given mesh.",
"since": "5.0",
"parameters": [
{
"name": "mesh",
"type": "Mesh",
"summary": "Mesh to draw."
},
{
"name": "material",
"type": "DisplayMaterial",
"summary": "Material to draw faces with."
}
]
},
{
"signature": "System.Void DrawMeshVertices(Mesh mesh, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws all the vertices in a given mesh.",
"since": "5.0",
"parameters": [
{
"name": "mesh",
"type": "Mesh",
"summary": "Mesh for vertex drawing."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of mesh vertices."
}
]
},
{
"signature": "System.Void DrawMeshWires(Mesh mesh, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws all the wires in a given mesh.",
"since": "5.0",
"parameters": [
{
"name": "mesh",
"type": "Mesh",
"summary": "Mesh for wire drawing."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of mesh wires."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of mesh wires."
}
]
},
{
"signature": "System.Void DrawMeshWires(Mesh mesh, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws all the wires in a given mesh.",
"since": "5.0",
"parameters": [
{
"name": "mesh",
"type": "Mesh",
"summary": "Mesh for wire drawing."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of mesh wires."
}
]
},
{
"signature": "System.Void DrawObject(DocObjects.RhinoObject rhinoObject, Transform xform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a DocObjects.RhinoObject with an applied transformation.",
"since": "5.0",
"parameters": [
{
"name": "rhinoObject",
"type": "DocObjects.RhinoObject",
"summary": "The Rhino object."
},
{
"name": "xform",
"type": "Transform",
"summary": "The transformation."
}
]
},
{
"signature": "System.Void DrawObject(DocObjects.RhinoObject rhinoObject)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a DocObjects.RhinoObject .",
"since": "5.0",
"parameters": [
{
"name": "rhinoObject",
"type": "DocObjects.RhinoObject",
"summary": "The Rhino object."
}
]
},
{
"signature": "System.Void DrawParticles(ParticleSystem particles, DisplayBitmap bitmap)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void DrawParticles(ParticleSystem particles, DisplayBitmap[] bitmaps)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void DrawParticles(ParticleSystem particles)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void DrawPatternedLine(Line line, System.Drawing.Color color, System.Int32 pattern, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single line with specified pattern.",
"since": "6.0",
"parameters": [
{
"name": "line",
"type": "Line",
"summary": "Line to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of line."
},
{
"name": "pattern",
"type": "System.Int32",
"summary": "Pattern of the line (like 0x00001111 for dotted line)."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of lines."
}
]
},
{
"signature": "System.Void DrawPatternedLine(Point3d from, Point3d to, System.Drawing.Color color, System.Int32 pattern, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single line with specified pattern.",
"since": "6.0",
"parameters": [
{
"name": "from",
"type": "Point3d",
"summary": "Line start point."
},
{
"name": "to",
"type": "Point3d",
"summary": "Line end point."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of line."
},
{
"name": "pattern",
"type": "System.Int32",
"summary": "Pattern of the line (like 0x00001111 for dotted line)."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of lines."
}
]
},
{
"signature": "System.Void DrawPatternedPolyline(IEnumerable points, System.Drawing.Color color, System.Int32 pattern, System.Int32 thickness, System.Boolean close)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a set of connected lines (polyline) with specified pattern.",
"since": "6.0",
"parameters": [
{
"name": "points",
"type": "System.Collections.Generic.IEnumerable",
"summary": "End points of each line segment."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of polyline."
},
{
"name": "pattern",
"type": "System.Int32",
"summary": "Pattern to use for the line (like 0x00001111 for dotted)."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of lines."
},
{
"name": "close",
"type": "System.Boolean",
"summary": "Draw a line between the first and last points."
}
]
},
{
"signature": "System.Void DrawPoint(Point3d point, PointStyle style, System.Drawing.Color strokeColor, System.Drawing.Color fillColor, System.Single radius, System.Single strokeWidth, System.Single secondarySize, System.Single rotationRadians, System.Boolean diameterIsInPixels, System.Boolean autoScaleForDpi)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void DrawPoint(Point3d point, PointStyle style, System.Int32 radius, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a point with a given radius, style and color.",
"since": "5.0",
"parameters": [
{
"name": "point",
"type": "Point3d",
"summary": "Location of point in world coordinates."
},
{
"name": "style",
"type": "PointStyle",
"summary": "Point display style."
},
{
"name": "radius",
"type": "System.Int32",
"summary": "Point size in pixels."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of point. If style is ControlPoint, this will be the border color."
}
]
},
{
"signature": "System.Void DrawPoint(Point3d point, PointStyle style, System.Single radius, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a point with a given radius, style and color.",
"since": "6.0",
"parameters": [
{
"name": "point",
"type": "Point3d",
"summary": "Location of point in world coordinates."
},
{
"name": "style",
"type": "PointStyle",
"summary": "Point display style."
},
{
"name": "radius",
"type": "System.Single",
"summary": "Point size in pixels."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of point. If style is ControlPoint, this will be the border color."
}
]
},
{
"signature": "System.Void DrawPoint(Point3d point, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a point with a given radius, style and color.",
"since": "5.0",
"parameters": [
{
"name": "point",
"type": "Point3d",
"summary": "Location of point in world coordinates."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of point."
}
]
},
{
"signature": "System.Void DrawPoint(Point3d point)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a point using the current display attribute size, style and color",
"since": "6.0",
"parameters": [
{
"name": "point",
"type": "Point3d",
"summary": "Location of point in world coordinates."
}
]
},
{
"signature": "System.Void DrawPointCloud(PointCloud cloud, System.Int32 size, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a point cloud.",
"since": "5.0",
"parameters": [
{
"name": "cloud",
"type": "PointCloud",
"summary": "Point cloud to draw."
},
{
"name": "size",
"type": "System.Int32",
"summary": "Size of points."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of points in the cloud, if the cloud has a color array this setting is ignored."
}
]
},
{
"signature": "System.Void DrawPointCloud(PointCloud cloud, System.Int32 size)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a point cloud.",
"since": "5.0",
"parameters": [
{
"name": "cloud",
"type": "PointCloud",
"summary": "Point cloud to draw, if the cloud has a color array, it will be used, otherwise the points will be black."
},
{
"name": "size",
"type": "System.Int32",
"summary": "Size of points."
}
]
},
{
"signature": "System.Void DrawPointCloud(PointCloud cloud, System.Single size, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a point cloud.",
"since": "6.0",
"parameters": [
{
"name": "cloud",
"type": "PointCloud",
"summary": "Point cloud to draw."
},
{
"name": "size",
"type": "System.Single",
"summary": "Size of points."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of points in the cloud, if the cloud has a color array this setting is ignored."
}
]
},
{
"signature": "System.Void DrawPointCloud(PointCloud cloud, System.Single size)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a point cloud.",
"since": "6.0",
"parameters": [
{
"name": "cloud",
"type": "PointCloud",
"summary": "Point cloud to draw, if the cloud has a color array, it will be used, otherwise the points will be black."
},
{
"name": "size",
"type": "System.Single",
"summary": "Size of points."
}
]
},
{
"signature": "System.Void DrawPoints(DisplayPointSet points, DisplayPointAttributes fallbackAttributes, DisplayPointAttributes overrideAttributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void DrawPoints(DisplayPointSet points)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void DrawPoints(IEnumerable points, PointStyle style, System.Drawing.Color strokeColor, System.Drawing.Color fillColor, System.Single radius, System.Single strokeWidth, System.Single secondarySize, System.Single rotationRadians, System.Boolean diameterIsInPixels, System.Boolean autoScaleForDpi)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void DrawPoints(IEnumerable points, PointStyle style, System.Int32 radius, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a set of points with a given radius, style and color.",
"since": "5.0",
"parameters": [
{
"name": "points",
"type": "System.Collections.Generic.IEnumerable",
"summary": "Location of points in world coordinates."
},
{
"name": "style",
"type": "PointStyle",
"summary": "Point display style."
},
{
"name": "radius",
"type": "System.Int32",
"summary": "Point size in pixels."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of points. If style is ControlPoint, this will be the border color."
}
]
},
{
"signature": "System.Void DrawPoints(IEnumerable points, PointStyle style, System.Single radius, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a set of points with a given radius, style and color.",
"since": "6.0",
"parameters": [
{
"name": "points",
"type": "System.Collections.Generic.IEnumerable",
"summary": "Location of points in world coordinates."
},
{
"name": "style",
"type": "PointStyle",
"summary": "Point display style."
},
{
"name": "radius",
"type": "System.Single",
"summary": "Point size in pixels."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color of points. If style is ControlPoint, this will be the border color."
}
]
},
{
"signature": "System.Void DrawPolygon(IEnumerable points, System.Drawing.Color color, System.Boolean filled)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a filled, convex polygon from a collection of points.",
"since": "5.0",
"parameters": [
{
"name": "points",
"type": "System.Collections.Generic.IEnumerable",
"summary": "Collection of world coordinate points that are connected by lines to form a closed shape. Collection must contain at least 3 points."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
},
{
"name": "filled",
"type": "System.Boolean",
"summary": "True if the closed area should be filled with color. False if you want to draw just the border of the closed shape."
}
]
},
{
"signature": "System.Void DrawPolyline(IEnumerable polyline, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single Polyline object.",
"since": "5.0",
"parameters": [
{
"name": "polyline",
"type": "System.Collections.Generic.IEnumerable",
"summary": "Polyline to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw in."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of the Polyline."
}
]
},
{
"signature": "System.Void DrawPolyline(IEnumerable polyline, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a single Polyline object.",
"since": "5.0",
"parameters": [
{
"name": "polyline",
"type": "System.Collections.Generic.IEnumerable",
"summary": "Polyline to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw in."
}
]
},
{
"signature": "System.Void DrawRoundedRectangle(System.Drawing.PointF center, System.Single pixelWidth, System.Single pixelHeight, System.Single cornerRadius, System.Drawing.Color strokeColor, System.Single strokeWidth, System.Drawing.Color fillColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void DrawSphere(Sphere sphere, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a wireframe sphere.",
"since": "5.0",
"parameters": [
{
"name": "sphere",
"type": "Sphere",
"summary": "Sphere to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of Sphere wires."
}
]
},
{
"signature": "System.Void DrawSphere(Sphere sphere, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a wireframe sphere.",
"since": "5.0",
"parameters": [
{
"name": "sphere",
"type": "Sphere",
"summary": "Sphere to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
}
]
},
{
"signature": "System.Void DrawSprite(DisplayBitmap bitmap, Point2d screenLocation, System.Single size, System.Drawing.Color blendColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void DrawSprite(DisplayBitmap bitmap, Point2d screenLocation, System.Single width, System.Single height)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw screen oriented image centered at 2d screen location",
"since": "7.0"
},
{
"signature": "System.Void DrawSprite(DisplayBitmap bitmap, Point2d screenLocation, System.Single size)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void DrawSprite(DisplayBitmap bitmap, Point3d worldLocation, System.Single size, System.Boolean sizeInWorldSpace)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void DrawSprite(DisplayBitmap bitmap, Point3d worldLocation, System.Single size, System.Drawing.Color blendColor, System.Boolean sizeInWorldSpace)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void DrawSprites(DisplayBitmap bitmap, DisplayBitmapDrawList items, System.Single size, System.Boolean sizeInWorldSpace)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void DrawSprites(DisplayBitmap bitmap, DisplayBitmapDrawList items, System.Single size, Vector3d translation, System.Boolean sizeInWorldSpace)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean DrawStereoFrameBuffer(DocObjects.ViewportInfo viewportLeft, DocObjects.ViewportInfo viewportRight, out System.UInt32 handleLeft, out System.UInt32 handleRight)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws the viewport as seen from the left and the right eye viewports and returns the result as OpenGL texture handles.",
"since": "6.8",
"parameters": [
{
"name": "viewportLeft",
"type": "DocObjects.ViewportInfo",
"summary": "The viewport representing the left eye location and look direction."
},
{
"name": "viewportRight",
"type": "DocObjects.ViewportInfo",
"summary": "The viewport representing the right eye location and look direction."
},
{
"name": "handleLeft",
"type": "System.UInt32",
"summary": "Will contain the OpenGL texture handle which references the left output color buffer."
},
{
"name": "handleRight",
"type": "System.UInt32",
"summary": "Will contain the OpenGL texture handle which references the right output color buffer."
}
],
"returns": "True if drawing succeeded, False otherwise."
},
{
"signature": "System.Void DrawSubDShaded(SubD subd, DisplayMaterial material)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a shaded mesh representation of a SubD",
"since": "7.0",
"parameters": [
{
"name": "subd",
"type": "SubD",
"summary": "SubD to draw"
},
{
"name": "material",
"type": "DisplayMaterial",
"summary": "Material to draw faces with"
}
]
},
{
"signature": "System.Void DrawSubDWires(SubD subd, DisplayPen boundaryPen, DisplayPen smoothInteriorPen, DisplayPen creasePen, DisplayPen nonmanifoldPen)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws all the wireframe curves os a SubD object using different pens",
"since": "8.11",
"parameters": [
{
"name": "subd",
"type": "SubD",
"summary": "SubD to draw"
},
{
"name": "boundaryPen",
"type": "DisplayPen",
"summary": "Pen to use for boundary wires. If null, no boundary wires will be drawn"
},
{
"name": "smoothInteriorPen",
"type": "DisplayPen",
"summary": "Pen to use for smooth interior wires. If null, no smooth interior wires will be drawn"
},
{
"name": "creasePen",
"type": "DisplayPen",
"summary": "Pen to use for crease wires. If null, no crease wires will be drawn"
},
{
"name": "nonmanifoldPen",
"type": "DisplayPen",
"summary": "Pen to use for non-manifold wires. If null, no non-manifold wires will be drawn"
}
]
},
{
"signature": "System.Void DrawSubDWires(SubD subd, System.Drawing.Color color, System.Single thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws all the wireframe curves of a SubD object",
"since": "7.0",
"parameters": [
{
"name": "subd",
"type": "SubD",
"summary": "SubD to draw"
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "wire color"
},
{
"name": "thickness",
"type": "System.Single",
"summary": "wire thickness"
}
]
},
{
"signature": "System.Void DrawSurface(Surface surface, System.Drawing.Color wireColor, System.Int32 wireDensity)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw wireframe display for a single surface.",
"since": "5.0",
"parameters": [
{
"name": "surface",
"type": "Surface",
"summary": "Surface to draw."
},
{
"name": "wireColor",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
},
{
"name": "wireDensity",
"type": "System.Int32",
"summary": "Thickness (in pixels) or wires to draw."
}
]
},
{
"signature": "System.Void DrawSurfaceDirectionIndicators(SurfaceDirectionIndicators directionIndicators)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw surface indicators"
},
{
"signature": "System.Void DrawText(TextEntity text, System.Drawing.Color color, System.Double scale)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void DrawText(TextEntity text, System.Drawing.Color color, Transform xform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void DrawText(TextEntity text, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void DrawTorus(Torus torus, System.Drawing.Color color, System.Int32 thickness)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a wireframe torus.",
"since": "5.0",
"parameters": [
{
"name": "torus",
"type": "Torus",
"summary": "Torus to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
},
{
"name": "thickness",
"type": "System.Int32",
"summary": "Thickness (in pixels) of torus wires."
}
]
},
{
"signature": "System.Void DrawTorus(Torus torus, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw a wireframe torus.",
"since": "5.0",
"parameters": [
{
"name": "torus",
"type": "Torus",
"summary": "Torus to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Color to draw with."
}
]
},
{
"signature": "System.Void DrawZebraPreview(Brep brep, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a shaded Brep with Zebra stripe preview.",
"since": "6.16",
"parameters": [
{
"name": "brep",
"type": "Brep",
"summary": "Brep to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Object color."
}
]
},
{
"signature": "System.Void DrawZebraPreview(Mesh mesh, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws a shaded Mesh with Zebra stripe preview.",
"since": "7.4",
"parameters": [
{
"name": "mesh",
"type": "Mesh",
"summary": "Mesh to draw."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "Object color."
}
]
},
{
"signature": "System.Void EnableClippingPlanes(System.Boolean enable)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Enable or disable the Clipping Plane logic of the engine.",
"since": "5.0",
"parameters": [
{
"name": "enable",
"type": "System.Boolean",
"summary": "True to enable Clipping Planes, False to disable."
}
]
},
{
"signature": "System.Void EnableColorWriting(System.Boolean enable)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Enable or disable the ColorWriting behavior of the engine.",
"since": "5.0",
"parameters": [
{
"name": "enable",
"type": "System.Boolean",
"summary": "True to enable ColorWriting, False to disable."
}
]
},
{
"signature": "System.Void EnableDepthTesting(System.Boolean enable)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Enable or disable the DepthTesting behavior of the engine. When DepthTesting is disabled, objects in front will no longer occlude objects behind them.",
"since": "5.0",
"parameters": [
{
"name": "enable",
"type": "System.Boolean",
"summary": "True to enable DepthTesting, False to disable."
}
]
},
{
"signature": "System.Void EnableDepthWriting(System.Boolean enable)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Enable or disable the DepthWriting behavior of the engine. When DepthWriting is disabled, drawn geometry does not affect the Z-Buffer.",
"since": "5.0",
"parameters": [
{
"name": "enable",
"type": "System.Boolean",
"summary": "True to enable DepthWriting, False to disable."
}
]
},
{
"signature": "System.Void EnableLighting(System.Boolean enable)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Enable or disable the Lighting logic of the engine.",
"since": "5.0",
"parameters": [
{
"name": "enable",
"type": "System.Boolean",
"summary": "True to enable Lighting, False to disable."
}
]
},
{
"signature": "System.Void Flush()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Force the pipeline to immediately flush any cached geometry to the display",
"since": "7.0"
},
{
"signature": "Light[] GetLights()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get lights that this pipeline is current using",
"since": "6.3"
},
{
"signature": "System.Single[] GetOpenGLCameraToClip()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get an array of 16 floats that represents the \"camera\" to \"clip\" coordinate transformation in OpenGL's right handed coordinate system",
"since": "6.0"
},
{
"signature": "System.Single[] GetOpenGLWorldToCamera(System.Boolean includeModelTransform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get an array of 16 floats that represents the \"world\" to \"camera\" coordinate transformation in OpenGL's right handed coordinate system",
"since": "6.0"
},
{
"signature": "System.Single[] GetOpenGLWorldToClip(System.Boolean includeModelTransform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get an array of 16 floats that represents the \"world\" to \"clip\" coordinate transformation in OpenGL's right handed coordinate system",
"since": "6.0"
},
{
"signature": "System.Boolean InterruptDrawing()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Tests to see if the pipeline should stop drawing more geometry and just show what it has so far. If a drawing operation is taking a long time, this function will return True and tell Rhino it should just finish up and show the frame buffer. This is used in dynamic drawing operations.",
"since": "5.0",
"returns": "True if the pipeline should stop attempting to draw more geometry and just show the frame buffer."
},
{
"signature": "System.Boolean IsActive(DocObjects.RhinoObject rhinoObject)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines if an object can be visible in this viewport based on it's object type and display attributes. This test does not check for visibility based on location of the object. NOTE: Use CRhinoDisplayPipeline::IsVisible() to perform \"visibility\" tests based on location (is some part of the object in the view frustum). Use CRhinoDisplayPipeline::IsActive() to perform \"visibility\" tests based on object type.",
"since": "5.0",
"parameters": [
{
"name": "rhinoObject",
"type": "DocObjects.RhinoObject",
"summary": "Object to test."
}
],
"returns": "True if this object can be drawn in the pipeline's viewport based on it's object type and display attributes."
},
{
"signature": "System.Boolean IsInTiledDraw(out System.Drawing.Size fullSize, out System.Drawing.Rectangle currentTile)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if the currently drawn frame is part of a tiled capture. Tiled captures are performed when creating large raster outputs.",
"since": "8.2",
"parameters": [
{
"name": "fullSize",
"type": "System.Drawing.Size",
"summary": "Final full size area that is being created"
},
{
"name": "currentTile",
"type": "System.Drawing.Rectangle",
"summary": "What portion of the fullSize area that is currently being drawn"
}
],
"returns": "True if a tiled capture is being performed. If false, the fullSize parameter will have the same size as currentTile"
},
{
"signature": "System.Boolean IsVisible(BoundingBox bbox)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Test a given box for visibility inside the view frustum under the current viewport and model transformation settings.",
"since": "5.0",
"parameters": [
{
"name": "bbox",
"type": "BoundingBox",
"summary": "Box to test for visibility."
}
],
"returns": "True if at least some portion of the box is visible, False if not."
},
{
"signature": "System.Boolean IsVisible(DocObjects.RhinoObject rhinoObject)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Test a given object for visibility inside the view frustum under the current viewport and model transformation settings. This function calls a virtual IsVisibleFinal function that sub-classed pipelines can add extra tests to. In the base class, this test only tests visibility based on the objects world coordinates location and does not pay attention to the object's attributes. NOTE: Use CRhinoDisplayPipeline::IsVisible() to perform \"visibility\" tests based on location (is some part of the object in the view frustum). Use CRhinoDisplayPipeline::IsActive() to perform \"visibility\" tests based on object type.",
"since": "5.0",
"parameters": [
{
"name": "rhinoObject",
"type": "DocObjects.RhinoObject",
"summary": "Object to test."
}
],
"returns": "True if the object is visible, False if not."
},
{
"signature": "System.Boolean IsVisible(Point3d worldCoordinate)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Test a given 3d world coordinate point for visibility inside the view frustum under the current viewport and model transformation settings.",
"since": "5.0",
"parameters": [
{
"name": "worldCoordinate",
"type": "Point3d",
"summary": "Point to test for visibility."
}
],
"returns": "True if the point is visible, False if it is not."
},
{
"signature": "System.Drawing.Rectangle Measure2dText(System.String text, Point2d definitionPoint, System.Boolean middleJustified, System.Double rotationRadians, System.Int32 height, System.String fontFace)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines screen rectangle that would be drawn to using the Draw2dText(..) function with the same parameters.",
"since": "5.10",
"parameters": [
{
"name": "text",
"type": "System.String",
"summary": "text to measure."
},
{
"name": "definitionPoint",
"type": "Point2d",
"summary": "either lower-left or middle of text."
},
{
"name": "middleJustified",
"type": "System.Boolean",
"summary": "true=middle justified. false=lower-left justified."
},
{
"name": "rotationRadians",
"type": "System.Double",
"summary": "text rotation in radians"
},
{
"name": "height",
"type": "System.Int32",
"summary": "height in pixels (good default is 12)"
},
{
"name": "fontFace",
"type": "System.String",
"summary": "font name (good default is \"Arial\")"
}
],
"returns": "rectangle in the viewport's screen coordinates on success."
},
{
"signature": "System.Boolean Open()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Opens the pipeline.",
"since": "7.0",
"returns": "True if the pipeline was opened, False if it was already open or failed to open."
},
{
"signature": "System.Void PopClipTesting()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Pop a ClipTesting flag off the engine's stack.",
"since": "5.0",
"deprecated": "6.0",
"obsolete": "Use PopDepthTesting"
},
{
"signature": "System.Void PopCullFaceMode()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Pop a FaceCull flag off the engine's stack.",
"since": "5.0"
},
{
"signature": "System.Void PopDepthTesting()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Pop a DepthTesting flag off the engine's stack.",
"since": "5.0"
},
{
"signature": "System.Void PopDepthWriting()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Pop a DepthWriting flag off the engine's stack.",
"since": "5.0"
},
{
"signature": "System.Void PopModelTransform()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Pop a model transformation off the engine's model transform stack.",
"since": "5.0"
},
{
"signature": "System.Void PopProjection()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Pop a view projection off this pipelines projection stack",
"since": "8.0"
},
{
"signature": "System.Void Push2dProjection()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Push the current view projection and set the viewport up to be a simple 2D top projection where the camera frustum matches the same size as the screen port. This allows geometry draw functions to act like they are working with typical 2d graphics APIs on a window",
"since": "8.0"
},
{
"signature": "System.Void PushClipTesting(System.Boolean enable)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Push a ClipTesting flag on the engine's stack.",
"since": "5.0",
"deprecated": "6.0",
"obsolete": "Use PushDepthTesting",
"parameters": [
{
"name": "enable",
"type": "System.Boolean",
"summary": "ClipTesting flag."
}
]
},
{
"signature": "System.Void PushCullFaceMode(CullFaceMode mode)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Push a FaceCull flag on the engine's stack.",
"since": "5.0",
"parameters": [
{
"name": "mode",
"type": "CullFaceMode",
"summary": "FaceCull flag."
}
]
},
{
"signature": "System.Void PushDepthTesting(System.Boolean enable)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Push a DepthTesting flag on the engine's stack.",
"since": "5.0",
"parameters": [
{
"name": "enable",
"type": "System.Boolean",
"summary": "DepthTesting flag."
}
]
},
{
"signature": "System.Void PushDepthWriting(System.Boolean enable)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Push a DepthWriting flag on the engine's stack.",
"since": "5.0",
"parameters": [
{
"name": "enable",
"type": "System.Boolean",
"summary": "DepthWriting flag."
}
]
},
{
"signature": "System.Void PushModelTransform(Transform xform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Push a model transformation on the engine's model transform stack.",
"since": "5.0",
"parameters": [
{
"name": "xform",
"type": "Transform",
"summary": "Transformation to push."
}
]
},
{
"signature": "System.Void RemoveClippingPlane(System.Int32 index)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove a clipping plane from the pipeline for this frame",
"since": "6.3"
},
{
"signature": "DisplayMaterial SetupDisplayMaterial(RhinoDoc doc, RhinoObject rhinoObject, ObjectAttributes attributes, Transform instanceTransform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets up a display material.",
"since": "8.0",
"parameters": [
{
"name": "doc",
"type": "RhinoDoc",
"summary": "The active document."
},
{
"name": "rhinoObject",
"type": "RhinoObject",
"summary": "The Rhino object."
},
{
"name": "attributes",
"type": "ObjectAttributes",
"summary": "The object attributes."
},
{
"name": "instanceTransform",
"type": "Transform",
"summary": "The instance object transformation."
}
],
"returns": "A display material if successful, None otherwise."
},
{
"signature": "DisplayMaterial SetupDisplayMaterial(RhinoDoc doc, RhinoObject rhinoObject, ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets up a display material.",
"since": "8.0",
"parameters": [
{
"name": "doc",
"type": "RhinoDoc",
"summary": "The active document."
},
{
"name": "rhinoObject",
"type": "RhinoObject",
"summary": "The Rhino object."
},
{
"name": "attributes",
"type": "ObjectAttributes",
"summary": "The object attributes."
}
],
"returns": "A display material if successful, None otherwise."
},
{
"signature": "DisplayMaterial SetupDisplayMaterial(RhinoDoc doc, RhinoObject rhinoObject)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets up a display material.",
"since": "8.0",
"parameters": [
{
"name": "doc",
"type": "RhinoDoc",
"summary": "The active document."
},
{
"name": "rhinoObject",
"type": "RhinoObject",
"summary": "The Rhino object."
}
],
"returns": "A display material if successful, None otherwise."
},
{
"signature": "DisplayMaterial SetupDisplayMaterial(System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
}
],
"events": [
{
"signature": "EventHandler CalculateBoundingBox",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "EventHandler CalculateBoundingBoxZoomExtents",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Calculate a bounding to include in the Zoom Extents command.",
"since": "5.0"
},
{
"signature": "EventHandler ObjectCulling",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "EventHandler DisplayModeChanged",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.18"
},
{
"signature": "EventHandler DrawForeground",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Called after all non-highlighted objects have been drawn and PostDrawObjects has been called. Depth writing and testing are turned OFF. If you want to draw with depth writing/testing, see PostDrawObjects.",
"since": "5.0",
"remarks": "This event is actually passed a DrawForegroundEventArgs, but we could not change the event declaration without breaking the SDK. Cast to a DrawForegroundEventArgs if you need it."
},
{
"signature": "EventHandler DrawOverlay",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "If Rhino is in a feedback mode, the draw overlay call allows for temporary geometry to be drawn on top of everything in the scene. This is similar to the dynamic draw routine that occurs with custom get point.",
"since": "5.0"
},
{
"signature": "EventHandler PostDrawObjects",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Called after all non-highlighted objects have been drawn. Depth writing and testing are still turned on. If you want to draw without depth writing/testing, see DrawForeground.",
"since": "5.0"
},
{
"signature": "EventHandler PreDrawObjects",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Called before objects are been drawn. Depth writing and testing are on.",
"since": "5.0"
},
{
"signature": "EventHandler PreDrawTransparentObjects",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Called before transparent objects have been drawn. Depth writing and testing are on.",
"since": "6.12"
},
{
"signature": "EventHandler ViewportProjectionChanged",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Called when the projection changes for a viewport being drawn.",
"since": "6.18"
},
{
"signature": "EventHandler PostDrawObject",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Called right after an individual object has been drawn. NOTE: Do not use this event unless you absolutely need to. It is called for every object in the document and can slow display down if a large number of objects exist in the document",
"since": "7.0"
},
{
"signature": "EventHandler PreDrawObject",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Called right before an individual object is being drawn. NOTE: Do not use this event unless you absolutely need to. It is called for every object in the document and can slow display down if a large number of objects exist in the document",
"since": "5.0"
},
{
"signature": "EventHandler InitFrameBuffer",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.18"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipeline.InferenceLineType",
"dataType": "enum",
"since": "8.17",
"values": [
{
"signature": "Chord = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A chord from P to Q"
},
{
"signature": "Ray = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A ray from P through Q"
},
{
"signature": "InfiniteLine = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "An infinite line through P and Q"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes",
"dataType": "class",
"summary": "Represents display pipeline settings, such as \"show transparency\" and \"show grips\".",
"interfaces": ["IDisposable", "ISerializable"],
"constructors": [
{
"signature": "DisplayPipelineAttributes(SerializationInfo info, StreamingContext context)",
"modifiers": ["protected"],
"protected": true,
"virtual": false
}
],
"properties": [
{
"signature": "Color AmbientLightingColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.3",
"property": ["get", "set"]
},
{
"signature": "int AxesSizePercentage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Size of axes as a percentage of the grid extents.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "BackfaceStyle BackfaceDisplayStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Changes the display of the backfaces (the side opposite of the surface normal direction).",
"since": "8.20",
"property": ["get", "set"]
},
{
"signature": "Color BackMaterialDiffuseColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.8",
"property": ["get", "set"]
},
{
"signature": "double BackMaterialShine",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get or set the back material shine (0 to Rhino.DocObjects.MaxShine). You must call DisplayModeDescription.UpdateDisplayMode() to commit this change.",
"since": "8.4",
"property": ["get", "set"]
},
{
"signature": "double BackMaterialTransparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get or set the back material transparency (0 to 100). You must call DisplayModeDescription.UpdateDisplayMode() to commit this change.",
"since": "8.4",
"property": ["get", "set"]
},
{
"signature": "bool BackOverrideObjectReflectivity",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Objects acquire reflectivity from render materials.",
"since": "8.21",
"property": ["get", "set"]
},
{
"signature": "bool BackOverrideObjectTransparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Objects acquire transparency from render materials.",
"since": "8.21",
"property": ["get", "set"]
},
{
"signature": "bool BakeTextures",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds the ability to display procedural textures in viewports. When it is turned off, procedural textures in viewports look different from the rendering.",
"since": "8.14",
"property": ["get", "set"]
},
{
"signature": "BoundingBoxDisplayMode BoundingBoxMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.1",
"property": ["get", "set"]
},
{
"signature": "bool CastShadows",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Cast shadows.",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "Color ClippingEdgeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Clipping edge color",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "ClippingEdgeColorUse ClippingEdgeColorUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies how the color for the Edges is determined",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int ClippingEdgeThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge thickness in pixels.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "Color ClippingFillColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Clipping plane fill color",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "ClippingPlaneFillColorUse ClippingPlaneFillColorUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies how the color for the clipping plane object fill is determined.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "Color ClippingShadeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Clipping plane solid color",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "ClippingShadeColorUse ClippingShadeColorUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies how to shade the clipping plane",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ClippingShadeSelectedPlane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shades the selected clipping plane.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int ClippingShadeTransparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies the clipping plane transparency percentage.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ClipSelectionHighlight",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Clips the highlight wires. Shaded selections always clip.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int ColorReductionPct",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "ContextsForDraw ContextForDraw",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.5",
"property": ["get"]
},
{
"signature": "Color ControlPolygonColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Control polygon color",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int ControlPolygonGripSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The control point size in pixels.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ControlPolygonHighlight",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Highlights the segments of the control polygon on either side of the control points.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ControlPolygonShow",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shows the control polygon and only shows the control points.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ControlPolygonShowPoints",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shows the control points while the control polygon is displayed.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ControlPolygonShowSurface",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shows the object while the control polygon is displayed.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "PointStyle ControlPolygonStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "PointStyle for the control polygon. Supported values are ControlPoint, RoundControlPoint, VariableDot, and RoundDot",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ControlPolygonUseFixedSingleColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies a color for the control polygon.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ControlPolygonUseSolidLines",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Use dotted / solid lines",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int ControlPolygonWireThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The width of the control polygon lines in pixels.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool CullBackfaces",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.8",
"property": ["get", "set"]
},
{
"signature": "Color CurveColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Color used for drawing curves",
"since": "5.1",
"property": ["get", "set"]
},
{
"signature": "int CurveThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Pixel thickness for curves",
"since": "5.1",
"property": ["get", "set"]
},
{
"signature": "float CurveThicknessScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Scale thickness for curves",
"since": "8.4",
"property": ["get", "set"]
},
{
"signature": "CurveThicknessUse CurveThicknessUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Use a pixel thickness (CurveThickness) or a scale thickness (CurveThicknessScale)",
"since": "8.4",
"property": ["get", "set"]
},
{
"signature": "double CustomGroundPlaneAltitude",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Height above the world XY plane in model units",
"since": "8.10",
"property": ["get", "set"]
},
{
"signature": "bool CustomGroundPlaneAutomaticAltitude",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turns on auto-elevation that moves Ground Plane to the lowest point of the objects in the model.",
"since": "8.10",
"property": ["get", "set"]
},
{
"signature": "bool CustomGroundPlaneOn",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turn the custom ground plane on or off",
"since": "8.10",
"property": ["get", "set"]
},
{
"signature": "bool CustomGroundPlaneShadowOnly",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Makes the ground plane transparent, but allows shadows to still be cast on it.",
"since": "8.10",
"property": ["get", "set"]
},
{
"signature": "bool DisableConduits",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DisableTransparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "DynamicDisplayUse DynamicDisplayUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the appearance of objects in the display",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "string EnglishName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "FrameBufferFillMode FillMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get or set the frame buffer fill mode.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Color FrontDiffuse",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shades the current viewport with no smoothing so the individual render mesh faces are visible.",
"since": "8.14",
"property": ["get", "set"]
},
{
"signature": "bool FrontFlatShaded",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shades the current viewport with no smoothing so the individual render mesh faces are visible.",
"since": "8.14",
"property": ["get", "set"]
},
{
"signature": "double FrontMaterialShine",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get or set the front material shine (0 to Rhino.DocObjects.MaxShine). You must call DisplayModeDescription.UpdateDisplayMode() to commit this change.",
"since": "8.4",
"property": ["get", "set"]
},
{
"signature": "double FrontMaterialTransparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get or set the front material transparency (0 to 100). You must call DisplayModeDescription.UpdateDisplayMode() to commit this change.",
"since": "8.4",
"property": ["get", "set"]
},
{
"signature": "bool FrontOverrideObjectColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.14",
"property": ["get", "set"]
},
{
"signature": "bool FrontOverrideObjectReflectivity",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Objects acquire reflectivity from render materials.",
"since": "8.21",
"property": ["get", "set"]
},
{
"signature": "bool FrontOverrideObjectTransparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Objects acquire transparency from render materials.",
"since": "8.21",
"property": ["get", "set"]
},
{
"signature": "bool GhostLockedObjects",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set locked appearance",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "Color GridPlaneColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The color of the grid plane",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int GridPlaneTransparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Transparency of the grid plane, percentage (0-100)",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "GridPlaneVisibilityMode GridPlaneVisibility",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set when to show the grid plane",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int GridTransparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Transparency of the grid, percentage (0-100)",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "GroundPlaneUsages GroundPlaneUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turn on or off custom Ground plane settungs",
"since": "8.14",
"property": ["get", "set"]
},
{
"signature": "bool HighlightSurfaces",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shades entire object with highlight color.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "Guid Id",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IgnoreHighlights",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool LayersFollowLockUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Applies the settings for locked objects to locked layers.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "LightingSchema LightingScheme",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.4",
"property": ["get", "set"]
},
{
"signature": "LinearWorkflowUsages LinearWorkflowUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turn on or off custom linear workflow settings",
"since": "8.14",
"property": ["get", "set"]
},
{
"signature": "string LocalName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "Color LockedColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Locked Object Color",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool LockedObjectsDrawBehindOthers",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Locked object are drawn behind other objects",
"since": "5.1",
"property": ["get", "set"]
},
{
"signature": "int LockedObjectTransparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "LockedObjectTransparency.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "LockedObjectUse LockedObjectUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set asource of display attributes for locked objects",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "Color MeshEdgeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the mesh edge color",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int MeshEdgeColorReduction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The darken percentage of the color",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int MeshEdgeThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Mesh edge width in pixels",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "Color MeshNakedEdgeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the naked edge color",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int MeshNakedEdgeColorReduction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The darken percentage of the color",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int MeshNakedEdgeThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Naked mesh edge width in pixels.}",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "Color MeshNonmanifoldEdgeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the nonmanifold edge color",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int MeshNonmanifoldEdgeColorReduction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The darken percentage of the color",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int MeshNonmanifoldEdgeThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Non-manifold mesh edge width in pixels",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "MeshDisplayAttributes MeshSpecificAttributes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "int MeshVertexSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Mesh vertex size in pixels",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "Color ObjectColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool PlaneUsesGridColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If true, use the grid thin line color in App settings",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "float PointCloudRadius",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.4",
"property": ["get", "set"]
},
{
"signature": "PointStyle PointCloudStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.4",
"property": ["get", "set"]
},
{
"signature": "float PointRadius",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "PointStyle PointStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool PostProcessFrameBuffer",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Linear workflow Adjust output image",
"since": "8.14",
"property": ["get", "set"]
},
{
"signature": "float PostProcessGamma",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Linear workflow Output image gamma",
"since": "8.14",
"property": ["get", "set"]
},
{
"signature": "bool PreProcessColors",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Linear workflow input colors",
"since": "8.14",
"property": ["get", "set"]
},
{
"signature": "float PreProcessGamma",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Linear workflow input gamma",
"since": "8.14",
"property": ["get", "set"]
},
{
"signature": "bool PreProcessTextures",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Linear workflow input textures",
"since": "8.14",
"property": ["get", "set"]
},
{
"signature": "Guid RealtimeDisplayId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the ID of the real-time display engine attached to the view. This will be Guid.Empty if no real-time display engine is in use. This can be the case for instance when starting a _Render session for a real-time viewport integration. That still would cause this ID to be Guid.Empty.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "int RealtimeRenderPasses",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get or set the real-time passes amount",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool ShadeVertexColors",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shade using vertex colors.",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "bool ShadingEnabled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw shaded meshes and surfaces",
"since": "5.1",
"property": ["get", "set"]
},
{
"signature": "double ShadowBiasX",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "ShadowBiasX (Self shadowing artifacts) from 0 (dirty) to 50 (cleaner).",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "float ShadowClippingRadius",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Camera-based shadow clipping radius",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "Color ShadowColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.3",
"property": ["get", "set"]
},
{
"signature": "double ShadowEdgeBlur",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set blurring from 0 (no blurring) to 16 (maximum blurring)",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int ShadowIntensity",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shadow intensity (percentage 0-100)",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int ShadowMemoryUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Value from 1 to 16384 indicating how much memory is to be allocated. Actual memory use is ShadowMemoryUsage*ShadowMemoryUsage*4.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ShadowsIgnoreUserDefinedClippingPlanes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If true, shadows ignore user-defined clipping planes",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int ShadowSoftEdgeQuality",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Soft edge quality, from 0 (none/faster) to 12 (softer/slower)",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ShadowsOn",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Enable shadows",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "int ShadowTransparencyTolerance",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Transparency tolerance from 0 (never cast shadows) to 100 (always case shadows)",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ShowAnnotations",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show annotations.",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "bool ShowClipIntersectionEdges",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show edges and hatches where clipping planes clip objects",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowClipIntersectionSurfaces",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show fills where clipping planes clip solid objects",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowClippingEdges",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shows the edges between the clipping plane and clipped objects.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ShowClippingFills",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When a clipping plane intersects a 3-D object and the section is closed, the section is filled.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ShowClippingPlanes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show clipping planes.",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "bool ShowCreases",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowCurves",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw curves",
"since": "5.1",
"property": ["get", "set"]
},
{
"signature": "bool ShowEdges",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowGrips",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowHiddenLines",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowIntersections",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowIsoCurves",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw surface ISO curves.",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "bool ShowLighting",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowLights",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show light widgets.",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "bool ShowMeshEdges",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Display mesh edges on/off",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ShowMeshNakedEdges",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Display mesh naked edges on/off",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ShowMeshNonmanifoldEdges",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Display mesh manifold edges on/off",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool ShowPointClouds",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show point clouds.",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "bool ShowPoints",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show points.",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "bool ShowRealtimeRenderProgressBar",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get or set whether the display is used for preview rendering or not.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowSeams",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowSilhouttes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowSubDBoundary",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set visibility of SubD naked edges.",
"since": "8.10",
"property": ["get", "set"]
},
{
"signature": "bool ShowSubDCreases",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set visibility of SubD creased edges.",
"since": "8.10",
"property": ["get", "set"]
},
{
"signature": "bool ShowSubDEdges",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set visibility of SubD smooth edges.",
"since": "8.10",
"property": ["get", "set"]
},
{
"signature": "bool ShowSubDNonmanifoldEdges",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turn on/off color differentiation of SubD symmetry children.",
"since": "8.10",
"property": ["get", "set"]
},
{
"signature": "bool ShowSubDReflectionPlanePreview",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.10",
"property": ["get", "set"]
},
{
"signature": "bool ShowSurfaceEdge",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turn Surface Edge visibility on or off",
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "bool ShowSurfaceEdges",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show surface edges.",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "bool ShowSurfaceNakedEdge",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turn Surface Naked Edge visibility on or off",
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "bool ShowTangentEdges",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show tangent edges.",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "bool ShowTangentSeams",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show tangent seams.",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "bool ShowText",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show text.",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "int SkylightShadowQuality",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Skylight shadow quality, from 0 (lowest) to 8 (highest)",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "StereoContext StereoContext",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get or set the stereo render context.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "bool SubDBoundaryApplyPattern",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Apply pattern to the edge",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "int SubDBoundaryColorReduction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Color reduction percentage",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "Color SubDBoundaryEdgeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge color",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "SubDEdgeColorUse SubDBoundaryEdgeColorUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge color usage",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "float SubDBoundaryEdgeThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge thickness (pixels).",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "float SubDBoundaryThicknessScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge thickness scale",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "SubDThicknessUse SubDBoundaryThicknessUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "bool SubDCreaseInteriorApplyPattern",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Apply pattern to the edge",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "int SubDCreaseInteriorColorReduction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Color reduction percentage",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "Color SubDCreaseInteriorEdgeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge color",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "SubDEdgeColorUse SubDCreaseInteriorEdgeColorUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge color usage",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "float SubDCreaseInteriorEdgeThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge thickness (pixels).",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "float SubDCreaseInteriorThicknessScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge thickness scale",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "SubDThicknessUse SubDCreaseInteriorThicknessUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "bool SubDNonManifoldApplyPattern",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Apply pattern to the edge",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "int SubDNonManifoldColorReduction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Color reduction percentage",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "Color SubDNonManifoldEdgeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge color",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "SubDEdgeColorUse SubDNonManifoldEdgeColorUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge color usage",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "float SubDNonManifoldEdgeThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge thickness (pixels).",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "float SubDNonManifoldThicknessScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge thickness scale",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "SubDThicknessUse SubDNonManifoldThicknessUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "Color SubDReflectionAxisLineColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Reflection axis line color",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "float SubDReflectionAxisLineThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SubDReflectionPlaneAxisLineOn",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Apply Turnh on or off the reflection plane axis line",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "Color SubDReflectionPlaneColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Reflection plane color",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "int SubDReflectionPlaneColorReduction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "SubD replection plane color reduction percentage",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "SubDReflectionPlaneColorUse SubDReflectionPlaneColorUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "SubD replection plane color use",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "bool SubDSmoothInteriorApplyPattern",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Apply pattern to the edge",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "int SubDSmoothInteriorColorReduction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Color reduction percentage",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "Color SubDSmoothInteriorEdgeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge color",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "SubDEdgeColorUse SubDSmoothInteriorEdgeColorUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge color usage",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "float SubDSmoothInteriorEdgeThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge thickness (pixels).",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "float SubDSmoothInteriorThicknessScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Edge thickness scale",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "SubDThicknessUse SubDSmoothInteriorThicknessUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "SubDThicknessUse SubDThicknessUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Thickness usage, pixel thickness or a scale thickness",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "bool SurfaceEdgeApplyPattern",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turn pattern application on or off",
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "Color SurfaceEdgeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "int SurfaceEdgeColorReduction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "int SurfaceEdgeColorReductionPercent",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.7",
"property": ["get", "set"]
},
{
"signature": "SurfaceEdgeColorUse SurfaceEdgeColorUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "int SurfaceEdgeThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Thickness for surface edges",
"since": "6.1",
"property": ["get", "set"]
},
{
"signature": "float SurfaceEdgeThicknessScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "bool SurfaceIsoColorsUsed",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "bool SurfaceIsoShowForFlatFaces",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "bool SurfaceIsoSingleColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "int SurfaceIsoThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "float SurfaceIsoThicknessUScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "bool SurfaceIsoThicknessUsed",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "float SurfaceIsoThicknessVScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "float SurfaceIsoThicknessWScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.7",
"property": ["get", "set"]
},
{
"signature": "Color SurfaceIsoUColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "int SurfaceIsoUThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "Color SurfaceIsoUVColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "Color SurfaceIsoVColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "int SurfaceIsoVThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "int SurfaceNakedAdgeColorReduction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "bool SurfaceNakedEdgeApplyPattern",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Turn pattern application on or off",
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "Color SurfaceNakedEdgeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "int SurfaceNakedEdgeColorReductionPercent",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.7",
"property": ["get", "set"]
},
{
"signature": "SurfaceNakedEdgeColorUse SurfaceNakedEdgeColorUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "int SurfaceNakedEdgeThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "float SurfaceNakedEdgeThicknessScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "bool UseAssignedObjectMaterial",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether objects ought to be drawn using their assigned rendering material.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool UseBackfaceMaterial",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Use the backface material for displaying backfaces.",
"since": "8.20",
"property": ["get", "set"]
},
{
"signature": "bool UseCustomBackface",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Use a custom material for displaying backfaces.",
"since": "8.20",
"property": ["get", "set"]
},
{
"signature": "bool UseCustomObjectColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether objects ought to be drawn using a custom color.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool UseCustomObjectColorBackfaces",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether objects ought to be drawn using a custom color for back faces.",
"since": "7.1",
"property": ["get", "set"]
},
{
"signature": "bool UseCustomObjectMaterial",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether objects ought to be drawn using a custom material.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool UseCustomObjectMaterialBackfaces",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether objects ought to be drawn using a custom material on backfaces.",
"since": "7.1",
"property": ["get", "set"]
},
{
"signature": "bool UseLightColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw lights using light color",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool UseObjectBackfaceMaterial",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Use the backface material of the object for displaying its backfaces.",
"since": "8.20",
"property": ["get", "set"]
},
{
"signature": "bool UseSectionStyles",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When enabled, the appearances of clipping fills and edges are based on objects' section style properties.",
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool UseSingleCurveColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Use a single color for drawing curves",
"since": "6.3",
"property": ["get", "set"]
},
{
"signature": "ViewDisplayAttributes ViewSpecificAttributes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "WorldAxesIconColorUse WorldAxesIconColorUsage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.11",
"property": ["get", "set"]
},
{
"signature": "bool XrayAllObjects",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true
},
{
"signature": "System.Void GetColorFadeEffect(out Color fadeColor, out System.Single fadeAmount)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the current color fade effect data.",
"since": "8.0",
"parameters": [
{
"name": "fadeColor",
"type": "Color",
"summary": "The current fade amount"
},
{
"name": "fadeAmount",
"type": "System.Single",
"summary": "The current fade color"
}
]
},
{
"signature": "CurveThicknessUse GetCurveThicknessUsage()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets current usage, pixel thickness (CurveThickness) or a scale thickness (CurveThicknessScale)",
"since": "8.7"
},
{
"signature": "System.Void GetDiagonalHatchEffect(out System.Single hatchStrength, out System.Single hatchWidth)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the current diagonal hatch strength and width in pixels.",
"since": "8.0",
"parameters": [
{
"name": "hatchStrength",
"type": "System.Single",
"summary": "The strength of the hatch effect."
},
{
"name": "hatchWidth",
"type": "System.Single",
"summary": "The width of the diagonal hatch in pixels."
}
]
},
{
"signature": "System.Single GetDitherTransparencyEffect()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the current dither transparency amount.",
"since": "8.0"
},
{
"signature": "System.Void GetFill(out Color topLeft, out Color bottomLeft, out Color topRight, out Color bottomRight)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get fill colors used for clearing the frame buffer",
"since": "6.23"
},
{
"signature": "System.Void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"since": "5.0"
},
{
"signature": "SurfaceThicknessUse GetSurfaceEdgeThicknessUsage()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Helper function for setting the SurfaceEdgeThicknessFlags",
"since": "8.6"
},
{
"signature": "System.Void GetSurfaceIsoApplyPattern(out System.Boolean u, out System.Boolean v, out System.Boolean w)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6",
"parameters": [
{
"name": "u",
"type": "System.Boolean",
"summary": "Gets mode in the u direction"
},
{
"name": "v",
"type": "System.Boolean",
"summary": "Gets mode in the v direction"
},
{
"name": "w",
"type": "System.Boolean",
"summary": "Gets mode in the w direction"
}
]
},
{
"signature": "SurfaceIsoColorUse GetSurfaceIsoColorUsage()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Helper function for getting SurfaceIsoColorsUsed and SurfaceSingleIsoColor",
"since": "8.6"
},
{
"signature": "SurfaceIsoThicknessUse GetSurfaceIsoThicknessUsage()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "This is a helper function that combines getting IsoThicknessUsed and SurfaceNakedEdgeThicknessUsageFlags settings to correspond to the behavor of the Settings page.",
"since": "8.6"
},
{
"signature": "SurfaceNakedEdgeThicknessUse GetSurfaceNakedEdgeThicknessUsage()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "This is a helper function that combines getting SurfaceNakeEdgeUseNormalThickness and SurfaceNakedEdgeThicknessUsageFlags settings to correspond to the behavor of the Settings page.",
"since": "8.6"
},
{
"signature": "System.Boolean HasColorFadeEffect()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns TRUE if there is a color fade effect enabled with a color fade effect amount larger than 0.0, FALSE otherwise.",
"since": "8.0"
},
{
"signature": "System.Boolean HasDiagonalHatchEffect()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns TRUE if there is a diagonal hatch effect enabled with a hatch strength larger than 0.0, FALSE otherwise.",
"since": "8.0"
},
{
"signature": "System.Boolean HasDitherTransparencyEffect()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns TRUE if there is a dither transparency effect enabled with a transparency amount larger than 0.0, FALSE otherwise.",
"since": "8.0"
},
{
"signature": "System.Void SetColorFadeEffect(in Color fadeColor, in System.Single fadeAmount)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set a color fade effect to make objects fade a given amount towards a given color.",
"since": "8.0",
"parameters": [
{
"name": "fadeColor",
"type": "Color",
"summary": "The amount of fade towards the given color (0..1)."
},
{
"name": "fadeAmount",
"type": "System.Single",
"summary": "The color to fade towards."
}
]
},
{
"signature": "System.Void SetCurveThicknessUsage(CurveThicknessUse usage)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets usage, pixel thickness (CurveThickness) or a scale thickness (CurveThicknessScale)",
"since": "8.7"
},
{
"signature": "System.Void SetDiagonalHatchEffect(in System.Single hatchStrength, in System.Single hatchWidth)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set a diagonal hatch effect to make objects render with diagonal hatch with a given strength and width in pixels. The effect works by brightening and darkening pixels in a diagonal pattern.",
"since": "8.0",
"parameters": [
{
"name": "hatchStrength",
"type": "System.Single",
"summary": "The strength of the hatch effect (0..1)."
},
{
"name": "hatchWidth",
"type": "System.Single",
"summary": "The width of the diagonal hatch in pixels (>= 0)."
}
]
},
{
"signature": "System.Void SetDitherTransparencyEffect(in System.Single transparencyAmount)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set a dither transparency effect to make objects render with a given amount of transparency using a dither effect.",
"since": "8.0",
"parameters": [
{
"name": "transparencyAmount",
"type": "System.Single",
"summary": "The amount of transparency (0..1)."
}
]
},
{
"signature": "System.Void SetFill(Color gradientTopLeft, Color gradientBottomLeft, Color gradientTopRight, Color gradientBottomRight)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the fill mode to four color gradient and set the colors",
"since": "6.23"
},
{
"signature": "System.Void SetFill(Color gradientTop, Color gradientBottom)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set fill mode to two color and set the colors",
"since": "6.23"
},
{
"signature": "System.Void SetFill(Color singleColor)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set fill mode to solid color and set the fill color",
"since": "6.23"
},
{
"signature": "System.Void SetSurfaceEdgeThicknessUsage(SurfaceThicknessUse use)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Helper function for getting the SurfaceEdgeThicknessFlags",
"since": "8.10"
},
{
"signature": "System.Void SetSurfaceIsoApplyPattern(System.Boolean u, System.Boolean v, System.Boolean w)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.6"
},
{
"signature": "System.Void SetSurfaceIsoColorUsage(SurfaceIsoColorUse use)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Helper function for setting SurfaceIsoColorsUsed and SurfaceIsoSingleColor",
"since": "8.6"
},
{
"signature": "System.Void SetSurfaceIsoThicknessUsage(SurfaceIsoThicknessUse value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "This is a helper function that combines setting IsoThicknessUsed and SurfaceNakedEdgeThicknessUsageFlags settings to correspond to the behavor of the Settings page.",
"since": "8.6"
},
{
"signature": "System.Void SetSurfaceNakedEdgeThicknessUsage(SurfaceNakedEdgeThicknessUse use)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "This is a helper function that combines setting SurfaceNakeEdgeUseNormalThickness and SurfaceNakedEdgeThicknessUsageFlags settings to correspond to the behavor of the Settings page.",
"since": "8.6"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.BackfaceStyle",
"dataType": "enum",
"summary": "Values for changing the display of the backface (the side opposite of the surface normal direction).",
"since": "8.20",
"values": [
{
"signature": "UseFrontFaceSettings = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No color change.",
"since": "8.20"
},
{
"signature": "CullBackfaces = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Surfaces viewed from the back will be transparent.",
"since": "8.20"
},
{
"signature": "UseObjectColor = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Surfaces viewed from the back use the color specified in the object's display properties.",
"since": "8.20"
},
{
"signature": "SingleColorAllBackfaces = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "All backfaces display a specified color regardless of the object color.",
"since": "8.20"
},
{
"signature": "UseRenderMaterial = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shades using rendering material.",
"since": "8.20"
},
{
"signature": "CustomMaterialAllBackfaces = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Use a custom material for all backfaces.",
"since": "8.20"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.BoundingBoxDisplayMode",
"dataType": "enum",
"since": "6.1",
"values": [
{
"signature": "None = UnsafeNativeMethods.DisplayPipelineAttributesBBox.BBoxOff",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "OnDuringDynamicDisplay = UnsafeNativeMethods.DisplayPipelineAttributesBBox.BBoxOnDynamicDisplay",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "OnAlways = UnsafeNativeMethods.DisplayPipelineAttributesBBox.BBoxOnAlways",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.ClippingEdgeColorUse",
"dataType": "enum",
"since": "8.11",
"values": [
{
"signature": "PlaneColor = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Uses the clipping plane's color (object or layer)."
},
{
"signature": "SolidColor = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Solid color"
},
{
"signature": "ObjectColor = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Uses the object's color (object or layer)."
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.ClippingPlaneFillColorUse",
"dataType": "enum",
"since": "8.11",
"values": [
{
"signature": "ViewportColor = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Follows how the object displays in the viewport."
},
{
"signature": "RenderMaterialColor = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Uses the object's render material."
},
{
"signature": "PlaneMaterialColor = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Uses the clipping plane's color or layer color property."
},
{
"signature": "SolidColor = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Solid color"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.ClippingShadeColorUse",
"dataType": "enum",
"since": "8.11",
"values": [
{
"signature": "PlaneColor = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Uses the clipping plane's color (object or layer)."
},
{
"signature": "PlaneMaterialColor = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Uses the plane's render material (object or layer)."
},
{
"signature": "SolidColor = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Solid Color"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.ContextsForDraw",
"dataType": "enum",
"since": "6.5",
"values": [
{
"signature": "Unset = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "FilePreview = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ViewCapture = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Printing = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "UIPreview = 4",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Mask = 5",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "RenderOverlays = 6",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.CurveThicknessUse",
"dataType": "enum",
"since": "8.6",
"values": [
{
"signature": "ObjectWidth = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Pixels = 1",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.DynamicDisplayUse",
"dataType": "enum",
"since": "8.11",
"values": [
{
"signature": "UseAppSettings = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Use system default settings."
},
{
"signature": "DisplayObjectBoundingBox = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Reduces the display of objects to their bounding boxes. This can speed up the display on large models."
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.FrameBufferFillMode",
"dataType": "enum",
"since": "6.0",
"values": [
{
"signature": "DefaultColor = UnsafeNativeMethods.FrameBufferFillMode.DEFAULT_COLOR",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SolidColor = UnsafeNativeMethods.FrameBufferFillMode.SOLID_COLOR",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Gradient2Color = UnsafeNativeMethods.FrameBufferFillMode.GRADIENT_2_COLOR",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Gradient4Color = UnsafeNativeMethods.FrameBufferFillMode.GRADIENT_4_COLOR",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Bitmap = UnsafeNativeMethods.FrameBufferFillMode.BITMAP",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Renderer = UnsafeNativeMethods.FrameBufferFillMode.RENDERER",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Transparent = UnsafeNativeMethods.FrameBufferFillMode.TRANSPARENT",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.GridPlaneVisibilityMode",
"dataType": "enum",
"since": "8.11",
"values": [
{
"signature": "ShowOnlyIfGridVisible = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Show only when grid is on"
},
{
"signature": "AlwaysShow = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Show always"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.GroundPlaneUsages",
"dataType": "enum",
"since": "8.14",
"values": [
{
"signature": "ByDocument = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Custom = 1",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.LightingSchema",
"dataType": "enum",
"since": "8.4",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DefaultLighting = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SceneLighting = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "CustomLighting = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AmbientOcclusion = 4",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.LinearWorkflowUsages",
"dataType": "enum",
"since": "8.14",
"values": [
{
"signature": "ByDocument = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Custom = 1",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.LockedObjectUse",
"dataType": "enum",
"since": "8.11",
"values": [
{
"signature": "UseObjectAttributes = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Uses the object's specified attributes."
},
{
"signature": "SpecifyColor = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Use specified lock color"
},
{
"signature": "UseAppSettings = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Use settings specified in Appearance: Colors Options."
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.MeshDisplayAttributes",
"dataType": "class",
"properties": [
{
"signature": "Color AllMeshWiresColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Color.Empty means that we are NOT using a single color for all mesh wires.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool HighlightMeshes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int MeshWireThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowMeshVertices",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowMeshWires",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.SubDEdgeColorUse",
"dataType": "enum",
"summary": "SubD edge color use",
"since": "8.9",
"values": [
{
"signature": "ObjectColor = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SingleColorForAll = 1",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.SubDReflectionPlaneColorUse",
"dataType": "enum",
"summary": "SubD replection plane color use",
"since": "8.9",
"values": [
{
"signature": "ObjectColor = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "CustomColor = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SingleColorForAll = 2",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.SubDThicknessUse",
"dataType": "enum",
"since": "8.9",
"values": [
{
"signature": "ObjectWidth = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Pixels = 1",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.SurfaceEdgeColorUse",
"dataType": "enum",
"since": "8.6",
"values": [
{
"signature": "ObjectColor = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "IsocurveColor = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SingleColorForAll = 2",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.SurfaceIsoColorUse",
"dataType": "enum",
"since": "8.6",
"values": [
{
"signature": "ObjectColor = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SingleColorForAll = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SpecifiedUV = 2",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.SurfaceIsoThicknessUse",
"dataType": "enum",
"since": "8.6",
"values": [
{
"signature": "ObjectWidth = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SingleWidthForAllCurves = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "PixelsUV = 2",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.SurfaceNakedEdgeColorUse",
"dataType": "enum",
"since": "8.6",
"values": [
{
"signature": "UseSurfaceEdgeSettings = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ObjectColor = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "IsoCurveColor = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SingleColorForAll = 3",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.SurfaceNakedEdgeThicknessUse",
"dataType": "enum",
"since": "8.6",
"values": [
{
"signature": "UseSurfaceEdgeSettings = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ObjectWidth = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Pixels = 2",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.SurfaceThicknessUse",
"dataType": "enum",
"since": "8.10",
"values": [
{
"signature": "ObjectWidth = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Pixels = 1",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.ViewDisplayAttributes",
"dataType": "class",
"properties": [
{
"signature": "bool BlendGrid",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawGrid",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawGridAxes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawTransparentGridPlane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawWorldAxes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawZAxis",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "float GridBoundaryThickness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The thickness of the grid boundary.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "float GridCornerRadius",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The radius used to round the corners of the grid.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "float GridFade",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The amount the grid fades out towards its edges, from 0.0 (no fade) to 1.0 (full fade).",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double HorizontalViewportScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowGridOnTop",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool UseDocumentGrid",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double VerticalViewportScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color WorldAxisColorX",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color WorldAxisColorY",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color WorldAxisColorZ",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPipelineAttributes.WorldAxesIconColorUse",
"dataType": "enum",
"since": "8.11",
"values": [
{
"signature": "UseApplicationSettings = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Use default setting"
},
{
"signature": "SameAsGridAxesColors = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Set colors for grid axes in Appearance: Colors Options"
},
{
"signature": "Custom = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Use specified custom colors"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPoint",
"dataType": "class",
"summary": "A 3d point with attributes used by the display pipeline",
"constructors": [
{
"signature": "DisplayPoint(Point3d location)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
}
],
"properties": [
{
"signature": "Point3d Location",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "DisplayPoint WithAttributes(DisplayPointAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPointAttributes",
"dataType": "class",
"constructors": [
{
"signature": "DisplayPointAttributes()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "DisplayPointAttributes(DisplayPointAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
}
],
"properties": [
{
"signature": "float? Diameter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color? FillColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "PointStyle? PointStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "float? RotationRadians",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "float? SecondarySize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color? StrokeColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "float? StrokeWidth",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayPointSet",
"dataType": "class",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "DisplayPointSet()",
"summary": "Initializes a new instance of the DisplayPointSet class"
}
],
"methods": [
{
"signature": "DisplayPointSet Create(IEnumerable points)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "DisplayTechnology",
"dataType": "enum",
"summary": "Graphics display techologies.",
"since": "7.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "OpenGL = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Metal = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DirectX = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Software = 4",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Vulkan = 5",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DrawEventArgs",
"dataType": "class",
"baseclass": "EventArgs",
"properties": [
{
"signature": "DisplayPipeline Display",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "RhinoDoc RhinoDoc",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "RhinoViewport Viewport",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "DrawForegroundEventArgs",
"dataType": "class",
"baseclass": "Rhino.Display.DrawEventArgs",
"properties": [
{
"signature": "bool DrawWorldAxes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool WorldAxesDrawn",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "DrawFrameStages",
"dataType": "enum",
"since": "5.0",
"values": [
{
"signature": "InitializeFrameBuffer = 0x00000001",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SetupFrustum = 0x00000002",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ObjectCulling = 0x00000004",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "CalculateBoundingBox = 0x00000008",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "CalculateClippingPlanes = 0x00000010",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SetupLighting = 0x00000020",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DrawBackground = 0x00000040",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "PreDrawObjects = 0x00000080",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DrawObject = 0x00000100",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "PostDrawObjects = 0x00000200",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DrawForeGround = 0x00000400",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DrawOverlay = 0x00000800",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "PostProcessFrameBuffer = 0x00001000",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "MeshingParameters = 0x00002000",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ObjectDisplayAttributes = 0x00004000",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "PreObjectDraw = 0x00008000",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "PostObjectDraw = 0x00010000",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ViewExtents = 0x00020000",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DrawMiddleGround = PreDrawObjects | DrawObject | PostDrawObjects",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ObjectBasedChannel = ObjectCulling | DrawObject | ObjectDisplayAttributes | PreObjectDraw | PostObjectDraw",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "All = 0xFFFFFFFF & ~ViewExtents",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "DrawObjectEventArgs",
"dataType": "class",
"baseclass": "Rhino.Display.DrawEventArgs",
"properties": [
{
"signature": "bool DrawObject",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "RhinoObject RhinoObject",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "FlairLayer",
"dataType": "enum",
"values": [
{
"signature": "Normals = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Depth = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Shadows = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Shading = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Material = 4",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Details = 5",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Background = 6",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Selection = 7",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Unknown = -1",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "GradientType",
"dataType": "enum",
"summary": "Style of color gradient",
"since": "7.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No gradient"
},
{
"signature": "Linear = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Linear (or axial) gradient between two points"
},
{
"signature": "Radial = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Radial (or spherical) gradient using a center point and a radius"
},
{
"signature": "LinearDisabled = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Disabled linear gradient. Useful for keeping gradient information around, but not having it displayed"
},
{
"signature": "RadialDisabled = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Disabled radial gradient. Useful for keeping gradient information around, but not having it displayed"
}
]
},
{
"namespace": "Rhino.Display",
"name": "InitFrameBufferEventArgs",
"dataType": "class",
"baseclass": "EventArgs",
"methods": [
{
"signature": "System.Void SetFill(System.Drawing.Color topLeft, System.Drawing.Color bottomLeft, System.Drawing.Color topRight, System.Drawing.Color bottomRight)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.18"
},
{
"signature": "System.Void SetFill(System.Drawing.Color top, System.Drawing.Color bottom)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.18"
},
{
"signature": "System.Void SetFill(System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.18"
}
]
},
{
"namespace": "Rhino.Display",
"name": "IsoDrawEffect",
"dataType": "class",
"constructors": [
{
"signature": "IsoDrawEffect()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0"
}
],
"properties": [
{
"signature": "Vector3d Direction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool DiscardGap",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "IsoDrawMode DrawMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double Falloff",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int Frequency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color GapColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double GapSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Point3d Point",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double RotationRadians",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int UsedBandColorCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "Color GetBandColor(System.Int32 index)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0"
},
{
"signature": "System.Boolean SetBandColor(System.Int32 index, Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "IsoDrawMode",
"dataType": "enum",
"summary": "Defines how drawing should be performed when drawing with iso intervals aka zebra or banded drawing",
"since": "9.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DirectionalLight = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DirectionalLightXY = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DirectionalLightXYDots = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DirectionalLightCameraX = 4",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DirectionalLightCameraY = 5",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DirectionalLightCameraXY = 6",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DirectionalLightCameraXYDots = 7",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DirectionalLightCameraZ = 8",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "PointLight = 9",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "PointLightCamera = 10",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "CylindricalStatic = 11",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DirectionalDistance = 12",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DirectionalDistanceCamera = 13",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "IsometricCamera",
"dataType": "enum",
"summary": "Isometric camera orientation.",
"since": "8.10",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Northeast = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Northwest = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Southeast = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Southwest = 4",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "PageViewPropertiesChangeEventArgs",
"dataType": "class",
"summary": "PageView properties change event arguments.",
"baseclass": "EventArgs",
"since": "8.9",
"properties": [
{
"signature": "RhinoDoc Document",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the Rhino document.",
"since": "8.9",
"property": ["get"]
},
{
"signature": "uint DocumentSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The serial number of the Rhino document.",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "RhinoPageView PageView",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the Rhino page view.",
"since": "8.9",
"property": ["get"]
},
{
"signature": "uint PageViewSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The serial number of the page view.",
"since": "8.9",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "PageViewSpaceChangeEventArgs",
"dataType": "class",
"summary": "PageView space change event arguments.",
"baseclass": "EventArgs",
"since": "5.0",
"properties": [
{
"signature": "Guid NewActiveDetailId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The id of the detail object was set active. Note, if this id is equal to Guid.Empty, then the active detail object is the page view itself.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Guid OldActiveDetailId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The id of the previously active detail object. Note, if this id is equal to Guid.Empty, then the active detail object was the page view itself.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "RhinoPageView PageView",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The page view on which a different detail object was set active.",
"since": "5.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "PointStyle",
"dataType": "enum",
"summary": "Defines styles used for drawing points.",
"values": [
{
"signature": "Simple = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Square"
},
{
"signature": "ControlPoint = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Square with white center"
},
{
"signature": "ActivePoint = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Like a control point but includes vertical/horizontal crosshair lines."
},
{
"signature": "X = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "X shape"
},
{
"signature": "RoundSimple = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Circular"
},
{
"signature": "RoundControlPoint = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Circular with white center"
},
{
"signature": "RoundActivePoint = 6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Round control point with crosshair lines"
},
{
"signature": "Circle = RoundSimple",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Circle or ring shape when secondarySize is set"
},
{
"signature": "Square = Simple",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Square or diamond shape when rotated"
},
{
"signature": "Triangle = 7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Triangular shape"
},
{
"signature": "Heart = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Heart shape"
},
{
"signature": "Chevron = 9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Chevron shape (two directional arrows)"
},
{
"signature": "Clover = 10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Three unioned circles"
},
{
"signature": "Tag = 11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Tag shape"
},
{
"signature": "Asterisk = 12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "* shape"
},
{
"signature": "Pin = 13",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Map style pin symbol. secondarySize defines hole zie in pin"
},
{
"signature": "ArrowTail = 14",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Arrow shape with tail as definition point. Shape is offset from tail by secondarySize."
},
{
"signature": "ArrowTip = 15",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Arrow shape with tip as definition point. Shape is offset from tip by secondarySize."
},
{
"signature": "VariableDot = 50",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Solid filled, single color square"
},
{
"signature": "SolidSquare = VariableDot",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Solid filled, single color square"
},
{
"signature": "RoundDot = 51",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Solid filled, single color circle, same as SolidRound"
},
{
"signature": "SolidRound = RoundDot",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Solid filled, single color circle"
},
{
"signature": "SolidCircle = RoundDot",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Solid filled, single color circle"
},
{
"signature": "None = 1000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No style (unset)"
}
]
},
{
"namespace": "Rhino.Display",
"name": "RhinoPageView",
"dataType": "class",
"summary": "A window that contains a single layout 'page'",
"baseclass": "Rhino.Display.RhinoView",
"properties": [
{
"signature": "DetailViewObject ActiveDetail",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the active detail object. If no detail is active, or if the page is active, then None is returned.",
"since": "7.0",
"property": ["get"]
},
{
"signature": "Guid ActiveDetailId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the id of the active detail. If no detail is active, or if the page is active, then Guid.Empty is returned.",
"since": "7.0",
"property": ["get"]
},
{
"signature": "RhinoViewport ActiveViewport",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets the active viewport. The ActiveViewport is the same as the MainViewport for standard RhinoViews. In a RhinoPageView, the active viewport may be the RhinoViewport of a child detail object. Most of the time, you will use ActiveViewport unless you explicitly need to work with the main viewport.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string Description",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets and sets a brief description of the page view.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double PageHeight",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Height of the page in the document's PageUnitSystem",
"since": "5.10",
"property": ["get", "set"]
},
{
"signature": "bool PageIsActive",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if the page is active, rather than any detail view. This occurs when the MainViewport.Id == ActiveViewportID.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string PageName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Same as the MainViewport.Name.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int PageNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the runtime page number and updates the page number for all of the other pages. The first page has a value of 0.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int PageViewGroupCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the number of page view groups this page view belongs to.",
"since": "9.0",
"property": ["get"]
},
{
"signature": "double PageWidth",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Width of the page in the document's PageUnitSystem",
"since": "5.10",
"property": ["get", "set"]
},
{
"signature": "string PaperName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the name of the layout's media, or paper (e.g. Letter, Legal, A1, etc.), used to determine the page width and page height.",
"since": "6.15",
"property": ["get"]
},
{
"signature": "string PrinterName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the name of the layout's destination printer.",
"since": "6.15",
"property": ["get"]
}
],
"methods": [
{
"signature": "DetailViewObject AddDetailView(System.String title, Geometry.Point2d corner0, Geometry.Point2d corner1, DefinedViewportProjection initialProjection)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Creates a detail view object that is displayed on this page and adds it to the document.",
"since": "5.0",
"parameters": [
{
"name": "title",
"type": "System.String",
"summary": "The detail view title."
},
{
"name": "corner0",
"type": "Geometry.Point2d",
"summary": "Corners of the detail view in world coordinates."
},
{
"name": "corner1",
"type": "Geometry.Point2d",
"summary": "Corners of the detail view in world coordinates."
},
{
"name": "initialProjection",
"type": "DefinedViewportProjection",
"summary": "The defined initial projection type."
}
],
"returns": "Newly created detail view on success, None on error."
},
{
"signature": "System.Void AddToPageViewGroup(System.Int32 pageViewGroupIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Add this page view to a page view group.",
"since": "9.0",
"parameters": [
{
"name": "pageViewGroupIndex",
"type": "System.Int32",
"summary": "Zero-based index of the page view group."
}
]
},
{
"signature": "RhinoPageView Duplicate(System.Boolean duplicatePageGeometry)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Copies a page view.",
"since": "6.3",
"parameters": [
{
"name": "duplicatePageGeometry",
"type": "System.Boolean",
"summary": "Set True if you want the page view geometry copied, along with the view."
}
],
"returns": "The new page view if successful, None otherwise."
},
{
"signature": "DetailViewObject[] GetDetailViews()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a list of the detail view objects associated with this layout.",
"since": "5.0",
"returns": "An array of detail view objects if successful, an empty array if the layout has no details."
},
{
"signature": "System.Int32[] GetPageViewGroupList()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets an array of page view group indices this page view belongs to.",
"since": "9.0",
"returns": "An array of page view group indices if successful, otherwise an empty array."
},
{
"signature": "System.Drawing.Bitmap GetPreviewImage(System.Drawing.Size size, System.Boolean grayScale)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Creates a preview image of the page.",
"since": "7.0",
"parameters": [
{
"name": "size",
"type": "System.Drawing.Size",
"summary": "The size of the preview image."
},
{
"name": "grayScale",
"type": "System.Boolean",
"summary": "Set True to produce a grayscale image, False to produce a color image."
}
],
"returns": "A bitmap if successful, None otherwise."
},
{
"signature": "System.Boolean IsInPageViewGroup(System.Int32 pageViewGroupIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines if this page view belongs in a page view group.",
"since": "9.0",
"returns": "True if the page view belongs in the page view group, otherwise false."
},
{
"signature": "System.Int32 PageViewGroupSortIndex(System.Int32 pageViewGroupIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets this page view's sort index within a page view group. The sort index determines the order of the page view among the other members of the group, independent of the document page (view-table) order.",
"since": "9.0",
"parameters": [
{
"name": "pageViewGroupIndex",
"type": "System.Int32",
"summary": "Zero-based index of the page view group."
}
],
"returns": "The zero-based sort index, or RhinoMath.UnsetIntIndex when the page view is not in the group or the group is unsorted (uses page-number order)."
},
{
"signature": "System.Void RemoveFromAllageViewGroups()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes this page view to all page view groups.",
"since": "9.0"
},
{
"signature": "System.Void RemoveFromPageViewGroup(System.Int32 pageViewGroupIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes this page view to a page view group.",
"since": "9.0",
"parameters": [
{
"name": "pageViewGroupIndex",
"type": "System.Int32",
"summary": "Zero-based index of the page view group."
}
]
},
{
"signature": "System.Boolean SetActiveDetail(System.Guid detailId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the active detail.",
"since": "5.0",
"parameters": [
{
"name": "detailId",
"type": "System.Guid",
"summary": "The id of the detail view object to set active."
}
],
"returns": "True if successful, False otherwise."
},
{
"signature": "System.Boolean SetActiveDetail(System.String detailName, System.Boolean compareCase)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the active detail.",
"since": "5.0",
"parameters": [
{
"name": "detailName",
"type": "System.String",
"summary": "The name, or title, of the detail to set active."
},
{
"name": "compareCase",
"type": "System.Boolean",
"summary": "Unused."
}
],
"returns": "True if successful, False otherwise."
},
{
"signature": "System.Void SetPageAsActive()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Deactivates the active details and sets the page view as active.",
"since": "5.0"
},
{
"signature": "System.Void SetPageViewGroupSortIndex(System.Int32 pageViewGroupIndex, System.Int32 sortIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets this page view's sort index (position) within a page view group, repositioning it among the group's members and renumbering the rest so the group stays contiguously ordered. A sort index at or beyond the member count moves the page view to the end. If the page view is not yet in the group, it is added.",
"since": "9.0",
"parameters": [
{
"name": "pageViewGroupIndex",
"type": "System.Int32",
"summary": "Zero-based index of the page view group."
},
{
"name": "sortIndex",
"type": "System.Int32",
"summary": "The desired zero-based position within the group."
}
]
}
],
"events": [
{
"signature": "EventHandler PageViewPropertiesChange",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false
},
{
"signature": "EventHandler PageViewSpaceChange",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "RhinoView",
"dataType": "class",
"summary": "A RhinoView represents a single \"window\" display of a document. A view could contain one or many RhinoViewports (many in the case of Layout views with detail viewports). Standard Rhino modeling views have one viewport.",
"properties": [
{
"signature": "bool EnableDrawing",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 'drawing enabled' flag. By default, drawing is enabled. \nThere are some rare situations where scripts want to disable drawing for a while.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "RhinoViewport ActiveViewport",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "The ActiveViewport is the same as the MainViewport for standard RhinoViews. In a RhinoPageView, the active viewport may be the RhinoViewport of a child detail object. Most of the time, you will use ActiveViewport unless you explicitly need to work with the main viewport.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid ActiveViewportID",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns viewport ID for the active viewport. Faster than ActiveViewport function when working with page views.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Rectangle Bounds",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the size and location of the view including its non-client elements, in pixels, relative to the parent control.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Rectangle ClientRectangle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the rectangle that represents the client area of the view.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "DisplayPipeline DisplayPipeline",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the display pipeline used for this view.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "RhinoDoc Document",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool Floating",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Floating state of RhinoView. if true, then the view will be in a floating frame window. Otherwise the view will be embedded in the main frame.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "IntPtr Handle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the window handle that this view is bound to.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool InDynamicViewChange",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True if the view is being dynamically changed by mouse moves, arrow keys, trackballs, etc.",
"since": "8.1",
"property": ["get"]
},
{
"signature": "RhinoViewport MainViewport",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "A RhinoView contains a \"main viewport\" that fills the entire view client window. RhinoPageViews may also contain nested child RhinoViewports for implementing detail viewports. The MainViewport will always return this RhinoView's m_vp.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool Maximized",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "RealtimeDisplayMode RealtimeDisplayMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the RealtimeDisplayMode active for this view. None if the view doesn't have a RealtimeDisplayMode set.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "uint RuntimeSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "Rectangle ScreenRectangle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the rectangle that represents the client area of the view in screen coordinates.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Size Size",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the size of the view",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool TitleVisible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Visibility of the viewport title window.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "RhinoView FromRuntimeSerialNumber(System.UInt32 serialNumber)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get a RhinoView from it's unique runtime serial number",
"since": "6.0",
"returns": "RhinoView or None if no view exists for a given serial number"
},
{
"signature": "System.Drawing.Bitmap CaptureToBitmap()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Capture View contents to a bitmap.",
"since": "5.0",
"returns": "The bitmap of the complete view."
},
{
"signature": "System.Drawing.Bitmap CaptureToBitmap(DisplayModeDescription mode)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Capture View contents to a bitmap using a display mode description to define how drawing is performed.",
"since": "5.0",
"parameters": [
{
"name": "mode",
"type": "DisplayModeDescription",
"summary": "The display mode."
}
],
"returns": "A new bitmap."
},
{
"signature": "System.Drawing.Bitmap CaptureToBitmap(DisplayPipelineAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Captures view contents to a bitmap using display attributes to define how drawing is performed.",
"since": "5.0",
"parameters": [
{
"name": "attributes",
"type": "DisplayPipelineAttributes",
"summary": "The specific display mode attributes."
}
],
"returns": "A new bitmap."
},
{
"signature": "System.Drawing.Bitmap CaptureToBitmap(System.Boolean grid, System.Boolean worldAxes, System.Boolean cplaneAxes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Captures the view contents to a bitmap allowing for visibility of grid and axes.",
"since": "5.0",
"parameters": [
{
"name": "grid",
"type": "System.Boolean",
"summary": "True if the construction plane grid should be visible."
},
{
"name": "worldAxes",
"type": "System.Boolean",
"summary": "True if the world axis should be visible."
},
{
"name": "cplaneAxes",
"type": "System.Boolean",
"summary": "True if the construction plane close the grid should be visible."
}
],
"returns": "A new bitmap."
},
{
"signature": "System.Drawing.Bitmap CaptureToBitmap(System.Drawing.Size size, DisplayModeDescription mode)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Capture View contents to a bitmap using a display mode description to define how drawing is performed.",
"since": "5.0",
"parameters": [
{
"name": "size",
"type": "System.Drawing.Size",
"summary": "The width and height of the returned bitmap."
},
{
"name": "mode",
"type": "DisplayModeDescription",
"summary": "The display mode."
}
],
"returns": "A new bitmap."
},
{
"signature": "System.Drawing.Bitmap CaptureToBitmap(System.Drawing.Size size, DisplayPipelineAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Capture View contents to a bitmap using display attributes to define how drawing is performed.",
"since": "5.0",
"parameters": [
{
"name": "size",
"type": "System.Drawing.Size",
"summary": "The width and height of the returned bitmap."
},
{
"name": "attributes",
"type": "DisplayPipelineAttributes",
"summary": "The specific display mode attributes."
}
],
"returns": "A new bitmap."
},
{
"signature": "System.Drawing.Bitmap CaptureToBitmap(System.Drawing.Size size, System.Boolean grid, System.Boolean worldAxes, System.Boolean cplaneAxes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Captures a part of the view contents to a bitmap allowing for visibility of grid and axes.",
"since": "5.0",
"parameters": [
{
"name": "size",
"type": "System.Drawing.Size",
"summary": "The width and height of the returned bitmap."
},
{
"name": "grid",
"type": "System.Boolean",
"summary": "True if the construction plane grid should be visible."
},
{
"name": "worldAxes",
"type": "System.Boolean",
"summary": "True if the world axis should be visible."
},
{
"name": "cplaneAxes",
"type": "System.Boolean",
"summary": "True if the construction plane close the grid should be visible."
}
],
"returns": "A new bitmap."
},
{
"signature": "System.Drawing.Bitmap CaptureToBitmap(System.Drawing.Size size)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Capture View contents to a bitmap.",
"since": "5.0",
"parameters": [
{
"name": "size",
"type": "System.Drawing.Size",
"summary": "Size of Bitmap to capture to."
}
],
"returns": "The bitmap of the specified part of the view."
},
{
"signature": "Geometry.Point2d ClientToScreen(Geometry.Point2d clientPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Drawing.Point ClientToScreen(System.Drawing.Point clientPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean Close()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove this View from Rhino. DO NOT attempt to use this instance of this class after calling Close.",
"since": "5.0",
"returns": "True on success"
},
{
"signature": "System.Boolean CreateShadedPreviewImage(System.String imagePath, System.Drawing.Size size, System.Boolean ignoreHighlights, System.Boolean drawConstructionPlane, System.Boolean useGhostedShading)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Creates a bitmap preview image of model.",
"since": "5.0",
"parameters": [
{
"name": "imagePath",
"type": "System.String",
"summary": "[in] The name of the bitmap file to create. The extension of the imagePath controls the format of the bitmap file created (BMP, TGA, JPG, PCX, PNG, TIF)."
},
{
"name": "size",
"type": "System.Drawing.Size",
"summary": "[in] The width and height of the bitmap in pixels."
},
{
"name": "ignoreHighlights",
"type": "System.Boolean",
"summary": "True if highlighted elements should be drawn normally."
},
{
"name": "drawConstructionPlane",
"type": "System.Boolean",
"summary": "True if the CPlane should be drawn."
},
{
"name": "useGhostedShading",
"type": "System.Boolean",
"summary": "True if ghosted shading (partially transparent shading) should be used."
}
],
"returns": "True if successful."
},
{
"signature": "System.Boolean CreateWireframePreviewImage(System.String imagePath, System.Drawing.Size size, System.Boolean ignoreHighlights, System.Boolean drawConstructionPlane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Creates a bitmap preview image of model.",
"since": "5.0",
"parameters": [
{
"name": "imagePath",
"type": "System.String",
"summary": "[in] The name of the bitmap file to create. The extension of the imagePath controls the format of the bitmap file created (BMP, TGA, JPG, PCX, PNG, TIF)."
},
{
"name": "size",
"type": "System.Drawing.Size",
"summary": "[in] The width and height of the bitmap in pixels."
},
{
"name": "ignoreHighlights",
"type": "System.Boolean",
"summary": "True if highlighted elements should be drawn normally."
},
{
"name": "drawConstructionPlane",
"type": "System.Boolean",
"summary": "True if the CPlane should be drawn."
}
],
"returns": "True if successful."
},
{
"signature": "System.Boolean Equals(System.Object obj)",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false
},
{
"signature": "System.Int32 GetHashCode()",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false
},
{
"signature": "System.Boolean MouseCaptured(System.Boolean bIncludeMovement)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns whether or not the mouse is captured in this view.",
"since": "6.0",
"parameters": [
{
"name": "bIncludeMovement",
"type": "System.Boolean",
"summary": "If captured, test if the mouse has moved between mouse button down and mouse button up."
}
],
"returns": "True if captured, False otherwise."
},
{
"signature": "System.Void Redraw()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Redraws this view.",
"since": "5.0",
"remarks": "If you change something in \"this\" view like the projection, construction plane, background bitmap, etc., then you need to call RhinoView.Redraw() to redraw \"this\" view./ The other views will not be changed. If you change something in the document (like adding new geometry to the model), then you need to call RhinoDoc.Views.Redraw() to redraw all the views."
},
{
"signature": "Geometry.Point2d ScreenToClient(Geometry.Point2d screenPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.8"
},
{
"signature": "System.Drawing.Point ScreenToClient(System.Drawing.Point screenPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Converts a point in screen coordinates to client coordinates for this view.",
"since": "5.0",
"parameters": [
{
"name": "screenPoint",
"type": "System.Drawing.Point",
"summary": "The 2D screen point."
}
],
"returns": "A 2D point in client coordinates."
},
{
"signature": "System.UInt32 ShowToast(System.String message, System.Int32 textHeight, System.Drawing.PointF location)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shows a temporary popup message in the lower right corner of the view",
"since": "8.0",
"parameters": [
{
"name": "message",
"type": "System.String",
"summary": "The message to be shown"
},
{
"name": "textHeight",
"type": "System.Int32",
"summary": "The height of the message"
},
{
"name": "location",
"type": "System.Drawing.PointF",
"summary": "The location of the message"
}
],
"returns": "The runtime serial number of the view toast"
},
{
"signature": "System.UInt32 ShowToast(System.String message, System.Int32 textHeight)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shows a temporary popup message in the lower right corner of the view",
"since": "8.0",
"parameters": [
{
"name": "message",
"type": "System.String",
"summary": "The message to be shown"
},
{
"name": "textHeight",
"type": "System.Int32",
"summary": "The height of the message"
}
],
"returns": "The runtime serial number of the view toast"
},
{
"signature": "System.UInt32 ShowToast(System.String message)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Shows a temporary popup message in the lower right corner of the view",
"since": "8.0",
"parameters": [
{
"name": "message",
"type": "System.String",
"summary": "The message to be shown"
}
],
"returns": "The runtime serial number of the view toast"
},
{
"signature": "System.Double SpeedTest(System.Int32 frameCount, System.Boolean freezeDrawList, System.Int32 direction, System.Double angleDeltaRadians)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.8"
}
],
"events": [
{
"signature": "EventHandler EnableDrawingChanged",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Called when the state of EnableDrawing changes.",
"since": "8.15"
},
{
"signature": "EventHandler Create",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "EventHandler Destroy",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "EventHandler Modified",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "EventHandler Rename",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "EventHandler SetActive",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "RhinoViewport",
"dataType": "class",
"summary": "Displays geometry with a given projection. In standard modeling views there is a one to one relationship between RhinoView and RhinoViewports. In a page layout, there may be multiple RhinoViewports for a single layout.",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "RhinoViewport()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "RhinoViewport(RhinoViewport other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
],
"properties": [
{
"signature": "Rectangle Bounds",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the size and location of the viewport, in pixels, relative to the parent view.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "double Camera35mmLensLength",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double CameraAngle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 1/2 of smallest subtended view angle.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Vector3d CameraDirection",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "Point3d CameraLocation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "Point3d CameraTarget",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Viewport target point.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Vector3d CameraUp",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Vector3d CameraX",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the \"unit to the right\" vector.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Vector3d CameraY",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the \"unit up\" vector.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Vector3d CameraZ",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the unit vector in CameraDirection.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "uint ChangeCounter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The value of change counter is incremented every time the view projection or construction plane changes. The user can the mouse and nestable view manipulation commands to change a view at any time. The value of change counter can be used to detect these changes in code that is sensitive to the view projection.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool ConstructionAxesVisible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ConstructionGridVisible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "DisplayModeDescription DisplayMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double FrustumAspect",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the width/height ratio of the frustum.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid Id",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Unique id for this viewport.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsParallelProjection",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsPerspectiveProjection",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsPlanView",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True if construction plane z axis is parallel to camera direction.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsTwoPointPerspectiveProjection",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsValidCamera",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsValidFrustum",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool LockedProjection",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If true, the camera location, camera direction, and lens angle should not be changed.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "string Name",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Name associated with this viewport.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "RhinoView ParentView",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the parent view, if there is one Every RhinoView has an associated RhinoViewport that does all the 3d display work. Those associated viewports return the RhinoView as their parent view. However, RhinoViewports are used in other image creating contexts that do not have a parent RhinoView. If you call ParentView, you MUST check for NULL return values.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "double ScreenPortAspect",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "screen port's width/height.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Size Size",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get or set the height and width of the viewport (in pixels)",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int UserStringCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.18",
"property": ["get"]
},
{
"signature": "ViewportType ViewportType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "string WallpaperFilename",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool WallpaperGrayscale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool WallpaperVisible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool WorldAxesVisible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "RhinoViewport FromId(System.Guid id)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Call this method to get the viewport with the specified Id.",
"since": "6.0",
"parameters": [
{
"name": "id",
"type": "System.Guid",
"summary": "Id to search for."
}
],
"returns": "Returns a RhinoViewport if the Id is found otherwise null."
},
{
"signature": "System.Boolean ChangeToParallelProjection(System.Boolean symmetricFrustum)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Use this function to change projections of valid viewports from perspective to parallel. It will make common additional adjustments to the frustum so the resulting views are similar. The camera location and direction will not be changed.",
"since": "5.0",
"parameters": [
{
"name": "symmetricFrustum",
"type": "System.Boolean",
"summary": "True if you want the resulting frustum to be symmetric."
}
],
"returns": "If the current projection is parallel and bSymmetricFrustum, FrustumIsLeftRightSymmetric() and FrustumIsTopBottomSymmetric() are all equal, then no changes are made and True is returned."
},
{
"signature": "System.Boolean ChangeToParallelReflectedProjection()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When a viewport is set to Parallel Reflected projection, the geometry on the ceiling is shown as if it is mirrored to the floor below.",
"since": "8.14"
},
{
"signature": "System.Boolean ChangeToPerspectiveProjection(System.Boolean symmetricFrustum, System.Double lensLength)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Use this function to change projections of valid viewports from parallel to perspective. It will make common additional adjustments to the frustum and camera location so the resulting views are similar. The camera direction and target point are not be changed.",
"since": "5.0",
"parameters": [
{
"name": "symmetricFrustum",
"type": "System.Boolean",
"summary": "True if you want the resulting frustum to be symmetric."
},
{
"name": "lensLength",
"type": "System.Double",
"summary": "(pass 50.0 when in doubt) 35 mm lens length to use when changing from parallel to perspective projections. If the current projection is perspective or lens_length is <= 0.0, then this parameter is ignored."
}
],
"returns": "If the current projection is perspective and bSymmetricFrustum, FrustumIsLeftRightSymmetric() and FrustumIsTopBottomSymmetric() are all equal, then no changes are made and True is returned."
},
{
"signature": "System.Boolean ChangeToPerspectiveProjection(System.Double targetDistance, System.Boolean symmetricFrustum, System.Double lensLength)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Use this function to change projections of valid viewports from parallel to perspective. It will make common additional adjustments to the frustum and camera location so the resulting views are similar. The camera direction and target point are not be changed.",
"since": "5.0",
"parameters": [
{
"name": "targetDistance",
"type": "System.Double",
"summary": "If RhinoMath.UnsetValue this parameter is ignored. Otherwise it must be > 0 and indicates which plane in the current view frustum should be preserved."
},
{
"name": "symmetricFrustum",
"type": "System.Boolean",
"summary": "True if you want the resulting frustum to be symmetric."
},
{
"name": "lensLength",
"type": "System.Double",
"summary": "(pass 50.0 when in doubt) 35 mm lens length to use when changing from parallel to perspective projections. If the current projection is perspective or lens_length is <= 0.0, then this parameter is ignored."
}
],
"returns": "If the current projection is perspective and bSymmetricFrustum, FrustumIsLeftRightSymmetric() and FrustumIsTopBottomSymmetric() are all equal, then no changes are made and True is returned."
},
{
"signature": "System.Boolean ChangeToTwoPointPerspectiveProjection(System.Double targetDistance, Rhino.Geometry.Vector3d up, System.Double lensLength)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Use this function to change projections of valid viewports to a two point perspective. It will make common additional adjustments to the frustum and camera location and direction so the resulting views are similar.",
"since": "6.0",
"parameters": [
{
"name": "targetDistance",
"type": "System.Double",
"summary": "If RhinoMath.UnsetValue this parameter is ignored. Otherwise it must be > 0 and indicates which plane in the current view frustum should be preserved."
},
{
"name": "up",
"type": "Rhino.Geometry.Vector3d",
"summary": "This direction will be the locked up direction. Pass ON_3dVector::ZeroVector if you want to use the world axis direction that is closest to the current up direction. Pass CameraY() if you want to preserve the current up direction."
},
{
"name": "lensLength",
"type": "System.Double",
"summary": "(pass 50.0 when in doubt) 35 mm lens length to use when changing from parallel to perspective projections. If the current projection is perspective or lens_length is <= 0.0, then this parameter is ignored."
}
],
"returns": "If the current projection is perspective and bSymmetricFrustum, FrustumIsLeftRightSymmetric() and FrustumIsTopBottomSymmetric() are all equal, then no changes are made and True is returned."
},
{
"signature": "System.Boolean ChangeToTwoPointPerspectiveProjection(System.Double lensLength)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Use this function to change projections of valid viewports to a two point perspective. It will make common additional adjustments to the frustum and camera location and direction so the resulting views are similar.",
"since": "6.0",
"parameters": [
{
"name": "lensLength",
"type": "System.Double",
"summary": "(pass 50.0 when in doubt) 35 mm lens length to use when changing from parallel to perspective projections. If the current projection is perspective or lens_length is <= 0.0, then this parameter is ignored."
}
],
"returns": "If the current projection is perspective and bSymmetricFrustum, FrustumIsLeftRightSymmetric() and FrustumIsTopBottomSymmetric() are all equal, then no changes are made and True is returned."
},
{
"signature": "System.Void ClearTraceImage()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove trace image (background bitmap) for this viewport if one exists.",
"since": "5.0"
},
{
"signature": "System.Drawing.Point ClientToScreen(Point2d clientPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Drawing.Point ClientToScreen(System.Drawing.Point clientPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Line ClientToWorld(Point2d clientPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Line ClientToWorld(System.Drawing.Point clientPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Plane ConstructionPlane()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Simple plane information for this viewport's construction plane. If you want detailed construction plane information, use GetConstructionPlane.",
"since": "5.0"
},
{
"signature": "System.Void DeleteAllUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.18"
},
{
"signature": "System.Boolean DeleteUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.18"
},
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true
},
{
"signature": "System.Boolean GetCameraAngle(out System.Double halfDiagonalAngle, out System.Double halfVerticalAngle, out System.Double halfHorizontalAngle)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "BoundingBox GetCameraExtents(IEnumerable points)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean GetCameraFrame(out Plane frame)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the camera plane.",
"since": "5.0",
"parameters": [
{
"name": "frame",
"type": "Plane",
"summary": "A plane is assigned to this out parameter during the call, if the operation succeeded."
}
],
"returns": "True if current camera orientation is valid."
},
{
"signature": "DocObjects.ConstructionPlane GetConstructionPlane()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean GetDepth(BoundingBox bbox, out System.Double nearDistance, out System.Double farDistance)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets near and far clipping distances of a bounding box.",
"since": "5.0",
"parameters": [
{
"name": "bbox",
"type": "BoundingBox",
"summary": "The bounding box."
},
{
"name": "nearDistance",
"type": "System.Double",
"summary": "The near distance is assigned to this out parameter during this call."
},
{
"name": "farDistance",
"type": "System.Double",
"summary": "The far distance is assigned to this out parameter during this call."
}
],
"returns": "True if the bounding box intersects the view frustum and near_dist/far_dist were set. False if the bounding box does not intersect the view frustum."
},
{
"signature": "System.Boolean GetDepth(Point3d point, out System.Double distance)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets clipping distance of a point.",
"since": "5.0",
"parameters": [
{
"name": "point",
"type": "Point3d",
"summary": "A 3D point."
},
{
"name": "distance",
"type": "System.Double",
"summary": "A computed distance is assigned to this out parameter if this call succeeds."
}
],
"returns": "True if the point is in the view frustum and near_dist/far_dist were set. False if the bounding box does not intersect the view frustum."
},
{
"signature": "System.Boolean GetDepth(Sphere sphere, out System.Double nearDistance, out System.Double farDistance)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets near and far clipping distances of a sphere.",
"since": "5.0",
"parameters": [
{
"name": "sphere",
"type": "Sphere",
"summary": "The sphere."
},
{
"name": "nearDistance",
"type": "System.Double",
"summary": "The near distance is assigned to this out parameter during this call."
},
{
"name": "farDistance",
"type": "System.Double",
"summary": "The far distance is assigned to this out parameter during this call."
}
],
"returns": "True if the sphere intersects the view frustum and near_dist/far_dist were set. False if the sphere does not intersect the view frustum."
},
{
"signature": "Point3d[] GetFarRect()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get corners of far clipping plane rectangle.",
"since": "5.0",
"returns": "[left_bottom, right_bottom, left_top, right_top] points on success None on failure."
},
{
"signature": "System.Boolean GetFrustum(out System.Double left, out System.Double right, out System.Double bottom, out System.Double top, out System.Double nearDistance, out System.Double farDistance)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the view frustum.",
"since": "5.0",
"parameters": [
{
"name": "left",
"type": "System.Double",
"summary": "left < right."
},
{
"name": "right",
"type": "System.Double",
"summary": "left < right."
},
{
"name": "bottom",
"type": "System.Double",
"summary": "bottom < top."
},
{
"name": "top",
"type": "System.Double",
"summary": "bottom < top."
},
{
"name": "nearDistance",
"type": "System.Double",
"summary": "0 < nearDistance < farDistance."
},
{
"name": "farDistance",
"type": "System.Double",
"summary": "0 < nearDistance < farDistance."
}
],
"returns": "True if operation succeeded."
},
{
"signature": "System.Boolean GetFrustumBottomPlane(out Plane plane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get bottom world frustum clipping plane.",
"since": "5.0",
"parameters": [
{
"name": "plane",
"type": "Plane",
"summary": "frustum bottom side clipping plane. The normal points into the visible region of the frustum. If the projection is perspective, the origin is at the camera location, otherwise the origin is the point on the plane that is closest to the camera location."
}
],
"returns": "True if camera and frustum are valid and plane was set."
},
{
"signature": "BoundingBox GetFrustumBoundingBox()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean GetFrustumCenter(out Point3d center)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns world coordinates of frustum's center.",
"since": "5.0",
"parameters": [
{
"name": "center",
"type": "Point3d",
"summary": "The center coordinate is assigned to this out parameter if this call succeeds."
}
],
"returns": "True if the center was successfully computed."
},
{
"signature": "System.Boolean GetFrustumFarPlane(out Plane plane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get far clipping plane.",
"since": "5.0",
"parameters": [
{
"name": "plane",
"type": "Plane",
"summary": "far clipping plane if camera and frustum are valid. The plane's frame is the same as the camera's frame. The origin is located at the intersection of the camera direction ray and the far clipping plane."
}
],
"returns": "True if camera and frustum are valid."
},
{
"signature": "System.Boolean GetFrustumLeftPlane(out Plane plane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get left world frustum clipping plane.",
"since": "5.0",
"parameters": [
{
"name": "plane",
"type": "Plane",
"summary": "frustum left side clipping plane. The normal points into the visible region of the frustum. If the projection is perspective, the origin is at the camera location, otherwise the origin is the point on the plane that is closest to the camera location."
}
],
"returns": "True if camera and frustum are valid and plane was set."
},
{
"signature": "System.Boolean GetFrustumLine(System.Double screenX, System.Double screenY, out Line worldLine)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the world coordinate line in the view frustum that projects to a point on the screen.",
"since": "5.0",
"parameters": [
{
"name": "screenX",
"type": "System.Double",
"summary": "(screenx,screeny) = screen location."
},
{
"name": "screenY",
"type": "System.Double",
"summary": "(screenx,screeny) = screen location."
},
{
"name": "worldLine",
"type": "Line",
"summary": "3d world coordinate line segment starting on the near clipping plane and ending on the far clipping plane."
}
],
"returns": "True if successful. False if view projection or frustum is invalid."
},
{
"signature": "System.Boolean GetFrustumNearPlane(out Plane plane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get near clipping plane.",
"since": "5.0",
"parameters": [
{
"name": "plane",
"type": "Plane",
"summary": "near clipping plane if camera and frustum are valid. The plane's frame is the same as the camera's frame. The origin is located at the intersection of the camera direction ray and the near clipping plane."
}
],
"returns": "True if camera and frustum are valid."
},
{
"signature": "System.Boolean GetFrustumRightPlane(out Plane plane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get right world frustum clipping plane.",
"since": "5.0",
"parameters": [
{
"name": "plane",
"type": "Plane",
"summary": "frustum right side clipping plane. The normal points into the visible region of the frustum. If the projection is perspective, the origin is at the camera location, otherwise the origin is the point on the plane that is closest to the camera location."
}
],
"returns": "True if camera and frustum are valid and plane was set."
},
{
"signature": "System.Boolean GetFrustumTopPlane(out Plane plane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get top world frustum clipping plane.",
"since": "5.0",
"parameters": [
{
"name": "plane",
"type": "Plane",
"summary": "frustum top side clipping plane. The normal points into the visible region of the frustum. If the projection is perspective, the origin is at the camera location, otherwise the origin is the point on the plane that is closest to the camera location."
}
],
"returns": "True if camera and frustum are valid and plane was set."
},
{
"signature": "Point3d[] GetNearRect()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get corners of near clipping plane rectangle.",
"since": "5.0",
"returns": "[left_bottom, right_bottom, left_top, right_top] points on success None on failure."
},
{
"signature": "Transform GetPickTransform(System.Drawing.Point clientPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Takes a rectangle in screen coordinates and returns a transformation that maps the 3d frustum defined by the rectangle to a -1/+1 clipping coordinate box. This takes a single point and inflates it by Rhino.ApplicationSettings.ModelAidSettings.MousePickBoxRadius to define the screen rectangle.",
"since": "5.0",
"parameters": [
{
"name": "clientPoint",
"type": "System.Drawing.Point",
"summary": "The client point."
}
],
"returns": "A transformation matrix."
},
{
"signature": "Transform GetPickTransform(System.Drawing.Rectangle clientRectangle)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Takes a rectangle in screen coordinates and returns a transformation that maps the 3d frustum defined by the rectangle to a -1/+1 clipping coordinate box.",
"since": "5.0",
"parameters": [
{
"name": "clientRectangle",
"type": "System.Drawing.Rectangle",
"summary": "The client rectangle."
}
],
"returns": "A transformation matrix."
},
{
"signature": "Transform GetPickTransform(System.Int32 clientX, System.Int32 clientY)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Takes a rectangle in screen coordinates and returns a transformation that maps the 3d frustum defined by the rectangle to a -1/+1 clipping coordinate box. This takes a single point and inflates it by Rhino.ApplicationSettings.ModelAidSettings.MousePickBoxRadius to define the screen rectangle.",
"since": "5.0",
"parameters": [
{
"name": "clientX",
"type": "System.Int32",
"summary": "The client point X coordinate."
},
{
"name": "clientY",
"type": "System.Int32",
"summary": "The client point Y coordinate."
}
],
"returns": "A transformation matrix."
},
{
"signature": "System.Boolean GetScreenPort(out System.Int32 portLeft, out System.Int32 portRight, out System.Int32 portBottom, out System.Int32 portTop, out System.Int32 portNear, out System.Int32 portFar)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Location of viewport in pixels. These are provided so you can set the port you are using and get the appropriate transformations to and from screen space.",
"since": "5.0",
"parameters": [
{
"name": "portLeft",
"type": "System.Int32",
"summary": "portLeft != portRight."
},
{
"name": "portRight",
"type": "System.Int32",
"summary": "portLeft != portRight."
},
{
"name": "portBottom",
"type": "System.Int32",
"summary": "portTop != portBottom."
},
{
"name": "portTop",
"type": "System.Int32",
"summary": "portTop != portBottom."
},
{
"name": "portNear",
"type": "System.Int32",
"summary": "The viewport near value."
},
{
"name": "portFar",
"type": "System.Int32",
"summary": "The viewport far value."
}
],
"returns": "True if the operation is successful."
},
{
"signature": "Transform GetTransform(DocObjects.CoordinateSystem sourceSystem, DocObjects.CoordinateSystem destinationSystem)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a transform from origin coordinate system to a target coordinate system.",
"since": "5.0",
"parameters": [
{
"name": "sourceSystem",
"type": "DocObjects.CoordinateSystem",
"summary": "The origin coordinate system."
},
{
"name": "destinationSystem",
"type": "DocObjects.CoordinateSystem",
"summary": "The target coordinate system."
}
],
"returns": "4x4 transformation matrix (acts on the left) Identity matrix is returned if this function fails."
},
{
"signature": "System.String GetUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a user string.",
"since": "6.18",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve the string."
}
],
"returns": "string associated with the key if successful. None if no key was found."
},
{
"signature": "System.Collections.Specialized.NameValueCollection GetUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets an independent copy of the collection of (user text key, user text value) pairs attached to this object.",
"since": "6.18",
"returns": "A collection of key strings and values strings. This"
},
{
"signature": "System.Double[] GetViewScale()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get Scale transform applied to the viewport",
"since": "8.0"
},
{
"signature": "System.Boolean GetWorldToScreenScale(Point3d pointInFrustum, out System.Double pixelsPerUnit)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the world to screen size scaling factor at a point in frustum.",
"since": "5.0",
"parameters": [
{
"name": "pointInFrustum",
"type": "Point3d",
"summary": "A point in frustum."
},
{
"name": "pixelsPerUnit",
"type": "System.Double",
"summary": "scale = number of pixels per world unit at the 3d point. \nThis out parameter is assigned during this call."
}
],
"returns": "True if the operation is successful."
},
{
"signature": "System.Boolean IsVisible(BoundingBox bbox)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if some portion of a world coordinate bounding box is potentially visible in the viewing frustum.",
"since": "5.0",
"parameters": [
{
"name": "bbox",
"type": "BoundingBox",
"summary": "A bounding box that is tested for visibility."
}
],
"returns": "True if the box is potentially visible; otherwise false."
},
{
"signature": "System.Boolean IsVisible(Point3d point)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines if a world coordinate point is visible in the viewing frustum.",
"since": "5.0",
"parameters": [
{
"name": "point",
"type": "Point3d",
"summary": "A point that is tested for visibility."
}
],
"returns": "True if the point is visible; otherwise false."
},
{
"signature": "System.Boolean KeyboardDolly(System.Boolean leftRight, System.Double amount)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Emulates the keyboard arrow key in terms of interaction.",
"since": "5.0",
"parameters": [
{
"name": "leftRight",
"type": "System.Boolean",
"summary": "left/right dolly if true, up/down dolly if false."
},
{
"name": "amount",
"type": "System.Double",
"summary": "The dolly amount."
}
],
"returns": "True if operation succeeded; otherwise false."
},
{
"signature": "System.Boolean KeyboardDollyInOut(System.Double amount)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Emulates the keyboard arrow key in terms of interaction.",
"since": "5.0",
"parameters": [
{
"name": "amount",
"type": "System.Double",
"summary": "The dolly amount."
}
],
"returns": "True if operation succeeded; otherwise false."
},
{
"signature": "System.Boolean KeyboardRotate(System.Boolean leftRight, System.Double angleRadians)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Emulates the keyboard arrow key in terms of interaction.",
"since": "5.0",
"parameters": [
{
"name": "leftRight",
"type": "System.Boolean",
"summary": "left/right rotate if true, up/down rotate if false."
},
{
"name": "angleRadians",
"type": "System.Double",
"summary": "If less than 0, rotation is to left or down. If greater than 0, rotation is to right or up."
}
],
"returns": "True if operation succeeded; otherwise false."
},
{
"signature": "System.Boolean Magnify(System.Double magnificationFactor, System.Boolean mode, System.Drawing.Point fixedScreenPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Zooms or dollies in order to scale the viewport projection of observed objects.",
"since": "5.0",
"parameters": [
{
"name": "magnificationFactor",
"type": "System.Double",
"summary": "The scale factor."
},
{
"name": "mode",
"type": "System.Boolean",
"summary": "False = perform a \"dolly\" magnification by moving the camera towards/away from the target so that the amount of the screen subtended by an object changes. True = perform a \"zoom\" magnification by adjusting the \"lens\" angle"
},
{
"name": "fixedScreenPoint",
"type": "System.Drawing.Point",
"summary": "A point in the screen that should remain fixed."
}
],
"returns": "True if operation succeeded; otherwise false."
},
{
"signature": "System.Boolean Magnify(System.Double magnificationFactor, System.Boolean mode)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Zooms or dollies in order to scale the viewport projection of observed objects.",
"since": "5.0",
"parameters": [
{
"name": "magnificationFactor",
"type": "System.Double",
"summary": "The scale factor."
},
{
"name": "mode",
"type": "System.Boolean",
"summary": "False = perform a \"dolly\" magnification by moving the camera towards/away from the target so that the amount of the screen subtended by an object changes. True = perform a \"zoom\" magnification by adjusting the \"lens\" angle"
}
],
"returns": "True if operation succeeded; otherwise false."
},
{
"signature": "System.Boolean MouseAdjustLensLength(System.Drawing.Point mousePreviousPoint, System.Drawing.Point mouseCurrentPoint, System.Boolean moveTarget)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adjusts the camera lens length.",
"since": "6.0",
"parameters": [
{
"name": "mousePreviousPoint",
"type": "System.Drawing.Point",
"summary": "The mouse previous point."
},
{
"name": "mouseCurrentPoint",
"type": "System.Drawing.Point",
"summary": "The mouse current point."
},
{
"name": "moveTarget",
"type": "System.Boolean",
"summary": "Should this operation move the target?"
}
]
},
{
"signature": "System.Boolean MouseDollyZoom(System.Drawing.Point mousePreviousPoint, System.Drawing.Point mouseCurrentPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Zooms lens (thus adjusting the field of view) while moving the camera.",
"since": "5.0",
"parameters": [
{
"name": "mousePreviousPoint",
"type": "System.Drawing.Point",
"summary": "The mouse previous point."
},
{
"name": "mouseCurrentPoint",
"type": "System.Drawing.Point",
"summary": "The mouse current point."
}
]
},
{
"signature": "System.Boolean MouseInOutDolly(System.Drawing.Point mousePreviousPoint, System.Drawing.Point mouseCurrentPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Moves the camera towards or away from the view maintaining focus on the view.",
"since": "5.0",
"parameters": [
{
"name": "mousePreviousPoint",
"type": "System.Drawing.Point",
"summary": "The mouse previous point."
},
{
"name": "mouseCurrentPoint",
"type": "System.Drawing.Point",
"summary": "The mouse current point."
}
]
},
{
"signature": "System.Boolean MouseLateralDolly(System.Drawing.Point mousePreviousPoint, System.Drawing.Point mouseCurrentPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Pans the camera",
"since": "6.0",
"parameters": [
{
"name": "mousePreviousPoint",
"type": "System.Drawing.Point",
"summary": "The mouse previous point."
},
{
"name": "mouseCurrentPoint",
"type": "System.Drawing.Point",
"summary": "The mouse current point."
}
]
},
{
"signature": "System.Boolean MouseMagnify(System.Drawing.Point mousePreviousPoint, System.Drawing.Point mouseCurrentPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Moves the camera towards or away from the view.",
"since": "5.0",
"parameters": [
{
"name": "mousePreviousPoint",
"type": "System.Drawing.Point",
"summary": "The mouse previous point."
},
{
"name": "mouseCurrentPoint",
"type": "System.Drawing.Point",
"summary": "The mouse current point."
}
]
},
{
"signature": "System.Boolean MouseRotateAroundTarget(System.Drawing.Point mousePreviousPoint, System.Drawing.Point mouseCurrentPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Rotates the viewport around target.",
"since": "5.0",
"parameters": [
{
"name": "mousePreviousPoint",
"type": "System.Drawing.Point",
"summary": "The mouse previous point."
},
{
"name": "mouseCurrentPoint",
"type": "System.Drawing.Point",
"summary": "The mouse current point."
}
]
},
{
"signature": "System.Boolean MouseRotateCamera(System.Drawing.Point mousePreviousPoint, System.Drawing.Point mouseCurrentPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Rotates the view around the camera location.",
"since": "5.0",
"parameters": [
{
"name": "mousePreviousPoint",
"type": "System.Drawing.Point",
"summary": "The mouse previous point."
},
{
"name": "mouseCurrentPoint",
"type": "System.Drawing.Point",
"summary": "The mouse current point."
}
]
},
{
"signature": "System.Boolean MouseTilt(System.Drawing.Point mousePreviousPoint, System.Drawing.Point mouseCurrentPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Tilts the camera view.",
"since": "5.0",
"parameters": [
{
"name": "mousePreviousPoint",
"type": "System.Drawing.Point",
"summary": "The mouse previous point."
},
{
"name": "mouseCurrentPoint",
"type": "System.Drawing.Point",
"summary": "The mouse current point."
}
]
},
{
"signature": "System.Boolean NextConstructionPlane()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the construction plane to the plane that was active before the last call to PreviousConstructionPlane.",
"since": "5.0",
"returns": "True if successful."
},
{
"signature": "System.Boolean NextViewProjection()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the view projection and target to the settings that were active before the last call to PrevView.",
"since": "5.0",
"returns": "True if the view stack was popped."
},
{
"signature": "System.Boolean PopConstructionPlane()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the construction plane to the plane that was active before the last call to PushConstructionPlane.",
"since": "5.0",
"returns": "True if a construction plane was popped."
},
{
"signature": "System.Boolean PopViewProjection()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the view projection and target to the settings at the top of the view stack and removes those settings from the view stack.",
"since": "5.0",
"returns": "True if there were settings that could be popped from the stack."
},
{
"signature": "System.Boolean PreviousConstructionPlane()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the construction plane to the plane that was active before the last call to NextConstructionPlane or SetConstructionPlane.",
"since": "5.0",
"returns": "True if successful."
},
{
"signature": "System.Boolean PreviousViewProjection()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the view projection and target to the settings that were active before the last call to NextViewProjection.",
"since": "5.0",
"returns": "True if the view stack was popped."
},
{
"signature": "System.Void PushConstructionPlane(DocObjects.ConstructionPlane cplane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Pushes the current construction plane on the viewport's construction plane stack and sets the construction plane to cplane.",
"since": "5.0",
"parameters": [
{
"name": "cplane",
"type": "DocObjects.ConstructionPlane",
"summary": "The construction plane to push."
}
]
},
{
"signature": "System.Boolean PushViewInfo(DocObjects.ViewInfo viewinfo, System.Boolean includeTraceImage)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void PushViewProjection()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Appends the current view projection and target to the viewport's view stack.",
"since": "5.0"
},
{
"signature": "System.Boolean Rotate(System.Double angleRadians, Vector3d rotationAxis, Point3d rotationCenter)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Rotates about the specified axis. A positive rotation angle results in a counter-clockwise rotation about the axis (right hand rule).",
"since": "5.0",
"parameters": [
{
"name": "angleRadians",
"type": "System.Double",
"summary": "angle of rotation in radians."
},
{
"name": "rotationAxis",
"type": "Vector3d",
"summary": "direction of the axis of rotation."
},
{
"name": "rotationCenter",
"type": "Point3d",
"summary": "point on the axis of rotation."
}
],
"returns": "True if geometry successfully rotated."
},
{
"signature": "System.Drawing.Point ScreenToClient(System.Drawing.Point screenPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void SetCameraDirection(Vector3d cameraDirection, System.Boolean updateTargetLocation)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set viewport camera direction. By default the target location is changed so that the vector from the camera location to the target is parallel to the camera direction.",
"since": "5.0",
"parameters": [
{
"name": "cameraDirection",
"type": "Vector3d",
"summary": "new camera direction."
},
{
"name": "updateTargetLocation",
"type": "System.Boolean",
"summary": "if true, the target location is changed so that the vector from the camera location to the target is parallel to the camera direction. If false, the target location is not changed. See the remarks section of RhinoViewport.SetTarget for important details."
}
]
},
{
"signature": "System.Void SetCameraLocation(Point3d cameraLocation, System.Boolean updateTargetLocation)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set viewport camera location. By default the target location is changed so that the vector from the camera location to the target is parallel to the camera direction vector.",
"since": "5.0",
"parameters": [
{
"name": "cameraLocation",
"type": "Point3d",
"summary": "new camera location."
},
{
"name": "updateTargetLocation",
"type": "System.Boolean",
"summary": "if true, the target location is changed so that the vector from the camera location to the target is parallel to the camera direction vector. If false, the target location is not changed. See the remarks section of RhinoViewport.SetTarget for important details."
}
]
},
{
"signature": "System.Void SetCameraLocations(Point3d targetLocation, Point3d cameraLocation)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set viewport camera location and target location. The camera direction vector is changed so that it is parallel to the vector from the camera location to the target location.",
"since": "5.0",
"parameters": [
{
"name": "targetLocation",
"type": "Point3d",
"summary": "new target location."
},
{
"name": "cameraLocation",
"type": "Point3d",
"summary": "new camera location."
}
]
},
{
"signature": "System.Void SetCameraTarget(Point3d targetLocation, System.Boolean updateCameraLocation)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set viewport target point. By default the camera location is translated so that the camera direction vector is parallel to the vector from the camera location to the target location.",
"since": "5.0",
"remarks": "In general, Rhino users expect to have the camera direction vector and the vector from the camera location to the target location to be parallel. If you use the RhinoViewport functions to set the camera location, camera direction, and target point, then the relationship between these three points and vectors is automatically maintained. If you directly manipulate the camera properties, then you should carefully set the target by calling SetTarget() with updateCameraLocation=false.",
"parameters": [
{
"name": "targetLocation",
"type": "Point3d",
"summary": "new target location."
},
{
"name": "updateCameraLocation",
"type": "System.Boolean",
"summary": "if true, the camera location is translated so that the camera direction vector is parallel to the vector from the camera location to the target location. If false, the camera location is not changed."
}
]
},
{
"signature": "System.Void SetClippingPlanes(BoundingBox box)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets optimal clipping planes to view objects in a world coordinate 3d bounding box.",
"since": "5.0",
"parameters": [
{
"name": "box",
"type": "BoundingBox",
"summary": "The bounding box"
}
]
},
{
"signature": "System.Void SetConstructionPlane(DocObjects.ConstructionPlane cplane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the construction plane to cplane.",
"since": "5.0",
"parameters": [
{
"name": "cplane",
"type": "DocObjects.ConstructionPlane",
"summary": "The construction plane to set."
}
]
},
{
"signature": "System.Void SetConstructionPlane(Plane plane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetProjection(DefinedViewportProjection projection, System.String viewName, System.Boolean updateConstructionPlane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set viewport to a defined projection.",
"since": "5.0",
"parameters": [
{
"name": "projection",
"type": "DefinedViewportProjection",
"summary": "The \"standard\" projection type."
},
{
"name": "viewName",
"type": "System.String",
"summary": "If not None or empty, the name is set."
},
{
"name": "updateConstructionPlane",
"type": "System.Boolean",
"summary": "If true, the construction plane is set to the viewport plane."
}
],
"returns": "True if successful."
},
{
"signature": "System.Boolean SetProjection(IsometricCamera projection, System.String viewName, System.Boolean updateConstructionPlane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set viewport to a defined projection.",
"since": "9.0",
"parameters": [
{
"name": "projection",
"type": "IsometricCamera",
"summary": "The \"isometric\" projection type."
},
{
"name": "viewName",
"type": "System.String",
"summary": "If not None or empty, the name is set."
},
{
"name": "updateConstructionPlane",
"type": "System.Boolean",
"summary": "If true, the construction plane is set to the viewport plane."
}
],
"returns": "True if successful."
},
{
"signature": "System.Boolean SetScreenPort(System.Int32 portLeft, System.Int32 portRight, System.Int32 portBottom, System.Int32 portTop, System.Int32 portNear, System.Int32 portFar)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Location of viewport in pixels. These are provided so you can set the port you are using and get the appropriate transformations to and from screen space.",
"since": "9.0",
"parameters": [
{
"name": "portLeft",
"type": "System.Int32",
"summary": "portLeft != portRight."
},
{
"name": "portRight",
"type": "System.Int32",
"summary": "portLeft != portRight."
},
{
"name": "portBottom",
"type": "System.Int32",
"summary": "portTop != portBottom."
},
{
"name": "portTop",
"type": "System.Int32",
"summary": "portTop != portBottom."
},
{
"name": "portNear",
"type": "System.Int32",
"summary": "The viewport near value."
},
{
"name": "portFar",
"type": "System.Int32",
"summary": "The viewport far value."
}
],
"returns": "True if the operation is successful."
},
{
"signature": "System.Boolean SetToPlanView(Point3d planeOrigin, Vector3d planeXaxis, Vector3d planeYaxis, System.Boolean setConstructionPlane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetTraceImage(System.String bitmapFileName, Plane plane, System.Double width, System.Double height, System.Boolean grayscale, System.Boolean filtered)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set trace image (background bitmap) for this viewport.",
"since": "5.0",
"parameters": [
{
"name": "bitmapFileName",
"type": "System.String",
"summary": "The bitmap file name."
},
{
"name": "plane",
"type": "Plane",
"summary": "A picture plane."
},
{
"name": "width",
"type": "System.Double",
"summary": "The picture width."
},
{
"name": "height",
"type": "System.Double",
"summary": "The picture height."
},
{
"name": "grayscale",
"type": "System.Boolean",
"summary": "True if the picture should be in grayscale."
},
{
"name": "filtered",
"type": "System.Boolean",
"summary": "True if image should be filtered (bilinear) before displayed."
}
],
"returns": "True if successful."
},
{
"signature": "System.Boolean SetUserString(System.String key, System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Attach a user string (key,value combination) to this geometry.",
"since": "6.18",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve this string."
},
{
"name": "value",
"type": "System.String",
"summary": "string associated with key. If null, the key will be removed"
}
],
"returns": "True on success."
},
{
"signature": "System.Boolean SetUserStrings(IEnumerable> items, System.Boolean replace)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Attach a user string (key,value combination) to this viewport.",
"since": "8.18",
"parameters": [
{
"name": "items",
"type": "System.Collections.Generic.IEnumerable>",
"summary": "collection of key-value pairs to set."
},
{
"name": "replace",
"type": "System.Boolean",
"summary": "If True, the previous user string will be removed"
}
],
"returns": "True on success."
},
{
"signature": "System.Boolean SetViewProjection(DocObjects.ViewportInfo projection, System.Boolean updateTargetLocation)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the viewport camera projection.",
"since": "5.0",
"parameters": [
{
"name": "projection",
"type": "DocObjects.ViewportInfo",
"summary": "The \"standard\" projection type."
},
{
"name": "updateTargetLocation",
"type": "System.Boolean",
"summary": "if true, the target location is changed so that the vector from the camera location to the target is parallel to the camera direction vector. If false, the target location is not changed."
}
],
"returns": "True on success."
},
{
"signature": "System.Boolean SetWallpaper(System.String imageFilename, System.Boolean grayscale, System.Boolean visible)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetWallpaper(System.String imageFilename, System.Boolean grayscale)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Point2d WorldToClient(Point3d worldPoint)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Convert a point from world coordinates in the viewport to a 2d screen point in the local coordinates of the viewport (X/Y of point is relative to top left corner of viewport on screen)",
"since": "5.0",
"parameters": [
{
"name": "worldPoint",
"type": "Point3d",
"summary": "The 3D point in world coordinates."
}
],
"returns": "The 2D point on the screen."
},
{
"signature": "System.Boolean ZoomBoundingBox(BoundingBox box)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Zooms the viewport to the given bounding box.",
"since": "5.0",
"parameters": [
{
"name": "box",
"type": "BoundingBox",
"summary": "The bounding box to zoom."
}
],
"returns": "True if operation succeeded; otherwise false."
},
{
"signature": "System.Boolean ZoomExtents()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Dollies the camera location and so that the view frustum contains all of the selected document objects that can be seen in view. If the projection is perspective, the camera angle is not changed.",
"since": "5.0",
"returns": "True if successful."
},
{
"signature": "System.Boolean ZoomExtentsSelected()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Dollies the camera location and so that the view frustum contains all of the selected document objects that can be seen in view. If the projection is perspective, the camera angle is not changed.",
"since": "5.0",
"returns": "True if successful."
},
{
"signature": "System.Boolean ZoomWindow(Rectangle rect)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Zooms the viewport to the given rectangle.",
"since": "7.33",
"parameters": [
{
"name": "rect",
"type": "Rectangle",
"summary": "A 2d screen rectangle in client coordinates of the parent Rhino view, where 0,0 is the upper left corner of the view window."
}
],
"returns": "True if operation succeeded; otherwise false."
}
]
},
{
"namespace": "Rhino.Display",
"name": "ShaderLanguage",
"dataType": "enum",
"summary": "Graphics Shader Language https://en.wikipedia.org/wiki/OpenGL_Shading_Language#Versions",
"values": [
{
"signature": "GLSL_ES100 = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Used for OpenGL ES 2.0 and WebGL 1.0"
},
{
"signature": "GLSL_ES300 = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Used for OpenGL ES 3.0 and WebGL 2.0"
},
{
"signature": "GLSL_ES310 = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "GLSL_120 = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Used for OpenGL 2.1"
},
{
"signature": "GLSL_130 = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Used for OpenGL 3.0"
},
{
"signature": "GLSL_140 = 6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Used for OpenGL 3.1"
},
{
"signature": "GLSL_150 = 7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Used for OpenGL 3.2"
},
{
"signature": "GLSL_330 = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Used for OpenGL 3.3"
},
{
"signature": "GLSL_400 = 9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Used for OpenGL 4.0"
},
{
"signature": "GLSL_410 = 10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Used for OpenGL 4.1"
},
{
"signature": "GLSL_420 = 11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Used for OpenGL 4.2"
},
{
"signature": "GLSL_430 = 12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Used for OpenGL 4.3"
},
{
"signature": "GLSL_440 = 13",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Used for OpenGL 4.4"
},
{
"signature": "Metal = 14",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Metal for Apple"
}
]
},
{
"namespace": "Rhino.Display",
"name": "StereoContext",
"dataType": "enum",
"since": "7.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LeftEye = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "RightEye = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "BothEyes = 3",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "Text3d",
"dataType": "class",
"summary": "3D aligned text with font settings.",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "Text3d(string text, Plane plane, double height)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of Text3d.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "System.String",
"summary": "Text string."
},
{
"name": "plane",
"type": "Plane",
"summary": "3D Plane for text."
},
{
"name": "height",
"type": "System.Double",
"summary": "Height (in units) for text."
}
]
},
{
"signature": "Text3d(string text)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new instance of Text3d.",
"since": "5.0",
"parameters": [
{
"name": "text",
"type": "System.String",
"summary": "Text string."
}
]
}
],
"properties": [
{
"signature": "bool Bold",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether this Text3d object will be drawn in Bold.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "BoundingBox BoundingBox",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the bounding box for this Text3d object.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string FontFace",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the FontFace name.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double Height",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the height (in units) of this Text3d object. The height should be a positive number larger than zero.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "TextHorizontalAlignment HorizontalAlignment",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Horizontal alignment that this Text3d is drawn with",
"since": "6.4",
"property": ["get", "set"]
},
{
"signature": "bool Italic",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether this Text3d object will be drawn in Italics.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string Text",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the text string for this Text3d object.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Plane TextPlane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the 3D aligned plane for this Text3d object.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "TextVerticalAlignment VerticalAlignment",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Vertical alignment that this Text3d is drawn with",
"since": "6.4",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Actively reclaims unmanaged resources that this instance uses.",
"since": "5.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "ViewCapture",
"dataType": "class",
"constructors": [
{
"signature": "ViewCapture()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
}
],
"properties": [
{
"signature": "bool DrawAxes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawGrid",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawGridAxes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "int Height",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Height of capture in Pixels",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool Preview",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "int RealtimeRenderPasses",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool ScaleScreenItems",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool TransparentBackground",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "int Width",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Width of capture in Pixels",
"since": "6.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "Bitmap CaptureToBitmap(ViewCaptureSettings settings)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Xml.XmlDocument CaptureToSvg(ViewCaptureSettings settings)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Boolean SendToPrinter(System.String printerName, ViewCaptureSettings[] settings, System.Int32 copies)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Send a list of view capture settings to a printer. Each setting represents a single page.",
"since": "8.0",
"parameters": [
{
"name": "printerName",
"type": "System.String",
"summary": ""
},
{
"name": "settings",
"type": "ViewCaptureSettings[]",
"summary": ""
},
{
"name": "copies",
"type": "System.Int32",
"summary": "number of copies to print"
}
],
"returns": "True on success"
},
{
"signature": "System.Boolean SendToPrinter(System.String printerName, ViewCaptureSettings[] settings)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Send a list of view capture settings to a printer. Each setting represents a single page.",
"since": "8.0",
"returns": "True on success"
},
{
"signature": "Bitmap CaptureToBitmap(RhinoView sourceView)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
}
]
},
{
"namespace": "Rhino.Display",
"name": "ViewCaptureSettings",
"dataType": "class",
"summary": "Holds information required to generate high resolution output of a RhinoViewport. This is used for generating paper prints or image files",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "ViewCaptureSettings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Construct default view capture settings",
"since": "6.0"
},
{
"signature": "ViewCaptureSettings(RhinoPageView sourcePageView, double dpi)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructor",
"since": "6.0",
"parameters": [
{
"name": "sourcePageView",
"type": "RhinoPageView",
"summary": "The Rhino page view to capture or print."
},
{
"name": "dpi",
"type": "System.Double",
"summary": "Capture \"density\" in dots per inch."
}
]
},
{
"signature": "ViewCaptureSettings(RhinoView sourceView, Size mediaSize, double dpi)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructor",
"since": "6.0",
"parameters": [
{
"name": "sourceView",
"type": "RhinoView",
"summary": "The Rhino view to capture or print."
},
{
"name": "mediaSize",
"type": "Size",
"summary": "The size of the output media."
},
{
"name": "dpi",
"type": "System.Double",
"summary": "Capture \"density\" in dots per inch."
}
]
},
{
"signature": "ViewCaptureSettings(ViewCaptureSettings other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Copy constructor",
"since": "8.5",
"parameters": [
{
"name": "other",
"type": "ViewCaptureSettings",
"summary": "settings to copy data from"
}
]
}
],
"properties": [
{
"signature": "bool ApplyDisplayModeThicknessScales",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Should curves and edges have their thicknesses scaled based the on the display mode settings for a view being captured (default is false)",
"since": "8.5",
"property": ["get", "set"]
},
{
"signature": "double ArrowheadSizeMillimeters",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Arrowhead size in millimeters.",
"since": "6.15",
"property": ["get", "set"]
},
{
"signature": "Rectangle CropRectangle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Actual area of output rectangle that view capture is sent to.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "double DefaultPrintWidthMillimeters",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Line thickness, in millimeters, used to print objects with no defined thickness.",
"since": "6.15",
"property": ["get", "set"]
},
{
"signature": "RhinoDoc Document",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.15",
"property": ["get", "set"]
},
{
"signature": "bool DrawAxis",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawBackground",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawBackgroundBitmap",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.2",
"property": ["get", "set"]
},
{
"signature": "bool DrawClippingPlanes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawGrid",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawLights",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawLockedObjects",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawMargins",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Rectangle DrawRectangle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Rectangle where drawing is confined to on MediaSize",
"since": "8.5",
"property": ["get"]
},
{
"signature": "bool DrawSelectedObjectsOnly",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawWallpaper",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.2",
"property": ["get", "set"]
},
{
"signature": "string FooterText",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Text drawn at the bottom of the output",
"since": "7.6",
"property": ["get", "set"]
},
{
"signature": "string HeaderText",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Text drawn at the top of the output",
"since": "7.6",
"property": ["get", "set"]
},
{
"signature": "double HorizontalScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Horizontal stretch to be applied to output. Useful for calibrating printers",
"since": "8.4",
"property": ["get", "set"]
},
{
"signature": "bool IsScaleToFit",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if the model has been scaled to fit.",
"since": "6.21",
"property": ["get"]
},
{
"signature": "bool IsValid",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool LinetypeWidthUnitsArePageLengths",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool MatchLinetypePatternDefinition",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Default is true. Linetype scales are normally generated right before printing/view capture in order to get linetypes to print to the same lengths as defined. If false, the linetypes are not scaled and the current pattern lengths as seen on the screen as used.",
"since": "7.6",
"property": ["get", "set"]
},
{
"signature": "Size MediaSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Total size of the image or page in dots",
"since": "6.0",
"property": ["get"]
},
{
"signature": "int ModelScaleType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.21",
"property": ["get", "set"]
},
{
"signature": "AnchorLocation OffsetAnchor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.2",
"property": ["get", "set"]
},
{
"signature": "ColorMode OutputColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.8",
"property": ["get", "set"]
},
{
"signature": "double PointSizeMillimeters",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Size of point objects in millimeters. if scale <= 0 the size is minimized so points are always drawn as small as possible",
"since": "6.15",
"property": ["get", "set"]
},
{
"signature": "bool RasterMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.17",
"property": ["get", "set"]
},
{
"signature": "double Resolution",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Capture \"density\" in dots per inch.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double TextDotPointSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Font point size use for printing text dots. The default value is 10.0. This has morphed into a scale setting as individual text dots have their own sizes. A value of 20 will print dots at double of their size setting while a value of 10 will print with no scaling applied.",
"since": "7.27",
"property": ["get", "set"]
},
{
"signature": "bool UsePrintWidths",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.15",
"property": ["get", "set"]
},
{
"signature": "double VerticalScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Vertical stretch to be applied to output. Useful for calibrating printers",
"since": "8.4",
"property": ["get", "set"]
},
{
"signature": "ViewAreaMapping ViewArea",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "How the RhinoViewport is mapped to the output rectangle",
"since": "7.7",
"property": ["get", "set"]
},
{
"signature": "double WireThicknessScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Scaling factor to apply to object print widths (typically 1.0). This is helpful when printing something at 1/2 scale and having all of the curves print 1/2 as thick.",
"since": "6.15",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "ViewCaptureSettings CreatePreviewSettings(System.Drawing.Size size)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Create a ViewCaptureSettings based on this instance, but scaled to fit in a different sized area. Scaling is also performed on dpi. This is primarily used to for capturing images that are shown as print previews",
"since": "7.9",
"returns": "new ViewCaptureSettings instance on success. Null on failure"
},
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Actively reclaims unmanaged resources that this instance uses.",
"since": "6.0"
},
{
"signature": "System.Boolean Equals(ViewCaptureSettings other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Check if the contents of this object is the same as another object",
"since": "8.5",
"parameters": [
{
"name": "other",
"type": "ViewCaptureSettings",
"summary": "other settings to compare against"
}
]
},
{
"signature": "System.Boolean GetMargins(UnitSystem lengthUnits, out System.Double left, out System.Double top, out System.Double right, out System.Double bottom)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get distances from the edge of the paper (MediaSize) to the CropRectangle in a defined unit system",
"since": "6.2",
"parameters": [
{
"name": "lengthUnits",
"type": "UnitSystem",
"summary": "Units to get distances in"
},
{
"name": "left",
"type": "System.Double",
"summary": "Distance from left edge of paper to left edge of CropRectangle"
},
{
"name": "top",
"type": "System.Double",
"summary": "Distance from top edge of paper to top edge of CropRectangle"
},
{
"name": "right",
"type": "System.Double",
"summary": "Distance from right edge of paper to right edge of CropRectangle"
},
{
"name": "bottom",
"type": "System.Double",
"summary": "Distance from bottom edge of paper to bottom edge of CropRectangle"
}
],
"returns": "True if successful. False if unsuccessful (this could happen if there is no set device_dpi)"
},
{
"signature": "System.Double GetModelScale(UnitSystem pageUnits, UnitSystem modelUnits)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the model scale factor.",
"since": "6.21",
"parameters": [
{
"name": "pageUnits",
"type": "UnitSystem",
"summary": "The current page units."
},
{
"name": "modelUnits",
"type": "UnitSystem",
"summary": "The current model units."
}
],
"returns": "The model scale factor."
},
{
"signature": "System.Void GetOffset(UnitSystem lengthUnits, out System.Boolean fromMargin, out System.Double x, out System.Double y)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.2"
},
{
"signature": "RhinoViewport GetViewport()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get RhinoViewport that this view capture settings is targeting",
"since": "8.0"
},
{
"signature": "System.Boolean Load(System.String name, PersistentSettings settings)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.1"
},
{
"signature": "System.Boolean MatchViewportAspectRatio()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adjust crop rectangle to match the aspect ratio of the original viewport that these settings reference",
"since": "7.9",
"returns": "True on success"
},
{
"signature": "System.Void MaximizePrintableArea()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Minimize cropping so the full drawable area is used",
"since": "7.9"
},
{
"signature": "System.Void Save(System.String name, PersistentSettings settings)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.1"
},
{
"signature": "System.Void SetLayout(Size mediaSize, Rectangle cropRectangle)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Boolean SetMarginBottom(UnitSystem lengthUnits, System.Double distance)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the distance from the bottom edge of the paper to the CropRectangle",
"since": "8.5",
"parameters": [
{
"name": "lengthUnits",
"type": "UnitSystem",
"summary": "units that distance is defined in"
},
{
"name": "distance",
"type": "System.Double",
"summary": "distance to set"
}
],
"returns": "True if successful. False if unsuccessful (this could happen if there is no set device_dpi)"
},
{
"signature": "System.Boolean SetMarginLeft(UnitSystem lengthUnits, System.Double distance)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the distance from the left edge of the paper to the CropRectangle",
"since": "8.5",
"parameters": [
{
"name": "lengthUnits",
"type": "UnitSystem",
"summary": "units that distance is defined in"
},
{
"name": "distance",
"type": "System.Double",
"summary": "distance to set"
}
],
"returns": "True if successful. False if unsuccessful (this could happen if there is no set device_dpi)"
},
{
"signature": "System.Boolean SetMarginRight(UnitSystem lengthUnits, System.Double distance)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the distance from the right edge of the paper to the CropRectangle",
"since": "8.5",
"parameters": [
{
"name": "lengthUnits",
"type": "UnitSystem",
"summary": "units that distance is defined in"
},
{
"name": "distance",
"type": "System.Double",
"summary": "distance to set"
}
],
"returns": "True if successful. False if unsuccessful (this could happen if there is no set device_dpi)"
},
{
"signature": "System.Boolean SetMargins(UnitSystem lengthUnits, System.Double left, System.Double top, System.Double right, System.Double bottom)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set distances from the edge of the paper (MediaSize) to the CropRectange in a defined unit system",
"since": "6.2",
"parameters": [
{
"name": "lengthUnits",
"type": "UnitSystem",
"summary": "Units that left, top, right, and bottom are defined in"
},
{
"name": "left",
"type": "System.Double",
"summary": "Distance from left edge of paper to left edge of CropRectangle"
},
{
"name": "top",
"type": "System.Double",
"summary": "Distance from top edge of paper to top edge of CropRectangle"
},
{
"name": "right",
"type": "System.Double",
"summary": "Distance from right edge of paper to right edge of CropRectangle"
},
{
"name": "bottom",
"type": "System.Double",
"summary": "Distance from bottom edge of paper to bottom edge of CropRectangle"
}
],
"returns": "True if successful. False if unsuccessful (this could happen if there is no set device_dpi)"
},
{
"signature": "System.Boolean SetMarginTop(UnitSystem lengthUnits, System.Double distance)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the distance from the top edge of the paper to the CropRectangle",
"since": "8.5",
"parameters": [
{
"name": "lengthUnits",
"type": "UnitSystem",
"summary": "units that distance is defined in"
},
{
"name": "distance",
"type": "System.Double",
"summary": "distance to set"
}
],
"returns": "True if successful. False if unsuccessful (this could happen if there is no set device_dpi)"
},
{
"signature": "System.Void SetModelScaleToFit(System.Boolean promptOnChange)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Scales the model to fit.",
"since": "6.21",
"parameters": [
{
"name": "promptOnChange",
"type": "System.Boolean",
"summary": "Prompt the user if the model scale will change."
}
]
},
{
"signature": "System.Void SetModelScaleToValue(System.Double scale)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the model scale to a value.",
"since": "6.21",
"parameters": [
{
"name": "scale",
"type": "System.Double",
"summary": "The scale value."
}
]
},
{
"signature": "System.Void SetOffset(UnitSystem lengthUnits, System.Boolean fromMargin, System.Double x, System.Double y)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.2"
},
{
"signature": "System.Void SetViewport(RhinoViewport viewport)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.15"
},
{
"signature": "System.Void SetWindowRect(Point2d screenPoint1, Point2d screenPoint2)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the print area to a window selection based on two points in screen coordinates",
"since": "7.4",
"parameters": [
{
"name": "screenPoint1",
"type": "Point2d",
"summary": "first point; it doesn't matter what corner of the rectangle this point represents"
},
{
"name": "screenPoint2",
"type": "Point2d",
"summary": "point representing opposite corner of rectangle from screenPoint1"
}
]
},
{
"signature": "System.Void SetWindowRect(Point3d worldPoint1, Point3d worldPoint2)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the print area to a window selection based on two points in world coordinates",
"since": "7.4",
"parameters": [
{
"name": "worldPoint1",
"type": "Point3d",
"summary": "First point in world coordinates. This point is projected to screen coordinates"
},
{
"name": "worldPoint2",
"type": "Point3d",
"summary": "Second point in world coordinates. This point is projected to screen coordinates"
}
]
}
]
},
{
"namespace": "Rhino.Display",
"name": "ViewCaptureSettings.AnchorLocation",
"dataType": "enum",
"since": "6.2",
"values": [
{
"signature": "LowerLeft = UnsafeNativeMethods.PrintInfoAnchor.LowerLeft",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LowerRight = UnsafeNativeMethods.PrintInfoAnchor.LowerRight",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "UpperLeft = UnsafeNativeMethods.PrintInfoAnchor.UpperLeft",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "UpperRight = UnsafeNativeMethods.PrintInfoAnchor.UpperRight",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Center = UnsafeNativeMethods.PrintInfoAnchor.Center",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "ViewCaptureSettings.ColorMode",
"dataType": "enum",
"since": "6.8",
"values": [
{
"signature": "DisplayColor",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "PrintColor",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "BlackAndWhite",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "ViewCaptureSettings.ViewAreaMapping",
"dataType": "enum",
"summary": "Defines how a viewport is mapped to output.",
"values": [
{
"signature": "View = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Best fit rectangle of what is displayed in a viewport"
},
{
"signature": "Extents = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Zoom projection to all visible geometry in a viewport"
},
{
"signature": "Window = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Use window rectangle defined by user"
}
]
},
{
"namespace": "Rhino.Display",
"name": "ViewEnableDrawingEventArgs",
"dataType": "class",
"summary": "View enable drawing event argument.",
"baseclass": "EventArgs",
"since": "8.15",
"properties": [
{
"signature": "RhinoDoc Document",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the Rhino document.",
"since": "8.15",
"property": ["get"]
},
{
"signature": "uint DocumentSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The serial number of the Rhino document.",
"since": "8.15",
"property": ["get", "set"]
},
{
"signature": "bool DrawingEnabled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True if drawing is enabled, False otherwise.",
"since": "8.15",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "ViewEventArgs",
"dataType": "class",
"summary": "View event arguments.",
"baseclass": "EventArgs",
"since": "5.0",
"properties": [
{
"signature": "RhinoView View",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.Display",
"name": "ViewportType",
"dataType": "enum",
"since": "5.0",
"values": [
{
"signature": "StandardModelingViewport = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "PageViewMainViewport = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DetailViewport = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "UVEditorViewport = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "BlockEditorViewport = 4",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "ViewTypeFilter",
"dataType": "enum",
"summary": "Filter for view types to list",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No views"
},
{
"signature": "Model = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Standard Rhino model views"
},
{
"signature": "Page = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Page views"
},
{
"signature": "ModelStyleViews = 0xFFFFFFF ^ 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "All view styles except Page."
},
{
"signature": "UVEditor = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "UV Editor views"
},
{
"signature": "BlockEditor = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Block Editor views"
},
{
"signature": "All = 0xFFFFFFF",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "All views"
}
]
},
{
"namespace": "Rhino.Display",
"name": "VisualAnalysisMode",
"dataType": "class",
"summary": "Represents a base class for visual analysis modes. \nThis class is abstract.",
"constructors": [
{
"signature": "VisualAnalysisMode()",
"summary": "Initializes a new instance of the VisualAnalysisMode class"
}
],
"properties": [
{
"signature": "Guid RhinoCurvatureColorAnalyisModeId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Id for Rhino's built-in curvature color analysis mode. Surface curvature is shown using False color mapping.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid RhinoCurvatureGraphAnalysisModeId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Id for Rhino's built-in curvature graphs analysis mode. Curvature hair is shown on curves and surfaces.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid RhinoDirectionAnalysisModeId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Id for Rhino's built-in direction analysis mode.",
"since": "9.0",
"property": ["get"]
},
{
"signature": "Guid RhinoDraftAngleAnalysisModeId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Id for Rhino's built-in draft angle analysis mode. Draft angle is displayed using False colors.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid RhinoEdgeAnalysisModeId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Id for Rhino's built-in edge analysis mode. Brep and mesh edges are shown in a selected color.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid RhinoEdgeContinuityAlalysisModeId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Id for Rhino's built-in edge continuity analysis mode.",
"since": "7.0",
"property": ["get"]
},
{
"signature": "Guid RhinoEmapAnalysisModeId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Id for Rhino's built-in emap analysis mode. An environment map is shown on surfaces and meshes.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid RhinoEndAnalysisModeId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Id for Rhino's built-in End analysis mode.",
"since": "9.0",
"property": ["get"]
},
{
"signature": "Guid RhinoThicknessAnalysisModeId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Id for Rhino's built-in thickness analysis mode.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid RhinoZebraStripeAnalysisModeId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Id for Rhino's built-in zebra stripe analysis mode. Zebra stripes are shown on surfaces and meshes.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid Id",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the visual analysis mode GUID. The Guid is specified with the System.Runtime.InteropServices.GuidAttribute applied to the class.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string Name",
"modifiers": ["public", "abstract"],
"protected": false,
"virtual": false,
"summary": "Gets the name of the analysis mode. It is used by the _What command and the object properties details window to describe the object.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool ShowIsoCurves",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Gets True if this visual analysis mode will show isocuves on shaded surface objects. Often a mode's user interface will provide a way to change this setting. \nThe default is false.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "AnalysisStyle Style",
"modifiers": ["public", "abstract"],
"protected": false,
"virtual": false,
"summary": "Gets the visual analysis mode style.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Boolean AdjustAnalysisMeshes(RhinoDoc doc, System.Guid analysisModeId)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Interactively adjusts surface analysis meshes of objects using a Rhino built-in analysis mode.",
"since": "7.0",
"parameters": [
{
"name": "doc",
"type": "RhinoDoc",
"summary": "The Rhino document."
},
{
"name": "analysisModeId",
"type": "System.Guid",
"summary": "The id of the analysis mode."
}
],
"returns": "True if successful, False otherwise."
},
{
"signature": "System.Void CurvatureColorAutoRange()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Adjusts the auto range values for curvature analysis.",
"since": "9.0"
},
{
"signature": "System.Void CurvatureColorMaxRange()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Adjusts the max range values for curvature analysis.",
"since": "9.0"
},
{
"signature": "VisualAnalysisMode Find(System.Guid id)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Finds a visual analysis mode by guid.",
"since": "5.0",
"parameters": [
{
"name": "id",
"type": "System.Guid",
"summary": "The globally unique identifier to search for."
}
],
"returns": "The found visual analysis mode, or None if it was not found, or on error."
},
{
"signature": "VisualAnalysisMode Find(System.Type t)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Finds a visual analysis mode by type.",
"since": "5.0",
"parameters": [
{
"name": "t",
"type": "System.Type",
"summary": "A visual analysis mode type."
}
],
"returns": "A visual analysis mode on success, or None on error."
},
{
"signature": "VisualAnalysisMode Register(System.Type customAnalysisModeType)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Registers a custom visual analysis mode for use in Rhino. It is OK to call register multiple times for a single custom analysis mode type, since subsequent register calls will notice that the type has already been registered.",
"since": "5.0",
"parameters": [
{
"name": "customAnalysisModeType",
"type": "System.Type",
"summary": "Must be a type that is a subclass of VisualAnalysisMode."
}
],
"returns": "An instance of registered analysis mode on success."
},
{
"signature": "System.Void DrawBrepObject(Rhino.DocObjects.BrepObject brep, DisplayPipeline pipeline)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Draws one brep. Override this method to add your custom behavior. \nThe default implementation does nothing.",
"parameters": [
{
"name": "brep",
"type": "Rhino.DocObjects.BrepObject",
"summary": "A brep object."
},
{
"name": "pipeline",
"type": "DisplayPipeline",
"summary": "The current display pipeline."
}
]
},
{
"signature": "System.Void DrawCurveObject(Rhino.DocObjects.CurveObject curve, DisplayPipeline pipeline)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "If Style==Wireframe, then the default decomposes the curve object into nurbs curve segments and calls the virtual DrawNurbsCurve for each segment.",
"parameters": [
{
"name": "curve",
"type": "Rhino.DocObjects.CurveObject",
"summary": "A document curve object."
},
{
"name": "pipeline",
"type": "DisplayPipeline",
"summary": "The drawing pipeline."
}
]
},
{
"signature": "System.Void DrawMesh(Rhino.DocObjects.RhinoObject obj, Rhino.Geometry.Mesh mesh, DisplayPipeline pipeline)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Draws a mesh. \nThe default implementation does nothing.",
"parameters": [
{
"name": "obj",
"type": "Rhino.DocObjects.RhinoObject",
"summary": "A Rhino object corresponding to the surface."
},
{
"name": "mesh",
"type": "Rhino.Geometry.Mesh",
"summary": "The mesh geometry."
},
{
"name": "pipeline",
"type": "DisplayPipeline",
"summary": "The current display pipeline."
}
]
},
{
"signature": "System.Void DrawMeshObject(Rhino.DocObjects.MeshObject mesh, DisplayPipeline pipeline)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Draws one mesh. Override this method to add your custom behavior. \nThe default implementation does nothing.",
"parameters": [
{
"name": "mesh",
"type": "Rhino.DocObjects.MeshObject",
"summary": "A mesh object."
},
{
"name": "pipeline",
"type": "DisplayPipeline",
"summary": "The current display pipeline."
}
]
},
{
"signature": "System.Void DrawNurbsCurve(Rhino.DocObjects.RhinoObject obj, Rhino.Geometry.NurbsCurve curve, DisplayPipeline pipeline)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Draws a NURBS curve. This is a good function to override for analysis modes like curvature hair display. \nThe default implementation does nothing.",
"parameters": [
{
"name": "obj",
"type": "Rhino.DocObjects.RhinoObject",
"summary": "A Rhino object corresponding to the curve."
},
{
"name": "curve",
"type": "Rhino.Geometry.NurbsCurve",
"summary": "The curve geometry."
},
{
"name": "pipeline",
"type": "DisplayPipeline",
"summary": "The current display pipeline."
}
]
},
{
"signature": "System.Void DrawNurbsSurface(Rhino.DocObjects.RhinoObject obj, Rhino.Geometry.NurbsSurface surface, DisplayPipeline pipeline)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Draws a NURBS surface. This is a good function to override to display object-related meshes. \nThe default implementation does nothing.",
"parameters": [
{
"name": "obj",
"type": "Rhino.DocObjects.RhinoObject",
"summary": "A Rhino object corresponding to the surface."
},
{
"name": "surface",
"type": "Rhino.Geometry.NurbsSurface",
"summary": "The surface geometry."
},
{
"name": "pipeline",
"type": "DisplayPipeline",
"summary": "The current display pipeline."
}
]
},
{
"signature": "System.Void DrawPointCloudObject(Rhino.DocObjects.PointCloudObject pointCloud, DisplayPipeline pipeline)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Draws one point cloud. Override this method to add your custom behavior. \nThe default implementation does nothing.",
"parameters": [
{
"name": "pointCloud",
"type": "Rhino.DocObjects.PointCloudObject",
"summary": "A point cloud object."
},
{
"name": "pipeline",
"type": "DisplayPipeline",
"summary": "The current display pipeline."
}
]
},
{
"signature": "System.Void DrawPointObject(Rhino.DocObjects.PointObject point, DisplayPipeline pipeline)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Draws one point. Override this method to add your custom behavior. \nThe default implementation does nothing.",
"parameters": [
{
"name": "point",
"type": "Rhino.DocObjects.PointObject",
"summary": "A point object."
},
{
"name": "pipeline",
"type": "DisplayPipeline",
"summary": "The current display pipeline."
}
]
},
{
"signature": "System.Void EnableUserInterface(System.Boolean on)",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Turns the analysis mode's user interface on and off. For Rhino's built in modes this opens or closes the modeless dialog that controls the analysis mode's display settings.",
"since": "5.0",
"parameters": [
{
"name": "on",
"type": "System.Boolean",
"summary": "True if the interface should be shown; False if it should be concealed."
}
]
},
{
"signature": "System.Boolean ObjectSupportsAnalysisMode(Rhino.DocObjects.RhinoObject obj)",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Gets a value indicating if this visual analysis mode can be used on a given Rhino object.",
"since": "5.0",
"parameters": [
{
"name": "obj",
"type": "Rhino.DocObjects.RhinoObject",
"summary": "The object to be tested."
}
],
"returns": "True if this mode can indeed be used on the object; otherwise false."
},
{
"signature": "System.Void SetUpDisplayAttributes(Rhino.DocObjects.RhinoObject obj, DisplayPipelineAttributes attributes)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "If an analysis mode needs to modify display attributes, this is the place to do it. In particular, Style==Texture, then this function must be overridden.",
"remarks": "Shaded analysis modes that use texture mapping, like zebra and emap, override this function set the texture, diffuse_color, and EnableLighting parameter.",
"parameters": [
{
"name": "obj",
"type": "Rhino.DocObjects.RhinoObject",
"summary": "The object for which to set up attributes."
},
{
"name": "attributes",
"type": "DisplayPipelineAttributes",
"summary": "The linked attributes."
}
]
},
{
"signature": "System.Void UpdateVertexColors(Rhino.DocObjects.RhinoObject obj, Rhino.Geometry.Mesh[] meshes)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "If Style==falseColor, then this virtual function must be overridden. Rhino calls this function when it is time for to set the False colors on the analysis mesh vertices. For breps, there is one mesh per face. For mesh objects there is a single mesh.",
"parameters": [
{
"name": "obj",
"type": "Rhino.DocObjects.RhinoObject",
"summary": "The object for which to update vertex colors."
},
{
"name": "meshes",
"type": "Rhino.Geometry.Mesh[]",
"summary": "An array of meshes that should be updated."
}
]
}
]
},
{
"namespace": "Rhino.Display",
"name": "VisualAnalysisMode.AnalysisStyle",
"dataType": "enum",
"summary": "Contains enumerated values for analysis styles, such as wireframe, texture or False colors..",
"since": "5.0",
"values": [
{
"signature": "Wireframe = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The analysis is showing with wires."
},
{
"signature": "Texture = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The analysis is showing with textures."
},
{
"signature": "FalseColor = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The analysis is showing with False colors."
}
]
},
{
"namespace": "Rhino.Display",
"name": "VisualAnalysisMode.EdgeContinuityMode",
"dataType": "enum",
"summary": "Continuity mode to report",
"values": [
{
"signature": "Distance = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "G0 Continuity"
},
{
"signature": "Tangency = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "G1 Continuity"
},
{
"signature": "Curvature = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "G2 Continuity"
}
]
},
{
"namespace": "Rhino.Display",
"name": "ZBiasMode",
"dataType": "enum",
"summary": "Biasing applied to geometry to attempt to get coplanar items to draw on top of or below other geometry",
"since": "5.0",
"values": [
{
"signature": "Neutral = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TowardsCamera = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AwayFromCamera = 2",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.Display",
"name": "ZBufferCapture",
"dataType": "class",
"summary": "Provides functionality for getting the z-buffer values from a viewport and a given display mode",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "ZBufferCapture(RhinoViewport viewport)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Actively reclaims unmanaged resources that this instance uses.",
"since": "5.3"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "For derived class implementers. \nThis method is called with argument True when class user calls Dispose(), while with argument False when the Garbage Collector invokes the finalizer, or Finalize() method. \nYou must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true. \nAlso, you must call the base virtual method within your overriding method.",
"parameters": [
{
"name": "disposing",
"type": "System.Boolean",
"summary": "True if the call comes from the Dispose() method; False if it comes from the Garbage Collector finalizer."
}
]
},
{
"signature": "System.Drawing.Bitmap GrayscaleDib()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "System.Int32 HitCount()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "System.Single MaxZ()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "System.Single MinZ()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "System.Void SetDisplayMode(System.Guid modeId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "System.Void ShowAnnotations(System.Boolean on)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "System.Void ShowCurves(System.Boolean on)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "System.Void ShowIsocurves(System.Boolean on)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "System.Void ShowLights(System.Boolean on)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "System.Void ShowMeshWires(System.Boolean on)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "System.Void ShowPoints(System.Boolean on)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "System.Void ShowText(System.Boolean on)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "Point3d WorldPointAt(System.Int32 x, System.Int32 y)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
},
{
"signature": "System.Single ZValueAt(System.Int32 x, System.Int32 y)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.3"
}
]
},
{
"namespace": "Rhino",
"name": "DisplayDeviceInfo",
"dataType": "class",
"summary": "Get information about display devices found on this machine (GPUs).",
"constructors": [
{
"signature": "DisplayDeviceInfo()",
"summary": "Initializes a new instance of the DisplayDeviceInfo class"
}
],
"methods": [
{
"signature": "List GpuDeviceInfos()",
"modifiers": ["static", "public"],
"protected": false,
"virtual": false,
"summary": "Get a list of GpuDeviceInfo for GPUs found on this machine.",
"since": "7.3",
"returns": "List of GpuDeviceInfo"
},
{
"signature": "List GpuNames()",
"modifiers": ["static", "public"],
"protected": false,
"virtual": false,
"summary": "Get a list with the names of all GPUs on this machine.",
"since": "7.3",
"returns": "List of strings"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ActiveSpace",
"dataType": "enum",
"summary": "Defines the current working space.",
"since": "5.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "There is no working space."
},
{
"signature": "ModelSpace = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "3d modeling or \"world\" space."
},
{
"signature": "PageSpace = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "page/layout/paper/printing space."
},
{
"signature": "UVEditorSpace = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "UV Editor space."
},
{
"signature": "BlockEditorSpace = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Block Editor space."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "AngleDisplayMode",
"dataType": "enum",
"summary": "Defines enumerated values for the display of angles.",
"since": "6.0",
"values": [
{
"signature": "Degrees = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shows angle in decimal degrees"
},
{
"signature": "DMS = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Show angle as degree,minute,second."
},
{
"signature": "Grads = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Show angle as grads."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "AngularDimensionObject",
"dataType": "class",
"summary": "Rhino Object that represents an angular dimension geometry and attributes",
"baseclass": "Rhino.DocObjects.DimensionObject",
"properties": [
{
"signature": "AngularDimension AngularDimensionGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the dimension geometry for this object.",
"since": "6.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "AnimationProperties",
"dataType": "class",
"summary": "Contains information used by the Animation Tools to create sun, season, turntable and fly through animations.",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "AnimationProperties()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new instance of the AnimationProperties class.",
"since": "6.11"
},
{
"signature": "AnimationProperties(AnimationProperties source)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initialize new instance of the AnimationProperties class.",
"since": "6.11",
"parameters": [
{
"name": "source",
"type": "AnimationProperties",
"summary": "If not null, settings are copied from source"
}
]
}
],
"properties": [
{
"signature": "string AnimationName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the name of the animation sequence.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "Guid CameraPathId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the object ID of the camera path.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "Point3d[] CameraPoints",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets points of the camera path.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "string CaptureMethod",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the capture method of the animation which is either preview or full.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "CaptureTypes CaptureType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the capture type of the animation.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int CurrentFrame",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the current frame during animation record.",
"since": "7.12",
"property": ["get", "set"]
},
{
"signature": "string[] Dates",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the dates that are calculated for seasonal/one day sun animations.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int DaysBetweenFrames",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the days between captured frames for seasonal sun animation.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "Guid DisplayMode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the ID of the view display mode (wireframe, shaded...).",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int EndDay",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the end day for seasonal day sun animation in the range 1 to 31.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int EndHour",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the end hour for one day sun animation in the range 0 to 23.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int EndMinutes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the end minutes for one day sun animation in the range 0 to 59.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int EndMonth",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the end month for seasonal day sun animation in the range 1 to 12.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int EndSeconds",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the end seconds for one day sun animation in the range 0 to 59.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int EndYear",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the end year for seasonal day sun animation in the range 1800 to 2199.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "string FileExtension",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the file extension of the saved frames created by the animation.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "string FolderName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the location for the saved frames.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int FrameCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the number of frames to be captured.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "string HtmlFileName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the HTML file name. This property is the same as AnimationName .",
"since": "7.12",
"property": ["get", "set"]
},
{
"signature": "string HtmlFullPath",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Return HTML file path consisting of FolderName and HtmlFileName. To change this set FolderName and HtmlFileName.",
"since": "7.12",
"property": ["get"]
},
{
"signature": "string[] Images",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the full path to the saved frames of an animation.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "double Latitude",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the latitude for sun animations in the range of -90 to +90.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int LightIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Internal value used while previewing animation.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "double Longitude",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the longitude for sun animations in the range of -180 to +180.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int MinutesBetweenFrames",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the minutes between captured frames for one day sun animation.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "double NorthAngle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the world angle corresponding to North in degrees. This angle is zero along the x-axis and increases anticlockwise.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "bool RenderFull",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating whether to capture a frame in rendered mode.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "bool RenderPreview",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating whether to capture a frame in preview rendered mode.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int StartDay",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the start day for seasonal/one day sun animation in the range 1 to 31.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int StartHour",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the start hour for seasonal/one day sun animation in the range 0 to 23.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int StartMinutes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the start minutes for seasonal/one day sun animation in the range 0 to 59.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int StartMonth",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the start month for seasonal/one day sun animation in the range 1 to 12.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int StartSeconds",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the start seconds for seasonal/one day sun animation in the range 0 to 59.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "int StartYear",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the start year for seasonal/one day sun animation in the range 1800 to 2199.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "Guid TargetPathId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the object ID of the target path.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "Point3d[] TargetPoints",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets points of the target path.",
"since": "6.11",
"property": ["get", "set"]
},
{
"signature": "string ViewportName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the viewport that will be captured.",
"since": "6.11",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Actively reclaims unmanaged resources that this instance uses.",
"since": "6.11"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "For derived class implementers. \nThis method is called with argument True when class user calls Dispose(), while with argument False when the Garbage Collector invokes the finalizer, or Finalize() method. \nYou must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true. \nAlso, you must call the base virtual method within your overriding method.",
"parameters": [
{
"name": "disposing",
"type": "System.Boolean",
"summary": "True if the call comes from the Dispose() method; False if it comes from the Garbage Collector finalizer."
}
]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "AnimationProperties.CaptureTypes",
"dataType": "enum",
"summary": "Constants that define the mode of the animation tools.",
"since": "6.11",
"values": [
{
"signature": "Path = UnsafeNativeMethods.AnimationPropertiesCaptureTypes.Path",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Camera and target movement along separate path curves"
},
{
"signature": "Turntable = UnsafeNativeMethods.AnimationPropertiesCaptureTypes.Turntable",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Rotate a view around the target."
},
{
"signature": "Flythrough = UnsafeNativeMethods.AnimationPropertiesCaptureTypes.Flythrough",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Camera and target movement along a path curve"
},
{
"signature": "DaySunStudy = UnsafeNativeMethods.AnimationPropertiesCaptureTypes.DaySunStudy",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Sun movement through a specified calendar day"
},
{
"signature": "SeasonalSunStudy = UnsafeNativeMethods.AnimationPropertiesCaptureTypes.SeasonalSunStudy",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Sun movement through a specified week, month, or year"
},
{
"signature": "None = UnsafeNativeMethods.AnimationPropertiesCaptureTypes.None",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No capture type specified"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "AnnotationObjectBase",
"dataType": "class",
"summary": "Base class for all annotation objects (text and dimensions)",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "AnnotationBase AnnotationGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the annotation base geometry for this object",
"since": "6.0",
"property": ["get"]
},
{
"signature": "string DisplayText",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the text that is displayed to users.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool HasMeasurableTextFields",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Test if the text in the annotation object contains fields that involve length, area, or volume measurements",
"since": "7.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "BasepointZero",
"dataType": "enum",
"summary": "Specifies enumerated constants used to indicate the zero level convention relating to a location on Earth. \nThis is used in conjunction with the class.",
"since": "5.0",
"deprecated": "8.6",
"values": [
{
"signature": "GroundLevel = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The ground level is the convention for 0."
},
{
"signature": "MeanSeaLevel = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The mean sea level is the convention for 0."
},
{
"signature": "CenterOfEarth = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The center of the planet is the convention for 0."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "BitmapEntry",
"dataType": "class",
"summary": "Rhino.DocObjects.Tables.BitmapTable entry",
"baseclass": "Rhino.DocObjects.ModelComponent",
"properties": [
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns ModelComponentType.Image .",
"since": "6.0",
"property": ["get"]
},
{
"signature": "string FileName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The name of this bitmap.",
"since": "5.1",
"property": ["get"]
},
{
"signature": "bool IsReference",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets a value indicting whether this bitmap is a referenced bitmap. Referenced bitmaps are part of referenced documents.",
"since": "5.1",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Boolean Save(System.String fileName)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.1"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "BrepObject",
"dataType": "class",
"summary": "Represents a Rhino.Geometry.Brep in a document.",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "Brep BrepGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the Brep geometry linked with this object.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "Brep DuplicateBrepGeometry()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new deep copy of the Brep geometry.",
"since": "5.0",
"returns": "The copy of the geometry."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "CentermarkObject",
"dataType": "class",
"summary": "Rhino Object that represents a centermark geometry and attributes",
"baseclass": "Rhino.DocObjects.DimensionObject",
"properties": [
{
"signature": "Centermark CentermarkGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the dimension geometry for this object.",
"since": "6.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ClippingPlaneObject",
"dataType": "class",
"summary": "Represents the object of a Rhino.Geometry.ClippingPlaneSurface , stored in the Rhino document and with attributes.",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "ClippingPlaneSurface ClippingPlaneGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the clipping plane surface.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Boolean AddClipViewport(Rhino.Display.RhinoViewport viewport, System.Boolean commit)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a viewport to the list of viewports that this clipping plane clips.",
"since": "6.1",
"parameters": [
{
"name": "viewport",
"type": "Rhino.Display.RhinoViewport",
"summary": "The viewport to add."
},
{
"name": "commit",
"type": "System.Boolean",
"summary": "Commit the change. When in doubt, set this parameter to true."
}
],
"returns": "True if the viewport was added, False if the viewport is already in the list."
},
{
"signature": "System.Boolean RemoveClipViewport(Rhino.Display.RhinoViewport viewport, System.Boolean commit)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes a viewport from the list of viewports that this clipping plane clips.",
"since": "6.1",
"parameters": [
{
"name": "viewport",
"type": "Rhino.Display.RhinoViewport",
"summary": "The viewport to remove."
},
{
"name": "commit",
"type": "System.Boolean",
"summary": "Commit the change. When in doubt, set this parameter to true."
}
],
"returns": "True if the viewport was removed, False if the viewport was not in the list."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ConstructionPlane",
"dataType": "class",
"summary": "Represents a construction plane inside the document. \nUse Rhino.DocObjects.Tables.NamedConstructionPlaneTable methods and indexers to add and access a .",
"constructors": [
{
"signature": "ConstructionPlane()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new instance of ConstructionPlane .",
"since": "5.0"
}
],
"properties": [
{
"signature": "bool DepthBuffered",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether the grid is drawn on top of geometry. \nfalse=grid is always drawn behind 3d geometry \ntrue=grid is drawn at its depth as a 3d plane and grid lines obscure things behind the grid.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int GridLineCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the total amount of grid lines in each direction.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double GridSpacing",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the distance between grid lines.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridXColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the grid X-axis mark.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridYColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the grid Y-axis mark.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color GridZColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the grid Z-axis mark.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string Name",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the name of the construction plane.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Plane Plane",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the geometric plane to use for construction.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowAxes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether the axes of the grid should be visible.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowGrid",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether the grid itself should be visible.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ShowZAxis",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets whether the Z axis of the grid should be visible.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double SnapSpacing",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "when \"grid snap\" is enabled, the distance between snap points. Typically this is the same distance as grid spacing.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color ThickLineColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the thicker, wider line.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int ThickLineFrequency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the recurrence of a wider line on the grid. \n0: No lines are thick, all are drawn thin. \n1: All lines are thick. \n2: Every other line is thick. \n3: One line in three lines is thick (and two are thin). \n4: ...",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color ThinLineColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the color of the thinner, less prominent line.",
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ConstructionPlaneGridDefaults",
"dataType": "class",
"summary": "Default grid settings for a document",
"constructors": [
{
"signature": "ConstructionPlaneGridDefaults()",
"summary": "Initializes a new instance of the ConstructionPlaneGridDefaults class"
}
],
"properties": [
{
"signature": "int GridLineCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Number of grid lines in each direction",
"since": "8.13",
"property": ["get", "set"]
},
{
"signature": "double GridSpacing",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Distance between grid lines",
"since": "8.13",
"property": ["get", "set"]
},
{
"signature": "int GridThickFrequency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "This line frequency. 0: none, 1: all lines are thick, 2: every other is thick, ...",
"since": "8.13",
"property": ["get", "set"]
},
{
"signature": "bool ShowGrid",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show the grid",
"since": "8.13",
"property": ["get", "set"]
},
{
"signature": "bool ShowGridAxes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show the grid axes",
"since": "8.13",
"property": ["get", "set"]
},
{
"signature": "bool ShowWorldAxes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Show the world axes icon in the corner",
"since": "8.13",
"property": ["get", "set"]
},
{
"signature": "double SnapSpacing",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When grid snap is enabled, the distance between snap points. Typically this is the same distance as grid spacing",
"since": "8.13",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "CoordinateSystem",
"dataType": "enum",
"summary": "Defines enumerated values for coordinate systems to use as references.",
"since": "5.0",
"values": [
{
"signature": "World = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The world coordinate system. This has origin (0,0,0), X unit axis is (1, 0, 0) and Y unit axis is (0, 1, 0)."
},
{
"signature": "Camera = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The camera coordinate system."
},
{
"signature": "Clip = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The clip coordinate system."
},
{
"signature": "Screen = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The screen coordinate system."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "CurveObject",
"dataType": "class",
"summary": "A Rhino Object that represents curve geometry and attributes",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "Curve CurveGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the underlying curve geometry.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "Curve DuplicateCurveGeometry()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns a copy of the underlying curve geometry.",
"since": "5.0"
},
{
"signature": "GeometryBase[] GetLinetypeSegments()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Converts the linetype pattern of the curve into curve segments and points based on the active Rhino viewport.",
"since": "8.4",
"returns": "An array of curve and point objects if successful."
},
{
"signature": "GeometryBase[] GetLinetypeSegments(RhinoViewport viewport)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Converts the linetype pattern of the curve into curve segments and points based on the specified Rhino viewport.",
"since": "8.4",
"parameters": [
{
"name": "viewport",
"type": "RhinoViewport",
"summary": "The Rhino viewport used to generate the curve segments and points."
}
],
"returns": "An array of curve and point objects if successful."
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "ClassIdAttribute",
"dataType": "class",
"summary": "Useful for legacy UserData",
"baseclass": "Attribute",
"constructors": [
{
"signature": "ClassIdAttribute(string id)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a class id attribute.",
"since": "6.0",
"parameters": [
{
"name": "id",
"type": "System.String",
"summary": "String in the form of a Guid."
}
]
}
],
"properties": [
{
"signature": "Guid Id",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the associated style.",
"since": "6.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "CustomBrepObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.BrepObject",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "CustomBrepObject()",
"modifiers": ["protected"],
"protected": true,
"virtual": false
},
{
"signature": "CustomBrepObject(Brep brep)",
"modifiers": ["protected"],
"protected": true,
"virtual": false
}
],
"methods": [
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "override"],
"protected": true,
"virtual": false
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "CustomCurveObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.CurveObject",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "CustomCurveObject()",
"modifiers": ["protected"],
"protected": true,
"virtual": false
},
{
"signature": "CustomCurveObject(Curve curve)",
"modifiers": ["protected"],
"protected": true,
"virtual": false
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public", "new"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "override"],
"protected": true,
"virtual": false
},
{
"signature": "Curve SetCurve(Curve curve)",
"modifiers": ["protected"],
"protected": true,
"virtual": false,
"summary": "Only for developers who are defining custom subclasses of CurveObject. Directly sets the internal curve geometry for this object. Note that this function does not work with Rhino's \"undo\".",
"remarks": "Note that this function does not work with Rhino's \"undo\". The typical approach for adjusting the curve geometry is to modify the object that you get when you call the CurveGeometry property and then call CommitChanges.",
"returns": "The old curve geometry that was set for this object"
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "CustomGripObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.GripObject",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "CustomGripObject()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
],
"properties": [
{
"signature": "int Index",
"modifiers": ["public", "new"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Point3d OriginalLocation",
"modifiers": ["public", "new"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double Weight",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public", "new"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "override"],
"protected": true,
"virtual": false
},
{
"signature": "System.Void NewLocation()",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "CustomMeshObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.MeshObject",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "CustomMeshObject()",
"modifiers": ["protected"],
"protected": true,
"virtual": false
},
{
"signature": "CustomMeshObject(Mesh mesh)",
"modifiers": ["protected"],
"protected": true,
"virtual": false
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public", "new"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "override"],
"protected": true,
"virtual": false
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "CustomObjectGrips",
"dataType": "class",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "CustomObjectGrips()",
"modifiers": ["protected"],
"protected": true,
"virtual": false
}
],
"properties": [
{
"signature": "int GripCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool GripsMoved",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If GripsMoved is True if some of the grips have ever been moved GripObject.NewLocation() sets GripsMoved=true.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool NewLocation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True if some of the grips have been moved. GripObject.NewLocation() sets NewLocation=true. Derived classes can set NewLocation to False after updating temporary display information.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "RhinoObject OwnerObject",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Owner of the grips.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Boolean Dragging()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Determines if grips are currently being dragged.",
"since": "5.0",
"returns": "True if grips are dragged."
},
{
"signature": "System.Void RegisterGripsEnabler(TurnOnGripsEventHandler enabler, System.Type customGripsType)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void AddGrip(Rhino.DocObjects.Custom.CustomGripObject grip)",
"modifiers": ["protected"],
"protected": true,
"virtual": false
},
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true
},
{
"signature": "CustomGripObject Grip(System.Int32 index)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "GripObject NeighborGrip(System.Int32 gripIndex, System.Int32 dr, System.Int32 ds, System.Int32 dt, System.Boolean wrap)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Get neighbors.",
"parameters": [
{
"name": "gripIndex",
"type": "System.Int32",
"summary": "index of grip where the search begins."
},
{
"name": "dr",
"type": "System.Int32",
"summary": "1 = next grip in the first parameter direction. \n-1 = previous grip in the first parameter direction."
},
{
"name": "ds",
"type": "System.Int32",
"summary": "1 = next grip in the second parameter direction. \n-1 = previous grip in the second parameter direction."
},
{
"name": "dt",
"type": "System.Int32",
"summary": "1 = next grip in the third parameter direction. \n-1 = rev grip in the third parameter direction."
},
{
"name": "wrap",
"type": "System.Boolean",
"summary": "If True and object is \"closed\", the search will wrap."
}
],
"returns": "Pointer to the desired neighbor or NULL if there is no neighbor."
},
{
"signature": "Rhino.Geometry.GeometryBase NewGeometry()",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "If the grips control just one object, then override NewGeometry(). When NewGeometry() is called, return new geometry calculated from the current grip locations. This happens once at the end of a grip drag.",
"returns": "The new geometry. The default implementation returns null."
},
{
"signature": "Rhino.Geometry.NurbsSurface NurbsSurface()",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "If the grips control a NURBS surface, this returns a pointer to that surface. You can look at but you must NEVER change this surface.",
"returns": "A pointer to a NURBS surface or null."
},
{
"signature": "GripObject NurbsSurfaceGrip(System.Int32 i, System.Int32 j)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "If the grips are control points of a NURBS surface, then this gets the index of the grip that controls the (i,j)-th CV.",
"parameters": [
{
"name": "i",
"type": "System.Int32",
"summary": "The index in the first dimension."
},
{
"name": "j",
"type": "System.Int32",
"summary": "The index in the second dimension."
}
],
"returns": "A grip controlling a NURBS surface CV or null."
},
{
"signature": "System.Void OnDraw(GripsDrawEventArgs args)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Draws the grips. In your implementation, override this if you need to draw dynamic elements and then call this base implementation to draw the grips themselves.",
"parameters": [
{
"name": "args",
"type": "GripsDrawEventArgs",
"summary": "The grips draw event arguments."
}
]
},
{
"signature": "System.Void OnReset()",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Resets location of all grips to original spots and cleans up stuff that was created by dynamic dragging. This is required when dragging is canceled or in the Copy command when grips are \"copied\". The override should clean up dynamic workspace stuff."
},
{
"signature": "System.Void OnResetMeshes()",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Just before Rhino turns off object grips, it calls this function. If grips have modified any display meshes, they must override this function and restore the meshes to their original states."
},
{
"signature": "System.Void OnUpdateMesh(Rhino.Geometry.MeshType meshType)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Just before Rhino shades an object with grips on, it calls this method to update the display meshes. Grips that modify surface or mesh objects must override this function and modify the display meshes here.",
"parameters": [
{
"name": "meshType",
"type": "Rhino.Geometry.MeshType",
"summary": "The mesh type being updated."
}
]
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "CustomPointObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.PointObject",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "CustomPointObject()",
"modifiers": ["protected"],
"protected": true,
"virtual": false
},
{
"signature": "CustomPointObject(Point point)",
"modifiers": ["protected"],
"protected": true,
"virtual": false
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public", "new"],
"protected": false,
"virtual": false,
"since": "5.6"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "override"],
"protected": true,
"virtual": false
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "GripsDrawEventArgs",
"dataType": "class",
"baseclass": "Rhino.Display.DrawEventArgs",
"properties": [
{
"signature": "int ControlPolygonStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "What kind of line is used to display things like control polygons. 0 = no control polygon, 1 = solid control polygon, 2 = dotted control polygon.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawDynamicStuff",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If true, then draw stuff that does not move when grips are dragged, like the control polygon of the \"original\" curve.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool DrawStaticStuff",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If true, then draw stuff that moves when grips are dragged, like the curve being bent by a dragged control point.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Color GripColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int GripStatusCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "Color LockedGripColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color SelectedGripColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Void DrawControlPolygonLine(Rhino.Geometry.Line line, GripStatus startStatus, GripStatus endStatus)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws the lines in a control polygons. \nThis is an helper function.",
"since": "5.0",
"parameters": [
{
"name": "line",
"type": "Rhino.Geometry.Line",
"summary": "Line between two grips."
},
{
"name": "startStatus",
"type": "GripStatus",
"summary": "Grip status at start of line."
},
{
"name": "endStatus",
"type": "GripStatus",
"summary": "Grip status at end of line."
}
]
},
{
"signature": "System.Void DrawControlPolygonLine(Rhino.Geometry.Line line, System.Int32 startStatus, System.Int32 endStatus)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws the lines in a control polygons. \nThis is an helper function.",
"since": "5.0",
"parameters": [
{
"name": "line",
"type": "Rhino.Geometry.Line",
"summary": "Line between two grips."
},
{
"name": "startStatus",
"type": "System.Int32",
"summary": "Index of Grip status at start of line."
},
{
"name": "endStatus",
"type": "System.Int32",
"summary": "Index if Grip status at end of line."
}
]
},
{
"signature": "System.Void DrawControlPolygonLine(Rhino.Geometry.Point3d start, Rhino.Geometry.Point3d end, System.Int32 startStatus, System.Int32 endStatus)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draws the lines in a control polygons. \nThis is an helper function.",
"since": "5.0",
"parameters": [
{
"name": "start",
"type": "Rhino.Geometry.Point3d",
"summary": "The point start."
},
{
"name": "end",
"type": "Rhino.Geometry.Point3d",
"summary": "The point end."
},
{
"name": "startStatus",
"type": "System.Int32",
"summary": "Index of Grip status at start of line defined by start and end."
},
{
"name": "endStatus",
"type": "System.Int32",
"summary": "Index if Grip status at end of line defined by start and end."
}
]
},
{
"signature": "GripStatus GripStatus(System.Int32 index)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void RestoreViewportSettings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "GripStatus",
"dataType": "class",
"properties": [
{
"signature": "bool Culled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool Visible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "UnknownUserData",
"dataType": "class",
"summary": "Represents user data with unknown origin.",
"baseclass": "Rhino.DocObjects.Custom.UserData",
"constructors": [
{
"signature": "UnknownUserData(IntPtr pointerNativeUserData)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new unknown data entity.",
"since": "5.0",
"parameters": [
{
"name": "pointerNativeUserData",
"type": "System.IntPtr",
"summary": "A pointer to the entity."
}
]
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "UserData",
"dataType": "class",
"summary": "Provides a base class for custom classes of information which may be attached to geometry or attribute classes.",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "UserData()",
"summary": "Initializes a new instance of the UserData class"
}
],
"properties": [
{
"signature": "string Description",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Descriptive name of the user data.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool ShouldWrite",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "If you want to save this user data in a 3dm file, override ShouldWrite and return true. If you do support serialization, you must also override the Read and Write functions.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Transform Transform",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Updated if user data is attached to a piece of geometry that is transformed and the virtual OnTransform() is not overridden. If you override OnTransform() and want Transform to be updated, then call the base class OnTransform() in your override. The default constructor sets Transform to the identity.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Void Copy(Runtime.CommonObject source, Runtime.CommonObject destination)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Expert user tool that copies user data that has a positive CopyCount from the source object to a destination object. Generally speaking you don't need to use Copy(). Simply rely on things like the copy constructors to do the right thing.",
"since": "5.0",
"parameters": [
{
"name": "source",
"type": "Runtime.CommonObject",
"summary": "A source object for the data."
},
{
"name": "destination",
"type": "Runtime.CommonObject",
"summary": "A destination object for the data."
}
]
},
{
"signature": "System.Guid MoveUserDataFrom(Runtime.CommonObject objectWithUserData)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Moves the user data from objectWithUserData to a temporary data storage identified by the return Guid. When MoveUserDataFrom returns, the objectWithUserData will not have any user data.",
"since": "5.0",
"parameters": [
{
"name": "objectWithUserData",
"type": "Runtime.CommonObject",
"summary": "Object with user data attached."
}
],
"returns": "Guid identifier for storage of UserData that is held in a temporary list by this class. This function should be used in conjunction with MoveUserDataTo to transfer the user data to a different object. Returns Guid.Empty if there was no user data to transfer."
},
{
"signature": "System.Void MoveUserDataTo(Runtime.CommonObject objectToGetUserData, System.Guid id, System.Boolean append)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Moves the user data. \nSee for more information.",
"since": "5.0",
"parameters": [
{
"name": "objectToGetUserData",
"type": "Runtime.CommonObject",
"summary": "Object data source."
},
{
"name": "id",
"type": "System.Guid",
"summary": "Target."
},
{
"name": "append",
"type": "System.Boolean",
"summary": "If the data should be appended or replaced."
}
]
},
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Actively reclaims unmanaged resources that this instance uses.",
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "For derived class implementers. \nThis method is called with argument True when class user calls Dispose(), while with argument False when the Garbage Collector invokes the finalizer, or Finalize() method. \nYou must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true. \nAlso, you must call the base virtual method within your overriding method.",
"parameters": [
{
"name": "disposing",
"type": "System.Boolean",
"summary": "True if the call comes from the Dispose() method; False if it comes from the Garbage Collector finalizer."
}
]
},
{
"signature": "System.Void OnDuplicate(UserData source)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Is called when the object is being duplicated.",
"parameters": [
{
"name": "source",
"type": "UserData",
"summary": "The source data."
}
]
},
{
"signature": "System.Void OnTransform(Geometry.Transform transform)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Is called when the object associated with this data is transformed. If you override this function, make sure to call the base class if you want the stored Transform to be updated.",
"parameters": [
{
"name": "transform",
"type": "Geometry.Transform",
"summary": "The transform being applied."
}
]
},
{
"signature": "System.Boolean Read(FileIO.BinaryArchiveReader archive)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Reads the content of this data from a stream archive.",
"parameters": [
{
"name": "archive",
"type": "FileIO.BinaryArchiveReader",
"summary": "An archive."
}
],
"returns": "True if the data was successfully written. The default implementation always returns false."
},
{
"signature": "System.Boolean Write(FileIO.BinaryArchiveWriter archive)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Writes the content of this data to a stream archive.",
"parameters": [
{
"name": "archive",
"type": "FileIO.BinaryArchiveWriter",
"summary": "An archive."
}
],
"returns": "True if the data was successfully written. The default implementation always returns false."
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "UserDataList",
"dataType": "class",
"summary": "Represents a collection of user data.",
"interfaces": ["IEnumerable"],
"properties": [
{
"signature": "int Count",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Number of UserData objects in this list.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "UserData this[int index]",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Retrieve through indexer. Read-only access."
}
],
"methods": [
{
"signature": "System.Boolean Add(UserData userdata)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If the user-data is already in a different UserDataList, it will be removed from that list and added to this list.",
"since": "5.0",
"parameters": [
{
"name": "userdata",
"type": "UserData",
"summary": "Data element."
}
],
"returns": "Whether this operation succeeded."
},
{
"signature": "System.Boolean Contains(System.Guid userdataId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Checks for the existence of a specific type of user-data in this list Both .NET and native user-data is checked",
"since": "6.1"
},
{
"signature": "UserData Find(System.Type userdataType)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Finds a specific data type in this regulated collection.",
"since": "5.0",
"parameters": [
{
"name": "userdataType",
"type": "System.Type",
"summary": "A data type."
}
],
"returns": "The found data, or None of nothing was found."
},
{
"signature": "IEnumerator GetEnumerator()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get enumerator for UserDataList",
"since": "6.0"
},
{
"signature": "System.Void Purge()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes all user data from this geometry.",
"since": "6.0",
"remarks": "User Remove to delete a single, known, item."
},
{
"signature": "System.Boolean Remove(UserData userdata)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove the user-data from this list",
"since": "5.6",
"returns": "True if the user data was successfully removed"
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "UserDataListEnumerator",
"dataType": "class",
"summary": "Enumerator for UserDataList",
"interfaces": ["IEnumerator"],
"constructors": [
{
"signature": "UserDataListEnumerator(UserDataList udl)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Create new UserDataListEnumerator",
"since": "6.0",
"parameters": [
{
"name": "udl",
"type": "UserDataList",
"summary": "UserDataList to enumerate"
}
]
}
],
"properties": [
{
"signature": "UserData Current",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get current UserData on the enumerator.",
"since": "6.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Implement Dispose(). NOP.",
"since": "6.0"
},
{
"signature": "System.Boolean MoveNext()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Advance enumerator to next UserData item.",
"since": "6.0",
"returns": "True if there is a next item."
},
{
"signature": "System.Void Reset()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Reset the enumerator",
"since": "6.0"
}
]
},
{
"namespace": "Rhino.DocObjects.Custom",
"name": "UserDictionary",
"dataType": "class",
"summary": "Defines the storage data class for a Rhino.Collections.ArchivableDictionary .",
"baseclass": "Rhino.DocObjects.Custom.UserData",
"constructors": [
{
"signature": "UserDictionary()",
"summary": "Initializes a new instance of the UserDictionary class"
}
],
"properties": [
{
"signature": "string Description",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets the text \"RhinoCommon UserDictionary\".",
"since": "5.0",
"property": ["get"]
},
{
"signature": "ArchivableDictionary Dictionary",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the dictionary that is associated with this class. \nThis dictionary is unique.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool ShouldWrite",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Writes this entity if the count is larger than 0.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Void OnDuplicate(UserData source)",
"modifiers": ["protected", "override"],
"protected": true,
"virtual": false,
"summary": "Clones the user data.",
"parameters": [
{
"name": "source",
"type": "UserData",
"summary": "The source data."
}
]
},
{
"signature": "System.Boolean Read(FileIO.BinaryArchiveReader archive)",
"modifiers": ["protected", "override"],
"protected": true,
"virtual": false,
"summary": "Is called to read this entity.",
"parameters": [
{
"name": "archive",
"type": "FileIO.BinaryArchiveReader",
"summary": "An archive."
}
],
"returns": "Always returns true."
},
{
"signature": "System.Boolean Write(FileIO.BinaryArchiveWriter archive)",
"modifiers": ["protected", "override"],
"protected": true,
"virtual": false,
"summary": "Is called to write this entity.",
"parameters": [
{
"name": "archive",
"type": "FileIO.BinaryArchiveWriter",
"summary": "An archive."
}
],
"returns": "Always returns true."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DetailViewObject",
"dataType": "class",
"summary": "A detail view object is a nested Rhino viewport placed on a page view with a 2D closed curve boundary. It can be any type of modeling view.",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "string DescriptiveTitle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Detail objects have two strings that can be used to describe the detail: 1. The name string that is part of the object's attributes 2. The viewport projection title that is part of the viewport This function combines these two strings to create a single \"description\" string in the form of attribute_name - projection_title.",
"since": "7.0",
"property": ["get"]
},
{
"signature": "DetailView DetailGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the detail view geometry.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsActive",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the active state of the detail view. Note, setting this property will trigger a RhinoPageView.PageViewSpaceChange event.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Transform PageToWorldTransform",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the page coordinate to world coordinate transformation.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "RhinoPageView ParentPageView",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the page view that this detail view belongs to.",
"since": "9.0",
"remarks": "Every detail view object belongs to one page view. Page views can be parent to multiple detail views.",
"property": ["get"]
},
{
"signature": "RhinoViewport Viewport",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the detail view's viewport.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Transform WorldToPageTransform",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the world coordinate to page coordinate transformation.",
"since": "6.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Boolean CommitViewportChanges()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean GetFormattedScale(ScaleFormat format, out System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the detail view object's scale as a formatted string. The detail view object's viewport must be to parallel projection.",
"since": "7.0",
"parameters": [
{
"name": "format",
"type": "ScaleFormat",
"summary": "The scale format."
},
{
"name": "value",
"type": "System.String",
"summary": "The formatted string"
}
],
"returns": "True if successful, False otherwise"
},
{
"signature": "System.Boolean TryGetModelLength(System.Double paper, out System.Double model)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Converts a paper length into a model length.",
"since": "8.17"
},
{
"signature": "System.Boolean TryGetPaperLength(System.Double model, out System.Double paper)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Converts a paper length into a model length.",
"since": "8.17"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DetailViewObject.ScaleFormat",
"dataType": "enum",
"summary": "Detail view object scale formats.",
"since": "7.0",
"values": [
{
"signature": "None",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No formatting"
},
{
"signature": "PageLengthToOne",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "#:1"
},
{
"signature": "OneToModelLength",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "1:#"
},
{
"signature": "OneInchToModelLengthFeet",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "1\" = #'"
},
{
"signature": "ModelLengthInchToOneFoot",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "#\" = 1'"
},
{
"signature": "ModelLengthInchToOneFootInch",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "#' = 1'-0\""
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionObject",
"dataType": "class",
"summary": "Rhino Object that represents dimension geometry and attributes",
"baseclass": "Rhino.DocObjects.AnnotationObjectBase",
"properties": [
{
"signature": "DimensionStyle DimensionStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the DimensionStyle associated with this OrdinateDimensionObject.",
"since": "6.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle",
"dataType": "class",
"summary": "Can also be considered an annotation style since it is used for more than just dimensions",
"baseclass": "Rhino.DocObjects.ModelComponent",
"constructors": [
{
"signature": "DimensionStyle()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Create a new non-document controlled annotation style",
"since": "5.0"
},
{
"signature": "DimensionStyle(SerializationInfo info, StreamingContext context)",
"modifiers": ["protected"],
"protected": true,
"virtual": false
}
],
"properties": [
{
"signature": "bool AlternateBelowLine",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "LengthDisplay AlternateDimensionLengthDisplay",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double AlternateLengthFactor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int AlternateLengthResolution",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "string AlternatePrefix",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double AlternateRoundoff",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "string AlternateSuffix",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "int AlternateToleranceResolution",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool AlternateUnitsDisplay",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "ZeroSuppression AlternateZeroSuppress",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "AngleDisplayFormat AngleFormat",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "int AngleResolution",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ZeroSuppression AngleZeroSuppress",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double AngularRoundoff",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "int ArcLengthSymbol",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Guid ArrowBlockId1",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Guid ArrowBlockId2",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double ArrowLength",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ArrowType ArrowType1",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "ArrowType ArrowType2",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double BaselineSpacing",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double CentermarkSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "CenterMarkStyle CenterMarkType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double ClippingArrowLength",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"property": ["get", "set"]
},
{
"signature": "ClippingArrowType ClippingArrowType1",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"property": ["get", "set"]
},
{
"signature": "ClippingArrowType ClippingArrowType2",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"property": ["get", "set"]
},
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns ModelComponentType.DimStyle .",
"since": "6.0",
"property": ["get"]
},
{
"signature": "char DecimalSeparator",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "LengthDisplay DimensionLengthDisplay",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double DimensionLineExtension",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double DimensionScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "ScaleValue DimensionScaleValue",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "LeaderContentAngleStyle DimRadialTextAngleType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "TextLocation DimRadialTextLocation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "TextOrientation DimRadialTextOrientation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "LeaderContentAngleStyle DimTextAngleType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "TextLocation DimTextLocation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "TextOrientation DimTextOrientation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawForward",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool DrawTextMask",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double ExtensionLineExtension",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double ExtensionLineOffset",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ArrowFit FitArrow",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.20",
"property": ["get", "set"]
},
{
"signature": "TextFit FitText",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.20",
"property": ["get", "set"]
},
{
"signature": "double FixedExtensionLength",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool FixedExtensionOn",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Font Font",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool ForceDimensionLineBetweenExtensionLines",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.20",
"property": ["get", "set"]
},
{
"signature": "bool HasFieldOverrides",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Checks if any fields in this DimensionStyle are overrides",
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool IsChild",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Tests if this DimensionStyle is a child of any other DimensionStyle",
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool IsDeleted",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool IsReference",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid LeaderArrowBlockId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double LeaderArrowLength",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ArrowType LeaderArrowType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.6",
"property": ["get", "set"]
},
{
"signature": "LeaderContentAngleStyle LeaderContentAngleType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Style of leader content angle Horizontal Aligned Rotated",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "LeaderCurveStyle LeaderCurveType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool LeaderHasLanding",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double LeaderLandingLength",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "TextHorizontalAlignment LeaderTextHorizontalAlignment",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "TextOrientation LeaderTextOrientation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double LeaderTextRotationDegrees",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double LeaderTextRotationRadians",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Angle of leader text for Rotated style",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "TextVerticalAlignment LeaderTextVerticalAlignment",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double LengthFactor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int LengthResolution",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double LineSpaceScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color MaskColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "MaskType MaskColorSource",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "MaskFrame MaskFrameType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double MaskOffset",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Guid ParentId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get or Set the Id of this DimensionStyle's parent. If ParentId is Guid.Empty, this DimensionStyle has no parent",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "string Prefix",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double Roundoff",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double ScaleLeftLengthMillimeters",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double ScaleRightLengthMillimeters",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "StackDisplayFormat StackFractionFormat",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double StackHeightScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "string Suffix",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SuppressArrow1",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool SuppressArrow2",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool SuppressExtension1",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool SuppressExtension2",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double TextGap",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double TextHeight",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "TextHorizontalAlignment TextHorizontalAlignment",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "int TextMoveLeader",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "TextOrientation TextOrientation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double TextRotation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool TextUnderlined",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "TextVerticalAlignment TextVerticalAlignment",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "ToleranceDisplayFormat ToleranceFormat",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double ToleranceHeightScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double ToleranceLowerValue",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "int ToleranceResolution",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double ToleranceUpperValue",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "ZeroSuppression ToleranceZeroSuppress",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool UseKerning",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int UserStringCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the amount of user strings.",
"since": "8.9",
"property": ["get"]
},
{
"signature": "ZeroSuppression ZeroSuppress",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "UnitSystem AlternateDimensionLengthDisplayUnit(System.UInt32 model_serial_number)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void ClearAllFieldOverrides()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets all the fields in this DimensionStyle to be not overridden Does not change any dimstyle_id's or parent_id's",
"since": "6.0"
},
{
"signature": "System.Void ClearFieldOverride(Field field)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the field as not overridden",
"since": "6.0"
},
{
"signature": "System.Void CopyFrom(DimensionStyle source)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Copy settings from source dimension style without changing the name, Id or index of this DimensionStyle.",
"since": "6.0",
"parameters": [
{
"name": "source",
"type": "DimensionStyle",
"summary": "DimensionStyle to copy settings from."
}
]
},
{
"signature": "Bitmap CreatePreviewBitmap(System.Int32 width, System.Int32 height, System.Boolean transparent)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0"
},
{
"signature": "Bitmap CreatePreviewBitmap(System.Int32 width, System.Int32 height)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void DeleteAllUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.9"
},
{
"signature": "System.Boolean DeleteUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.9"
},
{
"signature": "UnitSystem DimensionLengthDisplayUnit(System.UInt32 model_serial_number)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "DimensionStyle Duplicate()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Construct a deep (full) copy of this object.",
"since": "6.0",
"returns": "An object of the same type as this, with the same properties and behavior."
},
{
"signature": "DimensionStyle Duplicate(System.String newName, System.Guid newId, System.Guid newParentId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Construct a deep (full) copy of this object.",
"since": "6.0",
"returns": "An object of the same type as this, with the same properties and behavior."
},
{
"signature": "System.String GetUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets user string from this geometry.",
"since": "8.9",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve the string."
}
],
"returns": "string associated with the key if successful. None if no key was found."
},
{
"signature": "System.Collections.Specialized.NameValueCollection GetUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a copy of all (user key string, user value string) pairs attached to this geometry.",
"since": "8.9",
"returns": "A new collection."
},
{
"signature": "System.Boolean IsChildOf(System.Guid parentId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Tests if this DimensionStyle is a child of a specific DimensionStyle",
"since": "6.0",
"returns": "True if this is a child of the DimensionStyle with Parent False otherwise."
},
{
"signature": "System.Boolean IsFieldOverriden(Field field)",
"modifiers": ["public"],
"protected": false,
"virtual": false
},
{
"signature": "System.Void ScaleLengthValues(System.Double scale)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Scales all length values by 'scale'",
"since": "6.0"
},
{
"signature": "System.Void SetFieldOverride(Field field)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set a field as overridden",
"since": "6.0"
},
{
"signature": "System.Boolean SetUserString(System.String key, System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Attach a user string (key,value combination) to this geometry.",
"since": "8.9",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve this string."
},
{
"name": "value",
"type": "System.String",
"summary": "string associated with key."
}
],
"returns": "True on success."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.AngleDisplayFormat",
"dataType": "enum",
"summary": "Display format for angles",
"values": [
{
"signature": "DecimalDegrees = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Decimal Degrees"
},
{
"signature": "DegMinSec = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Degrees Minutes Seconds"
},
{
"signature": "Radians = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Decimal Radians"
},
{
"signature": "Grads = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Decimal Gradians"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.ArrowFit",
"dataType": "enum",
"summary": "Arrow display position inside or outside extension lines",
"values": [
{
"signature": "Auto = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Auto - Display when space permits"
},
{
"signature": "ArrowsInside = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Force arrows inside extensions"
},
{
"signature": "ArrowsOutside = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Force arrows outside extensions"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.ArrowType",
"dataType": "enum",
"summary": "Defines enumerated values for arrowhead shapes.",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "UserBlock = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SolidTriangle = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Dot = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Tick = 4",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ShortTriangle = 5",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "OpenArrow = 6",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Rectangle = 7",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LongTriangle = 8",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LongerTriangle = 9",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SolidDatumTriangle = 10",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.CenterMarkStyle",
"dataType": "enum",
"summary": "Style for drawing centermark for Radial dimensions and Centermark objects",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No centermark display"
},
{
"signature": "Mark = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "+ mark only"
},
{
"signature": "MarkAndLines = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "+ mark and lines to radius"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.ClippingArrowType",
"dataType": "enum",
"summary": "Defines enumerated values for arrowhead shapes.",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Triangle = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "OffsetTriangle = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Arrow = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "OffsetArrow = 4",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "OpenArrow = 5",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Rectangle = 6",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Ribbon = 7",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Line = 8",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.Field",
"dataType": "enum",
"summary": "Field identifiers used for file i/o and getting/setting values",
"values": [
{
"signature": "Unset = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Name = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Dimension style Name property. Cannot be inherited from parent."
},
{
"signature": "Index = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Dimension style runtime model component index property. Cannot be inherited from parent."
},
{
"signature": "ExtensionLineExtension = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ExtensionLineOffset = 4",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Arrowsize = 5",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LeaderArrowsize = 6",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Centermark = 7",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TextGap = 8",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TextHeight = 9",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimTextLocation = 10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Linear, angular, and ordinate dimension text location above/in/below"
},
{
"signature": "MaskFrameType = 11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask frame"
},
{
"signature": "LengthResolution = 12",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AngleFormat = 13",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AngleResolution = 14",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Font = 15",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LengthFactor = 16",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "LengthFactor is a rarely used. It applies when a model is being drawn to a scale and the dimension length values should be reverse scaled. For example, if a model is drawn at 1/4 scale, a line 5 units long indicates the real world line is 20 units long. In this case setting LengthFactor to 4 would cause a linear dimension applied to that line to display a value of 20."
},
{
"signature": "Alternate = 17",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AlternateLengthFactor = 18",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "AlternateLengthFactor is a rarely used. See Length factor for a description of this property."
},
{
"signature": "AlternateLengthResolution = 20",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Prefix = 21",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Suffix = 22",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AlternatePrefix = 23",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AlternateSuffix = 24",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimensionLineExtension = 25",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SuppressExtension1 = 26",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SuppressExtension2 = 27",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ExtLineColorSource = 28",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimLineColorSource = 29",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ArrowColorSource = 30",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TextColorSource = 31",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ExtLineColor = 32",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimLineColor = 33",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ArrowColor = 34",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TextColor = 35",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ExtLinePlotColorSource = 36",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimLinePlotColorSource = 37",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ArrowPlotColorSource = 38",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TextPlotColorSource = 39",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ExtLinePlotColor = 40",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimLinePlotColor = 41",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ArrowPlotColor = 42",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TextPlotColor = 43",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ExtLinePlotWeightSource = 44",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimLinePlotWeightSource = 45",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ExtLinePlotWeight_mm = 46",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimLinePlotWeight_mm = 47",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ToleranceFormat = 48",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ToleranceResolution = 49",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ToleranceUpperValue = 50",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ToleranceLowerValue = 51",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AltToleranceResolution = 52",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ToleranceHeightScale = 53",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "BaselineSpacing = 54",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DrawMask = 55",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "MaskColorSource = 56",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "MaskColor = 57",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "MaskBorder = 58",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimensionScale = 59",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimscaleSource = 60",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "FixedExtensionLength = 61",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "FixedExtensionOn = 62",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TextRotation = 63",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SuppressArrow1 = 64",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SuppressArrow2 = 65",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TextmoveLeader = 66",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ArclengthSymbol = 67",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "StackTextheightScale = 68",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "StackFormat = 69",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AltRound = 70",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Round = 71",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AngularRound = 72",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AltZeroSuppress = 73",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AngleZeroSuppress = 75",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ZeroSuppress = 76",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "AltBelow = 77",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ArrowType1 = 78",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ArrowType2 = 79",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LeaderArrowType = 80",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ArrowBlockId1 = 81",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ArrowBlockId2 = 82",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LeaderArrowBlock = 83",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimRadialTextLocation = 84",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Radial dimension text location above/in/below"
},
{
"signature": "TextVerticalAlignment = 85",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LeaderTextVerticalAlignment = 86",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LeaderContentAngleStyle = 87",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LeaderCurveType = 88",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LeaderContentAngle = 89",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LeaderHasLanding = 90",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LeaderLandingLength = 91",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "MaskFlags = 92",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "CentermarkStyle = 93",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TextHorizontalAlignment = 94",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LeaderTextHorizontalAlignment = 95",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DrawForward = 96",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "SignedOrdinate = 97",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "UnitSystem = 98",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Unit system for dimension rendering sizes like TextHeight, TextGap, ArrowSize, ExtOffset, and dozens of other properties that control the appearance and placement of the components used to render a dimension."
},
{
"signature": "TextMask = 99",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TextOrientation = 100",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "LeaderTextOrientation = 101",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimTextOrientation = 102",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimRadialTextOrientation = 103",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimTextAngleStyle = 104",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimRadialTextAngleStyle = 105",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "TextUnderlined = 106",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "DimensionLengthDisplay = 109",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Dimension length display. See ON_DimStyle::DimensionLengthDisplay() for a description of this parameter."
},
{
"signature": "AlternateDimensionLengthDisplay = 110",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Alternate dimension length display. See ON_DimStyle::AlternateDimensionLengthDisplay() for a description of this parameter."
},
{
"signature": "ForceDimLine = 111",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Force dimension line to draw when text is moved outside"
},
{
"signature": "ArrowFit = 112",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Arrow position when arrows won't fit between extensions"
},
{
"signature": "TextFit = 113",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text position when text won't fit between extensions"
},
{
"signature": "DecimalSeparator = 114",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Character to use for decimal separator in dimension text"
},
{
"signature": "Kerning = 115",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Enable kerning for placement of characters"
},
{
"signature": "LineSpaceScale = 116",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Scale applied for line spacing"
},
{
"signature": "ClippingArrowType1 = 117",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ClippingArrowType2 = 118",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "ClippingArrowSize = 119",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Count = 120",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Every enum UINT value that identifies a valid dimension style property is less than the UINT value of Count."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.LeaderContentAngleStyle",
"dataType": "enum",
"summary": "Angle for text or other leader or dimension content",
"values": [
{
"signature": "Horizontal = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Annotation text is horizontal in annotation object's plane"
},
{
"signature": "Aligned = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Aligned with last leader direction or dimension line"
},
{
"signature": "Rotated = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Explicit angle"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.LeaderCurveStyle",
"dataType": "enum",
"summary": "Type of leader curve",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Polyline = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Spline = 2",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.LengthDisplay",
"dataType": "enum",
"summary": "Dimension display length unit system and style",
"values": [
{
"signature": "ModelUnits = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Decimal current model units"
},
{
"signature": "Millmeters = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Decimal Millimeters"
},
{
"signature": "Centimeters = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Decimal Centimeters"
},
{
"signature": "Meters = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Decimal Meters"
},
{
"signature": "Kilometers = 6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Decimal Kilometers"
},
{
"signature": "InchesDecimal = 7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Decimal Inches"
},
{
"signature": "InchesFractional = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Fractional Inches ( 1.75 inches displays as 1-3/4 )"
},
{
"signature": "FeetDecimal = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Decimal Feet"
},
{
"signature": "FeetAndInches = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Feet and Inches ( 14.75 inches displays as 1'-2-3/4\" )"
},
{
"signature": "Miles = 9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Decimal Miles"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.LengthDisplayFormat",
"dataType": "enum",
"summary": "Obsolete format for length display - use ON_DimStyle::DimensionLengthDisplay instead",
"values": [
{
"signature": "Decimal = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Obsolete - use ON_DimStyle::DimensionLengthDisplay::ModelUnits."
},
{
"signature": "Fractional = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Obsolete - use ON_DimStyle::DimensionLengthDisplay::InchesFractional"
},
{
"signature": "FeetInches = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Obsolete - use ON_DimStyle::DimensionLengthDisplay::FeetAndInches"
},
{
"signature": "FeetDecimalInches = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Obsolete - use ON_DimStyle::DimensionLengthDisplay::FeetAndInches enum."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.MaskFrame",
"dataType": "enum",
"summary": "Draw a frame stroke around the text mask area",
"values": [
{
"signature": "NoFrame = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask frame not drawn"
},
{
"signature": "RectFrame = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask frame outline rectangle drawn"
},
{
"signature": "CapsuleFrame = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask frame outline capsule drawn"
},
{
"signature": "CircleFrame = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask frame outline circle drawn"
},
{
"signature": "SquareFrame = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask frame outline square drawn"
},
{
"signature": "DiamondFrame = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask frame outline square rotated 45 degrees"
},
{
"signature": "TriangleFrame = 6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask frame outline triangle drawn"
},
{
"signature": "HexagonFrame = 7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask frame outline as a hexagon"
},
{
"signature": "HexagonCapsuleFrame = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask frame outline as an elongated hexagon"
},
{
"signature": "RoundRectFrame = 9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask frame outline as a rounded rectangle"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.MaskType",
"dataType": "enum",
"summary": "Text mask drawn with background color or explicit color",
"values": [
{
"signature": "BackgroundColor = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask drawn with background color"
},
{
"signature": "MaskColor = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text mask drawn with explicit color"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.StackDisplayFormat",
"dataType": "enum",
"summary": "Format of stacked fractions",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No stacking"
},
{
"signature": "StackHorizontal = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Stack with horizontal line"
},
{
"signature": "StackDiagonal = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Stack with angled line"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.TextFit",
"dataType": "enum",
"summary": "Text display position inside or outside extension lines",
"values": [
{
"signature": "Auto = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Auto - Display inside when space permits"
},
{
"signature": "TextInside = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Force text inside extensions"
},
{
"signature": "TextRight = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Force text outside to the right of extensions"
},
{
"signature": "TextLeft = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Force text outside to the left of extensions"
},
{
"signature": "TextHintRight = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Move text outside to the right of extensions when it won't fit inside"
},
{
"signature": "TextHintLeft = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Move text outside to the left of extensions when it won't fit inside"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.TextLocation",
"dataType": "enum",
"summary": "The location of text in linear, angular, radial, and ordinate dimensions.",
"values": [
{
"signature": "AboveDimLine = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text is above dimension line."
},
{
"signature": "InDimLine = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text is centered in dimension line."
},
{
"signature": "BelowDimLine = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text is below dimension line."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.ToleranceDisplayFormat",
"dataType": "enum",
"summary": "Style of tolerance display for dimensions",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No tolerance display"
},
{
"signature": "Symmetrical = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Symmetrical +/- tolerance"
},
{
"signature": "Deviation = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Distance +tol, -tol"
},
{
"signature": "Limits = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Distance upper and lower limits"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DimensionStyle.ZeroSuppression",
"dataType": "enum",
"summary": "Marks leading and trailing zeros for removal.",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No zero suppression."
},
{
"signature": "SuppressLeading = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Suppress leading zeros."
},
{
"signature": "SuppressTrailing = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Suppress trailing zeros."
},
{
"signature": "SuppressLeadingAndTrailing = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Suppress leading and trailing zeros."
},
{
"signature": "SuppressZeroFeet = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Suppress zero feet."
},
{
"signature": "SuppressZeroInches = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Suppress zero inches."
},
{
"signature": "SuppressZeroFeetAndZeroInches = 12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Suppress zero feet and zero inches."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DisplayMode",
"dataType": "enum",
"summary": "Defines enumerated values for display modes, such as wireframe or shaded.",
"since": "5.0",
"values": [
{
"signature": "Default = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The default display mode."
},
{
"signature": "Wireframe = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The wireframe display mode. \nObjects are generally only outlined by their corresponding isocurves and edges."
},
{
"signature": "Shaded = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The shaded display mode. \nObjects are generally displayed with their corresponding isocurves and edges, and are filled with their display colors."
},
{
"signature": "RenderPreview = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The render display mode. \nObjects are generally displayed in a similar way to the one that will be resulting from rendering."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "DistanceDisplayMode",
"dataType": "enum",
"summary": "Defines enumerated values for the display of distances in US customary and Imperial units.",
"since": "5.0",
"values": [
{
"signature": "Decimal = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Shows distance decimals."
},
{
"signature": "Feet = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Show feet."
},
{
"signature": "FeetAndInches = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Show feet and inches."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "EarthAnchorPoint",
"dataType": "class",
"summary": "Contains information about the model's position in latitude, longitude, and elevation for GIS mapping applications.",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "EarthAnchorPoint()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new instance of the EarthAnchorPoint class.",
"since": "5.0"
}
],
"properties": [
{
"signature": "string Description",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the long form of the identifying information about this location.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double EarthBasepointElevation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the point elevation on earth, in meters.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "EarthCoordinateSystem EarthBasepointElevationCoordinateSystem",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating the zero level convention relating to a location on Earth.",
"since": "8.5",
"property": ["get", "set"]
},
{
"signature": "BasepointZero EarthBasepointElevationZero",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating the zero level convention relating to a location on Earth.",
"since": "5.0",
"obsolete": "Please use EarthBasepointElevationCoordinateSystem property",
"property": ["get", "set"]
},
{
"signature": "double EarthBasepointLatitude",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a point latitude on earth, in degrees. +90 = north pole, 0 = equator, -90 = south pole.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double EarthBasepointLongitude",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the point longitude on earth, in degrees.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double KMLOrientationHeadingAngleDegrees",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets Keyhole Markup Language (KML) orientation heading angle in degrees.",
"since": "7.11",
"property": ["get"]
},
{
"signature": "double KMLOrientationHeadingAngleRadians",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets Keyhole Markup Language (KML) orientation heading angle in radians.",
"since": "7.11",
"property": ["get"]
},
{
"signature": "double KMLOrientationRollAngleDegrees",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets Keyhole Markup Language (KML) orientation roll angle in degrees.",
"since": "7.11",
"property": ["get"]
},
{
"signature": "double KMLOrientationRollAngleRadians",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets Keyhole Markup Language (KML) orientation roll angle in degrees.",
"since": "7.11",
"property": ["get"]
},
{
"signature": "double KMLOrientationTiltAngleDegrees",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets Keyhole Markup Language (KML) orientation tilt angle in degrees.",
"since": "7.11",
"property": ["get"]
},
{
"signature": "double KMLOrientationTiltAngleRadians",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets Keyhole Markup Language (KML) orientation tilt angle in degrees.",
"since": "7.11",
"property": ["get"]
},
{
"signature": "Point3d ModelBasePoint",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Corresponding model point in model coordinates.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Vector3d ModelEast",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Earth directions in model coordinates.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Vector3d ModelNorth",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Earth directions in model coordinates.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string Name",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the short form of the identifying information about this location.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Actively reclaims unmanaged resources that this instance uses.",
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "For derived class implementers. \nThis method is called with argument True when class user calls Dispose(), while with argument False when the Garbage Collector invokes the finalizer, or Finalize() method. \nYou must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true. \nAlso, you must call the base virtual method within your overriding method.",
"parameters": [
{
"name": "disposing",
"type": "System.Boolean",
"summary": "True if the call comes from the Dispose() method; False if it comes from the Garbage Collector finalizer."
}
]
},
{
"signature": "System.Boolean EarthLocationIsSet()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Checks if the earth location is set or not.",
"since": "6.0",
"returns": "Boolean value, True if set else false"
},
{
"signature": "Plane GetEarthAnchorPlane(out Vector3d anchorNorth)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the earth anchor plane",
"since": "6.0",
"returns": "A plane value."
},
{
"signature": "Plane GetModelCompass()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns a plane in model coordinates whose X axis points East, Y axis points North and Z axis points Up. The origin is set to ModelBasepoint.",
"since": "5.0",
"returns": "A plane value. This might be invalid on error."
},
{
"signature": "Transform GetModelToEarthTransform(LengthUnit modelUnits)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a transformation from model coordinates to earth coordinates. This transformation assumes the model is small enough that the curvature of the earth can be ignored.",
"since": "9.0",
"remarks": "If M is a point in model coordinates and E = model_to_earth*M, then E.x = latitude in decimal degrees E.y = longitude in decimal degrees E.z = elevation in meters above mean sea level Because the earth is not flat, there is a small amount of error when using a linear transformation to calculate oblate spherical coordinates. This error is small. If the distance from P to M is d meters, then the approximation error is latitude error <= longitude error <= elevation error <= 6379000*((1 + (d/6356000)^2)-1) meters In particular, if every point in the model is within 1000 meters of the m_model_basepoint, then the maximum approximation errors are latitude error <= longitude error <= elevation error <= 8 centimeters.",
"parameters": [
{
"name": "modelUnits",
"type": "LengthUnit",
"summary": "The model length unit."
}
],
"returns": "Transform on success. Invalid Transform on error."
},
{
"signature": "Transform GetModelToEarthTransform(UnitSystem modelUnitSystem)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a transformation from model coordinates to earth coordinates. This transformation assumes the model is small enough that the curvature of the earth can be ignored.",
"since": "5.0",
"deprecated": "9.0",
"obsolete": "Since 9.0",
"remarks": "If M is a point in model coordinates and E = model_to_earth*M, then E.x = latitude in decimal degrees E.y = longitude in decimal degrees E.z = elevation in meters above mean sea level Because the earth is not flat, there is a small amount of error when using a linear transformation to calculate oblate spherical coordinates. This error is small. If the distance from P to M is d meters, then the approximation error is latitude error <= longitude error <= elevation error <= 6379000*((1 + (d/6356000)^2)-1) meters In particular, if every point in the model is within 1000 meters of the m_model_basepoint, then the maximum approximation errors are latitude error <= longitude error <= elevation error <= 8 centimeters.",
"parameters": [
{
"name": "modelUnitSystem",
"type": "UnitSystem",
"summary": "The model unit system."
}
],
"returns": "Transform on success. Invalid Transform on error."
},
{
"signature": "System.Boolean ModelLocationIsSet()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Checks if the model location is set or not.",
"since": "8.5",
"returns": "Boolean value, True if set else false"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "EarthCoordinateSystem",
"dataType": "enum",
"summary": "ON::EarthCoordinateSystem identifies the standard used to define Earth latitude, longitude, and elevation coordinates.",
"values": [
{
"signature": "Unset = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "ON::EarthCoordinateSystem::Unset"
},
{
"signature": "GroundLevel = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "ON::EarthCoordinateSystem::GroundLevel Not well defined, but latitude and longitude will be good enough for architecture sun studies."
},
{
"signature": "MeanSeaLevel = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "CenterOfEarth = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "ON::EarthCoordinateSystem::CenterOfEarth Not well defined. The Earth's center of mass and center of volume are at different locations."
},
{
"signature": "WGS1984 = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "ON::EarthCoordinateSystem::WGS1984 World Geodetic System 1984 standard. (Current GPS standard.)"
},
{
"signature": "EGM2008 = 6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "ON::EarthCoordinateSystem::EGM2008 Earth Gravitational Model 2008 standard."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Environment",
"dataType": "class",
"summary": "Represents an environment.",
"baseclass": "Rhino.Runtime.CommonObject",
"constructors": [
{
"signature": "Environment()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new environment.",
"since": "8.0"
}
],
"properties": [
{
"signature": "Color BackgroundColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The background color.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "Texture BackgroundImage",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The background image texture.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "BackgroundProjections BackgroundProjection",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The background projection.",
"since": "8.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Environment.BackgroundProjections",
"dataType": "enum",
"summary": "The available background projections.",
"since": "8.0",
"values": [
{
"signature": "Planar = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Planar."
},
{
"signature": "Spherical = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Spherical."
},
{
"signature": "Emap = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Environment map."
},
{
"signature": "Box = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Box."
},
{
"signature": "Automatic = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Automatic."
},
{
"signature": "LightProbe = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Light probe."
},
{
"signature": "CubeMap = 6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Cube map."
},
{
"signature": "VerticalCrossCubeMap = 7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Vertical cross cube map."
},
{
"signature": "HorizontalCrossCubeMap = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Horizontal cross cube map."
},
{
"signature": "Hemispherical = 9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Hemispherical."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ExtrusionObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "Extrusion ExtrusionGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "Extrusion DuplicateExtrusionGeometry()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Font",
"dataType": "class",
"summary": "Defines a format for text.",
"interfaces": ["ISerializable"],
"constructors": [
{
"signature": "Font(string familyName, FontWeight weight, FontStyle style, bool underlined, bool strikethrough)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "Font(string familyName, FontWeight weight, FontStyle style, FontStretch stretch, bool underlined, bool strikethrough)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "Font(string familyName)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
}
],
"properties": [
{
"signature": "bool Bold",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "string Description",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns a long description that includes family, face, weight, stretch and style information. Generally not useful for finding matching fonts.",
"since": "6.5",
"property": ["get"]
},
{
"signature": "string EnglishFaceName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns English Face name",
"since": "6.9",
"property": ["get"]
},
{
"signature": "string EnglishFamilyName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.9",
"property": ["get"]
},
{
"signature": "string EnglishQuartetName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.12",
"property": ["get"]
},
{
"signature": "string FaceName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns Face name",
"since": "5.0",
"property": ["get"]
},
{
"signature": "string FamilyName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.5",
"property": ["get"]
},
{
"signature": "string FamilyPlusFaceName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns concatenated Family and Face names",
"since": "6.9",
"property": ["get"]
},
{
"signature": "bool IsEngravingFont",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.10",
"property": ["get"]
},
{
"signature": "bool IsGeometricToleranceFont",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0",
"property": ["get"]
},
{
"signature": "bool IsInstalled",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Is this font installed on the system",
"since": "8.7",
"property": ["get"]
},
{
"signature": "bool IsSimulated",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.5",
"property": ["get"]
},
{
"signature": "bool IsSingleStrokeFont",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.5",
"property": ["get"]
},
{
"signature": "bool IsSymbolFont",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.5",
"property": ["get"]
},
{
"signature": "bool Italic",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "string LogfontName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns Windows LOGFONT Face name",
"since": "6.5",
"property": ["get"]
},
{
"signature": "double PointSize",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "string PostScriptName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the Font PostScriptName - \"Apple font name\"",
"since": "6.5",
"property": ["get"]
},
{
"signature": "string QuartetName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.7",
"property": ["get"]
},
{
"signature": "string RichTextFontName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the Font RichTextFontName used in RTF strings: {\\\\fonttbl...{\\\\fN RichTextFontName;}...}",
"since": "6.5",
"property": ["get"]
},
{
"signature": "FontStretch Stretch",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get"]
},
{
"signature": "bool Strikeout",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "FontStyle Style",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool Underlined",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "FontWeight Weight",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.String[] AvailableFontFaceNames()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Font FromQuartetProperties(System.String quartetName, System.Boolean bold, System.Boolean italic)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.7"
},
{
"signature": "Font[] InstalledFonts()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.5"
},
{
"signature": "Font[] InstalledFonts(System.String familyName)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.5"
},
{
"signature": "FontQuartet[] InstalledFontsAsQuartets()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.7"
},
{
"signature": "System.Void GetObjectData(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Populates a System.Runtime.Serialization.SerializationInfo with the data needed to serialize the target object.",
"since": "8.0",
"parameters": [
{
"name": "info",
"type": "System.Runtime.Serialization.SerializationInfo",
"summary": "The System.Runtime.Serialization.SerializationInfo to populate with data."
},
{
"name": "context",
"type": "System.Runtime.Serialization.StreamingContext",
"summary": "The destination (see System.Runtime.Serialization.StreamingContext) for this serialization."
}
]
},
{
"signature": "Font GetSubstituteFont()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If this font is not installed on the system, try to find a substitute",
"since": "8.7"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Font.FontOrigin",
"dataType": "enum",
"summary": "Platform where font originated. This information is useful when searching for appropriate substitutes.",
"values": [
{
"signature": "Unset = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Not set."
},
{
"signature": "Unknown = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Origin unknown. Changing an ON_Font characteristic like weight or style sets the origin to unknown."
},
{
"signature": "WindowsFont = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Set from a Windows IDWriteFont by ON_Font::SetFromDWriteFont() or a Windows LOGFONT by ON_Font::SetFromWindowsLogFont() and FaceName and WindowLogfontName match a font installed on a Windows device."
},
{
"signature": "AppleFont = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Set from an Apple CTFont. The PostScriptName() and FamilyName() match a font installed on device running MacOS or iOS. The FaceName() matches the \"typeface\" name shown in the MacOS FontBook app."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Font.FontStretch",
"dataType": "enum",
"summary": "Horizontal expansion or contraction of font",
"values": [
{
"signature": "Unset = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Not set."
},
{
"signature": "Ultracondensed = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Extracondensed = 2",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Condensed = 3",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Semicondensed = 4",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Medium = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Default font stretch."
},
{
"signature": "Semiexpanded = 6",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Expanded = 7",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Extraexpanded = 8",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Ultraexpanded = 9",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Font.FontStyle",
"dataType": "enum",
"summary": "Vertical angle of font Upright, Italic, or Oblique",
"values": [
{
"signature": "Unset = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Not set."
},
{
"signature": "Upright = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Default font style."
},
{
"signature": "Italic = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The face is sloped so the top is to the right of the base. Face names sometimes use the word \"oblique\" for italic faces."
},
{
"signature": "Oblique = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The face is sloped so the top is to the left of the base. This is extremely rare. NOTE WELL: Face names sometimes use the word \"oblique\" for italic faces."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Font.FontType",
"dataType": "enum",
"summary": "An enum that reports if the font face is available on the current device.",
"values": [
{
"signature": "Unset = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Not set."
},
{
"signature": "ManagedFont = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "In the managed font list."
},
{
"signature": "InstalledFont = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "In the installed font list."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Font.FontWeight",
"dataType": "enum",
"summary": "Weight enum values Avoid casting these values to int. Use ON_Font::WindowsLogfontWeightFromWeight() or ON_Font::AppleWeightOfFontFromWeight() or add another converter.",
"values": [
{
"signature": "Unset = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Not set."
},
{
"signature": "Thin = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "IsLight = True"
},
{
"signature": "Ultralight = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "IsLight = True"
},
{
"signature": "Light = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "IsLight = True"
},
{
"signature": "Normal = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Default font weight. IsNormalWeight = True Also called Regular."
},
{
"signature": "Medium = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "IsNormalWeight = True"
},
{
"signature": "Semibold = 6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "IsBold = True"
},
{
"signature": "Bold = 7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "IsBold = True"
},
{
"signature": "Ultrabold = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "IsBold = True"
},
{
"signature": "Heavy = 9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "IsBold = True Also called Black"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "FontQuartet",
"dataType": "class",
"constructors": [
{
"signature": "FontQuartet(string name, bool supportsRegular, bool supportsBold, bool supportsItalic, bool supportsBoldItalic)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.26"
}
],
"properties": [
{
"signature": "bool HasBoldFont",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.7",
"property": ["get", "set"]
},
{
"signature": "bool HasBoldItalicFont",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.7",
"property": ["get", "set"]
},
{
"signature": "bool HasItalicFont",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.7",
"property": ["get", "set"]
},
{
"signature": "bool HasRegularFont",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.7",
"property": ["get", "set"]
},
{
"signature": "string QuartetName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.7",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.String ToString()",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "GripObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "Point3d CurrentLocation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int Index",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool Moved",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True if the grip has moved from OriginalLocation.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Point3d OriginalLocation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid OwnerId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "double Weight",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "The weight of a NURBS control point grip or RhinoMath.UnsetValue if the grip is not a NURBS control point grip.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Boolean GetCageParameters(out System.Double u, out System.Double v, out System.Double w)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Retrieves the 2d parameter space values of this GripObject from the cage it's associated with.",
"since": "6.0",
"returns": "True on success. Output is unreliable if return is false."
},
{
"signature": "System.Int32 GetCurveCVIndices(out System.Int32[] cvIndices)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Retrieves the NURBS curve control point indices of this GripObject from the curve it is associated with.",
"since": "8.10",
"parameters": [
{
"name": "cvIndices",
"type": "System.Int32[]",
"summary": "The NURBS curve control point indices."
}
],
"returns": "The number of NURBS curve control points managed by this grip. If the grip is not a curve control point, zero is returned."
},
{
"signature": "System.Boolean GetCurveParameters(out System.Double t)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Retrieves the 2d parameter space values of this GripObject from the curve it's associated with.",
"since": "6.0",
"returns": "True on success. Output is unreliable if return is false."
},
{
"signature": "System.Boolean GetGripDirections(out Vector3d u, out Vector3d v, out Vector3d normal)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sometimes grips have directions. These directions can have any length and do not have to be orthogonal.",
"since": "6.0",
"parameters": [
{
"name": "u",
"type": "Vector3d",
"summary": "u direction"
},
{
"name": "v",
"type": "Vector3d",
"summary": "v direction"
},
{
"name": "normal",
"type": "Vector3d",
"summary": "normal direction"
}
],
"returns": "True if the grip has directions."
},
{
"signature": "System.Int32 GetSurfaceCVIndices(out Tuple[] cvIndices)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Retrieves the NURBS surface control point indices of this GripObject from the surface it is associated with.",
"since": "8.10",
"parameters": [
{
"name": "cvIndices",
"type": "Tuple[]",
"summary": "The NURBS surface control point indices as tuples."
}
],
"returns": "The number of NURBS surface control points managed by this grip. If the grip is not a surface control point, zero is returned."
},
{
"signature": "System.Boolean GetSurfaceParameters(out System.Double u, out System.Double v)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Retrieves the NURBS surface 2d parameter space values of this GripObject from the surface it's associated with.",
"since": "6.0",
"returns": "True on success. Output is unreliable if return is false."
},
{
"signature": "System.Void Move(Point3d newLocation)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Moves the grip to a new location.",
"since": "5.0",
"parameters": [
{
"name": "newLocation",
"type": "Point3d",
"summary": "New location for grip."
}
]
},
{
"signature": "System.Void Move(Transform xform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Moves the grip to a new location.",
"since": "5.0",
"parameters": [
{
"name": "xform",
"type": "Transform",
"summary": "Transformation applied to the OriginalLocation point."
}
]
},
{
"signature": "System.Void Move(Vector3d delta)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Moves the grip to a new location.",
"since": "5.0",
"parameters": [
{
"name": "delta",
"type": "Vector3d",
"summary": "Translation applied to the OriginalLocation point."
}
]
},
{
"signature": "GripObject NeighborGrip(System.Int32 directionR, System.Int32 directionS, System.Int32 directionT, System.Boolean wrap)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Used to get a grip's logical neighbors, like NURBS curve, surface, and cage control point grips.",
"since": "5.0",
"parameters": [
{
"name": "directionR",
"type": "System.Int32",
"summary": "-1 to go back one grip, +1 to move forward one grip. For curves, surfaces and cages, this is the first parameter direction."
},
{
"name": "directionS",
"type": "System.Int32",
"summary": "-1 to go back one grip, +1 to move forward one grip. For surfaces and cages this is the second parameter direction."
},
{
"name": "directionT",
"type": "System.Int32",
"summary": "For cages this is the third parameter direction"
},
{
"name": "wrap",
"type": "System.Boolean",
"summary": ""
}
],
"returns": "logical neighbor or None if the is no logical neighbor"
},
{
"signature": "System.Void UndoMove()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Undoes any grip moves made by calling Move.",
"since": "5.0"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Group",
"dataType": "class",
"baseclass": "Rhino.DocObjects.ModelComponent",
"properties": [
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns ModelComponentType.Group .",
"since": "6.0",
"property": ["get"]
},
{
"signature": "int UserStringCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the amount of user strings.",
"since": "6.4",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Void DeleteAllUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.11"
},
{
"signature": "System.Boolean DeleteUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.11"
},
{
"signature": "System.String GetUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets user string from this geometry.",
"since": "6.4",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve the string."
}
],
"returns": "string associated with the key if successful. None if no key was found."
},
{
"signature": "System.Collections.Specialized.NameValueCollection GetUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a copy of all (user key string, user value string) pairs attached to this geometry.",
"since": "6.4",
"returns": "A new collection."
},
{
"signature": "System.Boolean SetUserString(System.String key, System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Attach a user string (key,value combination) to this geometry.",
"since": "6.4",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve this string."
},
{
"name": "value",
"type": "System.String",
"summary": "string associated with key."
}
],
"returns": "True on success."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "HatchLine",
"dataType": "class",
"summary": "Hatch lines are used by hatch pattern to specify the dashes and offset patterns of the lines.",
"remarks": "Each line has the following information: Angle is the direction of the line counter-clockwise from the x-axis. The first line origin is at the base point. Each line repetition is offset from the previous line. Offset.X is parallel to the line and Offset.Y is perpendicular to the line. The base and offset values are rotated by the line's angle to produce a location in the hatch pattern's coordinate system. There can be gaps and dashes specified for drawing the line. If there are no dashes, the line is solid. Negative length dashes are gaps. Positive length dashes are drawn as line segments.",
"interfaces": ["IDisposable"],
"since": "8.0",
"constructors": [
{
"signature": "HatchLine()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Construts a new hatch line.",
"since": "8.0"
},
{
"signature": "HatchLine(HatchLine hatchLine)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Construts a new hatch line.",
"since": "8.0",
"parameters": [
{
"name": "hatchLine",
"type": "HatchLine",
"summary": "The hatch line to copy."
}
]
}
],
"properties": [
{
"signature": "double Angle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets and sets the angle, in radians, of the hatch line. The angle is measured counter-clockwise from the x-axis.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Point2d BasePoint",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get and sets this line's 2d base point.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int DashCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the number of dashes + gaps in this line.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "IEnumerable GetDashes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets all of the dashes.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "bool IsValid",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Verifies a hatch line is valid.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "Vector2d Offset",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get and sets this line's 2d offset for line repetitions. Offset.X is shift parallel to line. Offset.Y is spacing perpendicular to line.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "double PatternLength",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the total length of a pattern repeat.",
"since": "8.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Void AppendDash(System.Double dash)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Add a dash to the pattern.",
"since": "8.0",
"parameters": [
{
"name": "dash",
"type": "System.Double",
"summary": "Length to append, < 0 for a gap."
}
]
},
{
"signature": "System.Double DashAt(System.Int32 dashIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the dash length at the specified index.",
"since": "8.0",
"parameters": [
{
"name": "dashIndex",
"type": "System.Int32",
"summary": "Index of the dash to get."
}
],
"returns": "The length of the dash. or gap if negative."
},
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Actively releases the unmanaged object.",
"since": "8.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "Releases the unmanaged object."
},
{
"signature": "System.Void SetDashes(IEnumerable dashes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets a new dash array.",
"since": "8.0",
"parameters": [
{
"name": "dashes",
"type": "IEnumerable",
"summary": "The dash enumeration."
}
]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "HatchObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "Hatch HatchGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "HatchPattern",
"dataType": "class",
"baseclass": "Rhino.DocObjects.ModelComponent",
"constructors": [
{
"signature": "HatchPattern()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "HatchPattern(HatchPattern other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.15"
}
],
"properties": [
{
"signature": "bool AlwaysModelDistances",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Hatchpattern patterns are typically interpreted as distances on the printed output when printing. In this case AlwaysModelDistances is False (default). When set to true, the hatch pattern will be interpreted as being in world distances.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns ModelComponentType.HatchPattern .",
"since": "6.0",
"property": ["get"]
},
{
"signature": "string Description",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets and sets a short description of the pattern.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "HatchPatternFillType FillType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the pattern's fill type.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int HatchLineCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the number of HatchLines in the pattern.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "IEnumerable HatchLines",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets all the hatch lines.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "int Index",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Index in the hatch pattern table for this pattern. -1 if not in the table.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool InUse",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if the hatch pattern is in use by a Rhino object, a layer, an instance definition, or a section style.",
"since": "8.15",
"property": ["get"]
},
{
"signature": "bool IsDeleted",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Deleted hatch patterns are kept in the runtime hatch pattern table so that undo will work with hatch patterns. Call IsDeleted to determine to determine if a hatch pattern is deleted.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsReference",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Rhino allows multiple files to be viewed simultaneously. Hatch patterns in the document are \"normal\" or \"reference\". Reference hatch patterns are not saved.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "UnitSystem PatternUnitSystem",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Hatchpattern patterns are typically defined as distances on the printed output when printing. In this case PatternUnitSystem is UnitSystem.None (default). When set to any other unit system, the hatch pattern will be scaled acordingly.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int UserStringCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the amount of user strings.",
"since": "8.9",
"property": ["get"]
}
],
"methods": [
{
"signature": "HatchPattern[] GetDefaultHatchPatterns()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets Rhino default hatch patterns. These patterns are not in the document hatch pattern table.",
"since": "9.0",
"returns": "An array of hatch patterns."
},
{
"signature": "HatchPattern[] ReadFromFile(System.String filename, System.Boolean quiet)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Reads hatch pattern definitions from a file.",
"since": "5.0",
"parameters": [
{
"name": "filename",
"type": "System.String",
"summary": "Name of an existing file. If filename is None or empty, default hatch pattern filename is used."
},
{
"name": "quiet",
"type": "System.Boolean",
"summary": "Ignored."
}
],
"returns": "An array of hatch patterns. This can be null, but not empty."
},
{
"signature": "System.Boolean WriteToFile(System.String filename, HatchPattern hatchPattern)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Writes a hatch pattern defintion to a file.",
"since": "8.15",
"remarks": "Output file is in AutoCAD .PAT format.",
"parameters": [
{
"name": "filename",
"type": "System.String",
"summary": "Name of file to create. If file exists, it will be overwritten."
},
{
"name": "hatchPattern",
"type": "HatchPattern",
"summary": "The hatch pattern to write."
}
],
"returns": "True if successful, False otherwise."
},
{
"signature": "System.Boolean WriteToFile(System.String filename, IEnumerable hatchPatterns)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Writes one or more hatch pattern defintions to a file.",
"since": "8.15",
"remarks": "Output file is in AutoCAD .PAT format.",
"parameters": [
{
"name": "filename",
"type": "System.String",
"summary": "Name of file to create. If file exists, it will be overwritten."
},
{
"name": "hatchPatterns",
"type": "IEnumerable",
"summary": "The enumeration of hatch patterns to write."
}
],
"returns": "True if successful, False otherwise."
},
{
"signature": "System.Int32 AddHatchLine(HatchLine hatchLine)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Add a HatchLine to the pattern.",
"since": "8.0",
"parameters": [
{
"name": "hatchLine",
"type": "HatchLine",
"summary": "The hatch line to add."
}
],
"returns": "The index of newly added hatch line, or -1 on failure."
},
{
"signature": "Rhino.Geometry.Line[] CreatePreviewGeometry(System.Int32 width, System.Int32 height, System.Double angle)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Creates preview line segments of the hatch pattern.",
"since": "6.8",
"parameters": [
{
"name": "width",
"type": "System.Int32",
"summary": "The width of the preview."
},
{
"name": "height",
"type": "System.Int32",
"summary": "The height of the preview."
},
{
"name": "angle",
"type": "System.Double",
"summary": "The rotation angle of the pattern display in radians."
}
],
"returns": "The preview line segments if successful, an empty array on failure."
},
{
"signature": "System.Void DeleteAllUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.9"
},
{
"signature": "System.Boolean DeleteUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.9"
},
{
"signature": "System.String GetUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets user string from this geometry.",
"since": "8.9",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve the string."
}
],
"returns": "string associated with the key if successful. None if no key was found."
},
{
"signature": "System.Collections.Specialized.NameValueCollection GetUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a copy of all (user key string, user value string) pairs attached to this geometry.",
"since": "8.9",
"returns": "A new collection."
},
{
"signature": "HatchLine HatchLineAt(System.Int32 hatchLineIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a HatchLine at an index.",
"since": "8.0",
"parameters": [
{
"name": "hatchLineIndex",
"type": "System.Int32",
"summary": "The index of the hatch line."
}
],
"returns": "The hatch line, or None on failure."
},
{
"signature": "System.Void OnSwitchToNonConst()",
"modifiers": ["protected", "override"],
"protected": true,
"virtual": false
},
{
"signature": "System.Void RemoveAllHatchLines()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove all of the hatch line from the pattern.",
"since": "8.0"
},
{
"signature": "System.Boolean RemoveHatchLine(System.Int32 hatchLineIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove a hatch line from the pattern.",
"since": "8.0",
"parameters": [
{
"name": "hatchLineIndex",
"type": "System.Int32",
"summary": "The index of the hatch line to remove."
}
],
"returns": "True if successful, False if index is out of range."
},
{
"signature": "System.Int32 SetHatchLines(IEnumerable hatchLines)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set all of the hatch lines at once. Existing hatch lines are deleted.",
"since": "8.0",
"parameters": [
{
"name": "hatchLines",
"type": "IEnumerable",
"summary": "An enumeration of hatch lines."
}
],
"returns": "The number of hatch lines added."
},
{
"signature": "System.Boolean SetUserString(System.String key, System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Attach a user string (key,value combination) to this geometry.",
"since": "8.9",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve this string."
},
{
"name": "value",
"type": "System.String",
"summary": "string associated with key."
}
],
"returns": "True on success."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "HatchPattern.Defaults",
"dataType": "class",
"constructors": [
{
"signature": "HatchPattern.Defaults()",
"summary": "Initializes a new instance of the HatchPattern.Defaults class"
}
],
"properties": [
{
"signature": "HatchPattern Dash",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "HatchPattern Grid",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "HatchPattern Grid60",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "HatchPattern Hatch1",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "HatchPattern Hatch2",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "HatchPattern Hatch3",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "HatchPattern Plus",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "HatchPattern Solid",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "HatchPattern Squares",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "HatchPatternFillType",
"dataType": "enum",
"since": "5.0",
"values": [
{
"signature": "Solid = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Lines = 1",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Gradient = 2",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "HistoryRecord",
"dataType": "class",
"summary": "Provides a single bundling of information to be passed to Rhino when setting up history for an object.",
"remarks": "To use this object, just pass it to a RhinoDoc.Add() method along with the needed geometry. Do not reuse this class for more than one history addition.",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "HistoryRecord(Command command, int version)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
],
"properties": [
{
"signature": "bool CopyOnReplaceObject",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When an object is replaced and the old object has a history record with this field set, the history record is copied and attached to the new object. That allows a descendant object to continue the history linkage after it is edited.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "IntPtr Handle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Wrapped native C++ pointer to CRhinoHistory instance",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Actively reclaims unmanaged resources that this instance uses.",
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "For derived class implementers. \nThis method is called with argument True when class user calls Dispose(), while with argument False when the Garbage Collector invokes the finalizer, or Finalize() method. \nYou must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true. \nAlso, you must call the base virtual method within your overriding method.",
"parameters": [
{
"name": "disposing",
"type": "System.Boolean",
"summary": "True if the call comes from the Dispose() method; False if it comes from the Garbage Collector finalizer."
}
]
},
{
"signature": "System.Boolean SetBool(System.Int32 id, System.Boolean value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetBools(System.Int32 id, IEnumerable values)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetBrep(System.Int32 id, Geometry.Brep value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetColor(System.Int32 id, System.Drawing.Color value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetColors(System.Int32 id, IEnumerable values)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetCurve(System.Int32 id, Geometry.Curve value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetDouble(System.Int32 id, System.Double value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetDoubles(System.Int32 id, IEnumerable values)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetGuid(System.Int32 id, System.Guid value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetGuids(System.Int32 id, IEnumerable values)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetHistoryVersion(System.Int32 historyVersion)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies a non-zero integer that identifies the version of this history record. The virtual ReplayHistory() functions can check this version to avoid replaying history using information created by earlier versions of the command.",
"since": "6.0",
"parameters": [
{
"name": "historyVersion",
"type": "System.Int32",
"summary": "Any non-zero integer. It is strongly suggested that something like YYYYMMDD be used."
}
],
"returns": "True if successful."
},
{
"signature": "System.Boolean SetInt(System.Int32 id, System.Int32 value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetInts(System.Int32 id, IEnumerable values)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetMesh(System.Int32 id, Geometry.Mesh value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetObjRef(System.Int32 id, ObjRef value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetPoint3d(System.Int32 id, Rhino.Geometry.Point3d value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetPoint3dOnObject(System.Int32 id, ObjRef objref, Rhino.Geometry.Point3d value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetPoint3ds(System.Int32 id, IEnumerable values)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetString(System.Int32 id, System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetStrings(System.Int32 id, IEnumerable values)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetSurface(System.Int32 id, Geometry.Surface value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetTransorm(System.Int32 id, Rhino.Geometry.Transform value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetVector3d(System.Int32 id, Rhino.Geometry.Vector3d value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetVector3ds(System.Int32 id, IEnumerable values)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "InstanceDefinition",
"dataType": "class",
"summary": "This is the same as InstanceDefinitionGeometry , but in a Rhino document.",
"baseclass": "Rhino.Geometry.InstanceDefinitionGeometry",
"properties": [
{
"signature": "InstanceDefinitionArchiveFileStatus ArchiveFileStatus",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the archive file status of a linked instance definition.",
"since": "5.2",
"property": ["get"]
},
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns ModelComponentType.InstanceDefinition .",
"since": "6.0",
"property": ["get"]
},
{
"signature": "int Index",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Index of this instance definition in the index definition table.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsDeleted",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns True if this instance definition is deleted. Deleted object are not saved to a file archive.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsReference",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "An object from a work session reference model is reference a reference object and cannot be modified. An object is a reference object if, and only if, it is on a reference layer.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsTenuous",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True if this instance definition is from a linked file. It will be saved only if it is referenced by an instance reference object that is in the active geometry list and is being saved. Note that there can be multiple linked instance definitions with references to tenuous instance definitions.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "InstanceDefinitionLayerStyle LayerStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Specifies how model components (layers, materials, dimension styles, etc.) from linked instance definition files appear in the active model.",
"since": "7.8",
"property": ["get", "set"]
},
{
"signature": "int ObjectCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Number of objects this definition uses. This counts the objects that are used to define the geometry. This does NOT count the number of references to this instance definition.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool SkipNestedLinkedDefinitions",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "This property applies when an instance definition is linked. If true, when reading the file that defines the content of the linked instance definition, skip any linked instance definitions found in that file. If false, when reading the file that defines the content of the linked instance definition, recursively load linked instance definitions found in that file.",
"since": "7.8",
"property": ["get", "set"]
},
{
"signature": "string SourceArchive",
"modifiers": ["public", "new"],
"protected": false,
"virtual": false,
"summary": "Gets the full file path for linked instance definitions.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "UnitSystem UnitSystem",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the unit system of the instance definition. If the instance definition was imported from another 3dm file, the unit system may differ from that of the document.",
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "InstanceDefinitionUpdateType UpdateType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Drawing.Bitmap CreatePreviewBitmap(Display.DefinedViewportProjection definedViewportProjection, DisplayMode displayMode, System.Drawing.Size bitmapSize, System.Boolean applyDpiScaling)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Creates a preview bitmap of the instance definition.",
"since": "6.0",
"parameters": [
{
"name": "definedViewportProjection",
"type": "Display.DefinedViewportProjection",
"summary": "The view projection."
},
{
"name": "displayMode",
"type": "DisplayMode",
"summary": "The display mode."
},
{
"name": "bitmapSize",
"type": "System.Drawing.Size",
"summary": "The bitmap size in pixels."
},
{
"name": "applyDpiScaling",
"type": "System.Boolean",
"summary": "Specify True to apply DPI scaling (Windows-only)."
}
],
"returns": "The preview bitmap if successful, None otherwise."
},
{
"signature": "System.Drawing.Bitmap CreatePreviewBitmap(Display.DefinedViewportProjection definedViewportProjection, DisplayMode displayMode, System.Drawing.Size bitmapSize)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Creates a preview bitmap of the instance definition.",
"since": "5.0",
"parameters": [
{
"name": "definedViewportProjection",
"type": "Display.DefinedViewportProjection",
"summary": "The view projection."
},
{
"name": "displayMode",
"type": "DisplayMode",
"summary": "The display mode."
},
{
"name": "bitmapSize",
"type": "System.Drawing.Size",
"summary": "The bitmap size in pixels."
}
],
"returns": "The preview bitmap if successful, None otherwise."
},
{
"signature": "System.Drawing.Bitmap CreatePreviewBitmap(Display.DefinedViewportProjection definedViewportProjection, System.Drawing.Size bitmapSize, System.Boolean applyDpiScaling)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Creates a wireframe preview bitmap of the instance definition.",
"since": "6.0",
"parameters": [
{
"name": "definedViewportProjection",
"type": "Display.DefinedViewportProjection",
"summary": "The view projection."
},
{
"name": "bitmapSize",
"type": "System.Drawing.Size",
"summary": "The bitmap size in pixels."
},
{
"name": "applyDpiScaling",
"type": "System.Boolean",
"summary": "Specify True to apply DPI scaling (Windows-only)."
}
],
"returns": "The preview bitmap if successful, None otherwise."
},
{
"signature": "System.Drawing.Bitmap CreatePreviewBitmap(Display.DefinedViewportProjection definedViewportProjection, System.Drawing.Size bitmapSize)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Creates a wireframe preview bitmap of the instance definition.",
"since": "5.0",
"parameters": [
{
"name": "definedViewportProjection",
"type": "Display.DefinedViewportProjection",
"summary": "The view projection."
},
{
"name": "bitmapSize",
"type": "System.Drawing.Size",
"summary": "The bitmap size in pixels."
}
],
"returns": "The preview bitmap if successful, None otherwise."
},
{
"signature": "System.Drawing.Bitmap CreatePreviewBitmap(System.Guid displayModeId, Display.DefinedViewportProjection viewportProjection, Display.IsometricCamera isometricCamera, System.Boolean drawDecorations, System.Drawing.Size bitmapSize, System.Boolean applyDpiScaling)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Creates a preview bitmap of the instance definition.",
"since": "8.10",
"parameters": [
{
"name": "displayModeId",
"type": "System.Guid",
"summary": "The id of the display mode to draw with."
},
{
"name": "viewportProjection",
"type": "Display.DefinedViewportProjection",
"summary": "The view projection."
},
{
"name": "isometricCamera",
"type": "Display.IsometricCamera",
"summary": "The isometric camera angle."
},
{
"name": "drawDecorations",
"type": "System.Boolean",
"summary": "Specify True to draw viewport decorations, such as grid and axes."
},
{
"name": "bitmapSize",
"type": "System.Drawing.Size",
"summary": "The bitmap size in pixels."
},
{
"name": "applyDpiScaling",
"type": "System.Boolean",
"summary": "Specify True to apply DPI scaling (Windows-only)."
}
],
"returns": "The preview bitmap if successful, None otherwise."
},
{
"signature": "System.Drawing.Bitmap CreatePreviewBitmap(System.Guid definitionObjectId, Display.DefinedViewportProjection viewportProjection, DisplayMode displayMode, System.Drawing.Size bitmapSize, System.Boolean applyDpiScaling)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Creates a preview bitmap of the instance definition.",
"since": "6.21",
"parameters": [
{
"name": "definitionObjectId",
"type": "System.Guid",
"summary": "Id of one of this definition's objects to draw selected."
},
{
"name": "viewportProjection",
"type": "Display.DefinedViewportProjection",
"summary": "The view projection."
},
{
"name": "displayMode",
"type": "DisplayMode",
"summary": "The display mode."
},
{
"name": "bitmapSize",
"type": "System.Drawing.Size",
"summary": "The bitmap size in pixels."
},
{
"name": "applyDpiScaling",
"type": "System.Boolean",
"summary": "Specify True to apply DPI scaling (Windows-only)."
}
],
"returns": "The preview bitmap if successful, None otherwise."
},
{
"signature": "System.Boolean Equals(System.Object obj)",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Equality is checked against InstanceDefinition.Id",
"returns": "True if obj.Id equals Id"
},
{
"signature": "InstanceDefinition[] GetContainers()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a list of all the InstanceDefinitions that contain a reference this InstanceDefinition.",
"since": "5.0",
"returns": "An array of instance definitions. The returned array can be empty, but not null."
},
{
"signature": "System.Int32 GetHashCode()",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Use Id.GetHashCode()"
},
{
"signature": "RhinoObject[] GetObjects()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets an array with the objects that belong to this instance definition.",
"since": "5.0",
"returns": "An array of Rhino objects. The returned array can be empty, but not null."
},
{
"signature": "InstanceObject[] GetReferences(System.Int32 wheretoLook)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a list of the CRhinoInstanceObjects (inserts) that contains a reference this instance definition.",
"since": "5.0",
"parameters": [
{
"name": "wheretoLook",
"type": "System.Int32",
"summary": "0 = get top level references in active document. \n1 = get top level and nested references in active document. \n2 = check for references from other instance definitions."
}
],
"returns": "An array of instance objects. The returned array can be empty, but not null."
},
{
"signature": "System.Boolean InUse(System.Int32 wheretoLook)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines whether the instance definition is referenced.",
"since": "5.0",
"parameters": [
{
"name": "wheretoLook",
"type": "System.Int32",
"summary": "0 = check for top level references in active document. \n1 = check for top level and nested references in active document. \n2 = check for references in other instance definitions."
}
],
"returns": "True if the instance definition is used; otherwise false."
},
{
"signature": "RhinoObject Object(System.Int32 index)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "returns an object used as part of this definition.",
"since": "5.0",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "0 <= index < ObjectCount."
}
],
"returns": "Returns an object that is used to define the geometry. Does NOT return an object that references this definition.count the number of references to this instance."
},
{
"signature": "System.Int32 UseCount()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the number of references of this instance definition in the model. Both top-level references and nested instances are included in the count.",
"since": "7.4",
"returns": "The number of references of this instance definition in the model."
},
{
"signature": "System.Int32 UseCount(out System.Int32 topLevelReferenceCount, out System.Int32 nestedReferenceCount)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the number of references of this instance definition in the model. Both top-level references and nested instances are included in the count.",
"since": "7.4",
"parameters": [
{
"name": "topLevelReferenceCount",
"type": "System.Int32",
"summary": "The number of top-level references."
},
{
"name": "nestedReferenceCount",
"type": "System.Int32",
"summary": "The number of nested instances."
}
],
"returns": "The number of references of this instance definition in the model."
},
{
"signature": "System.Int32 UsesDefinition(System.Int32 otherIdefIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines if this instance definition contains a reference to another instance definition.",
"since": "5.0",
"parameters": [
{
"name": "otherIdefIndex",
"type": "System.Int32",
"summary": "index of another instance definition."
}
],
"returns": "0 no 1 other_idef_index is the index of this instance definition >1 This InstanceDefinition uses the instance definition and the returned value is the nesting depth."
},
{
"signature": "System.Boolean UsesLayer(System.Int32 layerIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if some object in the instance definition is on the layer with the specified layer index.",
"since": "8.7",
"parameters": [
{
"name": "layerIndex",
"type": "System.Int32",
"summary": "The index of layer to search for."
}
],
"returns": "True if there is an object in the instance definition that is on the layer."
},
{
"signature": "System.Boolean UsesLinetype(System.Int32 linetypeIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if some object in the instance definition references the linetype with the specified linetype index.",
"since": "8.7",
"parameters": [
{
"name": "linetypeIndex",
"type": "System.Int32",
"summary": "The index of linetype to search for."
}
],
"returns": "True if there is an object in the instance definition that references that linetype."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "InstanceDefinitionArchiveFileStatus",
"dataType": "enum",
"summary": "The archive file of a linked instance definition can have the following possible states. Use InstanceObject.ArchiveFileStatus to query a instance definition's archive file status.",
"since": "5.2",
"values": [
{
"signature": "NotALinkedInstanceDefinition = -3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The instance definition is not a linked instance definition."
},
{
"signature": "LinkedFileNotReadable = -2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The instance definition's archive file is not readable."
},
{
"signature": "LinkedFileNotFound = -1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The instance definition's archive file cannot be found."
},
{
"signature": "LinkedFileIsUpToDate = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The instance definition's archive file is up-to-date."
},
{
"signature": "LinkedFileIsNewer = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The instance definition's archive file is newer."
},
{
"signature": "LinkedFileIsOlder = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The instance definition's archive file is older."
},
{
"signature": "LinkedFileIsDifferent = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The instance definition's archive file is different."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "InstanceDefinitionLayerStyle",
"dataType": "enum",
"summary": "InstanceDefinition.LayerStyle specifies how model components (layers, materials, dimension styles, etc.) from linked instance definition files appear in the active model.",
"since": "5.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "This is the only valid layer style when the instance definition type is InstanceDefinitionUpdateType.Static or InstanceDefinitionUpdateType.LinkedAndEmbedded. This style is not valid when the instance definition type is InstanceDefinitionUpdateType.Linked."
},
{
"signature": "Active = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Model components (layers, materials, dimension styles, etc.) from linked instance definition files are embedded as ordinary components in the active model. This layer style may be used when the instance definition type is InstanceDefinitionUpdateType.Linked."
},
{
"signature": "Reference = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Layers from the linked instance definition are reference components in the model. This is the default layer style when the instance definition type is InstanceDefinitionUpdateType.Linked. This layer style may be used when the instance definition type is InstanceDefinitionUpdateType.Linked."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "InstanceDefinitionUpdateType",
"dataType": "enum",
"summary": "The possible relationships between the instance definition geometry and the archive containing the original definition.",
"since": "5.0",
"values": [
{
"signature": "Static = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The Rhino user interface uses the term \"Embedded\" for Static update types. This instance definition is never updated. If m_source_archive is set, it records the origin of the instance definition geometry, but m_source_archive is never used to update the instance definition."
},
{
"signature": " Embedded = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "This instance definition geometry was imported from another archive and is embedded. If the source archive changes, the user is asked if they want to update the instance definition.",
"obsolete": "Always use Static"
},
{
"signature": "LinkedAndEmbedded = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "This instance definition geometry was imported from another archive and is embedded. If the source archive changes, the instance definition is automatically updated. If the soruce archive is not available, the instance definition is still valid."
},
{
"signature": "Linked = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "This instance definition geometry was imported from another archive and is not embedded. If the source archive changes, the instance definition is automatically updated. If the source archive is not available, the instance definition is not valid."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "InstanceObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "Point3d InsertionPoint",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Base point coordinates of a block.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "InstanceDefinition InstanceDefinition",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "instance definition that this object uses.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Transform InstanceXform",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "transformation applied to an instance definition for this object.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Void Explode(System.Boolean explodeNestedInstances, out RhinoObject[] pieces, out ObjectAttributes[] pieceAttributes, out Transform[] pieceTransforms)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Explodes the instance reference into pieces.",
"since": "5.0",
"parameters": [
{
"name": "explodeNestedInstances",
"type": "System.Boolean",
"summary": "If true, then nested instance references are recursively exploded into pieces until actual geometry is found. If false, an InstanceObject is added to the pieces out parameter when this InstanceObject has nested references."
},
{
"name": "pieces",
"type": "RhinoObject[]",
"summary": "An array of Rhino objects will be assigned to this out parameter during this call."
},
{
"name": "pieceAttributes",
"type": "ObjectAttributes[]",
"summary": "An array of object attributes will be assigned to this out parameter during this call."
},
{
"name": "pieceTransforms",
"type": "Transform[]",
"summary": "An array of the previously applied transform matrices will be assigned to this out parameter during this call."
}
]
},
{
"signature": "System.Void Explode(System.Boolean skipHiddenPieces, System.Guid viewportId, System.Boolean explodeNestedInstances, out RhinoObject[] pieces, out ObjectAttributes[] pieceAttributes, out Transform[] pieceTransforms)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Explodes the instance reference into pieces.",
"since": "8.9",
"parameters": [
{
"name": "skipHiddenPieces",
"type": "System.Boolean",
"summary": "If true, pieces that are not visible will not be appended to the pieces out parameter."
},
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If skipHiddenPieces is false, then viewportId is ignored. If bSkipHiddenPieces is True and viewportId is not Guid.Empty, then layer and object per viewport visibility settings are used. If bSkipHiddenPieces is True and viewport_id is Guid.Empty, then layer and object global visibility settings are used."
},
{
"name": "explodeNestedInstances",
"type": "System.Boolean",
"summary": "If true, then nested instance references are recursively exploded into pieces until actual geometry is found. If false, an InstanceObject is added to the pieces out parameter when this InstanceObject has nested references."
},
{
"name": "pieces",
"type": "RhinoObject[]",
"summary": "An array of Rhino objects will be assigned to this out parameter during this call."
},
{
"name": "pieceAttributes",
"type": "ObjectAttributes[]",
"summary": "An array of object attributes will be assigned to this out parameter during this call."
},
{
"name": "pieceTransforms",
"type": "Transform[]",
"summary": "An array of the previously applied transform matrices will be assigned to this out parameter during this call."
}
]
},
{
"signature": "RhinoObject SubObjectFromComponentIndex(ComponentIndex ci)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get a RhinoObject in this block",
"since": "8.0"
},
{
"signature": "System.Boolean UsesDefinition(System.Int32 definitionIndex, out System.Int32 nestingLevel)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determine if this reference uses an instance definition",
"since": "5.2",
"parameters": [
{
"name": "definitionIndex",
"type": "System.Int32",
"summary": ""
},
{
"name": "nestingLevel",
"type": "System.Int32",
"summary": "If the instance definition is used, this is the definition's nesting depth"
}
],
"returns": "True or False depending on if the definition is used"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ItemColorSource",
"dataType": "enum",
"summary": "Color source for a per-item color override on object attributes (for example, hatch boundary color or hatch pattern color). Selects whether the color is read from the layer, from the object's main attribute color, inherited from the parent, or read from a custom override color stored on the attribute itself.",
"since": "9.0",
"values": [
{
"signature": "ColorFromLayer = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Use color assigned to layer."
},
{
"signature": "ColorFromObject = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Use the object's main attribute color."
},
{
"signature": "ColorFromParent = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "For objects with parents (like objects in instance references), use the parent's color. If no parent, treat as ColorFromLayer."
},
{
"signature": "ColorCustom = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Use the per-item custom override color stored on the attribute (for example, the color set by the matching color property such as HatchBoundaryColor or HatchPatternColor)."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Layer",
"dataType": "class",
"baseclass": "Rhino.DocObjects.ModelComponent",
"interfaces": ["IEquatable"],
"constructors": [
{
"signature": "Layer()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
],
"properties": [
{
"signature": "string PathSeparator",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The string \"::\" (colon,colon) is used to separate parent and child layer names.",
"since": "6.0",
"obsolete": "Use ModelComponent.NamePathSeparator",
"property": ["get"]
},
{
"signature": "Color Color",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the display color for this layer.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ComponentStatus ComponentStatus",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the status of the layer.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns ModelComponentType.Layer .",
"since": "6.0",
"property": ["get"]
},
{
"signature": "string Description",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets and sets a short description of the layer.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "string FullPath",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the full path to this layer. The full path includes nesting information.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid Id",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the ID of this layer object. You typically do not need to assign a custom ID.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int IgesLevel",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the IGES level for this layer.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool IsCurrent",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if the layer is the current layer.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "bool IsDeleted",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets a value indicating whether this layer has been deleted and is currently in the Undo buffer.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsExpanded",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating whether this layer is expanded in the Rhino Layer dialog.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool IsLocked",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets a value indicating the locked state of this layer.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool IsReference",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets a value indicting whether this layer is a referenced layer. Referenced layers are part of referenced documents.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsReferenceParentLayer",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if the layer is a parent layer of the layer tree from a linked instance definition or the layer tree from a worksession reference model.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "bool IsVisible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the global visibility of this layer.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool IsVisibleInUserInterface",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Return True if the layer is visible in user interfaces that display layers. Returns False if the layer not visible in user interfaces. This is a runtime property that does not persist in .3dm files. This property is also used by the Layers panel to filter layers.",
"since": "8.9",
"property": ["get", "set"]
},
{
"signature": "int LayerIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the index of this layer.",
"since": "5.0",
"obsolete": "Use the Index property.",
"property": ["get", "set"]
},
{
"signature": "int LinetypeIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the line-type index for this layer.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ModelIsVisible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the model visiblity of this layer.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool ModelPersistentVisibility",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the model persistent visibility of this layer. The persistent viability setting is used for layers whose visibility can be changed by a parent layer. In this case, when a parent layer is turned off, then child layers are also turned off. The persistent visibility setting determines what happens when the parent is turned on again.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "string Name",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the name of this layer.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Guid ParentLayerId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the ID of the parent layer. Layers can be organized in a hierarchical structure, in which case this returns the parent layer ID. If the layer has no parent, Guid.Empty will be returned.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool PersistentVisibility",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the global persistent visibility setting for this layer.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool PerViewportIsVisibleInNewDetails",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets and sets the initial per viewport visibility of this layer in newly created detail views.",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color PlotColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the plot color for this layer.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double PlotWeight",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the weight of the plotting pen in millimeters. A weight of 0.0 indicates the \"default\" pen weight should be used. A weight of -1.0 indicates the layer should not be printed.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "RenderMaterial RenderMaterial",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Render.RenderMaterial for objects on this layer that have MaterialSource() == MaterialFromLayer. A None result indicates that no Render.RenderMaterial has been assigned and the material created by the default Material constructor or the RenderMaterialIndex should be used.",
"since": "5.7",
"property": ["get", "set"]
},
{
"signature": "int RenderMaterialIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the index of render material for objects on this layer that have MaterialSource() == MaterialFromLayer. A material index of -1 indicates no material has been assigned and the material created by the default Material constructor should be used.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int SectionStyleIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the section style index for this layer.",
"property": ["get", "set"]
},
{
"signature": "int SortIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Runtime index used to sort layers in layer dialog.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "int UserStringCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the amount of user strings.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "Layer GetDefaultLayerProperties()",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Constructs a layer with the current default properties. The default layer properties are: \ncolor = Rhino.ApplicationSettings.AppearanceSettings.DefaultLayerColor \nline style = Rhino.ApplicationSettings.AppearanceSettings.DefaultLayerLineStyle \nmaterial index = -1 \nIGES level = -1 \nmode = NormalLayer \nname = empty \nlayer index = 0 (ignored by AddLayer)",
"since": "5.0",
"returns": "A new layer instance."
},
{
"signature": "System.String GetLeafName(Layer layer)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get a layer name's \"leaf\" level name",
"since": "6.0",
"returns": "leaf name or String.Empty if fullPath does not contain a leaf"
},
{
"signature": "System.String GetLeafName(System.String fullPath)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get a layer name's \"leaf\" level name",
"since": "6.0",
"returns": "leaf name or String.Empty if fullPath does not contain a leaf"
},
{
"signature": "System.String GetParentName(Layer layer)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get a layer's \"parent\" path name",
"since": "6.0",
"returns": "parent name or String.Empty"
},
{
"signature": "System.String GetParentName(System.String fullPath)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get a layer's \"parent\" path name",
"since": "6.0",
"returns": "parent name or String.Empty"
},
{
"signature": "System.Boolean IsValidName(System.String name)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Determines if a given string is valid for a layer name.",
"since": "5.0",
"deprecated": "8.0",
"obsolete": "Use ModelComponent.IsValidComponentName",
"parameters": [
{
"name": "name",
"type": "System.String",
"summary": "A name to be validated."
}
],
"returns": "True if the name is valid for a layer name; otherwise, false."
},
{
"signature": "System.Boolean CommitChanges()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"deprecated": "6.0",
"obsolete": "No longer needed. Layer changes in the document are now immediate"
},
{
"signature": "System.Void CopyAttributesFrom(Layer otherLayer)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Copy typical attributes from another layer",
"since": "6.0"
},
{
"signature": "System.Void Default()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets layer to default settings.",
"since": "5.0"
},
{
"signature": "System.Void DeleteAllUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.9"
},
{
"signature": "System.Void DeleteModelVisible()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove any model visibility setting so the layer's global setting will be used for all viewports.",
"since": "8.0"
},
{
"signature": "System.Void DeletePerViewportColor(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove any per viewport layer color setting so the layer's overall setting will be used for all viewports.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting for this viewport will be deleted. If Guid.Empty, the all per viewport layer color settings will be removed."
}
]
},
{
"signature": "System.Void DeletePerViewportPlotColor(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove any per viewport layer plot color setting so the layer's overall setting will be used for all viewports.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting for this viewport will be deleted. If Guid.Empty, the all per viewport layer color settings will be removed."
}
]
},
{
"signature": "System.Void DeletePerViewportPlotWeight(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove any per viewport layer plot weight setting so the layer's overall setting will be used for all viewports.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting for this viewport will be deleted. If Guid.Empty, the all per viewport layer color settings will be removed."
}
]
},
{
"signature": "System.Void DeletePerViewportSettings(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Deletes per viewport layer settings.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the settings for that viewport are deleted. If Guid.Empty, then all per viewport settings are deleted."
}
]
},
{
"signature": "System.Void DeletePerViewportVisible(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove any per viewport visibility setting so the layer's overall setting will be used for all viewports.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting for this viewport will be deleted. If Guid.Empty, the all per viewport visibility settings will be removed."
}
]
},
{
"signature": "System.Void DeletePlotColor()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes the plot color for layer. The layer's color will be used for the plot color.",
"since": "8.26"
},
{
"signature": "System.Boolean DeleteUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.9"
},
{
"signature": "System.Boolean Equals(Layer other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Boolean Equals(System.Object obj)",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false
},
{
"signature": "Layer[] GetChildren()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets immediate children of this layer. Note that child layers may have their own children.",
"since": "5.0",
"returns": "Array of child layers, sorted by layer index, or None if this layer does not have any children."
},
{
"signature": "Layer[] GetChildren(System.Boolean allChildren)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the children of this layer.",
"since": "8.0",
"parameters": [
{
"name": "allChildren",
"type": "System.Boolean",
"summary": "If false, the immediate children are returned. If true, immediate children, their children, and so on, are returned."
}
],
"returns": "Array of child layers, sorted by layer index, or None if this layer does not have any children."
},
{
"signature": "SectionStyle GetCustomSectionStyle()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get an optional custom section style associated with these attributes.",
"since": "8.0"
},
{
"signature": "System.Int32 GetHashCode()",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false
},
{
"signature": "System.Boolean GetPersistentLocking()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The persistent locking setting is used for layers that can be locked by a \"parent\" object. A common case is when a layer is a child layer (Layer.ParentI is not nil). In this case, when a parent layer is locked, then child layers are also locked. The persistent locking setting determines what happens when the parent is unlocked again.",
"since": "5.5"
},
{
"signature": "System.Boolean GetPersistentVisibility()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The global persistent visibility setting is used for layers whose visibility can be changed by a \"parent\" object. A common case is when a layer is a child layer (ParentId is not nil). In this case, when a parent layer is turned off, then child layers are also turned off. The persistent visibility setting determines what happens when the parent is turned on again.",
"since": "5.5",
"remarks": "Returns True if this layer's visibility is controlled by a parent object and the parent is turned on (after being off), then this layer will also be turned on. Returns False if this layer's visibility is controlled by a parent object and the parent layer is turned on (after being off), then this layer will continue to be off. When the persistent viability is not explicitly set, this property returns the current value of IsVisible"
},
{
"signature": "System.String GetUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets user string from this geometry.",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve the string."
}
],
"returns": "string associated with the key if successful. None if no key was found."
},
{
"signature": "System.Collections.Specialized.NameValueCollection GetUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a copy of all (user key string, user value string) pairs attached to this geometry.",
"since": "5.0",
"returns": "A new collection."
},
{
"signature": "System.Boolean HasPerViewportSettings(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Verifies that a layer has per viewport settings.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then checks for settings for that specific viewport. If Guid.Empty, then checks for any viewport settings."
}
],
"returns": "True if the layer has per viewport settings, False otherwise."
},
{
"signature": "System.Boolean HasSelectedObjects(System.Boolean checkSubObjects)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if the layer has one or more selected Rhino objects.",
"since": "8.0",
"parameters": [
{
"name": "checkSubObjects",
"type": "System.Boolean",
"summary": "If true, the search will include objects that have some subset of the object selected, like some edges of a Brep. If false, objects where the entire object is not selected are ignored."
}
],
"returns": "True if the layer has selected Rhino objects, False otherwise."
},
{
"signature": "System.Boolean IsChildOf(Layer otherLayer)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean IsChildOf(System.Guid otherlayerId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Boolean IsChildOf(System.Int32 layerIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean IsParentOf(Layer otherLayer)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean IsParentOf(System.Guid otherLayer)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Boolean IsParentOf(System.Int32 layerIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Layer ParentLayer(System.Boolean rootLevelParent)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns parent of a layer.",
"since": "8.0",
"parameters": [
{
"name": "rootLevelParent",
"type": "System.Boolean",
"summary": "If true, the root level parent is returned. The root level parent never has a parent. If false, the immediate parent is returned. The immediate parent may have a parent."
}
],
"returns": "The parent layer, or None if the layer does not have a parent."
},
{
"signature": "System.Drawing.Color PerViewportColor(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the display color for this layer.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting applies only to the viewport with the specified id."
}
],
"returns": "The display color."
},
{
"signature": "System.Boolean PerViewportIsVisible(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the per viewport visibility of this layer.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the visibility setting for that viewport is returned. If Guid.Empty, the IsVisible property is returned."
}
],
"returns": "Returns True if objects on layer are visible."
},
{
"signature": "System.Boolean PerViewportPersistentVisibility(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the per layer persistent visibility. The persistent viability setting is used for layers whose visibility can be changed by a parent layer. In this case, when a parent layer is turned off, then child layers are also turned off. The persistent visibility setting determines what happens when the parent is turned on again.",
"since": "6.0",
"returns": "Return True if this layer's visibility in the specified viewport is controlled by a parent object and the parent is turned on (after being off), then this layer will also be turned on in the specified viewport. Returns False if this layer's visibility in the specified viewport is controlled by a parent object and the parent layer is turned on(after being off), then this layer will continue to be off in the specified viewport."
},
{
"signature": "System.Drawing.Color PerViewportPlotColor(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the plot color for this layer.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting applies only to the viewport with the specified id."
}
],
"returns": "The plot color."
},
{
"signature": "System.Double PerViewportPlotWeight(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the plot weight, in millimeters, for this layer.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting applies only to the viewport with the specified id."
}
],
"returns": "The plot color."
},
{
"signature": "System.Void RemoveCustomSectionStyle()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void SetCustomSectionStyle(SectionStyle sectionStyle)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void SetPersistentLocking(System.Boolean persistentLocking)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the persistent locking setting for this layer",
"since": "5.5"
},
{
"signature": "System.Void SetPersistentVisibility(System.Boolean persistentVisibility)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the global persistent visibility setting for this layer.",
"since": "5.5"
},
{
"signature": "System.Void SetPerViewportColor(System.Guid viewportId, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the display color for this layer.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting applies only to the viewport with the specified id."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "The display color."
}
]
},
{
"signature": "System.Void SetPerViewportPersistentVisibility(System.Guid viewportId, System.Boolean persistentVisibility)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the per layer persistent visibility. The persistent viability setting is used for layers whose visibility can be changed by a parent layer. In this case, when a parent layer is turned off, then child layers are also turned off. The persistent visibility setting determines what happens when the parent is turned on again.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting applies only to the viewport with the specified id. If Guid.Empty, then the setting applies to all viewports with per viewport layer settings."
},
{
"name": "persistentVisibility",
"type": "System.Boolean",
"summary": "If true, this layer's visibility in the specified viewport is controlled by a parent object and the parent is turned on (after being off), then this layer will also be turned on in the specified viewport. If false, this layer's visibility in the specified viewport is controlled by a parent object and the parent layer is turned on (after being off), then this layer will continue to be off in the specified viewport."
}
]
},
{
"signature": "System.Void SetPerViewportPlotColor(System.Guid viewportId, System.Drawing.Color color)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the plot color for this layer.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting applies only to the viewport with the specified id."
},
{
"name": "color",
"type": "System.Drawing.Color",
"summary": "The plot color."
}
]
},
{
"signature": "System.Void SetPerViewportPlotWeight(System.Guid viewportId, System.Double plotWeight)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the plot weight, in millimeters, for this layer.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting applies only to the viewport with the specified id."
},
{
"name": "plotWeight",
"type": "System.Double",
"summary": "The plot weight in millimeters. A weight of 0.0 indicates the \"default\" pen weight should be used. A weight of -1.0 indicates the layer should not be printed."
}
]
},
{
"signature": "System.Void SetPerViewportVisible(System.Guid viewportId, System.Boolean visible)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Controls layer visibility in specific viewports.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting applies only to the viewport with the specified id. If Guid.Empty, then the setting applies to all viewports with per viewport layer settings."
},
{
"name": "visible",
"type": "System.Boolean",
"summary": "True to make layer visible, False to make layer invisible."
}
]
},
{
"signature": "System.Boolean SetUserString(System.String key, System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Attach a user string (key,value combination) to this geometry.",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve this string."
},
{
"name": "value",
"type": "System.String",
"summary": "string associated with key."
}
],
"returns": "True on success."
},
{
"signature": "System.String ToString()",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false
},
{
"signature": "System.Void UnsetModelPersistentVisibility()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove any model persistent visibility setting from this layer.",
"since": "8.0"
},
{
"signature": "System.Void UnsetPersistentLocking()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove any explicitly persistent locking settings from this layer",
"since": "5.5"
},
{
"signature": "System.Void UnsetPersistentVisibility()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove any explicit persistent visibility setting from this layer",
"since": "5.5"
},
{
"signature": "System.Void UnsetPerViewportPersistentVisibility(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove any per viewport persistent visibility setting so the layer's overall setting will be used for all viewports.",
"since": "6.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "If not Guid.Empty, then the setting for this viewport will be deleted. If Guid.Empty, the all per viewport visibility settings will be removed."
}
]
}
],
"operators": [
{
"signature": "bool operator !=(Layer left, Layer right)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "bool operator ==(Layer left, Layer right)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "6.0"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "LeaderObject",
"dataType": "class",
"summary": "Rhino Object that represents leader geometry and attributes",
"baseclass": "Rhino.DocObjects.AnnotationObjectBase",
"properties": [
{
"signature": "Leader LeaderGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the leader geometry for this object.",
"since": "6.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "LightObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "int Index",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Light LightGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "Light DuplicateLightGeometry()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "LinearDimensionObject",
"dataType": "class",
"summary": "Rhino Object that represents a linear dimension geometry and attributes",
"baseclass": "Rhino.DocObjects.DimensionObject",
"properties": [
{
"signature": "LinearDimension LinearDimensionGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the dimension geometry for this object.",
"since": "6.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "LineCapStyle",
"dataType": "enum",
"summary": "Shape to be used at the ends of open curves",
"values": [
{
"signature": "Round = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ends are extended by a half circle with diameter equal to the curve width"
},
{
"signature": "Flat = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Also known as butt. Ends are flat and do not extend"
},
{
"signature": "Square = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Ends are flat and extended by half of the curve width"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "LineJoinStyle",
"dataType": "enum",
"summary": "Shape to be used at the corners of curves",
"values": [
{
"signature": "Round = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Rounds corners"
},
{
"signature": "Miter = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Sharp corners where outer edges are extended to a point where they meet"
},
{
"signature": "Bevel = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Beveled corner where outer edges are connected without extending"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Linetype",
"dataType": "class",
"baseclass": "Rhino.DocObjects.ModelComponent",
"constructors": [
{
"signature": "Linetype()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Linetype(Linetype other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
}
],
"properties": [
{
"signature": "bool AlwaysModelDistances",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Linetype patterns and widths are typically interpreted as distances on the printed output when printing. In this case AlwaysModelDistances is False (default). When set to true, the linetype pattern and width will be interpreted as being in world distances. This is useful for cases like modeling a road as a single curve.",
"since": "8.6",
"property": ["get", "set"]
},
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns ModelComponentType.LinePattern .",
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool HasShapes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Does this linetype have shapes",
"property": ["get"]
},
{
"signature": "bool InUse",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if the linetype is in use by a Rhino object, a layer, an instance definition, or a section style.",
"since": "8.7",
"property": ["get"]
},
{
"signature": "bool IsDeleted",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets a value indicating whether this linetype has been deleted and is currently in the Undo buffer.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsModified",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True if this linetype has been modified by LinetypeTable.ModifyLinetype() and the modifications can be undone.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsPatternLocked",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if the pattern is locked and cannot be modified.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "bool IsReference",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets a value indicting whether this linetype is a referenced linetype. Referenced linetypes are part of referenced documents.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "LineCapStyle LineCapStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Defines how the ends of open curves should be drawn",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "LineJoinStyle LineJoinStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Defines how the corners of curves should be drawn",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int LinetypeIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The index of this linetype.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string Name",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "The name of this linetype.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double PatternLength",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Total length of one repeat of the pattern.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "int SegmentCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Number of segments in the pattern.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "BoundingBox ShapeBounds",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The bounding box of the shapes in this linetype definition.",
"property": ["get"]
},
{
"signature": "double ShapeGap",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If shapes are present in this linetype, this is the gap around the shape.",
"property": ["get", "set"]
},
{
"signature": "Vector2d ShapeLocalOffset",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Local offset applied to shapes",
"property": ["get", "set"]
},
{
"signature": "double ShapeSpacing",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If shapes are present in this linetype, this is the distance between shapes",
"property": ["get", "set"]
},
{
"signature": "int UserStringCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the amount of user strings.",
"since": "8.9",
"property": ["get"]
},
{
"signature": "double Width",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Base width for this linetype",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "UnitSystem WidthUnits",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Unit system that widths are defined in. UnitSystem.None is default and means that the width is defined in pixels.",
"since": "8.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "Linetype CreateFromPatternString(System.String patternString, System.Boolean millimeters)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Creates a linetype from a pattern string. Values greater than zero represent line segments, and values less than or equal to zero represents space segments.",
"since": "7.4",
"parameters": [
{
"name": "patternString",
"type": "System.String",
"summary": "The pattern string."
},
{
"name": "millimeters",
"type": "System.Boolean",
"summary": "Specify True if the pattern is represented in millimeters. Specify False if the pattern is represented in inches."
}
],
"returns": "A valid linetype if successful, None otherwise."
},
{
"signature": "Linetype[] ReadFromFile(System.String path)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Reads linetypes from either a Rhino .3dm file or an AutoCAD .lin file.",
"since": "6.6",
"parameters": [
{
"name": "path",
"type": "System.String",
"summary": "The path to the file to read."
}
],
"returns": "An array of linetypes if successful, otherwise an empty array."
},
{
"signature": "System.Boolean AddShape(Curve shapeCurve, System.Double offset)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Add a curve shape to this linetype definition"
},
{
"signature": "System.Boolean AddShape(TextEntity text, System.Double offset)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Add text as a shape to this linetype definition"
},
{
"signature": "System.Int32 AppendSegment(System.Double length, System.Boolean isSolid)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds a segment to the pattern.",
"since": "5.0",
"parameters": [
{
"name": "length",
"type": "System.Double",
"summary": "The length of the segment to be added."
},
{
"name": "isSolid",
"type": "System.Boolean",
"summary": "If true, the length is interpreted as a line. If false, then the length is interpreted as a space."
}
],
"returns": "Index of the added segment."
},
{
"signature": "System.Boolean CommitChanges()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void Default()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set linetype to default settings.",
"since": "5.0"
},
{
"signature": "System.Void DeleteAllUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.9"
},
{
"signature": "System.Boolean DeleteUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.9"
},
{
"signature": "Linetype DuplicateLinetype()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Duplicates a linetype, clears the name, id, and locked bits.",
"since": "8.0",
"returns": "The duplicated linetype if successful, None otherwise."
},
{
"signature": "System.Void GetSegment(System.Int32 index, out System.Double length, out System.Boolean isSolid)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the segment information at a index.",
"since": "5.0",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "Zero based index of the segment."
},
{
"name": "length",
"type": "System.Double",
"summary": "The length of the segment in millimeters."
},
{
"name": "isSolid",
"type": "System.Boolean",
"summary": "If the length is interpreted as a line, True is assigned during the call to this out parameter. \nIf the length is interpreted as a space, then False is assigned during the call to this out parameter."
}
]
},
{
"signature": "Point2d[] GetTaperPoints()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Taper points are positions/width combinations along the length of a curve",
"since": "8.0"
},
{
"signature": "System.String GetUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets user string from this geometry.",
"since": "8.9",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve the string."
}
],
"returns": "string associated with the key if successful. None if no key was found."
},
{
"signature": "System.Collections.Specialized.NameValueCollection GetUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a copy of all (user key string, user value string) pairs attached to this geometry.",
"since": "8.9",
"returns": "A new collection."
},
{
"signature": "System.String PatternString(System.Boolean millimeters)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns a string that represents the pattern of the linetype, which can be used in user interface. Values greater than zero represent line segments, and values less than or equal to zero represent space segments.",
"since": "7.4",
"parameters": [
{
"name": "millimeters",
"type": "System.Boolean",
"summary": "If true, the string is formatted in millimeters. If false, the string is formatted in inches."
}
],
"returns": "The pattern string."
},
{
"signature": "System.Void RemoveAllShapes()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove all shapes from this linetype"
},
{
"signature": "System.Boolean RemoveSegment(System.Int32 index)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes a segment in the linetype.",
"since": "5.0",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "Zero based index of the segment to remove."
}
],
"returns": "True if the segment index was removed."
},
{
"signature": "System.Void RemoveTaper()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove taper information for stroke",
"since": "8.0"
},
{
"signature": "System.Boolean SetSegment(System.Int32 index, System.Double length, System.Boolean isSolid)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the length and type of the segment at index.",
"since": "5.0",
"parameters": [
{
"name": "index",
"type": "System.Int32",
"summary": "Zero based index of the segment."
},
{
"name": "length",
"type": "System.Double",
"summary": "The length of the segment to be added in millimeters."
},
{
"name": "isSolid",
"type": "System.Boolean",
"summary": "If true, the length is interpreted as a line. If false, then the length is interpreted as a space."
}
],
"returns": "True if the operation was successful; otherwise false."
},
{
"signature": "System.Boolean SetSegments(IEnumerable segments)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set all segments.",
"since": "6.8",
"parameters": [
{
"name": "segments",
"type": "IEnumerable",
"summary": "An array of segments lengths. Lengths >= 0 are interpreted as a line. Lengths < 0 are interpreted as a space."
}
],
"returns": "True if the segments were replaced"
},
{
"signature": "System.Void SetTaper(System.Double startWidth, Point2d taperPoint, System.Double endWidth)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set taper for this linetype width a single internal taper point",
"since": "8.0"
},
{
"signature": "System.Void SetTaper(System.Double startWidth, System.Double endWidth)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set taper to a simple start width / end width",
"since": "8.0"
},
{
"signature": "System.Boolean SetUserString(System.String key, System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Attach a user string (key,value combination) to this geometry.",
"since": "8.9",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve this string."
},
{
"name": "value",
"type": "System.String",
"summary": "string associated with key."
}
],
"returns": "True on success."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Markup",
"dataType": "class",
"summary": "Markup elements that store image data when users create markups",
"baseclass": "Rhino.DocObjects.ModelComponent",
"constructors": [
{
"signature": "Markup()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Create a new instance of a Markup"
},
{
"signature": "Markup(Markup other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Create a new Markup that is a copy of another Markup"
}
],
"properties": [
{
"signature": "Bitmap Bitmap",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"property": ["get"]
},
{
"signature": "string Comments",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"property": ["get", "set"]
},
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns ModelComponentType.Markup .",
"since": "8.0",
"property": ["get"]
},
{
"signature": "DateTime Created",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"property": ["get"]
},
{
"signature": "string CreatedBy",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"property": ["get"]
},
{
"signature": "bool IsUnset",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if the markup is unset.",
"since": "9.0",
"property": ["get"]
},
{
"signature": "DateTime Modified",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"property": ["get"]
},
{
"signature": "string ModifiedBy",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"property": ["get"]
},
{
"signature": "string Name",
"modifiers": ["override", "public"],
"protected": false,
"virtual": false,
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Void CopyToClipboard()",
"modifiers": ["public"],
"protected": false,
"virtual": false
},
{
"signature": "System.Boolean ReadRevisionHistory(out System.String createdBy, out System.String lastEditedBy, out System.Int32 revision, out System.DateTime createdOn, out System.DateTime lastEditedOn)",
"modifiers": ["public"],
"protected": false,
"virtual": false
},
{
"signature": "System.Drawing.Bitmap Thumbnail(System.Int32 height)",
"modifiers": ["public"],
"protected": false,
"virtual": false
},
{
"signature": "System.Void WriteToFile()",
"modifiers": ["public"],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "Material",
"dataType": "class",
"baseclass": "Rhino.DocObjects.ModelComponent",
"constructors": [
{
"signature": "Material()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Material(Material other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
}
],
"properties": [
{
"signature": "Material DefaultMaterial",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "double MaxShine",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool AlphaTransparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Color AmbientColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns ModelComponentType.RenderMaterial .",
"since": "6.0",
"property": ["get"]
},
{
"signature": "Color DiffuseColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DisableLighting",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Color EmissionColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double FresnelIndexOfRefraction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the Fresnel index of refraction of the material, default is 1.56",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool FresnelReflections",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets if Fresnel reflections are used.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double IndexOfRefraction",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the index of refraction of the material, generally >= 1.0 (speed of light in vacuum)/(speed of light in material)",
"since": "5.1",
"property": ["get", "set"]
},
{
"signature": "bool IsDefaultMaterial",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "By default Rhino layers and objects are assigned the default rendering material.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsDeleted",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Deleted materials are kept in the runtime material table so that undo will work with materials. Call IsDeleted to determine to determine if a material is deleted.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsDocumentControlled",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "If True this object may not be modified. Any properties or functions that attempt to modify this object when it is set to \"IsReadOnly\" will throw a NotSupportedException.",
"since": "5.6",
"property": ["get"]
},
{
"signature": "bool IsPhysicallyBased",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get"]
},
{
"signature": "bool IsReference",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Rhino allows multiple files to be viewed simultaneously. Materials in the document are \"normal\" or \"reference\". Reference materials are not saved.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "int MaterialIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.6",
"property": ["get"]
},
{
"signature": "string Name",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "PhysicallyBasedMaterial PhysicallyBased",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get"]
},
{
"signature": "Color PreviewColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Very simple preview color function for GUIs.",
"since": "6.6",
"property": ["get"]
},
{
"signature": "Guid RDKMaterialID",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the RDK material ID.",
"since": "8.6",
"remarks": "Multiple Rhino materials ( with unique component IDs) can have the same RDK material ID.",
"property": ["get"]
},
{
"signature": "Color ReflectionColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double ReflectionGlossiness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the reflection glossiness.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "double Reflectivity",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets how reflective a material is, 0f is no reflection 1f is 100% reflective.",
"since": "5.7",
"property": ["get", "set"]
},
{
"signature": "double RefractionGlossiness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the refraction glossiness.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "RenderMaterial RenderMaterial",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the RenderMaterial related to this Material. Will create a new RenderMaterial if none exists. This can happen for older documents.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "Guid RenderMaterialInstanceId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Guid RenderPlugInId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The Id of the RenderPlugIn that is associated with this material.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double Shine",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the shine factor of the material.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color SpecularColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double Transparency",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the transparency of the material (0.0 = opaque to 1.0 = transparent)",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color TransparentColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int UseCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Number of objects and layers that use this material.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "int UserStringCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Void ClearMaterialChannels()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes all material channels",
"since": "6.26"
},
{
"signature": "System.Boolean CommitChanges()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void CopyFrom(Material other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Void Default()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set material to default settings.",
"since": "5.0"
},
{
"signature": "Texture GetBitmapTexture()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Texture GetBumpTexture()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the bump texture of this material.",
"since": "5.0",
"returns": "A texture; or None if no bump texture has been added to this material."
},
{
"signature": "Texture GetEnvironmentTexture()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Texture GetTexture(TextureType which)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the texture that corresponds with the specified texture type for this material.",
"since": "7.0"
},
{
"signature": "Texture[] GetTextures()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get array of textures that this material uses",
"since": "5.7"
},
{
"signature": "Texture GetTransparencyTexture()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.String GetUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a user string.",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve the string."
}
],
"returns": "string associated with the key if successful. None if no key was found."
},
{
"signature": "System.Collections.Specialized.NameValueCollection GetUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets an independent copy of the collection of (user text key, user text value) pairs attached to this object.",
"since": "5.0",
"returns": "A collection of key strings and values strings. This"
},
{
"signature": "System.Guid MaterialChannelIdFromIndex(System.Int32 material_channel_index)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Finds id of the material channel at given index.",
"since": "6.26",
"parameters": [
{
"name": "material_channel_index",
"type": "System.Int32",
"summary": "Index"
}
],
"returns": "Id of the material channel"
},
{
"signature": "System.Int32 MaterialChannelIndexFromId(System.Guid material_channel_id, System.Boolean bAddIdIfNotPresent)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Finds index of the material channel that refers to a material channel with the given id. Optionally adds channel if one is not found.",
"since": "6.26",
"parameters": [
{
"name": "material_channel_id",
"type": "System.Guid",
"summary": "Id"
},
{
"name": "bAddIdIfNotPresent",
"type": "System.Boolean",
"summary": "Controls whether to add channel if none exist"
}
],
"returns": "Index of the material channel"
},
{
"signature": "System.Void OnSwitchToNonConst()",
"modifiers": ["protected", "override"],
"protected": true,
"virtual": false
},
{
"signature": "System.Boolean SetBitmapTexture(System.String filename)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetBitmapTexture(Texture texture)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetBumpTexture(System.String filename)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetBumpTexture(Texture texture)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetEnvironmentTexture(System.String filename)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetEnvironmentTexture(Texture texture)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetTexture(Texture texture, TextureType which)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the texture that corresponds with the specified texture type for this material.",
"since": "7.0",
"parameters": [
{
"name": "texture",
"type": "Texture",
"summary": "An instance of Rhino.DocObjects.Texture"
},
{
"name": "which",
"type": "TextureType",
"summary": "Use Rhino.DocObjects.TextureType"
}
]
},
{
"signature": "System.Boolean SetTransparencyTexture(System.String filename)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetTransparencyTexture(Texture texture)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean SetUserString(System.String key, System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Attach a user string (key,value combination) to this geometry.",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve this string."
},
{
"name": "value",
"type": "System.String",
"summary": "string associated with key."
}
],
"returns": "True on success."
},
{
"signature": "System.Void ToPhysicallyBased()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "MaterialRef",
"dataType": "class",
"interfaces": ["IDisposable"],
"properties": [
{
"signature": "Guid BackFaceMaterialId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The Id of the Material used to render the back of an object.",
"since": "5.10",
"property": ["get"]
},
{
"signature": "int BackFaceMaterialIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The index of the material used to render the back of an object",
"since": "5.10",
"property": ["get"]
},
{
"signature": "Guid FrontFaceMaterialId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The Id of the Material used to render the front of an object.",
"since": "5.10",
"property": ["get"]
},
{
"signature": "int FrontFaceMaterialIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The index of the material used to render the front of an object",
"since": "5.10",
"property": ["get"]
},
{
"signature": "ObjectMaterialSource MaterialSource",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines if the simple material should come from the object or from it's layer.",
"since": "5.10",
"property": ["get"]
},
{
"signature": "Guid PlugInId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Identifies a rendering plug-in",
"since": "5.10",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.10"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "MaterialRefCreateParams",
"dataType": "class",
"summary": "Options passed to MaterialRefs.Create",
"constructors": [
{
"signature": "MaterialRefCreateParams()",
"summary": "Initializes a new instance of the MaterialRefCreateParams class"
}
],
"properties": [
{
"signature": "Guid BackFaceMaterialId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The Id of the Material used to render the back of an object.",
"since": "5.10",
"property": ["get", "set"]
},
{
"signature": "int BackFaceMaterialIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The index of the material used to render the back of an object",
"since": "5.10",
"property": ["get", "set"]
},
{
"signature": "Guid FrontFaceMaterialId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The Id of the Material used to render the front of an object.",
"since": "5.10",
"property": ["get", "set"]
},
{
"signature": "int FrontFaceMaterialIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The index of the material used to render the front of an object",
"since": "5.10",
"property": ["get", "set"]
},
{
"signature": "ObjectMaterialSource MaterialSource",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines if the simple material should come from the object or from it's layer.",
"since": "5.10",
"property": ["get", "set"]
},
{
"signature": "Guid PlugInId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Identifies a rendering plug-in",
"since": "5.10",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "MaterialRefs",
"dataType": "class",
"summary": "If you are developing a high quality plug-in renderer, and a user is assigning a custom render material to this object, then add rendering material information to the MaterialRefs dictionary. Note to developers: As soon as the MaterialRefs dictionary contains items rendering material queries slow down. Do not populate the MaterialRefs dictionary when setting the MaterialIndex will take care of your needs.",
"interfaces": ["IDictionary"],
"properties": [
{
"signature": "int Count",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the number of elements contained in this dictionary",
"since": "5.10",
"property": ["get"]
},
{
"signature": "bool IsReadOnly",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "IDictionary required property, always returns False for this dictionary.",
"since": "5.10",
"property": ["get"]
},
{
"signature": "ICollection Keys",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets an ICollection containing the plug-in Id's in this dictionary.",
"since": "5.10",
"property": ["get"]
},
{
"signature": "ICollection Values",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets an ICollection containing the MaterialRef objects in this dictionary.",
"since": "5.10",
"property": ["get"]
},
{
"signature": "MaterialRef this[Guid key]",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the element with the specified plug-in Id."
}
],
"methods": [
{
"signature": "System.Void Add(KeyValuePair item)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds an item to this dictionary.",
"parameters": [
{
"name": "item",
"type": "KeyValuePair",
"summary": "The object to add to this dictionary"
}
]
},
{
"signature": "System.Void Add(System.Guid key, MaterialRef value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Add or replace an element with the provided key and value to this dictionary.",
"since": "5.10",
"parameters": [
{
"name": "key",
"type": "System.Guid",
"summary": "The plug-in associated with this MaterialRef"
},
{
"name": "value",
"type": "MaterialRef",
"summary": "MaterialRef to add to this dictionary"
}
]
},
{
"signature": "System.Void Clear()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes all items from this dictionary.",
"since": "5.10"
},
{
"signature": "System.Boolean Contains(KeyValuePair item)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines whether this dictionary contains a specific value.",
"parameters": [
{
"name": "item",
"type": "KeyValuePair",
"summary": "The object to locate in this dictionary."
}
],
"returns": "True if item is found in this dictionary; otherwise, false."
},
{
"signature": "System.Boolean ContainsKey(System.Guid key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines whether this dictionary contains an MaterialRef with the specified plug-in id.",
"since": "5.10",
"parameters": [
{
"name": "key",
"type": "System.Guid",
"summary": "The plug-in Id used to locate a MaterialRef in this dictionary."
}
],
"returns": "True if this dictionary contains an element with the specified plug-in Id; otherwise, false."
},
{
"signature": "System.Void CopyTo(KeyValuePair[] array, System.Int32 arrayIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Copies the elements of this dictionary to an System.Array, starting at a particular System.Array index.",
"parameters": [
{
"name": "array",
"type": "KeyValuePair[]",
"summary": "The one-dimensional System.Array that is the destination of the elements copied from this dictionary. The System.Array must have zero-based indexing."
},
{
"name": "arrayIndex",
"type": "System.Int32",
"summary": "The zero-based index in array at which copying begins."
}
]
},
{
"signature": "MaterialRef Create(MaterialRefCreateParams createParams)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Call this method to create a MaterialRef which can be used when calling one of the Add methods.",
"since": "5.10",
"parameters": [
{
"name": "createParams",
"type": "MaterialRefCreateParams",
"summary": "Values used to initialize the MaterialRef"
}
],
"returns": "A temporary MaterialRef object, the caller is responsible for disposing of this object."
},
{
"signature": "IEnumerator> GetEnumerator()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns an enumerator that iterates through this dictionary.",
"since": "5.10",
"returns": "A IEnumerator that can be used to iterate this dictionary."
},
{
"signature": "System.Boolean Remove(KeyValuePair item)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes the element with the specified plug-in id from the this dictionary.",
"parameters": [
{
"name": "item",
"type": "KeyValuePair",
"summary": "The object to remove from this dictionary"
}
]
},
{
"signature": "System.Boolean Remove(System.Guid key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes the MaterialRef with the specified plug-in Id from this dictionary.",
"since": "5.10",
"parameters": [
{
"name": "key",
"type": "System.Guid",
"summary": "The plug-in Id for the MaterialRef to remove."
}
],
"returns": "True if the MaterialRef is successfully removed; otherwise, false. This method also returns False if key was not found in the original dictionary."
},
{
"signature": "System.Boolean TryGetValue(System.Guid key, out MaterialRef value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the value associated with the specified key.",
"since": "5.10",
"parameters": [
{
"name": "key",
"type": "System.Guid",
"summary": "The plug-in Id whose MaterialRef to get."
},
{
"name": "value",
"type": "MaterialRef",
"summary": "When this method returns, the MaterialRef associated with the specified key, if the key is found; otherwise, null. This parameter is passed uninitialized."
}
],
"returns": "True if this dictionary contains a MaterialRef with the specified key; otherwise, false."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "MeshObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "bool IsCustomObject",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "Mesh MeshGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Boolean CheckMeshes(IEnumerable meshObjects, Rhino.FileIO.TextLog textLog, ref MeshCheckParameters parameters)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Examines mesh objects and logs a description of what it finds right or wrong. The various properties the function checks for are described in MeshCheckParameters.",
"since": "7.0",
"parameters": [
{
"name": "meshObjects",
"type": "IEnumerable",
"summary": "A collection of mesh objects."
},
{
"name": "textLog",
"type": "Rhino.FileIO.TextLog",
"summary": "The text log."
},
{
"name": "parameters",
"type": "MeshCheckParameters",
"summary": "The mesh checking parameter and results."
}
],
"returns": "True if successful, False otherwise."
},
{
"signature": "Mesh DuplicateMeshGeometry()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Mesh SetMesh(Mesh mesh)",
"modifiers": ["protected"],
"protected": true,
"virtual": false,
"summary": "Only for developers who are defining custom subclasses of MeshObject. Directly sets the internal mesh geometry for this object. Note that this function does not work with Rhino's \"undo\".",
"remarks": "Note that this function does not work with Rhino's \"undo\". The typical approach for adjusting the mesh geometry is to modify the object that you get when you call the MeshGeometry property and then call CommitChanges.",
"returns": "The old mesh geometry that was set for this object"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ModelComponent",
"dataType": "class",
"summary": "Base class for all components in a model (document) and manages the index, id and other information common to this type of objects. \nThis class parallels the C++ ON_ModelComponent.",
"baseclass": "Rhino.Runtime.CommonObject",
"properties": [
{
"signature": "string NamePathSeparator",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Returns the string \"::\". This is the string Rhino uses in layer full path names to separate the names of individual layers.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "ComponentStatus ComponentStatus",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Gets or sets the component status of the model component.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "abstract"],
"protected": false,
"virtual": false,
"summary": "Gets the ModelComponentType for this object. Useful in switch statements.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "string DeletedName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the name of a component that is deleted.",
"since": "6.2",
"property": ["get"]
},
{
"signature": "bool HasId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns a value indicating whether the component has an ID.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool HasIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns a value indicating whether the component has an Index.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool HasName",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns a value indicating whether the component has a Name.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "Guid Id",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Gets or sets the ID of the current instance.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool IdIsLocked",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns a value indicating whether the component ID is already locked.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "int Index",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Gets or sets the model component index attribute.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool IndexIsLocked",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns a value indicating whether the component Index is already locked.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "uint InstanceDefinitionModelSerialNumber",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "When a component is in a model as part of the information required for a linked instance definition, this value identifies the linked instance definition reference model.",
"since": "6.12",
"remarks": "Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.",
"property": ["get"]
},
{
"signature": "bool IsComponentStatusLocked",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The component status itself can be locked. This returns an indication.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool IsDeleted",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "True if the component is deleted. Deleted components are kept by the document for undo purposes.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "bool IsReference",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Gets a value indicting whether this component is a referenced component. Referenced components are part of referenced documents.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "bool IsSystemComponent",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True if this model component is a system constant. \nAn incomplete list of system constant model components is below: \n- ON_ModelComponent::Unset
- ON_InstanceDefinition::Empty
- ON_Linetype::Unset
- ON_Linetype::Continuous
- ON_Linetype::ByLayer
- ON_Linetype::ByParent
- ON_Layer::Unset
- ON_Layer::Default
- ON_TextStyle::Unset
- ON_TextStyle::Default
- ON_TextStyle::ByLayer
- ON_TextStyle::ByParent
- ON_DimStyle::Unset
- ON_DimStyle::Default
- ON_DimStyle::DefaultInchDecimal
- ON_DimStyle::DefaultInchFractional
- ON_DimStyle::DefaultFootInchArchitecture
- ON_DimStyle::DefaultMillimeterSmall
- ON_DimStyle::DefaultMillimeterLarge
- ON_DimStyle::DefaultMillimeterArchitecture
",
"since": "6.0",
"property": ["get"]
},
{
"signature": "uint ModelSerialNumber",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "A value identifying the model that manages this component.",
"since": "6.12",
"remarks": "If the component is being managed by a model, this value identifies the model. In Rhino, this value is the document runtime serial number. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.",
"property": ["get"]
},
{
"signature": "string Name",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Gets or sets the name",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "bool NameIsLocked",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns a value indicating whether the component Name is already locked.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "uint ReferenceModelSerialNumber",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "When a component is in a model for reference, this value identifies the reference model.",
"since": "6.12",
"remarks": "Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Boolean IsValidComponentName(System.String name)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Tests for a valid model component name.",
"since": "6.15",
"parameters": [
{
"name": "name",
"type": "System.String",
"summary": "The string to validate."
}
],
"returns": "True if the string is a valid model component name, False otherwise."
},
{
"signature": "System.Boolean ModelComponentTypeIgnoresCase(ModelComponentType type)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Informs the developer if a particular model component type will require case-ignoring searching within a document. This is currently True with groups; False otherwise.",
"since": "6.0",
"parameters": [
{
"name": "type",
"type": "ModelComponentType",
"summary": "True if the component ignores case."
}
]
},
{
"signature": "System.Boolean ModelComponentTypeIncludesParent(ModelComponentType type)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Informs the developer if a particular model component type will include the hash of the parent.",
"since": "6.0",
"parameters": [
{
"name": "type",
"type": "ModelComponentType",
"summary": "True if the component includes parent hash."
}
]
},
{
"signature": "System.Boolean ModelComponentTypeRequiresUniqueName(ModelComponentType type)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Informs the developer if a particular model component type will require uniqueness within a document. This is currently True with render materials and model geometry; False otherwise.",
"since": "6.0",
"parameters": [
{
"name": "type",
"type": "ModelComponentType",
"summary": "The type to check."
}
],
"returns": "True with render materials and model geometry; False otherwise."
},
{
"signature": "System.Void ClearId()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Resets the HasId property of the model component to false, if possible.",
"since": "6.0"
},
{
"signature": "System.Void ClearIndex()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Resets the HasIndex property of the model component to false, if possible.",
"since": "6.0"
},
{
"signature": "System.Void ClearName()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Resets the HasName property of the model component to false, if possible.",
"since": "6.0"
},
{
"signature": "System.UInt32 DataCRC(System.UInt32 currentRemainder)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Increments the Cyclic Redundancy Check value by this instance.",
"since": "6.0",
"parameters": [
{
"name": "currentRemainder",
"type": "System.UInt32",
"summary": "The current remainder value."
}
],
"returns": "The updated remainder value."
},
{
"signature": "System.Void LockId()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Locks the component Id property.",
"since": "6.0"
},
{
"signature": "System.Void LockIndex()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Locks the component Index property.",
"since": "6.0"
},
{
"signature": "System.Void LockName()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Locks the component Name property.",
"since": "6.0"
},
{
"signature": "System.String ToString()",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns the name of the model component type, and then its name and index.",
"remarks": "This is provided as a visual aid. Do not rely on this for serialization."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ModelComponentType",
"dataType": "enum",
"summary": "The ON_ModelComponent::Type enum has a value for each explicit component type and two special values, Unset and Mixed. Use an ON_ModelComponentTypeIterator instance to iterate over the ON_ModelComponent::Type values.",
"values": [
{
"signature": "Unset = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "No value set."
},
{
"signature": "Image = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Embedded image (bitmap) components."
},
{
"signature": "TextureMapping = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Texture mapping."
},
{
"signature": "Material = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Material."
},
{
"signature": "RenderMaterial = Material",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Render material. Deprecated in favor of Material."
},
{
"signature": "LinePattern = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Line pattern (linetype)."
},
{
"signature": "Layer = 5",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Layer."
},
{
"signature": "Group = 6",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Group."
},
{
"signature": "TextStyle = 7",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Text style."
},
{
"signature": "DimStyle = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "AnnotationDimension style."
},
{
"signature": "RenderLight = 9",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Render light."
},
{
"signature": "HatchPattern = 10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Hatch pattern."
},
{
"signature": "InstanceDefinition = 11",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Instance definition."
},
{
"signature": "ModelGeometry = 12",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Model objects (points, curves, surfaces, ..., annotation, page details, ...), including objects referenced by instance definitions."
},
{
"signature": "HistoryRecord = 13",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "History record."
},
{
"signature": "RenderContent = 14",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Render content."
},
{
"signature": "EmbeddedFile = 15",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Embedded file for render texture."
},
{
"signature": "ObsoleteValue = 16",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "This value was never used and is now obsolete."
},
{
"signature": "SectionStyle = 17",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Section style attributes"
},
{
"signature": "Markup = 18",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Markup entity"
},
{
"signature": "PageViewGroup = 19",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Page view group."
},
{
"signature": "NumOf",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Number of items above."
},
{
"signature": "Mixed = 0xFE",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Multiple component types. Used when a component type filter must include all explicit component types."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "MorphControlObject",
"dataType": "class",
"summary": "Represents a Rhino.Geometry.MorphControl in a document.",
"baseclass": "Rhino.DocObjects.RhinoObject"
},
{
"namespace": "Rhino.DocObjects",
"name": "NamedViewWidgetObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "string AssociatedNamedView",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.5",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectAttributes",
"dataType": "class",
"summary": "Attributes (color, material, layer,...) associated with a rhino object",
"baseclass": "Rhino.Runtime.CommonObject",
"constructors": [
{
"signature": "ObjectAttributes()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "ObjectAttributes(SerializationInfo info, StreamingContext context)",
"modifiers": ["protected"],
"protected": true,
"virtual": false
}
],
"properties": [
{
"signature": "int OCSMappingChannelId",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "The mapping channel id to use when calling MappingChannel to retrieve the OCS mapping if there is one.",
"since": "7.17",
"property": ["get"]
},
{
"signature": "bool CastsShadows",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets an object's casts shadows property, or whether or not an object casts shadows on other objects and a ground plane.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "SectionLabelStyle ClippingPlaneLabelStyle",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Defines how a label for a clipping plane object should be shown",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "ObjectColorSource ColorSource",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The color used to display an object is specified in one of three ways. If ColorSource is ON::color_from_layer, then the object's layer ON_Layer::Color() is used. If ColorSource is ON::color_from_object, then value of m_color is used. If ColorSource is ON::color_from_material, then the diffuse color of the object's render material is used. See ON_3dmObjectAttributes::MaterialSource() to determine where to get the definition of the object's render material.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "MeshingParameters CustomMeshingParameters",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns or sets the per-object render meshing parameters, which controls the object's render mesh density. If this property is null, then the object uses the document's render meshing parameters. To remove the per-object render meshing parameters, set this property to null.",
"since": "7.6",
"property": ["get", "set"]
},
{
"signature": "Decals Decals",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets all object decals associated with this object.",
"since": "5.10",
"property": ["get"]
},
{
"signature": "bool DetailBackgroundVisible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Should the background color show for a detail",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int DisplayOrder",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Display order used to force objects to be drawn on top or behind each other. Larger numbers draw on top of smaller numbers. \n0 = draw object in standard depth buffered order \n<0 = draw object behind \"normal\" draw order objects \n>0 = draw object on top of \"normal\" draw order objects",
"since": "5.10",
"property": ["get", "set"]
},
{
"signature": "bool EnableCustomMeshingParameters",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "En/disables the custom meshing parameters enabled state.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "File3dmMeshModifiers File3dmMeshModifiers",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get an object that provides access to mesh modifiers when the attributes is for a File3dmObject.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "int GroupCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "number of groups object belongs to.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool HasMapping",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "A mapping from any plug-in source is associated with these attributes Need to do this here to respond correctly to ModifyObjectAttributes event",
"since": "5.10",
"property": ["get"]
},
{
"signature": "Color HatchBackgroundFillColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Fill color for hatches (default is Color.Empty)",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "Color HatchBackgroundFillPrintColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Fill color for hatches when printing (default is Color.Empty)",
"property": ["get", "set"]
},
{
"signature": "Color HatchBoundaryColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Hatch boundary color override. Default is unset color which means use the standard attributes and layer colors to determine the boundary color",
"property": ["get", "set"]
},
{
"signature": "ItemColorSource HatchBoundaryColorSource",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Source for the hatch boundary display color. Determines whether the boundary color is read from the layer, from the object's main attribute color, inherited from the parent, or read from the custom override color set by HatchBoundaryColor (ColorCustom).",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "Color HatchBoundaryPlotColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Hatch boundary plot color override. Default is unset color which means use the standard attributes and layer colors to determine the boundary color",
"property": ["get", "set"]
},
{
"signature": "ItemColorSource HatchBoundaryPlotColorSource",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Source for the hatch boundary plot/print color. Determines whether the boundary plot color is read from the layer, from the object's main attribute color, inherited from the parent, or read from the custom override color set by HatchBoundaryPlotColor (ColorCustom).",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "double HatchBoundaryPlotWeightMillimeters",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Plot width of hatch boundary curves. values less than -1 (-10 is default): plot weight is determined by the m_plot_weight -1: do not plot 0: use default weight defined by the print dialog positive values are thicknesses in millimeters to print to",
"property": ["get", "set"]
},
{
"signature": "bool HatchBoundaryVisible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Draw the bounrdaries for a hatch (default is false)",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "bool IsDocumentControlled",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsInstanceDefinitionObject",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Use this query to determine if an object is part of an instance definition.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "int LayerIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets an associated layer index. \nLayer definitions in an OpenNURBS model are stored in a layer table. The layer table is conceptually an array of ON_Layer classes. Every OpenNURBS object in a model is on some layer. The object's layer is specified by zero based indices into the ON_Layer array.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int LinetypeIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the linetype index. \nLinetype definitions in an OpenNURBS model are stored in a linetype table. The linetype table is conceptually an array of ON_Linetype classes. Every OpenNURBS object in a model references some linetype. The object's linetype is specified by zero based indices into the ON_Linetype array. \nIndex 0 is reserved for continuous linetype (no pattern).",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double LinetypePatternScale",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Per object linetype scale",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "ObjectLinetypeSource LinetypeSource",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The Linetype used to display an object is specified in one of two ways. If LinetypeSource is ON::linetype_from_layer, then the object's layer ON_Layer::Linetype() is used. If LinetypeSource is ON::linetype_from_object, then value of m_linetype is used.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int MaterialIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the material index. \nIf you want something simple and fast, set the index of the rendering material.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "MaterialRefs MaterialRefs",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If you are developing a high quality plug-in renderer, and a user is assigning a custom render material to this object, then add rendering material information to the MaterialRefs dictionary. Note to developers: As soon as the MaterialRefs dictionary contains items rendering material queries slow down. Do not populate the MaterialRefs dictionary when setting the MaterialIndex will take care of your needs.",
"since": "5.10",
"property": ["get"]
},
{
"signature": "ObjectMaterialSource MaterialSource",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines if the simple material should come from the object or from it's layer. High quality rendering plug-ins should use m_rendering_attributes.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ObjectMode Mode",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "An object must be in one of three modes: normal, locked or hidden. If an object is in normal mode, then the object's layer controls visibility and selectability. If an object is locked, then the object's layer controls visibility by the object cannot be selected. If the object is hidden, it is not visible and it cannot be selected.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string Name",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets an object optional text name. \nMore than one object in a model can have the same name and some objects may have no name.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color ObjectColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If ON::color_from_object == ColorSource, then color is the object's display color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ObjectDecoration ObjectDecoration",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Used to indicate an object has a decoration (like an arrowhead on a curve)",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Guid ObjectId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Every object has a Guid (globally unique identifier, also known as UUID, or universally unique identifier). The default value is Guid.Empty. \nWhen an object is added to a model, the value is checked. If the value is Guid.Empty, a new Guid is created. If the value is not None but it is already used by another object in the model, a new Guid is created. If the value is not Guid.Empty and it is not used by another object in the model, then that value persists. When an object is updated, by a move for example, the value of ObjectId persists. \nThis value is the same as the one returned by object.Id.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Color PlotColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If plot_color_from_object == PlotColorSource, then PlotColor is the object's plotting color.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ObjectPlotColorSource PlotColorSource",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The color used to plot an object on paper is specified in one of three ways. If PlotColorSource is ON::plot_color_from_layer, then the object's layer ON_Layer::PlotColor() is used. If PlotColorSource is ON::plot_color_from_object, then value of PlotColor() is used.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "double PlotWeight",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Plot weight in millimeters. =0.0 means use the default width <0.0 means don't plot (visible for screen display, but does not show on plot)",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ObjectPlotWeightSource PlotWeightSource",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ReceivesShadows",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets an object's receives shadows property, or whether or not an object receives shadows from other objects.",
"since": "6.0",
"property": ["get", "set"]
},
{
"signature": "RenderMaterial RenderMaterial",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Sets the render material for the object - higher level function for setting MaterialSource and MaterialIndex",
"since": "7.8",
"property": ["set"]
},
{
"signature": "ObjectSectionAttributesSource SectionAttributesSource",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Where section attributes are read from",
"since": "8.0",
"property": ["get", "set"]
},
{
"signature": "int SectionStyleIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the section style index.",
"property": ["get", "set"]
},
{
"signature": "ActiveSpace Space",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Starting with V4, objects can be in either model space or page space. If an object is in page space, then ViewportId is not nil and identifies the page it is on.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "string Url",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Objects may have an URL. There are no restrictions on what value this URL may have. As an example, if the object came from a commercial part library, the URL might point to the definition of that part.",
"since": "6.8",
"property": ["get", "set"]
},
{
"signature": "int UserStringCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid ViewportId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If ViewportId is nil, the object is active in all viewports. If ViewportId is not nil, then this object is only active in a specific view. This field is primarily used to assign page space objects to a specific page, but it can also be used to restrict model space to a specific view.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool Visible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets an object's visibility.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int WireDensity",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When a surface object is displayed in wireframe, this controls how many isoparametric wires are used. value number of isoparametric wires -1 boundary wires (off) 0 boundary and knot wires 1 boundary and knot wires and, if there are no interior knots, a single interior wire. N>=2 boundary and knot wires and (N+1) interior wires.",
"since": "5.0",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "System.Boolean AddActiveInViewportOverride(System.Guid viewportId, System.Boolean active)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0"
},
{
"signature": "System.Boolean AddHideInDetailOverride(System.Guid detailId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Make this object hidden in a given detail",
"since": "6.1"
},
{
"signature": "System.Void AddToGroup(System.Int32 groupIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Adds object to the group with specified index by appending index to group list. \nIf the object is already in group, nothing is changed.",
"since": "5.0",
"parameters": [
{
"name": "groupIndex",
"type": "System.Int32",
"summary": "The index that will be added."
}
]
},
{
"signature": "System.Void ClearRenderingAttributes()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Clears, or resets the rendering attributes.",
"since": "8.28"
},
{
"signature": "System.Drawing.Color ComputedPlotColor(RhinoDoc document, System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.6"
},
{
"signature": "System.Drawing.Color ComputedPlotColor(RhinoDoc document)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.6"
},
{
"signature": "System.Double ComputedPlotWeight(RhinoDoc document, System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.6"
},
{
"signature": "System.Double ComputedPlotWeight(RhinoDoc document)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.6"
},
{
"signature": "SectionStyle ComputedSectionStyle(RhinoDoc doc, ObjectAttributes sectionerAttributes, System.Boolean computeColors, System.Guid viewport_id)",
"modifiers": ["public"],
"protected": false,
"virtual": false
},
{
"signature": "System.Void DeleteAllUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Boolean DeleteUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Drawing.Color DrawColor(RhinoDoc document, System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets an object's draw color, which is based on the object's color source",
"since": "5.0",
"parameters": [
{
"name": "document",
"type": "RhinoDoc",
"summary": "The object's documnt."
},
{
"name": "viewportId",
"type": "System.Guid",
"summary": "The id of the viewport."
}
],
"returns": "The draw color."
},
{
"signature": "System.Drawing.Color DrawColor(RhinoDoc document)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets an object's draw color, which is based on the object's color source",
"since": "5.0",
"parameters": [
{
"name": "document",
"type": "RhinoDoc",
"summary": "The object's documnt."
}
],
"returns": "The draw color."
},
{
"signature": "ObjectAttributes Duplicate()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a copy of this ObjectAttributes instance.",
"since": "5.0",
"returns": "A new instance on success, or None on failure."
},
{
"signature": "System.Boolean GetActiveInViewportOverrides(out System.Guid[] viewportIds, out System.Boolean active)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0"
},
{
"signature": "Linetype GetCustomLinetype()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get an optional custom linetype associated with these attributes. If null, then the attributes use the linetype index to determine it's linetype",
"since": "8.0"
},
{
"signature": "SectionStyle GetCustomSectionStyle()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get an optional custom section style associated with these attributes.",
"since": "8.0"
},
{
"signature": "System.Guid GetDisplayModeOverride(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the id of the display mode of an objects. Object display modes are view based. Thus, it is possible to have an object display different in different views.",
"since": "6.18",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "Id of a Rhino Viewport."
}
],
"returns": "A display node id if the object has a display mode override for the viewport; otherwise Guid.Empty is returned."
},
{
"signature": "System.Int32[] GetGroupList()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns an array of GroupCount group indices. If GroupCount is zero, then GetGroupList() returns null.",
"since": "5.0",
"returns": "An array of group indices. None might be returned in place of an empty array."
},
{
"signature": "System.Guid[] GetHideInDetailOverrides()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get list of details that this object is supposed to be hidden in",
"since": "6.1"
},
{
"signature": "System.String GetUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a user string.",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve the string."
}
],
"returns": "string associated with the key if successful. None if no key was found."
},
{
"signature": "System.Collections.Specialized.NameValueCollection GetUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets an independent copy of the collection of (user text key, user text value) pairs attached to this object.",
"since": "5.0",
"returns": "A collection of key strings and values strings. This"
},
{
"signature": "System.Boolean HasActiveInViewportOverride(System.Guid viewportId, out System.Boolean active)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0"
},
{
"signature": "System.Boolean HasDisplayModeOverride(System.Guid viewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines if an object has a display mode override for a given viewport.",
"since": "5.0",
"parameters": [
{
"name": "viewportId",
"type": "System.Guid",
"summary": "Id of a Rhino Viewport."
}
],
"returns": "True if the object has a display mode override for the viewport; otherwise, false."
},
{
"signature": "System.Boolean HasHideInDetailOverrideSet(System.Guid detailId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Is this object supposed to be hidden in a given detail",
"since": "6.1"
},
{
"signature": "System.Boolean IsInGroup(System.Int32 groupIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Determines if an object belong to a group or not.",
"since": "8.11",
"parameters": [
{
"name": "groupIndex",
"type": "System.Int32",
"summary": "The index that will be tested."
}
]
},
{
"signature": "Plane ObjectFrame()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Boolean RemoveActiveInViewportOverride(System.Guid viewportId, System.Boolean active)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0"
},
{
"signature": "System.Void RemoveCustomLinetype()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void RemoveCustomSectionStyle()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void RemoveDisplayModeOverride()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "By default, objects are drawn using the display mode of the viewport that the object is being drawn in. Setting a specific display mode, instructs Rhino to always use that display mode, regardless of the viewport's mode. This function resets an object to use the viewport's display mode for all viewports.",
"since": "5.0"
},
{
"signature": "System.Void RemoveDisplayModeOverride(System.Guid rhinoViewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "By default, objects are drawn using the display mode of the viewport that the object is being drawn in. Setting a specific display mode, instructs Rhino to always use that display mode, regardless of the viewport's mode. This function resets an object to use the viewport's display mode.",
"since": "5.0",
"parameters": [
{
"name": "rhinoViewportId",
"type": "System.Guid",
"summary": "viewport that display mode overrides should be cleared from."
}
]
},
{
"signature": "System.Void RemoveFromAllGroups()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Removes object from all groups.",
"since": "5.0"
},
{
"signature": "System.Void RemoveFromGroup(System.Int32 groupIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "removes object from the group with specified index. \nIf the object is not in the group, nothing is changed.",
"since": "5.0",
"parameters": [
{
"name": "groupIndex",
"type": "System.Int32",
"summary": "The index that will be removed."
}
]
},
{
"signature": "System.Boolean RemoveHideInDetailOverride(System.Guid detailId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Remove hidden in detail flag for a specific detail",
"since": "6.1"
},
{
"signature": "System.Boolean SetActiveInViewportOverrides(System.Guid[] viewportIds, System.Boolean active)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0"
},
{
"signature": "System.Void SetCustomLinetype(Linetype linetype)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void SetCustomSectionStyle(SectionStyle sectionStyle)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Boolean SetDisplayModeOverride(Display.DisplayModeDescription mode, System.Guid rhinoViewportId)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "By default, objects are drawn using the display mode of the viewport that the object is being drawn in. Setting a specific display mode, instructs Rhino to always use that display mode, regardless of the viewport's mode. This version sets a display mode for a specific viewport.",
"since": "5.0",
"parameters": [
{
"name": "mode",
"type": "Display.DisplayModeDescription",
"summary": "The display mode."
},
{
"name": "rhinoViewportId",
"type": "System.Guid",
"summary": "The Rhino viewport ID."
}
],
"returns": "True on success."
},
{
"signature": "System.Boolean SetDisplayModeOverride(Display.DisplayModeDescription mode)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "By default, objects are drawn using the display mode of the viewport that the object is being drawn in. Setting a specific display mode, instructs Rhino to always use that display mode, regardless of the viewport's mode. This version affects the object's display mode for all viewports.",
"since": "5.0",
"parameters": [
{
"name": "mode",
"type": "Display.DisplayModeDescription",
"summary": "The display mode."
}
],
"returns": "True if setting was successful."
},
{
"signature": "System.Void SetObjectFrame(Plane plane)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Void SetObjectFrame(Transform xform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Boolean SetUserString(System.String key, System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Attach a user string (key,value combination) to this geometry.",
"since": "5.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve this string."
},
{
"name": "value",
"type": "System.String",
"summary": "string associated with key. If null, the key will be removed"
}
],
"returns": "True on success."
},
{
"signature": "System.Boolean Transform(Transform xform)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Apply a transformation.",
"since": "6.0",
"parameters": [
{
"name": "xform",
"type": "Transform",
"summary": "The transformation."
}
],
"returns": "True if successful, False otherwise."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectAttributes.ObjectFrameFlags",
"dataType": "enum",
"since": "8.0",
"values": [
{
"signature": "Standard = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Never returns unset plane. Will always calculate the plane even if nothing is stored."
},
{
"signature": "IncludeScaleTransforms = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "By default, the plane is orientation and rotation only. But scale transforms are stored if you need them."
},
{
"signature": "ReturnUnset = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "The object frame may be stored unset by default. If this is the case, and you want to know if it really is unset, this will tell you."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectColorSource",
"dataType": "enum",
"summary": "Defines enumerated values for the source of display color of single objects.",
"since": "5.0",
"values": [
{
"signature": "ColorFromLayer = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "use color assigned to layer."
},
{
"signature": "ColorFromObject = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "use color assigned to object."
},
{
"signature": "ColorFromMaterial = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "use diffuse render material color."
},
{
"signature": "ColorFromParent = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "for objects with parents (like objects in instance references, use parent linetype) if no parent, treat as color_from_layer."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectDecoration",
"dataType": "enum",
"summary": "Defines bit mask values to represent object decorations.",
"since": "5.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "There are no object decorations."
},
{
"signature": "StartArrowhead = 0x08",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Arrow head at start."
},
{
"signature": "EndArrowhead = 0x10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Arrow head at end."
},
{
"signature": "BothArrowhead = 0x18",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Arrow head at start and end."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectEnumeratorSettings",
"dataType": "class",
"summary": "Settings used for getting an enumerator of objects in a document. See ObjectTable.FindByFilter(ObjectEnumeratorSettings) , ObjectTable.GetObjectsByType{T}(ObjectEnumeratorSettings) , and ObjectTable.GetEnumerator(ObjectEnumeratorSettings) .",
"constructors": [
{
"signature": "ObjectEnumeratorSettings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs object enumerator settings that will iterate the document looking for normal object and locked object that are active, or part of current model and saved in file.",
"since": "5.0"
}
],
"properties": [
{
"signature": "bool ActiveObjects",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When true, objects that are part of current model and saved in file are returned.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "Type ClassTypeFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool DeletedObjects",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When true, deleted objects are returned.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool HiddenObjects",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When true, hidden objects or objects on hidden layers are returned.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool IdefObjects",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When true, objects in instance definitions (not the instance references) are returned.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool IncludeGrips",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The default object enumerator settings will not iterate through grip objects. If you want the iterator to include grips, then set this property to true.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool IncludeLights",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The default object enumerator settings will not iterate through render light objects. If you want the iterator to include lights, then set this property to true.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool IncludePhantoms",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The default object enumerator settings will not iterate through phantom objects. If you want the iterator to include phantom objects, then set this property to true.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int LayerIndexFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The layer filter property can be used to limit the iteration to objects on a specific layer. The default is to iterate through all layers.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool LockedObjects",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When true, locked objects or objects on locked layers are returned.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "int MaterialIndexFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The material filter property can be used to limit the iteration to objects that use a specific material. The default is to iterate through all objects no matter the material assignment.",
"since": "8.25",
"property": ["get", "set"]
},
{
"signature": "string NameFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The name filter property can be used to limit the iteration to objects with a specific name.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool NormalObjects",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When true, normal objects (e.g. not locked and not hidden) are returned.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ObjectType ObjectTypeFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The object type filter property can be used to limit the iteration to specific types of geometry. The default is to iterate all objects types.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool ReferenceObjects",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When true, objects that are for reference and not saved in file are returned.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool SelectedObjectsFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The default object enumerator settings ignore the selected state of objects. If you want the iterator to limit itself to selected objects, then set this property to true.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ActiveSpace SpaceFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The viewport filter property can be used to limit the iteration to objects that reside on specific space.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool SubObjectSelected",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If True then objects which only have a sub object selected will be included. This is False by default.",
"since": "7.3",
"property": ["get", "set"]
},
{
"signature": "bool UseFastSelection",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When SelectedObjectsFilter is true, enables an optimized iterator that walks only the document's selected objects rather than scanning the whole object table. Use this for selection-driven UI that re-queries on every selection change (e.g. panel enable-state). Only valid for the current selection set: do not use it while selection is actively changing. Ignored unless SelectedObjectsFilter is also true.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "RhinoViewport ViewportFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The viewport filter property can be used to limit the iteration to objects that are active in a specific viewport.",
"since": "5.6",
"property": ["get", "set"]
},
{
"signature": "bool VisibleFilter",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The default object enumerator settings ignore the visibility state of objects. If you want the iterator to limit itself to visible objects, then set this property to true.",
"since": "5.0",
"property": ["get", "set"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectLinetypeSource",
"dataType": "enum",
"summary": "Defines enumerated values for the source of linetype of single objects.",
"since": "5.0",
"values": [
{
"signature": "LinetypeFromLayer = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "use line style assigned to layer."
},
{
"signature": "LinetypeFromObject = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "use line style assigned to object."
},
{
"signature": "LinetypeFromParent = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "for objects with parents (like objects in instance references, use parent linetype) if not parent, treat as linetype_from_layer."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectMaterialSource",
"dataType": "enum",
"summary": "Defines enumerated values for the source of material of single objects.",
"since": "5.0",
"values": [
{
"signature": "MaterialFromLayer = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "use material assigned to layer."
},
{
"signature": "MaterialFromObject = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "use material assigned to object."
},
{
"signature": "MaterialFromParent = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "for objects with parents, like definition geometry in instance references and faces in polysurfaces, this value indicates the material definition should come from the parent. If the object does not have an obvious \"parent\", then treat it the same as material_from_layer."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectMode",
"dataType": "enum",
"summary": "Defines enumerated values for the display and behavior of single objects.",
"since": "5.0",
"values": [
{
"signature": "Normal = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Object mode comes from layer."
},
{
"signature": "Hidden = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Not visible, object cannot be selected or changed."
},
{
"signature": "Locked = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Visible, object cannot be selected or changed."
},
{
"signature": "InstanceDefinitionObject = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Object is part of an InstanceDefinition. The InstanceDefinition m_object_uuid[] array will contain this object attribute's id."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectPlotColorSource",
"dataType": "enum",
"summary": "Defines enumerated values for the source of plotting/printing color of single objects.",
"since": "5.0",
"values": [
{
"signature": "PlotColorFromLayer = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "use plot color assigned to layer."
},
{
"signature": "PlotColorFromObject = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "use plot color assigned to object."
},
{
"signature": "PlotColorFromDisplay = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "use display color."
},
{
"signature": "PlotColorFromParent = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "for objects with parents (like objects in instance references, use parent plot color) if no parent, treat as plot_color_from_layer."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectPlotWeightSource",
"dataType": "enum",
"summary": "Defines enumerated values for the source of plotting/printing weight of single objects.",
"since": "5.0",
"values": [
{
"signature": "PlotWeightFromLayer = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "use plot color assigned to layer."
},
{
"signature": "PlotWeightFromObject = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "use plot color assigned to object."
},
{
"signature": "PlotWeightFromParent = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "for objects with parents (like objects in instance references, use parent plot color) if no parent, treat as plot_color_from_layer."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectSectionAttributesSource",
"dataType": "enum",
"summary": "The source of sectioning attributes on an object.",
"since": "8.0",
"values": [
{
"signature": "FromLayer = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Section attributes defined by object's layer"
},
{
"signature": "FromObject = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Section attributes are specific to the object"
},
{
"signature": "FromParent = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Section attributes defined by object's parent"
},
{
"signature": "FromSectioner = 3",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Section attributes defined by the cutting object"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectSectionFillRule",
"dataType": "enum",
"summary": "For sectioning an object; the decision of when to generate hatches and fills.",
"since": "8.0",
"values": [
{
"signature": "ClosedCurves = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "If a the section results in a closed curve, then generate a fill"
},
{
"signature": "SolidObjects = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Only generate a fill for objects that are considered Solid"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjectType",
"dataType": "enum",
"summary": "Defines binary mask values for each object type that can be found in a document.",
"since": "5.0",
"values": [
{
"signature": "None = 0",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Nothing."
},
{
"signature": "Point = 1",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A point."
},
{
"signature": "PointSet = 2",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A point set or cloud."
},
{
"signature": "Curve = 4",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A curve."
},
{
"signature": "Surface = 8",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A surface."
},
{
"signature": "Brep = 0x10",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A brep."
},
{
"signature": "Mesh = 0x20",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A mesh."
},
{
"signature": "Light = 0x100",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A rendering light."
},
{
"signature": "Annotation = 0x200",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "An annotation."
},
{
"signature": "InstanceDefinition = 0x800",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A block definition."
},
{
"signature": "InstanceReference = 0x1000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A block reference."
},
{
"signature": "TextDot = 0x2000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A text dot."
},
{
"signature": "Grip = 0x4000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Selection filter value - not a real object type."
},
{
"signature": "Detail = 0x8000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A detail."
},
{
"signature": "Hatch = 0x10000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A hatch."
},
{
"signature": "MorphControl = 0x20000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A morph control."
},
{
"signature": "SubD = 0x40000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A SubD object."
},
{
"signature": "BrepLoop = 0x80000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A brep loop."
},
{
"signature": "BrepVertex = 0x100000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "a brep vertex."
},
{
"signature": "PolysrfFilter = 0x200000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Selection filter value - not a real object type."
},
{
"signature": "EdgeFilter = 0x400000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Selection filter value - not a real object type."
},
{
"signature": "PolyedgeFilter = 0x800000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "Selection filter value - not a real object type."
},
{
"signature": "MeshVertex = 0x01000000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A mesh vertex."
},
{
"signature": "MeshEdge = 0x02000000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A mesh edge."
},
{
"signature": "MeshFace = 0x04000000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A mesh face."
},
{
"signature": "Cage = 0x08000000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A cage."
},
{
"signature": "Phantom = 0x10000000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A phantom object."
},
{
"signature": "ClipPlane = 0x20000000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "A clipping plane."
},
{
"signature": "Extrusion = 0x40000000",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "An extrusion."
},
{
"signature": "AnyObject = 0xFFFFFFFF",
"modifiers": [],
"protected": false,
"virtual": false,
"summary": "All bits set."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ObjRef",
"dataType": "class",
"summary": "Represents a reference to a Rhino object.",
"interfaces": ["IDisposable"],
"constructors": [
{
"signature": "ObjRef(Guid id, ComponentIndex ci)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new object reference from a guid and component index. The component index is used to specify a \"piece\" of the geometry",
"since": "7.0",
"deprecated": "7.6",
"obsolete": "Use version that takes a document.",
"parameters": [
{
"name": "id",
"type": "System.Guid",
"summary": "The object's Id"
},
{
"name": "ci",
"type": "Geometry.ComponentIndex",
"summary": "a portion of the object"
}
]
},
{
"signature": "ObjRef(Guid id)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new object reference from a globally unique identifier ( Guid ).",
"since": "5.0",
"deprecated": "7.6",
"obsolete": "Use version that takes a document.",
"parameters": [
{
"name": "id",
"type": "System.Guid",
"summary": "The ID."
}
]
},
{
"signature": "ObjRef(ObjRef other)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Copy constructor",
"since": "7.0"
},
{
"signature": "ObjRef(RhinoDoc doc, Guid id, ComponentIndex ci)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new object reference from a guid and component index. The component index is used to specify a \"piece\" of the geometry",
"since": "7.6",
"parameters": [
{
"name": "doc",
"type": "RhinoDoc",
"summary": "The Rhino document"
},
{
"name": "id",
"type": "System.Guid",
"summary": "The object's Id"
},
{
"name": "ci",
"type": "Geometry.ComponentIndex",
"summary": "a portion of the object"
}
]
},
{
"signature": "ObjRef(RhinoDoc doc, Guid id)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new object reference from a globally unique identifier ( Guid ).",
"since": "7.6",
"parameters": [
{
"name": "doc",
"type": "RhinoDoc",
"summary": "The Rhino document"
},
{
"name": "id",
"type": "System.Guid",
"summary": "The ID."
}
]
},
{
"signature": "ObjRef(RhinoObject rhinoObject, PickContext pickContext)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initialized a new object reference from a Rhino object and pick context",
"since": "5.0"
},
{
"signature": "ObjRef(RhinoObject rhinoObject)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Initializes a new object reference from a Rhino object.",
"since": "5.0",
"parameters": [
{
"name": "rhinoObject",
"type": "RhinoObject",
"summary": "The Rhino object."
}
]
}
],
"properties": [
{
"signature": "RhinoDoc Document",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the document that owns this object reference.",
"since": "8.0",
"property": ["get"]
},
{
"signature": "ComponentIndex GeometryComponentIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the component index of the referenced (sub) geometry. Some objects have sub-objects that are valid pieces of geometry. For example, breps have edges and faces that are valid curves and surfaces. Each sub-object has a component index that is > 0. The parent geometry has a component index = -1.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid ObjectId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the id of the referenced Rhino object.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "uint RuntimeSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If > 0, then this is the value of a Rhino object's serial number field. The serial number is used instead of the pointer to prevent crashes in cases when the RhinoObject is deleted but an ObjRef continues to reference the Rhino object. The value of RuntimeSerialNumber is not saved in archives because it generally changes if you save and reload an archive.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "Brep Brep()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the brep if this reference geometry is one.",
"since": "5.0",
"returns": "A boundary representation; or None on error."
},
{
"signature": "ClippingPlaneSurface ClippingPlaneSurface()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the clipping plane surface if this reference targeted one.",
"since": "5.0",
"returns": "A clipping plane surface, or None if this reference targeted something else."
},
{
"signature": "Curve Curve()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the curve if this reference targeted one.",
"since": "5.0",
"returns": "A curve, or None if this reference targeted something else."
},
{
"signature": "Curve CurveParameter(out System.Double parameter)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If the reference geometry is a curve or edge with a selection point, then this gets the parameter of the selection point.",
"since": "5.0",
"remarks": "If a curve was selected and CurveParameter is called and the SelectionMethod() is not 1 (point pick on object), the curve will be returned and parameter will be set to the start parameter of the picked curve. This can be misleading so it may be necessary to call SelectionMethod() first, before calling CurveParameter to get the desired information.",
"parameters": [
{
"name": "parameter",
"type": "System.Double",
"summary": "The parameter of the selection point."
}
],
"returns": "If the selection point was on a curve or edge, then the curve/edge is returned, otherwise null."
},
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Actively reclaims unmanaged resources that this instance uses.",
"since": "5.0"
},
{
"signature": "System.Void Dispose(System.Boolean disposing)",
"modifiers": ["protected", "virtual"],
"protected": true,
"virtual": true,
"summary": "For derived class implementers. \nThis method is called with argument True when class user calls Dispose(), while with argument False when the Garbage Collector invokes the finalizer, or Finalize() method. \nYou must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true. \nAlso, you must call the base virtual method within your overriding method.",
"parameters": [
{
"name": "disposing",
"type": "System.Boolean",
"summary": "True if the call comes from the Dispose() method; False if it comes from the Garbage Collector finalizer."
}
]
},
{
"signature": "BrepEdge Edge()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the edge if this reference geometry is one.",
"since": "5.0",
"returns": "A boundary representation edge; or None on error."
},
{
"signature": "BrepFace Face()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If the referenced geometry is a brep face, a brep with one face, or a surface, this returns the brep face.",
"since": "5.0",
"returns": "A boundary representation face; or None on error."
},
{
"signature": "GeometryBase Geometry()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the geometry linked to the object targeted by this reference.",
"since": "5.0",
"returns": "The geometry."
},
{
"signature": "Hatch Hatch()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the hatch if the referenced geometry is one.",
"since": "5.0",
"returns": "A hatch; or None if the referenced object is not a hatch"
},
{
"signature": "RhinoObject InstanceDefinitionPart()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If sub-object selection is enabled and a piece of an instance reference is selected, this will return the selected piece.",
"since": "6.0"
},
{
"signature": "Light Light()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the light if the referenced geometry is one.",
"since": "5.0",
"returns": "A light; or None if the referenced object is not a light, or on error."
},
{
"signature": "Mesh Mesh()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the mesh if the referenced geometry is one.",
"since": "5.0",
"returns": "A mesh; or None if the referenced object is not a mesh, or on error."
},
{
"signature": "RhinoObject Object()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns the referenced Rhino object.",
"since": "5.0"
},
{
"signature": "Point Point()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the point if the referenced geometry is one.",
"since": "5.0",
"returns": "A point; or None if the referenced object is not a point, or on error."
},
{
"signature": "PointCloud PointCloud()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the point cloud if the referenced geometry is one.",
"since": "5.0",
"returns": "A point cloud; or None if the referenced object is not a point cloud, or on error."
},
{
"signature": "SelectionMethod SelectionMethod()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the method used to select this object.",
"since": "5.0",
"returns": "The method used to select this object."
},
{
"signature": "Point3d SelectionPoint()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If the object was selected by picking a point on it, then SelectionPoint() returns the point where the selection occurred, otherwise it returns Point3d.Unset.",
"since": "5.0",
"returns": "The point where the selection occurred or Point3d.Unset on failure."
},
{
"signature": "RhinoView SelectionView()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If the object was interactively selected in a particular viewport, then SelectionView() returns the view where the object was selected.",
"since": "6.5"
},
{
"signature": "System.UInt32 SelectionViewDetailSerialNumber()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If the object was interactively selected in a page space detail view, then SelectionViewDetailSerialNumber() returns the CRhinoObject serial number of the detail view object. Use SelectionView() to get the page view that contains the detail view object. If SelectionViewDetailSerialNumber() returns 0, then the selection did not happen in a detail view.",
"since": "6.5"
},
{
"signature": "System.Void SetSelectionComponent(ComponentIndex componentIndex)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "When an object is selected by picking a sub-object, SetSelectionComponent may be used to identify the sub-object.",
"since": "5.0"
},
{
"signature": "SubD SubD()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the SubD if the referenced geometry is one.",
"since": "7.0",
"returns": "A SubD; or None if the referenced object is not a SubD, or on error."
},
{
"signature": "SubDEdge SubDEdge()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the SubDEdge if the referenced geometry is one.",
"since": "8.15",
"returns": "A SubDEdge; or None if the referenced object is not a SubDEdge, or on error."
},
{
"signature": "SubDFace SubDFace()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the SubDFace if the referenced geometry is one.",
"since": "7.0",
"returns": "A SubDFace; or None if the referenced object is not a SubDFace, or on error."
},
{
"signature": "SubDVertex SubDVertex()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the SubDVertex if the referenced geometry is one.",
"since": "8.15",
"returns": "A SubDVertex; or None if the referenced object is not a SubDVertex, or on error."
},
{
"signature": "Surface Surface()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the surface if the referenced geometry is one.",
"since": "5.0",
"returns": "A surface; or None if the referenced object is not a surface, or on error."
},
{
"signature": "Surface SurfaceParameter(out System.Double u, out System.Double v)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If the reference geometry is a surface, brep with one face, or surface edge with a selection point, then this gets the surface parameters of the selection point.",
"since": "5.0",
"parameters": [
{
"name": "u",
"type": "System.Double",
"summary": "The U value is assigned to this out parameter during the call."
},
{
"name": "v",
"type": "System.Double",
"summary": "The V value is assigned to this out parameter during the call."
}
],
"returns": "If the selection point was on a surface, then the surface is returned."
},
{
"signature": "TextDot TextDot()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the text dot if the referenced geometry is one.",
"since": "5.0",
"returns": "A text dot; or None if the referenced object is not a text dot, or on error."
},
{
"signature": "TextEntity TextEntity()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the text entity if the referenced geometry is one.",
"since": "5.0",
"returns": "A text entity; or None if the referenced object is not a text entity, or on error."
},
{
"signature": "BrepTrim Trim()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "If the referenced geometry is an edge of a surface, this returns the associated brep trim.",
"since": "5.8",
"returns": "A boundary representation trim; or None on error"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "OrdinateDimensionObject",
"dataType": "class",
"summary": "Rhino Object that represents an ordinate dimension geometry and attributes",
"baseclass": "Rhino.DocObjects.DimensionObject",
"properties": [
{
"signature": "OrdinateDimension OrdinateDimensionGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the dimension geometry for this object.",
"since": "6.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "PageViewGroup",
"dataType": "class",
"summary": "PageView Group class",
"baseclass": "Rhino.DocObjects.ModelComponent",
"since": "9.0",
"constructors": [
{
"signature": "PageViewGroup()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Constructs a new page view group.",
"since": "9.0"
}
],
"properties": [
{
"signature": "ComponentStatus ComponentStatus",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the status of the page view group.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns ModelComponentType.Group .",
"since": "9.0",
"property": ["get"]
},
{
"signature": "string Description",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets and sets a brief description of the page view group.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "bool IsExpanded",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the expanded state of the page view group.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int MemberCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the number of page views that are members of this page view group.",
"since": "9.0",
"property": ["get"]
},
{
"signature": "string Name",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the name of this page view group.",
"since": "9.0",
"property": ["get", "set"]
},
{
"signature": "int SortIndex",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the runtime index used to sort page view groups.",
"since": "9.0",
"property": ["get"]
},
{
"signature": "int UserStringCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the amount of user strings.",
"since": "9.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Void CopyAttributesFrom(PageViewGroup src)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Copy attributes from another page view group.",
"since": "9.0"
},
{
"signature": "System.Void DeleteAllUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0"
},
{
"signature": "System.Boolean DeleteUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0"
},
{
"signature": "RhinoPageView[] GetMembers()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get an array of all of the page views in this page view group.",
"since": "9.0",
"returns": "Array page views if successful, otherwise an empty array."
},
{
"signature": "System.String GetUserString(System.String key)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets user string from this component.",
"since": "9.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve the string."
}
],
"returns": "string associated with the key if successful. None if no key was found."
},
{
"signature": "System.Collections.Specialized.NameValueCollection GetUserStrings()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets a copy of all (user key string, user value string) pairs attached to this component.",
"since": "9.0",
"returns": "A new collection."
},
{
"signature": "System.Boolean SetUserString(System.String key, System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Attach a user string (key,value combination) to this component.",
"since": "9.0",
"parameters": [
{
"name": "key",
"type": "System.String",
"summary": "id used to retrieve this string."
},
{
"name": "value",
"type": "System.String",
"summary": "string associated with key."
}
],
"returns": "True on success."
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "PhysicallyBasedMaterial",
"dataType": "class",
"properties": [
{
"signature": "double Alpha",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.1",
"property": ["get", "set"]
},
{
"signature": "double Anisotropic",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double AnisotropicRotation",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Color4f BaseColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "BRDFs BRDF",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double Clearcoat",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double ClearcoatRoughness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Color4f Emission",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Material Material",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get"]
},
{
"signature": "double Metallic",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double Opacity",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double OpacityIOR",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double OpacityRoughness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double ReflectiveIOR",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double Roughness",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double Sheen",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double SheenTint",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double Specular",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double SpecularTint",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double Subsurface",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "Color4f SubsurfaceScatteringColor",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "double SubsurfaceScatteringRadius",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0",
"property": ["get", "set"]
},
{
"signature": "bool UseBaseColorTextureAlphaForObjectAlphaTransparencyTexture",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.1",
"property": ["get", "set"]
}
],
"methods": [
{
"signature": "DocObjects.Texture GetTexture(DocObjects.TextureType which)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the texture that corresponds with the specified texture type for this material.",
"since": "7.0"
},
{
"signature": "DocObjects.Texture[] GetTextures()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get array of textures that this material uses",
"since": "7.0"
},
{
"signature": "System.Boolean SetTexture(DocObjects.Texture texture, DocObjects.TextureType which)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Set the texture that corresponds with the specified texture type for this material.",
"since": "7.0",
"parameters": [
{
"name": "texture",
"type": "DocObjects.Texture",
"summary": "An instance of Rhino.DocObjects.Texture"
},
{
"name": "which",
"type": "DocObjects.TextureType",
"summary": "Use Rhino.DocObjects.TextureType"
}
]
},
{
"signature": "System.Void SynchronizeLegacyMaterial()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.0"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "PhysicallyBasedMaterial.BRDFs",
"dataType": "enum",
"since": "7.0",
"values": [
{
"signature": "GGX = 0",
"modifiers": [],
"protected": false,
"virtual": false
},
{
"signature": "Ward = 1",
"modifiers": [],
"protected": false,
"virtual": false
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "PointCloudObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "PointCloud PointCloudGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "PointCloud DuplicatePointCloudGeometry()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "PointObject",
"dataType": "class",
"baseclass": "Rhino.DocObjects.RhinoObject",
"properties": [
{
"signature": "Point PointGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "Point DuplicatePointGeometry()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ProxyObject",
"dataType": "class",
"summary": "A proxy object (not saved in files)",
"baseclass": "Rhino.DocObjects.RhinoObject",
"methods": [
{
"signature": "System.Int32 CreateMeshes(MeshType meshType, MeshingParameters parameters, System.Boolean ignoreCustomParameters)",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "7.0"
},
{
"signature": "Mesh[] GetMeshes(MeshType meshType)",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"since": "7.0"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "RadialDimensionObject",
"dataType": "class",
"summary": "Rhino Object that represents a radial dimension geometry and attributes",
"baseclass": "Rhino.DocObjects.DimensionObject",
"properties": [
{
"signature": "RadialDimension RadialDimensionGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Get the dimension geometry for this object.",
"since": "6.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ReplayHistoryData",
"dataType": "class",
"summary": "Provides history information to commands that will repeat history construction. Generally, a developer using this class will not construct a new instance, but receive one.",
"interfaces": ["IDisposable"],
"properties": [
{
"signature": "RhinoDoc Document",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The document this record belongs to",
"since": "5.0",
"property": ["get"]
},
{
"signature": "int HistoryVersion",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "ReplayHistory overrides check the version number to ensure the information saved in the history record is compatible with the current implementation of ReplayHistory",
"since": "5.0",
"property": ["get"]
},
{
"signature": "Guid RecordId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Each history record has a unique id that Rhino assigns when it adds the history record to the history record table",
"since": "5.0",
"property": ["get"]
},
{
"signature": "ReplayHistoryResult[] Results",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Provides access to BOTH inputs and outputs of the replay history operation. \nUse this property to then call an appropriate UpdateToX() method and make your custom history support work.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "ReplayHistoryResult AppendHistoryResult()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Create an empty history result and add it to the end of the Results array. Note that you should call Results again if you need them as the old Results array will be out of sync with this class.",
"since": "8.0"
},
{
"signature": "System.Void Dispose()",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "Rhino.DocObjects.ObjRef GetRhinoObjRef(System.Int32 id)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "In ReplayHistory, use GetRhinoObjRef to convert the information in a history record into the ObjRef that has up to date RhinoObject pointers",
"since": "5.0",
"parameters": [
{
"name": "id",
"type": "System.Int32",
"summary": "HistoryRecord value id"
}
],
"returns": "ObjRef on success, None if not successful"
},
{
"signature": "System.Boolean TryGetBool(System.Int32 id, out System.Boolean value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean TryGetColor(System.Int32 id, out System.Drawing.Color value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean TryGetDouble(System.Int32 id, out System.Double value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean TryGetDoubles(System.Int32 id, out System.Double[] values)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.10"
},
{
"signature": "System.Boolean TryGetGuid(System.Int32 id, out System.Guid value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean TryGetGuids(System.Int32 id, out System.Guid[] values)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "8.0"
},
{
"signature": "System.Boolean TryGetInt(System.Int32 id, out System.Int32 value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean TryGetInts(System.Int32 id, out System.Int32[] values)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "9.0"
},
{
"signature": "System.Boolean TryGetPoint3d(System.Int32 id, out Geometry.Point3d value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean TryGetPoint3dOnObject(System.Int32 id, out Geometry.Point3d value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0"
},
{
"signature": "System.Boolean TryGetString(System.Int32 id, out System.String value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean TryGetTransform(System.Int32 id, out Geometry.Transform value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean TryGetVector3d(System.Int32 id, out Geometry.Vector3d value)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Void UpdateResultArray(IEnumerable newResults)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Update the Results array with a different set of values. Null entries in the newResults will result in empty ReplayHistoryResult elements",
"since": "8.0"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "ReplayHistoryResult",
"dataType": "class",
"properties": [
{
"signature": "RhinoObject ExistingObject",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The previously existing object. \nDo not attempt to edit this object. It might have been already deleted by, for example, dragging.",
"since": "5.0",
"property": ["get"]
}
],
"methods": [
{
"signature": "System.Boolean UpdateToAngularDimension(Geometry.AngularDimension dimension, ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToArc(Geometry.Arc arc, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToBrep(Geometry.Brep brep, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToCircle(Geometry.Circle circle, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToClippingPlane(Geometry.Plane plane, System.Double uMagnitude, System.Double vMagnitude, IEnumerable clippedViewportIds, ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToClippingPlane(Geometry.Plane plane, System.Double uMagnitude, System.Double vMagnitude, System.Guid clippedViewportId, ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToCurve(Geometry.Curve curve, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToEllipse(Geometry.Ellipse ellipse, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToExtrusion(Geometry.Extrusion extrusion, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToHatch(Geometry.Hatch hatch, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToInstanceReferenceGeometry(Geometry.InstanceReferenceGeometry instanceReference, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.30"
},
{
"signature": "System.Boolean UpdateToLeader(Geometry.Leader leader, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToLine(Geometry.Point3d from, Geometry.Point3d to, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToLinearDimension(Geometry.LinearDimension dimension, ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToMesh(Geometry.Mesh mesh, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToPoint(Rhino.Geometry.Point3d point, ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToPointCloud(IEnumerable points, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToPointCloud(Rhino.Geometry.PointCloud cloud, ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToPolyline(IEnumerable points, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToRadialDimension(Geometry.RadialDimension dimension, ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToSphere(Geometry.Sphere sphere, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToSubD(Geometry.SubD subD, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "7.18"
},
{
"signature": "System.Boolean UpdateToSurface(Geometry.Surface surface, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToText(Geometry.TextEntity text, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToText(System.String text, Geometry.Plane plane, System.Double height, System.String fontName, System.Boolean bold, System.Boolean italic, Geometry.TextJustification justification, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
},
{
"signature": "System.Boolean UpdateToTextDot(Geometry.TextDot dot, DocObjects.ObjectAttributes attributes)",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0"
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "RhinoAfterTransformObjectsEventArgs",
"dataType": "class",
"summary": "EventArgs passed to RhinoDoc.AfterTransform.",
"baseclass": "EventArgs",
"since": "8.15",
"properties": [
{
"signature": "uint TransformEventId",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The transformation event id.",
"since": "8.15",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "RhinoDeselectAllObjectsEventArgs",
"dataType": "class",
"baseclass": "EventArgs",
"properties": [
{
"signature": "RhinoDoc Document",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "int ObjectCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "RhinoModifyObjectAttributesEventArgs",
"dataType": "class",
"baseclass": "EventArgs",
"properties": [
{
"signature": "RhinoDoc Document",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "uint DocumentSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "The document runtime serial number.",
"since": "9.0",
"property": ["get"]
},
{
"signature": "ObjectAttributes NewAttributes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "ObjectAttributes OldAttributes",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
},
{
"signature": "RhinoObject RhinoObject",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "5.0",
"property": ["get"]
}
]
},
{
"namespace": "Rhino.DocObjects",
"name": "RhinoObject",
"dataType": "class",
"summary": "Represents an object in the document. \nRhinoObjects should only ever be creatable by the RhinoDoc.",
"baseclass": "Rhino.DocObjects.ModelComponent",
"properties": [
{
"signature": "uint NextRuntimeSerialNumber",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Gets the runtime serial number that will be assigned to the next Rhino Object that is created.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "ObjectAttributes Attributes",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Gets or sets the object attributes.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ModelComponentType ComponentType",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Returns ModelComponentType.ModelGeometry .",
"since": "6.0",
"property": ["get"]
},
{
"signature": "RhinoDoc Document",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the document that owns this object.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "GeometryBase Geometry",
"modifiers": ["public", "virtual"],
"protected": false,
"virtual": true,
"summary": "Gets the underlying geometry for this object. \nAll rhino objects are composed of geometry and attributes.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool GripsOn",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets or sets the activation state of object default editing grips.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool GripsSelected",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True if grips are turned on and at least one is selected.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "int GroupCount",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Number of groups object belongs to.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool HasDynamicTransform",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True if the object has a dynamic transformation",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool HasSubobjectMaterials",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Will be True if the object contains sub object meshes with materials that are different than the top level object.",
"since": "6.0",
"property": ["get"]
},
{
"signature": "Guid Id",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Every object has a Guid (globally unique identifier, also known as UUID, or universally unique identifier). The default value is Guid.Empty. \nWhen an object is added to a model, the value is checked. If the value is Guid.Empty, a new Guid is created. If the value is not None but it is already used by another object in the model, a new Guid is created. If the value is not Guid.Empty and it is not used by another object in the model, then that value persists. When an object is updated, by a move for example, the value of ObjectId persists. \nThis value is the same as the one returned by this.Attributes.ObjectId.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "uint InstanceDefinitionModelSerialNumber",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "When a component is in a model as part of the information required for a linked instance definition, this value identifies the linked instance definition reference model.",
"since": "6.12",
"remarks": "Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.",
"property": ["get"]
},
{
"signature": "bool IsDeletable",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Some objects cannot be deleted, like grips on lights and annotation objects.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "bool IsDeleted",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "True if the object is deleted. Deleted objects are kept by the document for undo purposes. Call RhinoDoc.UndeleteObject to undelete an object.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsHidden",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "An object must be in one of three modes: normal, locked or hidden. If an object is in normal mode, then the object's layer controls visibility and selectability. If an object is locked, then the object's layer controls visibility by the object cannot be selected. If the object is hidden, it is not visible and it cannot be selected.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsInstanceDefinitionGeometry",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "True if the object is used as part of an instance definition.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsLocked",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "An object must be in one of three modes: normal, locked or hidden. If an object is in normal mode, then the object's layer controls visibility and selectability. If an object is locked, then the object's layer controls visibility by the object cannot be selected. If the object is hidden, it is not visible and it cannot be selected.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsNormal",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "An object must be in one of three modes: normal, locked or hidden. If an object is in normal mode, then the object's layer controls visibility and selectability. If an object is locked, then the object's layer controls visibility by the object cannot be selected. If the object is hidden, it is not visible and it cannot be selected.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsPictureFrame",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if the object is a picture frame. A picture frame object is an object that displays a texture map in all views.",
"since": "7.9",
"property": ["get"]
},
{
"signature": "bool IsReference",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Gets a value indicating if an object is a reference object. An object from a work session reference model is a reference object and cannot be modified. An object is a reference object if, and only if, it is on a reference layer.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "bool IsSolid",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Returns True if object is a closed solid, otherwise false.",
"since": "7.6",
"property": ["get"]
},
{
"signature": "string Name",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "Rhino objects have optional text names. More than one object in a model can have the same name and some objects may have no name.",
"since": "5.0",
"property": ["get", "set"]
},
{
"signature": "ObjectType ObjectType",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the Rhino-based object type.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "uint ReferenceModelSerialNumber",
"modifiers": ["public", "override"],
"protected": false,
"virtual": false,
"summary": "When a component is in a model for reference, this value identifies the reference model.",
"since": "6.12",
"remarks": "Reference components are not saved in .3dm archives. Typically this value is set and locked by the code that adds a component to a model. This value is not saved in .3dm archives.",
"property": ["get"]
},
{
"signature": "RenderMaterial RenderMaterial",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the render material associated with this object or None if there is none. This does not pay attention to the material source and will not check parent objects or layers for a RenderMaterial.",
"since": "5.7",
"property": ["get", "set"]
},
{
"signature": "uint RuntimeSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the objects runtime serial number.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "ComponentIndex[] SubobjectMaterialComponents",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"since": "6.0",
"property": ["get"]
},
{
"signature": "bool Visible",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Gets the object visibility.",
"since": "5.0",
"property": ["get"]
},
{
"signature": "uint WorksessionReferenceSerialNumber",
"modifiers": ["public"],
"protected": false,
"virtual": false,
"summary": "Obsolete - use ReferenceModelSerialNumber",
"since": "6.3",
"property": ["get"]
}
],
"methods": [
{
"signature": "RhinoObject FromRuntimeSerialNumber(System.UInt32 serialNumber)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Get a Rhino object for a unique runtime serial number",
"since": "6.0"
},
{
"signature": "Brep[] GetFillSurfaces(RhinoObject rhinoObject, ClippingPlaneObject clippingPlaneObject)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Return list of fill surfaces if any for object and clipping plane.",
"since": "6.7",
"parameters": [
{
"name": "rhinoObject",
"type": "RhinoObject",
"summary": "Object to clip"
},
{
"name": "clippingPlaneObject",
"type": "ClippingPlaneObject",
"summary": "Clipping plane to use"
}
]
},
{
"signature": "Brep[] GetFillSurfaces(RhinoObject rhinoObject, IEnumerable clippingPlaneObjects, System.Boolean unclippedFills)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Return list of fill surfaces if any for object and clipping plane.",
"since": "6.7",
"parameters": [
{
"name": "rhinoObject",
"type": "RhinoObject",
"summary": "Object to clip"
},
{
"name": "clippingPlaneObjects",
"type": "IEnumerable",
"summary": "Enumeration of clipping plane objects"
},
{
"name": "unclippedFills",
"type": "System.Boolean",
"summary": "Use True to get fills that are not trimmed by all clipping planes"
}
],
"returns": "Array of Brep containing fills if there were any generated, trimmed if unclippedFills was false"
},
{
"signature": "Brep[] GetFillSurfaces(RhinoObject rhinoObject, IEnumerable clippingPlaneObjects)",
"modifiers": ["public", "static"],
"protected": false,
"virtual": false,
"summary": "Return list of fill surfaces if any for object and clipping plane. Fills are trimmed by clipping planes that did not generate them.",
"since": "6.7",
"parameters": [
{
"name": "rhinoObject",
"type": "RhinoObject",
"summary": "Object to clip"
},
{
"name": "clippingPlaneObjects",
"type": "IEnumerable