Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Camera::EditorCameraViewRequests Class Referenceabstract

#include <EditorCameraBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void ToggleCameraAsActiveView ()=0
 
virtual void MatchViewport ()=0
 
virtual bool IsActiveCamera () const =0
 
virtual bool GetCameraState (AzFramework::CameraState &cameraState)=0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 

Detailed Description

This bus is for requesting any camera-view-related changes or information

Member Function Documentation

◆ GetCameraState()

virtual bool Camera::EditorCameraViewRequests::GetCameraState ( AzFramework::CameraState &  cameraState)
pure virtual

Gets the camera state associated with this view.

◆ IsActiveCamera()

virtual bool Camera::EditorCameraViewRequests::IsActiveCamera ( ) const
pure virtual

Returns true if this is the active camera.

◆ MatchViewport()

virtual void Camera::EditorCameraViewRequests::MatchViewport ( )
pure virtual

Aligns this camera with the active view in the scene and sets it as the active camera

◆ ToggleCameraAsActiveView()

virtual void Camera::EditorCameraViewRequests::ToggleCameraAsActiveView ( )
pure virtual

Sets this camera as the active view in the scene, otherwise restores the default editor camera if it was already active


The documentation for this class was generated from the following file: