3
0

CameraComponentController.cpp 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723
  1. /*
  2. * Copyright (c) Contributors to the Open 3D Engine Project.
  3. * For complete copyright and license terms please see the LICENSE at the root of this distribution.
  4. *
  5. * SPDX-License-Identifier: Apache-2.0 OR MIT
  6. *
  7. */
  8. #include "CameraComponentController.h"
  9. #include "AzCore/Component/TransformBus.h"
  10. #include "CameraViewRegistrationBus.h"
  11. #include <Atom/RPI.Public/Pass/PassFilter.h>
  12. #include <Atom/RPI.Public/View.h>
  13. #include <Atom/RPI.Public/ViewportContextManager.h>
  14. #include <Atom/RPI.Public/ViewportContext.h>
  15. #include <AzCore/Asset/AssetSerializer.h>
  16. #include <AzCore/Component/EntityBus.h>
  17. #include <AzCore/Math/MatrixUtils.h>
  18. #include <AzCore/Math/Vector2.h>
  19. #include <AzFramework/Viewport/ViewportScreen.h>
  20. namespace Camera
  21. {
  22. void CameraComponentConfig::Reflect(AZ::ReflectContext* context)
  23. {
  24. if (auto serializeContext = azrtti_cast<AZ::SerializeContext*>(context))
  25. {
  26. serializeContext->Class<CameraComponentConfig, AZ::ComponentConfig>()
  27. ->Version(6)
  28. ->Field("Orthographic", &CameraComponentConfig::m_orthographic)
  29. ->Field("Orthographic Half Width", &CameraComponentConfig::m_orthographicHalfWidth)
  30. ->Field("Field of View", &CameraComponentConfig::m_fov)
  31. ->Field("Near Clip Plane Distance", &CameraComponentConfig::m_nearClipDistance)
  32. ->Field("Far Clip Plane Distance", &CameraComponentConfig::m_farClipDistance)
  33. ->Field("SpecifyDimensions", &CameraComponentConfig::m_specifyFrustumDimensions)
  34. ->Field("FrustumWidth", &CameraComponentConfig::m_frustumWidth)
  35. ->Field("FrustumHeight", &CameraComponentConfig::m_frustumHeight)
  36. ->Field("MakeActiveViewOnActivation", &CameraComponentConfig::m_makeActiveViewOnActivation)
  37. ->Field("RenderToTexture", &CameraComponentConfig::m_renderTextureAsset)
  38. ->Field("PipelineTemplate", &CameraComponentConfig::m_pipelineTemplate)
  39. ;
  40. if (auto editContext = serializeContext->GetEditContext())
  41. {
  42. editContext->Class<CameraComponentConfig>("CameraComponentConfig", "Configuration for a CameraComponent or EditorCameraComponent")
  43. ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
  44. ->Attribute(AZ::Edit::Attributes::Visibility, AZ::Edit::PropertyVisibility::ShowChildrenOnly)
  45. ->DataElement(AZ::Edit::UIHandlers::Default, &CameraComponentConfig::m_makeActiveViewOnActivation,
  46. "Make active camera on activation?", "If true, this camera will become the active render camera when it activates")
  47. ->DataElement(AZ::Edit::UIHandlers::Default, &CameraComponentConfig::m_orthographic, "Orthographic",
  48. "If set, this camera will use an orthographic projection instead of a perspective one. Objects will appear as the same size, regardless of distance from the camera.")
  49. ->Attribute(AZ::Edit::Attributes::ChangeNotify, AZ::Edit::PropertyRefreshLevels::EntireTree)
  50. ->DataElement(AZ::Edit::UIHandlers::Default, &CameraComponentConfig::m_orthographicHalfWidth, "Orthographic Half-width", "The half-width used to calculate the orthographic projection. The height will be determined by the aspect ratio.")
  51. ->Attribute(AZ::Edit::Attributes::Visibility, &CameraComponentConfig::GetOrthographicParameterVisibility)
  52. ->Attribute(AZ::Edit::Attributes::Min, 0.001f)
  53. ->Attribute(AZ::Edit::Attributes::ChangeNotify, AZ::Edit::PropertyRefreshLevels::ValuesOnly)
  54. ->DataElement(AZ::Edit::UIHandlers::Default, &CameraComponentConfig::m_fov, "Field of view", "Vertical field of view in degrees. Note: Max FoV is less than 180.")
  55. ->Attribute(AZ::Edit::Attributes::Min, MinFoV)
  56. ->Attribute(AZ::Edit::Attributes::Suffix, " degrees")
  57. ->Attribute(AZ::Edit::Attributes::Step, 1.f)
  58. ->Attribute(AZ::Edit::Attributes::Max, AZ::RadToDeg(AZ::Constants::Pi) - 0.001f) //We assert at fovs >= Pi so set the max for this field to be just under that
  59. ->Attribute(AZ::Edit::Attributes::ChangeNotify, AZ::Edit::PropertyRefreshLevels::ValuesOnly)
  60. ->Attribute(AZ::Edit::Attributes::Visibility, &CameraComponentConfig::GetPerspectiveParameterVisibility)
  61. ->DataElement(AZ::Edit::UIHandlers::Default, &CameraComponentConfig::m_nearClipDistance, "Near clip distance",
  62. "Distance to the near clip plane of the view Frustum")
  63. ->Attribute(AZ::Edit::Attributes::Min, MinimumNearPlaneDistance)
  64. ->Attribute(AZ::Edit::Attributes::Suffix, " m")
  65. ->Attribute(AZ::Edit::Attributes::Step, 0.1f)
  66. ->Attribute(AZ::Edit::Attributes::Max, &CameraComponentConfig::GetFarClipDistance)
  67. ->Attribute(AZ::Edit::Attributes::ChangeNotify, AZ::Edit::PropertyRefreshLevels::AttributesAndValues)
  68. ->DataElement(AZ::Edit::UIHandlers::Default, &CameraComponentConfig::m_farClipDistance, "Far clip distance",
  69. "Distance to the far clip plane of the view Frustum")
  70. ->Attribute(AZ::Edit::Attributes::Min, &CameraComponentConfig::GetNearClipDistance)
  71. ->Attribute(AZ::Edit::Attributes::Suffix, " m")
  72. ->Attribute(AZ::Edit::Attributes::Step, 10.f)
  73. ->Attribute(AZ::Edit::Attributes::ChangeNotify, AZ::Edit::PropertyRefreshLevels::AttributesAndValues)
  74. ->ClassElement(AZ::Edit::ClassElements::Group, "Render To Texture")
  75. ->DataElement(AZ::Edit::UIHandlers::Default, &CameraComponentConfig::m_renderTextureAsset, "Target texture", "The render target texture which the camera renders to.")
  76. ->DataElement(AZ::Edit::UIHandlers::Default, &CameraComponentConfig::m_pipelineTemplate, "Pipeline template", "The root pass template for the camera's render pipeline")
  77. ;
  78. }
  79. }
  80. }
  81. float CameraComponentConfig::GetFarClipDistance() const
  82. {
  83. return m_farClipDistance;
  84. }
  85. float CameraComponentConfig::GetNearClipDistance() const
  86. {
  87. return m_nearClipDistance;
  88. }
  89. AZ::EntityId CameraComponentConfig::GetEditorEntityId() const
  90. {
  91. return AZ::EntityId(m_editorEntityId);
  92. }
  93. AZ::u32 CameraComponentConfig::GetPerspectiveParameterVisibility() const
  94. {
  95. return m_orthographic ? AZ::Edit::PropertyVisibility::Hide : AZ::Edit::PropertyVisibility::Show;
  96. }
  97. AZ::u32 CameraComponentConfig::GetOrthographicParameterVisibility() const
  98. {
  99. return m_orthographic ? AZ::Edit::PropertyVisibility::Show : AZ::Edit::PropertyVisibility::Hide;
  100. }
  101. CameraComponentController::CameraComponentController(const CameraComponentConfig& config)
  102. {
  103. SetConfiguration(config);
  104. }
  105. void CameraComponentController::ActivateAtomView()
  106. {
  107. auto atomViewportRequests = AZ::Interface<AZ::RPI::ViewportContextRequestsInterface>::Get();
  108. if (atomViewportRequests)
  109. {
  110. AZ_Assert(GetView(), "Attempted to activate Atom camera before component activation");
  111. const AZ::Name contextName = atomViewportRequests->GetDefaultViewportContextName();
  112. AZ::RPI::ViewportContextNotificationBus::Handler::BusConnect(contextName);
  113. // Ensure the Atom camera is updated with our current transform state
  114. AZ::Transform localTransform;
  115. AZ::TransformBus::EventResult(localTransform, m_entityId, &AZ::TransformBus::Events::GetLocalTM);
  116. AZ::Transform worldTransform;
  117. AZ::TransformBus::EventResult(worldTransform, m_entityId, &AZ::TransformBus::Events::GetWorldTM);
  118. OnTransformChanged(localTransform, worldTransform);
  119. // Push the Atom camera after we make sure we're up-to-date with our component's transform to ensure the viewport reads the correct state
  120. UpdateCamera();
  121. atomViewportRequests->PushViewGroup(contextName, m_atomCameraViewGroup);
  122. }
  123. }
  124. void CameraComponentController::DeactivateAtomView()
  125. {
  126. if (auto atomViewportRequests = AZ::Interface<AZ::RPI::ViewportContextRequestsInterface>::Get())
  127. {
  128. const AZ::Name contextName = atomViewportRequests->GetDefaultViewportContextName();
  129. atomViewportRequests->PopViewGroup(contextName, m_atomCameraViewGroup);
  130. AZ::RPI::ViewportContextNotificationBus::Handler::BusDisconnect(contextName);
  131. }
  132. }
  133. void CameraComponentController::SetShouldActivateFunction(AZStd::function<bool()> shouldActivateFunction)
  134. {
  135. m_shouldActivateFn = AZStd::move(shouldActivateFunction);
  136. }
  137. void CameraComponentController::SetIsLockedFunction(AZStd::function<bool()> isLockedFunction)
  138. {
  139. m_isLockedFn = AZStd::move(isLockedFunction);
  140. }
  141. void CameraComponentController::Reflect(AZ::ReflectContext* context)
  142. {
  143. CameraComponentConfig::Reflect(context);
  144. if (auto serializeContext = azrtti_cast<AZ::SerializeContext*>(context))
  145. {
  146. serializeContext->Class<CameraComponentController>()
  147. ->Version(1)
  148. ->Field("Configuration", &CameraComponentController::m_config)
  149. ;
  150. if (auto editContext = serializeContext->GetEditContext())
  151. {
  152. editContext->Class<CameraComponentController>("CameraComponentController", "Controller for a CameraComponent or EditorCameraComponent")
  153. ->ClassElement(AZ::Edit::ClassElements::EditorData, "")
  154. ->Attribute(AZ::Edit::Attributes::Visibility, AZ::Edit::PropertyVisibility::ShowChildrenOnly)
  155. ->DataElement(AZ::Edit::UIHandlers::Default, &CameraComponentController::m_config, "Configuration", "Camera Controller Configuration")
  156. ;
  157. }
  158. }
  159. }
  160. void CameraComponentController::GetRequiredServices(AZ::ComponentDescriptor::DependencyArrayType& required)
  161. {
  162. required.push_back(AZ_CRC("TransformService", 0x8ee22c50));
  163. }
  164. void CameraComponentController::GetProvidedServices(AZ::ComponentDescriptor::DependencyArrayType& provided)
  165. {
  166. provided.push_back(AZ_CRC("CameraService", 0x1dd1caa4));
  167. }
  168. void CameraComponentController::GetIncompatibleServices(AZ::ComponentDescriptor::DependencyArrayType& incompatible)
  169. {
  170. incompatible.push_back(AZ_CRC("CameraService", 0x1dd1caa4));
  171. }
  172. void CameraComponentController::Init()
  173. {
  174. AZStd::function<void(AZ::RPI::ViewPtr view)> onChange = [this](AZ::RPI::ViewPtr view)
  175. {
  176. if (!m_updatingTransformFromEntity && !m_isLockedFn())
  177. {
  178. AZ::TransformBus::Event(m_entityId, &AZ::TransformInterface::SetWorldTM, view->GetCameraTransform());
  179. }
  180. };
  181. m_atomCameraViewGroup = AZStd::make_shared<AZ::RPI::ViewGroup>();
  182. m_atomCameraViewGroup->Init(AZ::RPI::ViewGroup::Descriptor{ onChange, nullptr });
  183. if (auto rpiSystemInterface = AZ::RPI::RPISystemInterface::Get())
  184. {
  185. m_xrSystem = rpiSystemInterface->GetXRSystem();
  186. if (m_xrSystem)
  187. {
  188. m_numSterescopicViews = m_xrSystem->GetNumViews();
  189. AZ_Assert(m_numSterescopicViews <= AZ::RPI::XRMaxNumViews, "Atom only supports two XR views");
  190. }
  191. }
  192. }
  193. void CameraComponentController::Activate(AZ::EntityId entityId)
  194. {
  195. m_entityId = entityId;
  196. // Let's set the camera default transforms:
  197. AZ::TransformBus::EventResult(m_xrCameraToBaseSpaceTm, m_entityId, &AZ::TransformBus::Handler::GetWorldTM);
  198. m_xrBaseSpaceToHeadTm = AZ::Transform::CreateIdentity();
  199. m_xrHeadToLeftEyeTm = AZ::Transform::CreateIdentity();
  200. m_xrHeadToRightEyeTm = AZ::Transform::CreateIdentity();
  201. AZ::RPI::XRSpaceNotificationBus::Handler::BusConnect();
  202. auto atomViewportRequests = AZ::Interface<AZ::RPI::ViewportContextRequestsInterface>::Get();
  203. if (atomViewportRequests)
  204. {
  205. const AZ::EntityId editorEntityId = m_config.GetEditorEntityId();
  206. // Lazily create our camera as part of Activate
  207. // This will be persisted as part of our config so that it may be shared between the Editor & Game components.
  208. // Also, when using the Editor and opening the level for the first time, GetViewForEntity() will return a null ViewPtr.
  209. if (GetView() == nullptr && editorEntityId.IsValid())
  210. {
  211. AZ::RPI::ViewPtr atomEditorView = nullptr;
  212. CameraViewRegistrationRequestsBus::BroadcastResult(atomEditorView, &CameraViewRegistrationRequests::GetViewForEntity, editorEntityId);
  213. m_atomCameraViewGroup->SetView(atomEditorView, AZ::RPI::ViewType::Default);
  214. }
  215. AZStd::string entityName;
  216. AZ::ComponentApplicationBus::BroadcastResult(entityName, &AZ::ComponentApplicationBus::Events::GetEntityName, m_entityId);
  217. AZ::Name cameraName = AZ::Name(AZStd::string::format("%s View", entityName.c_str()));
  218. // If there wasn't already a view registered (or the registration system isn't available), create a View
  219. if (GetView() == nullptr)
  220. {
  221. m_atomCameraViewGroup->CreateMainView(cameraName);
  222. if (editorEntityId.IsValid())
  223. {
  224. CameraViewRegistrationRequestsBus::Broadcast(
  225. &CameraViewRegistrationRequests::SetViewForEntity,
  226. editorEntityId,
  227. GetView());
  228. }
  229. }
  230. m_atomCameraViewGroup->CreateStereoscopicViews(cameraName);
  231. AZ::RPI::ViewProviderBus::Handler::BusConnect(m_entityId);
  232. m_atomCameraViewGroup->Activate();
  233. }
  234. CameraRequestBus::Handler::BusConnect(m_entityId);
  235. AZ::TransformNotificationBus::Handler::BusConnect(m_entityId);
  236. CameraBus::Handler::BusConnect();
  237. CameraNotificationBus::Broadcast(&CameraNotificationBus::Events::OnCameraAdded, m_entityId);
  238. if (m_config.m_renderTextureAsset.GetId().IsValid())
  239. {
  240. CreateRenderPipelineForTexture();
  241. }
  242. // Only activate if we're configured to do so, and our activation call back indicates that we should
  243. if (m_config.m_makeActiveViewOnActivation && (!m_shouldActivateFn || m_shouldActivateFn()))
  244. {
  245. MakeActiveView();
  246. }
  247. }
  248. void CameraComponentController::Deactivate()
  249. {
  250. AZ::RPI::XRSpaceNotificationBus::Handler::BusDisconnect();
  251. if (m_renderToTexturePipeline)
  252. {
  253. auto scene = AZ::RPI::RPISystemInterface::Get()->GetSceneByName(AZ::Name("Main"));
  254. scene->RemoveRenderPipeline(m_renderToTexturePipeline->GetId());
  255. m_renderToTexturePipeline = nullptr;
  256. }
  257. CameraNotificationBus::Broadcast(&CameraNotificationBus::Events::OnCameraRemoved, m_entityId);
  258. CameraBus::Handler::BusDisconnect();
  259. AZ::TransformNotificationBus::Handler::BusDisconnect(m_entityId);
  260. CameraRequestBus::Handler::BusDisconnect(m_entityId);
  261. AZ::RPI::ViewProviderBus::Handler::BusDisconnect(m_entityId);
  262. m_atomCameraViewGroup->Deactivate();
  263. DeactivateAtomView();
  264. }
  265. void CameraComponentController::CreateRenderPipelineForTexture()
  266. {
  267. auto scene = AZ::RPI::RPISystemInterface::Get()->GetSceneByName(AZ::Name("Main"));
  268. const AZStd::string pipelineName = "Camera_" + m_entityId.ToString() + "_Pipeline";
  269. AZ::RPI::RenderPipelineDescriptor pipelineDesc;
  270. pipelineDesc.m_mainViewTagName = "MainCamera";
  271. pipelineDesc.m_name = pipelineName;
  272. pipelineDesc.m_rootPassTemplate = m_config.m_pipelineTemplate;
  273. pipelineDesc.m_renderSettings.m_multisampleState = AZ::RPI::RPISystemInterface::Get()->GetApplicationMultisampleState();
  274. pipelineDesc.m_allowModification = false;
  275. m_renderToTexturePipeline = AZ::RPI::RenderPipeline::CreateRenderPipelineForImage(pipelineDesc, m_config.m_renderTextureAsset);
  276. if (!m_renderToTexturePipeline)
  277. {
  278. AZStd::string entityName;
  279. AZ::ComponentApplicationBus::BroadcastResult(entityName, &AZ::ComponentApplicationRequests::GetEntityName, m_entityId);
  280. AZ_Error("Camera", false, "Failed to create render to texture pipeline for camera component in entity %s", entityName.c_str());
  281. return;
  282. }
  283. scene->AddRenderPipeline(m_renderToTexturePipeline);
  284. m_renderToTexturePipeline->SetDefaultView(GetView());
  285. }
  286. void CameraComponentController::SetConfiguration(const CameraComponentConfig& config)
  287. {
  288. m_config = config;
  289. UpdateCamera();
  290. }
  291. const CameraComponentConfig& CameraComponentController::GetConfiguration() const
  292. {
  293. return m_config;
  294. }
  295. AZ::RPI::ViewportContextPtr CameraComponentController::GetViewportContext()
  296. {
  297. if (auto atomViewportRequests = AZ::Interface<AZ::RPI::ViewportContextRequestsInterface>::Get();
  298. m_atomCameraViewGroup && atomViewportRequests)
  299. {
  300. return atomViewportRequests->GetDefaultViewportContext();
  301. }
  302. return nullptr;
  303. }
  304. AZ::EntityId CameraComponentController::GetCameras()
  305. {
  306. return m_entityId;
  307. }
  308. float CameraComponentController::GetFovDegrees()
  309. {
  310. return m_config.m_fov;
  311. }
  312. float CameraComponentController::GetFovRadians()
  313. {
  314. return AZ::DegToRad(m_config.m_fov);
  315. }
  316. float CameraComponentController::GetNearClipDistance()
  317. {
  318. return m_config.m_nearClipDistance;
  319. }
  320. float CameraComponentController::GetFarClipDistance()
  321. {
  322. return m_config.m_farClipDistance;
  323. }
  324. float CameraComponentController::GetFrustumWidth()
  325. {
  326. return m_config.m_frustumWidth;
  327. }
  328. float CameraComponentController::GetFrustumHeight()
  329. {
  330. return m_config.m_frustumHeight;
  331. }
  332. bool CameraComponentController::IsOrthographic()
  333. {
  334. return m_config.m_orthographic;
  335. }
  336. float CameraComponentController::GetOrthographicHalfWidth()
  337. {
  338. return m_config.m_orthographicHalfWidth;
  339. }
  340. void CameraComponentController::SetFovDegrees(float fov)
  341. {
  342. m_config.m_fov = AZ::GetClamp(fov, MinFoV, MaxFoV);
  343. UpdateCamera();
  344. }
  345. void CameraComponentController::SetFovRadians(float fov)
  346. {
  347. SetFovDegrees(AZ::RadToDeg(fov));
  348. }
  349. void CameraComponentController::SetNearClipDistance(float nearClipDistance)
  350. {
  351. m_config.m_nearClipDistance = AZ::GetMin(nearClipDistance, m_config.m_farClipDistance);
  352. UpdateCamera();
  353. }
  354. void CameraComponentController::SetFarClipDistance(float farClipDistance)
  355. {
  356. m_config.m_farClipDistance = AZ::GetMax(farClipDistance, m_config.m_nearClipDistance);
  357. UpdateCamera();
  358. }
  359. void CameraComponentController::SetFrustumWidth(float width)
  360. {
  361. m_config.m_frustumWidth = width;
  362. UpdateCamera();
  363. }
  364. void CameraComponentController::SetFrustumHeight(float height)
  365. {
  366. m_config.m_frustumHeight = height;
  367. UpdateCamera();
  368. }
  369. void CameraComponentController::SetOrthographic(bool orthographic)
  370. {
  371. m_config.m_orthographic = orthographic;
  372. UpdateCamera();
  373. }
  374. void CameraComponentController::SetOrthographicHalfWidth(float halfWidth)
  375. {
  376. m_config.m_orthographicHalfWidth = halfWidth;
  377. UpdateCamera();
  378. }
  379. void CameraComponentController::SetXRViewQuaternion([[maybe_unused]] const AZ::Quaternion& viewQuat, [[maybe_unused]] uint32_t xrViewIndex)
  380. {
  381. //No implementation needed as we are calling into CR system directly to get view data within OnTransformChanged
  382. }
  383. void CameraComponentController::MakeActiveView()
  384. {
  385. if (IsActiveView())
  386. {
  387. return;
  388. }
  389. // Set Atom camera, if it exists
  390. if (m_atomCameraViewGroup->IsAnyViewEnabled())
  391. {
  392. ActivateAtomView();
  393. }
  394. // Update camera parameters
  395. UpdateCamera();
  396. // Notify of active view changed
  397. CameraNotificationBus::Broadcast(&CameraNotificationBus::Events::OnActiveViewChanged, m_entityId);
  398. }
  399. bool CameraComponentController::IsActiveView()
  400. {
  401. return m_isActiveView;
  402. }
  403. namespace Util
  404. {
  405. AZ::Vector3 GetWorldPosition(const AZ::Vector3& origin, float depth, const AzFramework::CameraState& cameraState)
  406. {
  407. if (depth == 0.f)
  408. {
  409. return origin;
  410. }
  411. else
  412. {
  413. const AZ::Vector3 rayDirection = cameraState.m_orthographic ? cameraState.m_forward : (origin - cameraState.m_position);
  414. return origin + (rayDirection.GetNormalized() * depth);
  415. }
  416. }
  417. }
  418. AZ::Vector3 CameraComponentController::ScreenToWorld(const AZ::Vector2& screenPosition, float depth)
  419. {
  420. const AzFramework::ScreenPoint point{ static_cast<int>(screenPosition.GetX()), static_cast<int>(screenPosition.GetY()) };
  421. const AzFramework::CameraState& cameraState = GetCameraState();
  422. const AZ::Vector3 origin = AzFramework::ScreenToWorld(point, cameraState);
  423. return Util::GetWorldPosition(origin, depth, cameraState);
  424. }
  425. AZ::Vector3 CameraComponentController::ScreenNdcToWorld(const AZ::Vector2& screenNdcPosition, float depth)
  426. {
  427. const AzFramework::CameraState& cameraState = GetCameraState();
  428. const AZ::Vector3 origin = AzFramework::ScreenNdcToWorld(screenNdcPosition, AzFramework::InverseCameraView(cameraState), AzFramework::InverseCameraProjection(cameraState));
  429. return Util::GetWorldPosition(origin, depth, cameraState);
  430. }
  431. AZ::Vector2 CameraComponentController::WorldToScreenNdc(const AZ::Vector3& worldPosition)
  432. {
  433. const AzFramework::CameraState& cameraState = GetCameraState();
  434. const AZ::Vector3 screenPosition = AzFramework::WorldToScreenNdc(worldPosition, AzFramework::CameraView(cameraState), AzFramework::CameraProjection(cameraState));
  435. return AZ::Vector2(screenPosition);
  436. }
  437. AZ::Vector2 CameraComponentController::WorldToScreen(const AZ::Vector3& worldPosition)
  438. {
  439. const AzFramework::ScreenPoint& point = AzFramework::WorldToScreen(worldPosition, GetCameraState());
  440. return AZ::Vector2(static_cast<float>(point.m_x), static_cast<float>(point.m_y));
  441. }
  442. AzFramework::CameraState CameraComponentController::GetCameraState()
  443. {
  444. auto viewportContext = GetViewportContext();
  445. if (!m_atomCameraViewGroup->IsAnyViewEnabled() || !viewportContext)
  446. {
  447. return AzFramework::CameraState();
  448. }
  449. const auto windowSize = viewportContext->GetViewportSize();
  450. const auto viewportSize = AzFramework::ScreenSize(windowSize.m_width, windowSize.m_height);
  451. AzFramework::CameraState cameraState =
  452. AzFramework::CreateDefaultCamera(GetView()->GetCameraTransform(), viewportSize);
  453. AzFramework::SetCameraClippingVolumeFromPerspectiveFovMatrixRH(
  454. cameraState, GetView()->GetViewToClipMatrix());
  455. return cameraState;
  456. }
  457. void CameraComponentController::OnTransformChanged([[maybe_unused]] const AZ::Transform& local, const AZ::Transform& world)
  458. {
  459. if (m_updatingTransformFromEntity)
  460. {
  461. return;
  462. }
  463. m_updatingTransformFromEntity = true;
  464. if (m_xrSystem && m_xrSystem->ShouldRender())
  465. {
  466. // When the XR System is active, The camera world transform will always be:
  467. // camWorldTm = m_xrCameraToBaseSpaceTm * m_xrBaseSpaceToHeadTm.
  468. // But when OnTransformChanged is called, may be because a Lua Script is changing
  469. // the camera location, we need to apply the inverse operation to preserve the value
  470. // of m_xrCameraToBaseSpaceTm.
  471. // This is the quick math:
  472. // m_xrCameraToBaseSpaceTm~ * camWorldTm = m_xrCameraToBaseSpaceTm~ * m_xrCameraToBaseSpaceTm * m_xrBaseSpaceToHeadTm
  473. // m_xrCameraToBaseSpaceTm~ * camWorldTm = m_xrBaseSpaceToHeadTm
  474. // m_xrCameraToBaseSpaceTm~ * camWorldTm * camWorldTm~ = m_xrBaseSpaceToHeadTm * camWorldTm~
  475. // m_xrCameraToBaseSpaceTm~ = m_xrBaseSpaceToHeadTm * camWorldTm~
  476. // m_xrCameraToBaseSpaceTm~~ = (m_xrBaseSpaceToHeadTm * camWorldTm~)~
  477. // m_xrCameraToBaseSpaceTm = camWorldTm~~ * m_xrBaseSpaceToHeadTm~
  478. // m_xrCameraToBaseSpaceTm = camWorldTm * m_xrBaseSpaceToHeadTm~
  479. m_xrCameraToBaseSpaceTm = world * m_xrBaseSpaceToHeadTm.GetInverse();
  480. m_updatingTransformFromEntity = false;
  481. // We are not going to call m_atomCameraViewGroup->SetCameraTransform() yet.
  482. // We need to wait for the OnXRSpaceLocationsChanged() notification, which will give us
  483. // the XR Headset orientation.
  484. return;
  485. }
  486. else
  487. {
  488. m_atomCameraViewGroup->SetCameraTransform(AZ::Matrix3x4::CreateFromTransform(world.GetOrthogonalized()));
  489. }
  490. m_updatingTransformFromEntity = false;
  491. UpdateCamera();
  492. }
  493. void CameraComponentController::OnViewportSizeChanged([[maybe_unused]] AzFramework::WindowSize size)
  494. {
  495. if (IsActiveView())
  496. {
  497. UpdateCamera();
  498. }
  499. }
  500. void CameraComponentController::OnViewportDefaultViewChanged(AZ::RPI::ViewPtr view)
  501. {
  502. m_isActiveView = GetView() == view;
  503. }
  504. AZ::RPI::ViewPtr CameraComponentController::GetView() const
  505. {
  506. return m_atomCameraViewGroup->GetView(AZ::RPI::ViewType::Default);
  507. }
  508. AZ::RPI::ViewPtr CameraComponentController::GetStereoscopicView(AZ::RPI::ViewType viewType) const
  509. {
  510. return m_atomCameraViewGroup->GetView(viewType);
  511. }
  512. void CameraComponentController::UpdateCamera()
  513. {
  514. // O3de assumes a setup for reversed depth
  515. const bool reverseDepth = true;
  516. if (auto viewportContext = GetViewportContext())
  517. {
  518. AZ::Matrix4x4 viewToClipMatrix;
  519. if (!m_atomAuxGeom)
  520. {
  521. SetupAtomAuxGeom(viewportContext);
  522. }
  523. auto windowSize = viewportContext->GetViewportSize();
  524. const float aspectRatio = aznumeric_cast<float>(windowSize.m_width) / aznumeric_cast<float>(windowSize.m_height);
  525. // This assumes a reversed depth buffer, in line with other LY Atom integration
  526. if (m_config.m_orthographic)
  527. {
  528. AZ::MakeOrthographicMatrixRH(viewToClipMatrix,
  529. -m_config.m_orthographicHalfWidth,
  530. m_config.m_orthographicHalfWidth,
  531. -m_config.m_orthographicHalfWidth / aspectRatio,
  532. m_config.m_orthographicHalfWidth / aspectRatio,
  533. m_config.m_nearClipDistance,
  534. m_config.m_farClipDistance,
  535. reverseDepth);
  536. }
  537. else
  538. {
  539. AZ::MakePerspectiveFovMatrixRH(viewToClipMatrix,
  540. AZ::DegToRad(m_config.m_fov),
  541. aspectRatio,
  542. m_config.m_nearClipDistance,
  543. m_config.m_farClipDistance,
  544. reverseDepth);
  545. }
  546. m_updatingTransformFromEntity = true;
  547. m_atomCameraViewGroup->SetViewToClipMatrix(viewToClipMatrix);
  548. // Update stereoscopic projection matrix
  549. if (m_xrSystem && m_xrSystem->ShouldRender())
  550. {
  551. AZ::Matrix4x4 projection = AZ::Matrix4x4::CreateIdentity();
  552. for (AZ::u32 i = 0; i < m_numSterescopicViews; i++)
  553. {
  554. AZ::RPI::ViewType viewType = i == 0 ? AZ::RPI::ViewType::XrLeft : AZ::RPI::ViewType::XrRight;
  555. AZ::RPI::FovData fovData;
  556. m_xrSystem->GetViewFov(i, fovData);
  557. if ( (fovData.m_angleLeft != 0 || fovData.m_angleRight != 0) && (fovData.m_angleUp != 0 || fovData.m_angleDown != 0))
  558. {
  559. projection = m_xrSystem->CreateStereoscopicProjection(
  560. fovData.m_angleLeft,
  561. fovData.m_angleRight,
  562. fovData.m_angleDown,
  563. fovData.m_angleUp,
  564. m_config.m_nearClipDistance,
  565. m_config.m_farClipDistance,
  566. reverseDepth);
  567. m_atomCameraViewGroup->SetStereoscopicViewToClipMatrix(projection, reverseDepth, viewType);
  568. }
  569. }
  570. }
  571. m_updatingTransformFromEntity = false;
  572. }
  573. }
  574. void CameraComponentController::SetupAtomAuxGeom(AZ::RPI::ViewportContextPtr viewportContext)
  575. {
  576. if (auto scene = viewportContext->GetRenderScene())
  577. {
  578. if (auto auxGeomFP = scene->GetFeatureProcessor<AZ::RPI::AuxGeomFeatureProcessorInterface>())
  579. {
  580. m_atomAuxGeom = auxGeomFP->GetOrCreateDrawQueueForView(GetView().get());
  581. }
  582. }
  583. }
  584. ////////////////////////////////////////////////////////////////////
  585. // AZ::RPI::XRSpaceNotificationBus::Handler Overrides
  586. void CameraComponentController::OnXRSpaceLocationsChanged(
  587. const AZ::Transform& baseSpaceToHeadTm,
  588. const AZ::Transform& headToleftEyeTm,
  589. const AZ::Transform& headToRightEyeTm)
  590. {
  591. if (!m_xrSystem || !m_xrSystem->ShouldRender())
  592. {
  593. return;
  594. }
  595. m_updatingTransformFromEntity = true;
  596. m_xrBaseSpaceToHeadTm = baseSpaceToHeadTm;
  597. const auto mainCameraWorldTm = m_xrCameraToBaseSpaceTm * baseSpaceToHeadTm;
  598. AZ::TransformBus::Event(m_entityId, &AZ::TransformBus::Handler::SetWorldTM, mainCameraWorldTm);
  599. // Update camera world matrix for the main pipeline.
  600. m_atomCameraViewGroup->SetCameraTransform(AZ::Matrix3x4::CreateFromTransform(mainCameraWorldTm));
  601. // Update camera world matrix for the left eye pipeline.
  602. m_xrHeadToLeftEyeTm = headToleftEyeTm;
  603. const auto leftEyeWorldTm = mainCameraWorldTm * headToleftEyeTm;
  604. m_atomCameraViewGroup->SetCameraTransform(AZ::Matrix3x4::CreateFromTransform(leftEyeWorldTm), AZ::RPI::ViewType::XrLeft);
  605. // Update camera world matrix for the right eye pipeline.
  606. m_xrHeadToRightEyeTm = headToRightEyeTm;
  607. const auto rightEyeWorldTm = mainCameraWorldTm * headToRightEyeTm;
  608. m_atomCameraViewGroup->SetCameraTransform(AZ::Matrix3x4::CreateFromTransform(rightEyeWorldTm), AZ::RPI::ViewType::XrRight);
  609. UpdateCamera();
  610. m_updatingTransformFromEntity = false;
  611. }
  612. ////////////////////////////////////////////////////////////////////
  613. } //namespace Camera