Stereo Panoramic Player  1.0.0
Public Member Functions | Public Attributes | List of all members
UPanoramicInteractionComponent Class Reference

The component used to perfom interactions with the stage navigations. More...

#include <PanoramicInteractionComponent.h>

Inheritance diagram for UPanoramicInteractionComponent:

Public Member Functions

void OnPanoramicModeEntered ()
 Called by the director. More...
 
void OnPanoramicModeExited ()
 Called by the director. More...
 
void PushCustomWorldTargetDirection (FVector WorldTargetDirection)
 Add a custom target direction (should be normalized and in world space). More...
 
virtual void TickComponent (float DeltaTime, ELevelTick TickType, FActorComponentTickFunction *ThisTickFunction) override
 Override UActorComponent::TickComponent. More...
 
void TryToInteractManually ()
 Try to interact with stage navigations manually and instantanially. More...
 

Public Attributes

bool CameraForwardAsTargetDirection
 Use the camera forward as target direction. More...
 
float FocusDuration
 How long (in seconds) the user should focus a target to enter on the next stage. More...
 
FName InputActionName
 The input action name used to trigger an interaction. More...
 
bool InteractionAutoMode
 Flag to enable the auto interaction mode. More...
 
bool InteractionInputActionMode
 Flag to enable the input-action interaction mode. More...
 
bool MouseCursorAsTargetDirection
 Use the mouse cursor as target direction. More...
 
TSubclassOf< class UUserWidget > ViewfinderClass
 An optional UMG widget used to customize the viewfinder. More...
 

Detailed Description

The component used to perfom interactions with the stage navigations.

Member Function Documentation

◆ OnPanoramicModeEntered()

void UPanoramicInteractionComponent::OnPanoramicModeEntered ( )

Called by the director.

Don't call it manually.

◆ OnPanoramicModeExited()

void UPanoramicInteractionComponent::OnPanoramicModeExited ( )

Called by the director.

Don't call it manually.

◆ PushCustomWorldTargetDirection()

void UPanoramicInteractionComponent::PushCustomWorldTargetDirection ( FVector  WorldTargetDirection)

Add a custom target direction (should be normalized and in world space).

It will be used to interact with stage navigations. The direction will be used automatically but you can call TryToInteractManually to try to interact (to perform a transition if it's possible) manually and instantanially. Collected custom target directions are cleared at each tick.

◆ TickComponent()

virtual void UPanoramicInteractionComponent::TickComponent ( float  DeltaTime,
ELevelTick  TickType,
FActorComponentTickFunction *  ThisTickFunction 
)
overridevirtual

Override UActorComponent::TickComponent.

◆ TryToInteractManually()

void UPanoramicInteractionComponent::TryToInteractManually ( )

Try to interact with stage navigations manually and instantanially.

Member Data Documentation

◆ CameraForwardAsTargetDirection

bool UPanoramicInteractionComponent::CameraForwardAsTargetDirection

Use the camera forward as target direction.

Target Directions are used to interact with stage navigations.

◆ FocusDuration

float UPanoramicInteractionComponent::FocusDuration

How long (in seconds) the user should focus a target to enter on the next stage.

Put to zero to disable this mechanism. It works if the auto interaction mode is on (

See also
InteractionAutoMode)

◆ InputActionName

FName UPanoramicInteractionComponent::InputActionName

The input action name used to trigger an interaction.

(

See also
InteractionInputActionMode)

◆ InteractionAutoMode

bool UPanoramicInteractionComponent::InteractionAutoMode

Flag to enable the auto interaction mode.

If true, when the user focus a navigation target, we move on the next stage automatically (

See also
FocusDuration)

◆ InteractionInputActionMode

bool UPanoramicInteractionComponent::InteractionInputActionMode

Flag to enable the input-action interaction mode.

If true, we move on the target stage (if any) when the choosen input action is triggered (

See also
InputActionName)

◆ MouseCursorAsTargetDirection

bool UPanoramicInteractionComponent::MouseCursorAsTargetDirection

Use the mouse cursor as target direction.

Target Directions are used to interact with stage navigations.

◆ ViewfinderClass

TSubclassOf<class UUserWidget> UPanoramicInteractionComponent::ViewfinderClass

An optional UMG widget used to customize the viewfinder.

Visible when the user is focusing a stage navigation and the auto interaction mode is on (

See also
InteractionAutoMode)

The documentation for this class was generated from the following file: