wiki:sns:snsscript:utilities
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
wiki:sns:snsscript:utilities [2017/07/14 09:41] – zach | wiki:sns:snsscript:utilities [2017/07/14 13:53] (current) – claire | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ~~NOTOC~~ | ||
====== Utility Functions ====== | ====== Utility Functions ====== | ||
- | ==== boolSuccess = objSnSScript.SetOutputOnOff(On) ==== | + | ===== boolSuccess = objSnSScript.SetOutputOnOff(On) |
Turns on/off status output from the SnSScript functions. | Turns on/off status output from the SnSScript functions. | ||
Line 10: | Line 11: | ||
|Boolean|True if output has been set as desired.| | |Boolean|True if output has been set as desired.| | ||
- | ==== boolSuccess = objSnSScript.Purge(GUID) ==== | + | ===== boolSuccess = objSnSScript.Purge(GUID) |
Removes solution results associated with the specified solid. | Removes solution results associated with the specified solid. | ||
Line 19: | Line 20: | ||
|Boolean|True.| | |Boolean|True.| | ||
- | ==== boolSuccess = objSnSScript.Reset(GUID) ==== | + | ===== boolSuccess = objSnSScript.Reset(GUID) |
Removes Scan& | Removes Scan& | ||
Line 28: | Line 29: | ||
|Boolean|True.| | |Boolean|True.| | ||
- | ==== intFaceIndex = objSnSScript.GetNearestFace(GUID, | + | ===== intFaceIndex = objSnSScript.GetNearestFace(GUID, |
Returns the index of the face nearest to the specified point. | Returns the index of the face nearest to the specified point. | ||
Line 38: | Line 39: | ||
|Boolean|The index of the face nearest to the specified point, -1 on failure.| | |Boolean|The index of the face nearest to the specified point, -1 on failure.| | ||
- | ==== intEdgeIndex = objSnSScript.GetNearestEdge(GUID, | + | ===== intEdgeIndex = objSnSScript.GetNearestEdge(GUID, |
Returns the index of the edge nearest to the specified point. | Returns the index of the edge nearest to the specified point. | ||
Line 48: | Line 49: | ||
|Boolean|The index of the edge nearest to the specified point, -1 on failure.| | |Boolean|The index of the edge nearest to the specified point, -1 on failure.| | ||
- | ==== boolSuccess = objSnSScript.PrintVersion() ==== | + | ===== boolSuccess = objSnSScript.PrintVersion() |
Prints the current version of the SnSScript plug-in. | Prints the current version of the SnSScript plug-in. |
wiki/sns/snsscript/utilities.1500046885.txt.gz · Last modified: 2017/07/14 09:41 by zach