Eplan Platform API
Eplan.EplApi.DataModel.E3D Namespace / HandleMate Class
Members

In This Topic
    HandleMate Class
    In This Topic
    Represents handle mate.
    Inheritance Hierarchy

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

    Syntax
    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
     NameDescription
    Public ConstructorHandleMate ConstructorDefault constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyDescriptionDescription of this mate. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public PropertyGroupRetrieves a group the a handle belongs to  
    Public PropertyIsBaseMateReturn true, if mate is base mate. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public PropertyIsReadOnlyDetermines if Mate can be modified. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public PropertyIsUserDefinedReturns true, if mate is used defined. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public PropertyMatchingMateNamesNames of mates that can be snapped to this one separated by '#'. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public PropertyNameName of this mate. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public PropertyPlacementPlacement3D to which this mate is assign. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public PropertyRotationAngle by which the components are to be rotated when they are placed on the mounting point. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public PropertyRotationTypeRotation type which this mate force while snapping. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public PropertySourceReturns 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)
    Public PropertyTransformationPosition and rotation relative to the parent placement represented by transformation matrix. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Top
    Public Methods
     NameDescription
    Public MethodCalculateSnapTransformationOverloaded. 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)
    Public MethodCanSnapToCheck, if this mate can snap to targetMate (Inherited from Eplan.EplApi.DataModel.E3D.PointMate)
    Public MethodCreateOverloaded. Creates a handle mate from existing mate  
    Public MethodDisposeDestructor for deterministic finalization of Mate object. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public MethodEqualsOperator of comparison implementation. Checks if two mates have same name and belongs to the same object. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public MethodRemoveRemoves the Mate object. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public MethodSnapToOverloaded. Snap this mate to another mate. (Inherited from Eplan.EplApi.DataModel.E3D.PointMate)
    Public MethodStoreToObjectStores changes into a project database. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Public MethodTransformTransform mate position. (Inherited from Eplan.EplApi.DataModel.E3D.Mate)
    Top
    See Also

    Reference

    HandleMate Members
    Eplan.EplApi.DataModel.E3D Namespace

     

     

    EPLAN API , 16.11.2024, © by EPLAN GmbH & Co. KG. All rights reserved.

    Use the Eplan Global Support Portal for feedback and support