AutoOpenCurried (Rhino.Scripting.Fsharp)

AutoOpenCurried Module

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

This module provides curried F# functions for easy use with pipeline operator |> This module is automatically opened when Rhino.Scripting.FSharp namespace is opened.

Functions and values

Function or value	Description
`x \|>! f` Full Usage: `x \|>! f` Parameters: x : `'a` f : `'a -> 'b` Returns: `'a` Modifiers: inline Type parameters: 'a, 'b	Apply function, like \|> , but ignore result. Return original input. let inline (\|>!) x f = f x \|> ignore ; x Be aware of correct indenting see: https://stackoverflow.com/questions/64784154/indentation-change-after-if-else-expression-not-taken-into-account x : `'a` f : `'a -> 'b` Returns: `'a`

Type extensions

Type extension	Description
`RhinoScriptSyntax.addArrows arrowStyle curveId` Full Usage: `RhinoScriptSyntax.addArrows arrowStyle curveId` Parameters: arrowStyle : `int` - (int) The style of annotation arrow to be displayed. 0 = no arrows 1 = display arrow at start of Curve 2 = display arrow at end of Curve 3 = display arrow at both start and end of Curve curveId : `Guid` - (Guid) Identifier of a Curve	Enables or disables a Curve object's annotation arrows. The size of the arrow cannot be changed. For an adjustable arrow size use a dimension leader object. Same as RhinoScriptSyntax.CurveArrows(curveId,arrowStyle) Extended Type: `RhinoScriptSyntax` arrowStyle : `int` (int) The style of annotation arrow to be displayed. 0 = no arrows 1 = display arrow at start of Curve 2 = display arrow at end of Curve 3 = display arrow at both start and end of Curve curveId : `Guid` (Guid) Identifier of a Curve
`RhinoScriptSyntax.appendUserText key value objectId` Full Usage: `RhinoScriptSyntax.appendUserText key value objectId` Parameters: key : `string` - (string) The key name to set value : `string` - (string) The string value to append. Cannot be empty string. Use RhinoScriptSyntax.DeleteUserText to delete keys objectId : `Guid` - (Guid) The identifier of the object	Append a string to a possibly already existing user-text value. Extended Type: `RhinoScriptSyntax` key : `string` (string) The key name to set value : `string` (string) The string value to append. Cannot be empty string. Use RhinoScriptSyntax.DeleteUserText to delete keys objectId : `Guid` (Guid) The identifier of the object
`RhinoScriptSyntax.getColor objectId` Full Usage: `RhinoScriptSyntax.getColor objectId` Parameters: objectId : `Guid` - (Guid) Id of object Returns: `Color` (Drawing.Color) The current object color.	Returns the color of an object. Extended Type: `RhinoScriptSyntax` objectId : `Guid` (Guid) Id of object Returns: `Color` (Drawing.Color) The current object color.
`RhinoScriptSyntax.getLayer objectId` Full Usage: `RhinoScriptSyntax.getLayer objectId` Parameters: objectId : `Guid` - (Guid) The identifier of the object Returns: `string` (string) The object's current layer.	Returns the full layer-name of an object. Parent layers are separated by `::`. Extended Type: `RhinoScriptSyntax` objectId : `Guid` (Guid) The identifier of the object Returns: `string` (string) The object's current layer.
`RhinoScriptSyntax.getLayerShort objectId` Full Usage: `RhinoScriptSyntax.getLayerShort objectId` Parameters: objectId : `Guid` - (Guid) The identifier of the object Returns: `string` (string) The object's current layer.	Returns the short layer name of an object. Without Parent Layers. Extended Type: `RhinoScriptSyntax` objectId : `Guid` (Guid) The identifier of the object Returns: `string` (string) The object's current layer.
`RhinoScriptSyntax.getName objectId` Full Usage: `RhinoScriptSyntax.getName objectId` Parameters: objectId : `Guid` - (Guid) Id of object Returns: `string` (string) The current object name, empty string if no name given.	Returns the name of an object or "" if none given. Extended Type: `RhinoScriptSyntax` objectId : `Guid` (Guid) Id of object Returns: `string` (string) The current object name, empty string if no name given.
`RhinoScriptSyntax.getUserText key objectId` Full Usage: `RhinoScriptSyntax.getUserText key objectId` Parameters: key : `string` - (string) The key name objectId : `Guid` - (Guid) The object's identifier Returns: `string` (string) If key is specified, the associated value, fails if non-existing.	Returns user text stored on an object, fails if non-existing. Extended Type: `RhinoScriptSyntax` key : `string` (string) The key name objectId : `Guid` (Guid) The object's identifier Returns: `string` (string) If key is specified, the associated value, fails if non-existing.
`RhinoScriptSyntax.hasUserText key objectId` Full Usage: `RhinoScriptSyntax.hasUserText key objectId` Parameters: key : `string` - (string) The key name objectId : `Guid` - (Guid) The object's identifier Returns: `bool` (bool) If key exists, true.	Checks if a User Text key is stored on an object. Extended Type: `RhinoScriptSyntax` key : `string` (string) The key name objectId : `Guid` (Guid) The object's identifier Returns: `bool` (bool) If key exists, true.
`RhinoScriptSyntax.isUserTextValue key valueToMatch objectId` Full Usage: `RhinoScriptSyntax.isUserTextValue key valueToMatch objectId` Parameters: key : `string` - (string) The key name valueToMatch : `string` - (string) The value to check for equality with objectId : `Guid` - (Guid) The object's identifier Returns: `bool` (bool) If key exists and matches, true.	Checks if the user text stored on an object matches a given string, fails if non-existing. Extended Type: `RhinoScriptSyntax` key : `string` (string) The key name valueToMatch : `string` (string) The value to check for equality with objectId : `Guid` (Guid) The object's identifier Returns: `bool` (bool) If key exists and matches, true.
`RhinoScriptSyntax.matchAllProperties sourceId targetId` Full Usage: `RhinoScriptSyntax.matchAllProperties sourceId targetId` Parameters: sourceId : `Guid` - (Guid) The object to take all keys from targetId : `Guid` - (Guid) The object to write all keys to	Matches all properties( layer, name, user text, ....) from a source object to a target object by duplicating attributes. and copying user strings on geometry. . Extended Type: `RhinoScriptSyntax` sourceId : `Guid` (Guid) The object to take all keys from targetId : `Guid` (Guid) The object to write all keys to
`RhinoScriptSyntax.matchAllUserText sourceId targetId` Full Usage: `RhinoScriptSyntax.matchAllUserText sourceId targetId` Parameters: sourceId : `Guid` - (Guid) The object to take all keys from targetId : `Guid` - (Guid) The object to write all keys to	Copies all user text keys and values from one object to another from both Geometry and Object.Attributes. Existing values are overwritten. Extended Type: `RhinoScriptSyntax` sourceId : `Guid` (Guid) The object to take all keys from targetId : `Guid` (Guid) The object to write all keys to
`RhinoScriptSyntax.matchLayer sourceId targetId` Full Usage: `RhinoScriptSyntax.matchLayer sourceId targetId` Parameters: sourceId : `Guid` - (Guid) The object to take the layer from targetId : `Guid` - (Guid) The object to change the layer	Puts target object on the same Layer as a source object . Extended Type: `RhinoScriptSyntax` sourceId : `Guid` (Guid) The object to take the layer from targetId : `Guid` (Guid) The object to change the layer
`RhinoScriptSyntax.matchName sourceId targetId` Full Usage: `RhinoScriptSyntax.matchName sourceId targetId` Parameters: sourceId : `Guid` - (Guid) The object to take the name from targetId : `Guid` - (Guid) The object to write the name to	Copies the object name from a source object to a target object. Extended Type: `RhinoScriptSyntax` sourceId : `Guid` (Guid) The object to take the name from targetId : `Guid` (Guid) The object to write the name to
`RhinoScriptSyntax.matchUserText sourceId key targetId` Full Usage: `RhinoScriptSyntax.matchUserText sourceId key targetId` Parameters: sourceId : `Guid` - (Guid) The object to take all keys from key : `string` - (string) The key name to set targetId : `Guid` - (Guid) The object to write all keys to	Copies the value for a given user text key from a source object to a target object. Extended Type: `RhinoScriptSyntax` sourceId : `Guid` (Guid) The object to take all keys from key : `string` (string) The key name to set targetId : `Guid` (Guid) The object to write all keys to
`RhinoScriptSyntax.move translation objectId` Full Usage: `RhinoScriptSyntax.move translation objectId` Parameters: translation : `Vector3d` - (Vector3d) Vector3d objectId : `Guid` - (Guid) The identifier of an object to move	Moves a single object. Extended Type: `RhinoScriptSyntax` translation : `Vector3d` (Vector3d) Vector3d objectId : `Guid` (Guid) The identifier of an object to move
`RhinoScriptSyntax.moveGeo translation geo` Full Usage: `RhinoScriptSyntax.moveGeo translation geo` Parameters: translation : `Vector3d` - (Vector3d) Vector3d geo : `GeometryBase` - (GeometryBase) The Geometry to move	Moves a Geometry. Extended Type: `RhinoScriptSyntax` translation : `Vector3d` (Vector3d) Vector3d geo : `GeometryBase` (GeometryBase) The Geometry to move
`RhinoScriptSyntax.moveGeoX translationX geo` Full Usage: `RhinoScriptSyntax.moveGeoX translationX geo` Parameters: translationX : `float` - (float) movement in X direction geo : `GeometryBase` - (GeometryBase) The Geometry to move	Moves a Geometry in X Direction. Extended Type: `RhinoScriptSyntax` translationX : `float` (float) movement in X direction geo : `GeometryBase` (GeometryBase) The Geometry to move
`RhinoScriptSyntax.moveGeoY translationY geo` Full Usage: `RhinoScriptSyntax.moveGeoY translationY geo` Parameters: translationY : `float` - (float) movement in Y direction geo : `GeometryBase` - (GeometryBase) The Geometry to move	Moves a Geometry in Y Direction. Extended Type: `RhinoScriptSyntax` translationY : `float` (float) movement in Y direction geo : `GeometryBase` (GeometryBase) The Geometry to move
`RhinoScriptSyntax.moveGeoZ translationZ geo` Full Usage: `RhinoScriptSyntax.moveGeoZ translationZ geo` Parameters: translationZ : `float` - (float) movement in Z direction geo : `GeometryBase` - (GeometryBase) The Geometry to move	Moves a Geometry in Z Direction. Extended Type: `RhinoScriptSyntax` translationZ : `float` (float) movement in Z direction geo : `GeometryBase` (GeometryBase) The Geometry to move
`RhinoScriptSyntax.moveX translationX objectId` Full Usage: `RhinoScriptSyntax.moveX translationX objectId` Parameters: translationX : `float` - (float) movement in X direction objectId : `Guid` - (Guid) The identifier of an object to move	Moves a single object in X Direction. Extended Type: `RhinoScriptSyntax` translationX : `float` (float) movement in X direction objectId : `Guid` (Guid) The identifier of an object to move
`RhinoScriptSyntax.moveY translationY objectId` Full Usage: `RhinoScriptSyntax.moveY translationY objectId` Parameters: translationY : `float` - (float) movement in Y direction objectId : `Guid` - (Guid) The identifier of an object to move	Moves a single object in Y Direction. Extended Type: `RhinoScriptSyntax` translationY : `float` (float) movement in Y direction objectId : `Guid` (Guid) The identifier of an object to move
`RhinoScriptSyntax.moveZ translationZ objectId` Full Usage: `RhinoScriptSyntax.moveZ translationZ objectId` Parameters: translationZ : `float` - (float) movement in Z direction objectId : `Guid` - (Guid) The identifier of an object to move	Moves a single object in Z Direction. Extended Type: `RhinoScriptSyntax` translationZ : `float` (float) movement in Z direction objectId : `Guid` (Guid) The identifier of an object to move
`RhinoScriptSyntax.scale origin scale objectId` Full Usage: `RhinoScriptSyntax.scale origin scale objectId` Parameters: origin : `Point3d` - (Point3d) The origin of the scale transformation scale : `float` - (float) One numbers that identify the X, Y, and Z axis scale factors to apply objectId : `Guid` - (Guid) The identifier of an object	Scales a single object. Uniform scale transformation. Scaling is based on the WorldXY Plane. Extended Type: `RhinoScriptSyntax` origin : `Point3d` (Point3d) The origin of the scale transformation scale : `float` (float) One numbers that identify the X, Y, and Z axis scale factors to apply objectId : `Guid` (Guid) The identifier of an object
`RhinoScriptSyntax.setColor color objectId` Full Usage: `RhinoScriptSyntax.setColor color objectId` Parameters: color : `Color` - (Drawing.Color) The new object color. objectId : `Guid` - (Guid) Id of object	Sets the color of an object. Extended Type: `RhinoScriptSyntax` color : `Color` (Drawing.Color) The new object color. objectId : `Guid` (Guid) Id of object
`RhinoScriptSyntax.setColors color objectIds` Full Usage: `RhinoScriptSyntax.setColors color objectIds` Parameters: color : `Color` - (Drawing.Color) The new object color. objectIds : `Guid seq` - (Guid seq) Ids of several objects	Sets the color of several objects. Extended Type: `RhinoScriptSyntax` color : `Color` (Drawing.Color) The new object color. objectIds : `Guid seq` (Guid seq) Ids of several objects
`RhinoScriptSyntax.setLayer layer objectId` Full Usage: `RhinoScriptSyntax.setLayer layer objectId` Parameters: layer : `string` - (string) Name of layer or empty string for current layer objectId : `Guid` - (Guid) The identifier of the object	Modifies the layer of an object, creates layer if it does not yet exist. Extended Type: `RhinoScriptSyntax` layer : `string` (string) Name of layer or empty string for current layer objectId : `Guid` (Guid) The identifier of the object
`RhinoScriptSyntax.setLayerIndex layerIndex objectId` Full Usage: `RhinoScriptSyntax.setLayerIndex layerIndex objectId` Parameters: layerIndex : `int` - (int) Index of layer in layer table objectId : `Guid` - (Guid) The identifier of the object	Modifies the layer of an object. Extended Type: `RhinoScriptSyntax` layerIndex : `int` (int) Index of layer in layer table objectId : `Guid` (Guid) The identifier of the object
`RhinoScriptSyntax.setLayers layer objectIds` Full Usage: `RhinoScriptSyntax.setLayers layer objectIds` Parameters: layer : `string` - (string) Name of layer or empty string for current layer objectIds : `Guid seq` - (Guid seq) The identifiers of several objects	Modifies the layer of several objects, creates layer if it does not yet exist. Extended Type: `RhinoScriptSyntax` layer : `string` (string) Name of layer or empty string for current layer objectIds : `Guid seq` (Guid seq) The identifiers of several objects
`RhinoScriptSyntax.setLayersIndex layerIndex objectIds` Full Usage: `RhinoScriptSyntax.setLayersIndex layerIndex objectIds` Parameters: layerIndex : `int` - (int) Index of layer in layer table objectIds : `Guid seq` - (Guid seq) The identifiers of several objects	Modifies the layer of several objects. Extended Type: `RhinoScriptSyntax` layerIndex : `int` (int) Index of layer in layer table objectIds : `Guid seq` (Guid seq) The identifiers of several objects
`RhinoScriptSyntax.setName name objectId` Full Usage: `RhinoScriptSyntax.setName name objectId` Parameters: name : `string` - (string) The new object name. objectId : `Guid` - (Guid)Id of object	Sets the name of an object. Extended Type: `RhinoScriptSyntax` name : `string` (string) The new object name. objectId : `Guid` (Guid)Id of object
`RhinoScriptSyntax.setNames name objectIds` Full Usage: `RhinoScriptSyntax.setNames name objectIds` Parameters: name : `string` - (string) The new object name. objectIds : `Guid seq` - (Guid seq)Ids of several objects	Sets the name of several objects. Extended Type: `RhinoScriptSyntax` name : `string` (string) The new object name. objectIds : `Guid seq` (Guid seq)Ids of several objects
`RhinoScriptSyntax.setUserText key value objectId` Full Usage: `RhinoScriptSyntax.setUserText key value objectId` Parameters: key : `string` - (string) The key name to set value : `string` - (string) The string value to set. Cannot be empty string. Use RhinoScriptSyntax.DeleteUserText to delete keys objectId : `Guid` - (Guid) The object's identifier	Sets a user text stored on an object. Extended Type: `RhinoScriptSyntax` key : `string` (string) The key name to set value : `string` (string) The string value to set. Cannot be empty string. Use RhinoScriptSyntax.DeleteUserText to delete keys objectId : `Guid` (Guid) The object's identifier
`RhinoScriptSyntax.setUserTexts key value objectIds` Full Usage: `RhinoScriptSyntax.setUserTexts key value objectIds` Parameters: key : `string` - (string) The key name to set value : `string` - (string) The string value to set. Cannot be empty string. Use RhinoScriptSyntax.DeleteUserText to delete keys objectIds : `Guid seq` - (Guid seq) The identifiers of several objects	Sets a user text stored on several objects. Extended Type: `RhinoScriptSyntax` key : `string` (string) The key name to set value : `string` (string) The string value to set. Cannot be empty string. Use RhinoScriptSyntax.DeleteUserText to delete keys objectIds : `Guid seq` (Guid seq) The identifiers of several objects
`RhinoScriptSyntax.transform matrix objectId` Full Usage: `RhinoScriptSyntax.transform matrix objectId` Parameters: matrix : `Transform` - (Transform) The transformation matrix (4x4 array of numbers) objectId : `Guid` - (Guid) The identifier of the object	Moves, scales, or rotates an object given a 4x4 transformation matrix. The matrix acts on the left. Extended Type: `RhinoScriptSyntax` matrix : `Transform` (Transform) The transformation matrix (4x4 array of numbers) objectId : `Guid` (Guid) The identifier of the object
`RhinoScriptSyntax.transformGeo matrix geo` Full Usage: `RhinoScriptSyntax.transformGeo matrix geo` Parameters: matrix : `Transform` - (Transform) The transformation matrix (4x4 array of numbers) geo : `GeometryBase` - (GeometryBase) Any Geometry derived from GeometryBase	Moves, scales, or rotates a geometry given a 4x4 transformation matrix. The matrix acts on the left. Extended Type: `RhinoScriptSyntax` matrix : `Transform` (Transform) The transformation matrix (4x4 array of numbers) geo : `GeometryBase` (GeometryBase) Any Geometry derived from GeometryBase
`RhinoScriptSyntax.tryGetUserText key objectId` Full Usage: `RhinoScriptSyntax.tryGetUserText key objectId` Parameters: key : `string` - (string) The key name objectId : `Guid` - (Guid) The object's identifier Returns: `string option` (string option) If key is specified, Some(value) else None.	Returns user text stored on an object, returns Option.None if non-existing. Extended Type: `RhinoScriptSyntax` key : `string` (string) The key name objectId : `Guid` (Guid) The object's identifier Returns: `string option` (string option) If key is specified, Some(value) else None.