API Reference > core-backend > Elements > PhysicalElement

PhysicalElement Class

An Element that is spatially located, has mass, and can be touched.

Extends

Extended by

Inherited methods

Name Inherited from Description
calculateRange3d(): Range3d SpatialElement  
collectPredecessorIds(predecessorIds: Id64Set): void Protected SpatialElement Collect the Ids of this element's references at this level of the class hierarchy.
collectReferenceIds(referenceIds: Set<string>): void Protected SpatialElement Collect the Ids of this entity's references at this level of the class hierarchy.
delete(): void SpatialElement Delete this Element from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void SpatialElement Call a function for each property of this Entity.
getClassMetaData(): undefined | EntityMetaData SpatialElement Get the class metadata for this element.
getDisplayLabel(): string SpatialElement Get a display label for this Element.
getJsonProperty(nameSpace: string): any SpatialElement Get a JSON property of this element, by namespace
getPlacementTransform(): Transform SpatialElement Get the Transform from the Placement of this GeometricElement
getPredecessorIds(): Id64Set SpatialElement Get the Ids of this element's references.
getReferenceIds(): Set<string> SpatialElement Get the Ids of this element's references.
getToolTipMessage(): string[] SpatialElement Get a list of HTML strings that describe this Element for the tooltip.
getUserProperties(namespace: string): any SpatialElement Get a set of JSON user properties by namespace
insert(): string SpatialElement Insert this Element into the iModel.
is2d(): this is GeometricElement2d SpatialElement Type guard for instanceof GeometricElement2d
is3d(): this is GeometricElement3d SpatialElement Type guard for instanceof GeometricElement3d
removeUserProperties(nameSpace: string): void SpatialElement Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(nameSpace: string, value: any): void SpatialElement  
setUserProperties(nameSpace: string, value: any): void SpatialElement Change a set of user JSON properties of this Element by namespace.
update(): void SpatialElement Update this Element in the iModel.
is(otherClass: undefined): boolean Static SpatialElement return whether this Entity class is a subclass of another Entity class
onAllInputsHandled(_id: string, _iModel: IModelDb): void ProtectedStatic SpatialElement Called on an element in a graph after all of its inputs have been processed and before its outputs are processed.
onBeforeOutputsHandled(_id: string, _iModel: IModelDb): void ProtectedStatic SpatialElement Called when a root element in a subgraph is changed and before its outputs are processed.
onChildAdd(_arg: OnChildElementPropsArg): void ProtectedStatic SpatialElement Called when an existing element is about to be updated so that an instance of this class will become its new parent.
onChildAdded(_arg: OnChildElementIdArg): void ProtectedStatic SpatialElement Called after an existing element has been updated so that an instance of this class is its new parent.
onChildDelete(_arg: OnChildElementIdArg): void ProtectedStatic SpatialElement Called when an element with an instance of this class as its parent is about to be deleted.
onChildDeleted(_arg: OnChildElementIdArg): void ProtectedStatic SpatialElement Called after an element with an instance of this class as its parent was successfully deleted.
onChildDrop(_arg: OnChildElementIdArg): void ProtectedStatic SpatialElement Called when an element with an instance of this class as its parent is about to be updated change to a different parent.
onChildDropped(_arg: OnChildElementIdArg): void ProtectedStatic SpatialElement Called after an element with an instance of this class as its previous parent was updated to have a new parent.
onChildInsert(_arg: OnChildElementPropsArg): void ProtectedStatic SpatialElement Called when a new element with an instance of this class as its parent is about to be inserted.
onChildInserted(_arg: OnChildElementIdArg): void ProtectedStatic SpatialElement Called after a new element with an instance of this class as its parent was inserted.
onChildUpdate(_arg: OnChildElementPropsArg): void ProtectedStatic SpatialElement Called when an element with an instance of this class as its parent is about to be updated.
onChildUpdated(_arg: OnChildElementIdArg): void ProtectedStatic SpatialElement Called after an element with an instance of this the class as its parent was updated.
onCloned(_context: IModelElementCloneContext, _sourceProps: ElementProps, _targetProps: ElementProps): void ProtectedStatic SpatialElement Called during the iModel transformation process after an Element from the source iModel was cloned for the target iModel.
onDelete(arg: OnElementIdArg): void ProtectedStatic SpatialElement Called before an Element is deleted.
onDeleted(_arg: OnElementIdArg): void ProtectedStatic SpatialElement Called after an Element was deleted.
onInsert(arg: OnElementPropsArg): void ProtectedStatic SpatialElement Called before a new Element is inserted.
onInserted(arg: OnElementIdArg): void ProtectedStatic SpatialElement Called after a new Element was inserted.
onSubModelDelete(_arg: OnSubModelIdArg): void ProtectedStatic SpatialElement Called when a sub-model of an instance of this class is being deleted.
onSubModelDeleted(_arg: OnSubModelIdArg): void ProtectedStatic SpatialElement Called after a sub-model of an instance of this class was deleted.
onSubModelInsert(_arg: OnSubModelPropsArg): void ProtectedStatic SpatialElement Called when an instance of this class is being sub-modeled by a new Model.
onSubModelInserted(_arg: OnSubModelIdArg): void ProtectedStatic SpatialElement Called after an instance of this class was sub-modeled by a new Model.
onUpdate(arg: OnElementPropsArg): void ProtectedStatic SpatialElement Called before an Element is updated.
onUpdated(_arg: OnElementIdArg): void ProtectedStatic SpatialElement Called after an Element was updated.

Properties

Name Type Description
physicalMaterial undefined | RelatedElement If defined, the PhysicalMaterial that makes up this PhysicalElement.  

Inherited properties

Name Type Inherited from Description
category string SpatialElement The Id of the Category for this GeometricElement.
classFullName Accessor ReadOnly string SpatialElement Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor StaticReadOnly string SpatialElement Get the full BIS class name of this Entity in the form "schema:class"
className Accessor ReadOnly string SpatialElement The name of the BIS class associated with this class.
code Code SpatialElement The Code for this element
federationGuid undefined | string SpatialElement A FederationGuid assigned to this element by some other federated database
geom undefined | GeometryStreamProps SpatialElement The GeometryStream for this GeometricElement.
id string SpatialElement The Id of this Entity.
iModel IModelDb SpatialElement The IModelDb that contains this Entity
isInstanceOfEntity Readonly "true" SpatialElement An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
jsonProperties Readonly { T } SpatialElement Optional json properties of this element.
model Readonly string SpatialElement The ModelId of the Model containing this element
parent undefined | RelatedElement SpatialElement The parent element, if present, of this element.
placement Placement3d SpatialElement  
requiredReferenceKeys StaticReadonly undefined SpatialElement  
schema Static undefined SpatialElement The Schema that defines this class.
schemaName Accessor ReadOnly string SpatialElement The name of the BIS Schema that defines this class
typeDefinition undefined | TypeDefinition SpatialElement  
userLabel undefined | string SpatialElement A user-assigned label for this element.

Defined in

Last Updated: 30 November, 2023