g4display
Loading...
Searching...
No Matches
g4display::G4SceneText Struct Reference

One text annotation to be inserted into the Geant4 scene. More...

#include <g4Text.h>

Data Fields

std::string text
 Text string to be displayed.
 
std::string color
 Text color name understood by Geant4 (e.g. "black", "red").
 
double x
 X position.
 
double y
 Y position.
 
double z = GNOT_SPECIFIED_SCENE_TEXT_Z
 Z position; if left at default sentinel, Z is treated as “not specified”.
 
int size
 Text size parameter passed to Geant4 visualization command.
 

Detailed Description

Each configured item is converted into Geant4 visualization commands by G4SceneProperties.

Interpretation rules:

  • If z is set to GNOT_SPECIFIED_SCENE_TEXT_Z, the text is treated as normal scene text (3D command).
  • If z is explicitly provided, the text is treated as “2D text” (text2D command).

Definition at line 30 of file g4Text.h.

Field Documentation

◆ color

std::string g4display::G4SceneText::color

Definition at line 36 of file g4Text.h.

◆ size

int g4display::G4SceneText::size

Definition at line 48 of file g4Text.h.

◆ text

std::string g4display::G4SceneText::text

Definition at line 33 of file g4Text.h.

◆ x

double g4display::G4SceneText::x

Definition at line 39 of file g4Text.h.

◆ y

double g4display::G4SceneText::y

Definition at line 42 of file g4Text.h.

◆ z

double g4display::G4SceneText::z = GNOT_SPECIFIED_SCENE_TEXT_Z

Definition at line 45 of file g4Text.h.


The documentation for this struct was generated from the following file: