Hide Table of Contents
GetPlotSettings Method (ICWResults)

Gets the settings for the specified plot.

.NET Syntax

Visual Basic (Declaration) 
Function GetPlotSettings( _
   ByVal SPlotName As System.String, _
   ByRef ErrorCode As System.Integer _
) As System.Object
Visual Basic (Usage) 
Dim instance As ICWResults
Dim SPlotName As System.String
Dim ErrorCode As System.Integer
Dim value As System.Object
 
value = instance.GetPlotSettings(SPlotName, ErrorCode)
C# 
System.object GetPlotSettings( 
   System.string SPlotName,
   out System.int ErrorCode
)
C++/CLI 
System.Object^ GetPlotSettings( 
&   System.String^ SPlotName,
&   [Out] System.int ErrorCode
) 

Parameters

SPlotName
Plot name (see Remarks)
ErrorCode
Error as defined in swsResultsError_e

Return Value

Array of plot settings (see Remarks)

Example

Remarks

Call ICWResults::GetPlotNames to populate SPlotName.

The 0-based array contains 11 elements:

Array element... Contains...
0 Display option for active fringe plot as defined in swsPlotFringeSettingsOptionValue_e
1 Display option for model boundary as defined in swsPlotBoundarySettingsOptionValue_e
2 R[0-255] value for model/mesh color; valid only if array element 1 is not swsPlotBoundarySettingsOptionValue_e.swsPlotBoundaryNone
3 G[0-255] value for model/mesh color; valid only if array element 1 is not swsPlotBoundarySettingsOptionValue_e.swsPlotBoundaryNone
4 B[0-255] value for model/mesh color; valid only if array element 1 is not swsPlotBoundarySettingsOptionValue_e.swsPlotBoundaryNone
5 Boolean; whether to superimpose the undeformed model on the deformed model
6 Deformed plot translucent color option as defined in swsPlotDeformedShapeOptionSuperImposeValue_e; valid only if array element 5 is true
7 R[0-255] value for single translucent color; valid only if array element 5 is true, and array element 6 is swsPlotDeformedShapeOptionSuperImposeValue_e.swsPlotDeformedShapeSuperImposeModel_TranslucentSingleColor
8 G[0-255] value for single translucent color; valid only if array element 5 is true, and array element 6 is swsPlotDeformedShapeOptionSuperImposeValue_e.swsPlotDeformedShapeSuperImposeModel_TranslucentSingleColor
9 B[0-255] value for single translucent color; valid only if array element 5 is true, and array element 6is swsPlotDeformedShapeOptionSuperImposeValue_e.swsPlotDeformedShapeSuperImposeModel_TranslucentSingleColor
10 0.0 <= Transparency or intensity of the translucent single color or part colors <= 1.0; valid only if array element 5 is true

 

See Also

Availability

SOLIDWORKS Simulation API 2015 SP0


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   GetPlotSettings Method (ICWResults)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:




x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2017 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.