LavishNav:lnavregiongroup (Object Type)
Jump to navigation
Jump to search
Contents
Description
| lnavregiongroup | |
| Defined By | LavishNav |
| Inherits | none |
| Reduces To | NULL |
| Variable Object Type | lnavregiongroup |
| Uses Sub-Types | no |
| C/C++ Type | LNavRegionGroup * |
Members
- uint Size:
- bool Contains[search]: TRUE if the specified region is present in this group
- ... NearestRegion[x,y,z]: Retrieves the nearest region in this group to the given location
- uint NearestRegions[index:lnavregionref object,Count,x,y,z]: Places the nearest (Count) regions in this group to the given location into the given index, sorted by distance, and retrieves the count of those regions
- uint RegionsWithin[index:lnavregionref object,Distance,x,y,z]: Places all regions in this group within a given Distance to the given location into the given index, sorted by distance, and retrieves the count of those regions
Methods
- Add[search]: Adds a specified region
- AddChildren[search]: Adds all children of a specified region
- AddDescendants[search]: Adds all descendants of a specified region
- Remove[search]: Removes a specified region
- Reset: Removes all regions from this group
- Intersect[group A,group B]: Adds A intersect B to this group. Parameters may be named group names, or lnavregiongroup objects. Group B may also be the FQN or ID of a region, to mean the set of all that region's descendants
- Union[group A,group B]: Adds A union B to this group. Parameters may be named group names, or lnavregiongroup objects. Group B may also be the FQN or ID of a region, to mean the set of all that region's descendants
- Not[group A,group B]: Adds A not B to this group. Parameters may be named group names, or lnavregiongroup objects. Group B may also be the FQN or ID of a region, to mean the set of all that region's descendants
- Minus[group A,group B]: Adds A minus B to this group. Parameters may be named group names, or lnavregiongroup objects. Group B may also be the FQN or ID of a region, to mean the set of all that region's descendants
- NotIntersect[group A,group B]: Adds A not intersect B to this group. Parameters may be named group names, or lnavregiongroup objects. Group B may also be the FQN or ID of a region, to mean the set of all that region's descendants
- Copy[group]: Copies the given group to this one (may be group name or a lnavregiongroup object)
- GetIterator[iterator object]: Initializes an iterator object for use with this region group
