wiki:sns:snsscript:visualization_functions
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
| wiki:sns:snsscript:visualization_functions [2017/07/14 09:38] – created zach | wiki:sns:snsscript:visualization_functions [2017/07/14 13:52] (current) – claire | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ===== Simulation Visualization ===== | + | ~~NOTOC~~ |
| + | ====== Simulation Visualization | ||
| - | ==== boolSuccess = objSnSScript.SolutionDisplayEnable(GUID, | + | ===== boolSuccess = objSnSScript.SolutionDisplayEnable(GUID, |
| 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. | 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. | ||
| Line 7: | Line 8: | ||
| ^Parameter^Description| | ^Parameter^Description| | ||
| |String GUID|Rhino ID of the object.| | |String GUID|Rhino ID of the object.| | ||
| - | |String Component|The string indicating which component you would like to visualize. See [[querying|this table]] of components and their corresponding string tags.| | + | |String Component|The string indicating which component you would like to visualize. See [[simulation |
| |Double DeformationScale|The scale factor to apply to the computed displacement when displaying the results.| | |Double DeformationScale|The scale factor to apply to the computed displacement when displaying the results.| | ||
| ^Return Type^Description| | ^Return Type^Description| | ||
| |Boolean|True if the solution display was successfully enabled, false otherwise.| | |Boolean|True if the solution display was successfully enabled, false otherwise.| | ||
| - | ==== boolSuccess = objSnSScript.SolutionDisplayDisable(GUID) ==== | + | ===== boolSuccess = objSnSScript.SolutionDisplayDisable(GUID) |
| Turns off display of the solution results associated with the specified solid. | Turns off display of the solution results associated with the specified solid. | ||
| Line 21: | Line 22: | ||
| |Boolean|True if the solution display was successfully disabled, false otherwise.| | |Boolean|True if the solution display was successfully disabled, false otherwise.| | ||
| - | ==== boolSuccess = objSnSScript.SolutionDisplayReset() ==== | + | ===== boolSuccess = objSnSScript.SolutionDisplayReset() |
| Turns off display of all solution results. | Turns off display of all solution results. | ||
| Line 28: | Line 29: | ||
| |Boolean|True.| | |Boolean|True.| | ||
| - | ==== boolSuccess = objSnSScript.SetLegendColorScale(GUID, | + | ===== boolSuccess = objSnSScript.SetLegendColorScale(GUID, |
| Sets the color scale to use for the legend associated with the specified solid. | Sets the color scale to use for the legend associated with the specified solid. | ||
| Line 34: | Line 35: | ||
| ^Parameter^Description| | ^Parameter^Description| | ||
| |String GUID|Rhino ID of the object.| | |String GUID|Rhino ID of the object.| | ||
| - | |Integer LegendID|{{images:legends.png}}| | + | |Integer LegendID|{{: |
| ^Return Type^Description| | ^Return Type^Description| | ||
| |Boolean|True if the legend scale was successfully set.| | |Boolean|True if the legend scale was successfully set.| | ||
| - | ==== boolSuccess = objSnSScript.SetLegendLimits(GUID, | + | ===== boolSuccess = objSnSScript.SetLegendLimits(GUID, |
| 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(...). | 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(...). | ||
| Line 49: | Line 50: | ||
| |Boolean|True if the legend limits were successfully set.| | |Boolean|True if the legend limits were successfully set.| | ||
| - | ==== boolSuccess = objSnSScript.BakeSolution(GUID, | + | ===== boolSuccess = objSnSScript.BakeSolution(GUID, |
| Inserts into the document a surface mesh representation of the solid, deformed based on the simulation data and the specified deformation scale. | Inserts into the document a surface mesh representation of the solid, deformed based on the simulation data and the specified deformation scale. | ||
wiki/sns/snsscript/visualization_functions.1500046682.txt.gz · Last modified: 2017/07/14 09:38 by zach