Plane Class

In This Topic

Represents surface of 3D object on which children can be placed. In GUI it is visible as part of parent.

Inheritance Hierarchy

System.Object
   Eplan.EplApi.DataModel.StorableObject
      Eplan.EplApi.DataModel.E3D.Placement3D
         Eplan.EplApi.DataModel.E3D.Plane

Syntax

C#
C++/CLI

public class Plane : Placement3D, Eplan.EplApi.DataModel.IFunctionBase

public ref class Plane : public Placement3D, Eplan.EplApi.DataModel.IFunctionBase

Public Constructors

	Name	Description
	Plane Constructor	Default constructor.

Top

Public Properties

	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)
	BaseMate	Default target mate for this Plane.
	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)
	FieldOffset	Position of NC field beginning relatively to the origin of plane. (The origin and the orientation of the plane are defined in his absolute transformation)
	FieldSize	Size of NC field. (x == width, y == height)
	FunctionDefinition	Returns the Eplan.EplApi.DataModel.FunctionDefinition of the Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
	InstallationSpace	Returns InstallationSpace in which this object exists. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
	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
	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 a Plane.
	Layer	Returns the Eplan.EplApi.DataModel.Graphics.GraphicalLayer of the Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
	MasterPlane	Returns the master plane.
	MountingSurface	Size of mounting surface beginning relatively to the origin of plane. (x == width, y == height)
	Name	Returns the name of the IFunctionBase.
	NameParts	Name of the IFunctionBase.
	ObjectIdentifier	Returns the object identifier as number. The number is unique for all objects of this type. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	OppositePlane	Returns the opposite plane.
	Parent	Gets 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)
	PlacementArea	Represents placement area of a Placement3D. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
	PlaneMode	Returns mode of plane.
	Planes	Returns children of this object which are Plane. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
	Project	Returns the project the StorableObject belongs to. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	Properties	.NET Property enabling access to EPLAN properties of the Plane object.
	PropertyPlacements	Returns 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	Return 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 IFunctionBase.
	VisibleNameParts	Returns visible name of the IFunctionBase.

Top

Public Methods

	Name	Description
	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	Copy 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)
	Dispose()	Destructor for deterministic finalization of Plane 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	Find source mate by name. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
	FindTargetMate	Find target mate by name. (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	Get array of all source mates from this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
	GetTargetMates	Get array of all target mates from this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
	GetTypeName	Returns object type name. (Inherited from Eplan.EplApi.DataModel.StorableObject)
	GetValidItemTypes	Returns array of Additional Types that are valid for Plane.
	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	Move this object. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
	MoveRelative	Move this object relative to its parent. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
	Remove	Removes object from project and all its children. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
	RemoveConnectionPointPosition	Removes connection point data stored under 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 parent placement. Sets parent placement. (Inherited from Eplan.EplApi.DataModel.E3D.Placement3D)
	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)

Top

Reference

Plane Members
Eplan.EplApi.DataModel.E3D Namespace

Send Feedback