APixoVRCircleProgress Class Reference

Class representing a circular progress indicator in PixoVR. The circle progress can be updated to display a specific percentage and can be enabled or disabled. More...

#include <PixoVRCircleProgress.h>

Inheritance diagram for APixoVRCircleProgress:

Public Member Functions
	APixoVRCircleProgress ()
void	SetCircleProgressEnabled (bool bIsEnabled)
	Sets the enabled state of the circle progress.
void	UpdateCircle (float Percentage)
	Updates the circle progress to the specified percentage.

Protected Member Functions
virtual void	BeginPlay () override
virtual void	Tick (float DeltaSeconds) override

Protected Attributes
UStaticMeshComponent *	ProgressPlane
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = Components)
USceneComponent *	SceneRoot
	UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = Components)
float	VisibilityThresholdTime = 0.2f
	UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = Setup)

Private Member Functions
	GENERATED_BODY ()

Private Attributes
UPixoVRLongHoldComponent *	LongHoldComponent
	UPROPERTY()
UMaterialInstanceDynamic *	ProgressMaterialInstance
	UPROPERTY()

Detailed Description

Class representing a circular progress indicator in PixoVR. The circle progress can be updated to display a specific percentage and can be enabled or disabled.

UCLASS()

Definition at line 17 of file PixoVRCircleProgress.h.

Constructor & Destructor Documentation

APixoVRCircleProgress()

APixoVRCircleProgress::APixoVRCircleProgress

(

)

Definition at line 7 of file PixoVRCircleProgress.cpp.

Member Function Documentation

BeginPlay()

void APixoVRCircleProgress::BeginPlay ( )

overrideprotectedvirtual

Definition at line 53 of file PixoVRCircleProgress.cpp.

GENERATED_BODY()

APixoVRCircleProgress::GENERATED_BODY ( )

private

SetCircleProgressEnabled()

void APixoVRCircleProgress::SetCircleProgressEnabled ( bool bIsEnabled )

ReliableNetMulticast

Sets the enabled state of the circle progress.

Parameters

bIsEnabled

True to enable the circle progress, false to disable.

UFUNCTION(NetMulticast, Reliable)

Tick()

void APixoVRCircleProgress::Tick ( float DeltaSeconds )

overrideprotectedvirtual

Definition at line 38 of file PixoVRCircleProgress.cpp.

Here is the call graph for this function:

UpdateCircle()

void APixoVRCircleProgress::UpdateCircle ( float Percentage )

BlueprintCallable

Updates the circle progress to the specified percentage.

Parameters

Percentage

The progress percentage to display.

UFUNCTION(BlueprintCallable)

Definition at line 23 of file PixoVRCircleProgress.cpp.

Here is the caller graph for this function:

Member Data Documentation

LongHoldComponent

UPixoVRLongHoldComponent* APixoVRCircleProgress::LongHoldComponent

private

UPROPERTY()

Definition at line 80 of file PixoVRCircleProgress.h.

ProgressMaterialInstance

UMaterialInstanceDynamic* APixoVRCircleProgress::ProgressMaterialInstance

private

UPROPERTY()

Definition at line 75 of file PixoVRCircleProgress.h.

ProgressPlane

UStaticMeshComponent* APixoVRCircleProgress::ProgressPlane

protectedBlueprintReadWriteVisibleAnywhere

UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = Components)

A static mesh component representing the visual progress indicator.

Definition at line 61 of file PixoVRCircleProgress.h.

SceneRoot

USceneComponent* APixoVRCircleProgress::SceneRoot

protectedBlueprintReadWriteVisibleAnywhere

UPROPERTY(VisibleAnywhere, BlueprintReadWrite, Category = Components)

A scene component that serves as the root component for the actor.

Definition at line 54 of file PixoVRCircleProgress.h.

VisibilityThresholdTime

float APixoVRCircleProgress::VisibilityThresholdTime = 0.2f

protectedBlueprintReadOnlyEditDefaultsOnly

UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = Setup)

A configurable threshold time used for visibility calculations.

Definition at line 69 of file PixoVRCircleProgress.h.

---

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

• SDKDemo/Plugins/UnrealEngineSDK/PixoCore/Source/PixoCore/Public/CharacterTools/PixoVRCircleProgress.h
• SDKDemo/Plugins/UnrealEngineSDK/PixoCore/Source/PixoCore/Private/CharacterTools/PixoVRCircleProgress.cpp