PBDConstraintContainer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Chaos/ConstraintHandle.h"
#include "Chaos/Transform.h"
#include "Chaos/Evolution/SolverBody.h"
#include "Chaos/Evolution/SolverConstraintContainer.h"
#include "Chaos/Evolution/ConstraintGroupSolver.h"
#include "Chaos/Island/IslandManagerFwd.h"
 
namespace Chaos
{
    class FPBDConstraintContainer
    {
    public:
        CHAOS_API FPBDConstraintContainer(FConstraintHandleTypeID InConstraintHandleType);
 
        CHAOS_API virtual ~FPBDConstraintContainer();
 
        int32 GetContainerId() const
        {
            return ContainerId;
        }
 
        void SetContainerId(int32 InContainerId)
        {
            ContainerId = InContainerId;
        }
 
        const FConstraintHandleTypeID& GetConstraintHandleType() const
        {
            return ConstraintHandleType;
        }
 
        virtual int32 GetNumConstraints() const = 0;
 
        virtual void ResetConstraints() = 0;
 
        virtual void UpdatePositionBasedState(const FReal Dt) {}
 
        virtual void PrepareTick() = 0;
 
        virtual void UnprepareTick() = 0;
 
        // This is called when a particle is destroyed. The constraint should be disabled and the particle in the constraint set to null
        // @todo(chaos): remove the set
        virtual void DisconnectConstraints(const TSet<TGeometryParticleHandle<FReal, 3>*>&) {}
 
        // This is called to notify the constraint container that a particle has been disabled
        virtual void OnDisableParticle(FGeometryParticleHandle* DisabledParticle);
 
        // This is called to notify the constraint container that a particle has been disabled
        virtual void OnEnableParticle(FGeometryParticleHandle* EnabledParticle);
 
        virtual TUniquePtr<FConstraintContainerSolver> CreateSceneSolver(const int32 Priority) = 0;
 
        virtual TUniquePtr<FConstraintContainerSolver> CreateGroupSolver(const int32 Priority) = 0;
 
        virtual void AddConstraintsToGraph(Private::FPBDIslandManager& IslandManager) = 0;
 
    protected:
        FConstraintHandleTypeID ConstraintHandleType;
        int32 ContainerId;
    };
 
    //
    //
    // From ConstraintHandle.h
    //
    //
 
    inline int32 FConstraintHandle::GetContainerId() const
    {
        if (ConstraintContainer != nullptr)
        {
            return ConstraintContainer->GetContainerId();
        }
        return INDEX_NONE;
    }
 
    inline const FConstraintHandleTypeID& FConstraintHandle::GetType() const
    {
        if (ConstraintContainer != nullptr)
        {
            return ConstraintContainer->GetConstraintHandleType();
        }
        return FConstraintHandle::InvalidType();
    }
 
    template<typename T>
    inline T* FConstraintHandle::As()
    {
        // @todo(chaos): we need a safe cast that allows for casting to intermediate base classes (e.g., FIndexedConstraintHandle)
        return ((ConstraintContainer != nullptr) && ConstraintContainer->GetConstraintHandleType().IsA(T::StaticType())) ? static_cast<T*>(this) : nullptr;
    }
 
    template<typename T>
    inline const T* FConstraintHandle::As() const
    {
        return ((ConstraintContainer != nullptr) && ConstraintContainer->GetConstraintHandleType().IsA(T::StaticType())) ? static_cast<const T*>(this) : nullptr;
    }
 
 
}