unreal.ComputeGraphComponent

class unreal.ComputeGraphComponent(outer=None, name='None')

Bases: unreal.ActorComponent

Component which holds a context for a UComputeGraph. This object binds the graph to its data providers, and queues the execution.

C++ Source:

  • Plugin: ComputeFramework

  • Module: ComputeFramework

  • File: ComputeGraphComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array(AssetUserData)): [Read-Write] Asset User Data: Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigation

  • component_tags (Array(Name)): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • compute_graph (ComputeGraph): [Read-Write] Compute Graph: The Compute Graph asset.

  • editable_when_inherited (bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor class

  • is_editor_only (bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor builds

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivated

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Component

  • replicates (bool): [Read-Write] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

property compute_graph

[Read-Write] Compute Graph: The Compute Graph asset.

Type

(ComputeGraph)

create_data_providers(set_default_bindings) → None

Create the Data Provider objects for the current ComputeGraph.

Parameters

set_default_bindings (bool) – Attempt to automate setup of the Data Provider objects based on the current Actor.

destroy_data_providers() → None

Destroy all associated DataProvider objects.

queue_execute() → None

Queue the graph for execution at the next render update.