API Reference › core-frontend› ModelState › GeometricModelState

GeometricModelState Class

Represents the front-end state of a GeometricModel. The contents of a GeometricModelState can be rendered inside a Viewport.

Extends

Extended by

Implements

Methods

Name Description
constructor(props: GeometricModelProps, iModel: IModelConnection, state?: GeometricModelState): GeometricModelState    
queryModelRange(): Promise<Range3d> Query for the union of the ranges of all the elements in this GeometricModel.  

Inherited methods

Name Inherited from Description
clone(iModel?: IModelConnection): this ModelState Make an independent copy of this EntityState
equals(other: this): boolean ModelState Return true if this EntityState is equal to another one.
toJSON(): ModelProps ModelState Add all custom-handled properties of a Model to a json object.

Properties

Name Type Description
className Accessor Static ReadOnly string The name of the BIS class associated with this class.  
is2d Accessor ReadOnly boolean Returns true if this is a 2d model (a GeometricModel2dState).  
is3d Accessor Abstract ReadOnly boolean Returns true if this is a 3d model (a GeometricModel3dState).  

Inherited properties

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

Defined in

Last Updated: 28 October, 2024