Difference between revisions of "LavishNav:lnavregiongroup (Object Type)"
Jump to navigation
Jump to search
| Line 1: | Line 1: | ||
== Description == | == Description == | ||
| + | {{ObjectType-Vitals|lnavregiongroup|[[LavishNav]]|none|NULL|[[LavishNav:lnavregiongroup (Object Type)|lnavregiongroup]]|no|LNavRegionGroup *}} | ||
== Members == | == Members == | ||
*[[DataType:bool|bool]] '''Contains['''search''']''': TRUE if the specified region is present in this group | *[[DataType:bool|bool]] '''Contains['''search''']''': TRUE if the specified region is present in this group | ||
| + | NearestRegions: | ||
| + | RegionsWithin: | ||
== Methods == | == Methods == | ||
| Line 9: | Line 12: | ||
*'''AddDescendants['''search''']''': Adds all descendants of a specified region | *'''AddDescendants['''search''']''': Adds all descendants of a specified region | ||
*'''Remove['''search''']''': Removes 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 | *'''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 | *'''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 | ||
| Line 15: | Line 18: | ||
*'''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 | *'''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 | *'''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 | |
| − | * ''' | ||
| − | * ''' | ||
| − | |||
| − | |||
== Examples == | == Examples == | ||
Revision as of 20:15, 24 March 2006
Contents
Description
| lnavregiongroup | |
| Defined By | LavishNav |
| Inherits | none |
| Reduces To | NULL |
| Variable Object Type | lnavregiongroup |
| Uses Sub-Types | no |
| C/C++ Type | LNavRegionGroup * |
Members
- bool Contains[search]: TRUE if the specified region is present in this group
NearestRegions: RegionsWithin:
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
