IManagedConstraints.AddMate Method

Namespace:  Autodesk.iLogic.Interfaces
Assembly:  Autodesk.iLogic.Interfaces (in Autodesk.iLogic.Interfaces.dll) Version: 30.0

Syntax

VB

Function AddMate ( 
	constraintName As String,
	component1 As ComponentArgument,
	entityName1 As String,
	component2 As ComponentArgument,
	entityName2 As String,
	Optional offset As Object = Nothing,
	Optional e1InferredType As InferredTypeEnum = InferredTypeEnum.kNoInference,
	Optional e2InferredType As InferredTypeEnum = InferredTypeEnum.kNoInference,
	Optional solutionType As MateConstraintSolutionTypeEnum = MateConstraintSolutionTypeEnum.kNoSolutionType,
	Optional biasPoint1 As Object = Nothing,
	Optional biasPoint2 As Object = Nothing
) As IManagedConstraint

C#

IManagedConstraint AddMate(
	string constraintName,
	ComponentArgument component1,
	string entityName1,
	ComponentArgument component2,
	string entityName2,
	Object offset = null,
	InferredTypeEnum e1InferredType = InferredTypeEnum.kNoInference,
	InferredTypeEnum e2InferredType = InferredTypeEnum.kNoInference,
	MateConstraintSolutionTypeEnum solutionType = MateConstraintSolutionTypeEnum.kNoSolutionType,
	Object biasPoint1 = null,
	Object biasPoint2 = null
)

Parameters

constraintName

Type: System.String
The constraint name.

component1

Type: Autodesk.iLogic.Types.ComponentArgument
The occurrence that contains the first entity. Examples: "Part:1" or {"Subassembly:1", "Part:1"}.

entityName1

Type: System.String
The first entity name. This can be named or work geometry.

component2

Type: Autodesk.iLogic.Types.ComponentArgument
The occurrence that contains the second entity. Examples: "Part:2" or {"Subassembly:2", "Part:2"}.

entityName2

Type: System.String
The second entity name. This can be named or work geometry.

offset (Optional)

Type: System.Object
Optional input that defines the offset between the two input entities. This can be either a numeric value or a string. Default: 0.

e1InferredType (Optional)

Type: InferredTypeEnum
Optional input constant that specifies how the geometry of entity one is to be interpreted.

e2InferredType (Optional)

Type: InferredTypeEnum
Optional input constant that specifies how the geometry of entity two is to be interpreted.

solutionType (Optional)

Type: MateConstraintSolutionTypeEnum
Optional input MateConstraintSolutionTypeEnum that specifies the solution type.

biasPoint1 (Optional)

Type: System.Object
Optional input object that is used to help in determining the initial position of the first occurrence. The occurrences are repositioned in an attempt to make the two bias points coincident.

biasPoint2 (Optional)

Type: System.Object
Optional input object that is used to help in determining the initial position of the second occurrence. The occurrences are repositioned in an attempt to make the two bias points coincident.

Return Value

Type: IManagedConstraint
The constraint.

See Also

Reference