Opened 16 years ago
#1 new defect
Comments on files
Reported by: | Owned by: | somebody | |
---|---|---|---|
Priority: | major | Milestone: | |
Component: | component1 | Version: | |
Keywords: | Cc: |
Description
Le 4 avr. 08 à 17:20, John Allison a écrit :
A few minor comments below...
- The method of commenting functions in Geant4 is dictated by the Geant4 police. Geant4 is so old it pre-dates tools like doxygen and we wrote our own system that creates the Software Reference Manual out of the header files. Unfortunately, we chose the opposite convention to doxygen - our comments come *after* the C++ definition and have a -style. So please allow me to convert your comments in G4ViewParameters.hh to the Geant4 style: void IncrementPan (G4double right, G4double up); Increment currentTarget point perpendicular to viewpoint direction. void IncrementPan (G4double right, G4double up, G4double forward); Increment currentTarget point also along viewpoint direction.
I assume a positive 3rd argument increments forward, i.e., along the line of sight, in the *negative* viewpoint direction? Ah! No! Your code says
fCurrentTargetPoint += right * unitRight + up * unitUp + distance * fViewpointDirection;
is that what you meant? Another Geant4 agreed convention is that all function names start with a capital letter. So your G4OpenGLViewer::getSceneNearWidth() should be G4OpenGLViewer::GetSceneNearWidth(). How about moving these to G4VViewer, anyway?
Note: See
TracTickets for help on using
tickets.