Bogie.h

//  trax track library
//  AD 2014
//
//  "here in the land of opportunity"
//
//                  New Model Army
// 
// 
// Copyright (c) 2025 Trend Redaktions- und Verlagsgesellschaft mbH
// Copyright (c) 2019 Marc-Michael Horstmann
//
// Permission is hereby granted to any person obtaining a copy of this software 
// and associated source code (the "Software"), to use, view, and study the 
// Software for personal or internal business purposes, subject to the following 
// conditions:
//
// 1. Redistribution, modification, sublicensing, or commercial use of the 
// Software is NOT permitted without prior written consent from the copyright 
// holder.
//
// 2. The Software is provided "AS IS", without warranty of any kind, express 
// or implied.
//
// 3. All copies of the Software must retain this license notice.
//
// For further information, please contact: horstmann.marc@trendverlag.de
 
#pragma once
 
#include "RailRunner.h"
 
#include "trax/Simulated.h"
#include "spat/Frame.h"
#include "spat/Sphere.h"
 
namespace trax{
 
    struct Gestalt;
    struct RollingStock;
    struct Scene;

    struct Bogie : RailRunner,
                   Simulated
    {
        static dclspc std::shared_ptr<Bogie> Make( Scene& scene, std::shared_ptr<Gestalt> pGestalt = nullptr ) noexcept;
 

        virtual std::shared_ptr<Bogie> ThisBogie() const noexcept = 0;
 
 
        virtual Gestalt& GetGestalt() const noexcept = 0;
 

        virtual RollingStock* GetRollingStock() const noexcept = 0;
 
 
        // Bogies's arrangement:

        
        virtual void Attach( std::shared_ptr<Bogie> pChildBogie, EndType atEnd, const spat::Frame<Length,One>& swivelPose ) = 0;

        virtual void Attach( std::shared_ptr<Bogie> pChildBogie, EndType atEnd ) = 0;
 

        virtual std::pair<std::shared_ptr<Bogie>,spat::Frame<Length,One>> GetChild( EndType atEnd ) const noexcept = 0;
 

        virtual std::pair<std::shared_ptr<Bogie>,spat::Frame<Length,One>> GetParent( EndType atEnd = EndType::any ) const noexcept = 0;
 

        virtual std::shared_ptr<Bogie> GetFirst() const noexcept = 0;
 

        virtual std::shared_ptr<Bogie> GetNext() const noexcept = 0;
 
        
        virtual std::shared_ptr<Bogie> GetPrevious() const noexcept = 0;
 

        virtual std::shared_ptr<Bogie> GetLast() const noexcept = 0;
 

        virtual void Detach( EndType atEnd = EndType::all ) noexcept = 0;
 
 
 
        // Coupling:

        virtual bool Couple( EndType end, Bogie& with, EndType withEnd, bool btriggerPulses = true ) noexcept = 0;
 

        virtual std::pair<std::shared_ptr<Bogie>,EndType> GetCoupledBogie( EndType end ) const noexcept = 0;
 

        struct CouplingProps{
            enum BreakingType{ 
                onNever,                            
                onForceLimitReached,                
                onMomentumConsumed,                 
                onMomentumConsumedWithRecuperation  
            } Type = onNever;                       
 
            spat::Sphere<Length>    Position = { spat::Origin3D<Length>, 0.5_m };   
            Force                   BreakingForce = infinite__force;                
            Momentum                BreakingSpareMomentum = 0_Ns;                   
            Force                   RecuperationForce = 0_N;                        
            int                     CouplingTypeIdx = 0;                            
        };
 

        virtual void SetCouplingProps( EndType atEnd, const CouplingProps& props ) = 0;
 

        virtual CouplingProps GetCouplingProps( EndType atEnd ) const noexcept = 0;
 
 
        virtual spat::Sphere<Length> GetCoupling( EndType end ) const noexcept = 0;
 

        virtual void SetCouplingHeight( EndType end, Length height ) = 0;
 

        virtual bool BreakCoupling( EndType atEnd, bool btriggerPulses = true ) noexcept = 0;
 
 
 
        // Jacks 'N Plugs:

        virtual Jack& JackOnMotorStart() noexcept = 0;
 

        virtual Jack& JackOnMotorStop() noexcept = 0;
 

        virtual Jack& JackOnBrakeApply() noexcept = 0;
 

        virtual Jack& JackOnBrakeRelease() noexcept = 0;
 

        virtual Jack& JackOnCouplingForceLimitExceeded( EndType end ) = 0;
 

        virtual Jack& JackOnNorthSwivelBendingIn() noexcept = 0;
 

        virtual Jack& JackOnNorthSwivelBendingOut() noexcept = 0;
 

        virtual Jack& JackOnSouthSwivelBendingIn() noexcept = 0;
 

        virtual Jack& JackOnSouthSwivelBendingOut() noexcept = 0;
    };
 
    dclspc bool Couple( std::pair<Bogie&,RailRunner::EndType> a, std::pair<Bogie&,RailRunner::EndType> b ) noexcept;
 
    dclspc bool AreCoupled( const Bogie& a, const Bogie& b ) noexcept;
 
    dclspc Length GetCouplingDistance( std::pair<const Bogie&,RailRunner::EndType> a, std::pair<const Bogie&,RailRunner::EndType> b ) noexcept;
}