wiki:sns:snsscript:utilities []

This is an old revision of the document!

<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> 
<title>Scan&Solve Scripting Documentation</title> 
<meta name="description" content="Scan&Solve(tm) for Rhino Help"> 
<meta name="copyright" content="Copyright (c) 2011 Intact Solutions LLC"> 
<meta name="author" content="Intact Solutions"> 
  <link href="sns_docs.css" rel="stylesheet" type="text/css" />

</head> <body>

<a href=“index.htm”><h1>Scan&Solve™ Scripting Documentation</h1></a>

<h1>Utility Functions</a></h1>

<h3>boolSuccess = objSnSScript.SetOutputOnOff(On)</h3> <p>Turns on/off status output from the SnSScript functions.</p> <table id=“funcdesc”>

  <tr><th style="width:200px">Parameter</th><th style="width:400px">Description</th></tr>	
  <tr><td>Boolean On</td><td>True to turn on status output, false to turn off status output.</td></tr>
  <tr><th>Return Type</th><th style="width:400px">Description</th></tr>
  <tr><td>Boolean</td><td>True if output has been set as desired.</td></tr>

</table>

<h3>boolSuccess = objSnSScript.Purge(GUID)</h3> <p>Removes solution results associated with the specified solid.</p> <table id=“funcdesc”>

  <tr><th style="width:200px">Parameter</th><th style="width:400px">Description</th></tr>	
  <tr><td>String GUID</td><td>Rhino ID of the object.</td></tr>
  <tr><th>Return Type</th><th style="width:400px">Description</th></tr>
  <tr><td>Boolean</td><td>True.</td></tr>

</table>

<h3>boolSuccess = objSnSScript.Reset(GUID)</h3> <p>Removes Scan&Solve data from the specified solid.</p> <table id=“funcdesc”>

  <tr><th style="width:200px">Parameter</th><th style="width:400px">Description</th></tr>	
  <tr><td>String GUID</td><td>Rhino ID of the object.</td></tr>
  <tr><th>Return Type</th><th style="width:400px">Description</th></tr>
  <tr><td>Boolean</td><td>True.</td></tr>

</table>

<h3>intFaceIndex = objSnSScript.GetNearestFace(GUID, Point)</h3> <p>Returns the index of the face nearest to the specified point.</p> <table id=“funcdesc”>

  <tr><th style="width:200px">Parameter</th><th style="width:400px">Description</th></tr>	
  <tr><td>String GUID</td><td>Rhino ID of the object.</td></tr>
  <tr><td>Array(double) Point</td><td>Query point on or near the face to be picked.</td></tr>
  <tr><th>Return Type</th><th style="width:400px">Description</th></tr>
  <tr><td>Boolean</td><td>The index of the face nearest to the specified point, -1 on failure.</td></tr>

</table>

<h3>intEdgeIndex = objSnSScript.GetNearestEdge(GUID, Point)</h3> <p>Returns the index of the edge nearest to the specified point.</p> <table id=“funcdesc”>

  <tr><th style="width:200px">Parameter</th><th style="width:400px">Description</th></tr>	
  <tr><td>String GUID</td><td>Rhino ID of the object.</td></tr>
  <tr><td>Array(double) Point</td><td>Query point on or near the edge to be picked.</td></tr>
  <tr><th>Return Type</th><th style="width:400px">Description</th></tr>
  <tr><td>Boolean</td><td>The index of the edge nearest to the specified point, -1 on failure.</td></tr>

</table>

<h3>boolSuccess = objSnSScript.PrintVersion()</h3> <p>Prints the current version of the SnSScript plug-in.</p> <table id=“funcdesc”>

  <tr><th style="width:200px">Return Type</th><th style="width:400px">Description</th></tr>
  <tr><td>Boolean</td><td>True.</td></tr>

</table>

</body> </html>