Navigation
API > API/Plugins > API/Plugins/GameplayCameras
A base class for a camera object that has a graph of camera nodes, connections between them, and some exposed parameters.
| Name | UBaseCameraObject |
| Type | class |
| Header File | /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/Core/BaseCameraObject.h |
| Include Path | #include "Core/BaseCameraObject.h" |
Syntax
UCLASS (Abstract, MinimalAPI)
class UBaseCameraObject : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UBaseCameraObject
Derived Classes
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AllocationInfo | FCameraObjectAllocationInfo | Allocation information for all the nodes and variables in this camera object. | Core/BaseCameraObject.h | |
| Connections | FCameraObjectConnections | Core/BaseCameraObject.h | ||
| EventHandlers | UE::Cameras::TCameraEventHandlerContainer< UE::Cameras::ICameraObjectEventHandler > | Event handlers to be notified of data changes. | Core/BaseCameraObject.h | |
| Interface | FCameraObjectInterface | The public data interface of this camera object. | Core/BaseCameraObject.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDefaultParametersMayHaveMissingPropertyFlags | bool | Flag for DefaultParameters maybe having missing property flags. | Core/BaseCameraObject.h | |
| DefaultParameters | FInstancedPropertyBag | The default interface parameter values, generated during build. | Core/BaseCameraObject.h | |
| Guid | FGuid | The camera object's unique ID. | Core/BaseCameraObject.h | |
| ParameterDefinitions | TArray< FCameraObjectInterfaceParameterDefinition > | The definitions of parameters exposed on this camera rig. | Core/BaseCameraObject.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool FindParameterDefinitionByGuid
(
const FGuid& ParameterGuid, |
Finds a parameter definition by ID. | Core/BaseCameraObject.h | |
bool FindParameterDefinitionByName
(
const FName ParameterName, |
Finds a parameter definition by name. | Core/BaseCameraObject.h | |
const FInstancedPropertyBag & GetDefaultParameters () |
Gets the default values for the parameters exposed on this camera rig. | Core/BaseCameraObject.h | |
| Gets the default values for the parameters exposed on this camera rig. | Core/BaseCameraObject.h | ||
const FGuid & GetGuid() |
Gets the object's unique ID. | Core/BaseCameraObject.h | |
TConstArrayView< FCameraObjectInterfaceParameterDefinition > GetParameterDefinitions() |
Gets the definitions of parameters exposed on this camera rig. | Core/BaseCameraObject.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual UCameraNode * GetRootNode() |
Get the root node of this camera object. | Core/BaseCameraObject.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostDuplicate
(
EDuplicateMode::Type DuplicateMode |
Core/BaseCameraObject.h | ||
virtual void PostInitProperties() |
Core/BaseCameraObject.h | ||
virtual void PostLoad() |
Core/BaseCameraObject.h | ||
virtual void Serialize
(
FArchive& Ar |
Core/BaseCameraObject.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void UpgradeInterfaceConnections
(
IObjectTreeGraphRootObject* RootObject, |
Utility method to be called on PostLoad by subclasses that need upgrading old data. | Core/BaseCameraObject.h |