RsTool Command Documentation

Appearance

RsTool Command Reference ​

Complete reference for all 277 RsTool commands. Each command has a dedicated page covering its purpose, invocation, workflow, parameters, output, notes, and tutorials.

AI (4) ​

Rendering & Modeling ​

  • rsAiRender · AI rendering — Open the AI ​​rendering window to provide AI-assisted rendering functionality. After selecting the perspective, various styles of rendering renderings can be generated.
  • rsAIModeler · AI modeling — Open the AI ​​modeling window and generate a 3D model from a text description or reference drawing.
  • rsAiRenderOld · Legacy AI rendering — The old AI rendering window remains compatible. It is recommended to use the new version rsAiRender.

Video Generation ​

  • rsAiAnimation · AI animation — Open the AI ​​animation window and generate a Seedance video through reference pictures (optional reference video/audio) and prompt words.

Libraries (6) ​

Model Library ​

Material Library ​

Productivity (10) ​

Productivity ​

Screen Tools ​

Fun (5) ​

Interactive Entertainment ​

Architecture (25) ​

Roads ​

Stairs & Ramps ​

Building Elements ​

3D Walls ​

2D Architecture (21) ​

Grids & Walls ​

Doors, Windows & Elevators ​

Other 2D Tools ​

Terrain (6) ​

Acquisition & Editing ​

Analysis & Simulation ​

Geometry (38) ​

Curves ​

Surfaces ​

Meshes ​

Object Transforms ​

Points ​

Paneling & Facades (6) ​

General ​

Organization & Selection (20) ​

Selection ​

Layers ​

Material Tools ​

Views & Documentation (16) ​

Annotation & Documentation ​

Views & Cameras ​

Analysis (8) ​

Building Performance Analysis ​

Physics Simulation (7) ​

Form Finding & Relaxation ​

Dynamics ​

SubD Tools (3) ​

Editing Tools ​

Section Management (2) ​

Profile Director ​

Utilities (20) ​

Clipboard ​

Block Operations ​

System Tools ​

Import & Export ​

Dynamic Components (7) ​

Creation ​

Panels ​

Getting Started ​

Interaction ​

Maintenance ​

Assembly ​

Grasshopper Components (73) ​

Animation ​

  • Counter — Generate count values during a Grasshopper solve or animation.
  • EventOperation — Handle events and time intervals in the Grasshopper timeline.
  • Export Mesh Alembic — Export list-ordered mesh frames as Alembic animation files that support topology changes.
  • GetCamera — Read camera information for the current Rhino viewport.
  • GetGraphMapperDomain — Read the domain of the Graph Mapper component.
  • LockGroupByName — Lock or unlock objects in a Grasshopper group by name.
  • RandomFlash — Generates a random flash animation effect for an object.
  • SetCamera — Sets the camera position and direction of the current Rhino viewport.

Architecture ​

  • ZigzagRamp — Create a switchback ramp from multiple straight or polyline paths.

Color ​

  • TweenColor — Linearly interpolates between two colors.

Curve ​

  • ArcBlend — Use arcs to create transitional connections between curves.
  • BrepSmoothEdge — Filter smoothly connected edges in Brep.
  • CurveBooleanRegions — Creates a Boolean region from a closed planar curve.
  • CurveRegion — Analyze planar curves and generate closed regions.
  • CurvesSplitAtIntersections — Split multiple curves where they intersect.
  • DivideCrvByDistanceList — Get the points on the curve in sequence according to the given distance list.
  • ExtendCrvOnSrf — Extends the ends of the curve along the surface to the surface boundary.
  • FilletMultipleRadii — Use multiple radii to sequentially fillet the corners of a curve.
  • FitPolyline — Fits an approximately smooth portion of a polyline to a curve.
  • Helix — Create a spiral or spring-like curve.
  • Loop Offset Curve On Surface — Continuously offset the curve on the surface, and continue with the next round of offset after each fitting and extension to the boundary.
  • MinBoundingRec — Computes the minimum enclosing rectangle of a geometric object.
  • OffsetCrv — Offsets a curve on a specified plane.
  • OffsetCrvOnSrfThroughPt — Offsets a curve on a surface and passes the result through specified points.
  • PolyCrv to Arc — Convert polycurves to arcs or straight line segments.
  • PolylineMaxDistance — Finds the two furthest vertices in a polyline and creates a connection.
  • Text curve — Create text outline curves based on text content and font.

Developer ​

  • Linked C# — Run trusted native C# source code and synchronize Grasshopper input and output after the file is saved.

Display ​

  • 2dTextToScreen — Displays 2D text in screen coordinates of the Rhino viewport, suitable for auxiliary annotation and previewing.
  • MaterialPlus — Create a Rhino material with basic color and map settings.
  • Preview Materials — Show input materials in Grasshopper preview.
  • TextDisplay — Display text labels in Rhino viewports.

Light ​

  • AddPointLights — Batch add point lights to Rhino documents based on input points.
  • AddRectangularLights — Batch add rectangular lights to Rhino documents based on input geometry.
  • AddSpotLight — Batch add spotlights to Rhino documents based on input position and orientation.

Math ​

  • ClosestOddEvenNumber — Find the odd and even numbers that are closest to the target value.
  • Value Quantization — Replaces values within the specified range with the nearest value in the custom target list, leaving the values outside the range unchanged.

Mesh ​

  • CurveProjectToMesh — Projects a curve to the mesh in the specified direction.
  • MeshEdgeSelect — Filter mesh edges based on the angle between adjacent mesh faces.
  • MeshExplode — Split the mesh into independent parts based on angular tolerances.
  • MeshLoft — Generate a mesh from a set of polyline lofts.
  • MeshPipe — Generate meshed circular tubes along curves.
  • OffsetMesh — Offsets the mesh along the vertex normal direction.
  • SplitMeshWithProjectedPolylines — Split the mesh using polylines projected onto the mesh.
  • Tween Mesh — Interpolate corresponding vertices between two topologically compatible meshes to generate a transition mesh.

Points ​

  • PointGroup — Divide points into groups based on the distance between them.
  • Sequential Closest Projection — The starting point is projected to the nearest point of the curve list in sequence, and the projection can be continued after moving along the tangential direction of the current curve at fixed intervals.

SubD ​

  • CreaseVertex — Sets the specified SubD vertex to an acute vertex.
  • SubDToBrep — Convert SubD object to NURBS Brep.

Surface ​

  • ExtendSrf — Extends the surface in the specified direction.
  • OffsetBrep — Offset Breps or polysurfaces and produce solid results.
  • ShrinkTrimmedSrf — Shrinks the underlying surface of the trimmed surface to the trimming boundary.
  • SplitBrepByCrvs — Split the Brep using curves lying on the surface.
  • Tessellate NURBS — Generate parametric pavement panels on NURBS single or polysurface surfaces.
  • Tween Surface — Reconstruct a NURBS transition surface between two surfaces by interpolating corresponding sample points.
  • Unroller — Unfold single or polysurfaces and output the corresponding unfolded geometry.

Text ​

  • FilterTextAndNumbers — Filter and separate text content from digital content.
  • FontTable — Read the list of available fonts and distinguish between Chinese and Western fonts.

TextureMapping ​

Util ​

  • CanvasTransparent — Adjust the transparency of the Grasshopper canvas background.
  • ChangeGui — Modify the display settings of the Grasshopper interface.
  • CloseAllGHDocuments — Closes all documents open in the current Grasshopper session.
  • CloseGH — Close the Grasshopper window.
  • Component Labels — Displays floating name labels next to Grasshopper components and supports exception configuration.
  • DeletePlaceholder — Remove placeholder components from Grasshopper documents.
  • NamedView — Reads named views in the current Rhino document.
  • ObjectsExport — Exports the specified objects to the selected file format.
  • RhinoRandomSelect — Randomly selects Rhino document objects according to a specified proportion.
  • RhinoViewCaptureToFile — Batch capture Rhino named views and save to file.
  • Rich Graph Mapper — Provides editable enhanced numerical mapping curves.
  • ViewCaptureToFile — Captures the current Rhino viewport from Grasshopper and saves it to a specified path.