unreal.CompositeViewProjectionComponent

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

Bases: ActorComponent

Component responsible for continuously updating the specified material parameter collection with a camera view projection matrix (to be used for texture projection in materials).

C++ Source:

  • Plugin: Composite

  • Module: Composite

  • File: CompositeViewProjectionComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

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

  • asset_user_data_editor_only (Array[AssetUserData]): [Read-Write] Array of user data stored with the component

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

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

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

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

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

  • is_enabled (bool): [Read-Write] Whether or not the component activates the view-projection matrix Material Parameter Collection update.

  • material_parameter_collection (MaterialParameterCollection): [Read-Write] The Material Parameter Collection in which the view-projection matrix should be stored.

  • matrix_parameter_name (Name): [Read-Write] Parameter name of the first element of the transform in the Material Parameter Collection set above. Requires space for 4 vectors.

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

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

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

  • replicate_using_registered_sub_object_list (bool): [Read-Write] When true the replication system will only replicate the registered subobjects list When false the replication system will instead call the virtual ReplicateSubObjects() function where the subobjects need to be manually replicated.

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

  • target_camera_component (ComponentReference): [Read-Write] The CineCameraComponent whose view-projection matrix is used.

force_update() → None

Force update the Material Parameter Collection this frame.

property is_enabled: bool

[Read-Write] Whether or not the component activates the view-projection matrix Material Parameter Collection update.

Type:

(bool)

property material_parameter_collection: MaterialParameterCollection

[Read-Write] The Material Parameter Collection in which the view-projection matrix should be stored.

Type:

(MaterialParameterCollection)

property matrix_parameter_name: Name

[Read-Write] Parameter name of the first element of the transform in the Material Parameter Collection set above. Requires space for 4 vectors.

Type:

(Name)

property target_camera_component: ComponentReference

[Read-Write] The CineCameraComponent whose view-projection matrix is used.

Type:

(ComponentReference)