Navigation
API > API/Plugins > API/Plugins/ColorGradingEditor
A data model that stores the color grading properties from a UObject, which allows UObjects with widely varying color grading interfaces to be used with the color grading panel.
| Name | FColorGradingEditorDataModel |
| Type | class |
| Header File | /Engine/Plugins/Editor/ColorGrading/Source/ColorGradingEditor/Public/ColorGradingEditorDataModel.h |
| Include Path | #include "ColorGradingEditorDataModel.h" |
Syntax
class FColorGradingEditorDataModel : public TSharedFromThis< FColorGradingEditorDataModel >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FColorGradingEditorDataModel
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FColorGradingEditorDataModel() |
ColorGradingEditorDataModel.h |
Structs
| Name | Remarks |
|---|---|
| FColorGradingElement | Stores the property handles for the color properties for a single color grading element (Shadows, Midtones, etc.) |
| FColorGradingGroup | Stores a list of color grading elements that form a single color grading group |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnColorGradingGroupDeleted | TMulticastDelegate_OneParam< void, int32 > | ColorGradingEditorDataModel.h | |
| FOnColorGradingGroupRenamed | TMulticastDelegate_TwoParams< void, int32, const FText & > | ColorGradingEditorDataModel.h | |
| FOnColorGradingSelectionChanged | TMulticastDelegate_NoParams< void > | ColorGradingEditorDataModel.h | |
| FOnDataModelGenerated | TMulticastDelegate_NoParams< void > | ColorGradingEditorDataModel.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| RegisteredDataModelGenerators | TMap< TWeakObjectPtr< UClass >, FGetDetailsDataModelGenerator > | A list of data model generators, indexed by class name, that have been registered | ColorGradingEditorDataModel.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bShowColorGradingGroupToolBar | bool | Indicates whether the color grading groups should be visible/selectable in a toolbar | ColorGradingEditorDataModel.h | |
| ColorGradingGroups | TArray< FColorGradingGroup > | A list of color grading groups in the color grading data model | ColorGradingEditorDataModel.h | |
| ColorGradingGroupToolBarWidget | TSharedPtr< SWidget > | An optional widget to append to the end of the color grading group toolbar | ColorGradingEditorDataModel.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| DataModelGeneratorInstances | TMap< TWeakObjectPtr< UClass >, TSharedPtr< IColorGradingEditorDataModelGenerator > > | A list of data model generators that have been created to generate the data model for the current objects | ColorGradingEditorDataModel.h | |
| OnColorGradingElementSelectionChangedDelegate | FOnColorGradingSelectionChanged | Delegate that is raised when the selected color grading element has been changed | ColorGradingEditorDataModel.h | |
| OnColorGradingGroupDeletedDelegate | FOnColorGradingGroupDeleted | Delegate that is raised when a color grading group is being deleted | ColorGradingEditorDataModel.h | |
| OnColorGradingGroupRenamedDelegate | FOnColorGradingGroupRenamed | Delegate that is raised when a color grading group is being renamed | ColorGradingEditorDataModel.h | |
| OnColorGradingGroupSelectionChangedDelegate | FOnColorGradingSelectionChanged | Delegate that is raised when the selected color grading group has been changed | ColorGradingEditorDataModel.h | |
| OnDataModelGeneratedDelegate | FOnDataModelGenerated | Delegate that is raised when the data model has been generated | ColorGradingEditorDataModel.h | |
| PropertyRowGenerator | TSharedPtr< IPropertyRowGenerator > | The property row generator which manages the property handles of the color grading objects | ColorGradingEditorDataModel.h | |
| SelectedColorGradingElementIndex | int32 | The currently selected color grading element | ColorGradingEditorDataModel.h | |
| SelectedColorGradingGroupIndex | int32 | The currently selected color grading element | ColorGradingEditorDataModel.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TArray< TWeakObjectPtr< UObject > > GetObjects() |
Gets the list of objects from which the color grading properties were generated from | ColorGradingEditorDataModel.h | |
void GetPanelState
(
FColorGradingPanelState& OutPanelState |
Adds the state of the data model to the specified drawer state | ColorGradingEditorDataModel.h | |
TSharedRef< IPropertyRowGenerator > GetPropertyRowGenerator() |
Gets the property row generator that was used to generate this data model | ColorGradingEditorDataModel.h | |
FColorGradingElement * GetSelectedColorGradingElement() |
Gets a pointer to the selected color grading element, or null if there isn't a valid selection | ColorGradingEditorDataModel.h | |
int32 GetSelectedColorGradingElementIndex() |
Gets the index of the selected color grading element | ColorGradingEditorDataModel.h | |
FColorGradingGroup * GetSelectedColorGradingGroup() |
Gets a pointer to the selected color grading group, or null if there isn't a valid selection | ColorGradingEditorDataModel.h | |
int32 GetSelectedColorGradingGroupIndex() |
Gets the index of the selected color grading group | ColorGradingEditorDataModel.h | |
bool HasObjectOfType
(
const UClass* InClass |
Gets whether the data model has objects of the specified class | ColorGradingEditorDataModel.h | |
FOnColorGradingSelectionChanged & OnColorGradingElementSelectionChanged() |
Gets the delegate that is raised when the selected color grading element has changed | ColorGradingEditorDataModel.h | |
FOnColorGradingGroupDeleted & OnColorGradingGroupDeleted() |
Gets the delegate that is raised when a color grading group is deleted by the user | ColorGradingEditorDataModel.h | |
FOnColorGradingGroupRenamed & OnColorGradingGroupRenamed() |
Gets the delegate that is raised when a color grading group is renamed by the user | ColorGradingEditorDataModel.h | |
FOnColorGradingSelectionChanged & OnColorGradingGroupSelectionChanged() |
Gets the delegate that is raised when the selected color grading group has changed | ColorGradingEditorDataModel.h | |
FOnDataModelGenerated & OnDataModelGenerated() |
Gets the delegate that is raised when the data model is generated | ColorGradingEditorDataModel.h | |
void Reset() |
Resets the data model to be empty | ColorGradingEditorDataModel.h | |
| Sets the objects from which the color grading properties will be generated from | ColorGradingEditorDataModel.h | ||
void SetPanelState
(
const FColorGradingPanelState& InPanelState |
Sets the state of the data model from the specified drawer state | ColorGradingEditorDataModel.h | |
void SetSelectedColorGradingElement
(
int32 InColorGradingElementIndex |
Sets the selected color grading element | ColorGradingEditorDataModel.h | |
void SetSelectedColorGradingGroup
(
int32 InColorGradingGroupIndex |
Sets the selected color grading group | ColorGradingEditorDataModel.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void RegisterColorGradingDataModelGenerator
(
FGetDetailsDataModelGenerator CreateGeneratorDelegate |
Registers a new data model generator used to populate a color grading data model for the specified class | ColorGradingEditorDataModel.h |