API Help
Eplan.EplApi.DataModel.E3D Namespace / InstallationSpace Class
Members

In This Topic
    InstallationSpace Class
    In This Topic
    Represents 3D space (i.e. building area) in P8's project where 3D objects can be placed.
    Inheritance Hierarchy

    System.Object
       Eplan.EplApi.DataModel.StorableObject
          Eplan.EplApi.DataModel.E3D.Placement3D
             Eplan.EplApi.DataModel.E3D.Function3D
                Eplan.EplApi.DataModel.E3D.InstallationSpace

    Syntax
    Remarks
    Use Properties.INSTALLATIONSPACE_DESIGNATION and Properties.FUNCTION3D_DESCRIPTION to get or set the name and description of InstallationSpace.
    Public Constructors
     NameDescription
    Public ConstructorDefault constructor.  
    Top
    Public Properties
     NameDescription
    Public PropertyOffset form beginning of installation space coordinate system to lower left back corner of object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    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 PropertyAdditional Type of this Function3D. Additional Type correspond to value of "Item" list in GUI. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    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 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 PropertyReturns the Eplan.EplApi.DataModel.FunctionDefinition of the Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    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 PropertyReturns true if placement area is defined for this Placement3D. (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 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 PropertyOverridden. Returns the name of the 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 PropertyReturns collection of PlaceHolder3D which are assign to this installation space.  
    Public PropertyReturns transformation defining plane of placement area. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns children of this object which are Plane. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public PropertyReturns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public Property.NET Property enabling access to EPLAN properties of the InstallationSpace object.  
    Public PropertyReturns Placement3D.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 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 PropertyOverridden. Returns the visible name of the Function3D.  
    Public PropertyReturns visible name of the Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D)
    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 Placements the objects and their children will be copied into the same Project as newParent Then parent of the copied objects will be set to newParent new parent of copied objectsobjects to copy (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public Methodstatic (Shared in Visual Basic)Overloaded. Creates InstallationSpace object and sets a name.  
    Public Methodstatic (Shared in Visual Basic)Overloaded. Creates transient InstallationSpace object and sets a name.  
    Public MethodDestructor for deterministic finalization of InstallationSpace 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 MethodFind source mate by name. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodFind target mate by name. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodReturns 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 MethodGet array of all source mates from this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public Methodget Array of all target mates from this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    Public MethodReturns array of Additional Types that are 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 MethodSets parent placement. Sets parent placement. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
    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 a string that represents the current object.  
    Public MethodReturns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject)
    Public MethodUpdate inherit drills for bended bus bars.  
    Top
    See Also