GridMate Class

In This Topic

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

Represents grid mate.

Inheritance Hierarchy

System.Object
Eplan.EplApi.DataModel.E3D.Mate
Eplan.EplApi.DataModel.E3D.GridMate

Syntax

C#
C++/CLI

public class GridMate : Mate

public ref class GridMate : public Mate

Remarks

GridMate object is only a container of information, that describes the grid (like size, increment, start position, etc) but 3d objects will snap only on a GridLineMate objects.

Public Constructors

	Name	Description
	GridMate Constructor

Top

Public Properties

	Name	Description
	Description	Description of this mate. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
	IncrementX	Increment in X direction
	IncrementY	Increment in Y direction
	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)
	LengthX	Number of cells in X direction
	LengthY	Number of cells in Y direction
	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)
	SizeX	Grid size, X coordinate
	SizeY	Grid size, Y coordinate
	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)
	StartPositionX	Start position in X direction
	StartPositionY	Start position in Y direction
	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
	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)
	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

GridMate Members
Eplan.EplApi.DataModel.E3D Namespace

Send Feedback