Map reference with coordinate-like behaviour. More...
#include <nxmap.h>
Inheritance diagram for clipper::NXmap_base::Map_reference_coord:
Public Member Functions | |
| Map_reference_coord () | |
| Null constructor. | |
| Map_reference_coord (const NXmap_base &map) | |
| Constructor: need parent map. | |
| Map_reference_coord (const NXmap_base &map, const Coord_grid &pos) | |
| Constructor: need parent map and coord. | |
| Coord_grid | coord () const |
| Get current value of coordinate. | |
| const Coord_orth | coord_orth () const |
| Get current value of orthogonal coordinate. | |
| Map_reference_coord & | set_coord (const Coord_grid &pos) |
| Set current value of coordinate - optimised for nearby coords. | |
| Map_reference_coord & | next () |
| Simple increment. | |
| Map_reference_coord & | next_u () |
| increment u | |
| Map_reference_coord & | next_v () |
| increment v | |
| Map_reference_coord & | next_w () |
| increment w | |
| Map_reference_coord & | prev_u () |
| decrement u | |
| Map_reference_coord & | prev_v () |
| decrement v | |
| Map_reference_coord & | prev_w () |
| decrement w | |
| Map_reference_coord & | operator= (const Coord_grid &pos) |
| Assignment operator from a coord. | |
| const NXmap_base & | base_nxmap () const |
| return the parent NXmap | |
| const int & | index () const |
| Get the index into the map data array. | |
| bool | last () const |
| Check for end of map. | |
Protected Attributes | |
| Coord_grid | pos_ |
| Current coord. | |
Detailed Description
Map reference with coordinate-like behaviour.
This is a reference to a map coordinate. It behaves like a coordinate, but also stores the index of the corresponding point in the map. It also implements methods for iterating through the a map. Since the current coordinate is stored, coord() is fast. However it required 5 words of storage.
- Note:
- The following methods are inherited from Map_reference_base but are documented here for convenience: base_nxmap(), index(), last().
Member Function Documentation
| Map_reference_coord& clipper::NXmap_base::Map_reference_coord::next | ( | ) | [inline] |
Simple increment.
Use of this function resets the stored coordinate and sym
References clipper::Grid::deindex(), clipper::NXmap_base::grid_, clipper::NXmap_base::Map_reference_base::index_, clipper::NXmap_base::Map_reference_base::map_, and pos_.
The documentation for this class was generated from the following file:
