• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdeedu
  • Sitemap
  • Contact Us
 

kalzium

Avogadro::BSDYEngine

Avogadro::BSDYEngine Class Reference

#include <bsdyengine.h>

Inheritance diagram for Avogadro::BSDYEngine:

Inheritance graph
[legend]

List of all members.


Detailed Description

Definition at line 43 of file bsdyengine.h.


Public Member Functions

 BSDYEngine (QObject *parent=0)
 ~BSDYEngine ()
void addPrimitive (Primitive *)
void updatePrimitive (Primitive *)
void removePrimitive (Primitive *)
QWidget * settingsWidget ()
Description methods
QString name ()
QString description ()
Render Methods
bool render (const Atom *a)
bool render (const Bond *b)
bool render (const Molecule *m)
bool render (GLWidget *gl)
double radius (const Primitive *p=0)

Constructor & Destructor Documentation

BSDYEngine::BSDYEngine ( QObject *  parent = 0  ) 

Constructor.

Definition at line 46 of file bsdyengine.cpp.

BSDYEngine::~BSDYEngine (  ) 

Deconstructor.

Definition at line 51 of file bsdyengine.cpp.


Member Function Documentation

QString Avogadro::BSDYEngine::name (  )  [inline, virtual]

Returns:
engine name

Implements Avogadro::Engine.

Definition at line 56 of file bsdyengine.h.

QString Avogadro::BSDYEngine::description (  )  [inline, virtual]

Returns:
engine description

Implements Avogadro::Engine.

Definition at line 58 of file bsdyengine.h.

bool BSDYEngine::render ( const Atom *  a  ) 

Render an Atom.

Definition at line 171 of file bsdyengine.cpp.

bool BSDYEngine::render ( const Bond *  b  ) 

Render a Bond.

Definition at line 177 of file bsdyengine.cpp.

bool BSDYEngine::render ( const Molecule *  m  ) 

Render a Molecule.

Definition at line 183 of file bsdyengine.cpp.

bool BSDYEngine::render ( GLWidget *  gl  )  [virtual]

Render a PrimitiveQueue.

This function is allowed to rendering whatever primitives it wishes. There is no requirement that it render every primitive.

Parameters:
queue This parameter is of type PrimitiveQueue which provides an organized list of Primitive* objects. During generation of the GL view engines will have their render function called at most once. It is the responsibility of the engine to render all of the objects in it's queue if it can.
Returns:
true if the rendering was completed successfully, false otherwise
Example
 Engine::render(const PrimitiveQueue *queue)
 {
   const QList<Primitive *> *list;

   glPushName(Primitive::AtomType);
   list = q->primitiveList(Primitive::AtomType);
   for( int i=0; i<list->size(); i++ ) {
     Bond *atom = (*list)[i];
     glPushName(atom->GetIdx());
     *** render atom ***
     glPopName();
   }

   glPushName(Primitive::BondType);
   list = q->primitiveList(Primitive::BondType);
   for( int i=0; i<list->size(); i++ ) {
     Bond *bond = (*list)[i];
     glPushName(bond->GetIdx());
     *** render bond ***
     glPopName();
   }
   glPopName();

   return true;
 }

Note:
To allow picking to happen you need to push the object type and name. If objects cannot be picked this may be omitted.
For more information on the various primitive lists available see PrimitiveQueue.

Implements Avogadro::Engine.

Definition at line 59 of file bsdyengine.cpp.

double BSDYEngine::radius ( const Primitive *  primitive = 0  )  [virtual]

Get the radius of the primitive referred to.

Parameters:
primitive is the Primitive to get the radius of
Returns:
the radius of the Primitive

Reimplemented from Avogadro::Engine.

Definition at line 154 of file bsdyengine.cpp.

void BSDYEngine::addPrimitive ( Primitive *  primitive  )  [virtual]

Reimplemented from Avogadro::Engine.

Definition at line 190 of file bsdyengine.cpp.

void BSDYEngine::updatePrimitive ( Primitive *  primitive  )  [virtual]

Reimplemented from Avogadro::Engine.

Definition at line 196 of file bsdyengine.cpp.

void BSDYEngine::removePrimitive ( Primitive *  primitive  )  [virtual]

Reimplemented from Avogadro::Engine.

Definition at line 202 of file bsdyengine.cpp.

QWidget * BSDYEngine::settingsWidget (  )  [virtual]

Display a window for the user to pick rendering options.

Reimplemented from Avogadro::Engine.

Definition at line 208 of file bsdyengine.cpp.


The documentation for this class was generated from the following files:
  • bsdyengine.h
  • bsdyengine.cpp

kalzium

Skip menu "kalzium"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdeedu

Skip menu "kdeedu"
  • kalzium
  • kanagram
  • kig
  • klettres
  • kstars
  • libkdeedu
  •   keduvocdocument
  •   docs
  •   src
  • parley
Generated for kdeedu by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal