Skip to content
  • Mark OLESEN's avatar
    ENH: cleanup treeData items (#2609) · ac4f580d
    Mark OLESEN authored and Andrew Heather's avatar Andrew Heather committed
    Changes / Improvements
    
    - more consistent subsetting, interface
    
      * Extend the use of subset and non-subset collections with uniform
        internal getters to ensure that the subset/non-subset versions
        are robustly handled.
    
      * operator[](label) and objectIndex(label) for standardized access
        to the underlying item, or the original index, regardless of
        subsetting or not.
    
      * centres() and centre(label) for representative point cloud
        information.
    
      * nDim() returns the object dimensionality (0: point, 1: line, etc)
        these can be used to determine how 'fat' each shape may be
        and whether bounds(labelList) may contribute any useful information.
    
      * bounds(labelList) to return the full bound box required for
        specific items. Eg, the overall bounds for various 3D cells.
    
    - easier construction of non-caching versions. The bounding boxes are
      rarely cached, so simpler constructors without the caching bool
      are provided.
    
    - expose findNearest (bound sphere) method to allow general use
      since this does not actually need a tree.
    
    - static helpers
    
      The boxes() static methods can be used by callers that need to build
      their own treeBoundBoxList of common shapes (edge, face, cell)
      that are also available as treeData types.
    
      The bounds() static methods can be used by callers to determine the
      overall bound-box size prior to constructing an indexedOctree
      without writing ad hoc code inplace.
    
      Not implemented for treeDataPrimitivePatch since similiar
      functionality is available directly from the PrimitivePatch::box()
      method with less typing.
    
    ========
    BREAKING: cellLabels(), faceLabels(), edgeLabel() access methods
    
    - it was always unsafe to use the treeData xxxLabels() methods without
      subsetting elements. However, since the various classes
      (treeDataCell, treeDataEdge, etc) automatically provided
      an identity lookup, this problem was not apparent.
    
      Use objectIndex(label) to safely de-reference to the original index
      and operator[](index) to de-reference to the original object.
    ac4f580d