 |
Chemical Data Processing Library C++ API - Version 1.4.0
|
|
Chemical Data Processing Library C++ API - Version 1.4.0
|
Data type for the descripton of arbitrary shapes composed of spheres approximated by gaussian functions. More...
#include <GaussianShape.hpp>
Inheritance diagram for CDPL::Shape::GaussianShape:Classes | |
| class | Element |
| Data structure representing a single sphere of the Gaussian shape, characterized by a position, radius, hardness and color. More... | |
Public Types | |
| typedef std::shared_ptr< GaussianShape > | SharedPointer |
A reference-counted smart pointer [SHPTR] for dynamically allocated GaussianShape instances. More... | |
| typedef ElementList::const_iterator | ConstElementIterator |
| A constant iterator over the elements of the shape. More... | |
| typedef ElementList::iterator | ElementIterator |
| A mutable iterator over the elements of the shape. More... | |
| Public Types inherited from CDPL::Base::PropertyContainer | |
| typedef PropertyMap::value_type | PropertyEntry |
| A Base::LookupKey / Base::Any pair that stores the property value for a given property key. More... | |
| typedef PropertyMap::const_iterator | ConstPropertyIterator |
| A constant iterator used to iterate over the property entries. More... | |
Public Member Functions | |
| void | clear () |
| Removes all elements from the shape. More... | |
| std::size_t | getNumElements () const |
| Returns the number of elements in the shape. More... | |
| void | addElement (const Math::Vector3D &pos, double radius, std::size_t color=0, double hardness=2.7) |
| Adds a new element to the shape. More... | |
| void | addElement (const Element &elem) |
| Adds the given element to the shape. More... | |
| void | removeElement (std::size_t idx) |
| Removes the element at index idx. More... | |
| const Element & | getElement (std::size_t idx) const |
Returns a const reference to the element at index idx. More... | |
| Element & | getElement (std::size_t idx) |
| Returns a reference to the element at index idx. More... | |
| ConstElementIterator | getElementsBegin () const |
| Returns a constant iterator pointing to the first element. More... | |
| ConstElementIterator | getElementsEnd () const |
| Returns a constant iterator pointing one past the last element. More... | |
| ElementIterator | getElementsBegin () |
| Returns a mutable iterator pointing to the first element. More... | |
| ElementIterator | getElementsEnd () |
| Returns a mutable iterator pointing one past the last element. More... | |
| ConstElementIterator | begin () const |
| Returns a constant iterator pointing to the first element (range-based for support). More... | |
| ConstElementIterator | end () const |
| Returns a constant iterator pointing one past the last element (range-based for support). More... | |
| ElementIterator | begin () |
| Returns a mutable iterator pointing to the first element (range-based for support). More... | |
| ElementIterator | end () |
| Returns a mutable iterator pointing one past the last element (range-based for support). More... | |
| Public Member Functions inherited from CDPL::Base::PropertyContainer | |
| std::size_t | getNumProperties () const |
| Returns the number of property entries. More... | |
| template<typename T > | |
| void | setProperty (const LookupKey &key, T &&val) |
| Sets the value of the property specified by key to val. More... | |
| template<typename T > | |
| const T & | getProperty (const LookupKey &key) const |
Returns the value of the property specified by key as a const reference to an object of type T. More... | |
| template<typename T > | |
| const T & | getPropertyOrDefault (const LookupKey &key, const T &def_val) const |
Returns the value of the property specified by key as a const reference to an object of type T, or the default value def_val if a stored value does not exist. More... | |
| const Any & | getProperty (const LookupKey &key, bool throw_=false) const |
| Returns the value of the property specified by key. More... | |
| bool | isPropertySet (const LookupKey &key) const |
| Tells whether or not a value has been assigned to the property specified by key. More... | |
| ConstPropertyIterator | getPropertiesBegin () const |
| Returns a constant iterator pointing to the beginning of the property entries. More... | |
| ConstPropertyIterator | getPropertiesEnd () const |
| Returns a constant iterator pointing to the end of the property entries. More... | |
| ConstPropertyIterator | begin () const |
| Returns a constant iterator pointing to the beginning of the property entries. More... | |
| ConstPropertyIterator | end () const |
| Returns a constant iterator pointing to the end of the property entries. More... | |
| bool | removeProperty (const LookupKey &key) |
| Clears the value of the property specified by key. More... | |
| void | clearProperties () |
| Clears all property values. More... | |
| void | addProperties (const PropertyContainer &cntnr) |
Adds the property value entries in the PropertyContainer instance cntnr. More... | |
| void | copyProperties (const PropertyContainer &cntnr) |
| Replaces the current set of properties by a copy of the entries in cntnr. More... | |
| void | swap (PropertyContainer &cntnr) |
| Exchanges the properties of this container with the properties of the container cntnr. More... | |
| const PropertyContainer & | getProperties () const |
Returns a const reference to itself. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from CDPL::Base::PropertyContainer | |
| PropertyContainer () | |
Constructs an empty PropertyContainer instance. More... | |
| PropertyContainer (const PropertyContainer &cntnr) | |
Constructs a copy of the PropertyContainer instance cntnr. More... | |
| virtual | ~PropertyContainer () |
| Virtual destructor. More... | |
| PropertyContainer & | operator= (const PropertyContainer &cntnr) |
| Assignment operator. More... | |
Data type for the descripton of arbitrary shapes composed of spheres approximated by gaussian functions.
| typedef std::shared_ptr<GaussianShape> CDPL::Shape::GaussianShape::SharedPointer |
A reference-counted smart pointer [SHPTR] for dynamically allocated GaussianShape instances.
| typedef ElementList::const_iterator CDPL::Shape::GaussianShape::ConstElementIterator |
A constant iterator over the elements of the shape.
| typedef ElementList::iterator CDPL::Shape::GaussianShape::ElementIterator |
A mutable iterator over the elements of the shape.
| void CDPL::Shape::GaussianShape::clear | ( | ) |
Removes all elements from the shape.
| std::size_t CDPL::Shape::GaussianShape::getNumElements | ( | ) | const |
Returns the number of elements in the shape.
| void CDPL::Shape::GaussianShape::addElement | ( | const Math::Vector3D & | pos, |
| double | radius, | ||
| std::size_t | color = 0, |
||
| double | hardness = 2.7 |
||
| ) |
Adds a new element to the shape.
| pos | The position of the new element's sphere center. |
| radius | The sphere radius. |
| color | The color attribute. |
| hardness | The hardness of the Gaussian. |
| void CDPL::Shape::GaussianShape::addElement | ( | const Element & | elem | ) |
Adds the given element to the shape.
| elem | The element to add. |
| void CDPL::Shape::GaussianShape::removeElement | ( | std::size_t | idx | ) |
Removes the element at index idx.
| idx | The index of the element to remove. |
| Base::IndexError | if the number of elements is zero or idx is not in the range [0, getNumElements() - 1]. |
| const Element& CDPL::Shape::GaussianShape::getElement | ( | std::size_t | idx | ) | const |
Returns a const reference to the element at index idx.
| idx | The index of the element. |
const reference to the element. | Base::IndexError | if the number of elements is zero or idx is not in the range [0, getNumElements() - 1]. |
| Element& CDPL::Shape::GaussianShape::getElement | ( | std::size_t | idx | ) |
Returns a reference to the element at index idx.
| idx | The index of the element. |
| Base::IndexError | if the number of elements is zero or idx is not in the range [0, getNumElements() - 1]. |
| ConstElementIterator CDPL::Shape::GaussianShape::getElementsBegin | ( | ) | const |
Returns a constant iterator pointing to the first element.
| ConstElementIterator CDPL::Shape::GaussianShape::getElementsEnd | ( | ) | const |
Returns a constant iterator pointing one past the last element.
| ElementIterator CDPL::Shape::GaussianShape::getElementsBegin | ( | ) |
Returns a mutable iterator pointing to the first element.
| ElementIterator CDPL::Shape::GaussianShape::getElementsEnd | ( | ) |
Returns a mutable iterator pointing one past the last element.
| ConstElementIterator CDPL::Shape::GaussianShape::begin | ( | ) | const |
Returns a constant iterator pointing to the first element (range-based for support).
| ConstElementIterator CDPL::Shape::GaussianShape::end | ( | ) | const |
Returns a constant iterator pointing one past the last element (range-based for support).
| ElementIterator CDPL::Shape::GaussianShape::begin | ( | ) |
Returns a mutable iterator pointing to the first element (range-based for support).
| ElementIterator CDPL::Shape::GaussianShape::end | ( | ) |
Returns a mutable iterator pointing one past the last element (range-based for support).
1.9.1