Use scripting

Scripting extends Rhino functionality.

All Rhino commands can be used in command macros. Command macros can be run by typing the command at the command prompt, from toolbar buttons, shortcut keys, command aliases, from the ReadCommandFile command, or using the Paste command into Rhino's command stream.

Some commands are provided to facilitate scripting actions usually performed through the Rhino interface.

Specialized commands for scripting

Action

Cancel

Cancel the current command and deselects objects.

Delete

Erase objects.

Echo

Turn on echoing of script commands to the command history window.

EditPythonScript

Edit a Python script.

EditScript

Open a text editor utility for editing RhinoScript files.

Enter

Simulate the Enter key in a script.

EnterEnd

Simulate the Enter key to complete a command string in a script.

GetDocumentUserText

Retrieve text information attached to a file with the SetDocumentUserText command.

GetUserText

Retrieve text information attached to an object using the SetUserText command.

MacroEditor

Open an edit window for script creation and testing.

NoEcho

Turn off echoing of script commands to the command history window.

Pause

Stop a script for user input.

ReadCommandFile

Read and execute a command script from a text file.

Run

Run another application from inside Rhino.

RunPythonScript

Run a Python script.

RunScript

Run a RhinoScript.

SetCurrentRenderPlugIn

Specify a rendering plug-in.

SetDisplayMode

Specify a viewport display mode.

SetDocumentUserText

Attach text information to the file.

SetObjectName

Assign a name to an object.

SetRedrawOff

Disable screen redraw, construction plane, and view changes during scripts.

SetRedrawOn

Enable screen redraw, construction plane, and view changes during scripts.

SetUserText

Attach text information to an object.

SetWorkingFolder

Specify the default folder for saving and opening files.

Interface

BringViewportToTop

Bring a viewport to the front.

ClearUndo

Clear the undo buffer to free memory.

CloseRenderWindow

Close the render display window.

CloseViewport

Close the active viewport.

CommandPrompt

Manage the display of the command prompt window.

CopyRenderWindowToClipboard

Copy the image in the render window to the Clipboard.

DocumentPropertiesPage

Open the Document Properties dialog box at the specified page.

Exit

Close Rhino.

Maximize

Maximize the Rhino application window.

MaxViewport

Maximize the active viewport.

NewFloatingViewport

Create a new free-floating viewport.

NewViewport

Create a new viewport.

NextOrthoViewport

Activate the next viewport with an orthogonal projection.

NextPerspectiveViewport

Activate the next viewport with a perspective projection.

NextViewport

Activate the next viewport.

NextViewportToTop

Display the next viewport in front of all other viewports.

Ortho

Restrict cursor movement to an angle.

OrthoAngle

Set the angle for cursor ortho movement.

OptionsPage

Open the Options dialog box at a specified page.

PrevViewport

Activate the previous viewport.

PushViewportToBack

Send a named viewport behind all viewports.

PropertiesPage

Open the Properties dialog box at a specified page.

SetActiveViewport

Activate a named viewport.

SetMaximizedViewport

Maximize a named viewport inside the application window.

SetOrtho

Turn ortho mode on, off, or toggle the current state.

SetPlanar

Turn Planar mode on, off, or toggle the current state.

SetSnap

Turn grid snap on, off, or toggle the current state.

ShowOsnap

Turn the Osnap control on.

Snap

Toggle the current snap mode state.

SnapSize

Specify the grid snap spacing.

Import/Export

AssignBlankTexture

Assign texture names to objects.

ComputeVertexColors

Evaluate texture coordinates and set vertex colors.

See also

Command Macros and Scripting

 

 

 

Rhinoceros 6 © 2010-2019 Robert McNeel & Associates. 21-Aug-2019