GrippableCapsuleComponent.cpp

Go to the documentation of this file.

// Copyright 1998-2016 Epic Games, Inc. All Rights Reserved.
 
#include "Grippables/GrippableCapsuleComponent.h"
#include "Net/UnrealNetwork.h"
 
  //=============================================================================
UGrippableCapsuleComponent::UGrippableCapsuleComponent(const FObjectInitializer& ObjectInitializer)
    : Super(ObjectInitializer)
{
    VRGripInterfaceSettings.bDenyGripping = false;
    VRGripInterfaceSettings.OnTeleportBehavior = EGripInterfaceTeleportBehavior::DropOnTeleport;
    VRGripInterfaceSettings.bSimulateOnDrop = true;
    VRGripInterfaceSettings.SlotDefaultGripType = EGripCollisionType::ManipulationGrip;
    VRGripInterfaceSettings.FreeDefaultGripType = EGripCollisionType::ManipulationGrip;
    VRGripInterfaceSettings.SecondaryGripType = ESecondaryGripType::SG_None;
    VRGripInterfaceSettings.MovementReplicationType = EGripMovementReplicationSettings::ForceClientSideMovement;
    VRGripInterfaceSettings.LateUpdateSetting = EGripLateUpdateSettings::LateUpdatesAlwaysOff;
    VRGripInterfaceSettings.ConstraintStiffness = 1500.0f;
    VRGripInterfaceSettings.ConstraintDamping = 200.0f;
    VRGripInterfaceSettings.ConstraintBreakDistance = 100.0f;
    VRGripInterfaceSettings.SecondarySlotRange = 20.0f;
    VRGripInterfaceSettings.PrimarySlotRange = 20.0f;
 
    VRGripInterfaceSettings.bIsHeld = false;
 
    bReplicateMovement = false;
    //this->bReplicates = true;
 
    bRepGripSettingsAndGameplayTags = true;
    bReplicateGripScripts = false;
}
 
void UGrippableCapsuleComponent::GetLifetimeReplicatedProps(TArray< class FLifetimeProperty > & OutLifetimeProps) const
{
    Super::GetLifetimeReplicatedProps(OutLifetimeProps);
    
    DOREPLIFETIME_CONDITION(UGrippableCapsuleComponent, GripLogicScripts, COND_Custom);
    DOREPLIFETIME(UGrippableCapsuleComponent, bReplicateGripScripts);
    DOREPLIFETIME(UGrippableCapsuleComponent, bRepGripSettingsAndGameplayTags);
    DOREPLIFETIME(UGrippableCapsuleComponent, bReplicateMovement);
    DOREPLIFETIME_CONDITION(UGrippableCapsuleComponent, VRGripInterfaceSettings, COND_Custom);
    DOREPLIFETIME_CONDITION(UGrippableCapsuleComponent, GameplayTags, COND_Custom);
}
 
void UGrippableCapsuleComponent::PreReplication(IRepChangedPropertyTracker & ChangedPropertyTracker)
{
    Super::PreReplication(ChangedPropertyTracker);
 
    // Don't replicate if set to not do it
    DOREPLIFETIME_ACTIVE_OVERRIDE(UGrippableCapsuleComponent, VRGripInterfaceSettings, bRepGripSettingsAndGameplayTags);
    DOREPLIFETIME_ACTIVE_OVERRIDE(UGrippableCapsuleComponent, GameplayTags, bRepGripSettingsAndGameplayTags);
    DOREPLIFETIME_ACTIVE_OVERRIDE(UGrippableCapsuleComponent, GripLogicScripts, bReplicateGripScripts);
 
    DOREPLIFETIME_ACTIVE_OVERRIDE_PRIVATE_PROPERTY(USceneComponent, RelativeLocation, bReplicateMovement);
    DOREPLIFETIME_ACTIVE_OVERRIDE_PRIVATE_PROPERTY(USceneComponent, RelativeRotation, bReplicateMovement);
    DOREPLIFETIME_ACTIVE_OVERRIDE_PRIVATE_PROPERTY(USceneComponent, RelativeScale3D, bReplicateMovement);
}
 
bool UGrippableCapsuleComponent::ReplicateSubobjects(UActorChannel* Channel, class FOutBunch *Bunch, FReplicationFlags *RepFlags)
{
    bool WroteSomething = Super::ReplicateSubobjects(Channel, Bunch, RepFlags);
 
    if (bReplicateGripScripts)
    {
        for (UVRGripScriptBase* Script : GripLogicScripts)
        {
            if (Script && !Script->IsPendingKill())
            {
                WroteSomething |= Channel->ReplicateSubobject(Script, *Bunch, *RepFlags);
            }
        }
    }
 
    return WroteSomething;
}
 
//=============================================================================
UGrippableCapsuleComponent::~UGrippableCapsuleComponent()
{
}
 
void UGrippableCapsuleComponent::BeginPlay()
{
    // Call the base class 
    Super::BeginPlay();
 
    // Call all grip scripts begin play events so they can perform any needed logic
    for (UVRGripScriptBase* Script : GripLogicScripts)
    {
        if (Script)
        {
            Script->BeginPlay(this);
        }
    }
 
    bOriginalReplicatesMovement = bReplicateMovement;
}
 
void UGrippableCapsuleComponent::EndPlay(const EEndPlayReason::Type EndPlayReason)
{
    // Call the base class 
    Super::EndPlay(EndPlayReason);
 
    // Call all grip scripts begin play events so they can perform any needed logic
    for (UVRGripScriptBase* Script : GripLogicScripts)
    {
        if (Script)
        {
            Script->EndPlay(EndPlayReason);
        }
    }
}
 
void UGrippableCapsuleComponent::SetDenyGripping(bool bDenyGripping)
{
    VRGripInterfaceSettings.bDenyGripping = bDenyGripping;
}
 
void UGrippableCapsuleComponent::SetGripPriority(int NewGripPriority)
{
    VRGripInterfaceSettings.AdvancedGripSettings.GripPriority = NewGripPriority;
}
 
void UGrippableCapsuleComponent::TickGrip_Implementation(UGripMotionControllerComponent * GrippingController, const FBPActorGripInformation & GripInformation, float DeltaTime) {}
void UGrippableCapsuleComponent::OnGrip_Implementation(UGripMotionControllerComponent* GrippingController, const FBPActorGripInformation& GripInformation) {}
void UGrippableCapsuleComponent::OnGripRelease_Implementation(UGripMotionControllerComponent* ReleasingController, const FBPActorGripInformation& GripInformation, bool bWasSocketed) { }
void UGrippableCapsuleComponent::OnChildGrip_Implementation(UGripMotionControllerComponent* GrippingController, const FBPActorGripInformation& GripInformation) {}
void UGrippableCapsuleComponent::OnChildGripRelease_Implementation(UGripMotionControllerComponent* ReleasingController, const FBPActorGripInformation& GripInformation, bool bWasSocketed) {}
void UGrippableCapsuleComponent::OnSecondaryGrip_Implementation(UGripMotionControllerComponent* GripOwningController, USceneComponent* SecondaryGripComponent, const FBPActorGripInformation& GripInformation) { OnSecondaryGripAdded.Broadcast(GripOwningController, GripInformation); }
void UGrippableCapsuleComponent::OnSecondaryGripRelease_Implementation(UGripMotionControllerComponent* GripOwningController, USceneComponent* ReleasingSecondaryGripComponent, const FBPActorGripInformation& GripInformation) { OnSecondaryGripRemoved.Broadcast(GripOwningController, GripInformation); }
void UGrippableCapsuleComponent::OnUsed_Implementation() {}
void UGrippableCapsuleComponent::OnEndUsed_Implementation() {}
void UGrippableCapsuleComponent::OnSecondaryUsed_Implementation() {}
void UGrippableCapsuleComponent::OnEndSecondaryUsed_Implementation() {}
void UGrippableCapsuleComponent::OnInput_Implementation(FKey Key, EInputEvent KeyEvent) {}
bool UGrippableCapsuleComponent::RequestsSocketing_Implementation(USceneComponent *& ParentToSocketTo, FName & OptionalSocketName, FTransform_NetQuantize & RelativeTransform) { return false; }
 
 
bool UGrippableCapsuleComponent::DenyGripping_Implementation(UGripMotionControllerComponent * GripInitiator)
{
    return VRGripInterfaceSettings.bDenyGripping;
}
 
EGripInterfaceTeleportBehavior UGrippableCapsuleComponent::TeleportBehavior_Implementation()
{
    return VRGripInterfaceSettings.OnTeleportBehavior;
}
 
bool UGrippableCapsuleComponent::SimulateOnDrop_Implementation()
{
    return VRGripInterfaceSettings.bSimulateOnDrop;
}
 
EGripCollisionType UGrippableCapsuleComponent::GetPrimaryGripType_Implementation(bool bIsSlot)
{
    return bIsSlot ? VRGripInterfaceSettings.SlotDefaultGripType : VRGripInterfaceSettings.FreeDefaultGripType;
}
 
ESecondaryGripType UGrippableCapsuleComponent::SecondaryGripType_Implementation()
{
    return VRGripInterfaceSettings.SecondaryGripType;
}
 
EGripMovementReplicationSettings UGrippableCapsuleComponent::GripMovementReplicationType_Implementation()
{
    return VRGripInterfaceSettings.MovementReplicationType;
}
 
EGripLateUpdateSettings UGrippableCapsuleComponent::GripLateUpdateSetting_Implementation()
{
    return VRGripInterfaceSettings.LateUpdateSetting;
}
 
void UGrippableCapsuleComponent::GetGripStiffnessAndDamping_Implementation(float &GripStiffnessOut, float &GripDampingOut)
{
    GripStiffnessOut = VRGripInterfaceSettings.ConstraintStiffness;
    GripDampingOut = VRGripInterfaceSettings.ConstraintDamping;
}
 
FBPAdvGripSettings UGrippableCapsuleComponent::AdvancedGripSettings_Implementation()
{
    return VRGripInterfaceSettings.AdvancedGripSettings;
}
 
float UGrippableCapsuleComponent::GripBreakDistance_Implementation()
{
    return VRGripInterfaceSettings.ConstraintBreakDistance;
}
 
void UGrippableCapsuleComponent::ClosestGripSlotInRange_Implementation(FVector WorldLocation, bool bSecondarySlot, bool & bHadSlotInRange, FTransform & SlotWorldTransform, FName & SlotName, UGripMotionControllerComponent * CallingController, FName OverridePrefix)
{
    if (OverridePrefix.IsNone())
        bSecondarySlot ? OverridePrefix = "VRGripS" : OverridePrefix = "VRGripP";
 
    UVRExpansionFunctionLibrary::GetGripSlotInRangeByTypeName_Component(OverridePrefix, this, WorldLocation, bSecondarySlot ? VRGripInterfaceSettings.SecondarySlotRange : VRGripInterfaceSettings.PrimarySlotRange, bHadSlotInRange, SlotWorldTransform, SlotName, CallingController);
}
 
bool UGrippableCapsuleComponent::AllowsMultipleGrips_Implementation()
{
    return VRGripInterfaceSettings.bAllowMultipleGrips;
}
 
void UGrippableCapsuleComponent::IsHeld_Implementation(TArray<FBPGripPair> & HoldingControllers, bool & bIsHeld)
{
    HoldingControllers = VRGripInterfaceSettings.HoldingControllers;
    bIsHeld = VRGripInterfaceSettings.bIsHeld;
}
 
void UGrippableCapsuleComponent::Native_NotifyThrowGripDelegates(UGripMotionControllerComponent* Controller, bool bGripped, const FBPActorGripInformation& GripInformation, bool bWasSocketed)
{
    if (bGripped)
    {
        OnGripped.Broadcast(Controller, GripInformation);
    }
    else
    {
        OnDropped.Broadcast(Controller, GripInformation, bWasSocketed);
    }
}
 
void UGrippableCapsuleComponent::SetHeld_Implementation(UGripMotionControllerComponent * HoldingController, uint8 GripID, bool bIsHeld)
{
    if (bIsHeld)
    {
        if (VRGripInterfaceSettings.MovementReplicationType != EGripMovementReplicationSettings::ForceServerSideMovement)
        {
            if (!VRGripInterfaceSettings.bIsHeld)
                bOriginalReplicatesMovement = bReplicateMovement;
            bReplicateMovement = false;
        }
 
        VRGripInterfaceSettings.bWasHeld = true;
        VRGripInterfaceSettings.HoldingControllers.AddUnique(FBPGripPair(HoldingController, GripID));
    }
    else
    {
        if (VRGripInterfaceSettings.MovementReplicationType != EGripMovementReplicationSettings::ForceServerSideMovement)
        {
            bReplicateMovement = bOriginalReplicatesMovement;
        }
 
        VRGripInterfaceSettings.HoldingControllers.Remove(FBPGripPair(HoldingController, GripID));
    }
 
    VRGripInterfaceSettings.bIsHeld = VRGripInterfaceSettings.HoldingControllers.Num() > 0;
}
 
/*FBPInteractionSettings UGrippableCapsuleComponent::GetInteractionSettings_Implementation()
{
    return VRGripInterfaceSettings.InteractionSettings;
}*/
 
bool UGrippableCapsuleComponent::GetGripScripts_Implementation(TArray<UVRGripScriptBase*> & ArrayReference)
{
    ArrayReference = GripLogicScripts;
    return GripLogicScripts.Num() > 0;
}
 
void UGrippableCapsuleComponent::PreDestroyFromReplication()
{
    Super::PreDestroyFromReplication();
 
    // Destroy any sub-objects we created
    for (int32 i = 0; i < GripLogicScripts.Num(); ++i)
    {
        if (UObject *SubObject = GripLogicScripts[i])
        {
            SubObject->PreDestroyFromReplication();
            SubObject->MarkPendingKill();
        }
    }
 
    GripLogicScripts.Empty();
}
 
void UGrippableCapsuleComponent::GetSubobjectsWithStableNamesForNetworking(TArray<UObject*> &ObjList)
{
    if (bReplicateGripScripts)
    {
        for (int32 i = 0; i < GripLogicScripts.Num(); ++i)
        {
            if (UObject* SubObject = GripLogicScripts[i])
            {
                ObjList.Add(SubObject);
            }
        }
    }
}
 
void UGrippableCapsuleComponent::OnComponentDestroyed(bool bDestroyingHierarchy)
{
    // Call the super at the end, after we've done what we needed to do
    Super::OnComponentDestroyed(bDestroyingHierarchy);
 
    // Don't set these in editor preview window and the like, it causes saving issues
    if (UWorld * World = GetWorld())
    {
        EWorldType::Type WorldType = World->WorldType;
        if (WorldType == EWorldType::Editor || WorldType == EWorldType::EditorPreview)
        {
            return;
        }
    }
 
    for (int32 i = 0; i < GripLogicScripts.Num(); i++)
    {
        if (UObject *SubObject = GripLogicScripts[i])
        {
            SubObject->MarkPendingKill();
        }
    }
 
    GripLogicScripts.Empty();
}