org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL

org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL Class Reference

Inheritance diagram for org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL:

Inheritance graph
[legend]
Collaboration diagram for org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL:

Collaboration graph
[legend]

Public Member Functions

 BoxTrimmingObjectGL ()
void show (int parentFigureIndex)
void setAxesBounds (double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
double findLeftMostYCoordinate ()
double findLeftMostXCoordinate ()

Protected Member Functions

double getXmin ()
double getXmax ()
double getYmin ()
double getYmax ()
double getZmin ()
double getZmax ()
double findOtherXBound (double xBound)
double findOtherYBound (double yBound)
double findOtherZBound (double zBound)
double findFrontXCoordinate (double zCoordinate)
double findLowerZCoordinate ()
double findFrontYCoordinate (double zCoordinate)
boolean isSharingEndWithXaxis (double zCoordFront, double xCoordinate)
Vector3D findXTicksDirection (double yCoordinate, double zCoordinate)
Vector3D findYTicksDirection (double xCoordinate, double zCoordinate)
Vector3D findZTicksDirection (double xCoordinate, double yCoordinate)

Private Attributes

double xMin
double xMax
double yMin
double yMax
double zMin
double zMax

Detailed Description

Object drawing decoaration around axes box
Author:
Jean-Baptiste Silvy

Definition at line 27 of file BoxTrimmingObjectGL.java.

Constructor & Destructor Documentation

org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL::BoxTrimmingObjectGL (  )  [inline]

Default constructor

Definition at line 39 of file BoxTrimmingObjectGL.java.

References xMax, xMin, yMax, yMin, zMax, and zMin.

00039                                      {
00040                 super();
00041                 xMin = 0.0;
00042                 xMax = 0.0;
00043                 yMin = 0.0;
00044                 yMax = 0.0;
00045                 zMin = 0.0;
00046                 zMax = 0.0;
00047         }

Member Function Documentation

void org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL::show ( int  parentFigureIndex  )  [inline, virtual]

Should not be called

Parameters:
parentFigureIndex index of parent figure

Implements org::scilab::modules::renderer::DrawableObjectGL.

Reimplemented in org::scilab::modules::renderer::subwinDrawing::GridDrawerGL.

Definition at line 53 of file BoxTrimmingObjectGL.java.

00053                                                 {
00054                 // should not be called
00055         }

void org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL::setAxesBounds ( double  xMin,
double  xMax,
double  yMin,
double  yMax,
double  zMin,
double  zMax 
) [inline]

Set axes box to know were to draw items.

Parameters:
xMin minimun bounds on X axis.
xMax maximum bounds on X axis.
yMin minimun bounds on Y axis.
yMax maximum bounds on Y axis.
zMin minimun bounds on Z axis.
zMax maximum bounds on Z axis.

Definition at line 66 of file BoxTrimmingObjectGL.java.

00066                                                                                                                 {
00067                 this.xMin = xMin;
00068                 this.xMax = xMax;
00069                 this.yMin = yMin;
00070                 this.yMax = yMax;
00071                 this.zMin = zMin;
00072                 this.zMax = zMax;
00073         }

double org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL::getXmin (  )  [inline, protected]

Returns:
minimium bound on X axis

Definition at line 78 of file BoxTrimmingObjectGL.java.

References xMin.

Referenced by org::scilab::modules::renderer::subwinDrawing::YTicksDrawerGL::findBackXCoordinate(), findFrontXCoordinate(), findFrontYCoordinate(), findLeftMostXCoordinate(), findLeftMostYCoordinate(), findLowerZCoordinate(), org::scilab::modules::renderer::subwinDrawing::YTicksDrawerGL::findMiddleXCoordinate(), findYTicksDirection(), org::scilab::modules::renderer::subwinDrawing::XTicksDrawerGL::getAxisSegmentStart(), org::scilab::modules::renderer::subwinDrawing::XGridDrawerGL::getGridStartingPoints(), org::scilab::modules::renderer::labelDrawing::XLabelPositionerGL::getLabelPosition(), and org::scilab::modules::renderer::subwinDrawing::XTicksDrawerGL::getTicksPosition().

00078                                    {
00079                 return xMin;
00080         }

Here is the caller graph for this function:

double org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL::getXmax (  )  [inline, protected]

Returns:
maximum bound on X axis

Definition at line 85 of file BoxTrimmingObjectGL.java.

References xMax.

Referenced by org::scilab::modules::renderer::subwinDrawing::YTicksDrawerGL::findBackXCoordinate(), findFrontXCoordinate(), findLeftMostXCoordinate(), org::scilab::modules::renderer::subwinDrawing::YTicksDrawerGL::findMiddleXCoordinate(), findYTicksDirection(), org::scilab::modules::renderer::subwinDrawing::XTicksDrawerGL::getAxisSegmentEnd(), org::scilab::modules::renderer::subwinDrawing::XGridDrawerGL::getGridStartingPoints(), org::scilab::modules::renderer::labelDrawing::XLabelPositionerGL::getLabelPosition(), and org::scilab::modules::renderer::subwinDrawing::XTicksDrawerGL::getTicksPosition().

00085                                    {
00086                 return xMax;
00087         }

Here is the caller graph for this function:

double org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL::getYmin (  )  [inline, protected]

Returns:
minimium bound on Y axis

Definition at line 92 of file BoxTrimmingObjectGL.java.

References yMin.

Referenced by org::scilab::modules::renderer::subwinDrawing::XTicksDrawerGL::findBackYCoordinate(), findFrontXCoordinate(), findFrontYCoordinate(), findLeftMostXCoordinate(), findLeftMostYCoordinate(), findLowerZCoordinate(), org::scilab::modules::renderer::subwinDrawing::XTicksDrawerGL::findMiddleYCoordinate(), findXTicksDirection(), org::scilab::modules::renderer::subwinDrawing::YTicksDrawerGL::getAxisSegmentStart(), org::scilab::modules::renderer::subwinDrawing::YGridDrawerGL::getGridStartingPoints(), org::scilab::modules::renderer::labelDrawing::YLabelPositionerGL::getLabelPosition(), org::scilab::modules::renderer::subwinDrawing::ZTicksDrawerGL::getTicksPosition(), and org::scilab::modules::renderer::subwinDrawing::YTicksDrawerGL::getTicksPosition().

00092                                    {
00093                 return yMin;
00094         }

Here is the caller graph for this function:

double org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL::getYmax (  )  [inline, protected]

Returns:
maximum bound on Y axis

Definition at line 99 of file BoxTrimmingObjectGL.java.

References yMax.

Referenced by org::scilab::modules::renderer::subwinDrawing::XTicksDrawerGL::findBackYCoordinate(), findFrontYCoordinate(), findLeftMostYCoordinate(), org::scilab::modules::renderer::subwinDrawing::XTicksDrawerGL::findMiddleYCoordinate(), findXTicksDirection(), org::scilab::modules::renderer::subwinDrawing::YTicksDrawerGL::getAxisSegmentEnd(), org::scilab::modules::renderer::subwinDrawing::YGridDrawerGL::getGridStartingPoints(), org::scilab::modules::renderer::labelDrawing::YLabelPositionerGL::getLabelPosition(), org::scilab::modules::renderer::subwinDrawing::ZTicksDrawerGL::getTicksPosition(), and org::scilab::modules::renderer::subwinDrawing::YTicksDrawerGL::getTicksPosition().

00099                                    {
00100                 return yMax;
00101         }

Here is the caller graph for this function:

double org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL::getZmin (  )  [inline, protected]

Returns:
minimium bound on Z axis

Definition at line 106 of file BoxTrimmingObjectGL.java.

References zMin.

Referenced by findLeftMostXCoordinate(), findLeftMostYCoordinate(), findLowerZCoordinate(), org::scilab::modules::renderer::subwinDrawing::YTicksDrawerGL::findTicksDirection(), org::scilab::modules::renderer::subwinDrawing::XTicksDrawerGL::findTicksDirection(), org::scilab::modules::renderer::subwinDrawing::TicksDrawerGL::findUpperZCoordinate(), org::scilab::modules::renderer::subwinDrawing::ZTicksDrawerGL::getAxisSegmentStart(), org::scilab::modules::renderer::subwinDrawing::ZGridDrawerGL::getGridStartingPoints(), and org::scilab::modules::renderer::labelDrawing::ZLabelPositionerGL::getLabelPosition().

00106                                    {
00107                 return zMin;
00108         }

Here is the caller graph for this function:

double org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL::getZmax (  )  [inline, protected]

Returns:
maximum bound on Z axis

Definition at line 113 of file BoxTrimmingObjectGL.java.

References zMax.

Referenced by findLowerZCoordinate(), org::scilab::modules::renderer::subwinDrawing::YTicksDrawerGL::findTicksDirection(), org::scilab::modules::renderer::subwinDrawing::XTicksDrawerGL::findTicksDirection(), org::scilab::modules::renderer::subwinDrawing::TicksDrawerGL::findUpperZCoordinate(), org::scilab::modules::renderer::subwinDrawing::ZTicksDrawerGL::getAxisSegmentEnd(), org::scilab::modules::renderer::subwinDrawing::ZGridDrawerGL::getGridStartingPoints(), and org::scilab::modules::renderer::labelDrawing::ZLabelPositionerGL::getLabelPosition().

00113                                    {
00114                 return zMax;
00115         }

Here is the caller graph for this function:

double org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL::findOtherXBound ( double  xBound  )  [inline, protected]

Knowing on of the X bounds (xMin or xMax), find the other

Parameters:
xBound xMin or xMax
Returns:
the other bound

Definition at line 122 of file BoxTrimmingObjectGL.java.

References xMax, and xMin.

Referenced by org::scilab::modules::renderer::subwinDrawing::ZGridDrawerGL::getGridEndPoints(), org::scilab::modules::renderer::subwinDrawing::ZGridDrawerGL::getGridMiddlePoints(), org::scilab::modules::renderer::subwinDrawing::YGridDrawerGL::getGridMiddlePoints(), and isSharingEndWithXaxis().

00122                                                         {
00123                 if (Math.abs(xBound - xMin) < Math.abs(xBound - xMax)) {
00124                         // closer to xMin
00125                         return xMax;
00126                 } else {
00127                         return xMin;
00128                 }
00129         }

Here is the caller graph for this function:

double org::scilab::modules::renderer::subwinDrawing::BoxTrimmingObjectGL::findOtherYBound ( double  yBound  )  [inline, protected]

Knowing on of the y bounds (yMin or yMax), find the other

Parameters:
yBound yMin or yMax
Returns:
the other bound

Definition at line 136 of file BoxTrimmingObjectGL.java.

References yMax, and yMin.

Referenced by org::scilab::modules::renderer::subwinDrawing::ZGridDrawerGL::getGridEndPoints(), org::scilab::modules::renderer::subwinDrawing::ZGridDrawerGL::getGridMiddlePoints(), and org::scilab::modules::renderer::subwinDrawing::XGridDrawerGL::getGridMiddlePoints().

00136                                                         {
00137                 if (Math.abs(yBound - yMin) < Math.abs(yBound - yMax)) {
00138                         // closer to yMin
00139                         return yMax;
00140                 } else {
00141                         return yMin;
00142                 }
00143         }

Here is the caller graph for this function: