Differences

This shows you the differences between two versions of the page.

--- wiki:sns:snsscript:utilities [2017/07/14 09:40] – created zach
+++ wiki:sns:snsscript:utilities [2017/07/14 13:53] (current) – claire
@@ Line 1: / Line 1: @@
-<html xmlns="http://www.w3.org/1999/xhtml" >
+~~NOTOC~~
-<head>
+====== Utility Functions ======
-	<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>
-<div id="wrap">
-<div id="header"><a href="index.htm"><h1>Scan&amp;Solve&#8482; Scripting Documentation</h1></a></div>
-<h1>Utility Functions</a></h1>
-<h3>boolSuccess = objSnSScript.SetOutputOnOff(On)</h3>
+===== boolSuccess = objSnSScript.SetOutputOnOff(On) =====
-<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>
+Turns on/off status output from the SnSScript functions.
-<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>
+^Parameter^Description|
-<p>Removes Scan&amp;Solve data from the specified solid.</p>
+|Boolean On|True to turn on status output, false to turn off status output.|
-<table id="funcdesc">
+^Return Type^Description|
-    <tr><th style="width:200px">Parameter</th><th style="width:400px">Description</th></tr>
+|Boolean|True if output has been set as desired.|
-    <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>
+===== boolSuccess = objSnSScript.Purge(GUID) =====
-<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>
+Removes solution results associated with the specified solid.
-<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>
+^Parameter^Description|
-<p>Prints the current version of the SnSScript plug-in.</p>
+|String GUID|Rhino ID of the object.|
-<table id="funcdesc">
+^Return Type^Description|
-    <tr><th style="width:200px">Return Type</th><th style="width:400px">Description</th></tr>
+|Boolean|True.|
-    <tr><td>Boolean</td><td>True.</td></tr>
-</table>
+===== boolSuccess = objSnSScript.Reset(GUID) =====
-<div id="footer">
+Removes Scan&Solve data from the specified solid.
-<p>Copyright 2013, Intact Solutions, LLC.</p>
-</div>
+^Parameter^Description|
+|String GUID|Rhino ID of the object.|
+^Return Type^Description|
+|Boolean|True.|
+===== intFaceIndex = objSnSScript.GetNearestFace(GUID, Point) =====
+Returns the index of the face nearest to the specified point.
+^Parameter^Description|
+|String GUID|Rhino ID of the object.|
+|Array(double) Point|Query point on or near the face to be picked.|
+^Return Type^Description|
+|Boolean|The index of the face nearest to the specified point, -1 on failure.|
+===== intEdgeIndex = objSnSScript.GetNearestEdge(GUID, Point) =====
+Returns the index of the edge nearest to the specified point.
+^Parameter^Description|
+|String GUID|Rhino ID of the object.|
+|Array(double) Point|Query point on or near the edge to be picked.|
+^Return Type^Description|
+|Boolean|The index of the edge nearest to the specified point, -1 on failure.|
+===== boolSuccess = objSnSScript.PrintVersion() =====
+Prints the current version of the SnSScript plug-in.
+^Return Type^Description|
+|Boolean|True.|
-</div>
-</body>
-</html>