Create(String,String,MultiLangString,Matrix3D) Method

In This Topic

Creates a point mate of type FreeRotation.

Syntax

C#
C++/CLI

public void Create( 
   string strName,
   string strMatchingMateNames,
   MultiLangString pMLSDescription,
   Matrix3D oPosition
)

public:
void Create( 
   String^ strName,
   String^ strMatchingMateNames,
   MultiLangString^ pMLSDescription,
   Matrix3D oPosition
)

Parameters

strName: Name identifying this mate.
strMatchingMateNames: Names of mates which can be snapped to this mate.
pMLSDescription: Description of set to this LineMate.
oPosition: Position represented by transformation matrix.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown when param is `null` value. Check exception message for more info.
System.ArgumentException	Thrown if `strName` has zero length.
Eplan.EplApi.DataModel.ObjectAlreadyCreatedException	Thrown when the PointMate has already been created.

Remarks

Such mate can be added to a Placement3D object by calling addMate().

Names of mates in strMatchingMateNames have to be separated by ';' char. It possible to specify that this mate matches all other mates if parameter strMatchingMateNames is null, empty or is equal to '*'. Value "*-R" of this parameter means that this mate matches all other mates but without mates from mounting rail (name of such mates is 'R').

Parameter strMatchingMateNames is not used when created mate has the name "G1" and Mate.Enums.LogicalType is set to Mate.Enums.LogicalType.UserGripPoint. In this case the MatchingMateNames is default for type of parent to which this mate will be attach.

Names are not case sensitive and can't contain char: '#'.

Notice that if user define handle is created then it position can be different then the one pass in argument. This is because mate of this type is projected on placement area if it exists. If placement area does not exist then z coordinate is set to 0.

Example

//oFunction doesn't have a handle defined

MultiLangString oMultiLangString = new MultiLangString();
PointMate oPointMate = new PointMate();

PointMate[] oPMBefore = oFunction3D.GetSourceMates(Mate.Enums.PlacementOptions.ConsiderMountingClearance);
//oPMBefore.Length: 9

oPointMate.Create("G1", "*", oMultiLangString, new Matrix3D());
oPointMate.LogicalType = Mate.Enums.LogicalType.UserGripPoint;
oFunction3D.AddMatePersistent(oPointMate);

PointMate[] oPMAfter = oFunction3D.GetSourceMates(Mate.Enums.PlacementOptions.ConsiderMountingClearance);
//oPMAfter.Length: 10

Reference

PointMate Class
PointMate Members
Overload List

Send Feedback