G4Scene Class Reference

#include <G4Scene.hh>

Classes
struct	Model

Public Types
enum	{ UNLIMITED = -1 }

Public Member Functions
	G4Scene (const G4String &name="scene-with-unspecified-name")
	~G4Scene ()
G4bool	operator== (const G4Scene &) const
G4bool	operator!= (const G4Scene &) const
const G4String &	GetName () const
G4bool	IsEmpty () const
const std::vector< Model > &	GetRunDurationModelList () const
const std::vector< Model > &	GetEndOfEventModelList () const
const std::vector< Model > &	GetEndOfRunModelList () const
const G4VisExtent &	GetExtent () const
const G4Point3D &	GetStandardTargetPoint () const
G4bool	GetRefreshAtEndOfEvent () const
G4int	GetMaxNumberOfKeptEvents () const
G4bool	GetRefreshAtEndOfRun () const
G4bool	AddRunDurationModel (G4VModel *, G4bool warn=false)
G4bool	AddWorldIfEmpty (G4bool warn=false)
G4bool	AddEndOfEventModel (G4VModel *, G4bool warn=false)
G4bool	AddEndOfRunModel (G4VModel *, G4bool warn=false)
void	SetName (const G4String &)
std::vector< Model > &	SetRunDurationModelList ()
std::vector< Model > &	SetEndOfEventModelList ()
std::vector< Model > &	SetEndOfRunModelList ()
void	SetRefreshAtEndOfEvent (G4bool)
void	SetMaxNumberOfKeptEvents (G4int)
void	SetRefreshAtEndOfRun (G4bool)
void	CalculateExtent ()

Friends
std::ostream &	operator<< (std::ostream &os, const G4Scene &d)

Detailed Description

Definition at line 49 of file G4Scene.hh.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
UNLIMITED

Definition at line 55 of file G4Scene.hh.

{UNLIMITED = -1};

Constructor & Destructor Documentation

G4Scene()

G4Scene::G4Scene

(

const G4String &

name = "scene-with-unspecified-name"

)

Definition at line 40 of file G4Scene.cc.

                                     :
  fName (name),
  fRefreshAtEndOfEvent(true),
  fRefreshAtEndOfRun(true),
  fMaxNumberOfKeptEvents(0)
{} // Note all other data members have default initial values.

~G4Scene()

G4Scene::~G4Scene

(

)

Definition at line 47 of file G4Scene.cc.

{}

Member Function Documentation

AddEndOfEventModel()

G4bool G4Scene::AddEndOfEventModel	(	G4VModel *	pModel,
		G4bool	warn = false
	)

Definition at line 190 of file G4Scene.cc.

                                                                 {
  G4int i, nModels = fEndOfEventModelList.size ();
  for (i = 0; i < nModels; i++) {
    if (pModel -> GetGlobalDescription () ==
    fEndOfEventModelList[i].fpModel -> GetGlobalDescription ()) break;
  }
  if (i < nModels) {
    if (warn) {
      G4cout << "G4Scene::AddEndOfEventModel: a model \""
         << pModel -> GetGlobalDescription ()
         << "\"\n  is already in the end-of-event list of scene \""
         << fName << "\"."
         << G4endl;
    }
    return false;
  }
  fEndOfEventModelList.push_back (Model(pModel));
  return true;
}

AddEndOfRunModel()

G4bool G4Scene::AddEndOfRunModel	(	G4VModel *	pModel,
		G4bool	warn = false
	)

Definition at line 210 of file G4Scene.cc.

                                                               {
  G4int i, nModels = fEndOfRunModelList.size ();
  for (i = 0; i < nModels; i++) {
    if (pModel -> GetGlobalDescription () ==
    fEndOfRunModelList[i].fpModel -> GetGlobalDescription ()) break;
  }
  if (i < nModels) {
    if (warn) {
      G4cout << "G4Scene::AddEndOfRunModel: a model \""
         << pModel -> GetGlobalDescription ()
         << "\"\n  is already in the end-of-run list of scene \""
         << fName << "\"."
         << G4endl;
    }
    return false;
  }
  fEndOfRunModelList.push_back (pModel);
  return true;
}

AddRunDurationModel()

G4bool G4Scene::AddRunDurationModel	(	G4VModel *	pModel,
		G4bool	warn = false
	)

Definition at line 49 of file G4Scene.cc.

                                                                  {
  std::vector<Model>::const_iterator i;
  for (i = fRunDurationModelList.begin ();
       i != fRunDurationModelList.end (); ++i) {
    if (pModel -> GetGlobalDescription () ==
    i->fpModel->GetGlobalDescription ()) break;
  }
  if (i != fRunDurationModelList.end ()) {
    if (warn) {
      G4cout << "G4Scene::AddRunDurationModel: model \""
         << pModel -> GetGlobalDescription ()
         << "\"\n  is already in the run-duration list of scene \""
         << fName
         << "\"."
         << G4endl;
    }
    return false;
  }
  fRunDurationModelList.push_back (Model(pModel));
  CalculateExtent ();
  return true;
}

Referenced by AddWorldIfEmpty().

AddWorldIfEmpty()

G4bool G4Scene::AddWorldIfEmpty

(

G4bool

warn = false

)

Definition at line 154 of file G4Scene.cc.

                                            {
  G4bool successful = true;
  if (IsEmpty ()) {
    successful = false;
    G4VPhysicalVolume* pWorld =
      G4TransportationManager::GetTransportationManager ()
      -> GetNavigatorForTracking () -> GetWorldVolume ();
    if (pWorld) {
      const G4VisAttributes* pVisAttribs =
    pWorld -> GetLogicalVolume () -> GetVisAttributes ();
      if (!pVisAttribs || pVisAttribs -> IsVisible ()) {
    if (warn) {
      G4cout << 
        "Your \"world\" has no vis attributes or is marked as visible."
        "\n  For a better view of the contents, mark the world as"
        " invisible, e.g.,"
        "\n  myWorldLogicalVol ->"
        " SetVisAttributes (G4VisAttributes::Invisible);"
         << G4endl;
    }
      }
      successful = AddRunDurationModel (new G4PhysicalVolumeModel (pWorld));
      // Note: default depth and no modeling parameters.
      if (successful) {
    if (warn) {
      G4cout <<
    "G4Scene::AddWorldIfEmpty: The scene was empty of run-duration models."
    "\n  \"world\" has been added.";
      G4cout << G4endl;
    }
      }
    }
  }
  return successful;
}

Referenced by G4RayTracerSceneHandler::G4RayTracerSceneHandler().

CalculateExtent()

void G4Scene::CalculateExtent

(

)

Definition at line 72 of file G4Scene.cc.

{
  G4BoundingSphereScene boundingSphereScene;
 
  for (size_t i = 0; i < fRunDurationModelList.size(); i++) {
    if (fRunDurationModelList[i].fActive) {
      G4VModel* model = fRunDurationModelList[i].fpModel;
      if (model -> Validate()) {  // Validates and also recomputes extent.
    const G4VisExtent& thisExtent = model -> GetExtent ();
    G4double thisRadius = thisExtent.GetExtentRadius ();
    if (thisRadius > 0.) {
      G4Point3D thisCentre = thisExtent.GetExtentCentre ();
      thisCentre.transform (model -> GetTransformation ());
      boundingSphereScene.AccrueBoundingSphere (thisCentre, thisRadius);
    }
      } else {
    G4ExceptionDescription ed;
    ed << "Invalid model \"" << model->GetGlobalDescription()
       << "\".\n  Not included in extent calculation.";
    G4Exception
      ("G4Scene::CalculateExtent",
       "visman0201", JustWarning, ed);
      }
    }
  }
 
  for (size_t i = 0; i < fEndOfEventModelList.size(); i++) {
    if (fEndOfEventModelList[i].fActive) {
      G4VModel* model = fEndOfEventModelList[i].fpModel;
      if (model -> Validate()) {  // Validates and also recomputes extent.
    const G4VisExtent& thisExtent = model -> GetExtent ();
    G4double thisRadius = thisExtent.GetExtentRadius ();
    if (thisRadius > 0.) {
      G4Point3D thisCentre = thisExtent.GetExtentCentre ();
      thisCentre.transform (model -> GetTransformation ());
      boundingSphereScene.AccrueBoundingSphere (thisCentre, thisRadius);
    }
      } else {
    G4ExceptionDescription ed;
    ed << "Invalid model \"" << model->GetGlobalDescription()
       << "\".\n  Not included in extent calculation.";
    G4Exception
      ("G4Scene::CalculateExtent",
       "visman0201", JustWarning, ed);
      }
    }
  }
 
  for (size_t i = 0; i < fEndOfRunModelList.size(); i++) {
    if (fEndOfRunModelList[i].fActive) {
      G4VModel* model = fEndOfRunModelList[i].fpModel;
      if (model -> Validate()) {  // Validates and also recomputes extent.
    const G4VisExtent& thisExtent = model -> GetExtent ();
    G4double thisRadius = thisExtent.GetExtentRadius ();
    if (thisRadius > 0.) {
      G4Point3D thisCentre = thisExtent.GetExtentCentre ();
      thisCentre.transform (model -> GetTransformation ());
      boundingSphereScene.AccrueBoundingSphere (thisCentre, thisRadius);
    }
      } else {
    G4ExceptionDescription ed;
    ed << "Invalid model \"" << model->GetGlobalDescription()
       << "\".\n  Not included in extent calculation.";
    G4Exception
      ("G4Scene::CalculateExtent",
       "visman0201", JustWarning, ed);
      }
    }
  }
 
  fExtent = boundingSphereScene.GetBoundingSphereExtent ();
  fStandardTargetPoint = fExtent.GetExtentCentre ();
  if (fExtent.GetExtentRadius() <= 0.) {
    G4Exception
      ("G4Scene::CalculateExtent",
       "visman0202", JustWarning,
       "Scene has no extent.  Please activate or add something."
       "\nThe camera needs to have something to point at!"
       "\n\"/vis/scene/list\" to see list of models.");
  }
}

Referenced by AddRunDurationModel(), G4VisManager::GeometryHasChanged(), G4VisManager::NotifyHandlers(), and G4VisCommandSceneNotifyHandlers::SetNewValue().

GetEndOfEventModelList()

const std::vector< Model > & G4Scene::GetEndOfEventModelList

(

)

const

Referenced by G4GMocrenFileSceneHandler::GFBeginModeling().

GetEndOfRunModelList()

const std::vector< Model > & G4Scene::GetEndOfRunModelList

(

)

const

GetExtent()

const G4VisExtent & G4Scene::GetExtent

(

)

const

Referenced by G4VSceneHandler::AddPrimitive(), CalculateExtent(), G4VSceneHandler::CreateSectionSolid(), G4DAWNFILEViewer::SendViewParameters(), G4VisCommandSceneAddArrow::SetNewValue(), G4VisCommandSceneAddAxes::SetNewValue(), G4VisCommandSceneAddLogo::SetNewValue(), G4VisCommandSceneAddScale::SetNewValue(), and G4RayTracerViewer::SetView().

GetMaxNumberOfKeptEvents()

G4int G4Scene::GetMaxNumberOfKeptEvents

(

)

const

GetName()

const G4String & G4Scene::GetName

(

)

const

Referenced by G4VisManager::GeometryHasChanged(), G4VisManager::NotifyHandlers(), G4VisCommandSceneList::SetNewValue(), and G4VisCommandViewerRefresh::SetNewValue().

GetRefreshAtEndOfEvent()

G4bool G4Scene::GetRefreshAtEndOfEvent

(

)

const

Referenced by G4VSceneHandler::ProcessScene(), G4VisCommandReviewKeptEvents::SetNewValue(), G4VisCommandSceneEndOfEventAction::SetNewValue(), and G4VisCommandSceneEndOfRunAction::SetNewValue().

GetRefreshAtEndOfRun()

G4bool G4Scene::GetRefreshAtEndOfRun

(

)

const

Referenced by G4VSceneHandler::ProcessScene(), G4VisCommandSceneEndOfEventAction::SetNewValue(), and G4VisCommandSceneEndOfRunAction::SetNewValue().

GetRunDurationModelList()

const std::vector< Model > & G4Scene::GetRunDurationModelList

(

)

const

Referenced by G4ASCIITreeSceneHandler::EndModeling(), and G4VisCommandViewerRefresh::SetNewValue().

GetStandardTargetPoint()

const G4Point3D & G4Scene::GetStandardTargetPoint

(

)

const

Referenced by G4DAWNFILEViewer::SendViewParameters(), G4VisCommandViewerSave::SetNewValue(), G4VisCommandsViewerSet::SetNewValue(), and G4RayTracerViewer::SetView().

IsEmpty()

G4bool G4Scene::IsEmpty

(

)

const

Referenced by AddWorldIfEmpty().

operator!=()

G4bool G4Scene::operator!=

(

const G4Scene &

scene

)

const

Definition at line 278 of file G4Scene.cc.

                                                       {
  if (
      (fRunDurationModelList.size () !=
       scene.fRunDurationModelList.size ())                 ||
      (fEndOfEventModelList.size () !=
       scene.fEndOfEventModelList.size ())                  ||
      (fEndOfRunModelList.size () !=
       scene.fEndOfRunModelList.size ())                    ||
      (fExtent               != scene.fExtent)              ||
      !(fStandardTargetPoint == scene.fStandardTargetPoint) ||
      fRefreshAtEndOfEvent   != scene.fRefreshAtEndOfEvent  ||
      fRefreshAtEndOfRun     != scene.fRefreshAtEndOfRun    ||
      fMaxNumberOfKeptEvents != scene.fMaxNumberOfKeptEvents
      ) return true;
 
  /* A complete comparison should, perhaps, include a comparison of
     individual models, but it is not easy to implement operator!= for
     all models.  Also, it would be unfeasible to ask users to
     implement opeerator!= if we ever get round to allowing
     user-defined models.  Moreover, there is no editing of G4Scene
     objects, apart from changing fRefreshAtEndOfEvent, etc; as far as
     models are concerned, all you can ever do is add them, so a test
     on size (above) is enough.
 
  for (size_t i = 0; i < fRunDurationModelList.size (); i++) {
    if (fRunDurationModelList[i] != scene.fRunDurationModelList[i])
      return true;
  }
 
  for (size_t i = 0; i < fEndOfEventModelList.size (); i++) {
    if (fEndOfEventModelList[i] != scene.fEndOfEventModelList[i])
      return true;
  }
 
  for (size_t i = 0; i < fEndOfRunModelList.size (); i++) {
    if (fEndOfRunModelList[i] != scene.fEndOfRunModelList[i])
      return true;
  }
  */
 
  return false;
}

operator==()

G4bool G4Scene::operator==

(

const G4Scene &

)

const

SetEndOfEventModelList()

std::vector< Model > & G4Scene::SetEndOfEventModelList

(

)

Referenced by G4VisCommandSceneActivateModel::SetNewValue().

SetEndOfRunModelList()

std::vector< Model > & G4Scene::SetEndOfRunModelList

(

)

Referenced by G4VisCommandSceneActivateModel::SetNewValue().

SetMaxNumberOfKeptEvents()

void G4Scene::SetMaxNumberOfKeptEvents

(

G4int

)

Referenced by G4VisCommandSceneEndOfEventAction::SetNewValue().

SetName()

void G4Scene::SetName

(

const G4String &

)

SetRefreshAtEndOfEvent()

void G4Scene::SetRefreshAtEndOfEvent

(

G4bool

)

Referenced by G4VisCommandReviewKeptEvents::SetNewValue(), and G4VisCommandSceneEndOfEventAction::SetNewValue().

SetRefreshAtEndOfRun()

void G4Scene::SetRefreshAtEndOfRun

(

G4bool

)

Referenced by G4VisCommandSceneEndOfRunAction::SetNewValue().

SetRunDurationModelList()

std::vector< Model > & G4Scene::SetRunDurationModelList

(

)

Referenced by G4VisCommandSceneActivateModel::SetNewValue().

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  os, const G4Scene &  d  )

friend

Definition at line 230 of file G4Scene.cc.

                                                               {
 
  size_t i;
 
  os << "Scene data:";
 
  os << "\n  Run-duration model list:";
  for (i = 0; i < scene.fRunDurationModelList.size (); i++) {
    if (scene.fRunDurationModelList[i].fActive) os << "\n  Active:   ";
    else os << "\n  Inactive: ";
    os << *(scene.fRunDurationModelList[i].fpModel);
  }
 
  os << "\n  End-of-event model list:";
  for (i = 0; i < scene.fEndOfEventModelList.size (); i++) {
    if (scene.fEndOfEventModelList[i].fActive) os << "\n  Active:   ";
    else os << "\n  Inactive: ";
    os << *(scene.fEndOfEventModelList[i].fpModel);
  }
 
  os << "\n  End-of-run model list:";
  for (i = 0; i < scene.fEndOfRunModelList.size (); i++) {
    if (scene.fEndOfRunModelList[i].fActive) os << "\n  Active:   ";
    else os << "\n  Inactive: ";
    os << *(scene.fEndOfRunModelList[i].fpModel);
  }
 
  os << "\n  Extent or bounding box: " << scene.fExtent;
 
  os << "\n  Standard target point:  " << scene.fStandardTargetPoint;
 
  os << "\n  End of event action set to \"";
  if (scene.fRefreshAtEndOfEvent) os << "refresh\"";
  else {
    os << "accumulate (maximum number of kept events: ";
    if (scene.fMaxNumberOfKeptEvents >= 0) os << scene.fMaxNumberOfKeptEvents;
    else os << "unlimited";
    os << ")";
  }
 
  os << "\n  End of run action set to \"";
  if (scene.fRefreshAtEndOfRun) os << "refresh";
  else os << "accumulate";
  os << "\"";
 
  return os;
}

---

The documentation for this class was generated from the following files:

• G4Scene.hh
• G4Scene.cc