Updating Agent Metadata and ThirdPartyCamera Metadata

[winthos]

This updates agent main camera and third party camera returned metadata to be more descriptive and have parity with each other in terms of naming convention and what values are returned. The idea is any camera, main or third party, will always return their position and rotation coordinates in world space and relative to the agent. Third party cameras additionally return position and rotation relative to any parent they might have as third party cameras may be attached to specific segments of articulated agents at some point.

This also fixes a silent bug where third party camera values may have not been correctly being calculated relative to the agent in some circumstances.

metadata now has

• worldRelativeCameraPosition - New metadata added. same as AgentMetadata.cameraPosition which returns the position of the camera in world coordinates.
• worldRelativeCameraRotation - New metadata added. same as AgentMetadata.cameraRotation which returns the rotation of the camera in world coordinates
• agentPositionRelativeCameraPosition - this already existed, returns position of the camera relative to the AgentMetadata.position
• agentPositionRelativeCameraRotation - this already existed, returns rotation of the camera relative to the AgentMetadata.position

ThirdPartyCameraMetadata has been updated as well

• worldRelativeThirdPartyCameraPosition - newly added. the same as ThirdPartyCameraMetadata.position but with more descriptive name
• worldRelativeThirdPartyCameraRotation - newly added. the same as ThirdPartyCameraMetadata.rotation but with a more descriptive name
• agentPositionRelativeThirdPartyCameraPosition - newly added. If this third party camera is attached to an agent, returns the position of this camera relative to that agent. Null otherwise.
• agentPositionRelativeThirdPartyCameraRotation - newly added. If this third party camera is attached to an agent, returns the rotation of this camera relative to that agent, null otherwise
• parentPositionRelativeThirdPartyCameraPosition - newly added, if this third party camera is the child of some other object, returns the position of this camera relative to that object. Null otherwise. This allows us to track which joint a camera may be attached to for agents with joints and the like.
• parentPositionRelativeThirdPartyCameraRotation - newly added, if this third party camera is the child of some other object, returns the rotation of this camera relative to that object. Null otherwise. This allows us to track which joint a camera may be attached to for agents with joints and the like.
• parentObjectName - newly added, if this third party camera has a parent object (which could also be the agent) returns the string name of that object.

[elimvb]

All good logically! Just a few tweaks for efficiency and typography's sake

[Lucaweihs]

Minor naming change suggestion, otherwise LGTM.

[Lucaweihs]

Rather than parentPositionRelative... can we change this to just parentRelative...? I.e.

parentPositionRelativeThirdPartyCameraPosition -> parentRelativeThirdPartyCameraPosition
parentPositionRelativeThirdPartyCameraRotation -> parentRelativeThirdPartyCameraRotation

[winthos]

Ok! Just talked with rose about this to confirm that its still clear that the third party camera position is relative to the parent's position, and that the third party camera rotation is relative to the parent's rotation.

Note that there was a change previously to make parentPositionRelativeThirdPartyCameraRotation to parent RotationRelativeThirdPartyCameraRotation to make it explicit that the rotation can only be relative to rotation, and position can only be relative to position, but I think we can just do this in the description of the variables in the documentation rather than bloating the names.

[Lucaweihs]

I suppose it's not clear to me what it would mean for a rotation to be relative a position?

[winthos]

updated with 12d8e05

[winthos]

I suppose it's not clear to me what it would mean for a rotation to be relative a position?

Right, I think most people can intuit that position only makes sense relative to a position, and rotation to a rotation, so my original intent of being extremely explicit was probably overkill