API Reference › core-frontend› Views › AuxCoordSystem3dState

AuxCoordSystem3dState Class

The state of an AuxCoordSystem3d element in the frontend

Extends

Extended by

Implements

Methods

Name Description
constructor(props: AuxCoordSystem3dProps, iModel: IModelConnection): AuxCoordSystem3dState    
getOrigin(result?: Point3d): Point3d    
getRotation(result?: Matrix3d): Matrix3d get a copy of the rotation matrix for this ACS.  
setOrigin(val: Readonly<WritableXYAndZ> | Readonly<WritableXAndY>): void    
setRotation(rMatrix: Matrix3d): void    
toJSON(): AuxCoordSystem3dProps Obtain this element's JSON representation.  

Inherited methods

Name Inherited from Description
clone(iModel?: IModelConnection): this AuxCoordSystemState Make an independent copy of this EntityState
display(context: DecorateContext, options: ACSDisplayOptions): void AuxCoordSystemState  
drawGrid(context: DecorateContext): void AuxCoordSystemState  
equals(other: this): boolean AuxCoordSystemState Return true if this EntityState is equal to another one.
isValidForView(view: ViewState): boolean AuxCoordSystemState  
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.

Properties

Name Type Description
className Accessor Static ReadOnly string The name of the BIS class associated with this class.  
origin Readonly Point3d    
pitch number    
roll number    
yaw number    

Inherited properties

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

Defined in

Last Updated: 28 October, 2024