Connector.h

//  trax track library
//  AD 2014 
//
//  "Hold up that light 
//   I'm lost at sea
//   But I'm coming way home"
//
//              Arkells
//
// 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 "Identified.h"
#include "Track.h"
#include "ConnectorType.h"
 
namespace trax{
 
    struct MultiPlug;
    struct Jack;
    struct SocketRegistry;
 
    class Location;
 
    struct ConnectorUserData;

    struct Connector : Identified<Connector>
    {
        virtual ConnectorType GetConnectorType() const noexcept = 0;
 

        virtual const char* TypeName() const noexcept = 0;
 

        virtual bool IsValid() const noexcept = 0;
 

        virtual void Toggle( bool pulse = true ) = 0;
 

        virtual void Set( const Track& trackA, Track::EndType trackendA, const Track& trackB, Track::EndType trackendB, bool pulse = true ) = 0;
 

        virtual void Disconnect() = 0;
 

        virtual int Slot( int slot, std::shared_ptr<TrackBuilder> pTrack, Track::EndType trackend, bool connectAnonymous = false ) = 0;
 

        virtual int Slot( std::shared_ptr<TrackBuilder> pTrack, Track::EndType trackend, bool connectAnonymous = false ) = 0;
 

        virtual std::pair<std::shared_ptr<TrackBuilder>,Track::EndType> Slot( int slot ) const noexcept = 0;
 

        virtual int Slot( const Track& track, Track::EndType trackend ) const = 0;
 

        virtual int CntSlots() const noexcept = 0;
 

        virtual void SwapSlots( int slotA, int slotB ) = 0;
 

        virtual bool IsComplete() const = 0;
 

        virtual bool Check( std::ostream& os, Length e_distance = epsilon__length, Angle e_kink = epsilon__angle, Angle e_twist = epsilon__angle ) const noexcept = 0;
 

        virtual void Clear( int slot ) = 0;
 

        virtual void Clear() = 0;
 

        virtual void GetCenter( spat::Frame<Length,One>& center ) const = 0;
 

        virtual MultiPlug& PlugToToggle() noexcept = 0;
 

        virtual const MultiPlug& PlugToToggle() const noexcept = 0;
 

        virtual Jack& JackOnChange() noexcept = 0;
 

        virtual const Jack& JackOnChange() const noexcept = 0;
 

        virtual void RegisterSockets( SocketRegistry& modul ) = 0;
 

        virtual void UnregisterSockets( SocketRegistry& modul ) = 0;
 

        virtual void UserData( ConnectorUserData* pData ) noexcept = 0;
 

        virtual ConnectorUserData* UserData() const noexcept = 0;
    };
 

    dclspc void Couple( 
        std::pair<std::shared_ptr<TrackBuilder>,Track::EndType> trackEndA, 
        std::pair<std::shared_ptr<TrackBuilder>,Track::EndType> trackEndB, 
        int slotA = -1,
        int slotB = -1,
        bool connectAnyway = false );
 

    dclspc void DeCouple( TrackBuilder& track, Track::EndType trackEnd, int ownerSlot = -1 );
 
    
    dclspc Location GetFarEndLocation( const Connector& connector, int slotID );
 
    dclspc Location GetEndLocation( const Connector& connector, int slotID );
 

    dclspc spat::Vector<Length> DistanceToOtherEnd( const Connector& connector, int fromSlot );
}