Avogadro::PrimitiveList Class Reference

Class which set of Primitives. More...

#include <primitivelist.h>

List of all members.

Classes
class	const_iterator
Public Member Functions
	PrimitiveList ()
	PrimitiveList (const PrimitiveList &other)
	PrimitiveList (const QList< Primitive * > &other)
PrimitiveList &	operator= (const PrimitiveList &other)
PrimitiveList &	operator= (const QList< Primitive * > &other)
	~PrimitiveList ()
QList< Primitive * >	subList (Primitive::Type type) const
QList< Primitive * >	list () const
bool	contains (const Primitive *p) const
void	append (Primitive *p)
void	removeAll (Primitive *p)
int	size () const
bool	isEmpty () const
int	count (Primitive::Type type) const
int	count () const
void	clear ()
const_iterator	begin () const
const_iterator	end () const

---

Detailed Description

Class which set of Primitives.

Author:

Donald Ephraim Curtis

The PrimitiveList class is designed to hold a set of Primitive objects and keep them organized by type allowing groups of them to be retrieved in constant time.

---

Constructor & Destructor Documentation

Avogadro::PrimitiveList::PrimitiveList

(

)

Constructor(s)

References Avogadro::Primitive::LastType.

Avogadro::PrimitiveList::~PrimitiveList

(

)

Deconstructor

---

Member Function Documentation

void Avogadro::PrimitiveList::append

(

Primitive *

p

)

Add a primitive to the queue.

Parameters:

p	primitive to add

References Avogadro::Primitive::FirstType, and Avogadro::Primitive::LastType.

Referenced by Avogadro::Engine::addPrimitive(), Avogadro::Molecule::copyAtomsAndBonds(), and Avogadro::GLWidget::namedSelectionPrimitives().

void Avogadro::PrimitiveList::clear

(

)

Removes every primitive from the queue.

Referenced by Avogadro::Engine::clearPrimitives(), and Avogadro::Engine::setMolecule().

bool Avogadro::PrimitiveList::contains

(

const Primitive *

p

)

const

Parameters:

p	the primitive to check if it is in any list

Returns:

true or false depending on whether p is in this list

Referenced by Avogadro::Engine::addPrimitive().

int Avogadro::PrimitiveList::count

(

Primitive::Type

type

)

const

Parameters:

type	the type of primitives we're interested in

Returns:

the number of primitives for the given type

References Avogadro::Primitive::LastType.

int Avogadro::PrimitiveList::count

(

)

const

effectively the same as size()

See also:

size()

References size().

bool Avogadro::PrimitiveList::isEmpty

(

)

const

Returns:

!size()

References size().

QList< Primitive * > Avogadro::PrimitiveList::list

(

)

const

Returns a list of all primitives of all types.

Returns:

a QList of pointers to Primitive objects

void Avogadro::PrimitiveList::removeAll

(

Primitive *

p

)

Remove a primitive from the queue. If the parameter does not exist in the queue, nothing is removed.

Parameters:

p	primitive to remove

Referenced by Avogadro::Engine::removePrimitive().

int Avogadro::PrimitiveList::size

(

)

const

Returns:

The total number of primitives in this queue.

Referenced by count(), and isEmpty().

QList< Primitive * > Avogadro::PrimitiveList::subList

(

Primitive::Type

type

)

const

Returns a list of primitives for a given type.

Parameters:

type	the type of primitives to retrieve, one of Primitive::Type

Returns:

a QList of pointers to Primitive objects

References Avogadro::Primitive::LastType.

Referenced by Avogadro::Molecule::copyAtomsAndBonds(), and Avogadro::Engine::setPrimitives().

---

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

• /home/kitware/dashboards/avogadro/libavogadro/src/primitivelist.h
• /home/kitware/dashboards/avogadro/libavogadro/src/primitivelist.cpp