Show / Hide Table of Contents

Class CineCameraComponent

A specialized version of a camera component, geared toward cinematic usage.

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
CameraComponent
CineCameraComponent
Inherited Members
CameraComponent.AddOrUpdateBlendable(Byte, Single)
CameraComponent.GetCameraView(Single)
CameraComponent.RemoveBlendable(Byte)
CameraComponent.SetAspectRatio(Single)
CameraComponent.SetConstraintAspectRatio(Boolean)
CameraComponent.SetFieldOfView(Single)
CameraComponent.SetOrthoFarClipPlane(Single)
CameraComponent.SetOrthoNearClipPlane(Single)
CameraComponent.SetOrthoWidth(Single)
CameraComponent.SetPostProcessBlendWeight(Single)
CameraComponent.SetProjectionMode(Byte)
CameraComponent.SetUseFieldOfViewForLOD(Boolean)
CameraComponent.FieldOfView
CameraComponent.OrthoWidth
CameraComponent.OrthoNearClipPlane
CameraComponent.OrthoFarClipPlane
CameraComponent.AspectRatio
CameraComponent.bConstrainAspectRatio
CameraComponent.bUseFieldOfViewForLOD
CameraComponent.bLockToHmd
CameraComponent.bUsePawnControlRotation
CameraComponent.ProjectionMode
CameraComponent.CameraMesh
CameraComponent.PostProcessBlendWeight
CameraComponent.PostProcessSettings
SceneComponent.DetachFromParent(Boolean, Boolean)
SceneComponent.DoesSocketExist(Name)
SceneComponent.GetAllSocketNames()
SceneComponent.GetAttachParent()
SceneComponent.GetAttachSocketName()
SceneComponent.GetChildComponent(Int32)
SceneComponent.GetChildrenComponents(Boolean)
SceneComponent.GetComponentVelocity()
SceneComponent.GetForwardVector()
SceneComponent.GetNumChildrenComponents()
SceneComponent.GetParentComponents()
SceneComponent.GetPhysicsVolume()
SceneComponent.GetRelativeTransform()
SceneComponent.GetRightVector()
SceneComponent.GetShouldUpdatePhysicsVolume()
SceneComponent.GetSocketLocation(Name)
SceneComponent.GetSocketQuaternion(Name)
SceneComponent.GetSocketRotation(Name)
SceneComponent.GetSocketTransform(Name, Byte)
SceneComponent.GetUpVector()
SceneComponent.IsAnySimulatingPhysics()
SceneComponent.IsSimulatingPhysics(Name)
SceneComponent.IsVisible()
SceneComponent.K2_AddLocalOffset(Vector, Boolean, Boolean)
SceneComponent.K2_AddLocalRotation(Rotator, Boolean, Boolean)
SceneComponent.K2_AddLocalTransform(Transform, Boolean, Boolean)
SceneComponent.K2_AddRelativeLocation(Vector, Boolean, Boolean)
SceneComponent.K2_AddRelativeRotation(Rotator, Boolean, Boolean)
SceneComponent.K2_AddWorldOffset(Vector, Boolean, Boolean)
SceneComponent.K2_AddWorldRotation(Rotator, Boolean, Boolean)
SceneComponent.K2_AddWorldTransform(Transform, Boolean, Boolean)
SceneComponent.K2_AttachTo(SceneComponent, Name, Byte, Boolean)
SceneComponent.K2_AttachToComponent(SceneComponent, Name, EAttachmentRule, EAttachmentRule, EAttachmentRule, Boolean)
SceneComponent.K2_DetachFromComponent(EDetachmentRule, EDetachmentRule, EDetachmentRule, Boolean)
SceneComponent.K2_GetComponentLocation()
SceneComponent.K2_GetComponentRotation()
SceneComponent.K2_GetComponentScale()
SceneComponent.K2_GetComponentToWorld()
SceneComponent.K2_SetRelativeLocation(Vector, Boolean, Boolean)
SceneComponent.K2_SetRelativeLocationAndRotation(Vector, Rotator, Boolean, Boolean)
SceneComponent.K2_SetRelativeRotation(Rotator, Boolean, Boolean)
SceneComponent.K2_SetRelativeTransform(Transform, Boolean, Boolean)
SceneComponent.K2_SetWorldLocation(Vector, Boolean, Boolean)
SceneComponent.K2_SetWorldLocationAndRotation(Vector, Rotator, Boolean, Boolean)
SceneComponent.K2_SetWorldRotation(Rotator, Boolean, Boolean)
SceneComponent.K2_SetWorldTransform(Transform, Boolean, Boolean)
SceneComponent.ResetRelativeTransform()
SceneComponent.SetAbsolute(Boolean, Boolean, Boolean)
SceneComponent.SetHiddenInGame(Boolean, Boolean)
SceneComponent.SetMobility(Byte)
SceneComponent.SetRelativeScale3D(Vector)
SceneComponent.SetShouldUpdatePhysicsVolume(Boolean)
SceneComponent.SetVisibility(Boolean, Boolean)
SceneComponent.SetWorldScale3D(Vector)
SceneComponent.SnapTo(SceneComponent, Name)
SceneComponent.ToggleVisibility(Boolean)
SceneComponent.AttachParent
SceneComponent.AttachSocketName
SceneComponent.AttachChildren
SceneComponent.ClientAttachedChildren
SceneComponent.RelativeLocation
SceneComponent.RelativeRotation
SceneComponent.RelativeScale3D
SceneComponent.ComponentVelocity
SceneComponent.bComponentToWorldUpdated
SceneComponent.bAbsoluteLocation
SceneComponent.bAbsoluteRotation
SceneComponent.bAbsoluteScale
SceneComponent.bVisible
SceneComponent.bHiddenInGame
SceneComponent.bShouldUpdatePhysicsVolume
SceneComponent.bBoundsChangeTriggersStreamingDataRebuild
SceneComponent.bUseAttachParentBound
SceneComponent.bVisualizeComponent
SceneComponent.Mobility
SceneComponent.DetailMode
ActorComponent.RegisterComponent()
ActorComponent.UnregisterComponent()
ActorComponent.ReceiveBeginPlay
ActorComponent.ReceiveEndPlay
ActorComponent.ReceiveTick
ActorComponent.Activate(Boolean)
ActorComponent.AddTickPrerequisiteActor(Actor)
ActorComponent.AddTickPrerequisiteComponent(ActorComponent)
ActorComponent.ComponentHasTag(Name)
ActorComponent.Deactivate()
ActorComponent.GetComponentTickInterval()
ActorComponent.GetOwner()
ActorComponent.IsActive()
ActorComponent.IsBeingDestroyed()
ActorComponent.IsComponentTickEnabled()
ActorComponent.K2_DestroyComponent(UObject)
ActorComponent.RemoveTickPrerequisiteActor(Actor)
ActorComponent.RemoveTickPrerequisiteComponent(ActorComponent)
ActorComponent.SetActive(Boolean, Boolean)
ActorComponent.SetAutoActivate(Boolean)
ActorComponent.SetComponentTickEnabled(Boolean)
ActorComponent.SetComponentTickInterval(Single)
ActorComponent.SetIsReplicated(Boolean)
ActorComponent.SetTickableWhenPaused(Boolean)
ActorComponent.SetTickGroup(Byte)
ActorComponent.ToggleActive()
ActorComponent.PrimaryComponentTick
ActorComponent.AssetUserData
ActorComponent.bReplicates
ActorComponent.bNetAddressable
ActorComponent.bAutoActivate
ActorComponent.bIsActive
ActorComponent.bEditableWhenInherited
ActorComponent.bCanEverAffectNavigation
ActorComponent.bIsEditorOnly
ActorComponent.bIsVisualizationComponent
UObject.TransientPackage
UObject.CastTo<T>(UObject)
UObject.CastTo(UObject, Type)
UObject.RemoveObject(UObject)
UObject.MakeObjectArrayField<T>(NativeArray*)
UObject.NotImplemented<T>()
UObject.Construct()
UObject.GetHashCode()
UObject.GetName()
UObject.ToString()
UObject.Name
UObject._None
UObject.None
UObject.ObjPointer
UObject.LoadObjectFromClass(Class, UObject, String, String, LoadFlags, PackageMap, Boolean)
UObject.LoadClass(Class, UObject, String, String, LoadFlags, PackageMap)
UObject.GetPropertyFor<T>(Name)
UObject.ExecuteUbergraph
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.CinematicCamera
Assembly: UE4DotNet.dll
Syntax
public class CineCameraComponent : CameraComponent

Properties

| Improve this Doc View Source

CurrentAperture

Current aperture, in terms of f-stop (e.g. 2.8 for f/2.8)

Declaration
public float CurrentAperture { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

CurrentFocalLength

Current focal length of the camera (i.e. controls FoV, zoom)

Declaration
public float CurrentFocalLength { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

CurrentFocusDistance

Read-only. Control this value via FocusSettings.

Declaration
public float CurrentFocusDistance { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

CurrentHorizontalFOV

Read-only. Control this value with CurrentFocalLength (and filmback settings).

Declaration
public float CurrentHorizontalFOV { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DebugFocusPlaneComponent

Component for the debug focus plane visualization

Declaration
public StaticMeshComponent DebugFocusPlaneComponent { get; set; }
Property Value
Type Description
StaticMeshComponent
| Improve this Doc View Source

DebugFocusPlaneMID

Dynamic material instance for the debug focus plane visualization

Declaration
public MaterialInstanceDynamic DebugFocusPlaneMID { get; set; }
Property Value
Type Description
MaterialInstanceDynamic
| Improve this Doc View Source

DefaultLensFocalLength

Default focal length (will be constrained by default lens)

Declaration
public float DefaultLensFocalLength { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DefaultLensFStop

Default aperture (will be constrained by default lens)

Declaration
public float DefaultLensFStop { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static CineCameraComponent DefaultObject { get; }
Property Value
Type Description
CineCameraComponent
| Improve this Doc View Source

FilmbackSettings

Controls the filmback of the camera.

Declaration
public CameraFilmbackSettings FilmbackSettings { get; set; }
Property Value
Type Description
CameraFilmbackSettings
| Improve this Doc View Source

FocusPlaneVisualizationMaterial

Material used for debug focus plane visualization

Declaration
public Material FocusPlaneVisualizationMaterial { get; set; }
Property Value
Type Description
Material
| Improve this Doc View Source

FocusPlaneVisualizationMesh

Mesh used for debug focus plane visualization

Declaration
public StaticMesh FocusPlaneVisualizationMesh { get; set; }
Property Value
Type Description
StaticMesh
| Improve this Doc View Source

FocusSettings

Controls the camera's focus.

Declaration
public CameraFocusSettings FocusSettings { get; set; }
Property Value
Type Description
CameraFocusSettings
| Improve this Doc View Source

LensSettings

Controls the camera's lens.

Declaration
public CameraLensSettings LensSettings { get; set; }
Property Value
Type Description
CameraLensSettings
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

GetFilmbackPresetName()

Returns the filmback name of the camera with the current settings.

Declaration
public string GetFilmbackPresetName()
Returns
Type Description
System.String
| Improve this Doc View Source

GetHorizontalFieldOfView()

Returns the horizonal FOV of the camera with current settings.

Declaration
public float GetHorizontalFieldOfView()
Returns
Type Description
System.Single
| Improve this Doc View Source

GetLensPresetName()

Returns the lens name of the camera with the current settings.

Declaration
public string GetLensPresetName()
Returns
Type Description
System.String
| Improve this Doc View Source

GetVerticalFieldOfView()

Returns the vertical FOV of the camera with current settings.

Declaration
public float GetVerticalFieldOfView()
Returns
Type Description
System.Single
| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static CineCameraComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
CineCameraComponent
| Improve this Doc View Source

SetFilmbackPresetByName(String)

Set the current preset settings by preset name.

Declaration
public void SetFilmbackPresetByName(string InPresetName)
Parameters
Type Name Description
System.String InPresetName
| Improve this Doc View Source

SetLensPresetByName(String)

Set the current lens settings by preset name.

Declaration
public void SetLensPresetByName(string InPresetName)
Parameters
Type Name Description
System.String InPresetName

Operators

| Improve this Doc View Source

Implicit(IntPtr to CineCameraComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator CineCameraComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
CineCameraComponent
  • Improve this Doc
  • View Source
Back to top Generated by DocFX