API Reference > imodeljs-frontend > Views > ViewState3d

ViewState3d Class

Defines the state of a view of 3d models.

see ViewState Parameters

Extends

Extended by

Implements

Methods

Name Description
constructor(props: ViewDefinition3dProps, iModel: IModelConnection, categories: CategorySelectorState, displayStyle: DisplayStyle3dState): ViewState3d    
allow3dManipulations(): boolean    
calcLensAngle(): Angle Calculate the lens angle formed by the current delta and focus distance  
centerEyePoint(backDistance?: number): void Place the eyepoint of the camera so it is aligned with the center of the view.  
centerFocusDistance(): void Center the focus distance of the camera halfway between the front plane and the back plane, keeping the eyepoint,  
createAuxCoordSystem(acsName: string): AuxCoordSystemState    
decorate(context: DecorateContext): void    
getBackDistance(): number Get the distance from the eyePoint to the back plane for this view.  
getDisplayStyle3d(): DisplayStyle3dState    
getExtents(): Vector3d    
getEyePoint(): Point3d Get the current location of the eyePoint for camera in this view.  
getFocusDistance(): number Get the distance from the eyePoint to the focus plane for this view.  
getFrontDistance(): number Get the distance from the eyePoint to the front plane for this view.  
getGroundElevation(): number Returns the ground elevation taken from the environment added with the global z position of this imodel.  
getGroundExtents(vp?: Viewport): AxisAlignedBox3d Return the ground extents, which will originate either from the viewport frustum or the extents of the imodel.  
getLensAngle(): Angle Get the lens angle for this view.  
getOrigin(): Point3d    
getRotation(): Matrix3d    
getTargetPoint(result?: Primitives.Point3d): Point3d Get the target point of the view.  
isEyePointAbove(elevation: number): boolean    
lookAt(eyePoint: XYAndZ, targetPoint: XYAndZ, upVector: Vector3d, newExtents?: XAndY, frontDistance?: number, backDistance?: number): ViewStatus Position the camera for this view and point it at a new target point.  
lookAtUsingLensAngle(eyePoint: Point3d, targetPoint: Point3d, upVector: Vector3d, fov: Angle, frontDistance?: number, backDistance?: number): ViewStatus Position the camera for this view and point it at a new target point, using a specified lens angle.  
minimumFrontDistance(): number    
moveCameraLocal(distance: Vector3d): ViewStatus Move the camera relative to its current location by a distance in camera coordinates.  
moveCameraWorld(distance: Vector3d): ViewStatus Move the camera relative to its current location by a distance in world coordinates.  
onRenderFrame(_viewport: Viewport): void    
rotateCameraLocal(angle: Angle, axis: Vector3d, aboutPt?: Primitives.Point3d): ViewStatus Rotate the camera from its current location about an axis relative to its current orientation.  
rotateCameraWorld(angle: Angle, axis: Vector3d, aboutPt?: Primitives.Point3d): ViewStatus Rotate the camera from its current location about an axis in world coordinates.  
setAllow3dManipulations(allow: boolean): void Set whether ViewTools are allowed to operate in 3 dimensions on this view.  
setExtents(extents: XYAndZ): void    
setEyePoint(pt: XYAndZ): void Change the location of the eyePoint for the camera in this view.  
setFocusDistance(dist: number): void Set the focus distance for this view.  
setLensAngle(angle: Angle): void Set the lens angle for this view.  
setOrigin(origin: XYAndZ): void    
setRotation(rot: Matrix3d): void    
setupFromFrustum(frustum: Frustum): ViewStatus    
supportsCamera(): boolean    
toJSON(): ViewDefinition3dProps    
turnCameraOff(): void Turn the camera off for this view.  
verifyFocusPlane(): void Ensure the focus plane lies between the front and back planes.  
calculateMaxDepth(delta: Vector3d, zVec: Vector3d): number ProtectedStatic    

Inherited methods

Name Inherited from Description
calculateFocusCorners(): Point3d[] ViewState  
calculateFrustum(result?: Frustum): Frustum | undefined ViewState Calculate the world coordinate Frustum from the parameters of this ViewState.
clone(iModel?: IModelConnection): this EntityState Make an independent copy of this EntityState
computeFitRange(): Range3d Abstract ViewState Compute a range in CoordSystem.World coordinates that tightly encloses the contents of this view.
equals(other: this): boolean ViewState Determine whether this ViewState exactly matches another.
forEachModel(func: (model: GeometricModelState) => void): void Abstract ViewState Execute a function on each viewed model
getAspectRatio(): number ViewState Get the aspect ratio (width/height) of this view
getAspectRatioSkew(): number ViewState Get the aspect ratio skew (x/y, usually 1.0) that is used to exaggerate the y axis of the view.
getAuxiliaryCoordinateSystemId(): Id64String ViewState Get the Id of the auxiliary coordinate system for this ViewState
getCenter(result?: Primitives.Point3d): Point3d ViewState Get the point at the geometric center of the view.
getDetails(): any ViewState  
getGridOrientation(): GridOrientationType ViewState Get the grid settings for this view
getGridSettings(vp: Viewport, origin: Point3d, rMatrix: Matrix3d, orientation: GridOrientationType): void ViewState Populate the given origin and rotation with information from the grid settings from the grid orientation.
getGridSpacing(): XAndY ViewState  
getGridsPerRef(): number ViewState  
getSubCategoryOverride(id: Id64String): SubCategoryOverride | undefined ViewState Query the symbology overrides applied to geometry belonging to a specific subcategory when rendered using this ViewState.
getViewClip(): ClipVector | undefined ViewState Get the clipping volume for this view, if defined
getViewedExtents(): AxisAlignedBox3d Abstract ViewState Get the extents of this view in CoordSystem.World coordinates.
getXVector(result?: Vector3d): Vector3d ViewState Get the unit vector that points in the view X (left-to-right) direction.
getYVector(result?: Vector3d): Vector3d ViewState Get the unit vector that points in the view Y (bottom-to-top) direction.
getZVector(result?: Vector3d): Vector3d ViewState Get the unit vector that points in the view Z (front-to-back) direction.
is2d(): this is ViewState2d ViewState Returns true if this ViewState is-a ViewState2d
is3d(): this is ViewState3d ViewState Returns true if this ViewState is-a ViewState3d
isCameraEnabled(): this is ViewState3d ViewState Returns true if this ViewState is-a ViewState3d with the camera currently on.
isDrawingView(): this is DrawingViewState ViewState Returns true if this ViewState is-a DrawingViewState
isSpatialView(): this is SpatialViewState ViewState Returns true if this ViewState is-a SpatialViewState
load(): Promise<void> ViewState Asynchronously load any required data for this ViewState from the backend.
lookAtViewAlignedVolume(volume: Range3d, aspect?: number, margin?: MarginPercent): void ViewState Look at a volume of space defined by a range in view local coordinates, keeping its current rotation.
lookAtVolume(volume: LowAndHighXYZ | LowAndHighXY, aspect?: number, margin?: MarginPercent): void ViewState Change the volume that this view displays, keeping its current rotation.
resetExtentLimits(): void ViewState Resets the largest and smallest values allowed for the extents of this ViewState to their default values.
setAspectRatioSkew(val: number): void ViewState Set the aspect ratio skew (x/y) for this view.
setAuxiliaryCoordinateSystem(acs?: AuxCoordSystemState): void ViewState Set or clear the AuxiliaryCoordinateSystem for this view.
setCategorySelector(categories: CategorySelectorState): void ViewState Set the CategorySelector for this view.
setCenter(center: Point3d): void ViewState set the center of this view to a new position.
setDisplayStyle(style: DisplayStyleState): void ViewState  
setGridSettings(orientation: GridOrientationType, spacing: Point2d, gridsPerRef: number): void ViewState Set the grid settings for this view
setRotationAboutPoint(rotation: Matrix3d, point?: Primitives.Point3d): void ViewState Set the rotation of this ViewState to the supplied rotation, by rotating it about a point.
setStandardRotation(id: StandardViewId): void ViewState Orient this view to one of the StandardView rotations.
setViewClip(clip?: ClipVector): void ViewState Set or clear the clipping volume for this view.
viewsCategory(id: Id64String): boolean ViewState Determine whether the specified Category is displayed in this view
viewsModel(modelId: Id64String): boolean Abstract ViewState Returns true if this view displays the contents of a ViewState.Model specified by Id.
createFromProps(_props: ViewStateProps, _iModel: IModelConnection): ViewState | undefined Static ViewState Create a new ViewState object from a set of properties.

Properties

Name Type Description
_cameraOn Protected boolean True if the camera is valid.  
camera Camera The camera used for this view.  
details Accessor ReadOnly ViewDetails3d Provides access to optional detail settings for this view. Beta  
extents Vector3d The extent of the view frustum.  
forceMinFrontDist number Minimum distance for front plane  
isCameraOn Accessor ReadOnly boolean    
isCameraValid Accessor ReadOnly boolean Determine whether the camera is valid for this view  
origin Point3d The lower left back corner of the view frustum.  
rotation Matrix3d Rotation of the view frustum.  

Inherited properties

Name Type Inherited from Description
analysisStyle Accessor ReadOnly AnalysisStyle | undefined ViewState Get the AnalysisDisplayProperties from the displayStyle of this ViewState.
auxiliaryCoordinateSystem Accessor ReadOnly AuxCoordSystemState ViewState get the auxiliary coordinate system state object for this ViewState.
backgroundColor Accessor ReadOnly ColorDef ViewState Get this view's background color.
categorySelector CategorySelectorState ViewState Selects the categories that are display by this ViewState.
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
defaultExtentLimits Accessor ReadOnly ExtentLimits ViewState Returns the default extent limits for this ViewState. These limits are used if the ViewState.extentLimits have not been explicitly overridden.
description undefined | string ViewState  
displayStyle DisplayStyleState ViewState Selects the styling parameters for this this ViewState.
extentLimits Accessor ExtentLimits ViewState Get or set the largest and smallest values allowed for the extents for this ViewState
The default limits vary based on the type of view:
- Spatial view extents cannot exceed the diameter of the earth.
- Drawing view extents cannot exceed twice the longest axis of the drawing model's range.
- Sheet view extents cannot exceed ten times the paper size of the sheet.
Explicitly setting the extent limits overrides the default limits.
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
isPrivate undefined | false | true ViewState  
jsonProperties [key: string]: any EntityState Optional json properties of this Entity.
model Id64String ElementState The ModelId of the Model containing this element
name Accessor ReadOnly string ViewState Get the name of the ViewDefinition from which this ViewState originated.
parent undefined | RelatedElement ElementState The parent Element of this, or undefined if no parent.
schemaName Accessor StaticReadOnly string EntityState The name of the BIS schema for this class.
userLabel undefined | string ElementState A user-assigned label for this element.
viewFlags Accessor ReadOnly ViewFlags ViewState Get the ViewFlags from the DisplayStyleState of this ViewState.

Defined in

Last Updated: 13 June, 2024