Navigation
API > API/Plugins > API/Plugins/GameplayCamerasEditor
The gameplay cameras editor module.
| Name | IGameplayCamerasEditorModule |
| Type | class |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCamerasEditor/Public/IGameplayCamerasEditorModule.h |
| Include Path | #include "IGameplayCamerasEditorModule.h" |
Syntax
class IGameplayCamerasEditorModule : public IModuleInterface
Implements Interfaces
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IGameplayCamerasEditorModule() |
IGameplayCamerasEditorModule.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FCameraDebugCategoryInfo | UE::Cameras::FCameraDebugCategoryInfo | IGameplayCamerasEditorModule.h | |
| FCameraVariablePickerConfig | UE::Cameras::FCameraVariablePickerConfig | IGameplayCamerasEditorModule.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| CameraRigAssetEditorToolBarName | const FName | IGameplayCamerasEditorModule.h | |
| GameplayCamerasEditorAppIdentifier | const FName | IGameplayCamerasEditorModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCameraAssetEditor * CreateCameraAssetEditor
(
const EToolkitMode::Type Mode, |
Creates an editor for the given camera asset | IGameplayCamerasEditorModule.h | |
UCameraRigAssetEditor * CreateCameraRigEditor
(
const EToolkitMode::Type Mode, |
Creates an editor for the given camera rig asset | IGameplayCamerasEditorModule.h | |
UCameraRigProxyAssetEditor * CreateCameraRigProxyEditor
(
const EToolkitMode::Type Mode, |
Creates an editor for the given camera rig proxy asset | IGameplayCamerasEditorModule.h | |
UCameraShakeAssetEditor * CreateCameraShakeEditor
(
const EToolkitMode::Type Mode, |
Creates an editor for the given camera shake asset | IGameplayCamerasEditorModule.h | |
UCameraVariableCollectionEditor * CreateCameraVariableCollectionEditor
(
const EToolkitMode::Type Mode, |
Creates an editor for the given variable collection | IGameplayCamerasEditorModule.h | |
TSharedRef< SWidget > CreateCameraVariablePicker
(
const FCameraVariablePickerConfig& InPickerConfig |
Creates a new camera varable asset picker widget | IGameplayCamerasEditorModule.h | |
TSharedPtr< SWidget > CreateDebugCategoryPanel
(
const FString& InCategoryName |
Creates the custom UI panel (if any) for a given debug category. | IGameplayCamerasEditorModule.h | |
TArrayView< const FOnCreateCameraDirectorAssetEditorMode > GetCameraDirectorEditorCreators() |
Gets the registered camera director editor creators. | IGameplayCamerasEditorModule.h | |
void GetRegisteredDebugCategories
(
TArray< UE::Cameras::FCameraDebugCategoryInfo >& OutCategoryInfos |
Gets all registered debug categories. | IGameplayCamerasEditorModule.h | |
FDelegateHandle RegisterCameraDirectorEditor
(
FOnCreateCameraDirectorAssetEditorMode InOnCreateEditor |
Registers a new camera director editor creator. | IGameplayCamerasEditorModule.h | |
void RegisterDebugCategory
(
const UE::Cameras::FCameraDebugCategoryInfo& InCategoryInfo |
Registers a new debug category, to be displayed in the camera debugger tool. | IGameplayCamerasEditorModule.h | |
void RegisterDebugCategoryPanel
(
const FString& InCategoryName, |
Registers a custom UI panel for a given debug category. | IGameplayCamerasEditorModule.h | |
void UnregisterCameraDirectorEditor
(
FDelegateHandle InHandle |
Unregisters a camera director editor creator. | IGameplayCamerasEditorModule.h | |
void UnregisterDebugCategory
(
const FString& InCategoryName |
Unregisters a debug category. | IGameplayCamerasEditorModule.h | |
void UnregisterDebugCategoryPanel
(
const FString& InCategoryName |
Unregisters a debug category's custom UI panel. | IGameplayCamerasEditorModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IGameplayCamerasEditorModule & Get() |
IGameplayCamerasEditorModule.h |