Hide Table of Contents
IGetBox Method (IComponent2)

Gets the bounding box for component.

.NET Syntax

Visual Basic (Declaration) 
Function IGetBox( _
   ByVal IncludeRefPlanes As System.Boolean, _
   ByVal IncludeSketches As System.Boolean _
) As System.Double
Visual Basic (Usage) 
Dim instance As IComponent2
Dim IncludeRefPlanes As System.Boolean
Dim IncludeSketches As System.Boolean
Dim value As System.Double
 
value = instance.IGetBox(IncludeRefPlanes, IncludeSketches)
C# 
System.double IGetBox( 
   System.bool IncludeRefPlanes,
   System.bool IncludeSketches
)
C++/CLI 
System.double IGetBox( 
&   System.bool IncludeRefPlanes,
&   System.bool IncludeSketches
) 

Parameters

IncludeRefPlanes
True includes reference planes with the returned bounding box, false does not
IncludeSketches

True includes sketches with the returned bounding box, false does not

Return Value

Two diagonal points that bound the component; the format is a pointer to an array of 6 doubles

Remarks

The resulting box encloses the object, but it might not be the tightest box.

The X, Y, Z points returned by SOLIDWORKS are the lower- and upper-diagonal corners that bound the component with the box sides parallel to the X, Y and Z axes. SOLIDWORKS returns box dimensions that enclose the component and are typically close to the minimum possible size.

The return value is an array of doubles as follows:


[ XCorner1, YCorner1, ZCorner1, XCorner2, YCorner2, ZCorner2 ]


It is possible for this method to return S_false for COM or a NULL VARIANT for Dispatch. This occurs if your application calls IComponent2::IGetBox with a component that represented a subassembly and that subassembly is not loaded. Once the subassembly is loaded, SOLIDWORKS returns the correct bounds and IComponent2::IGetBox returns S_OK.

The user interface behavior is the same. When the user selects a subassembly that is not loaded, there is no selection box around the subassembly. However, once the subassembly is loaded, there is a selection box.

IMPORTANT: The values returned are approximate and should not be used for comparison or calculation purposes. Furthermore, the bounding box may vary after rebuilding the model.

 

See Also

Availability

SOLIDWORKS 2001Plus FCS, Revision Number 10.0


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:   IGetBox Method (IComponent2)
*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) 2015 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.