OSDL::Video::TwoDimensional::UprightRectangleGL Class Reference

This classes defines a rectangle whose sides are parallel or orthogonal to the screen's sides, according to OpenGL conventions. More...

#include <OSDLGLUprightRectangle.h>

List of all members.

Public Member Functions

 UprightRectangleGL (const Ceylan::Maths::Linear::Bipoint &upperLeftCorner, const Ceylan::Maths::Linear::Bipoint &lowerRightCorner)
 Two corners define an UprightRectangleGL.
 UprightRectangleGL (const Ceylan::Maths::Linear::Bipoint &upperLeftCorner, OpenGL::GLLength width, OpenGL::GLLength height)
 One corner, width and height define an UprightRectangleGL.
 UprightRectangleGL (OpenGL::GLCoordinate x, OpenGL::GLCoordinate y, OpenGL::GLLength width, OpenGL::GLLength height)
 Two coordinates, width and height define an UprightRectangleGL.
virtual ~UprightRectangleGL () throw ()
 Basic destructor, so that it remains virtual.
virtual
Ceylan::Maths::Linear::Bipoint 
getUpperLeftCorner () const
 Returns this UprightRectangleGL's upper left corner.
virtual void setUpperLeftCorner (Ceylan::Maths::Linear::Bipoint &newUpperLeftCorner)
 Sets this UprightRectangleGL's upper left corner, width and height do not change.
virtual OpenGL::GLCoordinate getUpperLeftAbscissa () const
 Returns directly the abscissa of upper left corner.
virtual OpenGL::GLCoordinate getUpperLeftOrdinate () const
 Returns directly the ordiante of upper left corner.
virtual OpenGL::GLLength getWidth () const
 Returns this UprightRectangleGL's width.
virtual void setWidth (OpenGL::GLLength newWidth)
 Sets this UprightRectangleGL's width.
virtual OpenGL::GLLength getHeight () const
 Returns this UprightRectangleGL's height.
virtual void setHeight (OpenGL::GLLength newHeight)
 Sets this UprightRectangleGL's height.
virtual bool draw () const
 Draws directly this UprightRectangleGL thanks to OpenGL.
virtual const std::string toString (Ceylan::VerbosityLevels level=Ceylan::high) const
 Returns an user-friendly description of the state of this object.

Protected Attributes

OpenGL::GLCoordinate _x
 Upper left corner's abscissa (horizontal coordinate).
OpenGL::GLCoordinate _y
 Upper left corner's ordinate (vertical coordinate).
OpenGL::GLLength _width
 Width is counted from current abscissa, going right.
OpenGL::GLLength _height
 Height is count from current ordinate, going down.

Private Member Functions

 UprightRectangleGL (const UprightRectangleGL &source)
 Copy constructor made private to ensure that it will never be called.
UprightRectangleGLoperator= (const UprightRectangleGL &source)
 Assignment operator made private to ensure that it will never be called.

Detailed Description

This classes defines a rectangle whose sides are parallel or orthogonal to the screen's sides, according to OpenGL conventions.

The rectangle lies in the plane z=0 and has sides parallel to the x and y axes.

Note:
As long as no different platform is used, it happens that Ceylan::Maths::Real, which itself is a Ceylan::Float32, i.e. a float, is the same type as GLfloat. Therefore Ceylan::Maths::Linear::Bipoint instances, which rely on Real, can be used directly. If this relation had to change, then C++ template should be used instead.

Definition at line 106 of file OSDLGLUprightRectangle.h.


Constructor & Destructor Documentation

OSDL::Video::TwoDimensional::UprightRectangleGL::UprightRectangleGL ( const Ceylan::Maths::Linear::Bipoint &  upperLeftCorner,
const Ceylan::Maths::Linear::Bipoint &  lowerRightCorner 
)

Two corners define an UprightRectangleGL.

OSDL::Video::TwoDimensional::UprightRectangleGL::UprightRectangleGL ( const Ceylan::Maths::Linear::Bipoint &  upperLeftCorner,
OpenGL::GLLength  width,
OpenGL::GLLength  height 
)

One corner, width and height define an UprightRectangleGL.

OSDL::Video::TwoDimensional::UprightRectangleGL::UprightRectangleGL ( OpenGL::GLCoordinate  x,
OpenGL::GLCoordinate  y,
OpenGL::GLLength  width,
OpenGL::GLLength  height 
)

Two coordinates, width and height define an UprightRectangleGL.

UprightRectangleGL::~UprightRectangleGL (  )  throw () [virtual]

Basic destructor, so that it remains virtual.

Definition at line 110 of file OSDLGLUprightRectangle.cc.

OSDL::Video::TwoDimensional::UprightRectangleGL::UprightRectangleGL ( const UprightRectangleGL source  )  [explicit, private]

Copy constructor made private to ensure that it will never be called.

The compiler should complain whenever this undefined constructor is called, implicitly or not.


Member Function Documentation

bool UprightRectangleGL::draw (  )  const [virtual]

Draws directly this UprightRectangleGL thanks to OpenGL.

Definition at line 189 of file OSDLGLUprightRectangle.cc.

References _height, _width, _x, and _y.

GLLength UprightRectangleGL::getHeight (  )  const [virtual]

Returns this UprightRectangleGL's height.

Definition at line 171 of file OSDLGLUprightRectangle.cc.

References _height.

GLCoordinate UprightRectangleGL::getUpperLeftAbscissa (  )  const [virtual]

Returns directly the abscissa of upper left corner.

Definition at line 137 of file OSDLGLUprightRectangle.cc.

References _x.

Bipoint UprightRectangleGL::getUpperLeftCorner (  )  const [virtual]

Returns this UprightRectangleGL's upper left corner.

Definition at line 117 of file OSDLGLUprightRectangle.cc.

References _x, and _y.

GLCoordinate UprightRectangleGL::getUpperLeftOrdinate (  )  const [virtual]

Returns directly the ordiante of upper left corner.

Definition at line 146 of file OSDLGLUprightRectangle.cc.

References _y.

GLLength UprightRectangleGL::getWidth (  )  const [virtual]

Returns this UprightRectangleGL's width.

Definition at line 155 of file OSDLGLUprightRectangle.cc.

References _width.

UprightRectangleGL& OSDL::Video::TwoDimensional::UprightRectangleGL::operator= ( const UprightRectangleGL source  )  [private]

Assignment operator made private to ensure that it will never be called.

The compiler should complain whenever this undefined operator is called, implicitly or not.

virtual void OSDL::Video::TwoDimensional::UprightRectangleGL::setHeight ( OpenGL::GLLength  newHeight  )  [virtual]

Sets this UprightRectangleGL's height.

virtual void OSDL::Video::TwoDimensional::UprightRectangleGL::setUpperLeftCorner ( Ceylan::Maths::Linear::Bipoint &  newUpperLeftCorner  )  [virtual]

Sets this UprightRectangleGL's upper left corner, width and height do not change.

virtual void OSDL::Video::TwoDimensional::UprightRectangleGL::setWidth ( OpenGL::GLLength  newWidth  )  [virtual]

Sets this UprightRectangleGL's width.

const string UprightRectangleGL::toString ( Ceylan::VerbosityLevels  level = Ceylan::high  )  const [virtual]

Returns an user-friendly description of the state of this object.

Parameters:
level the requested verbosity level.
Note:
Text output format is determined from overall settings.
See also:
Ceylan::TextDisplayable

Definition at line 209 of file OSDLGLUprightRectangle.cc.

References _height, _width, _x, and _y.

Referenced by operator<<().


Member Data Documentation

Height is count from current ordinate, going down.

Definition at line 248 of file OSDLGLUprightRectangle.h.

Referenced by draw(), getHeight(), and toString().

Width is counted from current abscissa, going right.

Definition at line 243 of file OSDLGLUprightRectangle.h.

Referenced by draw(), getWidth(), and toString().

Upper left corner's abscissa (horizontal coordinate).

Definition at line 232 of file OSDLGLUprightRectangle.h.

Referenced by draw(), getUpperLeftAbscissa(), getUpperLeftCorner(), and toString().

Upper left corner's ordinate (vertical coordinate).

Definition at line 237 of file OSDLGLUprightRectangle.h.

Referenced by draw(), getUpperLeftCorner(), getUpperLeftOrdinate(), and toString().


The documentation for this class was generated from the following files:
Generated on Mon Nov 29 14:06:15 2010 for OSDL by  doxygen 1.6.3