Show / Hide Table of Contents

Class CameraComponent

Represents a camera viewpoint and settings, such as projection type, field of view, and post-process overrides.

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
CameraComponent
CineCameraComponent
Inherited Members
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.Engine
Assembly: UE4DotNet.dll
Syntax
public class CameraComponent : SceneComponent
Remarks

The default behavior for an actor used as the camera view target is to look for an attached camera component and use its location, rotation, and settings.

Properties

| Improve this Doc View Source

AspectRatio

Aspect Ratio (Width/Height)

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

bConstrainAspectRatio

Declaration
public bool bConstrainAspectRatio { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bLockToHmd

Declaration
public bool bLockToHmd { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bUseFieldOfViewForLOD

Declaration
public bool bUseFieldOfViewForLOD { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bUsePawnControlRotation

Declaration
public bool bUsePawnControlRotation { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CameraMesh

Camera Mesh

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

DefaultObject

Get UE4 Default Object for this Class

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

FieldOfView

The horizontal field of view (in degrees) in perspective mode (ignored in Orthographic mode)

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

OrthoFarClipPlane

The far plane distance of the orthographic view (in world units)

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

OrthoNearClipPlane

The near plane distance of the orthographic view (in world units)

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

OrthoWidth

The desired width (in world units) of the orthographic view (ignored in Perspective mode)

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

PostProcessBlendWeight

Indicates if PostProcessSettings should be used when using this Camera to view through.

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

PostProcessSettings

Post process settings to use for this camera. Don't forget to check the properties you want to override

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

ProjectionMode

The type of camera

Declaration
public byte ProjectionMode { get; set; }
Property Value
Type Description
System.Byte
| 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

AddOrUpdateBlendable(Byte, Single)

Adds an Blendable (implements IBlendableInterface) to the array of Blendables (if it doesn't exist) and update the weight

Declaration
public void AddOrUpdateBlendable(byte InBlendableObject, float InWeight)
Parameters
Type Name Description
System.Byte InBlendableObject
System.Single InWeight
| Improve this Doc View Source

GetCameraView(Single)

Returns camera's Point of View.

Declaration
public MinimalViewInfo GetCameraView(float DeltaTime)
Parameters
Type Name Description
System.Single DeltaTime
Returns
Type Description
MinimalViewInfo
Remarks

Called by Camera class. Subclass and postprocess to add any effects.

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

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

RemoveBlendable(Byte)

Removes a blendable.

Declaration
public void RemoveBlendable(byte InBlendableObject)
Parameters
Type Name Description
System.Byte InBlendableObject
| Improve this Doc View Source

SetAspectRatio(Single)

Set Aspect Ratio

Declaration
public void SetAspectRatio(float InAspectRatio)
Parameters
Type Name Description
System.Single InAspectRatio
| Improve this Doc View Source

SetConstraintAspectRatio(Boolean)

Set Constraint Aspect Ratio

Declaration
public void SetConstraintAspectRatio(bool bInConstrainAspectRatio)
Parameters
Type Name Description
System.Boolean bInConstrainAspectRatio
| Improve this Doc View Source

SetFieldOfView(Single)

Set Field Of View

Declaration
public void SetFieldOfView(float InFieldOfView)
Parameters
Type Name Description
System.Single InFieldOfView
| Improve this Doc View Source

SetOrthoFarClipPlane(Single)

Set Ortho Far Clip Plane

Declaration
public void SetOrthoFarClipPlane(float InOrthoFarClipPlane)
Parameters
Type Name Description
System.Single InOrthoFarClipPlane
| Improve this Doc View Source

SetOrthoNearClipPlane(Single)

Set Ortho Near Clip Plane

Declaration
public void SetOrthoNearClipPlane(float InOrthoNearClipPlane)
Parameters
Type Name Description
System.Single InOrthoNearClipPlane
| Improve this Doc View Source

SetOrthoWidth(Single)

Set Ortho Width

Declaration
public void SetOrthoWidth(float InOrthoWidth)
Parameters
Type Name Description
System.Single InOrthoWidth
| Improve this Doc View Source

SetPostProcessBlendWeight(Single)

Set Post Process Blend Weight

Declaration
public void SetPostProcessBlendWeight(float InPostProcessBlendWeight)
Parameters
Type Name Description
System.Single InPostProcessBlendWeight
| Improve this Doc View Source

SetProjectionMode(Byte)

Set Projection Mode

Declaration
public void SetProjectionMode(byte InProjectionMode)
Parameters
Type Name Description
System.Byte InProjectionMode
| Improve this Doc View Source

SetUseFieldOfViewForLOD(Boolean)

Set Use Field Of View for LOD

Declaration
public void SetUseFieldOfViewForLOD(bool bInUseFieldOfViewForLOD)
Parameters
Type Name Description
System.Boolean bInUseFieldOfViewForLOD

Operators

| Improve this Doc View Source

Implicit(IntPtr to CameraComponent)

Convert from IntPtr to UObject

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