SetPositionAndOrientation - Intergraph Smart 3D Web API - Customization & Programming - Hexagon PPM

Intergraph Smart 3D Web API Programmers Reference

Language
English
Product
Intergraph Smart 3D Web API
Subproduct
Smart 3D Web APIs
Search by Category
Customization & Programming
Smart 3D Version
13

IJLocalCoordinateSystem properties, such as position or orientation properties like XAxis, YAxis, and ZAxis, are part of a special subset of properties that are declared as read-only in the metadata and cannot be modified through the regular property-update mechanisms such as PATCH or BulkUpdate request.

The Com.Ingr.Smart3d.V1.SetPositionAndOrientation OData action is provided to update IJLocalCoordinateSystem properties representing the position and orientation. This action is bound to a Plant entity and can update one or more S3dItem entities by providing the ID, Position, and Orientation (X and Y axes) values for each entity to be updated. The request can also include ID with only one of Position or Orientation as well. However, at least one, if not both, of these properties are required.

POST https:/MyServer.Domain.com/s3d/v1/Sites('MySiteAlias')/Plants('MyPlant')/Com.Ingr.Smart3d.V1.SetPositionAndOrientation

{

"positionAndOrientationData": [

{

"Id": "00004E2E-0000-0000-3B0E-272AE4542704",

"Position": {

"type": "Point",

"coordinates": [

15000.0,

1880.0,

13.499448

]

},

"Orientation": {

"XAxis": {

"X": 8.0384689632619115E-08,

"Y": 0.99999999999999678,

"Z": 0.0

},

"YAxis": {

"X": -0.99999999999999678,

"Y": 8.0384689632619115E-08,

"Z": 0.0

}

}

}

]

}

Parameter

Type

Description

positionAndOrientationData

Collection<Com.Ingr.Smart3d.V1.PositionAndOrientation>

Collection of ID, Position, and Orientation properties for each entity to be updated.

Within the Com.Ingr.Smart3d.V1.PositionAndOrientation representing each entity to be updated there are three properties that can be provided. The follow table describes them in more detail:

Property

Type

Description

Id

Edm.String

The object identifier for the S3dItem entity to be updated that implements IJLocalCoordinateSystem.

Position

Edm.GeometryPoint

3D coordinates representing the position (also referred to as Origin in Smart 3D) of an entity.

Orientation

Com.Ingr.Smart3d.V1.Orientation

Contains two 3D Com.Ingr.Spatial.V1.Vector properties for the X and Y axes representing the 3D orientation of the entity. These must be orthogonal, and the Z axis will be calculated and updated accordingly.