OrthographicViewDefinition Class
Defines a spatial view that displays geometry on the image plane using a parallel orthographic projection. See [how to create a OrthographicViewDefinition]$(docs/learning/backend/CreateElements.md#OrthographicViewDefinition).
Extends
Methods
Name | Description | |
---|---|---|
constructor(props: SpatialViewDefinitionProps, iModel: IModelDb): OrthographicViewDefinition | ||
setRange(range: Range3d): void | Set a new viewed range without changing the rotation or any other properties. | |
create(iModelDb: IModelDb, definitionModelId: string, name: string, modelSelectorId: string, categorySelectorId: string, displayStyleId: string, range: Range3d, standardView: StandardViewIndex = StandardViewIndex.Iso): OrthographicViewDefinition Static | Create an OrthographicViewDefinition | |
insert(iModelDb: IModelDb, definitionModelId: string, name: string, modelSelectorId: string, categorySelectorId: string, displayStyleId: string, range: Range3d, standardView: StandardViewIndex = StandardViewIndex.Iso): string Static | Insert an OrthographicViewDefinition |
Inherited methods
Name | Inherited from | Description |
---|---|---|
collectPredecessorIds(predecessorIds: EntityReferenceSet): void Protected | SpatialViewDefinition | Collect the Ids of this element's references at this level of the class hierarchy. |
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected | SpatialViewDefinition | Collect the Ids of this entity's references at this level of the class hierarchy. |
delete(): void | SpatialViewDefinition | Delete this Element from the iModel. |
forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void | SpatialViewDefinition | Call a function for each property of this Entity. |
getAuxiliaryCoordinateSystemId(): string | SpatialViewDefinition | The Id of the AuxiliaryCoordinateSystem for this ViewDefinition, or an invalid Id if no ACS is defined. |
getClassMetaData(): undefined | EntityMetaData | SpatialViewDefinition | Get the class metadata for this element. |
getDisplayLabel(): string | SpatialViewDefinition | Get a display label for this Element. |
getJsonProperty(nameSpace: string): any | SpatialViewDefinition | Get a JSON property of this element, by namespace |
getPredecessorIds(): Id64Set | SpatialViewDefinition | Get the Ids of this element's references. |
getReferenceIds(): EntityReferenceSet | SpatialViewDefinition | Get the set of this entity's entity references, EntityReferenceSet. |
SpatialViewDefinition | Get a list of HTML strings that describe this Element for the tooltip. | |
getUserProperties(namespace: string): any | SpatialViewDefinition | Get a set of JSON user properties by namespace |
insert(): string | SpatialViewDefinition | Insert this Element into the iModel. |
isDrawingView(): this is DrawingViewDefinition | SpatialViewDefinition | Type guard for 'instanceof DrawingViewDefinition' |
isSpatialView(): this is SpatialViewDefinition | SpatialViewDefinition | Type guard for instanceof SpatialViewDefinition |
isView2d(): this is ViewDefinition2d | SpatialViewDefinition | Type guard for 'instanceof ViewDefinition2d` |
isView3d(): this is ViewDefinition3d | SpatialViewDefinition | Type guard for instanceof ViewDefinition3d |
loadCategorySelector(): CategorySelector | SpatialViewDefinition | Load this view's CategorySelector from the IModelDb. |
loadDisplayStyle(): DisplayStyle | SpatialViewDefinition | Load this view's DisplayStyle from the IModelDb. |
loadDisplayStyle3d(): DisplayStyle3d | SpatialViewDefinition | Load this view's DisplayStyle3d from the IModelDb. |
loadModelSelector(): ModelSelector | SpatialViewDefinition | Load this view's ModelSelector from the IModelDb. |
removeUserProperties(nameSpace: string): void | SpatialViewDefinition | Remove a set of JSON user properties, specified by namespace, from this Element |
setAuxiliaryCoordinateSystemId(acsId: string): void | SpatialViewDefinition | Set or clear the AuxiliaryCoordinateSystem for this ViewDefinition. |
setJsonProperty(nameSpace: string, value: any): void | SpatialViewDefinition | |
setUserProperties(nameSpace: string, value: any): void | SpatialViewDefinition | Change a set of user JSON properties of this Element by namespace. |
toJSON(): SpatialViewDefinitionProps | SpatialViewDefinition | Obtain the JSON representation of this Entity. |
update(): void | SpatialViewDefinition | Update this Element in the iModel. |
createCode(iModel: IModelDb, scopeModelId: string, codeValue: string): Code Static | SpatialViewDefinition | Create a Code for a ViewDefinition given a name that is meant to be unique within the scope of the specified DefinitionModel. |
createWithCamera(iModelDb: IModelDb, definitionModelId: string, name: string, modelSelectorId: string, categorySelectorId: string, displayStyleId: string, range: Range3d, standardView: StandardViewIndex = StandardViewIndex.Iso, cameraAngle: number = Angle.piOver2Radians): SpatialViewDefinition Static | SpatialViewDefinition | Create a SpatialViewDefinition with the camera turned on. |
fromJSON(props: Omit<SpatialViewDefinitionProps, "classFullName">, iModel: IModelDb): SpatialViewDefinition Static | SpatialViewDefinition | Construct a SpatialViewDefinition from its JSON representation. |
insertWithCamera(iModelDb: IModelDb, definitionModelId: string, name: string, modelSelectorId: string, categorySelectorId: string, displayStyleId: string, range: Range3d, standardView: StandardViewIndex = StandardViewIndex.Iso, cameraAngle: number = Angle.piOver2Radians): string Static | SpatialViewDefinition | Insert an SpatialViewDefinition with the camera turned on. |
is(otherClass: undefined): boolean Static | SpatialViewDefinition | return whether this Entity class is a subclass of another Entity class |
onAllInputsHandled(_id: string, _iModel: IModelDb): void ProtectedStatic | SpatialViewDefinition | Called on an element in a graph after all of its inputs have been processed and before its outputs are processed. |
onBeforeOutputsHandled(_id: string, _iModel: IModelDb): void ProtectedStatic | SpatialViewDefinition | Called when a root element in a subgraph is changed and before its outputs are processed. |
onChildAdd(_arg: OnChildElementPropsArg): void ProtectedStatic | SpatialViewDefinition | Called when an existing element is about to be updated so that an instance of this class will become its new parent. |
onChildAdded(_arg: OnChildElementIdArg): void ProtectedStatic | SpatialViewDefinition | Called after an existing element has been updated so that an instance of this class is its new parent. |
onChildDelete(_arg: OnChildElementIdArg): void ProtectedStatic | SpatialViewDefinition | Called when an element with an instance of this class as its parent is about to be deleted. |
onChildDeleted(_arg: OnChildElementIdArg): void ProtectedStatic | SpatialViewDefinition | Called after an element with an instance of this class as its parent was successfully deleted. |
onChildDrop(_arg: OnChildElementIdArg): void ProtectedStatic | SpatialViewDefinition | Called when an element with an instance of this class as its parent is about to be updated change to a different parent. |
onChildDropped(_arg: OnChildElementIdArg): void ProtectedStatic | SpatialViewDefinition | Called after an element with an instance of this class as its previous parent was updated to have a new parent. |
onChildInsert(_arg: OnChildElementPropsArg): void ProtectedStatic | SpatialViewDefinition | Called when a new element with an instance of this class as its parent is about to be inserted. |
onChildInserted(_arg: OnChildElementIdArg): void ProtectedStatic | SpatialViewDefinition | Called after a new element with an instance of this class as its parent was inserted. |
onChildUpdate(_arg: OnChildElementPropsArg): void ProtectedStatic | SpatialViewDefinition | Called when an element with an instance of this class as its parent is about to be updated. |
onChildUpdated(_arg: OnChildElementIdArg): void ProtectedStatic | SpatialViewDefinition | Called after an element with an instance of this the class as its parent was updated. |
onDelete(arg: OnElementIdArg): void ProtectedStatic | SpatialViewDefinition | Called before an Element is deleted. |
onDeleted(_arg: OnElementIdArg): void ProtectedStatic | SpatialViewDefinition | Called after an Element was deleted. |
onInsert(arg: OnElementPropsArg): void ProtectedStatic | SpatialViewDefinition | Called before a new Element is inserted. |
onInserted(arg: OnElementIdArg): void ProtectedStatic | SpatialViewDefinition | Called after a new Element was inserted. |
onSubModelDelete(_arg: OnSubModelIdArg): void ProtectedStatic | SpatialViewDefinition | Called when a sub-model of an instance of this class is being deleted. |
onSubModelDeleted(_arg: OnSubModelIdArg): void ProtectedStatic | SpatialViewDefinition | Called after a sub-model of an instance of this class was deleted. |
onSubModelInsert(_arg: OnSubModelPropsArg): void ProtectedStatic | SpatialViewDefinition | Called when an instance of this class is being sub-modeled by a new Model. |
onSubModelInserted(_arg: OnSubModelIdArg): void ProtectedStatic | SpatialViewDefinition | Called after an instance of this class was sub-modeled by a new Model. |
onUpdate(arg: OnElementPropsArg): void ProtectedStatic | SpatialViewDefinition | Called before an Element is updated. |
onUpdated(_arg: OnElementIdArg): void ProtectedStatic | SpatialViewDefinition | Called after an Element was updated. |
Inherited properties
Name | Type | Inherited from | Description |
---|---|---|---|
angles | YawPitchRollAngles | SpatialViewDefinition | Rotation from world coordinates to view coordinates. |
camera | Camera | SpatialViewDefinition | The camera used for this view, if cameraOn is true. |
cameraOn | boolean | SpatialViewDefinition | If true, camera is used. |
categorySelectorId | string | SpatialViewDefinition | The element Id of the CategorySelector for this ViewDefinition |
classFullName Accessor ReadOnly | string | SpatialViewDefinition | Get the full BIS class name of this Entity in the form "schema:class". |
classFullName Accessor StaticReadOnly | string | SpatialViewDefinition | Get the full BIS class name of this Entity in the form "schema:class" |
className Accessor ReadOnly | string | SpatialViewDefinition | The name of the BIS class associated with this class. |
code | Code | SpatialViewDefinition | The Code for this element |
details Accessor ReadOnly | ViewDetails3d | SpatialViewDefinition | Provides access to optional detail settings for this view. |
displayStyleId | string | SpatialViewDefinition | The element Id of the DisplayStyle for this ViewDefinition |
extents | Vector3d | SpatialViewDefinition | The extent (size) of the view frustum, in meters, along its x,y,z axes. |
federationGuid | undefined | string | SpatialViewDefinition | A FederationGuid assigned to this element by some other federated database |
id | string | SpatialViewDefinition | The Id of this Entity. |
iModel | IModelDb | SpatialViewDefinition | The IModelDb that contains this Entity |
isInstanceOfEntity Readonly | "true" | SpatialViewDefinition | An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types |
isPrivate | boolean | SpatialViewDefinition | If true, don't show this DefinitionElement in user interface lists. |
jsonProperties Readonly | { T } | SpatialViewDefinition | Optional json properties of this element. |
model Readonly | string | SpatialViewDefinition | The ModelId of the Model containing this element |
modelSelectorId | string | SpatialViewDefinition | The Id of the ModelSelector for this SpatialViewDefinition. |
origin | Point3d | SpatialViewDefinition | The lower left back corner of the view frustum. |
parent | undefined | RelatedElement | SpatialViewDefinition | The parent element, if present, of this element. |
requiredReferenceKeys StaticReadonly | undefined | SpatialViewDefinition | |
schema Static | undefined | SpatialViewDefinition | The Schema that defines this class. |
schemaName Accessor ReadOnly | string | SpatialViewDefinition | The name of the BIS Schema that defines this class |
userLabel | undefined | string | SpatialViewDefinition | A user-assigned label for this element. |
Defined in
- core/backend/src/ViewDefinition.ts Line 426
Last Updated: 15 March, 2024
Found something wrong, missing, or unclear on this page?
Raise an issue in our repo.