RhinoScript

rhinoscript
what's new?
introduction
  getting started
  loading scripts
  running scripts
  editing scripts
  scripting options
  external access
  rhinoscript fundamentals
rhinoscript methods
  application methods
    addalias
    addsearchpath
    addstartupscript
    aliascount
    aliasmacro
    aliasnames
    appearancecolor
    autosavefile
    autosaveinterval
    builddate
    clearcommandhistory
    command
    commandhistory
    defaultrenderer
    deletealias
    deletesearchpath
    deletestartupscript
    edgeanalysiscolor
    edgeanalysismode
    enableautosave
    exefolder
    exit
    findfile
    getpluginobject
    help
    incommand
    installfolder
    isalias
    iscommand
    lastcommandname
    lastcommandresult
    lastloadedscriptfile
    localeid
    ortho
    osnap
    osnapdialog
    osnapmode
    planar
    plugins
    print
    printex
    projectosnaps
    prompt
    registrykey
    screensize
    sdkversion
    searchpathcount
    searchpathlist
    sendkeystrokes
    snap
    startupscriptcount
    startupscriptlist
    statusbardistance
    statusbarmessage
    statusbarnumber
    statusbarpoint
    templatefile
    templatefolder
    windowhandle
    workingfolder
  document methods
    createpreviewimage
    documentmodified
    documentname
    documentpath
    documenturl
    enableredraw
    extractpreviewimage
    isdocumentmodified
    notes
    redraw
    renderantialias
    rendercolor
    renderresolution
    rendersettings
    unitabsolutetolerance
    unitangletolerance
    unitcustomunitsystem
    unitdistancedisplaymode
    unitdistancedisplayprecision
    unitrelativetolerance
    unitsystem
    unitsystemname
  selection methods
    allobjects
    firstobject
    getcurveobject
    getobject
    getobjects
    getpointcoordinates
    getsurfaceobject
    hiddenobjects
    invertselectedobjects
    lastcreatedobjects
    lastobject
    lockedobjects
    nextobject
    normalobjects
    objectsbycolor
    objectsbygroup
    objectsbylayer
    objectsbyname
    objectsbytype
    objectsbyurl
    prevselectedobjects
    referenceobjects
    selectedobjects
    unselectallobjects
    unselectedobjects
  object methods
    copyobject
    copyobjects
    deleteobject
    deleteobjects
    hideobject
    hideobjects
    isobject
    isobjecthidden
    isobjectingroup
    isobjectlocked
    isobjectnormal
    isobjectreference
    isobjectselectable
    isobjectselected
    isobjectsolid
    isobjectvalid
    lockobject
    lockobjects
    mirrorobject
    mirrorobjects
    moveobject
    moveobjects
    objectcolor
    objectcolorsource
    objectdescription
    objectdump
    objectgroups
    objectlayer
    objectlinetype
    objectlinetypesource
    objectmaterialindex
    objectmaterialsource
    objectname
    objectnames
    objecttopgroup
    objecttype
    objecturl
    orientobject
    orientobjects
    rotateobject
    rotateobjects
    scaleobject
    scaleobjects
    selectobject
    selectobjects
    showobject
    shearobject
    shearobjects
    showobjects
    transformobject
    transformobjects
    unlockobject
    unlockobjects
    unselectobject
    unselectobjects
  curve methods
    addarc
    addarc3pt
    addcircle
    addcircle3pt
    addcurve
    addellipse
    addellipse3pt
    addfilletcurve
    addinterpcrvonsrf
    addinterpcrvonsrfuv
    addinterpcurve
    addinterpcurveex
    addline
    addnurbscurve
    addpolyline
    addsubcrv
    arcangle
    arccenterpoint
    arcmidpoint
    arcradius
    circlecenterpoint
    circlecircumference
    circleradius
    closecurve
    convertcurvetopolyline
    curvearclengthpoint
    curvearea
    curveareacentroid
    curvearrows
    curvebrepintersect
    curveclosestpoint
    curvecurvature
    curvecurveintersection
    curvedegree
    curvedeviation
    curvedim
    curvedirectionsmatch
    curvediscontinuity
    curvedomain
    curveeditpoints
    curveendpoint
    curveevaluate
    curvefilletpoints
    curveframe
    curveknotcount
    curveknots
    curvelength
    curvemidpoint
    curvenormal
    curveperpframe
    curveplane
    curvepointcount
    curvepoints
    curveradius
    curveseam
    curvestartpoint
    curvesurfaceintersection
    curvetangent
    curveweights
    dividecurve
    dividecurvelength
    ellipsecenterpoint
    ellipsequadpoints
    evaluatecurve
    explodecurves
    extendcurve
    extendcurvelength
    extendcurvepoint
    faircurve
    insertcurveknot
    isarc
    iscircle
    iscurve
    iscurveclosable
    iscurveclosed
    iscurveinplane
    iscurvelinear
    iscurveperiodic
    iscurveplanar
    iscurverational
    isellipse
    isline
    ispointoncurve
    ispolycurve
    ispolyline
    joincurves
    makecurveperiodic
    meshpolyline
    offsetcurve
    planarclosedcurvecontainment
    planarcurvecollision
    pointinplanarclosedcurve
    polycurvecount
    polylinevertices
    reversecurve
    simplifycurve
    splitcurve
    trimcurve
  surface methods
    addbox
    addcone
    addcylinder
    addedgesrf
    addloftsrf
    addnurbssurface
    addplanarsrf
    addplanesurface
    addrailrevsrf
    addrevsrf
    addsphere
    addsrfcontrolptgrid
    addsrfpt
    addsrfptgrid
    addtorus
    booleandifference
    booleanintersection
    booleanunion
    brepclosestpoint
    capplanarholes
    duplicateedgecurves
    evaluatesurface
    explodepolysurfaces
    extractisocurve
    extrudecurve
    extrudecurvepoint
    extrudecurvestraight
    extrudesurface
    flipsurface
    insertsurfaceknot
    intersectbreps
    isbrep
    isplanesurface
    ispointinsurface
    ispointonsurface
    ispolysurface
    ispolysurfaceclosed
    ispolysurfaceplanar
    issurface
    issurfaceclosed
    issurfaceperiodic
    issurfaceplanar
    issurfacerational
    issurfacesingular
    issurfacetrimmed
    joinsurfaces
    makesurfaceperiodic
    offsetsurface
    pullcurve
    shortpath
    shrinktrimmedsurface
    splitbrep
    surfacearea
    surfaceareacentroid
    surfaceareamoments
    surfaceclosestpoint
    surfacecontourpoints
    surfacecurvature
    surfacecurvatureanalysis
    surfacedegree
    surfacedomain
    surfaceeditpoints
    surfaceevaluate
    surfaceframe
    surfaceisocurvedensity
    surfacenormal
    surfaceknotcount
    surfaceknots
    surfacepointcount
    surfacepoints
    surfaceprincipalcurvature
    surfacesurfaceintersection
    surfacevolume
    surfacevolumecentroid
    surfacevolumemoments
    surfaceweights
  geometry methods
    addleader
    addpoint
    addpointcloud
    addpoints
    addtext
    addtextdot
    angle
    angle2
    boundingbox
    comparegeometry
    distance
    distancetoplane
    isleader
    ispoint
    ispointcloud
    istext
    istextdot
    isvectorparallelto
    isvectorperpendicularto
    isvectortiny
    isvectorzero
    moveplane
    pi
    planeclosestpoint
    planeequation
    planefitfrompoints
    planefromframe
    planefromnormal
    planefrompoints
    pointadd
    pointcloudcount
    pointcloudpoints
    pointcompare
    pointcoordinates
    pointdivide
    pointsarecoplanar
    pointscale
    pointsubtract
    pointtransform
    polar
    pullpoints
    rotateplane
    textdotpoint
    textdottext
    textobjectfont
    textobjectheight
    textobjectplane
    textobjectpoint
    textobjectstyle
    textobjecttext
    todegrees
    toradians
    vectoradd
    vectorcompare
    vectorcreate
    vectorcrossproduct
    vectordivide
    vectordotproduct
    vectorlength
    vectormultiply
    vectorreverse
    vectorrotate
    vectorscale
    vectorsubtract
    vectorunitize
    worldxyplane
    worldyzplane
    worldzxplane
    xformcplanetoworld
    xformscreentoworld
    xformworldtocplane
    xformworldtoscreen
  mesh methods
    addmesh
    disjointmeshcount
    ismesh
    ismeshclosed
    mesharea
    meshareacentroid
    meshcontourpoints
    meshfacecenters
    meshfacecount
    meshfacenormals
    meshfaces
    meshfacevertices
    meshhasfacenormals
    meshhastexturecoordinates
    meshhasvertexcolors
    meshhasvertexnormals
    meshnakededgepoints
    meshoffset
    meshquadcount
    meshquadstotriangles
    meshtexturecoordinates
    meshtrianglecount
    meshvertexcolors
    meshvertexcount
    meshvertexnormals
    meshvertices
    meshvolume
    meshvolumecentroid
    pullcurvetomesh
    splitdisjointmesh
    unifymeshnormals
  object grip methods
    enableobjectgrips
    nextobjectgrip
    getobjectgrip
    getobjectgrips
    objectgripcount
    objectgriplocation
    objectgriplocations
    objectgripson
    objectgripsselected
    prevobjectgrip
    selectedobjectgrips
    selectobjectgrip
    selectobjectgrips
    unselectobjectgrips
    unselectobjectgrip
  layer methods
    addlayer
    currentlayer
    deletelayer
    expandlayer
    islayer
    islayerchangeable
    islayerchildof
    islayercurrent
    islayerempty
    islayerexpanded
    islayerlocked
    islayeron
    islayerparentof
    islayerreference
    islayerselectable
    islayervisible
    layerchildcount
    layerchildren
    layercolor
    layercount
    layerlinetype
    layerlocked
    layermaterialindex
    layermode
    layernames
    layerorder
    layerprintcolor
    layerprintwidth
    layervisible
    parentlayer
    purgelayer
    renamelayer
  view methods
    addnamedcplane
    addnamedview
    currentview
    deletenamedcplane
    deletenamedview
    isview
    isviewcurrent
    isviewmaximized
    isviewperspective
    isviewtitlevisible
    maximizerestoreview
    namedcplane
    namedcplanes
    namedviews
    renameview
    restorenamedcplane
    restorenamedview
    rotatecamera
    rotateview
    showviewtitle
    synchronizecplanes
    tiltview
    viewcamera
    viewcameralens
    viewcameratarget
    viewcameraup
    viewcplane
    viewdisplaymode
    viewnames
    viewprojection
    viewsize
    viewtarget
    wallpaper
    wallpapergrayscale
    wallpaperhidden
    zoomboundingbox
    zoomextents
    zoomselected
  dimension methods
    adddimstyle
    currentdimstyle
    deletedimstyle
    dimensionstyle
    dimensiontext
    dimensionusertext
    dimensionvalue
    dimscale
    dimstyleangleprecision
    dimstylearrowsize
    dimstylecount
    dimstyleextension
    dimstylefont
    dimstyleleaderarrowsize
    dimstylelinearprecision
    dimstylenames
    dimstylenumberformat
    dimstyleoffset
    dimstyletextalignment
    dimstyletextheight
    isaligneddimension
    isangulardimension
    isdiameterdimension
    isdimstyle
    isdimension
    isdimstylereference
    islineardimension
    isordinatedimension
    isradialdimension
    renamedimstyle
  group methods
    addgroup
    addobjectstogroup
    addobjecttogroup
    deletegroup
    groupcount
    groupnames
    isgroup
    isgroupempty
    removeobjectfromallgroups
    removeobjectfromgroup
    removeobjectfromtopgroup
    removeobjectsfromgroup
    renamegroup
  block methods
    blockcontainercount
    blockcontainers
    blockcount
    blockdescription
    blockinstancecount
    blockinstanceinsertpoint
    blockinstancename
    blockinstances
    blockinstancexform
    blocknames
    blockobjectcount
    blockobjects
    blockpath
    blockurl
    blockurltag
    deleteblock
    explodeblockinstance
    insertblock
    isblock
    isblockembedded
    isblockinstance
    isblockinuse
    isblockreference
    renameblock
  material methods
    addmaterialtolayer
    addmaterialtoobject
    ismaterialdefault
    ismaterialreference
    matchmaterial
    materialbump
    materialcolor
    materialname
    materialreflectivecolor
    materialshine
    materialtexture
    materialtransparency
  light methods
    adddirectionallight
    addlinearlight
    addpointlight
    addrectangularlight
    addspotlight
    enablelight
    isdirectionallight
    islight
    islightenabled
    islightreference
    islinearlight
    ispointlight
    isrectangularlight
    isspotlight
    lightcolor
    lightcount
    lightdirection
    lightlocation
    lightname
    lightobjects
    spotlighthardness
    spotlightradius
    spotlightshadowintensity
  linetype methods
    islinetype
    islinetypereference
    linetypecount
    linetypenames
  user data methods
    attributedatacount
    deleteattributedata
    deletedocumentdata
    deleteobjectdata
    documentdatacount
    getattributedata
    getdocumentdata
    getobjectdata
    isattributedata
    isdocumentdata
    isobjectdata
    objectdatacount
    setattributedata
    setdocumentdata
    setobjectdata
  user interface methods
    browseforfolder
    checklistbox
    combolistbox
    editbox
    getangle
    getboolean
    getbox
    getcolor
    getdistance
    getinteger
    getlayer
    getlinetype
    getpoint
    getpointoncurve
    getpointonmesh
    getpointonsurface
    getpoints
    getprintwidth
    getreal
    getrectangle
    getstring
    integerbox
    htmlbox
    listbox
    messagebeep
    messagebox
    multilistbox
    openfilename
    popupmenu
    propertylistbox
    realbox
    savefilename
    stringbox
  toolbar methods
    addtoolbar
    addtoolbarbutton
    addtoolbarcollection
    closetoolbarcollection
    deletetoolbar
    hidetoolbar
    istoolbar
    istoolbarcollection
    istoolbardocked
    istoolbarvisible
    opentoolbarcollection
    savetoolbarcollection
    savetoolbarcollectionas
    showtoolbar
    toolbarcollectioncount
    toolbarcollectionnames
    toolbarcollectionpath
    toolbarcount
    toolbarnames
  utility methods
    allprocedures
    clipboardtext
    cullduplicatenumbers
    cullduplicatepoints
    cullduplicatestrings
    currentprinter
    getsettings
    isprocedure
    joinarrays
    printernames
    pt2str
    savesettings
    simplifyarray
    sleep
    sortnumbers
    sortpointlist
    sortpoints
    sortstrings
    spooltoprinter
    str2pt
    str2ptarray
    strtok
    version
sample scripts
  annotatecurveendpoints
  arraypointsonsurface
  circlefromcircumference
  copyobjectstolayer
  createshortcut
  currentmodelinfo
  curvelength
  drawparametriccurve
  dumpdocumentdata
  dynamicarray
  exportpoints
  formatmessage
  gardenpath
  getarraydim
  importcurvefromexcel
  makenurbscurve
  math.rvb
  readtextfile
  rgb helpers
  rhino.rvb
  ringtorus