Hide Table of Contents
IGetEntityParams Method (IMateEntity2)

Gets the parameters of this mate entity.

.NET Syntax

Visual Basic (Declaration) 
Function IGetEntityParams( _
   ByVal NParamsSize As System.Integer _
) As System.Double
Visual Basic (Usage) 
Dim instance As IMateEntity2
Dim NParamsSize As System.Integer
Dim value As System.Double
 
value = instance.IGetEntityParams(NParamsSize)
C# 
System.double IGetEntityParams( 
   System.int NParamsSize
)
C++/CLI 
System.double IGetEntityParams( 
&   System.int NParamsSize
) 

Parameters

NParamsSize
Number of parameters for this mate entity

Return Value

  • in-process, unmanaged C++: Pointer to an array of doubles representing the parameters for this mate entity (see Remarks)
  • VBA, VB.NET, C#, and C++/CLI: Not supported

    See In-process Methods for details about this type of method.

  • Remarks

    Call IMateEntity2::GetEntityParamsSize to get the value for the size of the array.

    The return value is the following array of doubles:

     [ pointX, pointY, pointZ, vectorI, vectorJ, vectorK, radius1, radius2 ]

     where

    •   pointX is the X location of this mate entity in the assembly model space

    •   pointY is the Y location of this mate entity in the assembly model space

    •   pointZ is the Z location of this mate entity in the assembly model space

    •   vectorI is the i component of the assembly mate vector

    •   vectorJ is the j component of the assembly mate vector

    •   vectorK is the k component of the assembly mate vector

    •   radius1 is the value for the first radius

    •   radius2 is the value for the second radius

    To define the mate entity, the following information is returned based on the mate type. All coordinate information is given in terms of the assembly coordinate system where the mate resides.

     

    Mate Type

    Returned

    swMatePoint

    pointX, pointY, pointZ

    swMateLine

    pointX, pointY, pointZ, vectorI, vectorJ, vectorK where the point is a point on the line and the vector represents the line direction.

    swMatePlane

    pointX, pointY, pointZ, vectorI, vectorJ, vectorK where the point is a point on the plane and the vector represents the plane normal.

    swMateCylinder

    pointX, pointY, pointZ, vectorI, vectorJ, vectorK, radius1 where the point is a point on the cylinder axis and the vector represents the cylinder axis.

    swMateCone

    pointX, pointY, pointZ, vectorI, vectorJ, vectorK, radius1, radius2 where the point is a point on the cone axis and the vector represents the cone axis.

     

     

    To get the IMateEntity2 interface, use IMate2::MateEntity.

     

    See Also

    Availability

    SOLIDWORKS 2004 FCS, Revision Number


    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:   IGetEntityParams Method (IMateEntity2)
    *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) 2019 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.