1. Epic GamesDeveloper
  3. IGameplayCamerasEditorModule

IGameplayCamerasEditorModule

The gameplay cameras editor module.

API > API/Plugins > API/Plugins/GameplayCamerasEditor

Inheritance Hierarchy

References

   
Module GameplayCamerasEditor
Header /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCamerasEditor/Public/IGameplayCamerasEditorModule.h
Include #include "IGameplayCamerasEditorModule.h"

Syntax

class IGameplayCamerasEditorModule : public IModuleInterface

Remarks

The gameplay cameras editor module.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function UCameraAssetEditor *

CreateCameraAssetEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
UCameraAsset* CameraAsset
)

 Creates an editor for the given camera asset
Public function UCameraRigAssetEditor *

CreateCameraRigEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
UCameraRigAsset* CameraRig
)

 Creates an editor for the given camera rig asset
Public function TSharedRef< SWidget >

CreateCameraRigPicker ( const FCameraRigPickerConfig& InPickerConfig
)

 Creates a new camera rig asset picker widget
Public function UCameraRigProxyAssetEditor *

CreateCameraRigProxyEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
UCameraRigProxyAsset* CameraRigProxy
)

 Creates an editor for the given camera rig proxy asset
Public function UCameraVariableCollectionEditor *

CreateCameraVariableCollectionEditor ( const EToolkitMode::Type Mode,
const TSharedPtr< IToolkitHost >& InitToolkitHost,
UCameraVariableCollection* VariableCollection
)

 Creates an editor for the given variable collection
Public function TSharedRef< SWidget > Creates a new camera varable asset picker widget
Public function TSharedPtr< SWidget >

CreateDebugCategoryPanel ( const FString& InCategoryName
)

 Creates the custom UI panel (if any) for a given debug category.
Public function Static IGameplayCamerasEditorModule &

Get ()

  
Public function Const TArrayView< const FOnBuildCameraAsset > Gets the registered custom camera asset builders.
Public function Const TArrayView< const FOnCreateCameraDirectorAssetEditorMode > Gets the registered camera director editor creators.
Public function Const TArrayView< const FOnBuildCameraRigAsset > Gets the registered custom camera rig builders.
Public function void Gets all registered debug categories.
Public function FDelegateHandle Registers a custom camera asset builder.
Public function FDelegateHandle Registers a new camera director editor creator.
Public function FDelegateHandle Registers a custom camera rig builder.
Public function void Registers a new debug category, to be displayed in the camera debugger tool.
Public function void

RegisterDebugCategoryPanel ( const FString& InCategoryName,
FOnCreateDebugCategoryPanel OnCreatePanel
)

 Registers a custom UI panel for a given debug category.
Public function void Unregisters a custom camera asset builder.
Public function void Unregisters a camera director editor creator.
Public function void Unregisters a custom camera rig builder.
Public function void

UnregisterDebugCategory ( const FString& InCategoryName
)

 Unregisters a debug category.
Public function void

UnregisterDebugCategoryPanel ( const FString& InCategoryName
)

 Unregisters a debug category's custom UI panel.

Typedefs

Name Description
FCameraDebugCategoryInfo  
FCameraRigPickerConfig  
FCameraVariablePickerConfig  

Constants

Name Description
CameraRigAssetEditorToolBarName  
GameplayCamerasEditorAppIdentifier  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page