box¶
- marxs.visualization.x3d.box(obj, display, *, scene)[source] [edit on github]¶
Plot a rectangular box for an object.
By default, the box extends in x,y, and z direction. The display keyword “box-half” can be used to show only one half of the box, e.g. “+x” would show the full extend in y and z direction, but only the lower half in x direction (such that rays coming from the +x direction are visible up to the interaction point). Use this for elements such as mirrors or detectors where photon interaction happens on the surface, not in the substrate.
- Parameters:
- obj
marxs.base.MarxsElement
The element that should be plotted.
- displaydict of None
Dictionary with display settings.
- scene
marxs.visualization.x3d.Scene
object A scene that this object is added to. If
None
, a new scene will be created.
- obj
- Returns:
- scene
marxs.visualization.x3d.Scene
object Scene with object added.
- scene