G4VRML2FileSceneHandler Class Reference

#include <G4VRML2FileSceneHandler.hh>

Inheritance diagram for G4VRML2FileSceneHandler:

Public Member Functions
	G4VRML2FileSceneHandler (G4VRML2File &system, const G4String &name="")
virtual	~G4VRML2FileSceneHandler ()
void	AddSolid (const G4Box &)
void	AddSolid (const G4Cons &)
void	AddSolid (const G4Tubs &)
void	AddSolid (const G4Trd &)
void	AddSolid (const G4Trap &)
void	AddSolid (const G4Sphere &)
void	AddSolid (const G4Para &)
void	AddSolid (const G4Torus &)
void	AddSolid (const G4Polycone &polycone)
void	AddSolid (const G4Polyhedra &polyhedra)
void	AddSolid (const G4VSolid &)
void	AddCompound (const G4VTrajectory &traj)
void	AddCompound (const G4VHit &hit)
void	AddCompound (const G4VDigi &digi)
void	AddCompound (const G4THitsMap< G4double > &hits)
void	BeginPrimitives (const G4Transform3D &objectTransformation)
void	EndPrimitives ()
void	AddPrimitive (const G4Polyline &)
void	AddPrimitive (const G4Polyhedron &)
void	AddPrimitive (const G4Text &)
void	AddPrimitive (const G4Circle &)
void	AddPrimitive (const G4Square &)
void	AddPrimitive (const G4Polymarker &polymarker)
void	AddPrimitive (const G4Scale &scale)
void	ClearTransientStore ()
void	BeginModeling ()
void	EndModeling ()
void	VRMLBeginModeling ()
void	VRMLEndModeling ()
void	connectPort ()
void	closePort ()
Public Member Functions inherited from G4VSceneHandler
	G4VSceneHandler (G4VGraphicsSystem &system, G4int id, const G4String &name="")
virtual	~G4VSceneHandler ()
virtual void	PreAddSolid (const G4Transform3D &objectTransformation, const G4VisAttributes &)
virtual void	PostAddSolid ()
virtual void	BeginPrimitives2D (const G4Transform3D &objectTransformation)
virtual void	EndPrimitives2D ()
virtual const G4VisExtent &	GetExtent () const
const G4String &	GetName () const
G4int	GetSceneHandlerId () const
G4int	GetViewCount () const
G4VGraphicsSystem *	GetGraphicsSystem () const
G4Scene *	GetScene () const
const G4ViewerList &	GetViewerList () const
G4VModel *	GetModel () const
G4VViewer *	GetCurrentViewer () const
G4bool	GetMarkForClearingTransientStore () const
G4bool	IsReadyForTransients () const
G4bool	GetTransientsDrawnThisEvent () const
G4bool	GetTransientsDrawnThisRun () const
const G4Transform3D &	GetObjectTransformation () const
void	SetName (const G4String &)
void	SetCurrentViewer (G4VViewer *)
virtual void	SetScene (G4Scene *)
G4ViewerList &	SetViewerList ()
void	SetModel (G4VModel *)
void	SetMarkForClearingTransientStore (G4bool)
void	SetTransientsDrawnThisEvent (G4bool)
void	SetTransientsDrawnThisRun (G4bool)
void	SetObjectTransformation (const G4Transform3D &)
const G4Colour &	GetColour (const G4Visible &)
const G4Colour &	GetColor (const G4Visible &)
const G4Colour &	GetTextColour (const G4Text &)
const G4Colour &	GetTextColor (const G4Text &)
G4double	GetLineWidth (const G4VisAttributes *)
G4ViewParameters::DrawingStyle	GetDrawingStyle (const G4VisAttributes *)
G4bool	GetAuxEdgeVisible (const G4VisAttributes *)
G4int	GetNoOfSides (const G4VisAttributes *)
G4double	GetMarkerSize (const G4VMarker &, MarkerSizeType &)
G4double	GetMarkerDiameter (const G4VMarker &, MarkerSizeType &)
G4double	GetMarkerRadius (const G4VMarker &, MarkerSizeType &)
G4ModelingParameters *	CreateModelingParameters ()
void	DrawEvent (const G4Event *)
void	DrawEndOfRunModels ()
G4int	IncrementViewCount ()
virtual void	ClearStore ()
void	AddViewerToList (G4VViewer *pView)
void	RemoveViewerFromList (G4VViewer *pView)
Public Member Functions inherited from G4VGraphicsScene
	G4VGraphicsScene ()
virtual	~G4VGraphicsScene ()

Data Fields
std::ofstream	fDest

Friends
class	G4VRML2FileViewer

Additional Inherited Members
Public Types inherited from G4VSceneHandler
enum	MarkerSizeType { world, screen }
Protected Member Functions inherited from G4VSceneHandler
virtual void	ProcessScene ()
virtual void	RequestPrimitives (const G4VSolid &solid)
virtual G4VSolid *	CreateSectionSolid ()
virtual G4VSolid *	CreateCutawaySolid ()
void	LoadAtts (const G4Visible &, G4AttHolder *)
Protected Attributes inherited from G4VSceneHandler
G4VGraphicsSystem &	fSystem
const G4int	fSceneHandlerId
G4String	fName
G4int	fViewCount
G4ViewerList	fViewerList
G4VViewer *	fpViewer
G4Scene *	fpScene
G4bool	fMarkForClearingTransientStore
G4bool	fReadyForTransients
G4bool	fTransientsDrawnThisEvent
G4bool	fTransientsDrawnThisRun
G4bool	fProcessingSolid
G4bool	fProcessing2D
G4VModel *	fpModel
G4Transform3D	fObjectTransformation
G4int	fNestingDepth
const G4VisAttributes *	fpVisAttribs
const G4Transform3D	fIdentityTransformation

Detailed Description

Definition at line 45 of file G4VRML2FileSceneHandler.hh.

Constructor & Destructor Documentation

G4VRML2FileSceneHandler::G4VRML2FileSceneHandler	(	G4VRML2File &	system,
		const G4String &	name = ""
	)

Definition at line 73 of file G4VRML2FileSceneHandler.cc.

References DEFAULT_MAX_WRL_FILE_NUM, and VRMLFILE_DEST_DIR.

                                                                                          :
    G4VSceneHandler(system, fSceneIdCount++, name),
    fSystem(system),
    fFlagDestOpen( false ),
    fPVPickable  ( false ),
        fDest()
{
    // output file name
    strcpy(fVRMLFileName, "");

    // destination directory
    if ( getenv( VRMLFILE_DEST_DIR ) == NULL ) {
        strcpy( fVRMLFileDestDir, "" );
    } else {
        strcpy( fVRMLFileDestDir, getenv( VRMLFILE_DEST_DIR ) );
    }


    // maximum number of g4.prim files in the dest directory
    fMaxFileNum = DEFAULT_MAX_WRL_FILE_NUM ; // initialization
    if ( getenv( "G4VRMLFILE_MAX_FILE_NUM" ) != NULL ) {    
        
        sscanf( getenv("G4VRMLFILE_MAX_FILE_NUM"), "%d", &fMaxFileNum ) ;

    } else {
        fMaxFileNum = DEFAULT_MAX_WRL_FILE_NUM ;
    }
    if( fMaxFileNum < 1 ) { fMaxFileNum = 1; }


    // PV name pickability  
    if( getenv( "G4VRML_PV_PICKABLE" ) != NULL ) {

        int is_pickable ;
        sscanf( getenv("G4VRML_PV_PICKABLE"), "%d", &is_pickable ) ;

        if ( is_pickable ) { SetPVPickability ( true ) ; }
    } 

    // PV Transparency
    SetPVTransparency ();

}

G4VRML2FileSceneHandler::~G4VRML2FileSceneHandler ( )

virtual

Definition at line 118 of file G4VRML2FileSceneHandler.cc.

References G4VisManager::errors, G4cout, G4endl, G4VisManager::GetVerbosity(), and VRMLEndModeling().

{
#if defined DEBUG_FR_SCENE
  if (G4VisManager::GetVerbosity() >= G4VisManager::errors)
    G4cout << "***** ~G4VRML2FileSceneHandler" << G4endl;
#endif 
    VRMLEndModeling();
}

Member Function Documentation

void G4VRML2FileSceneHandler::AddCompound ( const G4VTrajectory &  traj )

inlinevirtual

Reimplemented from G4VSceneHandler.

Definition at line 68 of file G4VRML2FileSceneHandler.hh.

References G4VSceneHandler::AddCompound().

                                                      {
          G4VSceneHandler::AddCompound(traj);
        }

void G4VRML2FileSceneHandler::AddCompound ( const G4VHit &  hit )

inlinevirtual

Reimplemented from G4VSceneHandler.

Definition at line 71 of file G4VRML2FileSceneHandler.hh.

References G4VSceneHandler::AddCompound().

                                              {
          G4VSceneHandler::AddCompound(hit);
        }

void G4VRML2FileSceneHandler::AddCompound ( const G4VDigi &  digi )

inlinevirtual

Reimplemented from G4VSceneHandler.

Definition at line 74 of file G4VRML2FileSceneHandler.hh.

References G4VSceneHandler::AddCompound().

                                                {
          G4VSceneHandler::AddCompound(digi);
        }

void G4VRML2FileSceneHandler::AddCompound ( const G4THitsMap< G4double > &  hits )

inlinevirtual

Reimplemented from G4VSceneHandler.

Definition at line 77 of file G4VRML2FileSceneHandler.hh.

References G4VSceneHandler::AddCompound().

                                                              {
      G4VSceneHandler::AddCompound(hits);
    }

void G4VRML2FileSceneHandler::AddPrimitive ( const G4Polyline &  )

virtual

Implements G4VSceneHandler.

void G4VRML2FileSceneHandler::AddPrimitive ( const G4Polyhedron &  )

virtual

Implements G4VSceneHandler.

void G4VRML2FileSceneHandler::AddPrimitive ( const G4Text &  )

virtual

Implements G4VSceneHandler.

void G4VRML2FileSceneHandler::AddPrimitive ( const G4Circle &  )

virtual

Implements G4VSceneHandler.

void G4VRML2FileSceneHandler::AddPrimitive ( const G4Square &  )

virtual

Implements G4VSceneHandler.

void G4VRML2FileSceneHandler::AddPrimitive ( const G4Polymarker &  polymarker )

inlinevirtual

Reimplemented from G4VSceneHandler.

Definition at line 89 of file G4VRML2FileSceneHandler.hh.

References G4VSceneHandler::AddPrimitive().

        { G4VSceneHandler::AddPrimitive (polymarker); }

void G4VRML2FileSceneHandler::AddPrimitive ( const G4Scale &  scale )

inlinevirtual

Reimplemented from G4VSceneHandler.

Definition at line 91 of file G4VRML2FileSceneHandler.hh.

References G4VSceneHandler::AddPrimitive().

                { G4VSceneHandler::AddPrimitive (scale); }

void G4VRML2FileSceneHandler::AddSolid ( const G4Box &  )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::AddSolid ( const G4Cons &  )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::AddSolid ( const G4Tubs &  )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::AddSolid ( const G4Trd &  )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::AddSolid ( const G4Trap &  )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::AddSolid ( const G4Sphere &  )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::AddSolid ( const G4Para &  )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::AddSolid ( const G4Torus &  )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::AddSolid ( const G4Polycone &  polycone )

inlinevirtual

Reimplemented from G4VSceneHandler.

Definition at line 61 of file G4VRML2FileSceneHandler.hh.

References G4VSceneHandler::AddSolid().

                                                     {
          G4VSceneHandler::AddSolid (polycone);
        }

void G4VRML2FileSceneHandler::AddSolid ( const G4Polyhedra &  polyhedra )

inlinevirtual

Reimplemented from G4VSceneHandler.

Definition at line 64 of file G4VRML2FileSceneHandler.hh.

References G4VSceneHandler::AddSolid().

                                                      {
          G4VSceneHandler::AddSolid (polyhedra);
        }

void G4VRML2FileSceneHandler::AddSolid ( const G4VSolid &  )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::BeginModeling ( )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::BeginPrimitives ( const G4Transform3D &  objectTransformation )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::ClearTransientStore ( )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::closePort

(

)

Definition at line 196 of file G4VRML2FileSceneHandler.cc.

References ENV_VRML_VIEWER, G4VisManager::errors, fDest, G4cout, G4endl, G4VisManager::GetVerbosity(), NO_VRML_VIEWER, and void().

{
    char command[256] ;
    char viewer [256] ; 
    strcpy( viewer, NO_VRML_VIEWER ); // initialization
    if( getenv( ENV_VRML_VIEWER ) ) {
        strcpy( viewer, getenv( ENV_VRML_VIEWER ) ) ;
    }

    // close VRML file  
    fDest.close();  fFlagDestOpen = false ;
    if (G4VisManager::GetVerbosity() >= G4VisManager::errors)
          G4cout << "*** VRML 2.0 File  " << fVRMLFileName << "  is generated." << G4endl;

    
    // Invoke viewer 

    if ( !strcmp(viewer, NO_VRML_VIEWER )) {
      if (G4VisManager::GetVerbosity() >= G4VisManager::errors) {
        G4cout << "MESSAGE from VRML2FILE driver:"     << G4endl;
        G4cout << "    Set an environmental variable  " ;
        G4cout <<      ENV_VRML_VIEWER << G4endl;
        G4cout << "    if you want to visualize the generated VRML file" << G4endl; 
        G4cout << "    automatically.  For example, " << G4endl;
        G4cout << "    setenv  " << ENV_VRML_VIEWER << "  vrwave " << G4endl;
      }
    } else {
        sprintf( command, "%s %s", viewer, fVRMLFileName  );   
        (void) system( command );
    }
}

void G4VRML2FileSceneHandler::connectPort

(

)

Definition at line 135 of file G4VRML2FileSceneHandler.cc.

References DEFAULT_WRL_FILE_NAME, G4VisManager::errors, fDest, G4cout, G4endl, G4VisManager::GetVerbosity(), and WRL_FILE_HEADER.

{
    // g4_00.wrl, g4_01.wrl, ..., g4_MAX_FILE_INDEX.wrl
    const int MAX_FILE_INDEX = fMaxFileNum - 1 ;

    // dest directory (null if no environmental variables is set)
    strcpy ( fVRMLFileName, fVRMLFileDestDir) ; 

    // create full path name (default)
    strcat ( fVRMLFileName, DEFAULT_WRL_FILE_NAME );

    // Determine VRML file name
    for( int i = 0 ; i < fMaxFileNum ; i++) { 

        // Message in the final execution
        if( i == MAX_FILE_INDEX ) 
        {
          if (G4VisManager::GetVerbosity() >= G4VisManager::errors) {
            G4cout << "==========================================="   << G4endl; 
            G4cout << "WARNING MESSAGE from VRML2FILE driver:     "   << G4endl;
            G4cout << "  This file name is the final one in the   "   << G4endl;
            G4cout << "  automatic updation of the output file name." << G4endl; 
            G4cout << "  You may overwrite existing files, i.e.   "   << G4endl; 
            G4cout << "  g4_XX.wrl.                               "   << G4endl;
            G4cout << "==========================================="   << G4endl; 
          }
        }

        // re-determine file name as G4VRMLFILE_DEST_DIR/g4_XX.wrl 
        if( i >=  0 && i <= 9 ) { 
            sprintf( fVRMLFileName, "%s%s%s%d.wrl" , fVRMLFileDestDir,  WRL_FILE_HEADER, "0", i );
        } else {
            sprintf( fVRMLFileName, "%s%s%d.wrl"   , fVRMLFileDestDir,  WRL_FILE_HEADER, i );
        }

        // check validity of the file name
        std::ifstream  fin ; 
        fin.open(fVRMLFileName) ;
        if(!fin) { 
            // new file 
            fin.close();  
            break; 
        } else { 
            // already exists (try next) 
            fin.close(); 
        } 

    } // for 

    // open a VRML 2.0 file with determined file name
    if (G4VisManager::GetVerbosity() >= G4VisManager::errors) {
      G4cout << "==========================================="  << G4endl; 
      G4cout << "Output VRML 2.0 file: " <<    fVRMLFileName << G4endl; 
      G4cout << "Maximum number of files in the destination directory: " << fMaxFileNum << G4endl; 
      G4cout << "  (Customizable with the environment variable: G4VRMLFILE_MAX_FILE_NUM) " << G4endl;
      G4cout << "===========================================" << G4endl; 
    }
    fDest.open(fVRMLFileName) ;  fFlagDestOpen =  true ;
}

void G4VRML2FileSceneHandler::EndModeling ( )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::EndPrimitives ( )

virtual

Reimplemented from G4VSceneHandler.

void G4VRML2FileSceneHandler::VRMLBeginModeling

(

)

Referenced by G4VRML2FileViewer::DrawView().

void G4VRML2FileSceneHandler::VRMLEndModeling

(

)

Referenced by G4VRML2FileViewer::ShowView(), and ~G4VRML2FileSceneHandler().

Friends And Related Function Documentation

friend class G4VRML2FileViewer

friend

Definition at line 47 of file G4VRML2FileSceneHandler.hh.

Field Documentation

std::ofstream G4VRML2FileSceneHandler::fDest

Definition at line 144 of file G4VRML2FileSceneHandler.hh.

Referenced by G4VRML2FileViewer::ClearView(), closePort(), and connectPort().

---

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

• G4VRML2FileSceneHandler.hh
• G4VRML2FileSceneHandler.cc