Navigation
API > API/Plugins > API/Plugins/VCamExtensions > API/Plugins/VCamExtensions/Hierarchies
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UModifierHierarchyRules
- UTargetModifierPerNodeHierarchyRules
References
| Module | VCamExtensions |
| Header | /Engine/Plugins/VirtualProduction/VirtualCamera/Source/VCamExtensions/Public/Hierarchies/ModifierHierarchyRules.h |
| Include | #include "Hierarchies/ModifierHierarchyRules.h" |
Syntax
UCLASS (Abstract, Blueprintable, EditInlineNew)
class UModifierHierarchyRules : public UObject
Remarks
Defines a tree hierarchy. Each node is called a group. A group consists of connections and (sub) groups. A connection is a modifier and a corresponding connection point.
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.
Functions
| Type | Name | Description | |
|---|---|---|---|
     |
TSet< FName > | GetChildNodes
(
FName Node |
Gets the child groups of the given group. |
     |
bool | GetConnectionPointTargetForNode
(
FName GroupName, |
Gets the connection point the modifier is configured to be bound to, if any. |
     |
UVCamModifier * | GetModifierInNode
(
UVCamComponent* Component, |
Gets all the modifiers on the component that belong in the given group. |
     |
TSet< FName > | GetNodesContainingModifier
(
UVCamModifier* Modifier |
Utility function to get all groups which contain this modifier. |
     |
bool | GetParentNode
(
FName ChildNode, |
Gets the parent of this given group. Fails if called on the root node. |
     |
FName | GetRootNode () |
Gets the root of the tree. |