| Name | Description | |
|---|---|---|
 | BarBase Constructor | Default constructor. |
The following tables list the members exposed by BarBase.
| Name | Description | |
|---|---|---|
| BarBase Constructor | Default constructor. |
| Name | Description | |
|---|---|---|
 | AbsoluteTransformation | Absolute position and rotation represented by transformation matrix. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| AbsoluteTransformationOfMacro | Absolute position and rotation represented by transformation matrix where transformation of macro is considered. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| AreConnectionPointPositionsLocal | Determines if connection point data are saved locally at the part placement. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| ArticleReferences | Returns Eplan.EplApi.DataModel.ArticleReferences that are referenced by Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| Articles | Returns 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) |
| CanHaveArticleData | Check if the Function3D can have Eplan.EplApi.DataModel.Articles. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| Children | Returns all children of this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| Color | Color of 3D Placement (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| Connection3Ds | All existing 3D connections whose beginning or end is this placement. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| ConnectionPointPositions | Array of connection points data. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| Corners | Represents coordinates of corners (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| CrossReferencedObjectsAll | Returns 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) |
| DatabaseIdentifier | Returns 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) |
| FunctionDefinition | Returns the Eplan.EplApi.DataModel.FunctionDefinition of the Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| Group3D | Returns 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) |
| InstallationSpace | Returns InstallationSpace in which this object exists. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| IsFixedDevice | Set or checks if device of this Function3d is fixed. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| IsHidden | Indicates whether object is currently hidden in 3D editor view. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| IsLocked | Determines if the the StorableObject is locked. The StorableObject is locked when it was explicitly or implicitly locked. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| IsMeshCreated | Returns TRUE if a mesh is created for this objects and assigned for it. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| IsNameEmpty | Returns true if the list of name's properties is empty (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| IsPlaced | Returns TRUE if the placement is placed. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| IsReadOnly | Determines if StorableObject is read-only (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| IsTransient | 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) |
| IsValid | Determines if StorableObject is correct database object and is not deleted. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| ItemType | Item type of this Function3D, corresponds to value of the 'Item' list in GUI. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| Layer | Returns the GraphicalLayer of the Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| Length | Returns and sets length of this object. Length is stored in mm. |
| Mesh | Returns mesh. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| Name | Returns the name of the Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| NameParts | Name of the Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| ObjectIdentifier | Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Parent | Gets or sets the 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) |
| PlacementArea | Represents placement area of a Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| Planes | Returns children of this object which are Plane. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| PlanningSegment | Eplan.EplApi.DataModel.Planning.PlanningSegment assigned to this function3d. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| Project | Returns the project to which the StorableObject belongs. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Properties | EPLAN properties of the BarBase object. |
| PropertyPlacements | Returns Placement3D.PropertyPlacementsSchemas assigned to this Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| PropertyPlacementsSchemas | Returns PropertyPlacementsSchemas assigned to this SymbolReference. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| RelativeTransformation | Position and rotation relative to the parent placement represented by transformation matrix. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| RelativeTransformationOfMacro | Relative position and rotation represented by transformation matrix where transformation of macro is considered. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| TopLevelParent | Gets the root 3D placement from tree of 3D elements which this object is part of. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| TypeIdentifier | Returns the type of the object as number. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| UseLocalPropertyPlacements | Returns TRUE if the instance uses the local property instances, otherwise it uses the ones of the variant. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| VisibleName | Returns the visible name of the Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| VisibleNameParts | Returns visible name of the Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| Name | Description | |
|---|---|---|
 | AddArticleReference | Overloaded. Adds a new Eplan.EplApi.DataModel.ArticleReference to the Function3D. Returns the added Eplan.EplApi.DataModel.ArticleReference. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| AddConnectionPointPosition | Creates new connection point position. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| AddMatePersistent | Add copy of a mate to a Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| CopyTo | Copies a 3D placement. A Placement3D and its children will be copied into the same project as "newParent". Then the parent of the copy will be set to "newParent". (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| Dispose() | Destructor for deterministic finalization of BarBase object. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Equals | Operator of comparison implementation. Checks if two StorableObjects refer to the same object in the project. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| FindSourceMate | Overloaded. Find source mate by name. Mate namePlacement optionsConsider child mounting surfaces (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| FindTargetMate | Overloaded. Find target mate by name. Mate nameConsider mounting clearanceConsider child mounting surfaces (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| GetBoundingBox | Returns bounding box of a Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| GetBoundingBoxRelative | Returns relative bounding box of a Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| GetHashCode | Serves as the default hash function. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetSourceMates | Overloaded. Get array of all source mates from this object. Placement optionsConsider child mounting surfaces (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| GetTargetMates | Overloaded. Get array of all target mates from this object. Consider mounting clearanceConsider child mounting surfaces (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| GetTypeName | Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| GetValidItemTypes | Returns an array of item types valid for this Function3D. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| LockObject | Tries to lock current object in database for exclusive access. Throws Eplan.EplApi.Base.LockingException on failure. (Inherited from Eplan.EplApi.DataModel.StorableObject) |
| Move | Moves this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| MoveRelative | Moves this object relative to its parent. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| Place | Overloaded. Places unplaced Function3D on a layout space (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| Remove | Removes object from project and all its children. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| RemoveArticleReference | Removes the ArticleReference from the Function. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| RemoveConnectionPointPosition | Removes connection point data stored under the given index. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| RemovePlacement | Removes object and all its children only from layout space. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| SetParent | Sets the parent placement. Sets parent placement. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| SetPlanningSegment | Assigns Eplan.EplApi.DataModel.Planning.PlanningSegment to this function3d. (Inherited from Eplan.EplApi.DataModel.E3D.Function3D) |
| SmartLock | Tries 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) |
| StoreConnectionPointPosition | Stores data from connection point position in function under given index. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| SwitchLocalPropertyPlacements | Copies or removes all local ProperyPlacemnets and sets flag (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D) |
| ToStringIdentifier | Returns this object as string identifier. (Inherited from Eplan.EplApi.DataModel.StorableObject) |