AutoOpenSelection (Rhino.Scripting.Fsharp) | Rhino.Scripting.Fsharp

Rhino.Scripting.Fsharp

AutoOpenSelection Module

Namespace: Rhino.Scripting.FSharp
Assembly: Rhino.Scripting.FSharp.dll

This module provides functions similar to Rhino.Scripting.FSharp.GetObject(..) This module is automatically opened when Rhino.Scripting.FSharp namespace is opened. These type extensions are only visible in F#.

Type extensions

Type extension	Description
`RhinoScriptSyntax.ClearRememberedObjects()` Full Usage: `RhinoScriptSyntax.ClearRememberedObjects()` Parameters: () : `unit`	Clears all remembered objects from the internal Dictionary that were added via rs.GetObjectAndRemember() or rs.GetObjectsAndRemember() Extended Type: `RhinoScriptSyntax` () : `unit`
`RhinoScriptSyntax.GetObjectAndRemember(message, filter, preselect, select, printDescr, customFilter)` Full Usage: `RhinoScriptSyntax.GetObjectAndRemember(message, filter, preselect, select, printDescr, customFilter)` Parameters: message : `string` - (string) A prompt or message, should be unique, this will be the key in dictionary to remember object filter : `int` - (int) Optional, The type(s) of geometry (points, Curves, Surfaces, Meshes,...) that can be selected. Object types can be added together to filter several different kinds of geometry. use the RhinoScriptSyntax.Filter enum to get values, they can be joined with '+' preselect : `bool` - (bool) Optional, Default Value: `true` Allow for the selection of pre-selected objects select : `bool` - (bool) Optional, Default Value: `false` Select the picked objects. If False, the objects that are picked are not selected printDescr : `bool` - (bool) Optional, Default Value: `false` Print object description to command window customFilter : `GetObjectGeometryFilter` - (Input.Custom.GetObjectGeometryFilter) Optional, A custom filter function Returns: `Guid` (Guid) a identifier of the picked object.	Returns the same object as in the last user interaction with the same prompt message If none found, Prompts user to pick one object and remembers it. Call rs.ClearRememberedObjects() to clear the memory. Extended Type: `RhinoScriptSyntax` message : `string` (string) A prompt or message, should be unique, this will be the key in dictionary to remember object filter : `int` (int) Optional, The type(s) of geometry (points, Curves, Surfaces, Meshes,...) that can be selected. Object types can be added together to filter several different kinds of geometry. use the RhinoScriptSyntax.Filter enum to get values, they can be joined with '+' preselect : `bool` (bool) Optional, Default Value: `true` Allow for the selection of pre-selected objects select : `bool` (bool) Optional, Default Value: `false` Select the picked objects. If False, the objects that are picked are not selected printDescr : `bool` (bool) Optional, Default Value: `false` Print object description to command window customFilter : `GetObjectGeometryFilter` (Input.Custom.GetObjectGeometryFilter) Optional, A custom filter function Returns: `Guid` (Guid) a identifier of the picked object.
`RhinoScriptSyntax.GetObjectsAndRemember(message, filter, group, preselect, select, objects, minimumCount, maximumCount, printCount, customFilter)` Full Usage: `RhinoScriptSyntax.GetObjectsAndRemember(message, filter, group, preselect, select, objects, minimumCount, maximumCount, printCount, customFilter)` Parameters: message : `string` - (string) A prompt or message, should be unique, this will be the key in dictionary to remember objects filter : `int` - (int) Optional, The type(s) of geometry (points, Curves, Surfaces, Meshes,...) that can be selected. Object types can be added together to filter several different kinds of geometry. use the RhinoScriptSyntax.Filter enum to get values, they can be joined with '+' group : `bool` - (bool) Optional, Default Value: `true` Honor object grouping. If omitted and the user picks a group, the entire group will be picked (True). Note, if filter is set to a value other than 0 (All objects), then group selection will be disabled preselect : `bool` - (bool) Optional, Default Value: `true` Allow for the selection of pre-selected objects select : `bool` - (bool) Optional, Default Value: `false` Select the picked objects. If False, the objects that are picked are not selected objects : `Guid seq` - (Guid seq) Optional, List of objects that are allowed to be selected. If set customFilter will be ignored minimumCount : `int` - (int) Optional, Default Value: `1` Minimum count of objects allowed to be selected maximumCount : `int` - (int) Optional, Default Value: `0` Maximum count of objects allowed to be selected printCount : `bool` - (bool) Optional, Default Value: `true` Print object count to command window customFilter : `GetObjectGeometryFilter` - (Input.Custom.GetObjectGeometryFilter) Optional, Will be ignored if 'objects' are set. Calls a custom function in the script and passes the Rhino Object, Geometry, and component index and returns true or false indicating if the object can be selected Returns: `ResizeArray<Guid>` (Guid ResizeArray) List of identifiers of the picked objects.	Returns the same objects as in the last user interaction with the same prompt message If none found, Prompts user to pick or select one or more objects and remembers them. Call rs.ClearRememberedObjects() to clear the memory. Extended Type: `RhinoScriptSyntax` message : `string` (string) A prompt or message, should be unique, this will be the key in dictionary to remember objects filter : `int` (int) Optional, The type(s) of geometry (points, Curves, Surfaces, Meshes,...) that can be selected. Object types can be added together to filter several different kinds of geometry. use the RhinoScriptSyntax.Filter enum to get values, they can be joined with '+' group : `bool` (bool) Optional, Default Value: `true` Honor object grouping. If omitted and the user picks a group, the entire group will be picked (True). Note, if filter is set to a value other than 0 (All objects), then group selection will be disabled preselect : `bool` (bool) Optional, Default Value: `true` Allow for the selection of pre-selected objects select : `bool` (bool) Optional, Default Value: `false` Select the picked objects. If False, the objects that are picked are not selected objects : `Guid seq` (Guid seq) Optional, List of objects that are allowed to be selected. If set customFilter will be ignored minimumCount : `int` (int) Optional, Default Value: `1` Minimum count of objects allowed to be selected maximumCount : `int` (int) Optional, Default Value: `0` Maximum count of objects allowed to be selected printCount : `bool` (bool) Optional, Default Value: `true` Print object count to command window customFilter : `GetObjectGeometryFilter` (Input.Custom.GetObjectGeometryFilter) Optional, Will be ignored if 'objects' are set. Calls a custom function in the script and passes the Rhino Object, Geometry, and component index and returns true or false indicating if the object can be selected Returns: `ResizeArray<Guid>` (Guid ResizeArray) List of identifiers of the picked objects.
`RhinoScriptSyntax.ShownObjects(filter, printCount, includeReferences, includeLockedObjects, includeLights, includeGrips)` Full Usage: `RhinoScriptSyntax.ShownObjects(filter, printCount, includeReferences, includeLockedObjects, includeLights, includeGrips)` Parameters: filter : `int` - (int) Optional, Default Value: `0` The type(s) of geometry (points, Curves, Surfaces, Meshes,...) that can be selected. Object types can be added together to filter several different kinds of geometry. use the RhinoScriptSyntax.Filter enum to get values, they can be joined with '+' printCount : `bool` - (bool) Optional, Default Value: `true` Print object count to command window includeReferences : `bool` - (bool) Optional, Default Value: `false` Include reference objects such as work session objects includeLockedObjects : `bool` - (bool) Optional, Default Value: `false` Include locked objects includeLights : `bool` - (bool) Optional, Default Value: `false` Include light objects includeGrips : `bool` - (bool) Optional, Default Value: `false` Include grips objects Returns: `ResizeArray<Guid>` (Guid ResizeArray) Identifiers for all the objects that are not hidden and whose layer is on and visible.	Returns identifiers of all objects in the current model or paper space that are not hidden, not locked nor on turned off layers. Extended Type: `RhinoScriptSyntax` filter : `int` (int) Optional, Default Value: `0` The type(s) of geometry (points, Curves, Surfaces, Meshes,...) that can be selected. Object types can be added together to filter several different kinds of geometry. use the RhinoScriptSyntax.Filter enum to get values, they can be joined with '+' printCount : `bool` (bool) Optional, Default Value: `true` Print object count to command window includeReferences : `bool` (bool) Optional, Default Value: `false` Include reference objects such as work session objects includeLockedObjects : `bool` (bool) Optional, Default Value: `false` Include locked objects includeLights : `bool` (bool) Optional, Default Value: `false` Include light objects includeGrips : `bool` (bool) Optional, Default Value: `false` Include grips objects Returns: `ResizeArray<Guid>` (Guid ResizeArray) Identifiers for all the objects that are not hidden and whose layer is on and visible.