HandleMate Class

In This Topic

Inheritance Hierarchy
Syntax
Remarks
Public Constructors
Public Properties
Public Methods
See Also

Represents handle mate.

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.E3D.Mate
      Eplan.EplApi.DataModel.E3D.PointMate
         Eplan.EplApi.DataModel.E3D.HandleMate

Syntax

C#
C++/CLI

public class HandleMate : PointMate

public ref class HandleMate : public PointMate

Remarks

The class represents either a standard mate point (with all mouning points permitted) or with extended logic (having a list of assigned mounting points.)

Public Constructors

	Name	Description
	HandleMate Constructor	Default constructor.

Top

Public Properties

	Name	Description
	Description	Description of this mate. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	IsBaseMate	Return true, if mate is base mate. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	IsReadOnly	Determines if Mate can be modified. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	IsUserDefined	Returns true, if mate is used defined. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	MatchingMateNames	Names of mates that can be snapped to this one separated by '#'. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	Name	Name of this mate. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	Placement	Placement3D to which this mate is assign. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	Rotation	Angle by which the components are to be rotated when they are placed on the mounting point. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	RotationType	Rotation type which this mate force while snapping. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	Source	Returns object from which the mate was returned or changed by: Placement3D.GetTargetMates, Placement3D.GetSourceMates, Placement3D.AddMatePersistent or BaseMate property. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	Transformation	Position and rotation relative to the parent placement represented by transformation matrix. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)

Top

Public Methods

	Name	Description
	CalculateSnapTransformation	Overloaded. calculate a transformation matrix, that can be used to transform the associated placement into snap position that means, that the position and/or orientation of the associated placement will change, so that this mate fits to the target mate. (Inherited from Eplan.EplApi.DataModel.E3D.PointMate)
	CanSnapTo	Check, if this mate can snap to targetMate (Inherited from Eplan.EplApi.DataModel.E3D.PointMate)
	Create	Overloaded. Creates a handle with a list of assigned mounting points.
	Dispose	Destructor for deterministic finalization of Mate object. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	Equals	Operator of comparison implementation. Checks if two mates have same name and belongs to the same object. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	Remove	Removes the Mate object. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	SnapTo	Overloaded. Snap this mate to another mate. (Inherited from Eplan.EplApi.DataModel.E3D.PointMate)
	StoreToObject	Stores changes into a project database. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	Transform	Transform mate position. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)

Top

Reference

HandleMate Members
Eplan.EplApi.DataModel.E3D Namespace

Send Feedback