v1.2.26 |
Documentation for the Unreal C++ Plugin
|
A actor class representing the PixoVR wrist menu. The wrist menu allows users to interact with menu items and perform actions based on their selection. More...
#include <PixoVRWristMenu.h>
Public Member Functions | |
APixoVRWristMenu () | |
void | ActivateWristMenu (bool InActivate) |
Activate or deactivate the wrist menu. | |
void | AddIMenuItem (const FPixoVRWristMenuDataTableRow &InNewItemInfo) |
Add a new menu item or update an existing one in the wrist menu if found in the DataTableRows array by MenuItemID. | |
void | CalculateRotationByItemIndex (const int32 WristMenuItemIndex) |
Calculate the rotation of the pointer arrow based on the item index. | |
void | IncreaseSelectedItem (int Amount) |
Increase the selected item by a specified amount. Use this to do tests with the mouse wheel. | |
bool | IsActivated () |
Check if the wrist menu is activated. | |
EWristMenuItemCategory | SelectMenuItem () |
Signal that the user has performed a select action on the wrist menu. | |
void | SetEventHandlers (TArray< UObject * > &InEventHandleObjects) |
Set the event handlers for the wrist menu. | |
void | UpdateTrackpadPosition (const FVector2D &position) |
Update the position of the trackpad. You need to call this method when the user moves his fingers (thumb) on the pad. | |
Public Attributes | |
float | AnglePerLargeItem |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu") | |
float | AnglePerNormalItem |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu") | |
UAudioComponent * | AudioComponent |
UPROPERTY(VisibleDefaultsOnly, BlueprintReadWrite) | |
bool | bAlignToPlayerHead |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu") | |
bool | bIsActivated |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu") | |
float | CurrentAngle |
UPROPERTY(BlueprintReadOnly, Transient, Category = "PixoVR | Wrist Menu") | |
FRotator | CurrentArrowRotation |
The current rotation of the arrow. | |
int | CurrentLargeAngleIndex |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu") | |
UWidgetComponent * | CurrentLargePointedWidgetComponent |
UPROPERTY() | |
int | CurrentNormalAngleIndex |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu") | |
FVector2D | CurrentPadDirection |
The current direction of the pad. | |
UWidgetComponent * | CurrentPointedWidgetComponent |
UPROPERTY() | |
UCurveFloat * | Curve |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu") | |
TArray< FPixoVRWristMenuDataTableRow * > | DataTableRows |
The rows from the data table for easier usage. | |
TArray< FPixoVRWristMenuDataTableRow * > | DataTableRowsLarge |
The rows from the data table for easier usage. | |
TArray< FPixoVRWristMenuDataTableRow * > | DataTableRowsNormal |
The rows from the data table for easier usage. | |
TArray< UObject * > | EventHandleObjects |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu") | |
USoundCue * | HoverAudioCue |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu") | |
float | IconRadialDistance |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu") | |
FVector | IconRelativeScale |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu") | |
TArray< UWidgetComponent * > | LargeWidgetComponents |
The widget components used for rendering large wrist menu items. | |
int | PreviousLargeAngleIndex |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu") | |
int | PreviousNormalAngleIndex |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu") | |
UStaticMeshComponent * | RadialArrowMesh |
UPROPERTY(VisibleDefaultsOnly, BlueprintReadWrite) | |
UStaticMeshComponent * | RadialFloatingMesh |
UPROPERTY(VisibleDefaultsOnly, BlueprintReadWrite) | |
float | RotationSpeed |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu") | |
USceneComponent * | SceneComponent |
UPROPERTY(VisibleDefaultsOnly, BlueprintReadWrite) | |
USoundCue * | SelectAudioCue |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu") | |
float | ThumbDeadZone |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu") | |
UTimelineComponent * | TimelineComponent |
UPROPERTY(VisibleAnywhere, BlueprintReadWrite) | |
FOnTimelineEvent | TimelineFinished |
Delegate fired when the timeline reaches the end. | |
FOnTimelineFloat | TimelinePostUpdate |
Delegate fired when the timeline has a new update. | |
UWidgetComponent * | Title |
UPROPERTY() | |
TArray< UWidgetComponent * > | WidgetComponents |
The widget components used for rendering normal wrist menu items. | |
UDataTable * | WidgetDataTable |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu", meta = (AllowPrivateAccess = "true")) | |
UDataTable * | WidgetDataTableDefault |
UPROPERTY(Transient) | |
TSubclassOf< class UUserWidget > | WristMenuTitleWidgetClass |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu", meta = (AllowPrivateAccess = "true")) | |
TSubclassOf< class UUserWidget > | WristMenuWidgetClass |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu", meta = (AllowPrivateAccess = "true")) | |
Protected Member Functions | |
void | RebuildWristMenu (UDataTable *NewWidgetDataTable) |
Rebuild the wrist menu using a new widget data table. | |
void | ResetToDefaultTable () |
Reset the data table to the default one. | |
Private Member Functions | |
virtual void | BeginPlay () override |
void | CalculateRotationFromInput (const FVector2D &Direction) |
Calculate the rotation of the pointer arrow based on the input from a controller pad. | |
void | ClearAllWidgets () |
Clear all the widgets. | |
void | CreateAllWidgets () |
Create all the widgets using the widget data table. | |
GENERATED_BODY () | |
void | HandleTimelineFinished () |
Handle the timeline finished event. | |
void | HandleTimeLineFloat (float Value) |
Handle the update of the timeline. | |
bool | ParseWidgetDataTable () |
Parse the widget data table and create all the required widgets. | |
bool | ParseWidgetDataTableRows () |
Parse the data table rows array and create all the required widgets. | |
virtual void | Tick (float DeltaTime) override |
void | TickWristMenu (float DeltaTime) |
Private Attributes | |
int | MaxNumberOfLargeButtons |
int | MaxNumberOfNormalButtons |
A actor class representing the PixoVR wrist menu. The wrist menu allows users to interact with menu items and perform actions based on their selection.
UCLASS(Blueprintable)
Definition at line 28 of file PixoVRWristMenu.h.
APixoVRWristMenu::APixoVRWristMenu | ( | ) |
|
ReliableNetMulticastBlueprintCallable |
Activate or deactivate the wrist menu.
InActivate | Whether to activate or deactivate the wrist menu. |
UFUNCTION(BlueprintCallable, NetMulticast, Reliable, Category = "PixoVR | Wrist Menu")
|
BlueprintCallable |
Add a new menu item or update an existing one in the wrist menu if found in the DataTableRows array by MenuItemID.
InNewItemInfo | The information of the new menu item. |
UFUNCTION(BlueprintCallable, Category = "PixoVR | Wrist Menu")
Definition at line 454 of file PixoVRWristMenu.cpp.
|
overrideprivatevirtual |
|
BlueprintCallable |
Calculate the rotation of the pointer arrow based on the item index.
WristMenuItemIndex | The index of the wrist menu item. |
UFUNCTION(BlueprintCallable, Category = "PixoVR | Wrist Menu")
Definition at line 443 of file PixoVRWristMenu.cpp.
|
private |
Calculate the rotation of the pointer arrow based on the input from a controller pad.
Direction | The direction of the controller pad input. |
Definition at line 427 of file PixoVRWristMenu.cpp.
|
private |
Clear all the widgets.
Definition at line 292 of file PixoVRWristMenu.cpp.
|
private |
Create all the widgets using the widget data table.
Definition at line 473 of file PixoVRWristMenu.cpp.
|
private |
|
private |
Handle the timeline finished event.
UFUNCTION()
Definition at line 681 of file PixoVRWristMenu.cpp.
|
private |
Handle the update of the timeline.
Value | The current value of the timeline. |
UFUNCTION()
Definition at line 676 of file PixoVRWristMenu.cpp.
|
BlueprintCallable |
Increase the selected item by a specified amount. Use this to do tests with the mouse wheel.
Amount | The amount by which to increase the selected item. |
UFUNCTION(BlueprintCallable, Category = "PixoVR | Wrist Menu")
Definition at line 119 of file PixoVRWristMenu.cpp.
|
BlueprintCallable |
Check if the wrist menu is activated.
UFUNCTION(BlueprintCallable, Category = "PixoVR | Wrist Menu")
Definition at line 422 of file PixoVRWristMenu.cpp.
|
private |
Parse the widget data table and create all the required widgets.
Definition at line 604 of file PixoVRWristMenu.cpp.
|
private |
Parse the data table rows array and create all the required widgets.
Definition at line 626 of file PixoVRWristMenu.cpp.
|
protectedBlueprintCallable |
Rebuild the wrist menu using a new widget data table.
NewWidgetDataTable | The new data table to be used for building the wrist menu. |
UFUNCTION(BlueprintCallable, Category = "PixoVR | Wrist Menu")
Definition at line 657 of file PixoVRWristMenu.cpp.
|
protectedBlueprintCallable |
Reset the data table to the default one.
UFUNCTION(BlueprintCallable, Category = "PixoVR | Wrist Menu")
Definition at line 124 of file PixoVRWristMenu.cpp.
|
BlueprintCallable |
Signal that the user has performed a select action on the wrist menu.
UFUNCTION(BlueprintCallable, Category = "PixoVR | Wrist Menu")
Definition at line 329 of file PixoVRWristMenu.cpp.
|
BlueprintCallable |
Set the event handlers for the wrist menu.
InEventHandleObjects | The objects that will handle the selection events of the wrist menu. |
UFUNCTION(BlueprintCallable, Category = "PixoVR | Wrist Menu")
Definition at line 652 of file PixoVRWristMenu.cpp.
|
overrideprivatevirtual |
|
private |
Definition at line 198 of file PixoVRWristMenu.cpp.
|
ReliableNetMulticastBlueprintCallable |
Update the position of the trackpad. You need to call this method when the user moves his fingers (thumb) on the pad.
position | The position of the trackpad. |
UFUNCTION(BlueprintCallable, NetMulticast, Reliable, Category = "PixoVR | Wrist Menu")
|
BlueprintReadOnly |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu")
The angle size of one item inside the wrist menu (for large buttons).
Definition at line 275 of file PixoVRWristMenu.h.
|
BlueprintReadOnly |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu")
The angle size of one item inside the wrist menu (for normal buttons).
Definition at line 270 of file PixoVRWristMenu.h.
|
BlueprintReadWriteVisibleDefaultsOnly |
UPROPERTY(VisibleDefaultsOnly, BlueprintReadWrite)
Definition at line 215 of file PixoVRWristMenu.h.
|
EditAnywhereBlueprintReadWrite |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu")
Flag indicating whether the wrist menu should align to the player's head.
Definition at line 381 of file PixoVRWristMenu.h.
|
BlueprintReadOnly |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu")
Indicates whether the wrist menu is activated or not.
Definition at line 235 of file PixoVRWristMenu.h.
|
BlueprintReadOnlyTransient |
UPROPERTY(BlueprintReadOnly, Transient, Category = "PixoVR | Wrist Menu")
The current angle of the wrist menu.
Definition at line 281 of file PixoVRWristMenu.h.
FRotator APixoVRWristMenu::CurrentArrowRotation |
The current rotation of the arrow.
Definition at line 297 of file PixoVRWristMenu.h.
|
BlueprintReadOnly |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu")
The current index for large buttons that the arrow points to.
Definition at line 253 of file PixoVRWristMenu.h.
UWidgetComponent* APixoVRWristMenu::CurrentLargePointedWidgetComponent |
UPROPERTY()
Definition at line 364 of file PixoVRWristMenu.h.
|
BlueprintReadOnly |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu")
The current index for normal buttons that the arrow points to.
Definition at line 248 of file PixoVRWristMenu.h.
FVector2D APixoVRWristMenu::CurrentPadDirection |
The current direction of the pad.
Definition at line 296 of file PixoVRWristMenu.h.
UWidgetComponent* APixoVRWristMenu::CurrentPointedWidgetComponent |
UPROPERTY()
Definition at line 360 of file PixoVRWristMenu.h.
|
EditAnywhereBlueprintReadWrite |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu")
The curve used for activating/deactivating the wrist menu.
Definition at line 229 of file PixoVRWristMenu.h.
TArray<FPixoVRWristMenuDataTableRow*> APixoVRWristMenu::DataTableRows |
The rows from the data table for easier usage.
Definition at line 348 of file PixoVRWristMenu.h.
TArray<FPixoVRWristMenuDataTableRow*> APixoVRWristMenu::DataTableRowsLarge |
The rows from the data table for easier usage.
Definition at line 350 of file PixoVRWristMenu.h.
TArray<FPixoVRWristMenuDataTableRow*> APixoVRWristMenu::DataTableRowsNormal |
The rows from the data table for easier usage.
Definition at line 349 of file PixoVRWristMenu.h.
|
EditAnywhereBlueprintReadWrite |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu")
The objects that will handle the selection events of the wrist menu.
Definition at line 330 of file PixoVRWristMenu.h.
|
EditAnywhereBlueprintReadWrite |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu")
The audio cue used when hovering over a menu item.
Definition at line 343 of file PixoVRWristMenu.h.
|
EditAnywhereBlueprintReadWrite |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu")
The radial distance of the icons in the wrist menu.
Definition at line 288 of file PixoVRWristMenu.h.
|
EditAnywhereBlueprintReadWrite |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu")
The relative scale of the icons in the wrist menu.
Definition at line 294 of file PixoVRWristMenu.h.
TArray<UWidgetComponent*> APixoVRWristMenu::LargeWidgetComponents |
The widget components used for rendering large wrist menu items.
Definition at line 346 of file PixoVRWristMenu.h.
|
private |
Definition at line 385 of file PixoVRWristMenu.h.
|
private |
Definition at line 384 of file PixoVRWristMenu.h.
|
BlueprintReadOnly |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu")
Definition at line 264 of file PixoVRWristMenu.h.
|
BlueprintReadOnly |
UPROPERTY(BlueprintReadOnly, Category = "PixoVR | Wrist Menu")
Definition at line 259 of file PixoVRWristMenu.h.
|
BlueprintReadWriteVisibleDefaultsOnly |
UPROPERTY(VisibleDefaultsOnly, BlueprintReadWrite)
Definition at line 208 of file PixoVRWristMenu.h.
|
BlueprintReadWriteVisibleDefaultsOnly |
UPROPERTY(VisibleDefaultsOnly, BlueprintReadWrite)
Definition at line 201 of file PixoVRWristMenu.h.
|
EditAnywhereBlueprintReadWrite |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu")
The rotation speed of the wrist menu.
Definition at line 374 of file PixoVRWristMenu.h.
|
BlueprintReadWriteVisibleDefaultsOnly |
UPROPERTY(VisibleDefaultsOnly, BlueprintReadWrite)
Definition at line 194 of file PixoVRWristMenu.h.
|
EditAnywhereBlueprintReadWrite |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu")
The audio cue used when selecting a menu item.
Definition at line 337 of file PixoVRWristMenu.h.
|
EditAnywhereBlueprintReadWrite |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu")
The minimum length of the pad pointer that is considered as a valid pointer.
Definition at line 242 of file PixoVRWristMenu.h.
|
VisibleAnywhereBlueprintReadWrite |
UPROPERTY(VisibleAnywhere, BlueprintReadWrite)
Definition at line 222 of file PixoVRWristMenu.h.
FOnTimelineEvent APixoVRWristMenu::TimelineFinished |
Delegate fired when the timeline reaches the end.
Definition at line 367 of file PixoVRWristMenu.h.
FOnTimelineFloat APixoVRWristMenu::TimelinePostUpdate |
Delegate fired when the timeline has a new update.
Definition at line 366 of file PixoVRWristMenu.h.
UWidgetComponent* APixoVRWristMenu::Title |
UPROPERTY()
Definition at line 355 of file PixoVRWristMenu.h.
TArray<UWidgetComponent*> APixoVRWristMenu::WidgetComponents |
The widget components used for rendering normal wrist menu items.
Definition at line 345 of file PixoVRWristMenu.h.
|
EditAnywhereBlueprintReadWrite |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu", meta = (AllowPrivateAccess = "true"))
The data table that holds information about how the wrist menu is built up.
Definition at line 310 of file PixoVRWristMenu.h.
|
Transient |
UPROPERTY(Transient)
Definition at line 303 of file PixoVRWristMenu.h.
|
EditAnywhereBlueprintReadWrite |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu", meta = (AllowPrivateAccess = "true"))
The blueprint class used to render the titles of the selected items in the wrist menu.
Definition at line 323 of file PixoVRWristMenu.h.
|
EditAnywhereBlueprintReadWrite |
UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "PixoVR | Wrist Menu", meta = (AllowPrivateAccess = "true"))
The blueprint class used to render the menu items in the wrist menu.
Definition at line 317 of file PixoVRWristMenu.h.