sciGraphics::AxesPositioner Class Reference

#include </home/scilab/compilation_chain/sci_checkOut/scilab/modules/renderer/src/cpp/axesDrawing/AxesPositioner.hxx>

Inheritance diagram for sciGraphics::AxesPositioner:

[legend]

Collaboration diagram for sciGraphics::AxesPositioner:

[legend]

Public Member Functions
	AxesPositioner (DrawableAxes *axes)
virtual	~AxesPositioner (void)
virtual void	getAxisBounds (double startBound[3], double endBound[3])
virtual void	getTicksDirection (double ticksDir[3])
virtual int	getRelativeTicksPosition (double ticksPos[], int nbTicks)
Protected Member Functions
bool	isXAxisAligned (void)
Protected Attributes
DrawableAxes *	m_pAxes

---

Detailed Description

Interface for determining on which edge of axes box an axe will be

Definition at line 26 of file AxesPositioner.hxx.

---

Constructor & Destructor Documentation

sciGraphics::AxesPositioner::AxesPositioner

(

DrawableAxes *

axes

)

Definition at line 27 of file AxesPositioner.cpp.

References m_pAxes.

{
  m_pAxes = axes;
}

sciGraphics::AxesPositioner::~AxesPositioner

(

void

)

[virtual]

Definition at line 32 of file AxesPositioner.cpp.

References m_pAxes, and NULL.

{
  m_pAxes = NULL;
}

---

Member Function Documentation

void sciGraphics::AxesPositioner::getAxisBounds	(	double	startBound[3],
		double	endBound[3]
	)			[virtual]

Get the two bounds of this axis.

Implements sciGraphics::AxisPositioner.

Definition at line 37 of file AxesPositioner.cpp.

References ComputeXIntervals(), destroyGraphicPointer(), sciGraphics::DrawableObject::getDrawedObject(), isXAxisAligned(), m_pAxes, NULL, pAXES_FEATURE, sciAxes::tics, sciAxes::vx, and sciAxes::vy.

Referenced by getRelativeTicksPosition().

{
  sciPointObj * pAxes = m_pAxes->getDrawedObject();
  sciAxes * ppAxes = pAXES_FEATURE(pAxes);
  double xStart;
  double xEnd;
  double yStart;
  double yEnd;

  if (isXAxisAligned())
  {
    // axis along X axis
    // Y value is constant
    yStart = ppAxes->vy[0];
    yEnd = ppAxes->vy[0];

    // compute X ticks
    int nbTicks;
    double * tempPos = NULL;
    ComputeXIntervals(pAxes, ppAxes->tics, &tempPos, &nbTicks, 0);

    // get the first and the last one
    xStart = tempPos[0];
    xEnd = tempPos[nbTicks - 1];

    destroyGraphicPointer(tempPos);


  }
  else
  {
    // axis along Y axis
    // X value is constant
    xStart = ppAxes->vx[0];
    xEnd = ppAxes->vx[0];

    // compute Y ticks
    int nbTicks;
    double * tempPos = NULL;
    ComputeXIntervals(pAxes, ppAxes->tics, &tempPos, &nbTicks, 0);

    // get the first and the last one
    yStart = tempPos[0];
    yEnd = tempPos[nbTicks - 1];

    destroyGraphicPointer(tempPos);

  }

  startBound[0] = xStart;
  startBound[1] = yStart;
  startBound[2] = 0.0;

  endBound[0] = xEnd;
  endBound[1] = yEnd;
  endBound[2] = 0.0;

}

Here is the call graph for this function:

Here is the caller graph for this function:

void sciGraphics::AxesPositioner::getTicksDirection

(

double

ticksDir[3]

)

[virtual]

Compute the direction and length of ticks

Implements sciGraphics::AxisPositioner.

Definition at line 96 of file AxesPositioner.cpp.

References sciAxes::dir, sciGraphics::DrawableObject::getDrawedObject(), m_pAxes, pAXES_FEATURE, sciGetParentSubwin(), and sciGraphics::AxisPositioner::setTicksDirectionLength().

{
  sciAxes * ppAxes = pAXES_FEATURE(m_pAxes->getDrawedObject());
  switch(ppAxes->dir)
  {
  case 'u':
    // axis along X axis
    // ticks along Y one
    ticksDir[0] = 0.0;
    ticksDir[1] = 1.0;
    break;
  case 'd':
    // axis along X axis
    // ticks along Y one
    ticksDir[0] = 0.0;
    ticksDir[1] = -1.0;
    break;
  case 'l':
    // axis along Y axis
    // ticks along X one
    ticksDir[0] = -1.0;
    ticksDir[1] = 0.0;
    break;
  case 'r':
    // axis along Y axis
    // ticks along X one
    ticksDir[0] = 1.0;
    ticksDir[1] = 0.0;
    break;
  default:
    break;
  }

  ticksDir[2] = 0.0;

  // apply the right number of pixels
  setTicksDirectionLength(ticksDir, sciGetParentSubwin(m_pAxes->getDrawedObject()));

}

Here is the call graph for this function:

int sciGraphics::AxesPositioner::getRelativeTicksPosition	(	double	ticksPos[],
		int	nbTicks
	)			[virtual]

Convert ticks abscissas, into relative coordinates between the two axis bounds

Parameters:

	ticksPos	abscissas of ticks along their axis as input in output, get the relative coordinates between the axes bounds. 0 stands fot the start bound, 1 for the last one.
	nbTicks	number of ticks abascissas as input

Returns:

number of ticks as output

Implements sciGraphics::AxisPositioner.

Definition at line 136 of file AxesPositioner.cpp.

References getAxisBounds(), i, isXAxisAligned(), max, and min.

{
  double axisStart[3];
  double axisEnd[3];
  getAxisBounds(axisStart, axisEnd);

  double min;
  double max;

  if (isXAxisAligned())
  {
    min = axisStart[0];
    max = axisEnd[0];
  }
  else
  {
    min = axisStart[1];
    max = axisEnd[1];
  }


  for (int i = 0; i < nbTicks; i++)
  {
    ticksPos[i] = (ticksPos[i] - min) / (max - min);
  }
  return nbTicks;
}

Here is the call graph for this function:

bool sciGraphics::AxesPositioner::isXAxisAligned

(

void

)

[protected]

To know if the axes is aligned with X axis or with Y axis

Definition at line 164 of file AxesPositioner.cpp.

References sciGraphics::DrawableObject::getDrawedObject(), m_pAxes, sciAxes::nx, sciAxes::ny, and pAXES_FEATURE.

Referenced by getAxisBounds(), and getRelativeTicksPosition().

{
  sciAxes * ppAxes = pAXES_FEATURE(m_pAxes->getDrawedObject());
  return (ppAxes->nx > ppAxes->ny);
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

DrawableAxes* sciGraphics::AxesPositioner::m_pAxes [protected]

Definition at line 63 of file AxesPositioner.hxx.

Referenced by AxesPositioner(), getAxisBounds(), getTicksDirection(), isXAxisAligned(), and ~AxesPositioner().

---

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

• /home/scilab/compilation_chain/sci_checkOut/scilab/modules/renderer/src/cpp/axesDrawing/AxesPositioner.hxx
• /home/scilab/compilation_chain/sci_checkOut/scilab/modules/renderer/src/cpp/axesDrawing/AxesPositioner.cpp