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

In This Topic
    RoutingSpline Class
    In This Topic
    Class represents an object in P8 which can route connections.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.StorableObject
          Eplan.EplApi.DataModel.E3D.Placement3D
             Eplan.EplApi.DataModel.E3D.Function3D
                Eplan.EplApi.DataModel.E3D.RoutingSegment
                   Eplan.EplApi.DataModel.E3D.RoutingSpline

    Syntax
    Remarks
    Corresponding FunctionCategory for this class is Routing.
    Public Constructors
     NameDescription
    Public ConstructorDefault constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyAbsolute position and rotation represented by transformation matrix. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyAbsolute position and rotation represented by transformation matrix where transformation of macro is considered. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyDetermines if connection point data are saved locally at the part placement. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns Eplan.EplApi.DataModel.ArticleReferences that are referenced by Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public PropertyReturns Eplan.EplApi.DataModel.Articles that are referenced by Function3D, and only those that are stored in project database. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public PropertyCheck if the Function3D can have Eplan.EplApi.DataModel.Articles. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public PropertyReturns all children of this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyColor of 3D Placement (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyAll existing 3d connections whose beginning or end is this placement. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyArray of connection points data. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyRepresents coordinates of corners (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns an array of objects cross-referenced with this object (i.e. having the same name - in case of functions - or otherwise associated) (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns the project as number. The number is unique for all open projects in one session. The number changes when the project is closed and opened again. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyPoint in 3d space which is the end of routing segment. (Inherited from Eplan.EplApi.DataModel.E3D.RoutingSegment)
    Public PropertyThe degree of routing segment filling in percent. (Inherited from Eplan.EplApi.DataModel.E3D.RoutingSegment)
    Public PropertyReturns the Eplan.EplApi.DataModel.FunctionDefinition of the Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyOverridden. Geometrical length of routing segment.  
    Public PropertyArray of gradients an nodes of spline.  
    Public PropertyReturns a Group3D object that the Placement3D object belongs to. If the Placement3D object doesn't belong to any group3D, NULL is returned. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyIf true, then this routing segment is ignored while calculating any filling degree in P8 project. (Inherited from Eplan.EplApi.DataModel.E3D.RoutingSegment)
    Public PropertyReturns InstallationSpace in which this object exists. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertySet or checks if device of this Function3d is fixed. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public PropertyIndicates whether object is currently hidden in 3D editor view. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public Property

    Determines if the the StorableObject is locked.

    The StorableObject is locked when it was explicitly or implicitly locked.

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturns true if a mesh is created for this objects and assigned for it. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns true if the list of name's properties is empty (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public PropertyReturns true if the placement is placed. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyDetermines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Property

    Determines if the the StorableObject is transient.

    The StorableObject is transient when it was created by default constructor and:

    it is a Eplan.EplApi.DataModel.Page and it was not assigned a Eplan.EplApi.DataModel.Project,

    it is a Eplan.EplApi.DataModel.Placement or any class derived from it and was not assigned a Eplan.EplApi.DataModel.Page.

    (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyDetermines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyItem type of this Function3D, corresponds to value of the 'Item' list in GUI. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public PropertyReturns the Eplan.EplApi.DataModel.Graphics.GraphicalLayer of the Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns mesh. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public PropertyReturns the name of the Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public PropertyName of the Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public PropertyReturns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyGets or Sets parent placement. Caution: The Change of the parent will also change the absolute position because Placement3D stores the position relative to his parent (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyRepresents placement area of a Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns children of this object which are Plane. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyEplan.EplApi.DataModel.Planning.PlanningSegment assigned to this function3d. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public PropertyArray of points on spline (these are the nodes of the spline).  
    Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Property.NET Property enabling access to P8 properties of the RoutingSpline object.  
    Public PropertyReturns PropertyPlacementsSchemas assigned to this Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns PropertyPlacementsSchemas assigned to this SymbolReference. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyPosition and rotation relative to the parent placement represented by transformation matrix. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyRelative position and rotation represented by transformation matrix where transformation of macro is considered. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyConnection which are routed by this segment. (Inherited from Eplan.EplApi.DataModel.E3D.RoutingSegment)
    Public PropertyArray of points representing the shape of spline.  
    Public PropertyPoint in 3d space which is the beginning of routing segment. (Inherited from Eplan.EplApi.DataModel.E3D.RoutingSegment)
    Public PropertyGets the root 3d placement from tree of 3d elements which this object is part of. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public PropertyReturn true if the instance uses the local property instances, otherwise it uses the ones of the variant. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns the visible name of the Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public PropertyReturns visible name of the Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public PropertyArray of weights on nodes of spline.  
    Top
    Public Methods
     NameDescription
    Public MethodOverloaded. Adds a new Eplan.EplApi.DataModel.ArticleReference to the Function3D. Returns the added Eplan.EplApi.DataModel.ArticleReference. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public MethodCreates new connection point position. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodAdd copy of a mate to a Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodCopy 3D Placement Placement3D and its children will be copied into the same Project as newParent Then parent of the copy will be set to newParent new parent of copy (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodOverloaded. Create new routing spline in P8 project.  
    Public MethodOverloaded. Create new routing spline in P8 project.  
    Public MethodDestructor for deterministic finalization of RoutingSpline object. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodOperator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodOverloaded. Find source mate by name. Mate namePlacement optionsConsider child mounting surfaces (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodOverloaded. Find target mate by name. Mate nameConsider mounting clearanceConsider child mounting surfaces (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodReturns bounding box of a Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodReturns relative bounding box of a Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodServes as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodGets the point of spline at a relative position.  
    Public MethodOverloaded. Get array of all source mates from this object. Placement optionsConsider child mounting surfaces (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodOverloaded. Get array of all target mates from this object. Consider mounting clearanceConsider child mounting surfaces (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodReturns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodReturns an array of item types valid for this Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public MethodTries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodMove this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodMove this object relative to its parent. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodRemoves object from project and all its children. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodRemoves the ArticleReference from the Function. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public MethodRemoves connection point data stored under given index. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodRemoves object and all its children only from layout space. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodSets parent placement. Sets parent placement. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodAssigns Eplan.EplApi.DataModel.Planning.PlanningSegment to this function3d. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    Public MethodTries to lock current object. If object is Eplan.EplApi.DataModel.Placement - it's page will be locked as well; Placement3D locks it's installation space; Eplan.EplApi.DataModel.Function locks all it's connections and connection definition points; Eplan.EplApi.DataModel.Page locks all placements from this page. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodStores data from connection point position in function under given index. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodCopies or removes all local ProperyPlacemnets and sets flag (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Top
    See Also