|
Checks whether one group belongs to enabled parts of another group.
(disabled parts are subgroups that are disabled. See STATE_group_disable() )
A NULL group_handle means the whole world
Return value: Returns YES or NO.
Note the following examples:
1) If groupA_handle==groupB_handle returns YES
2) If groupB_handle==NULL it will return YES only if groupA does not belong to a disabled group.
3) If groupA belongs to a disabled group that belongs to groupB then returns NO
Parameters:
groupA_handle, groupB_handle: checks wheter groupA belongs to groupB
Example:
check if a polygon belongs to a disabled group
DWORD my_group=STATE_polygon_get_group(my_polygon)
if(STATE_group_is_groupA_included_in_enabled_parts_of_groupB( my_group, NULL)==NO) {
my_group belongs to a disabled group !!!
}
See also STATE_group_is_groupA_included_in_groupB()
Version note:
In version 5.0 and before STATE_group_is_groupA_included_in_groupB() was identical to
STATE_group_is_groupA_included_in_enabled_parts_of_groupB(). In other words, in old version
there was only one function which behaved exactly as STATE_group_is_groupA_included_in_enabled_parts_of_groupB()
|