API Reference › core-frontend › Views › AuxCoordSystemSpatialState

AuxCoordSystemSpatialState Class

The state of an AuxCoordSystemSpatial element in the frontend

Extends

Methods

Name Description
constructor(props: AuxCoordSystem3dProps, iModel: IModelConnection): AuxCoordSystemSpatialState    

Inherited methods

Name Inherited from Description
clone(iModel?: IModelConnection): AuxCoordSystemSpatialState AuxCoordSystem3dState Make an independent copy of this EntityState
display(context: DecorateContext, options: ACSDisplayOptions): void AuxCoordSystem3dState  
drawGrid(context: DecorateContext): void AuxCoordSystem3dState  
equals(other: AuxCoordSystemSpatialState): boolean AuxCoordSystem3dState Return true if this EntityState is equal to another one.
getOrigin(result?: Point3d): Point3d AuxCoordSystem3dState  
getRotation(result?: Matrix3d): Matrix3d AuxCoordSystem3dState get a copy of the rotation matrix for this ACS.
isValidForView(view: ViewState): boolean AuxCoordSystem3dState  
setOrigin(val: Readonly<WritableXYAndZ> | Readonly<WritableXAndY>): void AuxCoordSystem3dState  
setRotation(rMatrix: Matrix3d): void AuxCoordSystem3dState  
toJSON(): AuxCoordSystem3dProps AuxCoordSystem3dState Obtain this element's JSON representation.
createNew(acsName: string, iModel: IModelConnection): AuxCoordSystemState Static AuxCoordSystem3dState Create a new AuxCoordSystemState.
fromProps(props: AuxCoordSystemProps, iModel: IModelConnection): AuxCoordSystemState Static AuxCoordSystem3dState  
isOriginInView(drawOrigin: Point3d, viewport: Viewport, adjustOrigin: boolean): boolean Static AuxCoordSystem3dState Given an origin point, returns whether the point falls within the view or not.

Properties

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

Inherited properties

Name Type Inherited from Description
classFullName Accessor StaticReadOnly string AuxCoordSystem3dState Get full BIS class name of this Entity in the form "SchemaName:ClassName".
classFullName Readonly string AuxCoordSystem3dState The full class name in the form "schema:class".
className Accessor ReadOnly string AuxCoordSystem3dState The name of the BIS class associated with this class.
code Readonly Code AuxCoordSystem3dState The Code for this element
description undefined | string AuxCoordSystem3dState  
federationGuid Readonly undefined | string AuxCoordSystem3dState A FederationGuid assigned to this element by some other federated database
id Readonly string AuxCoordSystem3dState The Id of this Entity.
iModel Readonly IModelConnection AuxCoordSystem3dState The iModel from which this Entity was loaded
is3d Accessor ReadOnly boolean AuxCoordSystem3dState  
jsonProperties Readonly { T } AuxCoordSystem3dState Optional json properties of this Entity.
model Readonly string AuxCoordSystem3dState The ModelId of the Model containing this element
origin Readonly Point3d AuxCoordSystem3dState  
parent Readonly undefined | RelatedElement AuxCoordSystem3dState The parent Element of this, or undefined if no parent.
pitch number AuxCoordSystem3dState  
roll number AuxCoordSystem3dState  
schemaName Accessor StaticReadOnly string AuxCoordSystem3dState The name of the BIS schema for this class.
type number AuxCoordSystem3dState  
userLabel Readonly undefined | string AuxCoordSystem3dState A user-assigned label for this element.
yaw number AuxCoordSystem3dState  

Defined in

Last Updated: 19 April, 2024