unreal.ModifierHierarchyAsset

class unreal.ModifierHierarchyAsset(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

An asset intended to be referenced by Slate widgets.

Defines a tree hierarchy. Nodes are called groups. A group consists of modifiers and (sub) groups.

An example use case is if you want to have a button menu which should procedurally generate sub-button menus depending on the modifiers in the component. One group could be a Lens group which groups together modifiers that e.g. modify focal distance, filmback, and FOV. The rules are defined generically enough so as modifiers are added or removed, the groupings also update accordingly.

C++ Source:

  • Plugin: VirtualCamera

  • Module: VCamExtensions

  • File: ModifierHierarchyAsset.h

Editor Properties: (see get_editor_property/set_editor_property)

  • rules (ModifierHierarchyRules): [Read-Write]

get_child_nodes(parent_group) → Set[Name]

Gets the child groups of the given group.

Parameters:

parent_group (Name) –

Return type:

Set[Name]

get_connection_point_target_for_node(group_name, component) → VCamModifierConnectionBinding or None

Gets the connection point the modifier is configured to be bound to. This function is optional to implement; it is valid for it to always return false.

Parameters:
Returns:

connection (VCamModifierConnectionBinding):

Return type:

VCamModifierConnectionBinding or None

get_groups_containing_modifier(modifier) → Set[Name]

Utility function to get all groups which contain this modifier.

Parameters:

modifier (VCamModifier) –

Return type:

Set[Name]

get_modifier_in_node(component, group_name) → VCamModifier

Gets all the modifiers on the component that belong in the given group.

Parameters:
Return type:

VCamModifier

get_parent_node(child_node) → Name or None

Gets the parent of this given group. Fails if called on the root node.

Parameters:

child_node (Name) –

Returns:

parent_node (Name):

Return type:

Name or None

get_root_node() → Name

Gets the root of the tree.

Return type:

Name

property rules: ModifierHierarchyRules

[Read-Only]

Type:

(ModifierHierarchyRules)