UAnselFunctionLibrary

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Ansel

Header

/Engine/Plugins/Runtime/Nvidia/Ansel/Source/Ansel/Public/AnselFunctionLibrary.h

Include

#include "AnselFunctionLibrary.h"

Syntax

UCLASS ()
class UAnselFunctionLibrary : public UBlueprintFunctionLibrary

Functions

Name Description

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

ConstrainCameraByDistance

(
    UObject * WorldContextObject,
    const FVector NewCameraLocation,
    const FVector PreviousCameraLocatio...,
    const FVector OriginalCameraLocatio...,
    FVector & OutCameraLocation,
    float MaxDistance
)

A utility which constrains distance of camera from its start point; may be useful when implementing a custom APlayerCameraManager::PhotographyCameraModify

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

ConstrainCameraByGeometry

(
    UObject * WorldContextObject,
    const FVector NewCameraLocation,
    const FVector PreviousCameraLocatio...,
    const FVector OriginalCameraLocatio...,
    FVector & OutCameraLocation
)

A utility which constrains the camera against collidable geometry; may be useful when implementing a custom APlayerCameraManager::PhotographyCameraModify

Public function Static UFunction BlueprintCallable, Category

bool

 

IsPhotographyAllowed()

Whether the app is permitting photography at this time. See CVar r.Photography.Allowed

Public function Static UFunction BlueprintCallable, Category

bool

 

IsPhotographyAvailable()

Whether the photography system is available at all. See CVar r.Photography.Available

Public function Static UFunction BlueprintCallable, Category

void

 

SetAutoPause

(
    const bool bShouldAutoPause
)

Sets whether the photography system automatically pauses the game during a photography session.

Public function Static UFunction BlueprintCallable, Category

void

 

SetAutoPostprocess

(
    const bool bShouldAutoPostprocess
)

Sets whether the photography system automatically tries to optimize Unreal's postprocessing effects for photography.

Public function Static UFunction BlueprintCallable, Category

void

 

SetCameraConstraintCameraSize

(
    const float CameraSize
)

Sets the size of the photography camera for collision purposes; only relevant when default implementation of PlayerCameraManager's PhotographyCameraModify function is used.

Public function Static UFunction BlueprintCallable, Category

void

 

SetCameraConstraintDistance

(
    const float MaxCameraDistance
)

Sets maximum distance which the camera is allowed to wander from its initial position; only relevant when default implementation of PlayerCameraManager's PhotographyCameraModify function is used.

Public function Static UFunction BlueprintCallable, Category

void

 

SetCameraMovementSpeed

(
    const float TranslationSpeed
)

Sets the normal speed of movement of the photography camera.

Public function Static UFunction BlueprintCallable, Category

void

 

SetIsPhotographyAllowed

(
    const bool bIsPhotographyAllowed
)

Sets whether the app is permitting photography at this time. See CVar r.Photography.Allowed

Public function Static UFunction BlueprintCallable, Category

void

 

SetSettleFrames

(
    const int NumSettleFrames
)

Sets the number of frames between captures in a multi-part shot.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

SetUIControlVisibility

(
    UObject * WorldContextObject,
    const TEnumAsByte < EUIControlEffect ...,
    const bool bIsVisible
)

Show or hide controls in the photography UI which let the player tweak standard UE visual effects during photography - for example, depth of field or chromatic aberration.

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

StartSession

(
    UObject * WorldContextObject
)

Starts a photography session

Public function Static UFunction BlueprintCallable, Category, Meta

void

 

StopSession

(
    UObject * WorldContextObject
)

Stops a photography session

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback