unreal.AnselFunctionLibrary

class unreal.AnselFunctionLibrary(outer=None, name='None')

Bases: unreal.BlueprintFunctionLibrary

Ansel Function Library

C++ Source:

  • Plugin: Ansel

  • Module: Ansel

  • File: AnselFunctionLibrary.h

classmethod constrain_camera_by_distance(world_context_object, new_camera_location, previous_camera_location, original_camera_location, max_distance) → Vector

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

Parameters

  • world_context_object (Object) –

  • new_camera_location (Vector) –

  • previous_camera_location (Vector) –

  • original_camera_location (Vector) –

  • max_distance (float) –

Returns

out_camera_location (Vector):

Return type

Vector

classmethod constrain_camera_by_geometry(world_context_object, new_camera_location, previous_camera_location, original_camera_location) → Vector

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

Parameters

  • world_context_object (Object) –

  • new_camera_location (Vector) –

  • previous_camera_location (Vector) –

  • original_camera_location (Vector) –

Returns

out_camera_location (Vector):

Return type

Vector

classmethod is_photography_allowed() → bool

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

Returns

Return type

bool

classmethod is_photography_available() → bool

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

Returns

Return type

bool

classmethod set_auto_pause(should_auto_pause) → None

Sets whether the photography system automatically pauses the game during a photography session. See CVar r.Photography.AutoPause

Parameters

should_auto_pause (bool) –

classmethod set_auto_postprocess(should_auto_postprocess) → None

Sets whether the photography system automatically tries to optimize Unreal’s postprocessing effects for photography. See CVar r.Photography.AutoPostprocess

Parameters

should_auto_postprocess (bool) –

classmethod set_camera_constraint_camera_size(camera_size) → None

Sets the size of the photography camera for collision purposes; only relevant when default implementation of PlayerCameraManager’s PhotographyCameraModify function is used. See CVar r.Photography.Constrain.CameraSize

Parameters

camera_size (float) –

classmethod set_camera_constraint_distance(max_camera_distance) → None

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. See CVar r.Photography.Constrain.MaxCameraDistance

Parameters

max_camera_distance (float) –

classmethod set_camera_movement_speed(translation_speed) → None

Sets the normal speed of movement of the photography camera. See CVar r.Photography.TranslationSpeed

Parameters

translation_speed (float) –

classmethod set_is_photography_allowed(is_photography_allowed) → None

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

Parameters

is_photography_allowed (bool) –

classmethod set_settle_frames(num_settle_frames) → None

Sets the number of frames between captures in a multi-part shot. See CVar r.Photography.SettleFrames

Parameters

num_settle_frames (int32) –

classmethod set_ui_control_visibility(world_context_object, ui_control_target, is_visible) → None

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. Note: these controls only exist when SetAutoPostprocess is turned on. Some may not apply to your application either because you are not using the associated effect or you are using a custom version of the effect.

Parameters
classmethod start_session(world_context_object) → None

Starts a photography session

Parameters

world_context_object (Object) –

classmethod stop_session(world_context_object) → None

Stops a photography session

Parameters

world_context_object (Object) –