GeometryView3D.hpp

Go to the documentation of this file. Or view the newest version in sPHENIX GitHub for file GeometryView3D.hpp

// This file is part of the Acts project.
//
// Copyright (C) 2020 CERN for the benefit of the Acts project
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.

#pragma once

#include "Acts/Definitions/Algebra.hpp"
#include "Acts/Geometry/AbstractVolume.hpp"
#include "Acts/Geometry/GeometryContext.hpp"
#include "Acts/Visualization/IVisualization3D.hpp"
#include "Acts/Visualization/ViewConfig.hpp"

#include <string>

namespace Acts {

class Layer;
class Surface;
class SurfaceArray;
class TrackingVolume;
struct Polyhedron;
class AbstractVolume;
class IVisualization3D;

namespace Experimental {
class DetectorVolume;
class Portal;
}  // namespace Experimental

static ViewConfig s_viewSensitive = ViewConfig({0, 180, 240});
static ViewConfig s_viewPassive = ViewConfig({240, 280, 0});
static ViewConfig s_viewVolume = ViewConfig({220, 220, 0});
static ViewConfig s_viewGrid = ViewConfig({220, 0, 0});
static ViewConfig s_viewLine = ViewConfig({0, 0, 220});

struct GeometryView3D {
  static void drawPolyhedron(IVisualization3D& helper,
                             const Polyhedron& polyhedron,
                             const ViewConfig& viewConfig = s_viewVolume);

  static void drawSurface(IVisualization3D& helper, const Surface& surface,
                          const GeometryContext& gctx,
                          const Transform3& transform = Transform3::Identity(),
                          const ViewConfig& viewConfig = s_viewSensitive);

  static void drawSurfaceArray(
      IVisualization3D& helper, const SurfaceArray& surfaceArray,
      const GeometryContext& gctx,
      const Transform3& transform = Transform3::Identity(),
      const ViewConfig& sensitiveConfig = s_viewSensitive,
      const ViewConfig& passiveConfig = s_viewPassive,
      const ViewConfig& gridConfig = s_viewGrid,
      const std::string& outputDir = ".");

  static void drawVolume(IVisualization3D& helper, const AbstractVolume& volume,
                         const GeometryContext& gctx,
                         const Transform3& transform = Transform3::Identity(),
                         const ViewConfig& viewConfig = s_viewVolume);

  static void drawPortal(IVisualization3D& helper,
                         const Experimental::Portal& portal,
                         const GeometryContext& gctx,
                         const Transform3& transform = Transform3::Identity(),
                         const ViewConfig& connected = ViewConfig({0, 255, 0}),
                         const ViewConfig& disconnected = ViewConfig({255, 0,
                                                                      0}));

  static void drawDetectorVolume(
      IVisualization3D& helper,
      const Acts::Experimental::DetectorVolume& volume,
      const GeometryContext& gctx,
      const Transform3& transform = Transform3::Identity(),
      const ViewConfig& connected = ViewConfig({0, 255, 0}),
      const ViewConfig& unconnected = ViewConfig({255, 0, 0}),
      const ViewConfig& viewConfig = s_viewSensitive);

  static void drawLayer(IVisualization3D& helper, const Layer& layer,
                        const GeometryContext& gctx,
                        const ViewConfig& layerConfig = s_viewPassive,
                        const ViewConfig& sensitiveConfig = s_viewSensitive,
                        const ViewConfig& gridConfig = s_viewGrid,
                        const std::string& outputDir = ".");

  static void drawTrackingVolume(
      IVisualization3D& helper, const TrackingVolume& tVolume,
      const GeometryContext& gctx,
      const ViewConfig& containerView = s_viewVolume,
      const ViewConfig& volumeView = s_viewVolume,
      const ViewConfig& layerView = s_viewPassive,
      const ViewConfig& sensitiveView = s_viewSensitive,
      const ViewConfig& gridView = s_viewGrid, bool writeIt = true,
      const std::string& tag = "", const std::string& outputDir = ".");

  static void drawSegmentBase(IVisualization3D& helper, const Vector3& start,
                              const Vector3& end, int arrows = 0,
                              double arrowLength = 0., double arrowWidth = 0.,
                              const ViewConfig& viewConfig = s_viewLine);

  static void drawSegment(IVisualization3D& helper, const Vector3& start,
                          const Vector3& end,
                          const ViewConfig& viewConfig = s_viewLine);

  static void drawArrowBackward(IVisualization3D& helper, const Vector3& start,
                                const Vector3& end, double arrowLength,
                                double arrowWidth,
                                const ViewConfig& viewConfig = s_viewLine);

  static void drawArrowForward(IVisualization3D& helper, const Vector3& start,
                               const Vector3& end, double arrowLength,
                               double arrowWidth,
                               const ViewConfig& viewConfig = s_viewLine);

  static void drawArrowsBoth(IVisualization3D& helper, const Vector3& start,
                             const Vector3& end, double arrowLength,
                             double arrowWidth,
                             const ViewConfig& viewConfig = s_viewLine);
};

}  // namespace Acts