An interface representing the orientation of an entity. Such an entity can have 1D 2D or 3D orientation.
An example of a 1D orientation would be a rotary potentiometer. It has a single degree of rotational freedom and that's only has one degree of orientation.
An accelerometer to represent 2D orientation but so could a joystick represent 2D orientation. The reason accelerometers do not have more degrees of freedom is due to the fact that they cannot get y'all without some other reference that isn't gravity like a compass.
3D orientation can come from an IMU that provides yaw pitch and roll information.
There should also be consideration of whether or not there should be separate interfaces for each type of orientation 1D, 2D or 3D. The benefits of having separate types for each one are:
APIs using specific interfaces will make it more clear and obvious to the developers what their expectations are. Taking a 3D orientation when you only want one dimension of orientation information can make the API a bit confusing.
The cost of having to use a 3D orientation for all orientations is that you pay the cost of returning a larger data structure when you will never use these values.
Whether or not this particular interface should use were there angles or quaternions is up for debate. My personal preference would be or their angles as it's more intuitive for human beings to understand.
An interface representing the orientation of an entity. Such an entity can have 1D 2D or 3D orientation.
An example of a 1D orientation would be a rotary potentiometer. It has a single degree of rotational freedom and that's only has one degree of orientation.
An accelerometer to represent 2D orientation but so could a joystick represent 2D orientation. The reason accelerometers do not have more degrees of freedom is due to the fact that they cannot get y'all without some other reference that isn't gravity like a compass.
3D orientation can come from an IMU that provides yaw pitch and roll information.
There should also be consideration of whether or not there should be separate interfaces for each type of orientation 1D, 2D or 3D. The benefits of having separate types for each one are:
Whether or not this particular interface should use were there angles or quaternions is up for debate. My personal preference would be or their angles as it's more intuitive for human beings to understand.