wiki:sns:snsscript:utilities []

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
~~NOTOC~~
====== Utility Functions ======

===== boolSuccess = objSnSScript.SetOutputOnOff(On) =====

Turns on/off status output from the SnSScript functions.

^Parameter^Description|
|Boolean On|True to turn on status output, false to turn off status output.|
^Return Type^Description|
|Boolean|True if output has been set as desired.|

===== boolSuccess = objSnSScript.Purge(GUID) =====

Removes solution results associated with the specified solid.

^Parameter^Description|
|String GUID|Rhino ID of the object.|
^Return Type^Description|
|Boolean|True.|

===== boolSuccess = objSnSScript.Reset(GUID) =====

Removes Scan&Solve data from the specified solid.

^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.|