Template Class gridQ3D_view_entity

Inheritance Relationships

Base Types

Class Documentation

template<typename TGridType, typename TGridViewType>
class gridQ3D_view_entity : public rer::client<gridQ3D_view_entity<TGridType, TGridViewType>>, public cosm::repr::entity3D, public cosm::repr::base_grid_view_entity<TGridType, TGridViewType>

Representation of an entity that lives on 2D grid, but that has an imaginary Z dimension (i.e., it is a bounding box).

Public Types

using cell_type = typename grid_type::value_type
using coord_type = typename grid_type::coord_type
using grid_type = TGridType
using grid_view_entity_type = base_grid_view_entity<TGridType, TGridViewType>
using grid_view_type = TGridViewType

Public Functions

inline gridQ3D_view_entity(const rtypes::type_uuid &id, const grid_view_type &the_view, size_t zdsize, const rtypes::discretize_ratio &res)
~gridQ3D_view_entity(void) override = default
inline virtual const cell_type &access(const coord_type &c) const override

Get the cell associated with a particular grid location within the view. Asserts that both coordinates are within the bounds of the grid underlying the view.

Parameters:

c – The RELATIVE coord within the view.

Returns:

A reference to the cell.

inline const cell_type &access(size_t i, size_t j) const
inline virtual bool contains_abs(const coord_type &cell) const override

Determine if the specified ABSOLUTE coordinates lie within the view entity (i.e., the coordinates are specified relative to the origin of the parent grid this entity is built from.)

inline virtual bool contains_rel(const coord_type &cell) const override

Determine if the specified RELATIVE coordinates lie within the view entity (i.e., the coordinates are specified relative to the origin of the view entity, which is not necessarily the same as the origin of the parent grid).

inline const rtypes::discretize_ratio &resolution(void) const

Protected Functions

inline const grid_view_type &view(void) const