Garfield::ViewCell Class Reference

Visualize the "cell" defined in an analytic-field component. More...

#include <ViewCell.hh>

Public Member Functions
	ViewCell ()
	Constructor.
	~ViewCell ()
	Destructor.
void	SetCanvas (TCanvas *c)
	Set the canvas on which to draw the cell geometry.
void	SetComponent (ComponentAnalyticField *comp)
	Set the component for which to draw the cell geometry.
void	SetArea (const double xmin, const double ymin, const double zmin, const double xmax, const double ymax, const double zmax)
	Set the plot range explicitly.
void	SetArea ()
	Take the plot range from the bounding box of the component class.
void	Plot2d ()
	Make a two-dimensional drawing of the cell geometry.
void	Plot3d ()
	Make a three-dimensional drawing of the cell geometry (using TGeo).
void	EnableDebugging (const bool on=true)
	Switch on/off debugging output.
void	EnableWireMarkers (const bool on=true)
void	DisableWireMarkers ()

Detailed Description

Visualize the "cell" defined in an analytic-field component.

Definition at line 15 of file ViewCell.hh.

Constructor & Destructor Documentation

ViewCell()

Garfield::ViewCell::ViewCell

(

)

Constructor.

Definition at line 17 of file ViewCell.cc.

    : m_className("ViewCell"),
      m_debug(false),
      m_useWireMarker(true),
      m_label("Cell Layout"),
      m_canvas(NULL),
      m_hasExternalCanvas(false),
      m_hasUserArea(false),
      m_xMin(-1.),
      m_yMin(-1.),
      m_zMin(-1.),
      m_xMax(1.),
      m_yMax(1.),
      m_zMax(1.),
      m_component(NULL),
      m_geo(NULL) {
 
  plottingEngine.SetDefaultStyle();
}

~ViewCell()

Garfield::ViewCell::~ViewCell

(

)

Destructor.

Definition at line 37 of file ViewCell.cc.

                    {
 
  if (!m_hasExternalCanvas && m_canvas) delete m_canvas;
  if (m_geo) delete m_geo;
 
}

Member Function Documentation

DisableWireMarkers()

void Garfield::ViewCell::DisableWireMarkers ( )

inline

Definition at line 45 of file ViewCell.hh.

{ EnableWireMarkers(false); }

EnableDebugging()

void Garfield::ViewCell::EnableDebugging ( const bool  on = true )

inline

Switch on/off debugging output.

Definition at line 40 of file ViewCell.hh.

{ m_debug = on; }

EnableWireMarkers()

void Garfield::ViewCell::EnableWireMarkers ( const bool  on = true )

inline

Visualize wirers using markers or as a circle with the actual wire radius. The default is markers.

Definition at line 44 of file ViewCell.hh.

{ m_useWireMarker = on; }

Referenced by DisableWireMarkers().

Plot2d()

void Garfield::ViewCell::Plot2d

(

)

Make a two-dimensional drawing of the cell geometry.

Definition at line 84 of file ViewCell.cc.

                      {
 
  if (!Plot(false)) {
    std::cerr << m_className << "::Plot2d: Error creating plot.\n";
  }
}

Plot3d()

void Garfield::ViewCell::Plot3d

(

)

Make a three-dimensional drawing of the cell geometry (using TGeo).

Definition at line 91 of file ViewCell.cc.

                      {
 
  if (!Plot(true)) {
    std::cerr << m_className << "::Plot3d: Error creating plot.\n";
  }
}

SetArea() [1/2]

void Garfield::ViewCell::SetArea ( )

inline

Take the plot range from the bounding box of the component class.

Definition at line 32 of file ViewCell.hh.

{ m_hasUserArea = false; }

SetArea() [2/2]

void Garfield::ViewCell::SetArea	(	const double	xmin,
		const double	ymin,
		const double	zmin,
		const double	xmax,
		const double	ymax,
		const double	zmax
	)

Set the plot range explicitly.

Definition at line 65 of file ViewCell.cc.

                                          {
 
  // Check range, assign if non-null
  if (xmin == xmax || ymin == ymax || zmin == zmax) {
    std::cerr << m_className << "::SetArea: Null area range not permitted.\n";
    return;
  }
  m_xMin = std::min(xmin, xmax);
  m_yMin = std::min(ymin, ymax);
  m_zMin = std::min(zmin, zmax);
  m_xMax = std::max(xmin, xmax);
  m_yMax = std::max(ymin, ymax);
  m_zMax = std::max(zmin, zmax);
  m_hasUserArea = true;
}

SetCanvas()

void Garfield::ViewCell::SetCanvas

(

TCanvas *

c

)

Set the canvas on which to draw the cell geometry.

Definition at line 54 of file ViewCell.cc.

                                   {
 
  if (!c) return;
  if (!m_hasExternalCanvas && m_canvas) {
    delete m_canvas;
    m_canvas = NULL;
  }
  m_canvas = c;
  m_hasExternalCanvas = true;
}

SetComponent()

void Garfield::ViewCell::SetComponent

(

ComponentAnalyticField *

comp

)

Set the component for which to draw the cell geometry.

Definition at line 44 of file ViewCell.cc.

                                                        {
 
  if (!comp) {
    std::cerr << m_className << "::SetComponent: Null pointer.\n";
    return;
  }
 
  m_component = comp;
}

---

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

• ViewCell.hh
• ViewCell.cc