unreal.LiveLinkOpenTrackIOData¶
- class unreal.LiveLinkOpenTrackIOData(static: LiveLinkOpenTrackIOStatics = Ellipsis, tracker: LiveLinkOpenTrackIOTracker = Ellipsis, timing: LiveLinkOpenTrackIOTiming = Ellipsis, lens: LiveLinkOpenTrackIOLens = Ellipsis, protocol: LiveLinkOpenTrackIOProtocol = Ellipsis, sample_id: str = '', source_id: str = '', source_number: int = 0, related_sample_ids: None = [], global_stage: LiveLinkOpenTrackIOGlobalStage = Ellipsis, transforms: None = [], custom: LiveLinkOpenTrackIOCustomData = Ellipsis)¶
Bases:
StructBaseData from a parsed header that was read by other CBOR or JSON format.
Schema can be found here: https://www.opentrackio.org/schema.json
C++ Source:
Plugin: LiveLinkOpenTrackIO
Module: LiveLinkOpenTrackIO
File: LiveLinkOpenTrackIOTypes.h
Editor Properties: (see get_editor_property/set_editor_property)
custom(LiveLinkOpenTrackIOCustomData): [Read-Write] Typed property to allow users to add custom data to the incoming OpenTrackIO data. Our implementation only supports a field called LiveLinkMetaData. For example,“custom” : {
- “liveLinkMetaData”[
- {
“key”: “mykey”, “value”: “myvalue”
}, {
“key”: “otherKey”, “value”: “otherValue”
}
]
}
global_stage(LiveLinkOpenTrackIOGlobalStage): [Read-Write] Position of stage origin in global ENU and geodetic coordinateslens(LiveLinkOpenTrackIOLens): [Read-Write]protocol(LiveLinkOpenTrackIOProtocol): [Read-Write]related_sample_ids(Array[str]): [Read-Write] List of sampleId properties of samples related to this sample. The existence of a sample with a given sampleId is not guaranteed.sample_id(str): [Read-Write] URN serving as unique identifier of the sample in which data is being transported. Pattern -> ^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$source_id(str): [Read-Write] URN serving as unique identifier of the source from which data is being transported. Pattern -> ^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$source_number(int64): [Read-Write] Number that identifies the index of the stream from a source from which data is being transported. This is most important in the case where a source is producing multiple streams of samples.static(LiveLinkOpenTrackIOStatics): [Read-Write]timing(LiveLinkOpenTrackIOTiming): [Read-Write]tracker(LiveLinkOpenTrackIOTracker): [Read-Write]transforms(Array[LiveLinkOpenTrackIOTransform]): [Read-Write] A list of transforms. Transforms are composed in order with the last in the list representing the X,Y,Z in meters of camera sensor relative to stage origin. The Z axis points upwards and the coordinate system is right-handed. Y points in the forward camera direction (when pan, tilt and roll are zero). For example in an LED volume Y would point towards the centre of the LED wall and so X would point to camera-right. Rotation expressed as euler angles in degrees of the camera sensor relative to stage origin Rotations are intrinsic and are measured around the axes ZXY, commonly referred to as [pan, tilt, roll] Notes on Euler angles: Euler angles are human readable and unlike quarternions, provide the ability for cycles (with angles >360 or <0 degrees). Where a tracking system is providing the pose of a virtual camera, gimbal lock does not present the physical challenges of a robotic system. Conversion to and from quarternions is trivial with an acceptable loss of precision.
- property custom: LiveLinkOpenTrackIOCustomData¶
[Read-Write] Typed property to allow users to add custom data to the incoming OpenTrackIO data. Our implementation only supports a field called LiveLinkMetaData. For example,
“custom” : {
- “liveLinkMetaData”[
- {
“key”: “mykey”, “value”: “myvalue”
}, {
“key”: “otherKey”, “value”: “otherValue”
}
]
}
- Type:
- property global_stage: LiveLinkOpenTrackIOGlobalStage¶
[Read-Write] Position of stage origin in global ENU and geodetic coordinates
- Type:
- property lens: LiveLinkOpenTrackIOLens¶
[Read-Write]
- Type:
- property protocol: LiveLinkOpenTrackIOProtocol¶
[Read-Write]
- Type:
[Read-Write] List of sampleId properties of samples related to this sample. The existence of a sample with a given sampleId is not guaranteed.
- property sample_id: str¶
[Read-Write] URN serving as unique identifier of the sample in which data is being transported. Pattern -> ^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- Type:
(str)
- property source_id: str¶
[Read-Write] URN serving as unique identifier of the source from which data is being transported. Pattern -> ^urn:uuid:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- Type:
(str)
- property source_number: int¶
[Read-Write] Number that identifies the index of the stream from a source from which data is being transported. This is most important in the case where a source is producing multiple streams of samples.
- Type:
(int64)
- property static: LiveLinkOpenTrackIOStatics¶
[Read-Write]
- Type:
- property timing: LiveLinkOpenTrackIOTiming¶
[Read-Write]
- Type:
- property tracker: LiveLinkOpenTrackIOTracker¶
[Read-Write]
- Type:
- property transforms: None¶
[Read-Write] A list of transforms. Transforms are composed in order with the last in the list representing the X,Y,Z in meters of camera sensor relative to stage origin. The Z axis points upwards and the coordinate system is right-handed. Y points in the forward camera direction (when pan, tilt and roll are zero). For example in an LED volume Y would point towards the centre of the LED wall and so X would point to camera-right. Rotation expressed as euler angles in degrees of the camera sensor relative to stage origin Rotations are intrinsic and are measured around the axes ZXY, commonly referred to as [pan, tilt, roll] Notes on Euler angles: Euler angles are human readable and unlike quarternions, provide the ability for cycles (with angles >360 or <0 degrees). Where a tracking system is providing the pose of a virtual camera, gimbal lock does not present the physical challenges of a robotic system. Conversion to and from quarternions is trivial with an acceptable loss of precision.
- Type: