wiki:sns:snsscript:visualization_functions []

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

===== boolSuccess = objSnSScript.SolutionDisplayEnable(GUID, Component, DeformationScale) =====

Turns on display of the solution results associated with the specified solid. Coloration of the solid corresponds to the specified solution component. Deflection of the displayed geometry is controlled by the deformation scale parameter.

^Parameter^Description|
|String GUID|Rhino ID of the object.|
|String Component|The string indicating which component you would like to visualize. See [[simulation querying functions|this table]] of components and their corresponding string tags.|
|Double DeformationScale|The scale factor to apply to the computed displacement when displaying the results.|
^Return Type^Description|
|Boolean|True if the solution display was successfully enabled, false otherwise.|

===== boolSuccess = objSnSScript.SolutionDisplayDisable(GUID) =====

Turns off display of the solution results associated with the specified solid.

^Parameter^Description|
|String GUID|Rhino ID of the object.|
^Return Type^Description|
|Boolean|True if the solution display was successfully disabled, false otherwise.|

===== boolSuccess = objSnSScript.SolutionDisplayReset() =====

Turns off display of all solution results.

^Return Type^Description|
|Boolean|True.|

===== boolSuccess = objSnSScript.SetLegendColorScale(GUID, LegendID) =====

Sets the color scale to use for the legend associated with the specified solid.

^Parameter^Description|
|String GUID|Rhino ID of the object.|
|Integer LegendID|{{:wiki:sns:snsscript:z22.png?150|}}|
^Return Type^Description|
|Boolean|True if the legend scale was successfully set.|

===== boolSuccess = objSnSScript.SetLegendLimits(GUID, LegendMin, LegendMax) =====

Sets the maximum and minimum values for the legend associated with the specified solid. Legend limit settings are overridden by any subsequent calls to SolutionDisplayEnable(...).

^Parameter^Description|
|String GUID|Rhino ID of the object.|
|Double LegendMin|The lower limit for the legend.|
|Double LegendMax|The upper limit for the legend.|
^Return Type^Description|
|Boolean|True if the legend limits were successfully set.|

===== boolSuccess = objSnSScript.BakeSolution(GUID, DeformationScale) =====

Inserts into the document a surface mesh representation of the solid, deformed based on the simulation data and the specified deformation scale.

^Parameter^Description|
|String GUID|Rhino ID of the object.|
|Double DeformationScale|The scale factor to apply to the computed displacement when displaying the results.|
^Return Type^Description|
|Boolean|True if the object was successfully baked, false otherwise.|