TrackCollection.h

//  trax track library
//  AD 2014 
//
//  "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 "trax/Identified.h"
#include "Collection.h"
#include "CollectionDecorator.h"
#include "trax/Track.h"
 
#include <vector>
 
namespace spat{
    template<typename> struct Sphere;
}
 
namespace trax{
 
    class Location;

    struct TrackCollection :    Collection<TrackCollection,TrackBuilder>,
                                Identified<TrackCollection>
    {
        static dclspc std::unique_ptr<TrackCollection> Make() noexcept;
 

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

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

    std::vector<std::tuple<std::shared_ptr<TrackBuilder>,Track::EndType,Length>> dclspc FindTrackEnds( const TrackCollection& collection, const spat::Sphere<Length>& area, bool sort = false );
 

    std::vector<std::pair<Location,Length>> dclspc FindTrackLocations( const TrackCollection& collection, const spat::Sphere<Length>& area, bool sort = false );
    

    std::vector<std::pair<Location,Length>> dclspc FindTrackLocations( const TrackCollection& collection, const spat::VectorBundle<Length,One>& ray, Length gauge, bool sort = false );
 

    std::pair<std::shared_ptr<TrackBuilder>,Track::EndType> dclspc Snap( const TrackCollection& collection, TrackBuilder& track, Track::EndType endType, Length maxDistance, bool bUncoupled = true );
 

    std::pair<std::shared_ptr<TrackBuilder>,Track::EndType> dclspc Couple( const TrackCollection& collection, TrackBuilder& track, Track::EndType endType, Length maxDistance = 1_m, Angle maxKink = pi, bool bSilent = true );
 

    class TrackCollectionDecorator : public CollectionDecorator<ObjectIDDecorator<Decorator<TrackCollection>>>{
    public:
        typedef TrackCollection ComponentType;
 
 
        TrackCollectionDecorator() = delete;

        TrackCollectionDecorator( std::shared_ptr<TrackCollection> pTrackCollection )
            : CollectionDecorator<ObjectIDDecorator<Decorator<TrackCollection>>>{ pTrackCollection }
        {}
 
        void SetFrame( const spat::Frame<Length, One>& frame ) noexcept override{
            return m_pComponent->SetFrame(frame);
        }
 
        const spat::Frame<Length, One>& GetFrame() const noexcept override{
            return m_pComponent->GetFrame();
        }
    };
}