GeometricModel3dState Class

Represents the front-end state of a GeometricModel3d.

Extends

Extended by

Implements

Methods

Name Description
constructor(props: GeometricModel3dProps, iModel: IModelConnection, state?: GeometricModel3dState): GeometricModel3dState    

Inherited methods

Name Inherited from Description
clone(iModel?: IModelConnection): this EntityState Make an independent copy of this EntityState
equals(other: this): boolean EntityState Return true if this EntityState is equal to another one.

Properties

Name Type Description
isNotSpatiallyLocated boolean If true, then the elements in this GeometricModel3dState are not in real-world coordinates and will not be in the spatial index.  
iSpatiallyLocated Accessor ReadOnly boolean If true, then the elements in this GeometricModel3dState are in real-world coordinates and will be in the spatial index.  
isPlanProjection boolean If true, then the elements in this GeometricModel3dState are expected to be in an XY plane.  

Inherited properties

Name Type Inherited from Description
asGeometricModel2d Accessor ReadOnly GeometricModel2dState | undefined ModelState Attempts to cast this model to a 2d geometric model.
asSpatialModel Accessor ReadOnly SpatialModelState | undefined ModelState Attempts to cast this model to a spatial model.
classFullName Accessor StaticReadOnly string EntityState Get full BIS class name of this Entity in the form "SchemaName:ClassName".
classFullName string EntityState The full class name in the form "schema:class".
className Accessor ReadOnly string EntityState The name of the BIS class associated with this class.
id Id64String EntityState The Id of this Entity.
iModel IModelConnection EntityState The iModel from which this Entity was loaded
is2d Accessor ReadOnly boolean GeometricModelState Returns true if this is a 2d model (a GeometricModel2dState).
isPrivate boolean ModelState  
isTemplate boolean ModelState  
jsonProperties [key: string]: any EntityState Optional json properties of this Entity.
modeledElement RelatedElement ModelState  
name string ModelState  
parentModel Id64String ModelState  
schemaName Accessor StaticReadOnly string EntityState The name of the BIS schema for this class.

Defined in

Last Updated: 13 June, 2024