Create(MultiLangString,Matrix3D) Method

In This Topic

Creates a handle point with all mounting points permitted.

Syntax

C#
C++/CLI

public void Create( 
   MultiLangString pMLSDescription,
   Matrix3D oPosition
)

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

Parameters

pMLSDescription: Description of a handle
oPosition: Position represented by transformation matrix.

Exceptions

Exception	Description
System.ArgumentNullException	Thrown when param is `null` value. Check exception message for more info.
Eplan.EplApi.DataModel.ObjectAlreadyCreatedException	Thrown when a handle has already been created.

Remarks

Notice that if user define handle is created, its 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

var handle = new HandleMate();
handle.Create(new MultiLangString(), new Matrix3D());
oFunction3D.AddMatePersistent(handle);

//create a handle relative to placement area
var transformationToPlacementArea = new Matrix3D();
transformationToPlacementArea.Translate(new Vector3D(50.0, 500.0, 0.0));
var transformation = transformationToPlacementArea * oFunction3D.PlacementArea.RelativeTransformation;

var handle2 = new HandleMate();
handle2.Create(new MultiLangString(), transformation);
oFunction3D.AddMatePersistent(handle2);

//create a handle with extended logic 
var handleWithExtendedLogic = new HandleMate();
handleWithExtendedLogic.Create(new[] { "V1", "V2" }, new MultiLangString(), new Matrix3D());
oFunction3D.AddMatePersistent(handleWithExtendedLogic);

Reference

HandleMate Class
HandleMate Members
Overload List

Send Feedback