#include <G4AxesModel.hh>

Inheritance diagram for G4AxesModel:

Public Member Functions
void	Construct (G4double x0, G4double y0, G4double z0, G4double length, G4double arrowWidth, const G4String &colourString, const G4String &description, G4bool withAnnotation, G4double textSize, const G4Transform3D &transform)

void	DescribeYourselfTo (G4VGraphicsScene &) override

	G4AxesModel (G4double x0, G4double y0, G4double z0, G4double length, const G4Transform3D &transform=G4Transform3D())

	G4AxesModel (G4double x0, G4double y0, G4double z0, G4double length, G4double arrowWidth=1., const G4String &colourString="auto", const G4String &description="", G4bool withAnnotation=true, G4double textSize=10., const G4Transform3D &transform=G4Transform3D())

virtual G4String	GetCurrentDescription () const

virtual G4String	GetCurrentTag () const

const G4VisExtent &	GetExtent () const

const G4String &	GetGlobalDescription () const

const G4String &	GetGlobalTag () const

const G4ModelingParameters *	GetModelingParameters () const

const G4String &	GetType () const

void	SetExtent (const G4VisExtent &)

void	SetGlobalDescription (const G4String &)

void	SetGlobalTag (const G4String &)

void	SetModelingParameters (const G4ModelingParameters *)

void	SetType (const G4String &)

virtual G4bool	Validate (G4bool warn=true)

virtual	~G4AxesModel ()

Protected Attributes
G4VisExtent	fExtent

G4String	fGlobalDescription

G4String	fGlobalTag

const G4ModelingParameters *	fpMP

G4String	fType

Private Member Functions
	G4AxesModel (const G4AxesModel &)

G4AxesModel &	operator= (const G4AxesModel &)

Private Attributes
G4Transform3D	fTransform

G4VModel *	fXAnnotationModel

G4VModel *	fXAxisModel

G4VModel *	fXLabelModel

G4VModel *	fYAnnotationModel

G4VModel *	fYAxisModel

G4VModel *	fYLabelModel

G4VModel *	fZAnnotationModel

G4VModel *	fZAxisModel

G4VModel *	fZLabelModel

Detailed Description

Definition at line 44 of file G4AxesModel.hh.

Constructor & Destructor Documentation

◆ G4AxesModel() [1/3]

G4AxesModel::G4AxesModel	(	G4double	x0,
		G4double	y0,
		G4double	z0,
		G4double	length,
		G4double	arrowWidth = `1.`,
		const G4String &	colourString = `"auto"`,
		const G4String &	description = `""`,
		G4bool	withAnnotation = `true`,
		G4double	textSize = `10.`,
		const G4Transform3D &	transform = `G4Transform3D()`
	)

Definition at line 56 of file G4AxesModel.cc.

{
  Construct
  (x0,y0,z0,length,arrowWidth,
   colourString,description,withAnnotation,textSize,
   transform);
}

References Construct(), G4coutFormatters::anonymous_namespace{G4coutFormatters.cc}::transform(), and G4InuclParticleNames::z0.

◆ G4AxesModel() [2/3]

G4AxesModel::G4AxesModel	(	G4double	x0,
		G4double	y0,
		G4double	z0,
		G4double	length,
		const G4Transform3D &	transform = `G4Transform3D()`
	)

Definition at line 71 of file G4AxesModel.cc.

{
  G4double arrowWidth = 1.;
  const G4String& colourString = "auto";
  const G4String& description = "";
  G4bool withAnnotation = true;
  G4double textSize = 10.;
  Construct
  (x0,y0,z0,length,arrowWidth,
   colourString,description,withAnnotation,textSize,
   transform);
}

References Construct(), G4coutFormatters::anonymous_namespace{G4coutFormatters.cc}::transform(), and G4InuclParticleNames::z0.

◆ ~G4AxesModel()

G4AxesModel::~G4AxesModel ( )

virtual

Definition at line 43 of file G4AxesModel.cc.

{
  delete fZAnnotationModel;
  delete fZLabelModel;
  delete fZAxisModel;
  delete fYAnnotationModel;
  delete fYLabelModel;
  delete fYAxisModel;
  delete fXAnnotationModel;
  delete fXLabelModel;
  delete fXAxisModel;
}

References fXAnnotationModel, fXAxisModel, fXLabelModel, fYAnnotationModel, fYAxisModel, fYLabelModel, fZAnnotationModel, fZAxisModel, and fZLabelModel.

◆ G4AxesModel() [3/3]

G4AxesModel::G4AxesModel ( const G4AxesModel & )

private

Member Function Documentation

◆ Construct()

void G4AxesModel::Construct	(	G4double	x0,
		G4double	y0,
		G4double	z0,
		G4double	length,
		G4double	arrowWidth,
		const G4String &	colourString,
		const G4String &	description,
		G4bool	withAnnotation,
		G4double	textSize,
		const G4Transform3D &	transform
	)

Definition at line 86 of file G4AxesModel.cc.

{
  fXAxisModel = nullptr;
  fXLabelModel = nullptr;
  fXAnnotationModel = nullptr;
  fYAxisModel = nullptr;
  fYLabelModel = nullptr;
  fYAnnotationModel = nullptr;
  fZAxisModel = nullptr;
  fZLabelModel = nullptr;
  fZAnnotationModel = nullptr;
 
  fTransform = transform;
 
  fType = "Axes";
  fGlobalTag = fType;
  fGlobalDescription = fType + ": " + description;
  fExtent = G4VisExtent
    (x0, x0+length, y0, y0+length, z0, z0+length);
 
  G4Colour colour(1,1,1,1);  // Default white and opaque (unless "auto").
  G4bool autoColour = false;
  if (colourString == "auto") autoColour = true;
  else {
    if (!G4Colour::GetColour(colourString, colour)) {
      G4ExceptionDescription ed;
      ed << "Colour \"" << colourString
     << "\" not found.  Defaulting to white and opaque.";
      G4Exception
    ("G4AxesModel::G4AxesModel",
     "modeling0011", JustWarning, ed);
    }
  }
 
  G4String annotation = G4BestUnit(length,"Length");
 
  G4Text* text = 0;
  G4VisAttributes* va = 0;
  G4int lineSegmentsPerCircle = 6;
 
  G4Colour xColour(colour);
  if (autoColour) xColour = G4Colour::Red();
  fXAxisModel = new G4ArrowModel
    (x0, y0, z0, x0+length, y0, z0, arrowWidth,
     xColour, "x-axis: " + description,
     lineSegmentsPerCircle, fTransform);
  if (withAnnotation) {
    text = new G4Text("x",G4Point3D(x0+1.05*length, y0, z0));
    text->SetScreenSize(textSize);
    text->SetOffset(0.5*textSize,0.5*textSize);
    text->SetLayout(G4Text::centre);
    va = new G4VisAttributes(xColour);
    text->SetVisAttributes(va);
    fXLabelModel = new G4TextModel(*text,fTransform);
    delete text;
    text = new G4Text(annotation,G4Point3D(x0+0.8*length, y0, z0));
    text->SetScreenSize(textSize);
    text->SetOffset(-1.5*textSize,-1.5*textSize);
    text->SetLayout(G4Text::centre);
    va = new G4VisAttributes(xColour);
    text->SetVisAttributes(va);
    fXAnnotationModel = new G4TextModel(*text,fTransform);
    delete text;
  }
 
  G4Colour yColour(colour);
  if (autoColour) yColour = G4Colour::Green();
  fYAxisModel = new G4ArrowModel
    (x0, y0, z0, x0, y0+length, z0, arrowWidth,
     yColour, "y-axis: " + description,
     lineSegmentsPerCircle, fTransform);
  if (withAnnotation) {
    text = new G4Text("y",G4Point3D(x0, y0+1.05*length, z0));
    text->SetScreenSize(textSize);
    text->SetOffset(0.5*textSize,0.5*textSize);
    text->SetLayout(G4Text::centre);
    va = new G4VisAttributes(yColour);
    text->SetVisAttributes(va);
    fYLabelModel = new G4TextModel(*text,fTransform);
    delete text;
    text = new G4Text(annotation,G4Point3D(x0, y0+0.8*length, z0));
    text->SetScreenSize(textSize);
    text->SetOffset(-1.5*textSize,-1.5*textSize);
    text->SetLayout(G4Text::centre);
    va = new G4VisAttributes(yColour);
    text->SetVisAttributes(va);
    fYAnnotationModel = new G4TextModel(*text,fTransform);
    delete text;
  }
 
  G4Colour zColour(colour);
  if (autoColour) zColour = G4Colour::Blue();
  fZAxisModel = new G4ArrowModel
    (x0, y0, z0, x0, y0, z0+length, arrowWidth,
     zColour, "z-axis: " + description,
     lineSegmentsPerCircle, fTransform);
  if (withAnnotation) {
    text = new G4Text("z",G4Point3D(x0, y0, z0+1.05*length));
    text->SetScreenSize(textSize);
    text->SetOffset(0.5*textSize,0.5*textSize);
    text->SetLayout(G4Text::centre);
    va = new G4VisAttributes(zColour);
    text->SetVisAttributes(va);
    fZLabelModel = new G4TextModel(*text,fTransform);
    delete text;
    text = new G4Text(annotation,G4Point3D(x0, y0, z0+0.8*length));
    text->SetScreenSize(textSize);
    text->SetOffset(-1.5*textSize,-1.5*textSize);
    text->SetLayout(G4Text::centre);
    va = new G4VisAttributes(zColour);
    text->SetVisAttributes(va);
    fZAnnotationModel = new G4TextModel(*text,fTransform);
    delete text;
  }
}

References G4Colour::Blue(), G4Text::centre, G4VModel::fExtent, G4VModel::fGlobalDescription, G4VModel::fGlobalTag, fTransform, G4VModel::fType, fXAnnotationModel, fXAxisModel, fXLabelModel, fYAnnotationModel, fYAxisModel, fYLabelModel, fZAnnotationModel, fZAxisModel, fZLabelModel, G4BestUnit, G4Exception(), G4Colour::GetColour(), G4Colour::Green(), JustWarning, G4Colour::Red(), G4Text::SetLayout(), G4Text::SetOffset(), G4VMarker::SetScreenSize(), G4Visible::SetVisAttributes(), G4coutFormatters::anonymous_namespace{G4coutFormatters.cc}::transform(), and G4InuclParticleNames::z0.

Referenced by G4AxesModel().

◆ DescribeYourselfTo()

void G4AxesModel::DescribeYourselfTo ( G4VGraphicsScene & sceneHandler )

overridevirtual

Implements G4VModel.

Definition at line 208 of file G4AxesModel.cc.

{
  if (fXAxisModel)       fXAxisModel->      DescribeYourselfTo(sceneHandler);
  if (fXLabelModel)      fXLabelModel->     DescribeYourselfTo(sceneHandler);
  if (fXAnnotationModel) fXAnnotationModel->DescribeYourselfTo(sceneHandler);
 
  if (fYAxisModel)       fYAxisModel->      DescribeYourselfTo(sceneHandler);
  if (fYLabelModel)      fYLabelModel->     DescribeYourselfTo(sceneHandler);
  if (fYAnnotationModel) fYAnnotationModel->DescribeYourselfTo(sceneHandler);
 
  if (fZAxisModel)       fZAxisModel->      DescribeYourselfTo(sceneHandler);
  if (fZLabelModel)      fZLabelModel->     DescribeYourselfTo(sceneHandler);
  if (fZAnnotationModel) fZAnnotationModel->DescribeYourselfTo(sceneHandler);
}

References DescribeYourselfTo(), G4VModel::DescribeYourselfTo(), fXAnnotationModel, fXAxisModel, fXLabelModel, fYAnnotationModel, fYAxisModel, fYLabelModel, fZAnnotationModel, fZAxisModel, and fZLabelModel.

Referenced by DescribeYourselfTo(), and G4VisCommandsTouchable::SetNewValue().

◆ GetCurrentDescription()

G4String G4VModel::GetCurrentDescription ( ) const

virtualinherited

Reimplemented in G4GPSModel, and G4PhysicalVolumeModel.

Definition at line 51 of file G4VModel.cc.

                                                {
  // Override in concrete class if concept of "current" is meaningful.
  return fGlobalDescription;
}

References G4VModel::fGlobalDescription.

Referenced by G4OpenGLStoredQtSceneHandler::ExtraPOProcessing().

◆ GetCurrentTag()

G4String G4VModel::GetCurrentTag ( ) const

virtualinherited

Reimplemented in G4GPSModel, and G4PhysicalVolumeModel.

Definition at line 46 of file G4VModel.cc.

                                        {
  // Override in concrete class if concept of "current" is meaningful.
  return fGlobalTag;
}

References G4VModel::fGlobalTag.

Referenced by G4Qt3DSceneHandler::AddPrimitive(), and G4ToolsSGSceneHandler::AddPrimitive().

◆ GetExtent()

const G4VisExtent & G4VModel::GetExtent ( ) const

inherited

Referenced by G4PhysicalVolumeModel::CalculateExtent(), and G4VisCommandSceneAddLogicalVolume::SetNewValue().

◆ GetGlobalDescription()

const G4String & G4VModel::GetGlobalDescription ( ) const

inherited

Referenced by G4Scene::AddRunDurationModel(), and anonymous_namespace{G4Scene.cc}::PrintInvalidModel().

◆ GetGlobalTag()

const G4String & G4VModel::GetGlobalTag ( ) const

inherited

Referenced by G4Qt3DSceneHandler::CreateNewNode().

◆ GetModelingParameters()

const G4ModelingParameters * G4VModel::GetModelingParameters ( ) const

inherited

Referenced by G4ASCIITreeSceneHandler::EndModeling(), and G4OpenGLSceneHandler::ScaledFlush().

◆ GetType()

const G4String & G4VModel::GetType ( ) const

inherited

Referenced by G4OpenGLStoredQtSceneHandler::ExtraPOProcessing().

◆ operator=()

G4AxesModel & G4AxesModel::operator= ( const G4AxesModel & )

private

◆ SetExtent()

void G4VModel::SetExtent ( const G4VisExtent & )

inherited

Referenced by G4VisCommandSceneAddUserAction::AddVisAction(), G4VisCommandSceneAddExtent::SetNewValue(), G4VisCommandSceneAddLogo::SetNewValue(), and G4VisCommandSceneAddScale::SetNewValue().

◆ SetGlobalDescription()

void G4VModel::SetGlobalDescription ( const G4String & )

inherited

◆ SetGlobalTag()

void G4VModel::SetGlobalTag ( const G4String & )

inherited

◆ SetModelingParameters()

void G4VModel::SetModelingParameters ( const G4ModelingParameters * )

inherited

Referenced by G4LogicalVolumeModel::DescribeYourselfTo(), G4ASCIITreeSceneHandler::EndModeling(), G4TouchableUtils::FindTouchableProperties(), G4VSceneHandler::ProcessScene(), G4VisCommandSetTouchable::SetNewValue(), G4VisCommandSetVolumeForField::SetNewValue(), G4VisCommandsTouchable::SetNewValue(), and G4VisCommandViewerCentreOn::SetNewValue().

◆ SetType()

void G4VModel::SetType ( const G4String & )

inherited

◆ Validate()

G4bool G4VModel::Validate ( G4bool warn = true )

virtualinherited

Reimplemented in G4PhysicalVolumeModel, and G4LogicalVolumeModel.

Definition at line 56 of file G4VModel.cc.

                                 {
  return true;
}

Field Documentation

◆ fExtent

G4VisExtent G4VModel::fExtent

protectedinherited

Definition at line 101 of file G4VModel.hh.

Referenced by G4PhysicalVolumeModel::CalculateExtent(), Construct(), G4ArrowModel::G4ArrowModel(), and G4PlotterModel::G4PlotterModel().

◆ fGlobalDescription

G4String G4VModel::fGlobalDescription

protectedinherited

Definition at line 100 of file G4VModel.hh.

Referenced by Construct(), G4ArrowModel::G4ArrowModel(), G4DigiModel::G4DigiModel(), G4GPSModel::G4GPSModel(), G4HitsModel::G4HitsModel(), G4LogicalVolumeModel::G4LogicalVolumeModel(), G4PhysicalVolumeModel::G4PhysicalVolumeModel(), G4PlotterModel::G4PlotterModel(), G4PSHitsModel::G4PSHitsModel(), G4TextModel::G4TextModel(), G4TrajectoriesModel::G4TrajectoriesModel(), G4VFieldModel::G4VFieldModel(), and G4VModel::GetCurrentDescription().

◆ fGlobalTag

G4String G4VModel::fGlobalTag

protectedinherited

Definition at line 99 of file G4VModel.hh.

Referenced by Construct(), G4ArrowModel::G4ArrowModel(), G4DigiModel::G4DigiModel(), G4GPSModel::G4GPSModel(), G4HitsModel::G4HitsModel(), G4LogicalVolumeModel::G4LogicalVolumeModel(), G4PhysicalVolumeModel::G4PhysicalVolumeModel(), G4PlotterModel::G4PlotterModel(), G4PSHitsModel::G4PSHitsModel(), G4TextModel::G4TextModel(), G4TrajectoriesModel::G4TrajectoriesModel(), G4VFieldModel::G4VFieldModel(), G4PhysicalVolumeModel::GetCurrentTag(), and G4VModel::GetCurrentTag().

◆ fpMP

const G4ModelingParameters* G4VModel::fpMP

protectedinherited

Definition at line 102 of file G4VModel.hh.

Referenced by G4PhysicalVolumeModel::CalculateExtent(), G4PhysicalVolumeModel::DescribeAndDescend(), G4PhysicalVolumeModel::DescribeSolid(), G4DigiModel::DescribeYourselfTo(), G4HitsModel::DescribeYourselfTo(), G4LogicalVolumeModel::DescribeYourselfTo(), G4PhysicalVolumeModel::DescribeYourselfTo(), G4TrajectoriesModel::DescribeYourselfTo(), G4CallbackModel< F >::DescribeYourselfTo(), and G4PhysicalVolumeModel::VisitGeometryAndGetVisReps().

◆ fTransform

G4Transform3D G4AxesModel::fTransform

private

Definition at line 87 of file G4AxesModel.hh.

Referenced by Construct().

◆ fType

G4String G4VModel::fType

protectedinherited

Definition at line 98 of file G4VModel.hh.

Referenced by Construct(), G4ArrowModel::G4ArrowModel(), G4DigiModel::G4DigiModel(), G4GPSModel::G4GPSModel(), G4HitsModel::G4HitsModel(), G4LogicalVolumeModel::G4LogicalVolumeModel(), G4PhysicalVolumeModel::G4PhysicalVolumeModel(), G4PlotterModel::G4PlotterModel(), G4PSHitsModel::G4PSHitsModel(), G4TextModel::G4TextModel(), G4TrajectoriesModel::G4TrajectoriesModel(), and G4VFieldModel::G4VFieldModel().

◆ fXAnnotationModel

G4VModel * G4AxesModel::fXAnnotationModel

private

Definition at line 84 of file G4AxesModel.hh.

Referenced by Construct(), DescribeYourselfTo(), and ~G4AxesModel().

◆ fXAxisModel

G4VModel* G4AxesModel::fXAxisModel

private

Definition at line 84 of file G4AxesModel.hh.

Referenced by Construct(), DescribeYourselfTo(), and ~G4AxesModel().

◆ fXLabelModel

G4VModel * G4AxesModel::fXLabelModel

private

Definition at line 84 of file G4AxesModel.hh.

Referenced by Construct(), DescribeYourselfTo(), and ~G4AxesModel().

◆ fYAnnotationModel

G4VModel * G4AxesModel::fYAnnotationModel

private

Definition at line 85 of file G4AxesModel.hh.

Referenced by Construct(), DescribeYourselfTo(), and ~G4AxesModel().

◆ fYAxisModel

G4VModel * G4AxesModel::fYAxisModel

private

Definition at line 85 of file G4AxesModel.hh.

Referenced by Construct(), DescribeYourselfTo(), and ~G4AxesModel().

◆ fYLabelModel

G4VModel * G4AxesModel::fYLabelModel

private

Definition at line 85 of file G4AxesModel.hh.

Referenced by Construct(), DescribeYourselfTo(), and ~G4AxesModel().

◆ fZAnnotationModel

G4VModel * G4AxesModel::fZAnnotationModel

private

Definition at line 86 of file G4AxesModel.hh.

Referenced by Construct(), DescribeYourselfTo(), and ~G4AxesModel().

◆ fZAxisModel

G4VModel * G4AxesModel::fZAxisModel

private

Definition at line 86 of file G4AxesModel.hh.

Referenced by Construct(), DescribeYourselfTo(), and ~G4AxesModel().

◆ fZLabelModel

G4VModel * G4AxesModel::fZLabelModel

private

Definition at line 86 of file G4AxesModel.hh.

Referenced by Construct(), DescribeYourselfTo(), and ~G4AxesModel().

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

source/visualization/modeling/include/G4AxesModel.hh
source/visualization/modeling/src/G4AxesModel.cc

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ G4AxesModel() [1/3]

◆ G4AxesModel() [2/3]

◆ ~G4AxesModel()

◆ G4AxesModel() [3/3]

Member Function Documentation

◆ Construct()

◆ DescribeYourselfTo()

◆ GetCurrentDescription()

◆ GetCurrentTag()

◆ GetExtent()

◆ GetGlobalDescription()

◆ GetGlobalTag()

◆ GetModelingParameters()

◆ GetType()

◆ operator=()

◆ SetExtent()

◆ SetGlobalDescription()

◆ SetGlobalTag()

◆ SetModelingParameters()

◆ SetType()

◆ Validate()

Field Documentation

◆ fExtent

◆ fGlobalDescription

◆ fGlobalTag

◆ fpMP

◆ fTransform

◆ fType

◆ fXAnnotationModel

◆ fXAxisModel

◆ fXLabelModel

◆ fYAnnotationModel

◆ fYAxisModel

◆ fYLabelModel

◆ fZAnnotationModel

◆ fZAxisModel

◆ fZLabelModel