Definition
Functional Requirements
Syntax
Semantics
Conformance Testing
Performance Assessment
1 Definition
Basic Pointer Object.
2 Functional Requirements
- The Data shall have Header “OSD-BPO-V1.5”.
- The Data shall include BasicPointerObjectID, BasicPointerData.
- The Data may include the other properties of Table 1, each as specified there.
- The Data shall validate against the JSON Schema of Section 3.
3 Syntax
https://schemas.mpai.community/OSD/V1.5/data/BasicPointerObject.json
4 Semantics
| Header | Basic Pointer Object Header – Standard “OSD-BPO-Vx.y”. |
| MInstanceID | |
| UEnvironment | |
| BasicPointerObjectID | (required) |
| BasicPointerObjectTime | (SimpleTime) |
| PointerSpace | |
| – Width | (required) |
| – Height | (required) |
| – Unit | |
| BasicPointerData[] | (required) |
| – PointerID | (required) |
| – PointerType | (required) |
| – IsPrimary | |
| – EventType | One of: pointerover, pointerenter, pointerdown, pointermove, pointerrawupdate, pointerup, pointercancel, pointerout, pointerleave, gotpointercapture, lostpointercapture, wheel. (required) |
| – EventTime | (SimpleTime) |
| – X | (required) |
| – Y | (required) |
| – Width | |
| – Height | |
| – Pressure | Range 0..1. |
| – TangentialPressure | Range -1..1. |
| – TiltX | |
| – TiltY | |
| – Twist | |
| – AltitudeAngle | Range 0..1.5707963267948966. |
| – AzimuthAngle | Range 0..6.283185307179586. |
| – Button | |
| – Buttons | |
| – DeltaX | |
| – DeltaY | |
| – DeltaZ | |
| – DeltaMode | One of: 0, 1, 2. |
| – Momentum | |
| SpatialQualifier | Spatial Qualifier stating the conventions of the positions of the pointer: the frame, the origin and the axes of the space PointerSpace describes, and its unit. (SpatialQualifier) |
| DataXMData | (DataExchangeMetadata) |
| DescrMetadata |
5 Conformance Testing
A Data instance conforms with Basic Pointer Object (OSD-BPO) if it validates against the JSON Schema of Section 3. If a schema contains references to other schemas, conformance of data for the primary schema implies that any data referencing a secondary schema shall also validate against the relevant schema.
6 Performance Assessment
Not part of this specification.