1. Epic GamesDeveloper
  3. UGameplayCameraComponent

UGameplayCameraComponent

A component that can run a camera asset inside its own camera evaluation context.

API > API/Plugins > API/Plugins/GameplayCameras > API/Plugins/GameplayCameras/GameFramework

Inheritance Hierarchy

  • USceneComponent
  • UGameplayCameraComponent

References

   
Module GameplayCameras
Header /Engine/Plugins/Cameras/GameplayCameras/Source/GameplayCameras/Public/GameFramework/GameplayCameraComponent.h
Include #include "GameFramework/GameplayCameraComponent.h"

Syntax

UCLASS (Blueprintable, MinimalAPI, ClassGroup=Camera, HideCategories=(Mobility, Rendering, LOD),  
       Meta=(BlueprintSpawnableComponent))  
class UGameplayCameraComponent : public USceneComponent

Remarks

A component that can run a camera asset inside its own camera evaluation context.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite TEnumAsByte< EAutoReceiveInput::Type > AutoActivateForPlayer If AutoActivate is set, auto-activates this component's camera for the given player.
Protected variable bool bIsCameraCutNextFrame  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< UCameraAsset > Camera The camera asset to run.
Protected variable UProperty TObjectPtr< UGameplayCameraSystemHost > CameraSystemHost  
Protected variable TSharedPtr< FGameplayCameraComponentEvaluationContext > EvaluationContext  
Protected variable UProperty Transient TObjectPtr< UStaticMesh > PreviewMesh  
Protected variable UProperty Transient TObjectPtr< UStaticMeshComponent > PreviewMeshComponent  

Constructors

  Type Name Description
Public function  

UGameplayCameraComponent ( const FObjectInitializer& ObjectInit
)

 Create a new camera component.

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

ActivateCameraForPlayerController ( APlayerController* PlayerController
)

 Activates the camera for the given player.
Public function UFunction BlueprintCallable, Category void Activates the camera for the given player.
Public function Virtual void  
Public function UFunction BlueprintCallable, Category void Deactivates the camera for the last player it was activated for.
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

  
Public function Virtual bool

GetEditorPreviewInfo ( float DeltaTime,
FMinimalViewInfo& ViewOut
)

  
Public function TSharedPtr< UE::Cameras::FCameraEvaluationContext > Get the camera evaluation context used by this component.
Public function Const UFunction BlueprintPure, Category FBlueprintCameraPose Gets the initial camera pose for this component's camera evaluation context.
Public function Const UFunction BlueprintPure, Category FBlueprintCameraVariableTable Gets the initial camera variable table for this component's camera evaluation context.
Public function Const APlayerController * Get the player controller this component is currently activated for (if any).
Public function Virtual void

OnComponentDestroyed ( bool bDestroyingHierarchy
)

  
Public function Virtual void  
Public function Virtual void

OnUpdateTransform ( EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

  
Public function UFunction BlueprintCallable, Category void

SetInitialPose ( const FBlueprintCameraPose& CameraPose
)

 Sets the initial camera pose for this component's camera evaluation context.
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

  

Typedefs

Name Description
FGameplayCameraComponentEvaluationContext  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page