Header menu logo Rhino.Scripting.Fsharp

AutoOpenPrinting Module

This module shadows the Pretty module from the Pretty nuget package to include the special formatting for Rhino types.

Functions and values

Function or value Description

pretty x

Full Usage: pretty x

Parameters:
    x : 'T

Returns: string

Pretty formatting for Rhino and .Net types, e.g. numbers including thousand Separator and (nested) sequences, first five items are printed out. Settings are exposed in Pretty.PrettySettings: - thousandSeparator = ' ; set this to change the printing of floats and integers larger than 10'000 - maxNestingDepth = 3 ; set this to change how deep the content of nested seq is printed (printFull ignores this) - maxNestingDepth = 6 ; set this to change how how many items per seq are printed (printFull ignores this) - maxCharsInString = 2000 ; set this to change how many characters of a string might be printed at once.

x : 'T
Returns: string

print x

Full Usage: print x

Parameters:
    x : 'a

Returns: string

Print to standard out including nice formatting for Rhino Objects, numbers including thousand Separator and (nested) sequences, first five items are printed out. Only prints to Console.Out, NOT to Rhino Commandline Shows numbers smaller than State.Doc.ModelAbsoluteTolerance * 0.1 as ~0.0 Settings are exposed in Pretty.PrettySettings: - thousandSeparator = ' ; set this to change the printing of floats and integers larger than 10'000 - maxNestingDepth = 3 ; set this to change how deep the content of nested seq is printed (printFull ignores this) - maxNestingDepth = 6 ; set this to change how how many items per seq are printed (printFull ignores this) - maxCharsInString = 2000 ; set this to change how many characters of a string might be printed at once.

x : 'a
Returns: string

Type extensions

Type extension Description

RhinoScriptSyntax.Print(x)

Full Usage: RhinoScriptSyntax.Print(x)

Parameters:
    x : 'T - ('T) the value or object to print

Pretty formatting for numbers including thousand Separator and (nested) sequences, first five items are printed out. Prints to Console.Out and to Rhino Commandline Shows numbers smaller than State.Doc.ModelAbsoluteTolerance * 0.1 as 0.0 Settings are exposed in Pretty.PrettySettings: maxDepth = 3 : how deep the content of nested seq is printed maxVertItems = 6 : amount of lines printed. maxHorChars = 120 : maximum amount of characters per line. maxCharsInString = 2000 : after this the characters of a string are trimmed off. The function rs.PrintFull does not do this trimming.

Extended Type: RhinoScriptSyntax

x : 'T

('T) the value or object to print

RhinoScriptSyntax.PrintBlue(msg)

Full Usage: RhinoScriptSyntax.PrintBlue(msg)

Parameters:
    msg : string

Prints in Blue if used from Fesh F# Scripting Editor. Does not add a new line at end. Prints to Console.Out and to Rhino Commandline.

Extended Type: RhinoScriptSyntax

msg : string

RhinoScriptSyntax.PrintColor(red) (green) (blue) (msg)

Full Usage: RhinoScriptSyntax.PrintColor(red) (green) (blue) (msg)

Parameters:
    red : int - (int) Red Value between 0 and 255
    green : int - (int) Green value between 0 and 255
    blue : int - (int) Blue value between 0 and 255
    msg : string - The string

Prints in custom color if used from Fesh F# Scripting Editor. Does not add a new line at end. Prints to Console.Out and to Rhino Commandline.

Extended Type: RhinoScriptSyntax

red : int

(int) Red Value between 0 and 255

green : int

(int) Green value between 0 and 255

blue : int

(int) Blue value between 0 and 255

msg : string

The string

RhinoScriptSyntax.PrintGray(msg)

Full Usage: RhinoScriptSyntax.PrintGray(msg)

Parameters:
    msg : string

Prints in Gray if used from Fesh F# Scripting Editor. Does not add a new line at end. Prints to Console.Out and to Rhino Commandline.

Extended Type: RhinoScriptSyntax

msg : string

RhinoScriptSyntax.PrintGreen(msg)

Full Usage: RhinoScriptSyntax.PrintGreen(msg)

Parameters:
    msg : string

Like PrintColor.f but in Green if used from Fesh F# Scripting Editor. Does not add a new line at end. Prints to Console.Out and to Rhino Commandline.

Extended Type: RhinoScriptSyntax

msg : string

RhinoScriptSyntax.PrintLightBlue(msg)

Full Usage: RhinoScriptSyntax.PrintLightBlue(msg)

Parameters:
    msg : string

Prints in Light Blue if used from Fesh F# Scripting Editor. Does not add a new line at end. Prints to Console.Out and to Rhino Commandline.

Extended Type: RhinoScriptSyntax

msg : string

RhinoScriptSyntax.PrintRed(msg)

Full Usage: RhinoScriptSyntax.PrintRed(msg)

Parameters:
    msg : string

Prints in Red if used from Fesh F# Scripting Editor. Does not add a new line at end. Prints to Console.Out and to Rhino Commandline.

Extended Type: RhinoScriptSyntax

msg : string

RhinoScriptSyntax.PrintnBlue(msg)

Full Usage: RhinoScriptSyntax.PrintnBlue(msg)

Parameters:
    msg : string

Prints in Blue if used from Fesh F# Scripting Editor. Adds a new line at end. Prints to Console.Out and to Rhino Commandline.

Extended Type: RhinoScriptSyntax

msg : string

RhinoScriptSyntax.PrintnColor(red) (green) (blue) (msg)

Full Usage: RhinoScriptSyntax.PrintnColor(red) (green) (blue) (msg)

Parameters:
    red : int - (int) Red Value between 0 and 255
    green : int - (int) Green value between 0 and 255
    blue : int - (int) Blue value between 0 and 255
    msg : string - The format string

Prints in custom color if used from Fesh F# Scripting Editor. Adds a new line at end. Prints to Console.Out and to Rhino Commandline.

Extended Type: RhinoScriptSyntax

red : int

(int) Red Value between 0 and 255

green : int

(int) Green value between 0 and 255

blue : int

(int) Blue value between 0 and 255

msg : string

The format string

RhinoScriptSyntax.PrintnGray(msg)

Full Usage: RhinoScriptSyntax.PrintnGray(msg)

Parameters:
    msg : string

Prints in Gray if used from Fesh F# Scripting Editor. Adds a new line at end. Prints to Console.Out and to Rhino Commandline.

Extended Type: RhinoScriptSyntax

msg : string

RhinoScriptSyntax.PrintnGreen(msg)

Full Usage: RhinoScriptSyntax.PrintnGreen(msg)

Parameters:
    msg : string

Prints in Green if used from Fesh F# Scripting Editor. Adds a new line at end. Prints to Console.Out and to Rhino Commandline.

Extended Type: RhinoScriptSyntax

msg : string

RhinoScriptSyntax.PrintnLightBlue(msg)

Full Usage: RhinoScriptSyntax.PrintnLightBlue(msg)

Parameters:
    msg : string

Prints in Light Blue if used from Fesh F# Scripting Editor. Adds a new line at end. Prints to Console.Out and to Rhino Commandline.

Extended Type: RhinoScriptSyntax

msg : string

RhinoScriptSyntax.PrintnRed(msg)

Full Usage: RhinoScriptSyntax.PrintnRed(msg)

Parameters:
    msg : string

Prints in Red if used from Fesh F# Scripting Editor. Adds a new line at end. Prints to Console.Out and to Rhino Commandline.

Extended Type: RhinoScriptSyntax

msg : string

Type something to start searching.