SceneAssemblyExtract#
(Extract)
- Category:
SceneAssembly
- Default object name:
extract
- Inherits from: ProjectItem
Description#
Provides single item selection from a collection.
Public Attributes#
Type | Name | Visual Hint | Description |
---|---|---|---|
reference |
input_context |
VISUAL_HINT_DEFAULT |
Input Context to extract the item from. |
bool |
hide_input_link |
VISUAL_HINT_DEFAULT |
When turned on, the link between Extract and its Input Context is hidden in Build View. |
action |
extract_rules |
VISUAL_HINT_DEFAULT |
Create a new Rule Set node out of this node. |
string |
filter |
VISUAL_HINT_TAG |
Specify the class (or type) of items for which the rule is evaluated. When no filter is specified, rule is applied to all items whatever their classes. |
string |
rules |
VISUAL_HINT_MULTILINE |
Define rules that target the resulting item. This field supports multiple rules. Rule evaluation stops as soon as a matching item is found. |
reference (RuleSet ) |
rule_set |
VISUAL_HINT_DEFAULT |
Define a Rule Set to use for rule resolution. |
long |
rule_set_mode |
VISUAL_HINT_DEFAULT |
When set to Override (default value), the node only evaluates rules defined in the input Rule Set. When set to Merge, the Rule Set is merged to the rules defined by the node. |
reference |
extracted_item |
VISUAL_HINT_DEFAULT |
Currently extracted item. |
CID#
class "SceneAssemblyExtract" "ProjectItem" {
#license {
flavor "advanced"
}
#version 0.9
icon "../icons/object_icons/scene_assembly_extract.iconrc"
category "SceneAssembly"
doc "Provides single item selection from a collection."
reference "input_context" {
doc "Input Context to extract the item from."
filter "Context"
value ""
}
bool "hide_input_link" {
doc "When turned on, the link between Extract and its Input Context is hidden in Build View."
value no
}
attribute_group "filtering" {
action "extract_rules" {
doc "Create a new Rule Set node out of this node."
value <empty>
}
list<tag> "filter" {
doc "Specify the class (or type) of items for which the rule is evaluated. When no filter is specified, rule is applied to all items whatever their classes."
value "ProjectItem"
}
multiline "rules" {
doc "Define rules that target the resulting item. This field supports multiple rules. Rule evaluation stops as soon as a matching item is found."
value "*"
}
reference "rule_set" {
doc "Define a Rule Set to use for rule resolution."
filter "RuleSet"
value ""
}
long "rule_set_mode" {
doc "When set to Override (default value), the node only evaluates rules defined in the input Rule Set. When set to Merge, the Rule Set is merged to the rules defined by the node."
preset "Override" "0"
preset "Merge" "1"
value 0
}
}
attribute_group "result" {
reference "extracted_item" {
doc "Currently extracted item."
saveable no
read_only yes
value ""
}
}
}