sciGraphics::BarDecomposition Class Reference

#include </home/scilab/compilation_chain/sci_checkOut/scilab/modules/renderer/src/cpp/polylineDrawing/BarDecomposition.hxx>

Inheritance diagram for sciGraphics::BarDecomposition:

[legend]

Collaboration diagram for sciGraphics::BarDecomposition:

[legend]

Public Member Functions
	BarDecomposition (DrawablePolyline *polyline)
virtual	~BarDecomposition (void)
virtual void	getDrawnVertices (double xCoords[], double yCoords[], double zCoords[])
virtual void	getDrawnVerticesColor (int colors[])
virtual int	getDrawnVerticesLength (void)
void	getBarOrdinates (double bottom[], double top[])
void	getBarAbscissas (double left[], double right[])
void	getBarPlotMarkVertices (double xCoords[], double yCoords[], double zCoords[])
int	getBarPlotMarkVerticesLength (void)
Protected Member Functions
void	getBarLinearOrdinates (double bottom[], double top[])
void	getBarLinearAbscissas (double left[], double right[])
Protected Attributes
LinearBarDecomposition *	m_pExtentComputer

---

Detailed Description

Definition at line 23 of file BarDecomposition.hxx.

---

Constructor & Destructor Documentation

sciGraphics::BarDecomposition::BarDecomposition

(

DrawablePolyline *

polyline

)

Definition at line 28 of file BarDecomposition.cpp.

References sciGraphics::DrawableObject::getDrawedObject(), m_pExtentComputer, and sciGetPolylineStyle().

  : DecomposeLineStrategy(polyline)
{
  sciPointObj * pPolyline = polyline->getDrawedObject();
  if (sciGetPolylineStyle(pPolyline) == 7)
  {
    m_pExtentComputer = new HorizontalBarDecomposition(this);
  }
  else
  {
    m_pExtentComputer = new VerticalBarDecomposition(this);
  }
}

Here is the call graph for this function:

sciGraphics::BarDecomposition::~BarDecomposition

(

void

)

[virtual]

Definition at line 42 of file BarDecomposition.cpp.

References m_pExtentComputer, and NULL.

{
  delete m_pExtentComputer;
  m_pExtentComputer = NULL;
}

---

Member Function Documentation

void sciGraphics::BarDecomposition::getDrawnVertices	(	double	xCoords[],
		double	yCoords[],
		double	zCoords[]
	)			[virtual]

Retrieve the vertices of the polyline which will be used to draw it directly. In the polyline sciPointObj, x, y and z vectors does not always stands for the real vertices of the drawn line (specially when staircase mode is on). To allocate the array for retrieving vertices, user should use the getDrawnVerticesLength.

Parameters:

	xCoords	X coordinates of the drawn vertices
	yCoords	Y coordinates of the drawn vertices
	zCoords	Z coordinates of the drawn vertices

Implements sciGraphics::DecomposeLineStrategy.

Definition at line 48 of file BarDecomposition.cpp.

References doubleArrayCopy(), sciGraphics::DrawableObject::getDrawedObject(), getDrawnVerticesLength(), i, sciGraphics::DecomposeLineStrategy::m_pDrawed, NULL, sciGraphics::DrawableObject::pointScale(), pPOLYLINE_FEATURE, sciGetNbPoints(), and setDoubleArraySingleValue().

Referenced by sciGraphics::PolylineBarDrawerJoGL::drawPolyline(), and getBarPlotMarkVertices().

{
  sciPointObj * pPolyline = m_pDrawed->getDrawedObject();
  int nbVertices = sciGetNbPoints(m_pDrawed->getDrawedObject());
  double * xPoints = pPOLYLINE_FEATURE(pPolyline)->pvx;
  double * yPoints = pPOLYLINE_FEATURE(pPolyline)->pvy;
  double * zPoints = pPOLYLINE_FEATURE(pPolyline)->pvz;
  double * xShift = pPOLYLINE_FEATURE(pPolyline)->x_shift;
  double * yShift = pPOLYLINE_FEATURE(pPolyline)->y_shift;
  double * zShift = pPOLYLINE_FEATURE(pPolyline)->z_shift;

  if (xCoords != NULL)
  {
    doubleArrayCopy(xCoords, xPoints, nbVertices);
    if (xShift != NULL)
    {
      for(int i = 0; i < nbVertices; i++)
      {
        xCoords[i] += xShift[i];
      }
    }
  }
  

  if (yCoords != NULL)
  {
    doubleArrayCopy(yCoords, yPoints, nbVertices);
    if (yShift != NULL)
    {
      for(int i = 0; i < nbVertices; i++)
      {
        yCoords[i] += yShift[i];
      }
    }
  }
  
  if (zCoords != NULL)
  {
    if ( zPoints == NULL )
    {
      setDoubleArraySingleValue(zCoords, 0.0, nbVertices);
    }
    else
    {
      doubleArrayCopy(zCoords, zPoints, nbVertices);
    }

    if (zShift != NULL)
    {
      for(int i = 0; i < nbVertices; i++)
      {
        zCoords[i] += zShift[i];
      }
    }
  }
  

  // apply logarithmic mode if needed
  m_pDrawed->pointScale(xCoords, yCoords, zCoords, getDrawnVerticesLength());
  
}

Here is the call graph for this function:

Here is the caller graph for this function:

void sciGraphics::BarDecomposition::getDrawnVerticesColor

(

int

colors[]

)

[virtual]

Retrieve the colors to use for each vertex. To be used for color interpolation. The size of the array must be retrieved by getDrawnVerticesLength().

Parameters:

colors

color inddex of the draw vertices

Implements sciGraphics::DecomposeLineStrategy.

Definition at line 110 of file BarDecomposition.cpp.

References getDrawnVerticesLength(), and i.

{
  // unused for now
  for(int i = 0; i < getDrawnVerticesLength(); i++)
  {
    colors[i] = 0;
  }
}

Here is the call graph for this function:

int sciGraphics::BarDecomposition::getDrawnVerticesLength

(

void

)

[virtual]

Returns:

number of vertices which will be computed by the getDrawnVertices routine.

Implements sciGraphics::DecomposeLineStrategy.

Definition at line 119 of file BarDecomposition.cpp.

References sciGraphics::DrawableObject::getDrawedObject(), sciGraphics::DecomposeLineStrategy::m_pDrawed, and sciGetNbPoints().

Referenced by sciGraphics::PolylineBarDrawerJoGL::drawPolyline(), sciGraphics::VerticalBarDecomposition::getBarAbscissas(), sciGraphics::HorizontalBarDecomposition::getBarAbscissas(), getBarAbscissas(), sciGraphics::VerticalBarDecomposition::getBarOrdinates(), sciGraphics::HorizontalBarDecomposition::getBarOrdinates(), getBarOrdinates(), getBarPlotMarkVertices(), getBarPlotMarkVerticesLength(), getDrawnVertices(), and getDrawnVerticesColor().

{
  // can't be closed
  return sciGetNbPoints(m_pDrawed->getDrawedObject());
}

Here is the call graph for this function:

Here is the caller graph for this function:

void sciGraphics::BarDecomposition::getBarOrdinates	(	double	bottom[],
		double	top[]
	)

Get the top and bottom ordinates of each bar to draw.

Parameters:

	top	array containing top abscissa of the bars. Its size is getDrawnVerticesLength().
	bottom	array containing the bottom abscissa of the bars. Its size is getDrawnVerticesLength().

Definition at line 125 of file BarDecomposition.cpp.

References getBarLinearOrdinates(), getDrawnVerticesLength(), sciGraphics::DecomposeLineStrategy::m_pDrawed, NULL, and sciGraphics::DrawableObject::pointScale().

Referenced by sciGraphics::PolylineBarDrawerJoGL::drawPolyline().

{

  int nbVertices = getDrawnVerticesLength();
  getBarLinearOrdinates(bottom, top);

  m_pDrawed->pointScale(NULL, bottom, NULL, nbVertices);
  m_pDrawed->pointScale(NULL, top, NULL, nbVertices);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void sciGraphics::BarDecomposition::getBarAbscissas	(	double	left[],
		double	right[]
	)

Get the left and right abscissas of each bar to draw.

Parameters:

	left	array containing left abscissa of the bars. Its size is getDrawnVerticesLength().
	right	array containing the right abscissa of the bars. Its size is getDrawnVerticesLength().

Definition at line 135 of file BarDecomposition.cpp.

References getBarLinearAbscissas(), getDrawnVerticesLength(), sciGraphics::DecomposeLineStrategy::m_pDrawed, NULL, and sciGraphics::DrawableObject::pointScale().

Referenced by sciGraphics::PolylineBarDrawerJoGL::drawPolyline().

{
  // apply log scale if needed
  int nbVertices = getDrawnVerticesLength();
  getBarLinearAbscissas(left, right);

  m_pDrawed->pointScale(left, NULL, NULL, nbVertices);
  m_pDrawed->pointScale(right, NULL, NULL, nbVertices);

}

Here is the call graph for this function:

Here is the caller graph for this function:

void sciGraphics::BarDecomposition::getBarPlotMarkVertices	(	double	xCoords[],
		double	yCoords[],
		double	zCoords[]
	)

Bar plot mode (ie polyline_style = 3), also draws mark on y = 0 line.

Definition at line 146 of file BarDecomposition.cpp.

References sciGraphics::DrawableObject::getDrawedObject(), getDrawnVertices(), getDrawnVerticesLength(), i, sciGraphics::DecomposeLineStrategy::m_pDrawed, and sciGetLogFlags().

Referenced by sciGraphics::PolylineMarkDrawerJoGL::drawPolyline().

{
  // first half
  getDrawnVertices(xCoords, yCoords, zCoords);

  int semiSize = getDrawnVerticesLength();

  // second half
  sciPointObj * pPolyline = m_pDrawed->getDrawedObject();
  
  // special case for with logarithmic mode
  // bars starts at y = 1 = 10^0 and not 0 which is not displayable
  char logFlags[3];
  sciGetLogFlags(pPolyline, logFlags);
  if (logFlags[1] == 'l')
  {
    for (int i = 0; i < semiSize ; i++)
    {
      xCoords[i + semiSize] = xCoords[i];
      yCoords[i + semiSize] = 1.0;
      zCoords[i + semiSize] = zCoords[i];
    }
  }
  else
  {
    for (int i = 0; i < semiSize ; i++)
    {
      xCoords[i + semiSize] = xCoords[i];
      yCoords[i + semiSize] = 0.0;
      zCoords[i + semiSize] = zCoords[i];
    }
  }
  
}

Here is the call graph for this function:

Here is the caller graph for this function:

int sciGraphics::BarDecomposition::getBarPlotMarkVerticesLength

(

void

)

Returns:

number of vertices for bar plot drawing of marks

Definition at line 181 of file BarDecomposition.cpp.

References getDrawnVerticesLength().

Referenced by sciGraphics::PolylineMarkDrawerJoGL::drawPolyline().

{
  return 2 * getDrawnVerticesLength();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void sciGraphics::BarDecomposition::getBarLinearOrdinates	(	double	bottom[],
		double	top[]
	)			[protected]

Get the top and bottom ordinates of each bar in linear coordinates.

Definition at line 186 of file BarDecomposition.cpp.

References sciGraphics::LinearBarDecomposition::getBarOrdinates(), and m_pExtentComputer.

Referenced by getBarOrdinates().

{
  m_pExtentComputer->getBarOrdinates(bottom, top);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void sciGraphics::BarDecomposition::getBarLinearAbscissas	(	double	left[],
		double	right[]
	)			[protected]

Get the left and right abscissas of each bar in linear coordinates.

Definition at line 191 of file BarDecomposition.cpp.

References sciGraphics::LinearBarDecomposition::getBarAbscissas(), and m_pExtentComputer.

Referenced by getBarAbscissas().

{
  m_pExtentComputer->getBarAbscissas(left, right);
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

LinearBarDecomposition* sciGraphics::BarDecomposition::m_pExtentComputer [protected]

Definition at line 91 of file BarDecomposition.hxx.

Referenced by BarDecomposition(), getBarLinearAbscissas(), getBarLinearOrdinates(), and ~BarDecomposition().

---

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

• /home/scilab/compilation_chain/sci_checkOut/scilab/modules/renderer/src/cpp/polylineDrawing/BarDecomposition.hxx
• /home/scilab/compilation_chain/sci_checkOut/scilab/modules/renderer/src/cpp/polylineDrawing/BarDecomposition.cpp