API Reference › core-backend› Elements › PhysicalObject

PhysicalObject Class

The Generic:PhysicalObject class is used when physical elements cannot be further classified.

@note More-specific BisCore:PhysicalElement subclasses should be used wherever possible.

Extends

Methods

Name Description
constructor(props: PhysicalElementProps, iModel: IModelDb): PhysicalObject    

Inherited methods

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

Properties

Name Type Description
className Accessor Static ReadOnly string The name of the BIS class associated with this class.  

Inherited properties

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

Defined in

Last Updated: 13 November, 2024