KDE 4.0 API Reference kalzium
Avogadro::GLHit Class Reference
#include <glwidget.h>
Detailed Description
Class for wrapping hits from GL picking.Provides an easy to use class to contain OpenGL hits returned from the process of picking. This class relies on the Engine subclasses properly naming the objects which it is rendering. For more information see the Engine documentation.
Definition at line 59 of file src/glwidget.h.
Public Member Functions | |
| GLHit () | |
| GLHit (const GLHit &glHit) | |
| GLHit (GLuint type, GLuint name, GLuint minZ, GLuint maxZ) | |
| ~GLHit () | |
| bool | operator< (const GLHit &other) const |
| bool | operator== (const GLHit &other) const |
| GLHit & | operator= (const GLHit &other) |
| GLuint | type () const |
| GLuint | name () const |
| GLuint | minZ () const |
| GLuint | maxZ () const |
| void | setType (GLuint type) |
| void | setName (GLuint name) |
| void | setMinZ (GLuint minZ) |
| void | setMaxZ (GLuint maxZ) |
Constructor & Destructor Documentation
| Avogadro::GLHit::GLHit | ( | ) |
| Avogadro::GLHit::GLHit | ( | const GLHit & | glHit | ) |
| Avogadro::GLHit::GLHit | ( | GLuint | type, | |
| GLuint | name, | |||
| GLuint | minZ, | |||
| GLuint | maxZ | |||
| ) |
Constructor.
- Parameters:
-
type The type of the OpenGL object that was picked which corresponds to the Primitive::Type for the object (ie. type==PrimitiveAtomType means an Atom was picked). name The name of the OpenGL object that was picked corresponding to the primitive index (ie. name==1 means Atom 1)
Definition at line 68 of file glwidget.cpp.
| Avogadro::GLHit::~GLHit | ( | ) |
Member Function Documentation
| bool Avogadro::GLHit::operator< | ( | const GLHit & | other | ) | const |
Less than operator.
- Parameters:
-
other the other GLHit object to compare to
- Returns:
- (this->minZ < other->minZ) ?
true:false
Definition at line 89 of file glwidget.cpp.
| bool Avogadro::GLHit::operator== | ( | const GLHit & | other | ) | const |
Equivalence operator.
- Parameters:
-
other the other GLHit object to test equivalence with
- Returns:
- returns true if all elements are equivalent (type, name, minZ, maxZ)
Definition at line 94 of file glwidget.cpp.
Copy operator.
- Parameters:
-
other the GLHit object to set this object equal to
- Returns:
- *this
Definition at line 75 of file glwidget.cpp.
| GLuint Avogadro::GLHit::type | ( | ) | const |
| GLuint Avogadro::GLHit::name | ( | ) | const |
| GLuint Avogadro::GLHit::minZ | ( | ) | const |
- Returns:
- the minimum Z value of this hit corresponding to the Z value of the drawn object closest to the camera
Definition at line 101 of file glwidget.cpp.
| GLuint Avogadro::GLHit::maxZ | ( | ) | const |
- Returns:
- the maximum Z value of this hit corresponding to the Z value of the drawn object farthest from the camera
Definition at line 102 of file glwidget.cpp.
| void Avogadro::GLHit::setType | ( | GLuint | type | ) |
| void Avogadro::GLHit::setName | ( | GLuint | name | ) |
| void Avogadro::GLHit::setMinZ | ( | GLuint | minZ | ) |
- Parameters:
-
minZ minimum Z value to set for this object
Definition at line 106 of file glwidget.cpp.
| void Avogadro::GLHit::setMaxZ | ( | GLuint | maxZ | ) |
- Parameters:
-
maxZ maximum Z value to set for this object
Definition at line 107 of file glwidget.cpp.
The documentation for this class was generated from the following files:
