GeometricModel3dState Class
Represents the front-end state of a GeometricModel3d.
extensions
Extends
Extended by
Methods
| Name | Description | |
|---|---|---|
| constructor(props: GeometricModel3dProps, iModel: IModelConnection, state?: GeometricModel3dState): GeometricModel3dState | Constructor for EntityState |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| clone(iModel?: IModelConnection): GeometricModel3dState | GeometricModelState | Make an independent copy of this EntityState |
| equals(other: GeometricModel3dState): boolean | GeometricModelState | Return true if this EntityState is equal to another one. |
| queryModelRange(): Promise<Range3d> | GeometricModelState | Query for the union of the ranges of all the elements in this GeometricModel. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| isNotSpatiallyLocated Readonly | boolean | If true, then the elements in this GeometricModel3dState are not in real-world coordinates and will not be in the spatial index. | |
| isPlanProjection Readonly | boolean | If true, then the elements in this GeometricModel3dState are expected to be in an XY plane. | |
| isSpatiallyLocated Accessor ReadOnly | boolean | If true, then the elements in this GeometricModel3dState are in real-world coordinates and will be in the spatial index. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| asGeometricModel2d Accessor ReadOnly | undefined | GeometricModel2dState | GeometricModelState | Attempts to cast this model to a 2d geometric model. |
| asSpatialModel Accessor ReadOnly | undefined | SpatialModelState | GeometricModelState | Attempts to cast this model to a spatial model. |
| classFullName Accessor StaticReadOnly | string | GeometricModelState | Get full BIS class name of this Entity in the form "SchemaName:ClassName". |
| classFullName Readonly | string | GeometricModelState | The full class name in the form "schema:class". |
| className Accessor ReadOnly | string | GeometricModelState | The name of the BIS class associated with this class. |
| id Readonly | string | GeometricModelState | The Id of this Entity. |
| iModel Readonly | IModelConnection | GeometricModelState | The iModel from which this Entity was loaded |
| is2d Accessor ReadOnly | boolean | GeometricModelState | Returns true if this is a 2d model (a GeometricModel2dState). |
| isPrivate Readonly | boolean | GeometricModelState | |
| isTemplate Readonly | boolean | GeometricModelState | |
| jsonProperties Readonly | { T } | GeometricModelState | Optional json properties of this Entity. |
| modeledElement Readonly | RelatedElement | GeometricModelState | |
| name Readonly | string | GeometricModelState | |
| parentModel | string | GeometricModelState | |
| schemaName Accessor StaticReadOnly | string | GeometricModelState | The name of the BIS schema for this class. |
Defined in
- core/frontend/src/ModelState.ts Line 227
Last Updated: 20 June, 2023