# Group#

(Group)

Go to User page.

## Description#

A simple group (list) of ProjectItem. Group are extremely useful and are often used to set rendering visibility. If you delete an item referenced in a group, it is automatically removed for you. Please note groups can be empty and that you can't group groups.

## Public Attributes#

Type Name Visual Hint Description
reference (SearchPath) search_paths VISUAL_HINT_DEFAULT Use the input object to retrieve search paths. If none then the current context is used.
reference input_context VISUAL_HINT_DEFAULT Specify the context for object lookup. Group will only be able to gather objects contained in that context.
long update_mode VISUAL_HINT_DEFAULT Specifies if the group reacts to changes to update its references ('Automatic'), or if it acts like a static cache of references ('Manual').
action refresh VISUAL_HINT_DEFAULT
string filter VISUAL_HINT_TAG Set the filter attribute to specify which class of objects the group can reference. If none is specified, group will behave as if ProjectItem was specified.
string inclusion_rule VISUAL_HINT_MULTILINE Rule filter which defines which objects to include in the group.
reference (ProjectItem) inclusion_items VISUAL_HINT_DEFAULT List of items to be referenced by the group.
string exclusion_rule VISUAL_HINT_MULTILINE Rule filter which defines which objects to exclude from the group.
reference (ProjectItem) exclusion_items VISUAL_HINT_DEFAULT List of items to be excluded from the group.
string result_filter VISUAL_HINT_MULTILINE Final exclusion step to remove additional items from the result.
reference (ProjectItem) references VISUAL_HINT_DEFAULT List of items that are currently referenced by the group, resulting from inclusion and exclusion setup parameters of the group.

## CID#

class "Group" "ProjectItem" {
#version 0.93
icon "../icons/object_icons/group.iconrc"
doc "A simple group (list) of ProjectItem. Group are extremely useful and are often used to set rendering visibility. If you delete an item referenced in a group, it is automatically removed for you. Please note groups can be empty and that you can\'t group groups."
attribute_group "settings" {
null_label "Use 3D Layer"
hidden yes
value ""
}
reference "search_paths" {
doc "Use the input object to retrieve search paths. If none then the current context is used."
filter "SearchPath"
value ""
}
reference "input_context" {
doc "Specify the context for object lookup. Group will only be able to gather objects contained in that context."
filter "Context"
value ""
}
long "update_mode" {
doc "Specifies if the group reacts to changes to update its references (\'Automatic\'), or if it acts like a static cache of references (\'Manual\')."
preset "Automatic" "0"
preset "Manual" "1"
value 0
}
action "refresh" {
value <empty>
}
list<tag> "filter" {
doc "Set the filter attribute to specify which class of objects the group can reference. If none is specified, group will behave as if ProjectItem was specified."
value "SceneItem" "Group"
}
list<tag> "exclusion_filter" {
doc "Specify which class of objects the group cannot reference. This allows to specify a base class in the filter, and some of its children in the exclusion filter instead of specifying all the classes supported in the filter (for example : all the geometries except volumes)."
private yes
hidden yes
value <empty>
}
list<reference> "dynamic_groups" {
doc "Hidden groups to be notified of changes within groups references with a rule"
private yes
hidden yes
saveable no
value <empty>
}
reference "parent" {
doc "If not null, the current group will be synchronized with this group and will just apply its filters on the result. It is hidden and used only for internal purposes."
filter "Group"
private yes
hidden yes
saveable no
value ""
}
}
attribute_group "inclusion" {
multiline "inclusion_rule" {
doc "Rule filter which defines which objects to include in the group."
dg_active no
value ""
}
list<reference> "inclusion_items" {
doc "List of items to be referenced by the group."
filter "ProjectItem"
dirtiness_pass_through yes
value <empty>
}
}
attribute_group "exclusion" {
multiline "exclusion_rule" {
doc "Rule filter which defines which objects to exclude from the group."
dg_active no
value ""
}
list<reference> "exclusion_items" {
doc "List of items to be excluded from the group."
filter "ProjectItem"
dirtiness_pass_through yes
value <empty>
}
}
attribute_group "result" {
multiline "result_filter" {
doc "Final exclusion step to remove additional items from the result."
dg_active no
value "*"
}
reference[] "objects" {
doc "Internal array of object references."
filter "ProjectItem"
output "none"
private yes
saveable no
dg_active no
value <empty>
}
list<reference> "references" {
doc "List of items that are currently referenced by the group, resulting from inclusion and exclusion setup parameters of the group."
filter "ProjectItem"
saveable no
dirtiness_pass_through yes