Hide Table of Contents
GetPlotSettingsOptionForHiddenAndExcludedBody Method (ICWResults)

Gets hidden and excluded body options for the specified plot.

.NET Syntax

Visual Basic (Declaration) 
Function GetPlotSettingsOptionForHiddenAndExcludedBody( _
   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.GetPlotSettingsOptionForHiddenAndExcludedBody(SPlotName, ErrorCode)
C# 
System.object GetPlotSettingsOptionForHiddenAndExcludedBody( 
   System.string SPlotName,
   out System.int ErrorCode
)
C++/CLI 
System.Object^ GetPlotSettingsOptionForHiddenAndExcludedBody( 
&   System.String^ SPlotName,
&   [Out] System.int ErrorCode
) 

Parameters

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

Return Value

Array of hidden and excluded body options (see Remarks)

Example

Remarks

Call ICWResults::GetPlotNames to populate SPlotName.

The 0-based array contains 12 elements:

Array element... Contains...
0 Boolean; whether to show hidden bodies
1 Hidden body translucent color option as defined in swsPlotShowHiddenBodiesOptionValue_e; valid only if array element 0 is true
2 R[0-255] value for single translucent color; valid only if array element 0 is true, and array element 1 is swsPlotShowHiddenBodiesOptionValue_e.swsPlotHiddenBodyTranslucentSingleColor
3 G[0-255] value for single translucent color; valid only if array element 0 is true, and array element 1 is swsPlotShowHiddenBodiesOptionValue_e.swsPlotHiddenBodyTranslucentSingleColor
4 B[0-255] value for single translucent color; valid only if array element 0 is true, and array element 1 is swsPlotShowHiddenBodiesOptionValue_e.swsPlotHiddenBodyTranslucentSingleColor
5 0.0 <= transparency or intensity of the translucent single color or part colors <= 1.0; valid only if array element 0 is true
6 Boolean; whether to show excluded bodies
7 Excluded body translucent color option as defined in swsPlotShowExcludedBodiesOptionValue_e; valid only if array element 6 is true
8 R[0-255] value for single translucent color; valid only if array element 6 is true, and array element 7 is swsPlotShowExcludedBodiesOptionValue_e.swsPlotExcludedBodyTranslucentSingleColor
9 G[0-255] value for single translucent color; valid only if array element 6 is true, and array element 7 is swsPlotShowExcludedBodiesOptionValue_e.swsPlotExcludedBodyTranslucentSingleColor
10 B[0-255] value for single translucent color; valid only if array element 6 is true, and array element 7 is swsPlotShowExcludedBodiesOptionValue_e.swsPlotExcludedBodyTranslucentSingleColor
11 0.0 <= transparency or intensity of the translucent single color or part colors <= 1.0; valid only if array element 6 is true
 

See Also

Availability

SOLIDWORKS Simulation API 2016 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:   GetPlotSettingsOptionForHiddenAndExcludedBody 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.