WheelFrame.h

//  trax track library
//  AD 2023 
//
//  "the resolution of all the fruitless searches"
//
//                              Peter Gabriel
// 
// 
// 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 "Bogie.h"
#include "trax/Event.h"
 
namespace trax{
 
    struct TractionForceCharacteristic;
    struct Wheelset;
    struct TrackJointLimits;

    struct WheelFrame : virtual Bogie
    {

        static dclspc std::shared_ptr<WheelFrame> Make( Scene& scene, std::shared_ptr<Gestalt> pGestalt = nullptr ) noexcept;
 
 

        virtual void Limits( const TrackJointLimits& wfl ) = 0;
 

        virtual const TrackJointLimits& Limits() const noexcept = 0;
 

        virtual std::shared_ptr<const TractionForceCharacteristic> SetTractionForceCharacteristic( std::shared_ptr<const TractionForceCharacteristic> pCharacteristic ) = 0;
 

        virtual std::shared_ptr<const TractionForceCharacteristic> GetTractionForceCharacteristic() const = 0;
 

        virtual void EnableDerailing( bool bEnable = true ) noexcept = 0;
 

        virtual bool IsDerailingEnabled() const noexcept = 0;
 
 

        
        virtual void Anchor( const spat::Frame<Length,One>& anchor ) noexcept = 0;

        virtual spat::Frame<Length,One> Anchor() const noexcept = 0;

        virtual spat::Frame<Length,One> UnflippedAnchor() const noexcept = 0;
 
 
        //Wheelsets:
 
        using Bogie::Attach;

        virtual int Attach( const Wheelset& ws ) = 0;
 

        virtual void DetachAllWheelsets() = 0;
 

        virtual int CntWheelsets() const noexcept = 0;
 

        virtual const Wheelset& GetWheelset( int idx ) const = 0;
 
 
        struct Event : trax::Event{
 
            virtual WheelFrame& GetWheelFrame() const noexcept = 0;
        };
 
        // Jacks 'N Plugs:

        virtual Jack& JackOnRail() noexcept = 0;
 

        virtual Jack& JackOnDerail() noexcept = 0;
 

        virtual Jack& JackOnRollingStart() noexcept = 0;
 

        virtual Jack& JackOnRollingStop() noexcept = 0;
 
        
        virtual Jack& JackOnMotorActive() noexcept = 0;
 

        virtual Jack& JackOnMotorInactive() noexcept = 0;
 

        virtual Jack& JackOnBrakeActive() noexcept = 0;
 

        virtual Jack& JackOnBrakeInactive() noexcept = 0;
 

        virtual Jack& JackOnTrackTransition() noexcept = 0;
 

        virtual Jack& JackOnStartTilting() noexcept = 0;
 

        virtual Jack& JackOnStopTilting() noexcept = 0;
    };
 
    // Were is this used?
    //std::shared_ptr<Bogie> RemoveUnusedWheelFrames( std::shared_ptr<Bogie> pBogie );
 
}