//
// ********************************************************************
// * License and Disclaimer                                           *
// *                                                                  *
// * The  Geant4 software  is  copyright of the Copyright Holders  of *
// * the Geant4 Collaboration.  It is provided  under  the terms  and *
// * conditions of the Geant4 Software License,  included in the file *
// * LICENSE and available at  http://cern.ch/geant4/license .  These *
// * include a list of copyright holders.                             *
// *                                                                  *
// * Neither the authors of this software system, nor their employing *
// * institutes,nor the agencies providing financial support for this *
// * work  make  any representation or  warranty, express or implied, *
// * regarding  this  software system or assume any liability for its *
// * use.  Please see the license in the file  LICENSE  and URL above *
// * for the full disclaimer and the limitation of liability.         *
// *                                                                  *
// * This  code  implementation is the result of  the  scientific and *
// * technical work of the GEANT4 collaboration.                      *
// * By using,  copying,  modifying or  distributing the software (or *
// * any work based  on the software)  you  agree  to acknowledge its *
// * use  in  resulting  scientific  publications,  and indicate your *
// * acceptance of all terms of the Geant4 Software license.          *
// ********************************************************************
//
// G4ParticleChangeForTransport
//
// Class description:
//
// Concrete class for ParticleChange for transportation.

// Author: Hisaya Kurashige, 10 May 1998
// --------------------------------------------------------------------
#ifndef G4ParticleChangeForTransport_hh
#define G4ParticleChangeForTransport_hh 1

#include "globals.hh"
#include "G4ios.hh"
#include "G4TouchableHandle.hh"
#include "G4ParticleChange.hh"

class G4MaterialCutsCouple;
class G4VSensitiveDetector;

class G4ParticleChangeForTransport final : public G4ParticleChange
{
  public:

    G4ParticleChangeForTransport();

    ~G4ParticleChangeForTransport() override = default;

    G4ParticleChangeForTransport(const G4ParticleChangeForTransport& right) = delete;
    G4ParticleChangeForTransport& operator=(const G4ParticleChangeForTransport& right) = delete;

  // --- the following methods are for updating G4Step ---
  // Return the pointer to the G4Step after updating the Step information
  // by using final state information of the track given by a physics process

    G4Step* UpdateStepForAlongStep(G4Step* Step) final;
    G4Step* UpdateStepForAtRest(G4Step* Step) final;
    G4Step* UpdateStepForPostStep(G4Step* Step) final;
      // A physics process gives the final state of the particle
      // based on information of G4Track (or equivalently the PreStepPoint)

    void Initialize(const G4Track&) final;
      // Initialize all properties by using G4Track information

  // --- methods to keep information of the final state ---
  // IMPORTANT NOTE: despite the name, what this class stores/returns
  // through its methods, are the "FINAL" values of the Position, Momentum, etc.

    inline const G4TouchableHandle& GetTouchableHandle() const;
    inline void SetTouchableHandle(const G4TouchableHandle& fTouchable);
      // Get/Set the touchable of the current particle.
      // Note: Touchable in PostStepPoint will be updated only after
      // PostStepDoIt

    inline G4Material* GetMaterialInTouchable() const;
    inline void SetMaterialInTouchable(G4Material* fMaterial);
      // Get/Propose the material in the touchable of the current particle

    inline const G4MaterialCutsCouple* GetMaterialCutsCoupleInTouchable() const;
    inline void SetMaterialCutsCoupleInTouchable(
    const G4MaterialCutsCouple* fMaterialCutsCouple);
      // Get/Set the materialCutsCouple in the touchable of the current
      // particle

    inline G4VSensitiveDetector* GetSensitiveDetectorInTouchable() const;
    inline void SetSensitiveDetectorInTouchable(
    G4VSensitiveDetector* fSensitiveDetector);
      // Get/Set the sensitive detector in the touchable of the current particle

    inline G4bool GetMomentumChanged() const;
    inline void SetMomentumChanged(G4bool b);

    inline void
    SetPointerToVectorOfAuxiliaryPoints(std::vector<G4ThreeVector>* vec);
    inline std::vector<G4ThreeVector>*
    GetPointerToVectorOfAuxiliaryPoints() const;
      // Smooth representation of curved trajectories

    void DumpInfo() const final;

  private:

    G4TouchableHandle theTouchableHandle;
      // The changed touchable of a given particle

    G4bool isMomentumChanged = false;
      // The flag which is set if momentum is changed in current step

    G4Material* theMaterialChange = nullptr;

    const G4MaterialCutsCouple* theMaterialCutsCoupleChange = nullptr;

    G4VSensitiveDetector* theSensitiveDetectorChange = nullptr;
      // The material (and MaterialCutsCouple) where given track
      // currently locates

    std::vector<G4ThreeVector>* fpVectorOfAuxiliaryPointsPointer = nullptr;
};

#include "G4ParticleChangeForTransport.icc"

#endif