# Visualization Library

A lightweight C++ OpenGL middleware for 2D/3D graphics

[Home] [Tutorials] [All Classes] [Grouped Classes]

Public Member Functions | Protected Attributes

# vl::Bond Class Reference

The Bond class represents a bond to be used with the Molecule class. More...

`#include <Bond.hpp>`

Inheritance diagram for vl::Bond:

List of all members.

## Public Member Functions

virtual const char * | className ()
| Returns the name of the class.
| Bond ()
| Bond (const Bond &other)
unsigned int | id () const
void | setId (unsigned int id)
void | setBondType (EBondType type)
EBondType | bondType () const
void | setAtom1 (Atom *atom)
Atom * | atom1 () const
void | setAtom2 (Atom *atom)
Atom * | atom2 () const
void | setVisible (bool visible)
bool | visible () const
void | setColor (const fvec4 &color)
const fvec4 & | color () const
void | setUseAtomColors (bool use_atom_color)
bool | useAtomColors () const
float | radius () const
void | setRadius (float radius)

## Protected Attributes

fvec4 | mColor
float | mRadius
Atom * | mAtom1
Atom * | mAtom2
EBondType | mType
unsigned int | mId
bool | mVisible
bool | mUseAtomColors

## Detailed Description

The Bond class represents a bond to be used with the Molecule class.

See also:
  - Molecule Visualization Tutorial
  - Molecule
  - Atom

Definition at line 62 of file Bond.hpp.

## Constructor & Destructor Documentation

vl::Bond::Bond | ( | ) | `[inline]`

Definition at line 67 of file Bond.hpp.

References VL_DEBUG_SET_OBJECT_NAME.

vl::Bond::Bond | ( | const Bond & | other ) | `[inline]`

Definition at line 71 of file Bond.hpp.

## Member Function Documentation

virtual const char* vl::Bond::className | ( | ) | `[inline, virtual]`

Returns the name of the class.

Reimplemented from vl::Object.

Definition at line 65 of file Bond.hpp.

unsigned int vl::Bond::id | ( | ) | const`[inline]`

Definition at line 73 of file Bond.hpp.

References mId.

Referenced by setId().

void vl::Bond::setId | ( | unsigned int | id ) | `[inline]`

Definition at line 74 of file Bond.hpp.

References id(), and mId.

void vl::Bond::setBondType | ( | EBondType | type ) | `[inline]`

Definition at line 76 of file Bond.hpp.

References mType.

EBondType vl::Bond::bondType | ( | ) | const`[inline]`

Definition at line 77 of file Bond.hpp.

References mType.

Referenced by vl::RingExtractor::keepAromaticCycles().

void vl::Bond::setAtom1 | ( | Atom * | atom ) | `[inline]`

Definition at line 79 of file Bond.hpp.

References mAtom1.

Atom* vl::Bond::atom1 | ( | ) | const`[inline]`

Definition at line 80 of file Bond.hpp.

References mAtom1.

Referenced by vl::Molecule::ballAndStickStyle(), vl::Molecule::bond(), vl::Molecule::computeAtomAdjacency(), vl::Molecule::eraseBond(), vl::Molecule::incidentBonds(), vl::Molecule::operator=(), vl::Molecule::sticksStyle(), and vl::Molecule::wireframeStyle().

void vl::Bond::setAtom2 | ( | Atom * | atom ) | `[inline]`

Definition at line 82 of file Bond.hpp.

References mAtom2.

Atom* vl::Bond::atom2 | ( | ) | const`[inline]`

Definition at line 83 of file Bond.hpp.

References mAtom2.

Referenced by vl::Molecule::ballAndStickStyle(), vl::Molecule::bond(), vl::Molecule::computeAtomAdjacency(), vl::Molecule::eraseBond(), vl::Molecule::incidentBonds(), vl::Molecule::operator=(), vl::Molecule::sticksStyle(), and vl::Molecule::wireframeStyle().

void vl::Bond::setVisible | ( | bool | visible ) | `[inline]`

Definition at line 85 of file Bond.hpp.

References mVisible, and visible().

bool vl::Bond::visible | ( | ) | const`[inline]`

Definition at line 86 of file Bond.hpp.

References mVisible.

Referenced by setVisible(), and vl::Molecule::wireframeStyle().

void vl::Bond::setColor | ( | const fvec4 & | color ) | `[inline]`

Definition at line 88 of file Bond.hpp.

References color(), and mColor.

const fvec4& vl::Bond::color | ( | ) | const`[inline]`

Definition at line 89 of file Bond.hpp.

References mColor.

Referenced by vl::Molecule::ballAndStickStyle(), setColor(), vl::Molecule::sticksStyle(), and vl::Molecule::wireframeStyle().

void vl::Bond::setUseAtomColors | ( | bool | use_atom_color ) | `[inline]`

Definition at line 91 of file Bond.hpp.

References mUseAtomColors.

bool vl::Bond::useAtomColors | ( | ) | const`[inline]`

Definition at line 92 of file Bond.hpp.

References mUseAtomColors.

Referenced by vl::Molecule::ballAndStickStyle(), vl::Molecule::sticksStyle(), and vl::Molecule::wireframeStyle().

float vl::Bond::radius | ( | ) | const`[inline]`

Definition at line 94 of file Bond.hpp.

References mRadius.

Referenced by vl::Molecule::ballAndStickStyle(), setRadius(), and vl::Molecule::sticksStyle().

void vl::Bond::setRadius | ( | float | radius ) | `[inline]`

Definition at line 95 of file Bond.hpp.

References mRadius, and radius().

## Member Data Documentation

fvec4 vl::Bond::mColor`[protected]`

Definition at line 98 of file Bond.hpp.

Referenced by color(), and setColor().

float vl::Bond::mRadius`[protected]`

Definition at line 99 of file Bond.hpp.

Referenced by radius(), and setRadius().

Atom* vl::Bond::mAtom1`[protected]`

Definition at line 100 of file Bond.hpp.

Referenced by atom1(), and setAtom1().

Atom* vl::Bond::mAtom2`[protected]`

Definition at line 101 of file Bond.hpp.

Referenced by atom2(), and setAtom2().

EBondType vl::Bond::mType`[protected]`

Definition at line 102 of file Bond.hpp.

Referenced by bondType(), and setBondType().

unsigned int vl::Bond::mId`[protected]`

Definition at line 103 of file Bond.hpp.

Referenced by id(), and setId().

bool vl::Bond::mVisible`[protected]`

Definition at line 104 of file Bond.hpp.

Referenced by setVisible(), and visible().

bool vl::Bond::mUseAtomColors`[protected]`

Definition at line 105 of file Bond.hpp.

Referenced by setUseAtomColors(), and useAtomColors().

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

- D:/VL/BuildSystem/VL_DISTRO/Visualization_Library_SDK/src/vlMolecule/Bond.hpp

Visualization Library v2011.05.1142 Reference Documentation
Copyright 2005-2011 Michele Bosi. All rights reserved.
Updated on Thu May 26 2011 22:51:47.
Permission is granted to use this page to write and publish articles regarding Visualization Library.