Hide Table of Contents
AddMate3 Method (IAssemblyDoc)

Adds a mate relationship to the selected entities.

.NET Syntax

Visual Basic (Declaration) 
Function AddMate3( _
   ByVal MateTypeFromEnum As System.Integer, _
   ByVal AlignFromEnum As System.Integer, _
   ByVal Flip As System.Boolean, _
   ByVal Distance As System.Double, _
   ByVal DistanceAbsUpperLimit As System.Double, _
   ByVal DistanceAbsLowerLimit As System.Double, _
   ByVal GearRatioNumerator As System.Double, _
   ByVal GearRatioDenominator As System.Double, _
   ByVal Angle As System.Double, _
   ByVal AngleAbsUpperLimit As System.Double, _
   ByVal AngleAbsLowerLimit As System.Double, _
   ByVal ForPositioningOnly As System.Boolean, _
   ByRef ErrorStatus As System.Integer _
) As Mate2
Visual Basic (Usage) 
Dim instance As IAssemblyDoc
Dim MateTypeFromEnum As System.Integer
Dim AlignFromEnum As System.Integer
Dim Flip As System.Boolean
Dim Distance As System.Double
Dim DistanceAbsUpperLimit As System.Double
Dim DistanceAbsLowerLimit As System.Double
Dim GearRatioNumerator As System.Double
Dim GearRatioDenominator As System.Double
Dim Angle As System.Double
Dim AngleAbsUpperLimit As System.Double
Dim AngleAbsLowerLimit As System.Double
Dim ForPositioningOnly As System.Boolean
Dim ErrorStatus As System.Integer
Dim value As Mate2
 
value = instance.AddMate3(MateTypeFromEnum, AlignFromEnum, Flip, Distance, DistanceAbsUpperLimit, DistanceAbsLowerLimit, GearRatioNumerator, GearRatioDenominator, Angle, AngleAbsUpperLimit, AngleAbsLowerLimit, ForPositioningOnly, ErrorStatus)
C# 
Mate2 AddMate3( 
   System.int MateTypeFromEnum,
   System.int AlignFromEnum,
   System.bool Flip,
   System.double Distance,
   System.double DistanceAbsUpperLimit,
   System.double DistanceAbsLowerLimit,
   System.double GearRatioNumerator,
   System.double GearRatioDenominator,
   System.double Angle,
   System.double AngleAbsUpperLimit,
   System.double AngleAbsLowerLimit,
   System.bool ForPositioningOnly,
   out System.int ErrorStatus
)
C++/CLI 
Mate2^ AddMate3( 
&   System.int MateTypeFromEnum,
&   System.int AlignFromEnum,
&   System.bool Flip,
&   System.double Distance,
&   System.double DistanceAbsUpperLimit,
&   System.double DistanceAbsLowerLimit,
&   System.double GearRatioNumerator,
&   System.double GearRatioDenominator,
&   System.double Angle,
&   System.double AngleAbsUpperLimit,
&   System.double AngleAbsLowerLimit,
&   System.bool ForPositioningOnly,
&   [Out] System.int ErrorStatus
) 

Parameters

MateTypeFromEnum

Type of mate as defined in swMateType_e

AlignFromEnum

Type of alignment as defined in swMateAlign_e

Flip

True to flip the component, false otherwise

Distance

Distance value to use with distance or limit mates

DistanceAbsUpperLimit
Absolute maximum distance value (see Remarks)
DistanceAbsLowerLimit

Absolute minimum distance value  (see Remarks)

GearRatioNumerator

Gear ratio numerator value for gear mates

GearRatioDenominator

Gear ratio denominator value for gear mates

Angle

Angle value to use with angle mates

AngleAbsUpperLimit

Absolute maximum angle value

AngleAbsLowerLimit

Absolute maximum angle value

ForPositioningOnly

True positions the components according to the mating relationship but a mate relationship is not created and returned, false does not

ErrorStatus

Success or error as defined by swAddMateError_e

Return Value

IMate2

Example

Remarks

To specify a distance mate without limits, set the distAbsUpperLimit and distAbsLowerLimit arguments equal to the distance argument's value.

 

If mateTypeFromEnum is swMateDISTANCE or swMateANGLE when the mate is applied to the closest position that meets the mate condition specified by distance or angle, then setting flip to True moves the assembly to the other possible mate position.

 

Use:

If mateTypeFromEnum is swMateCAMFOLLOWER, then use a selection mark of 8 for the cam-follower face.

 

If mateTypeFromEnum is swMateWIDTH and uses tab selections, then use a selection mark of 16.

 

If nothing is preselected, then errorStatus is swAddMateError_IncorrectSeletions and pMateObjOut is NULL/Nothing.

 

See Also

Availability

SolidWorks 2005 SP2, Revision Number 13


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:   AddMate3 Method (IAssemblyDoc)
*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) 2013 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.