source: trunk/source/visualization/modeling/include/G4VisTrajContext.hh @ 1337

//
// ********************************************************************
// * 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.          *
// ********************************************************************
//
// $Id: G4VisTrajContext.hh,v 1.4 2009/02/24 12:00:56 allison Exp $
// GEANT4 tag $Name: geant4-09-04-beta-01 $
//
// Jane Tinslay May 2006
//
#ifndef G4VISTRAJCONTEXT_HH
#define G4VISTRAJCONTEXT_HH

#include "G4Colour.hh"
#include "G4Polymarker.hh"

class G4VisTrajContext {

public:

  // Default configuration
  G4VisTrajContext(const G4String& name = "Unspecified");

  // Destructor
  virtual ~G4VisTrajContext();

  G4String Name() const;
  
  void SetVisible(const G4bool& visible); 

  // Print configuration
  void Print(std::ostream& ostr) const;

  // Line
  void SetLineColour(const G4Colour& colour);
  G4Colour GetLineColour() const;

  void SetDrawLine(const G4bool& draw); 
  G4bool GetDrawLine() const;

  void SetLineVisible(const G4bool& visible);
  G4bool GetLineVisible() const;

  // Auxiliary points
  void SetDrawAuxPts(const G4bool& draw);
  G4bool GetDrawAuxPts() const;

  void SetAuxPtsType(const G4Polymarker::MarkerType& marker);
  G4Polymarker::MarkerType GetAuxPtsType() const;

  void SetAuxPtsSize(const G4double& size);
  G4double GetAuxPtsSize() const;

  void SetAuxPtsSizeType(const G4VMarker::SizeType& sizeType);
  G4VMarker::SizeType GetAuxPtsSizeType() const;

  void SetAuxPtsFillStyle(const G4VMarker::FillStyle& style);
  G4VMarker::FillStyle GetAuxPtsFillStyle() const;

  void SetAuxPtsColour(const G4Colour& colour);
  G4Colour GetAuxPtsColour() const;

  void SetAuxPtsVisible(const G4bool& visible);
  G4bool GetAuxPtsVisible() const;

  // Step points
  void SetDrawStepPts(const G4bool& draw);
  G4bool GetDrawStepPts() const;

  void SetStepPtsType(const G4Polymarker::MarkerType& marker);
  G4Polymarker::MarkerType GetStepPtsType() const;

  void SetStepPtsSize(const G4double& size);
  G4double GetStepPtsSize() const;

  void SetStepPtsSizeType(const G4VMarker::SizeType& sizeType);
  G4VMarker::SizeType GetStepPtsSizeType() const;

  void SetStepPtsFillStyle(const G4VMarker::FillStyle& style);
  G4VMarker::FillStyle GetStepPtsFillStyle() const;

  void SetStepPtsColour(const G4Colour& colour);
  G4Colour GetStepPtsColour() const;

  void SetStepPtsVisible(const G4bool& visible);
  G4bool GetStepPtsVisible() const;

  void SetTimeSliceInterval(const G4double& interval);
  G4double GetTimeSliceInterval() const;

private:
  
  // Data members
  G4String fName;

  // Line data
  G4Colour fLineColour;
  G4bool fLineVisible;
  G4bool fDrawLine;

  // Auxiliary point data
  G4bool fDrawAuxPts;
  G4Polymarker::MarkerType fAuxPtsType;
  G4double fAuxPtsSize;
  G4VMarker::SizeType fAuxPtsSizeType;
  G4VMarker::FillStyle fAuxPtsFillStyle;
  G4Colour fAuxPtsColour;
  G4bool fAuxPtsVisible;

  // Step point data
  G4bool fDrawStepPts;
  G4Polymarker::MarkerType fStepPtsType;
  G4double fStepPtsSize;
  G4VMarker::SizeType fStepPtsSizeType;
  G4VMarker::FillStyle fStepPtsFillStyle;
  G4Colour fStepPtsColour;
  G4bool fStepPtsVisible;

  // Time slicing
  G4double fTimeSliceInterval;

};

#include "G4VisTrajContext.icc"

#endif