AuxCoordSystemSpatialState Class

The state of an AuxCoordSystemSpatial element in the frontend

Extends

Implements

Methods

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

Inherited methods

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

Inherited properties

Name Type Inherited from Description
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.
code Code ElementState The Code for this element
description undefined | string AuxCoordSystemState  
federationGuid undefined | GuidString ElementState A FederationGuid assigned to this element by some other federated database
id Id64String EntityState The Id of this Entity.
iModel IModelConnection EntityState The iModel from which this Entity was loaded
is3d Accessor ReadOnly boolean AuxCoordSystemState  
jsonProperties [key: string]: any EntityState Optional json properties of this Entity.
model Id64String ElementState The ModelId of the Model containing this element
origin Point3d AuxCoordSystem3dState  
parent undefined | RelatedElement ElementState The parent Element of this, or undefined if no parent.
pitch number AuxCoordSystem3dState  
roll number AuxCoordSystem3dState  
schemaName Accessor StaticReadOnly string EntityState The name of the BIS schema for this class.
type number AuxCoordSystemState  
userLabel undefined | string ElementState A user-assigned label for this element.
yaw number AuxCoordSystem3dState  

Defined in

Last Updated: 20 September, 2019