Simulation Querying Functions

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.

ParameterDescription
String GUIDRhino ID of the object.
String ComponentThe string indicating which component you would like to visualize. See this table of components and their corresponding string tags.
Double DeformationScaleThe scale factor to apply to the computed displacement when displaying the results.
Return TypeDescription
BooleanTrue 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.

ParameterDescription
String GUIDRhino ID of the object.
Return TypeDescription
BooleanTrue if the solution display was successfully disabled, false otherwise.

boolSuccess = objSnSScript.SolutionDisplayReset()

Turns off display of all solution results.

Return TypeDescription
BooleanTrue.

boolSuccess = objSnSScript.SetLegendColorScale(GUID, LegendID)

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

ParameterDescription
String GUIDRhino ID of the object.
Integer LegendID
Return TypeDescription
BooleanTrue 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(...).

ParameterDescription
String GUIDRhino ID of the object.
Double LegendMinThe lower limit for the legend.
Double LegendMaxThe upper limit for the legend.
Return TypeDescription
BooleanTrue 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.

ParameterDescription
String GUIDRhino ID of the object.
Double DeformationScaleThe scale factor to apply to the computed displacement when displaying the results.
Return TypeDescription
BooleanTrue if the object was successfully baked, false otherwise.