Mate Class

In This Topic

Mate is a class that helps to define the position of 3D placements. One or more Mates belong to an object of type Placement3D.

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.E3D.Mate
      Eplan.EplApi.DataModel.E3D.GridMate
      Eplan.EplApi.DataModel.E3D.LineMate
      Eplan.EplApi.DataModel.E3D.PlaneMate
      Eplan.EplApi.DataModel.E3D.PointMate

Syntax

C#
C++/CLI

public class Mate

public ref class Mate

Remarks

There are two different types of mates: stored in database and generated in runtime. First can be created by user and assign to a Placement3D. Name of generated mate depends on type of object. Mate named 'V1'is placed on first vertex (lowest left in local coordinate system of the object). Numeration of those mates is done in counterclockwise direction. Very similar are mates which name starts with 'M', only those mates are placed in the middle of edges and the first on is the lowest one (in the local coordinate system). Third type of mate that can be found is named "C". This one is placed in the center of object. Check mate description for more information about current mate.

Public Constructors

	Name	Description
	Mate Constructor	Default constructor.

Top

Public Properties

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

Top

Public Methods

	Name	Description
	Dispose	Destructor for deterministic finalization of Mate object.
	Equals	Operator of comparison implementation. Checks if two mates have same name and belongs to the same object.
	Remove	Removes the Mate object.
	StoreToObject	Stores changes into a project database.
	Transform	Transform mate position.

Top

Public Operators

Equality	Operator of comparison implementation. Checks if two mates have same name and belongs to the same object.
Inequality	Operator of comparison implementation. Checks if two mates have different name or not belongs to the same object.

Top

Reference

Mate Members
Eplan.EplApi.DataModel.E3D Namespace

Send Feedback