This class can be used for cases when the user needs to apply Grip to specific areas that can have no specific meshes. More...

#include <BaseGrippableStoryVolume.h>

Inheritance diagram for ABaseGrippableStoryVolume:

[legend]

Public Member Functions
	ABaseGrippableStoryVolume ()

void	ActivateHighlightOnActiveStep ()
	Event called to activate the highlight on the active step.

virtual FBPAdvGripSettings	AdvancedGripSettings_Implementation () override
	Implementation of the AdvancedGripSettings function from the IVRGripInterface interface. Get the advanced physics settings for this grip.

virtual bool	AllowsMultipleGrips_Implementation () override
	Implementation of the AllowsMultipleGrips function from the IVRGripInterface interface. Check if an object allows multiple grips at one time.

void	AttachToHandObject (UGripMotionControllerComponent *GrippingController, const FBPActorGripInformation &GripInformation)
	Attaches the object to a hand.

virtual void	BeginPlay () override

void	CheckPositionResetConditions ()
	Checking if this object's position can be reset.

virtual void	ClosestGripSlotInRange_Implementation (FVector WorldLocation, bool bSecondarySlot, bool &bHadSlotInRange, FTransform &SlotWorldTransform, FName &SlotName, UGripMotionControllerComponent *CallingController=nullptr, FName OverridePrefix=NAME_None) override
	Implementation of the ClosestGripSlotInRange function from the IVRGripInterface interface. Get closest primary slot in range.

bool	CouldBeGrabbedByOtherHand ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

bool	CouldBeGrabbedWithTwoHands ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior\|Two Hands")

bool	DenyDropping ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

virtual bool	DenyGripping_Implementation (UGripMotionControllerComponent *GripInitiator=nullptr) override
	Implementation of the DenyGripping function from the IVRGripInterface interface. Set up as deny instead of allow so that default allows for gripping.

void	DetachObjectFromHand ()
	Detaches the object from the hand.

void	EnableOnePressDetach (bool Enable)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior\|Two Hands")

virtual void	EnableOnePressDetach_Implementation (bool Enable) override

TArray< FTransparentMaterialData >	GetActorTransparentMaterialData ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Fadable")

virtual void	GetGripStiffnessAndDamping_Implementation (float &GripStiffnessOut, float &GripDampingOut) override
	Implementation of the GetGripStiffnessAndDamping function from the IVRGripInterface interface. What grip stiffness and damping to use if using a physics constraint.

FTransform	GetObjectGrabTransform (APixoVRHand *GrabbedHand)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

virtual FTransform	GetObjectGrabTransform_Implementation (APixoVRHand *GrabbedHand) override
	Implementation of the GetObjectGrabTransform function from the IPixoVRStoryObject interface. Gets current world transform relative to selected hand for this object.

EPixoVRGripState	GetObjectGripAnimation ()
	Gets the grip animation state of the object.

virtual EGripCollisionType	GetPrimaryGripType_Implementation (bool bIsSlot) override
	Implementation of the GetPrimaryGripType function from the IVRGripInterface interface. Grip type to use.

FTwoHandProperties	GetTwoHandProperties ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior\|Two Hands")

void	GrabWithTwoHands (UMotionControllerComponent *GrabbingController)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior\|Two Hands")

virtual void	GrabWithTwoHands_Implementation (UMotionControllerComponent *GrabbingController) override
	Two hand grabbing logic implementation.

virtual float	GripBreakDistance_Implementation () override
	Implementation of the GripBreakDistance function from the IVRGripInterface interface. What distance to break a grip at (only relevent with physics enabled grips).

virtual EGripLateUpdateSettings	GripLateUpdateSetting_Implementation () override
	Implementation of the GripLateUpdateSetting function from the IVRGripInterface interface. Define the late update setting.

virtual EGripMovementReplicationSettings	GripMovementReplicationType_Implementation () override
	Implementation of the GripMovementReplicationType function from the IVRGripInterface interface. Define which movement repliation setting to use.

bool	HoldItemByClick ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

bool	IsGrabbingWrongActorActive ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

virtual bool	IsGrabbingWrongActorActive_Implementation () override
	Implementation of the IsGrabbingWrongActorActive function from the IPixoVRStoryObject interface. Check if should send notification when the wrong interactable actor grabbed.

virtual void	IsHeld_Implementation (TArray< FBPGripPair > &HoldingControllers, bool &bIsHeld) override
	Implementation of the IsHeld function from the IVRGripInterface interface. Returns if the object is held and if so, which controllers are holding it.

bool	IsObjectActive ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Story")

virtual bool	IsObjectActive_Implementation () override
	Implementation of the IsObjectActive function from the IPixoVRStoryObject interface.

bool	IsObjectHeldWithTwoHands ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior\|Two Hands")

virtual bool	IsObjectHeldWithTwoHands_Implementation () override

bool	IsUsingCustomGripAnimation ()
	Checks if the object is using a custom grip animation.

void	ObjectActivated ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Story")

virtual void	ObjectActivated_Implementation () override
	Implementation of the ObjectActivated function from the IPixoVRStoryObject interface.

void	ObjectDeactivated ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Story")

virtual void	ObjectDeactivated_Implementation () override
	Implementation of the ObjectDeactivated function from the IPixoVRStoryObject interface.

virtual void	OnGrip_Implementation (UGripMotionControllerComponent *GrippingController, const FBPActorGripInformation &GripInformation) override
	Implementation of the OnGrip function from the IVRGripInterface interface. Event triggered on the interfaced object when gripped.

void	OnGrippedEvent (UGripMotionControllerComponent *GrippingController, const FBPActorGripInformation &GripInformation)
	Event triggered when the object is gripped.

virtual void	OnGripRelease_Implementation (UGripMotionControllerComponent *ReleasingController, const FBPActorGripInformation &GripInformation, bool bWasSocketed) override
	Implementation of the OnGripRelease function from the IVRGripInterface interface. Event triggered on the interfaced object when grip is released.

void	OnHintActivated (bool Activate)
	Event called when a hint is activated.

void	OnReleasedEvent (UGripMotionControllerComponent *ReleasingController, const FBPActorGripInformation &GripInformation, bool bWasSocketed)
	Event triggered when the object is released from the grip.

virtual void	OnSecondaryGrip_Implementation (UGripMotionControllerComponent GripOwningController, USceneComponent SecondaryGripComponent, const FBPActorGripInformation &GripInformation) override
	Implementation of the OnSecondaryGrip function from the IVRGripInterface interface. Event triggered on the interfaced object when secondary gripped.

virtual void	OnSecondaryGripRelease_Implementation (UGripMotionControllerComponent GripOwningController, USceneComponent ReleasingSecondaryGripComponent, const FBPActorGripInformation &GripInformation) override
	Implementation of the OnSecondaryGripRelease function from the IVRGripInterface interface. Event triggered on the interfaced object when secondary grip is released.

bool	ReleaseItemByPress ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

void	ReleaseTwoHands (UMotionControllerComponent *ReleasingController)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior\|Two Hands")

virtual void	ReleaseTwoHands_Implementation (UMotionControllerComponent *ReleasingController) override

void	ResetPosition ()
	Resetting object to the position it has ben grabbed off.

void	ResetTwoHandsHoldingFunctionality ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior\|Two Hands")

virtual void	ResetTwoHandsHoldingFunctionality_Implementation () override

virtual ESecondaryGripType	SecondaryGripType_Implementation () override
	Implementation of the SecondaryGripType function from the IVRGripInterface interface. Secondary grip type.

void	SendWrongGrabbingNotification ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

virtual void	SendWrongGrabbingNotification_Implementation () override
	Implementation of the SendErrorGrabbingNotification function from the IPixoVRStoryObject interface. Send error grabbing notification when the wrong interactable actor is grabbed.

void	SetDenyDropping (const bool bDenyDropping)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

virtual void	SetHeld_Implementation (UGripMotionControllerComponent *HoldingController, uint8 GripID, bool bIsHeld) override
	Implementation of the SetHeld function from the IVRGripInterface interface. Sets is held, used by the plugin.

void	SetIsActive (bool bNewIsActive)
	Setter for bIsActive property, also updates collision state for BoxCollisionComponent.

virtual bool	SimulateOnDrop_Implementation () override
	Implementation of the SimulateOnDrop function from the IVRGripInterface interface. Should this object simulate on drop.

void	StartPositionResetTimer ()
	Stopping new position reset check timer.

void	StepSkipped (FStoryStep SkippedStep, bool IsForward)
	Event called when a step is skipped.

void	StopPositionResetTimer ()
	Stopping the current position reset check timer.

virtual EGripInterfaceTeleportBehavior	TeleportBehavior_Implementation () override
	Implementation of the TeleportBehavior function from the IVRGripInterface interface. How an interfaced object behaves when teleporting.

void	UpdateHandGripLogic (EHandGripLogic NewHandGripLogic)
	Updates the hand grip logic.

void	UpdateObjectHighlight (bool Activate)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Hint")

virtual void	UpdateObjectHighlight_Implementation (bool Activate) override
	Implementation of the UpdateObjectHighlight function from the IPixoVRStoryObject interface.

Public Attributes
bool	ActiveStepsAcquiredFromParent = false

bool	AlwaysActive
	UPROPERTY(EditAnywhere, BlueprintReadWrite)

bool	bActivateLocationResetAfterDrop { false }
	UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "GrippableObject")

bool	bCanResetPosition { true }
	UPROPERTY(BlueprintReadWrite, Category = "GrippableObject")

bool	bDestroyActorAfterFailedDrop { false }
	UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "GrippableObject")

bool	bFeedbackEnabled
	UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect")

bool	bGripSoundsEnabled
	UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect")

UBoxComponent *	BoxCollisionComponent
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")

bool	bReleaseSoundsEnabled
	UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect")

TArray< TSubclassOf< ABaseStoryActor > >	ChildClassesThatAcquiredPopulatedData
	UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "BaseStoryActor\|DynamicStory", meta = (EditCondition = "IsAutoStepDataPopulationActive == true", EditConditionHides))

APixoVRHand *	CurrentHoldingHand
	UPROPERTY(VisibleInstanceOnly, BlueprintReadWrite, Category = "GrippableObject")

USoundCue *	GripSoundCue
	UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect", meta = (EditCondition = "bGripSoundsEnabled", EditConditionHides))

EHandGripLogic	HandGripLogic
	UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "GrippableObject")

float	HapticDuration
	UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect", meta=(EditCondition = "bFeedbackEnabled", EditConditionHides))

float	HapticStrength
	UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect", meta=(EditCondition = "bFeedbackEnabled", EditConditionHides))

UHighlightComponent *	HighlightComponent
	UPROPERTY(EditAnywhere, BlueprintReadWrite)

UHintManager *	HintManager
	UPROPERTY(BlueprintReadWrite)

bool	IsAutoStepDataPopulationActive = false
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "BaseStoryActor\|DynamicStory")

bool	ObjectHeldWithTwoHands = false
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Two Hands Grip")

FTransform	ObjectTransformInLeftHand
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "GrippableObject")

FTransform	ObjectTransformInRightHand
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "GrippableObject")

FOnActorStopped	OnActorPositionResetDelegate
	UPROPERTY(BlueprintReadWrite, BlueprintCallable, BlueprintAssignable)

FOnActorStopped	OnActorStoppedDelegate
	UPROPERTY(BlueprintReadWrite, BlueprintCallable, BlueprintAssignable)

FVROnDropSignature	OnDropped
	UPROPERTY(BlueprintAssignable, Category = "Grip Events")

FOnDroppedActorDeleted	OnDroppedActorDeleted
	UPROPERTY(BlueprintReadWrite, BlueprintCallable, BlueprintAssignable)

FVROnGripSignature	OnGripped
	UPROPERTY(BlueprintAssignable, Category = "Grip Events")

FVROnGripSignature	OnSecondaryGripAdded
	UPROPERTY(BlueprintAssignable, Category = "Grip Events")

FVROnGripSignature	OnSecondaryGripRemoved
	UPROPERTY(BlueprintAssignable, Category = "Grip Events")

float	PositionResetCheckRate { 0.1f }
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "GrippableObject")

float	PositionResetMaximumDelay { 5.0f }
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "GrippableObject")

USoundCue *	ReleaseSoundCue
	UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect", meta = (EditCondition = "bReleaseSoundsEnabled", EditConditionHides))

FTransform	ResetTransform
	UPROPERTY(BlueprintReadOnly, Category = "GrippableObject")

FText	SpecificVolumeName
	UPROPERTY(EditAnywhere, BlueprintReadWrite)

UStaticMeshComponent *	StaticMeshComponent
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")

UStoryComponent *	Story
	UPROPERTY(BlueprintReadWrite, EditAnywhere)

bool	StoryActivationAffectsDenyGripping { true }
	UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "GrippableObject")

FBPInterfaceProperties	VRGripInterfaceSettings
	UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "VRGripInterface")

Protected Member Functions
void	NewStepActivated (FStoryStep NewStep, bool IsForward)
	Callback function for when a new step is activated.

void	NewSubStepActivated (FStoryStep NewSubStep)
	Callback function for when a new substep is activated.

Private Member Functions
	GENERATED_BODY ()

void	HandCrossDetection (float CurrentPitch, float RightLeftHandVPitch)

void	PlayGripSound () const

void	PlayHapticFeedbackEffect (UGripMotionControllerComponent *GripMotionControllerComponent) const
	Plays haptic feedback on specific controller.

void	PlayReleaseSound () const

void	TwoHandGrab ()

Private Attributes
bool	bIsActive
	Determines whether the volume is active, use SetIsActive to update its value.

bool	bSaveResetTransformOnGrip { true }
	Flag for preventing this objet from saving ResetTransform.

bool	CrossChanged

bool	CrossDetected

bool	EnableOnePressDetach

float	MoveBackPitchDelta = 0

float	PitchBeforeCross = 0

TWeakObjectPtr< APixoVRHand >	PixoVRHandLeft

TWeakObjectPtr< APixoVRHand >	PixoVRHandRight

FTimerHandle	PositionResetTimer
	Internal timer for checking object's conditions for position reset.

float	ResultedPitch = 0

float	TimeSinceResetTimerStarted { 0.0f }
	Time that accumulates after PositionResetTimer has started.

TWeakObjectPtr< UMotionControllerComponent >	TwoHandMainGrabController

FTimerHandle	TwoHandTimer

float	TwoHandZAxisValue = 0.0

Detailed Description

This class can be used for cases when the user needs to apply Grip to specific areas that can have no specific meshes.

UCLASS()

Definition at line 16 of file BaseGrippableStoryVolume.h.

Constructor & Destructor Documentation

◆ ABaseGrippableStoryVolume()

ABaseGrippableStoryVolume::ABaseGrippableStoryVolume ( )

Definition at line 6 of file BaseGrippableStoryVolume.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ ActivateHighlightOnActiveStep()

void ABaseStoryActor::ActivateHighlightOnActiveStep ( )

inheritedBlueprintNativeEvent

Event called to activate the highlight on the active step.

UFUNCTION(BlueprintNativeEvent)

Here is the caller graph for this function:

◆ AdvancedGripSettings_Implementation()

FBPAdvGripSettings ABaseGrippableStoryActor::AdvancedGripSettings_Implementation ( )

overridevirtualinherited

Implementation of the AdvancedGripSettings function from the IVRGripInterface interface. Get the advanced physics settings for this grip.

Definition at line 274 of file BaseGrippableStoryActor.cpp.

◆ AllowsMultipleGrips_Implementation()

bool ABaseGrippableStoryActor::AllowsMultipleGrips_Implementation ( )

overridevirtualinherited

Implementation of the AllowsMultipleGrips function from the IVRGripInterface interface. Check if an object allows multiple grips at one time.

Definition at line 292 of file BaseGrippableStoryActor.cpp.

◆ AttachToHandObject()

void ABaseGrippableStoryActor::AttachToHandObject	(	UGripMotionControllerComponent *	GrippingController,
		const FBPActorGripInformation &	GripInformation )

inheritedBlueprintCallable

Attaches the object to a hand.

Parameters

GrippingController	The motion controller component that is gripping the object.
GripInformation	Information about the grip.

UFUNCTION(BlueprintCallable, Category = "GrippableObject")

Definition at line 329 of file BaseGrippableStoryActor.cpp.

Here is the caller graph for this function:

◆ BeginPlay()

void ABaseGrippableStoryActor::BeginPlay ( )

overridevirtualinherited

Reimplemented from ABaseStoryActor.

Definition at line 44 of file BaseGrippableStoryActor.cpp.

Here is the call graph for this function:

◆ CheckPositionResetConditions()

void ABaseGrippableStoryActor::CheckPositionResetConditions ( )

inherited

Checking if this object's position can be reset.

UFUNCTION()

Definition at line 82 of file BaseGrippableStoryActor.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ClosestGripSlotInRange_Implementation()

void ABaseGrippableStoryActor::ClosestGripSlotInRange_Implementation	(	FVector	WorldLocation,
		bool	bSecondarySlot,
		bool &	bHadSlotInRange,
		FTransform &	SlotWorldTransform,
		FName &	SlotName,
		UGripMotionControllerComponent *	CallingController = nullptr,
		FName	OverridePrefix = NAME_None )

overridevirtualinherited

Implementation of the ClosestGripSlotInRange function from the IVRGripInterface interface. Get closest primary slot in range.

Definition at line 284 of file BaseGrippableStoryActor.cpp.

◆ CouldBeGrabbedByOtherHand()

bool IPixoVRStoryObject::CouldBeGrabbedByOtherHand ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

Determines if user can grab object from one hand to another.

◆ CouldBeGrabbedWithTwoHands()

bool IPixoVRStoryObject::CouldBeGrabbedWithTwoHands ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior|Two Hands")

◆ DenyDropping()

bool IPixoVRStoryObject::DenyDropping ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

Determines if user can drop this object.

◆ DenyGripping_Implementation()

bool ABaseGrippableStoryActor::DenyGripping_Implementation ( UGripMotionControllerComponent * GripInitiator = nullptr )

overridevirtualinherited

Implementation of the DenyGripping function from the IVRGripInterface interface. Set up as deny instead of allow so that default allows for gripping.

Parameters

GripInitiator Is not guaranteed to be valid, check it for validity

Definition at line 232 of file BaseGrippableStoryActor.cpp.

◆ DetachObjectFromHand()

void ABaseGrippableStoryActor::DetachObjectFromHand ( )

inheritedBlueprintCallable

Detaches the object from the hand.

UFUNCTION(BlueprintCallable, Category = "GrippableObject")

Definition at line 348 of file BaseGrippableStoryActor.cpp.

Here is the caller graph for this function:

◆ EnableOnePressDetach()

void IPixoVRStoryObject::EnableOnePressDetach ( bool Enable )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior|Two Hands")

◆ EnableOnePressDetach_Implementation()

void ABaseGrippableStoryActor::EnableOnePressDetach_Implementation ( bool Enable )

overridevirtualinherited

Definition at line 489 of file BaseGrippableStoryActor.cpp.

◆ GENERATED_BODY()

ABaseGrippableStoryVolume::GENERATED_BODY ( )

private

◆ GetActorTransparentMaterialData()

TArray< FTransparentMaterialData > IPixoVRStoryObject::GetActorTransparentMaterialData ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Fadable")

Gets data for fading actor.

◆ GetGripStiffnessAndDamping_Implementation()

void ABaseGrippableStoryActor::GetGripStiffnessAndDamping_Implementation	(	float &	GripStiffnessOut,
		float &	GripDampingOut )

overridevirtualinherited

Implementation of the GetGripStiffnessAndDamping function from the IVRGripInterface interface. What grip stiffness and damping to use if using a physics constraint.

Definition at line 268 of file BaseGrippableStoryActor.cpp.

◆ GetObjectGrabTransform()

FTransform IPixoVRStoryObject::GetObjectGrabTransform ( APixoVRHand * GrabbedHand )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

Gets current world transform relative to selected hand for this object.

◆ GetObjectGrabTransform_Implementation()

FTransform ABaseGrippableStoryActor::GetObjectGrabTransform_Implementation ( APixoVRHand * GrabbedHand )

overridevirtualinherited

Implementation of the GetObjectGrabTransform function from the IPixoVRStoryObject interface. Gets current world transform relative to selected hand for this object.

Definition at line 111 of file BaseGrippableStoryActor.cpp.

◆ GetObjectGripAnimation()

EPixoVRGripState IGripResponseAnimationInterface::GetObjectGripAnimation ( )

inheritedBlueprintNativeEventBlueprintCallable

Gets the grip animation state of the object.

Returns: The grip animation state.

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "GripResponseAnimationInterface")

◆ GetPrimaryGripType_Implementation()

EGripCollisionType ABaseGrippableStoryActor::GetPrimaryGripType_Implementation ( bool bIsSlot )

overridevirtualinherited

Implementation of the GetPrimaryGripType function from the IVRGripInterface interface. Grip type to use.

Definition at line 248 of file BaseGrippableStoryActor.cpp.

◆ GetTwoHandProperties()

FTwoHandProperties IPixoVRStoryObject::GetTwoHandProperties ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior|Two Hands")

◆ GrabWithTwoHands()

void IPixoVRStoryObject::GrabWithTwoHands ( UMotionControllerComponent * GrabbingController )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior|Two Hands")

◆ GrabWithTwoHands_Implementation()

void ABaseGrippableStoryActor::GrabWithTwoHands_Implementation ( UMotionControllerComponent * GrabbingController )

overridevirtualinherited

Two hand grabbing logic implementation.

Definition at line 364 of file BaseGrippableStoryActor.cpp.

Here is the call graph for this function:

◆ GripBreakDistance_Implementation()

float ABaseGrippableStoryActor::GripBreakDistance_Implementation ( )

overridevirtualinherited

Implementation of the GripBreakDistance function from the IVRGripInterface interface. What distance to break a grip at (only relevent with physics enabled grips).

Definition at line 279 of file BaseGrippableStoryActor.cpp.

◆ GripLateUpdateSetting_Implementation()

EGripLateUpdateSettings ABaseGrippableStoryActor::GripLateUpdateSetting_Implementation ( )

overridevirtualinherited

Implementation of the GripLateUpdateSetting function from the IVRGripInterface interface. Define the late update setting.

Definition at line 263 of file BaseGrippableStoryActor.cpp.

◆ GripMovementReplicationType_Implementation()

EGripMovementReplicationSettings ABaseGrippableStoryActor::GripMovementReplicationType_Implementation ( )

overridevirtualinherited

Implementation of the GripMovementReplicationType function from the IVRGripInterface interface. Define which movement repliation setting to use.

Definition at line 258 of file BaseGrippableStoryActor.cpp.

◆ HandCrossDetection()

void ABaseGrippableStoryActor::HandCrossDetection	(	float	CurrentPitch,
		float	RightLeftHandVPitch )

privateinherited

Definition at line 609 of file BaseGrippableStoryActor.cpp.

Here is the caller graph for this function:

◆ HoldItemByClick()

bool IPixoVRStoryObject::HoldItemByClick ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

Determines if you need to hold object by click or holding button.

◆ IsGrabbingWrongActorActive()

bool IPixoVRStoryObject::IsGrabbingWrongActorActive ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

Determines if should send notification when the wrong interactable actor grabbed.

◆ IsGrabbingWrongActorActive_Implementation()

bool ABaseGrippableStoryActor::IsGrabbingWrongActorActive_Implementation ( )

overridevirtualinherited

Implementation of the IsGrabbingWrongActorActive function from the IPixoVRStoryObject interface. Check if should send notification when the wrong interactable actor grabbed.

Definition at line 98 of file BaseGrippableStoryActor.cpp.

◆ IsHeld_Implementation()

void ABaseGrippableStoryActor::IsHeld_Implementation	(	TArray< FBPGripPair > &	HoldingControllers,
		bool &	bIsHeld )

overridevirtualinherited

Implementation of the IsHeld function from the IVRGripInterface interface. Returns if the object is held and if so, which controllers are holding it.

Definition at line 211 of file BaseGrippableStoryActor.cpp.

◆ IsObjectActive()

bool IPixoVRStoryObject::IsObjectActive ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Story")

Returns whether object has active step/substep for current step/substep.

◆ IsObjectActive_Implementation()

bool ABaseStoryActor::IsObjectActive_Implementation ( )

overridevirtualinherited

Implementation of the IsObjectActive function from the IPixoVRStoryObject interface.

Returns: True if the object has an active step/substep for the current step/substep, false otherwise.

Definition at line 16 of file BaseStoryActor.cpp.

◆ IsObjectHeldWithTwoHands()

bool IPixoVRStoryObject::IsObjectHeldWithTwoHands ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior|Two Hands")

◆ IsObjectHeldWithTwoHands_Implementation()

bool ABaseGrippableStoryActor::IsObjectHeldWithTwoHands_Implementation ( )

overridevirtualinherited

Definition at line 466 of file BaseGrippableStoryActor.cpp.

◆ IsUsingCustomGripAnimation()

bool IGripResponseAnimationInterface::IsUsingCustomGripAnimation ( )

inheritedBlueprintNativeEventBlueprintCallable

Checks if the object is using a custom grip animation.

Returns: True if the object is using a custom grip animation, false otherwise.

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "GripResponseAnimationInterface")

◆ NewStepActivated()

void ABaseStoryActor::NewStepActivated	(	FStoryStep	NewStep,
		bool	IsForward )

protectedinherited

Callback function for when a new step is activated.

Parameters

NewStep	The newly activated step.
IsForward	True if story moving forward, false if moving backward.

UFUNCTION()

Definition at line 98 of file BaseStoryActor.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NewSubStepActivated()

void ABaseStoryActor::NewSubStepActivated ( FStoryStep NewSubStep )

protectedinherited

Callback function for when a new substep is activated.

Parameters

NewSubStep The newly activated substep.

UFUNCTION()

Definition at line 115 of file BaseStoryActor.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ObjectActivated()

void IPixoVRStoryObject::ObjectActivated ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Story")

Called if object has active step/substep for current step/substep.

◆ ObjectActivated_Implementation()

void ABaseGrippableStoryActor::ObjectActivated_Implementation ( )

overridevirtualinherited

Implementation of the ObjectActivated function from the IPixoVRStoryObject interface.

Definition at line 127 of file BaseGrippableStoryActor.cpp.

◆ ObjectDeactivated()

void IPixoVRStoryObject::ObjectDeactivated ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Story")

Called if object does not have active step/substep for current step/substep.

◆ ObjectDeactivated_Implementation()

void ABaseGrippableStoryVolume::ObjectDeactivated_Implementation ( )

overridevirtual

Implementation of the ObjectDeactivated function from the IPixoVRStoryObject interface.

Reimplemented from ABaseGrippableStoryActor.

Definition at line 34 of file BaseGrippableStoryVolume.cpp.

◆ OnGrip_Implementation()

void ABaseGrippableStoryActor::OnGrip_Implementation	(	UGripMotionControllerComponent *	GrippingController,
		const FBPActorGripInformation &	GripInformation )

overridevirtualinherited

Implementation of the OnGrip function from the IVRGripInterface interface. Event triggered on the interfaced object when gripped.

Definition at line 150 of file BaseGrippableStoryActor.cpp.

Here is the call graph for this function:

◆ OnGrippedEvent()

void ABaseGrippableStoryActor::OnGrippedEvent	(	UGripMotionControllerComponent *	GrippingController,
		const FBPActorGripInformation &	GripInformation )

inheritedBlueprintImplementableEvent

Event triggered when the object is gripped.

Parameters

GrippingController	The motion controller component that is gripping the object.
GripInformation	Information about the grip.

UFUNCTION(BlueprintImplementableEvent, Category = "Grip Events")

Here is the caller graph for this function:

◆ OnGripRelease_Implementation()

void ABaseGrippableStoryActor::OnGripRelease_Implementation	(	UGripMotionControllerComponent *	ReleasingController,
		const FBPActorGripInformation &	GripInformation,
		bool	bWasSocketed )

overridevirtualinherited

Implementation of the OnGripRelease function from the IVRGripInterface interface. Event triggered on the interfaced object when grip is released.

Definition at line 184 of file BaseGrippableStoryActor.cpp.

Here is the call graph for this function:

◆ OnHintActivated()

void ABaseStoryActor::OnHintActivated ( bool Activate )

inheritedBlueprintNativeEvent

Event called when a hint is activated.

Parameters

Activate True if the hint is being activated, false if it is being deactivated.

UFUNCTION(BlueprintNativeEvent)

Here is the caller graph for this function:

◆ OnReleasedEvent()

void ABaseGrippableStoryActor::OnReleasedEvent	(	UGripMotionControllerComponent *	ReleasingController,
		const FBPActorGripInformation &	GripInformation,
		bool	bWasSocketed )

inheritedBlueprintImplementableEvent

Event triggered when the object is released from the grip.

Parameters

ReleasingController	The motion controller component that released the object.
GripInformation	Information about the grip.
bWasSocketed	Indicates if the object was socketed before release.

UFUNCTION(BlueprintImplementableEvent, Category = "Grip Events")

Here is the caller graph for this function:

◆ OnSecondaryGrip_Implementation()

void ABaseGrippableStoryActor::OnSecondaryGrip_Implementation	(	UGripMotionControllerComponent *	GripOwningController,
		USceneComponent *	SecondaryGripComponent,
		const FBPActorGripInformation &	GripInformation )

overridevirtualinherited

Implementation of the OnSecondaryGrip function from the IVRGripInterface interface. Event triggered on the interfaced object when secondary gripped.

Definition at line 326 of file BaseGrippableStoryActor.cpp.

◆ OnSecondaryGripRelease_Implementation()

void ABaseGrippableStoryActor::OnSecondaryGripRelease_Implementation	(	UGripMotionControllerComponent *	GripOwningController,
		USceneComponent *	ReleasingSecondaryGripComponent,
		const FBPActorGripInformation &	GripInformation )

overridevirtualinherited

Implementation of the OnSecondaryGripRelease function from the IVRGripInterface interface. Event triggered on the interfaced object when secondary grip is released.

Definition at line 327 of file BaseGrippableStoryActor.cpp.

◆ PlayGripSound()

void ABaseGrippableStoryActor::PlayGripSound ( ) const

privateinherited

Definition at line 525 of file BaseGrippableStoryActor.cpp.

Here is the caller graph for this function:

◆ PlayHapticFeedbackEffect()

void ABaseGrippableStoryActor::PlayHapticFeedbackEffect ( UGripMotionControllerComponent * GripMotionControllerComponent ) const

privateinherited

Plays haptic feedback on specific controller.

Parameters

GripMotionControllerComponent The motion controller component that is gripping the object.

Definition at line 509 of file BaseGrippableStoryActor.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PlayReleaseSound()

void ABaseGrippableStoryActor::PlayReleaseSound ( ) const

privateinherited

Definition at line 533 of file BaseGrippableStoryActor.cpp.

Here is the caller graph for this function:

◆ ReleaseItemByPress()

bool IPixoVRStoryObject::ReleaseItemByPress ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

Determines if you need to release object by press button.

◆ ReleaseTwoHands()

void IPixoVRStoryObject::ReleaseTwoHands ( UMotionControllerComponent * ReleasingController )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior|Two Hands")

◆ ReleaseTwoHands_Implementation()

void ABaseGrippableStoryActor::ReleaseTwoHands_Implementation ( UMotionControllerComponent * ReleasingController )

overridevirtualinherited

Definition at line 405 of file BaseGrippableStoryActor.cpp.

◆ ResetPosition()

void ABaseGrippableStoryActor::ResetPosition ( )

inheritedBlueprintCallable

Resetting object to the position it has ben grabbed off.

UFUNCTION(BlueprintCallable, Category = "GrippableObject")

Definition at line 61 of file BaseGrippableStoryActor.cpp.

Here is the caller graph for this function:

◆ ResetTwoHandsHoldingFunctionality()

void IPixoVRStoryObject::ResetTwoHandsHoldingFunctionality ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior|Two Hands")

◆ ResetTwoHandsHoldingFunctionality_Implementation()

void ABaseGrippableStoryActor::ResetTwoHandsHoldingFunctionality_Implementation ( )

overridevirtualinherited

Definition at line 471 of file BaseGrippableStoryActor.cpp.

◆ SecondaryGripType_Implementation()

ESecondaryGripType ABaseGrippableStoryActor::SecondaryGripType_Implementation ( )

overridevirtualinherited

Implementation of the SecondaryGripType function from the IVRGripInterface interface. Secondary grip type.

Definition at line 253 of file BaseGrippableStoryActor.cpp.

◆ SendWrongGrabbingNotification()

void IPixoVRStoryObject::SendWrongGrabbingNotification ( )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

Called to send wrong grabbing notification.

◆ SendWrongGrabbingNotification_Implementation()

void ABaseGrippableStoryActor::SendWrongGrabbingNotification_Implementation ( )

overridevirtualinherited

Implementation of the SendErrorGrabbingNotification function from the IPixoVRStoryObject interface. Send error grabbing notification when the wrong interactable actor is grabbed.

Definition at line 103 of file BaseGrippableStoryActor.cpp.

◆ SetDenyDropping()

void IPixoVRStoryObject::SetDenyDropping ( const bool bDenyDropping )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Grip Behavior")

Update flag indicate whether if user can drop this object.

◆ SetHeld_Implementation()

void ABaseGrippableStoryActor::SetHeld_Implementation	(	UGripMotionControllerComponent *	HoldingController,
		uint8	GripID,
		bool	bIsHeld )

overridevirtualinherited

Implementation of the SetHeld function from the IVRGripInterface interface. Sets is held, used by the plugin.

Definition at line 217 of file BaseGrippableStoryActor.cpp.

◆ SetIsActive()

void ABaseGrippableStoryVolume::SetIsActive ( bool bNewIsActive )

BlueprintCallable

Setter for bIsActive property, also updates collision state for BoxCollisionComponent.

UFUNCTION(BlueprintCallable, Category = "GrippableVolume")

Definition at line 17 of file BaseGrippableStoryVolume.cpp.

Here is the caller graph for this function:

◆ SimulateOnDrop_Implementation()

bool ABaseGrippableStoryActor::SimulateOnDrop_Implementation ( )

overridevirtualinherited

Implementation of the SimulateOnDrop function from the IVRGripInterface interface. Should this object simulate on drop.

Definition at line 243 of file BaseGrippableStoryActor.cpp.

◆ StartPositionResetTimer()

void ABaseGrippableStoryActor::StartPositionResetTimer ( )

inheritedBlueprintCallable

Stopping new position reset check timer.

UFUNCTION(BlueprintCallable, Category = "GrippableObject")

Definition at line 50 of file BaseGrippableStoryActor.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StepSkipped()

void ABaseStoryActor::StepSkipped	(	FStoryStep	SkippedStep,
		bool	IsForward )

inheritedBlueprintNativeEvent

Event called when a step is skipped.

Parameters

SkippedStep	The skipped step.
IsForward	True if skipping story forward, false if skipping backward.

UFUNCTION(BlueprintNativeEvent)

Here is the caller graph for this function:

◆ StopPositionResetTimer()

void ABaseGrippableStoryActor::StopPositionResetTimer ( )

inheritedBlueprintCallable

Stopping the current position reset check timer.

UFUNCTION(BlueprintCallable, Category = "GrippableObject")

Definition at line 56 of file BaseGrippableStoryActor.cpp.

Here is the caller graph for this function:

◆ TeleportBehavior_Implementation()

EGripInterfaceTeleportBehavior ABaseGrippableStoryActor::TeleportBehavior_Implementation ( )

overridevirtualinherited

Implementation of the TeleportBehavior function from the IVRGripInterface interface. How an interfaced object behaves when teleporting.

Definition at line 238 of file BaseGrippableStoryActor.cpp.

◆ TwoHandGrab()

void ABaseGrippableStoryActor::TwoHandGrab ( )

privateinherited

Definition at line 541 of file BaseGrippableStoryActor.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateHandGripLogic()

void ABaseGrippableStoryActor::UpdateHandGripLogic ( EHandGripLogic NewHandGripLogic )

inheritedBlueprintCallable

Updates the hand grip logic.

Parameters

NewHandGripLogic The new hand grip logic to set.

UFUNCTION(BlueprintCallable, Category = "GrippableObject")

Definition at line 297 of file BaseGrippableStoryActor.cpp.

Here is the caller graph for this function:

◆ UpdateObjectHighlight()

void IPixoVRStoryObject::UpdateObjectHighlight ( bool Activate )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "Hint")

Called to update object highlight.

◆ UpdateObjectHighlight_Implementation()

void ABaseGrippableStoryActor::UpdateObjectHighlight_Implementation ( bool Activate )

overridevirtualinherited

Implementation of the UpdateObjectHighlight function from the IPixoVRStoryObject interface.

Definition at line 494 of file BaseGrippableStoryActor.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ ActiveStepsAcquiredFromParent

bool ABaseStoryActor::ActiveStepsAcquiredFromParent = false

inherited

Definition at line 61 of file BaseStoryActor.h.

◆ AlwaysActive

bool ABaseGrippableStoryVolume::AlwaysActive

EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Determines whether the volume is always active regardless of the story progress.

Definition at line 40 of file BaseGrippableStoryVolume.h.

◆ bActivateLocationResetAfterDrop

bool ABaseGrippableStoryActor::bActivateLocationResetAfterDrop { false }

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "GrippableObject")

Determines if object position should be reset after drop.

Definition at line 358 of file BaseGrippableStoryActor.h.

◆ bCanResetPosition

bool ABaseGrippableStoryActor::bCanResetPosition { true }

inheritedBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, Category = "GrippableObject")

Flag for preventing this object from resetting position even if ResetPosition is called.

Definition at line 364 of file BaseGrippableStoryActor.h.

◆ bDestroyActorAfterFailedDrop

bool ABaseGrippableStoryActor::bDestroyActorAfterFailedDrop { false }

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "GrippableObject")

Determines whether to destroy the actor on failure drop

Definition at line 371 of file BaseGrippableStoryActor.h.

◆ bFeedbackEnabled

bool ABaseGrippableStoryActor::bFeedbackEnabled

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect")

Set true if feedback effect should be played when this actor is gripped or released.

Definition at line 330 of file BaseGrippableStoryActor.h.

◆ bGripSoundsEnabled

bool ABaseGrippableStoryActor::bGripSoundsEnabled

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect")

Set true if sound effects should be played when this actor is gripped.

Definition at line 302 of file BaseGrippableStoryActor.h.

◆ bIsActive

bool ABaseGrippableStoryVolume::bIsActive

private

Determines whether the volume is active, use SetIsActive to update its value.

Definition at line 59 of file BaseGrippableStoryVolume.h.

◆ BoxCollisionComponent

UBoxComponent* ABaseGrippableStoryVolume::BoxCollisionComponent

EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")

Box collision component for defining the grip area.

Definition at line 33 of file BaseGrippableStoryVolume.h.

◆ bReleaseSoundsEnabled

bool ABaseGrippableStoryActor::bReleaseSoundsEnabled

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect")

Set true if sound effects should be played when this actor is released.

Definition at line 316 of file BaseGrippableStoryActor.h.

◆ bSaveResetTransformOnGrip

bool ABaseGrippableStoryActor::bSaveResetTransformOnGrip { true }

privateinherited

Flag for preventing this objet from saving ResetTransform.

Definition at line 454 of file BaseGrippableStoryActor.h.

◆ ChildClassesThatAcquiredPopulatedData

TArray<TSubclassOf<ABaseStoryActor> > ABaseStoryActor::ChildClassesThatAcquiredPopulatedData

inheritedBlueprintReadWriteEditDefaultsOnly

UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "BaseStoryActor|DynamicStory", meta = (EditCondition = "IsAutoStepDataPopulationActive == true", EditConditionHides))

Definition at line 59 of file BaseStoryActor.h.

◆ CrossChanged

bool ABaseGrippableStoryActor::CrossChanged

privateinherited

Definition at line 473 of file BaseGrippableStoryActor.h.

◆ CrossDetected

bool ABaseGrippableStoryActor::CrossDetected

privateinherited

Definition at line 472 of file BaseGrippableStoryActor.h.

◆ CurrentHoldingHand

APixoVRHand* ABaseGrippableStoryActor::CurrentHoldingHand

inheritedVisibleInstanceOnlyBlueprintReadWrite

UPROPERTY(VisibleInstanceOnly, BlueprintReadWrite, Category = "GrippableObject")

The currently holding hand reference.

Definition at line 276 of file BaseGrippableStoryActor.h.

◆ EnableOnePressDetach

bool ABaseGrippableStoryActor::EnableOnePressDetach

privateinherited

Definition at line 482 of file BaseGrippableStoryActor.h.

◆ GripSoundCue

USoundCue* ABaseGrippableStoryActor::GripSoundCue

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect", meta = (EditCondition = "bGripSoundsEnabled", EditConditionHides))

Definition at line 309 of file BaseGrippableStoryActor.h.

◆ HandGripLogic

EHandGripLogic ABaseGrippableStoryActor::HandGripLogic

inheritedEditDefaultsOnlyBlueprintReadWrite

UPROPERTY(EditDefaultsOnly, BlueprintReadWrite, Category = "GrippableObject")

Logic for handling hand grip behavior.

Definition at line 270 of file BaseGrippableStoryActor.h.

◆ HapticDuration

float ABaseGrippableStoryActor::HapticDuration

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect", meta=(EditCondition = "bFeedbackEnabled", EditConditionHides))

Duration of haptic effect.

Definition at line 337 of file BaseGrippableStoryActor.h.

◆ HapticStrength

float ABaseGrippableStoryActor::HapticStrength

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect", meta=(EditCondition = "bFeedbackEnabled", EditConditionHides))

Strength of haptic effect.

Definition at line 344 of file BaseGrippableStoryActor.h.

◆ HighlightComponent

UHighlightComponent* ABaseStoryActor::HighlightComponent

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Component responsible for highlighting the actor.

Definition at line 39 of file BaseStoryActor.h.

◆ HintManager

UHintManager* ABaseStoryActor::HintManager

inheritedBlueprintReadWrite

UPROPERTY(BlueprintReadWrite)

Manager for handling hints related to the actor.

Definition at line 45 of file BaseStoryActor.h.

◆ IsAutoStepDataPopulationActive

bool ABaseStoryActor::IsAutoStepDataPopulationActive = false

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "BaseStoryActor|DynamicStory")

New BaseStoryActor will receive StorySteps from InteractiveObjectStoryStep data base.

Definition at line 52 of file BaseStoryActor.h.

◆ MoveBackPitchDelta

float ABaseGrippableStoryActor::MoveBackPitchDelta = 0

privateinherited

Definition at line 475 of file BaseGrippableStoryActor.h.

◆ ObjectHeldWithTwoHands

bool ABaseGrippableStoryActor::ObjectHeldWithTwoHands = false

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Two Hands Grip")

Definition at line 263 of file BaseGrippableStoryActor.h.

◆ ObjectTransformInLeftHand

FTransform ABaseGrippableStoryActor::ObjectTransformInLeftHand

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "GrippableObject")

The object's transform when held in the left hand.

Definition at line 282 of file BaseGrippableStoryActor.h.

◆ ObjectTransformInRightHand

FTransform ABaseGrippableStoryActor::ObjectTransformInRightHand

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "GrippableObject")

The object's transform when held in the right hand.

Definition at line 288 of file BaseGrippableStoryActor.h.

◆ OnActorPositionResetDelegate

FOnActorStopped ABaseGrippableStoryActor::OnActorPositionResetDelegate

inheritedBlueprintCallableBlueprintReadWriteBlueprintAssignable

UPROPERTY(BlueprintReadWrite, BlueprintCallable, BlueprintAssignable)

Delegate for actor position reset event.

Definition at line 407 of file BaseGrippableStoryActor.h.

◆ OnActorStoppedDelegate

FOnActorStopped ABaseGrippableStoryActor::OnActorStoppedDelegate

inheritedBlueprintCallableBlueprintReadWriteBlueprintAssignable

UPROPERTY(BlueprintReadWrite, BlueprintCallable, BlueprintAssignable)

Delegate for actor stopped event.

Definition at line 399 of file BaseGrippableStoryActor.h.

◆ OnDropped

FVROnDropSignature ABaseGrippableStoryActor::OnDropped

inheritedBlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "Grip Events")

Called when a object is dropped

Definition at line 174 of file BaseGrippableStoryActor.h.

◆ OnDroppedActorDeleted

FOnDroppedActorDeleted ABaseGrippableStoryActor::OnDroppedActorDeleted

inheritedBlueprintCallableBlueprintReadWriteBlueprintAssignable

UPROPERTY(BlueprintReadWrite, BlueprintCallable, BlueprintAssignable)

Delegate for dropped actor.

Definition at line 415 of file BaseGrippableStoryActor.h.

◆ OnGripped

FVROnGripSignature ABaseGrippableStoryActor::OnGripped

inheritedBlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "Grip Events")

Called when a object is gripped

Definition at line 169 of file BaseGrippableStoryActor.h.

◆ OnSecondaryGripAdded

FVROnGripSignature ABaseGrippableStoryActor::OnSecondaryGripAdded

inheritedBlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "Grip Events")

Called when an object we hold is secondary gripped

Definition at line 180 of file BaseGrippableStoryActor.h.

◆ OnSecondaryGripRemoved

FVROnGripSignature ABaseGrippableStoryActor::OnSecondaryGripRemoved

inheritedBlueprintAssignable

UPROPERTY(BlueprintAssignable, Category = "Grip Events")

Called when an object we hold is secondary dropped

Definition at line 186 of file BaseGrippableStoryActor.h.

◆ PitchBeforeCross

float ABaseGrippableStoryActor::PitchBeforeCross = 0

privateinherited

Definition at line 474 of file BaseGrippableStoryActor.h.

◆ PixoVRHandLeft

TWeakObjectPtr<APixoVRHand> ABaseGrippableStoryActor::PixoVRHandLeft

privateinherited

Definition at line 477 of file BaseGrippableStoryActor.h.

◆ PixoVRHandRight

TWeakObjectPtr<APixoVRHand> ABaseGrippableStoryActor::PixoVRHandRight

privateinherited

Definition at line 478 of file BaseGrippableStoryActor.h.

◆ PositionResetCheckRate

float ABaseGrippableStoryActor::PositionResetCheckRate { 0.1f }

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "GrippableObject")

Rate for position reset check timer.

Definition at line 384 of file BaseGrippableStoryActor.h.

◆ PositionResetMaximumDelay

float ABaseGrippableStoryActor::PositionResetMaximumDelay { 5.0f }

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "GrippableObject")

Maximum delay after which position of the item will be reset.

Definition at line 391 of file BaseGrippableStoryActor.h.

◆ PositionResetTimer

FTimerHandle ABaseGrippableStoryActor::PositionResetTimer

privateinherited

Internal timer for checking object's conditions for position reset.

Definition at line 458 of file BaseGrippableStoryActor.h.

◆ ReleaseSoundCue

USoundCue* ABaseGrippableStoryActor::ReleaseSoundCue

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "Feedback Effect", meta = (EditCondition = "bReleaseSoundsEnabled", EditConditionHides))

Definition at line 323 of file BaseGrippableStoryActor.h.

◆ ResetTransform

FTransform ABaseGrippableStoryActor::ResetTransform

inheritedBlueprintReadOnly

UPROPERTY(BlueprintReadOnly, Category = "GrippableObject")

Transform for resetting position after object drop.

Definition at line 377 of file BaseGrippableStoryActor.h.

◆ ResultedPitch

float ABaseGrippableStoryActor::ResultedPitch = 0

privateinherited

Definition at line 476 of file BaseGrippableStoryActor.h.

◆ SpecificVolumeName

FText ABaseGrippableStoryVolume::SpecificVolumeName

EditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite)

Definition at line 47 of file BaseGrippableStoryVolume.h.

◆ StaticMeshComponent

UStaticMeshComponent* ABaseGrippableStoryActor::StaticMeshComponent

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "Components")

Definition at line 295 of file BaseGrippableStoryActor.h.

◆ Story

UStoryComponent* ABaseStoryActor::Story

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, EditAnywhere)

Component responsible for managing the story.

Definition at line 32 of file BaseStoryActor.h.

◆ StoryActivationAffectsDenyGripping

bool ABaseGrippableStoryActor::StoryActivationAffectsDenyGripping { true }

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "GrippableObject")

Determines if object's story activation and deactivation can affect bDenyGripping variable.

Definition at line 351 of file BaseGrippableStoryActor.h.

◆ TimeSinceResetTimerStarted

float ABaseGrippableStoryActor::TimeSinceResetTimerStarted { 0.0f }

privateinherited

Time that accumulates after PositionResetTimer has started.

Definition at line 456 of file BaseGrippableStoryActor.h.

◆ TwoHandMainGrabController

TWeakObjectPtr<UMotionControllerComponent> ABaseGrippableStoryActor::TwoHandMainGrabController

privateinherited

Definition at line 481 of file BaseGrippableStoryActor.h.

◆ TwoHandTimer

FTimerHandle ABaseGrippableStoryActor::TwoHandTimer

privateinherited

Definition at line 480 of file BaseGrippableStoryActor.h.

◆ TwoHandZAxisValue

float ABaseGrippableStoryActor::TwoHandZAxisValue = 0.0

privateinherited

Definition at line 479 of file BaseGrippableStoryActor.h.

◆ VRGripInterfaceSettings

FBPInterfaceProperties ABaseGrippableStoryActor::VRGripInterfaceSettings

inheritedEditAnywhereBlueprintReadWrite

UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = "VRGripInterface")

Settings for IVRGripInterface functions.

Definition at line 193 of file BaseGrippableStoryActor.h.

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

PixoCore/Source/PixoCore/Public/InteractableObjects/BaseGrippableStoryVolume.h
PixoCore/Source/PixoCore/Private/InteractableObjects/BaseGrippableStoryVolume.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ABaseGrippableStoryVolume()

Member Function Documentation

◆ ActivateHighlightOnActiveStep()

◆ AdvancedGripSettings_Implementation()

◆ AllowsMultipleGrips_Implementation()

◆ AttachToHandObject()

◆ BeginPlay()

◆ CheckPositionResetConditions()

◆ ClosestGripSlotInRange_Implementation()

◆ CouldBeGrabbedByOtherHand()

◆ CouldBeGrabbedWithTwoHands()

◆ DenyDropping()

◆ DenyGripping_Implementation()

◆ DetachObjectFromHand()

◆ EnableOnePressDetach()

◆ EnableOnePressDetach_Implementation()

◆ GENERATED_BODY()

◆ GetActorTransparentMaterialData()

◆ GetGripStiffnessAndDamping_Implementation()

◆ GetObjectGrabTransform()

◆ GetObjectGrabTransform_Implementation()

◆ GetObjectGripAnimation()

◆ GetPrimaryGripType_Implementation()

◆ GetTwoHandProperties()

◆ GrabWithTwoHands()

◆ GrabWithTwoHands_Implementation()

◆ GripBreakDistance_Implementation()

◆ GripLateUpdateSetting_Implementation()

◆ GripMovementReplicationType_Implementation()

◆ HandCrossDetection()

◆ HoldItemByClick()

◆ IsGrabbingWrongActorActive()

◆ IsGrabbingWrongActorActive_Implementation()

◆ IsHeld_Implementation()

◆ IsObjectActive()

◆ IsObjectActive_Implementation()

◆ IsObjectHeldWithTwoHands()

◆ IsObjectHeldWithTwoHands_Implementation()

◆ IsUsingCustomGripAnimation()

◆ NewStepActivated()

◆ NewSubStepActivated()

◆ ObjectActivated()

◆ ObjectActivated_Implementation()

◆ ObjectDeactivated()

◆ ObjectDeactivated_Implementation()

◆ OnGrip_Implementation()

◆ OnGrippedEvent()

◆ OnGripRelease_Implementation()

◆ OnHintActivated()

◆ OnReleasedEvent()

◆ OnSecondaryGrip_Implementation()

◆ OnSecondaryGripRelease_Implementation()

◆ PlayGripSound()

◆ PlayHapticFeedbackEffect()

◆ PlayReleaseSound()

◆ ReleaseItemByPress()

◆ ReleaseTwoHands()

◆ ReleaseTwoHands_Implementation()

◆ ResetPosition()

◆ ResetTwoHandsHoldingFunctionality()

◆ ResetTwoHandsHoldingFunctionality_Implementation()

◆ SecondaryGripType_Implementation()

◆ SendWrongGrabbingNotification()

◆ SendWrongGrabbingNotification_Implementation()

◆ SetDenyDropping()

◆ SetHeld_Implementation()

◆ SetIsActive()

◆ SimulateOnDrop_Implementation()

◆ StartPositionResetTimer()

◆ StepSkipped()

◆ StopPositionResetTimer()

◆ TeleportBehavior_Implementation()

◆ TwoHandGrab()