APixoVRToolBase Class Reference

Base class for PixoVR tools. More...

#include <PixoVRToolBase.h>

Inheritance diagram for APixoVRToolBase:

Public Member Functions
	APixoVRToolBase ()
FBPAdvGripSettings	AdvancedGripSettings ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
bool	AllowsMultipleGrips ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
bool	CanExitsWithoutOwner () const
void	ClosestGripSlotInRange (FVector WorldLocation, bool bSecondarySlot, bool &bHadSlotInRange, FTransform &SlotWorldTransform, FName &SlotName, UGripMotionControllerComponent *CallingController=nullptr, FName OverridePrefix=NAME_None)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
bool	DenyDropping ()
	Deny dropping. If this is set to true the actor will not be dropped after releasing until set to false again.
virtual bool	DenyDropping_Implementation () override
bool	DenyGripping (UGripMotionControllerComponent *GripInitiator=nullptr)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface", meta = (DisplayName = "IsDenyingGrips"))
bool	DenyGrippingPixoVR (UGripMotionControllerComponent *GrippingController)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
virtual bool	DenyGrippingPixoVR_Implementation (UGripMotionControllerComponent *GrippingController) override
bool	DenyTriggerGripping ()
	Deny gripping after triggering grip.
virtual bool	DenyTriggerGripping_Implementation () override
bool	DestroyOnExit ()
bool	DisablePhysicsOnDrop ()
	Disable Physics on Drop. When this is set to 'true' if user drops object it will disable physics else it will use default.
virtual bool	DisablePhysicsOnDrop_Implementation () override
bool	GetGripScripts (TArray< UVRGripScriptBase * > &ArrayReference)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
void	GetGripStiffnessAndDamping (float &GripStiffnessOut, float &GripDampingOut)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
virtual void	GetLifetimeReplicatedProps (TArray< FLifetimeProperty > &OutLifetimeProps) const override
EGripCollisionType	GetPrimaryGripType (bool bIsSlot)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
float	GripBreakDistance ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
EGripLateUpdateSettings	GripLateUpdateSetting ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
void	GripMode (EPixoVRGripModeEnum &GripMode)
	Will be used to determine how to do the grabbing. Using normal attachment or a physics constraint.
virtual void	GripMode_Implementation (EPixoVRGripModeEnum &GripMode) override
EGripMovementReplicationSettings	GripMovementReplicationType ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
void	GripTriggerMode (EPixoVRGripTriggerModeEnum &GripTriggerMode)
	Will be used to determine how the gripping trigger should behave.
virtual void	GripTriggerMode_Implementation (EPixoVRGripTriggerModeEnum &GripTriggerMode) override
void	GripTriggerTransform (UGripMotionControllerComponent *GrippingController, bool &bUseCustomTransform, FTransform &CustomTransform)
	This specified transformation will be used when flag is set and a grip is happening.
virtual void	GripTriggerTransform_Implementation (UGripMotionControllerComponent *GrippingController, bool &bUseCustomTransform, FTransform &CustomTransform) override
void	HandleDestroy ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVRToolbox | Tools")
void	InitializeTool (const FPixoToolData &InToolData)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVRToolbox | Tools")
virtual void	InitializeTool_Implementation (const FPixoToolData &InToolData) override
bool	IsDestroyable ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVRToolbox | Tools")
bool	IsGripped ()
	UFUNCTION(BlueprintCallable, Category = Tool)
void	IsHeld (TArray< FBPGripPair > &HoldingControllers, bool &bIsHeld)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
virtual void	Native_NotifyThrowGripDelegates (UGripMotionControllerComponent *Controller, bool bGripped, const FBPActorGripInformation &GripInformation, bool bWasSocketed=false)
void	OnChildGrip (UGripMotionControllerComponent *GrippingController, const FBPActorGripInformation &GripInformation)
	UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
void	OnChildGripRelease (UGripMotionControllerComponent *ReleasingController, const FBPActorGripInformation &GripInformation, bool bWasSocketed=false)
	UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
void	OnEndSecondaryUsed ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
void	OnEndUsed ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
void	OnGrip (UGripMotionControllerComponent *GrippingController, const FBPActorGripInformation &GripInformation)
	UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
void	OnGripObject (UGripMotionControllerComponent *GrippingController, AActor *GrippedActor)
	Will be called when user grabs an object.
virtual void	OnGripObject_Implementation (UGripMotionControllerComponent *GrippingController, AActor *GrippedActor) override
void	OnGripObjectRelease (UGripMotionControllerComponent *GrippingController, AActor *GrippedActor)
	Will be called when the user releases an object.
virtual void	OnGripObjectRelease_Implementation (UGripMotionControllerComponent *GrippingController, AActor *GrippedActor) override
void	OnGripRelease (UGripMotionControllerComponent *ReleasingController, const FBPActorGripInformation &GripInformation, bool bWasSocketed=false)
	UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
void	OnInput (FKey Key, EInputEvent KeyEvent)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
void	OnObjectPaused ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
virtual void	OnObjectPaused_Implementation () override
void	OnObjectUnPaused ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")
virtual void	OnObjectUnPaused_Implementation () override
void	OnSecondaryGrip (UGripMotionControllerComponent *GripOwningController, USceneComponent *SecondaryGripComponent, const FBPActorGripInformation &GripInformation)
	UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
void	OnSecondaryGripRelease (UGripMotionControllerComponent *GripOwningController, USceneComponent *ReleasingSecondaryGripComponent, const FBPActorGripInformation &GripInformation)
	UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
void	OnSecondaryUsed ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
void	OnTryGripObject (UGripMotionControllerComponent *GrippingController, AActor *GrippedActor)
	Will be called when user tried to grab the object.
virtual void	OnTryGripObject_Implementation (UGripMotionControllerComponent *GrippingController, AActor *GrippedActor) override
void	OnUsed ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
void	PairSecondaryTool (AActor *SecondaryTool)
	Binds a secondary tool to the primary tool.
bool	RequestsSocketing (USceneComponent *&ParentToSocketTo, FName &OptionalSocketName, FTransform_NetQuantize &RelativeTransform)
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
ESecondaryGripType	SecondaryGripType ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
void	SetHeld (UGripMotionControllerComponent *HoldingController, uint8 GripID, bool bIsHeld)
	UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
bool	SimulateOnDrop ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
EGripInterfaceTeleportBehavior	TeleportBehavior ()
	UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface")
void	TickGrip (UGripMotionControllerComponent *GrippingController, const FBPActorGripInformation &GripInformation, float DeltaTime)
	UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")
void	ToggleState (EControllerHand Hand)
	Wraps the toggle on and off functionality of the tool.
void	Use (bool InActivate, EControllerHand Hand)
	Wraps the usable functionality of the tool.

Protected Member Functions
virtual void	BeginPlay () override
bool	IsRightHand (UGripMotionControllerComponent *GrippingController) const
virtual void	OnOverlapBegin (UPrimitiveComponent *OverlappedComp, AActor *OtherActor, UPrimitiveComponent *OtherComp, int32 OtherBodyIndex, bool FromSweep, const FHitResult &SweepResult)
	UFUNCTION()
void	ServerAdjustPlayingSoundVolumeViaComponent (float InVolumeMultiplier=1.0f)
	UFUNCTION(Server, Reliable, WithValidation)
void	ServerOnDropped ()
	UFUNCTION(Server, Reliable, WithValidation)
void	ServerStartPlayingSound (USoundBase *Sound, const FVector &SoundLocation, float VolumeMultiplier=1.0f)
	UFUNCTION(Server, Reliable, WithValidation)
void	ServerStartPlayingSoundViaComponent (USoundBase *Sound, float VolumeMultiplier=1.0f)
	UFUNCTION(Server, Reliable, WithValidation)
void	ServerStopPlayingSound (USoundBase *Sound)
	UFUNCTION(Server, Reliable, WithValidation)
void	ServerStopPlayingSoundViaComponent ()
	UFUNCTION(Server, Reliable, WithValidation)
virtual void	Tick (float DeltaSeconds) override

Protected Attributes
UAudioComponent *	AudioComponent
	UPROPERTY(VisibleAnywhere, Category = Tool)
bool	bAdvancedDrop
	UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = DropBehavior)
bool	bDestroyOnDrop
	UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = DropBehavior)
bool	bDestroyOnExit
	UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = DropBehavior)
bool	bIsGripAllowed
	UPROPERTY(BlueprintReadOnly, Category = GripBehavior)
bool	bIsGripped
	UPROPERTY(Replicated, BlueprintReadOnly, Category = GripBehavior)
bool	bIsPaused
	UPROPERTY(Replicated, BlueprintReadOnly, Category = ToolBehavior)
bool	bToggleCollisionOnUsage
	UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = GripBehavior)
USoundAttenuation *	DefaultAttenuationSettings
	UPROPERTY()
float	DestroyDelay
	UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = DropBehavior)
struct {
bool   bIsPendingKill
float   TimeBeforeKilled
}	DestroyState
UBoxComponent *	GrabBoxComponent
	UPROPERTY(VisibleAnywhere, Category = Tool)
EControllerHand	GrabHand
	UPROPERTY(Replicated, BlueprintReadOnly, Category = GripBehavior)
USoundBase *	GripSound
	UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = GripBehavior)
FTransform	LeftHandGrip
	UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = TransformOffset)
FGripAction	OnGripAction
FTransform	RightHandGrip
	UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = TransformOffset)
FPixoToolData	ToolData
	UPROPERTY(Replicated, BlueprintReadOnly, Category = ToolData)
UStaticMeshComponent *	ToolMeshComponent
	UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = Tool)

Private Member Functions
	GENERATED_BODY ()
	GENERATED_IINTERFACE_BODY ()
USoundAttenuation *	GetDefaultAttenuationSettings ()
void	MulticastAdjustPlayingSoundVolumeViaComponent (float InVolumeMultiplier)
	UFUNCTION(NetMulticast, Reliable)
void	MulticastStartPlayingSound (USoundBase *Sound, const FVector &SoundLocation, float VolumeMultiplier)
	UFUNCTION(NetMulticast, Reliable)
void	MulticastStartPlayingSoundViaComponent (USoundBase *Sound, float VolumeMultiplier)
	UFUNCTION(NetMulticast, Reliable)
void	MulticastStopPlayingSound (USoundBase *Sound)
	UFUNCTION(NetMulticast, Reliable)
void	MulticastStopPlayingSoundViaComponent ()
	UFUNCTION(NetMulticast, Reliable)
void	MulticastToggleCollision (ECollisionEnabled::Type Type)
	UFUNCTION(NetMulticast, Reliable)
void	ServerDestroyTool ()
	UFUNCTION(Server, Reliable, WithValidation)
void	ServerUseTool (UGripMotionControllerComponent *GrippingController, AActor *GrippedActor)
	UFUNCTION(Server, Reliable, WithValidation)

Detailed Description

Base class for PixoVR tools.

Todo

We need to update it because we have an ABaseGrippableStoryActor.

UCLASS(Blueprintable, ClassGroup = ToolMenu)

Definition at line 26 of file PixoVRToolBase.h.

Constructor & Destructor Documentation

APixoVRToolBase()

APixoVRToolBase::APixoVRToolBase

(

)

Definition at line 16 of file PixoVRToolBase.cpp.

Member Function Documentation

AdvancedGripSettings()

FBPAdvGripSettings IVRGripInterface::AdvancedGripSettings ( )

inheritedBlueprintNativeEventBlueprintCallable

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

AllowsMultipleGrips()

bool IVRGripInterface::AllowsMultipleGrips ( )

inheritedBlueprintNativeEventBlueprintCallable

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

BeginPlay()

void APixoVRToolBase::BeginPlay ( )

overrideprotectedvirtual

Definition at line 44 of file PixoVRToolBase.cpp.

Here is the call graph for this function:

CanExitsWithoutOwner()

bool APixoVRToolBase::CanExitsWithoutOwner ( ) const

inline

Definition at line 235 of file PixoVRToolBase.h.

ClosestGripSlotInRange()

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

inheritedBlueprintNativeEventBlueprintCallable

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

Called to get the closest grip socket in range

Parameters

WorldLocation	- World Location to check near
bSecondarySlot	- True if this is a check for a secondary slot or not
CallingController	- Controller checking for the slot (can be used in overrides for per hand checks)
OverridePrefix	- A different substring to check against in the socket names to find relevant ones

DenyDropping()

bool APixoVRToolBase::DenyDropping ( )

BlueprintNativeEventBlueprintCallable

Deny dropping. If this is set to true the actor will not be dropped after releasing until set to false again.

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")

DenyDropping_Implementation()

bool APixoVRToolBase::DenyDropping_Implementation ( )

overridevirtual

Definition at line 143 of file PixoVRToolBase.cpp.

DenyGripping()

bool IVRGripInterface::DenyGripping ( UGripMotionControllerComponent * GripInitiator = nullptr )

inheritedBlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "VRGripInterface", meta = (DisplayName = "IsDenyingGrips"))

DenyGrippingPixoVR()

bool APixoVRToolBase::DenyGrippingPixoVR ( UGripMotionControllerComponent * GrippingController )

BlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")

IPixoVRGripInterface Implementation Deny gripping. If this is set to true the actor can't be gripped anymore until set the false again.

DenyGrippingPixoVR_Implementation()

bool APixoVRToolBase::DenyGrippingPixoVR_Implementation ( UGripMotionControllerComponent * GrippingController )

overridevirtual

Definition at line 133 of file PixoVRToolBase.cpp.

DenyTriggerGripping()

bool APixoVRToolBase::DenyTriggerGripping ( )

BlueprintNativeEventBlueprintCallable

Deny gripping after triggering grip.

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")

DenyTriggerGripping_Implementation()

bool APixoVRToolBase::DenyTriggerGripping_Implementation ( )

overridevirtual

Definition at line 138 of file PixoVRToolBase.cpp.

DestroyOnExit()

bool APixoVRToolBase::DestroyOnExit ( )

inline

Definition at line 234 of file PixoVRToolBase.h.

DisablePhysicsOnDrop()

bool APixoVRToolBase::DisablePhysicsOnDrop ( )

BlueprintNativeEventBlueprintCallable

Disable Physics on Drop. When this is set to 'true' if user drops object it will disable physics else it will use default.

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")

DisablePhysicsOnDrop_Implementation()

bool APixoVRToolBase::DisablePhysicsOnDrop_Implementation ( )

overridevirtual

Definition at line 173 of file PixoVRToolBase.cpp.

GENERATED_BODY()

APixoVRToolBase::GENERATED_BODY ( )

private

GENERATED_IINTERFACE_BODY()

IVRGripInterface::GENERATED_IINTERFACE_BODY ( )

privateinherited

GetDefaultAttenuationSettings()

USoundAttenuation * APixoVRToolBase::GetDefaultAttenuationSettings ( )

private

Definition at line 430 of file PixoVRToolBase.cpp.

GetGripScripts()

bool IVRGripInterface::GetGripScripts ( TArray< UVRGripScriptBase * > & ArrayReference )

inheritedBlueprintNativeEventBlueprintCallable

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

GetGripStiffnessAndDamping()

void IVRGripInterface::GetGripStiffnessAndDamping ( float & GripStiffnessOut, float & GripDampingOut )

inheritedBlueprintNativeEventBlueprintCallable

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

GetLifetimeReplicatedProps()

void APixoVRToolBase::GetLifetimeReplicatedProps ( TArray< FLifetimeProperty > & OutLifetimeProps ) const

overridevirtual

Definition at line 98 of file PixoVRToolBase.cpp.

GetPrimaryGripType()

EGripCollisionType IVRGripInterface::GetPrimaryGripType ( bool bIsSlot )

inheritedBlueprintNativeEventBlueprintCallable

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

GripBreakDistance()

float IVRGripInterface::GripBreakDistance ( )

inheritedBlueprintNativeEventBlueprintCallable

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

GripLateUpdateSetting()

EGripLateUpdateSettings IVRGripInterface::GripLateUpdateSetting ( )

inheritedBlueprintNativeEventBlueprintCallable

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

GripMode()

void APixoVRToolBase::GripMode ( EPixoVRGripModeEnum & GripMode )

BlueprintNativeEventBlueprintCallable

Will be used to determine how to do the grabbing. Using normal attachment or a physics constraint.

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")

Here is the caller graph for this function:

GripMode_Implementation()

void APixoVRToolBase::GripMode_Implementation ( EPixoVRGripModeEnum & GripMode )

overridevirtual

Definition at line 168 of file PixoVRToolBase.cpp.

Here is the call graph for this function:

GripMovementReplicationType()

EGripMovementReplicationSettings IVRGripInterface::GripMovementReplicationType ( )

inheritedBlueprintNativeEventBlueprintCallable

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

GripTriggerMode()

void APixoVRToolBase::GripTriggerMode ( EPixoVRGripTriggerModeEnum & GripTriggerMode )

BlueprintNativeEventBlueprintCallable

Will be used to determine how the gripping trigger should behave.

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")

Here is the caller graph for this function:

GripTriggerMode_Implementation()

void APixoVRToolBase::GripTriggerMode_Implementation ( EPixoVRGripTriggerModeEnum & GripTriggerMode )

overridevirtual

Definition at line 157 of file PixoVRToolBase.cpp.

Here is the call graph for this function:

GripTriggerTransform()

void APixoVRToolBase::GripTriggerTransform ( UGripMotionControllerComponent * GrippingController, bool & bUseCustomTransform, FTransform & CustomTransform )

BlueprintNativeEventBlueprintCallable

This specified transformation will be used when flag is set and a grip is happening.

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")

GripTriggerTransform_Implementation()

void APixoVRToolBase::GripTriggerTransform_Implementation ( UGripMotionControllerComponent * GrippingController, bool & bUseCustomTransform, FTransform & CustomTransform )

overridevirtual

Definition at line 162 of file PixoVRToolBase.cpp.

Here is the call graph for this function:

HandleDestroy()

void APixoVRToolBase::HandleDestroy ( )

BlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVRToolbox | Tools")

Here is the caller graph for this function:

InitializeTool()

void APixoVRToolBase::InitializeTool ( const FPixoToolData & InToolData )

BlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVRToolbox | Tools")

IPixoVRToolInterface Implementation Passes tool data to the tool to provide user configurable data.

InitializeTool_Implementation()

void APixoVRToolBase::InitializeTool_Implementation ( const FPixoToolData & InToolData )

overridevirtual

Definition at line 117 of file PixoVRToolBase.cpp.

IsDestroyable()

bool APixoVRToolBase::IsDestroyable ( )

BlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVRToolbox | Tools")

Here is the caller graph for this function:

IsGripped()

bool APixoVRToolBase::IsGripped ( )

BlueprintCallable

UFUNCTION(BlueprintCallable, Category = Tool)

Definition at line 93 of file PixoVRToolBase.cpp.

IsHeld()

void IVRGripInterface::IsHeld ( TArray< FBPGripPair > & HoldingControllers, bool & bIsHeld )

inheritedBlueprintNativeEventBlueprintCallable

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

IsRightHand()

bool APixoVRToolBase::IsRightHand ( UGripMotionControllerComponent * GrippingController ) const

protected

Definition at line 424 of file PixoVRToolBase.cpp.

Here is the caller graph for this function:

MulticastAdjustPlayingSoundVolumeViaComponent()

void APixoVRToolBase::MulticastAdjustPlayingSoundVolumeViaComponent ( float InVolumeMultiplier )

privateNetMulticastReliable

UFUNCTION(NetMulticast, Reliable)

MulticastStartPlayingSound()

void APixoVRToolBase::MulticastStartPlayingSound ( USoundBase * Sound, const FVector & SoundLocation, float VolumeMultiplier )

privateNetMulticastReliable

UFUNCTION(NetMulticast, Reliable)

MulticastStartPlayingSoundViaComponent()

void APixoVRToolBase::MulticastStartPlayingSoundViaComponent ( USoundBase * Sound, float VolumeMultiplier )

privateNetMulticastReliable

UFUNCTION(NetMulticast, Reliable)

MulticastStopPlayingSound()

void APixoVRToolBase::MulticastStopPlayingSound ( USoundBase * Sound )

privateNetMulticastReliable

UFUNCTION(NetMulticast, Reliable)

MulticastStopPlayingSoundViaComponent()

void APixoVRToolBase::MulticastStopPlayingSoundViaComponent ( )

privateNetMulticastReliable

UFUNCTION(NetMulticast, Reliable)

MulticastToggleCollision()

void APixoVRToolBase::MulticastToggleCollision ( ECollisionEnabled::Type Type )

privateNetMulticastReliable

UFUNCTION(NetMulticast, Reliable)

Native_NotifyThrowGripDelegates()

void IVRGripInterface::Native_NotifyThrowGripDelegates ( UGripMotionControllerComponent * Controller, bool bGripped, const FBPActorGripInformation & GripInformation, bool bWasSocketed = false )

virtualinherited

Reimplemented in AGrippableActor, UGrippableBoxComponent, UGrippableCapsuleComponent, AGrippableSkeletalMeshActor, UGrippableSkeletalMeshComponent, UGrippableSphereComponent, AGrippableStaticMeshActor, UGrippableStaticMeshComponent, UVRDialComponent, UVRLeverComponent, and UVRSliderComponent.

Definition at line 14 of file VRGripInterface.cpp.

OnChildGrip()

void IVRGripInterface::OnChildGrip ( UGripMotionControllerComponent * GrippingController, const FBPActorGripInformation & GripInformation )

inheritedBlueprintNativeEvent

UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")

OnChildGripRelease()

void IVRGripInterface::OnChildGripRelease ( UGripMotionControllerComponent * ReleasingController, const FBPActorGripInformation & GripInformation, bool bWasSocketed = false )

inheritedBlueprintNativeEvent

UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")

OnEndSecondaryUsed()

void IVRGripInterface::OnEndSecondaryUsed ( )

inheritedBlueprintNativeEventBlueprintCallable

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

OnEndUsed()

void IVRGripInterface::OnEndUsed ( )

inheritedBlueprintNativeEventBlueprintCallable

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

OnGrip()

void IVRGripInterface::OnGrip ( UGripMotionControllerComponent * GrippingController, const FBPActorGripInformation & GripInformation )

inheritedBlueprintNativeEvent

UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")

OnGripObject()

void APixoVRToolBase::OnGripObject ( UGripMotionControllerComponent * GrippingController, AActor * GrippedActor )

BlueprintNativeEventBlueprintCallable

Will be called when user grabs an object.

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")

OnGripObject_Implementation()

void APixoVRToolBase::OnGripObject_Implementation ( UGripMotionControllerComponent * GrippingController, AActor * GrippedActor )

overridevirtual

Definition at line 108 of file PixoVRToolBase.cpp.

Here is the call graph for this function:

OnGripObjectRelease()

void APixoVRToolBase::OnGripObjectRelease ( UGripMotionControllerComponent * GrippingController, AActor * GrippedActor )

BlueprintNativeEventBlueprintCallable

Will be called when the user releases an object.

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")

OnGripObjectRelease_Implementation()

void APixoVRToolBase::OnGripObjectRelease_Implementation ( UGripMotionControllerComponent * GrippingController, AActor * GrippedActor )

overridevirtual

Definition at line 152 of file PixoVRToolBase.cpp.

Here is the call graph for this function:

OnGripRelease()

void IVRGripInterface::OnGripRelease ( UGripMotionControllerComponent * ReleasingController, const FBPActorGripInformation & GripInformation, bool bWasSocketed = false )

inheritedBlueprintNativeEvent

UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")

OnInput()

void IVRGripInterface::OnInput ( FKey Key, EInputEvent KeyEvent )

inheritedBlueprintNativeEventBlueprintCallable

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

OnObjectPaused()

void APixoVRToolBase::OnObjectPaused ( )

BlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")

OnObjectPaused_Implementation()

void APixoVRToolBase::OnObjectPaused_Implementation ( )

overridevirtual

Definition at line 178 of file PixoVRToolBase.cpp.

OnObjectUnPaused()

void APixoVRToolBase::OnObjectUnPaused ( )

BlueprintNativeEventBlueprintCallable

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")

OnObjectUnPaused_Implementation()

void APixoVRToolBase::OnObjectUnPaused_Implementation ( )

overridevirtual

Definition at line 185 of file PixoVRToolBase.cpp.

OnOverlapBegin()

void APixoVRToolBase::OnOverlapBegin ( UPrimitiveComponent * OverlappedComp, AActor * OtherActor, UPrimitiveComponent * OtherComp, int32 OtherBodyIndex, bool FromSweep, const FHitResult & SweepResult )

protectedvirtual

UFUNCTION()

Definition at line 70 of file PixoVRToolBase.cpp.

Here is the caller graph for this function:

OnSecondaryGrip()

void IVRGripInterface::OnSecondaryGrip ( UGripMotionControllerComponent * GripOwningController, USceneComponent * SecondaryGripComponent, const FBPActorGripInformation & GripInformation )

inheritedBlueprintNativeEvent

UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")

OnSecondaryGripRelease()

void IVRGripInterface::OnSecondaryGripRelease ( UGripMotionControllerComponent * GripOwningController, USceneComponent * ReleasingSecondaryGripComponent, const FBPActorGripInformation & GripInformation )

inheritedBlueprintNativeEvent

UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")

OnSecondaryUsed()

void IVRGripInterface::OnSecondaryUsed ( )

inheritedBlueprintNativeEventBlueprintCallable

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

OnTryGripObject()

void APixoVRToolBase::OnTryGripObject ( UGripMotionControllerComponent * GrippingController, AActor * GrippedActor )

BlueprintNativeEventBlueprintCallable

Will be called when user tried to grab the object.

UFUNCTION(BlueprintNativeEvent, BlueprintCallable, Category = "PixoVR | Grip Interface")

OnTryGripObject_Implementation()

void APixoVRToolBase::OnTryGripObject_Implementation ( UGripMotionControllerComponent * GrippingController, AActor * GrippedActor )

overridevirtual

Definition at line 148 of file PixoVRToolBase.cpp.

OnUsed()

void IVRGripInterface::OnUsed ( )

inheritedBlueprintNativeEventBlueprintCallable

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

PairSecondaryTool()

void IPixoVRToolInterface::PairSecondaryTool ( AActor * SecondaryTool )

inheritedBlueprintCallableBlueprintNativeEvent

Binds a secondary tool to the primary tool.

Parameters

SecondaryTool

The secondary tool to be paired with the primary tool.

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

RequestsSocketing()

bool IVRGripInterface::RequestsSocketing ( USceneComponent *& ParentToSocketTo, FName & OptionalSocketName, FTransform_NetQuantize & RelativeTransform )

inheritedBlueprintNativeEventBlueprintCallable

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

SecondaryGripType()

ESecondaryGripType IVRGripInterface::SecondaryGripType ( )

inheritedBlueprintNativeEventBlueprintCallable

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

ServerAdjustPlayingSoundVolumeViaComponent()

void APixoVRToolBase::ServerAdjustPlayingSoundVolumeViaComponent ( float InVolumeMultiplier = 1.0f )

protectedWithValidationReliableServer

UFUNCTION(Server, Reliable, WithValidation)

ServerDestroyTool()

void APixoVRToolBase::ServerDestroyTool ( )

privateWithValidationReliableServer

UFUNCTION(Server, Reliable, WithValidation)

ServerOnDropped()

void APixoVRToolBase::ServerOnDropped ( )

protectedWithValidationReliableServer

UFUNCTION(Server, Reliable, WithValidation)

Here is the caller graph for this function:

ServerStartPlayingSound()

void APixoVRToolBase::ServerStartPlayingSound ( USoundBase * Sound, const FVector & SoundLocation, float VolumeMultiplier = 1.0f )

protectedWithValidationReliableServer

UFUNCTION(Server, Reliable, WithValidation)

ServerStartPlayingSoundViaComponent()

void APixoVRToolBase::ServerStartPlayingSoundViaComponent ( USoundBase * Sound, float VolumeMultiplier = 1.0f )

protectedWithValidationReliableServer

UFUNCTION(Server, Reliable, WithValidation)

ServerStopPlayingSound()

void APixoVRToolBase::ServerStopPlayingSound ( USoundBase * Sound )

protectedWithValidationReliableServer

UFUNCTION(Server, Reliable, WithValidation)

ServerStopPlayingSoundViaComponent()

void APixoVRToolBase::ServerStopPlayingSoundViaComponent ( )

protectedWithValidationReliableServer

UFUNCTION(Server, Reliable, WithValidation)

ServerUseTool()

void APixoVRToolBase::ServerUseTool ( UGripMotionControllerComponent * GrippingController, AActor * GrippedActor )

privateWithValidationReliableServer

UFUNCTION(Server, Reliable, WithValidation)

Here is the caller graph for this function:

SetHeld()

void IVRGripInterface::SetHeld ( UGripMotionControllerComponent * HoldingController, uint8 GripID, bool bIsHeld )

inheritedBlueprintNativeEvent

UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")

SimulateOnDrop()

bool IVRGripInterface::SimulateOnDrop ( )

inheritedBlueprintNativeEventBlueprintCallable

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

TeleportBehavior()

EGripInterfaceTeleportBehavior IVRGripInterface::TeleportBehavior ( )

inheritedBlueprintNativeEventBlueprintCallable

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

Tick()

void APixoVRToolBase::Tick ( float DeltaSeconds )

overrideprotectedvirtual

Definition at line 56 of file PixoVRToolBase.cpp.

Here is the call graph for this function:

TickGrip()

void IVRGripInterface::TickGrip ( UGripMotionControllerComponent * GrippingController, const FBPActorGripInformation & GripInformation, float DeltaTime )

inheritedBlueprintNativeEvent

UFUNCTION(BlueprintNativeEvent, Category = "VRGripInterface")

ToggleState()

void IPixoVRToolInterface::ToggleState ( EControllerHand Hand )

inheritedBlueprintCallableBlueprintNativeEvent

Wraps the toggle on and off functionality of the tool.

Parameters

Hand	The hand associated with the tool.

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

Use()

void IPixoVRToolInterface::Use ( bool InActivate, EControllerHand Hand )

inheritedBlueprintCallableBlueprintNativeEvent

Wraps the usable functionality of the tool.

Parameters

InActivate	Whether to activate or deactivate the tool.
Hand	The hand holding the tool.

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

Member Data Documentation

AudioComponent

UAudioComponent* APixoVRToolBase::AudioComponent

protectedVisibleAnywhere

UPROPERTY(VisibleAnywhere, Category = Tool)

Definition at line 317 of file PixoVRToolBase.h.

bAdvancedDrop

bool APixoVRToolBase::bAdvancedDrop

protectedBlueprintReadOnlyEditDefaultsOnly

UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = DropBehavior)

Definition at line 360 of file PixoVRToolBase.h.

bDestroyOnDrop

bool APixoVRToolBase::bDestroyOnDrop

protectedBlueprintReadOnlyEditDefaultsOnly

UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = DropBehavior)

Definition at line 339 of file PixoVRToolBase.h.

bDestroyOnExit

bool APixoVRToolBase::bDestroyOnExit

protectedBlueprintReadOnlyEditDefaultsOnly

UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = DropBehavior)

Definition at line 346 of file PixoVRToolBase.h.

bIsGripAllowed

bool APixoVRToolBase::bIsGripAllowed

protectedBlueprintReadOnly

UPROPERTY(BlueprintReadOnly, Category = GripBehavior)

Definition at line 410 of file PixoVRToolBase.h.

bIsGripped

bool APixoVRToolBase::bIsGripped

protectedReplicatedBlueprintReadOnly

UPROPERTY(Replicated, BlueprintReadOnly, Category = GripBehavior)

Definition at line 404 of file PixoVRToolBase.h.

bIsPaused

bool APixoVRToolBase::bIsPaused

protectedReplicatedBlueprintReadOnly

UPROPERTY(Replicated, BlueprintReadOnly, Category = ToolBehavior)

Definition at line 419 of file PixoVRToolBase.h.

bIsPendingKill

bool APixoVRToolBase::bIsPendingKill

Definition at line 423 of file PixoVRToolBase.h.

bToggleCollisionOnUsage

bool APixoVRToolBase::bToggleCollisionOnUsage

protectedBlueprintReadOnlyEditDefaultsOnly

UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = GripBehavior)

Definition at line 367 of file PixoVRToolBase.h.

DefaultAttenuationSettings

USoundAttenuation* APixoVRToolBase::DefaultAttenuationSettings

protected

UPROPERTY()

Definition at line 322 of file PixoVRToolBase.h.

DestroyDelay

float APixoVRToolBase::DestroyDelay

protectedBlueprintReadOnlyEditDefaultsOnly

UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = DropBehavior)

Definition at line 353 of file PixoVRToolBase.h.

[struct]

struct { ... } APixoVRToolBase::DestroyState

GrabBoxComponent

UBoxComponent* APixoVRToolBase::GrabBoxComponent

protectedVisibleAnywhere

UPROPERTY(VisibleAnywhere, Category = Tool)

Definition at line 311 of file PixoVRToolBase.h.

GrabHand

EControllerHand APixoVRToolBase::GrabHand

protectedReplicatedBlueprintReadOnly

UPROPERTY(Replicated, BlueprintReadOnly, Category = GripBehavior)

Definition at line 397 of file PixoVRToolBase.h.

GripSound

USoundBase* APixoVRToolBase::GripSound

protectedBlueprintReadOnlyEditDefaultsOnly

UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = GripBehavior)

Definition at line 332 of file PixoVRToolBase.h.

LeftHandGrip

FTransform APixoVRToolBase::LeftHandGrip

protectedBlueprintReadOnlyEditDefaultsOnly

UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = TransformOffset)

Definition at line 381 of file PixoVRToolBase.h.

OnGripAction

FGripAction APixoVRToolBase::OnGripAction

protected

Definition at line 412 of file PixoVRToolBase.h.

RightHandGrip

FTransform APixoVRToolBase::RightHandGrip

protectedBlueprintReadOnlyEditDefaultsOnly

UPROPERTY(EditDefaultsOnly, BlueprintReadOnly, Category = TransformOffset)

Definition at line 374 of file PixoVRToolBase.h.

TimeBeforeKilled

float APixoVRToolBase::TimeBeforeKilled

Definition at line 424 of file PixoVRToolBase.h.

ToolData

FPixoToolData APixoVRToolBase::ToolData

protectedReplicatedBlueprintReadOnly

UPROPERTY(Replicated, BlueprintReadOnly, Category = ToolData)

Definition at line 390 of file PixoVRToolBase.h.

ToolMeshComponent

UStaticMeshComponent* APixoVRToolBase::ToolMeshComponent

protectedBlueprintReadOnlyVisibleAnywhere

UPROPERTY(VisibleAnywhere, BlueprintReadOnly, Category = Tool)

Definition at line 305 of file PixoVRToolBase.h.

---

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

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