sciGraphics::UserDefinedTicksComputer Class Reference

#include </home/scilab/compilation_chain/sci_checkOut/scilab/modules/renderer/src/cpp/subwinDrawing/UserDefinedTicksComputer.hxx>

Inheritance diagram for sciGraphics::UserDefinedTicksComputer:

[legend]

Collaboration diagram for sciGraphics::UserDefinedTicksComputer:

[legend]

Public Member Functions
	UserDefinedTicksComputer (DrawableSubwin *subwin)
virtual	~UserDefinedTicksComputer (void)
virtual void	reinit (void)
virtual int	getNbTicks (void)
virtual void	getTicksPosition (double positions[], char *labels[], char *labelsExponents[])
virtual void	reduceTicksNumber (void)
virtual bool	needTicksDecimation (void)
virtual bool	isDisplayingLabelsExponents (void)
void	setUserTicks (double *userTicksPos, char **userLabels, int nbUserTicks, int nbSubticks)
Protected Attributes
double *	m_aUserTicksPositions
char **	m_aUserTicksLabels
int	m_iNbUserTicks
int	m_iNbSubticks

---

Detailed Description

Definition at line 22 of file UserDefinedTicksComputer.hxx.

---

Constructor & Destructor Documentation

sciGraphics::UserDefinedTicksComputer::UserDefinedTicksComputer

(

DrawableSubwin *

subwin

)

Definition at line 21 of file UserDefinedTicksComputer.cpp.

References m_aUserTicksLabels, m_aUserTicksPositions, m_iNbSubticks, m_iNbUserTicks, and NULL.

  : ComputeTicksStrategy(subwin)
{
  m_aUserTicksPositions = NULL;
  m_aUserTicksLabels = NULL;
  m_iNbUserTicks = 0;
  m_iNbSubticks = 0;
}

sciGraphics::UserDefinedTicksComputer::~UserDefinedTicksComputer

(

void

)

[virtual]

Definition at line 30 of file UserDefinedTicksComputer.cpp.

References m_aUserTicksLabels, m_aUserTicksPositions, m_iNbSubticks, m_iNbUserTicks, and NULL.

{
  m_aUserTicksPositions = NULL;
  m_aUserTicksLabels = NULL;
  m_iNbUserTicks = 0;
  m_iNbSubticks = 0;
}

---

Member Function Documentation

void sciGraphics::UserDefinedTicksComputer::reinit

(

void

)

[virtual]

Reinitialize ticks computer data.

Implements sciGraphics::ComputeTicksStrategy.

Definition at line 38 of file UserDefinedTicksComputer.cpp.

{

}

int sciGraphics::UserDefinedTicksComputer::getNbTicks

(

void

)

[virtual]

Get the number of ticks which will be computed by the strategy.

Implements sciGraphics::ComputeTicksStrategy.

Definition at line 43 of file UserDefinedTicksComputer.cpp.

References m_iNbUserTicks.

{
  return m_iNbUserTicks;
}

void sciGraphics::UserDefinedTicksComputer::getTicksPosition	(	double	positions[],
		char *	labels[],
		char *	labelsExponents[]
	)			[virtual]

Fill positions parameters with the ticks abscissas, ordinate, ...

Implements sciGraphics::ComputeTicksStrategy.

Reimplemented in sciGraphics::UserDefLogTicksComputer.

Definition at line 48 of file UserDefinedTicksComputer.cpp.

References i, m_aUserTicksLabels, m_aUserTicksPositions, m_iNbUserTicks, and BasicAlgos::stringArrayCopy().

{
  for (int i = 0; i < m_iNbUserTicks; i++)
  {
    positions[i] = m_aUserTicksPositions[i];
  }
  BasicAlgos::stringArrayCopy(labels, m_aUserTicksLabels, m_iNbUserTicks);
}

Here is the call graph for this function:

void sciGraphics::UserDefinedTicksComputer::reduceTicksNumber

(

void

)

[virtual]

To be called when there are too many ticks. Compute a new sequence of ticks with less ticks.

Implements sciGraphics::ComputeTicksStrategy.

Definition at line 57 of file UserDefinedTicksComputer.cpp.

{
  // don't do anything since this is user defined ticks
  // Actually, this function should not be called.
}

virtual bool sciGraphics::UserDefinedTicksComputer::needTicksDecimation

(

void

)

[inline, virtual]

To know if the ticks computer needs decimation.

Implements sciGraphics::ComputeTicksStrategy.

Definition at line 55 of file UserDefinedTicksComputer.hxx.

{return false;}

virtual bool sciGraphics::UserDefinedTicksComputer::isDisplayingLabelsExponents

(

void

)

[inline, virtual]

To know if we need to get ticks exposants or not.

Implements sciGraphics::ComputeTicksStrategy.

Definition at line 60 of file UserDefinedTicksComputer.hxx.

{return false;}

void sciGraphics::UserDefinedTicksComputer::setUserTicks	(	double *	userTicksPos,
		char **	userLabels,
		int	nbUserTicks,
		int	nbSubticks
	)

Set the parameter for drawing user ticks.

Parameters:

nbSubticks

number of subticks between each ticks.

Definition at line 63 of file UserDefinedTicksComputer.cpp.

References m_aUserTicksLabels, m_aUserTicksPositions, m_iNbSubticks, and m_iNbUserTicks.

Referenced by sciGraphics::TicksDrawerFactory::createXTicksDrawer(), sciGraphics::TicksDrawerFactory::createYTicksDrawer(), and sciGraphics::TicksDrawerFactory::createZTicksDrawer().

{
  m_aUserTicksPositions = userTicks;
  m_aUserTicksLabels = userLabels;
  m_iNbUserTicks = nbUserTicks;
  m_iNbSubticks = nbSubticks;
}

Here is the caller graph for this function:

---

Field Documentation

double* sciGraphics::UserDefinedTicksComputer::m_aUserTicksPositions [protected]

Definition at line 71 of file UserDefinedTicksComputer.hxx.

Referenced by sciGraphics::UserDefLogTicksComputer::getTicksPosition(), getTicksPosition(), setUserTicks(), UserDefinedTicksComputer(), and ~UserDefinedTicksComputer().

char** sciGraphics::UserDefinedTicksComputer::m_aUserTicksLabels [protected]

Definition at line 72 of file UserDefinedTicksComputer.hxx.

Referenced by sciGraphics::UserDefLogTicksComputer::getTicksPosition(), getTicksPosition(), setUserTicks(), UserDefinedTicksComputer(), and ~UserDefinedTicksComputer().

int sciGraphics::UserDefinedTicksComputer::m_iNbUserTicks [protected]

Definition at line 73 of file UserDefinedTicksComputer.hxx.

Referenced by getNbTicks(), sciGraphics::UserDefLogTicksComputer::getTicksPosition(), getTicksPosition(), setUserTicks(), UserDefinedTicksComputer(), and ~UserDefinedTicksComputer().

int sciGraphics::UserDefinedTicksComputer::m_iNbSubticks [protected]

Definition at line 74 of file UserDefinedTicksComputer.hxx.

Referenced by setUserTicks(), UserDefinedTicksComputer(), and ~UserDefinedTicksComputer().

---

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

• /home/scilab/compilation_chain/sci_checkOut/scilab/modules/renderer/src/cpp/subwinDrawing/UserDefinedTicksComputer.hxx
• /home/scilab/compilation_chain/sci_checkOut/scilab/modules/renderer/src/cpp/subwinDrawing/UserDefinedTicksComputer.cpp