unreal.VCamComponent

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

Bases: unreal.SceneComponent

VCam Component

C++ Source:

  • Plugin: VirtualCamera

  • Module: VCamCore

  • File: VCamComponent.h

Editor Properties: (see get_editor_property/set_editor_property)

  • absolute_location (bool): [Read-Write] Absolute Location: If RelativeLocation should be considered relative to the world, rather than the parent

  • absolute_rotation (bool): [Read-Write] Absolute Rotation: If RelativeRotation should be considered relative to the world, rather than the parent

  • absolute_scale (bool): [Read-Write] Absolute Scale: If RelativeScale3D should be considered relative to the world, rather than the parent

  • 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.

  • detail_mode (DetailMode): [Read-Write] Detail Mode: If detail mode is >= system detail mode, primitive won’t be rendered.

  • disable_component_when_spawned_by_sequencer (bool): [Read-Write] Disable Component when Spawned by Sequencer: If true, the component will force bEnabled to false when it is part of a spawnable in Sequencer

  • disable_output_on_multi_user_receiver (bool): [Read-Write] Disable Output on Multi User Receiver: Do we disable the output if the virtual camera is in a Multi-user session and the camera is a “receiver” from multi-user

  • 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

  • enabled (bool): [Read-Write] Enabled: Enabled state of the component

  • hidden_in_game (bool): [Read-Write] Hidden in Game: Whether to hide the primitive in game, if the primitive is Visible.

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

  • live_link_subject (LiveLinkSubjectName): [Read-Write] Live Link Subject: LiveLink subject name for the incoming camera transform

  • lock_viewport_to_camera (bool): [Read-Write] Lock Viewport to Camera: If true, render the viewport from the point of view of the parented CineCamera

  • mobility (ComponentMobility): [Read-Write] Mobility: How often this component is allowed to move, used to make various optimizations. Only safe to set in constructor.

  • modifier_context (VCamModifierContext): [Read-Write] Modifier Context: Modifier Context object that can be accessed by the Modifier Stack

  • modifier_stack (Array(ModifierStackEntry)): [Read-Write] Modifier Stack: List of Modifiers (executed in order)

  • 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

  • on_component_replaced (OnComponentReplaced): [Read-Write] On Component Replaced: There are situations in the editor where the component may be replaced by another component as part of the actor being reconstructed This event will notify you of that change and give you a reference to the new component. Bindings will be copied to the new component so you do not need to rebind this event

    Note: When the component is replaced you will need to get all properties on the component again such as Modifiers and Output Providers

  • output_providers (Array(VCamOutputProviderBase)): [Read-Write] Output Providers: List of Output Providers (executed in order)

  • physics_volume_changed_delegate (PhysicsVolumeChanged): [Read-Write] Physics Volume Changed Delegate: Delegate that will be called when PhysicsVolume has been changed *

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

  • relative_location (Vector): [Read-Write] Relative Location: Location of the component relative to its parent

  • relative_rotation (Rotator): [Read-Write] Relative Rotation: Rotation of the component relative to its parent

  • relative_scale3d (Vector): [Read-Write] Relative Scale 3D: Non-uniform scaling of the component relative to its parent. Note that scaling is always applied in local space (no shearing etc)

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

  • role (GameplayTag): [Read-Write] Role: The role of this virtual camera. If this value is set and the corresponding tag set on the editor matches this value, then this camera is the sender and the authority in the case when connected to a multi-user session.

  • should_update_physics_volume (bool): [Read-Write] Should Update Physics Volume: Whether or not the cached PhysicsVolume this component overlaps should be updated when the component is moved. see: GetPhysicsVolume()

  • target_viewport (VCamTargetViewportID): [Read-Write] Target Viewport: Which viewport to use for this VCam

  • update_frequency_ms (float): [Read-Write] Update Frequency Ms: Indicates the frequency which camera updates are sent when in Multi-user mode. This has a minimum value of 30ms.

  • use_attach_parent_bound (bool): [Read-Write] Use Attach Parent Bound: If true, this component uses its parents bounds when attached. This can be a significant optimization with many components attached together.

  • visible (bool): [Read-Write] Visible: Whether to completely draw the primitive; if false, the primitive is not drawn, does not cast a shadow.

add_modifier(name, modifier_class) → VCamModifier or None

Add a modifier to the stack with a given name. If that name is already in use then the modifier will not be added. Returns the created modifier if the Add succeeded

Parameters
Returns

created_modifier (VCamModifier):

Return type

VCamModifier or None

add_output_provider(provider_class) → VCamOutputProviderBase or None

Output Provider access

Parameters

provider_class (type(Class)) –

Returns

created_provider (VCamOutputProviderBase):

Return type

VCamOutputProviderBase or None

property disable_component_when_spawned_by_sequencer

[Read-Write] Disable Component when Spawned by Sequencer: If true, the component will force bEnabled to false when it is part of a spawnable in Sequencer

Type

(bool)

property disable_output_on_multi_user_receiver

[Read-Write] Disable Output on Multi User Receiver: Do we disable the output if the virtual camera is in a Multi-user session and the camera is a “receiver” from multi-user

Type

(bool)

property enabled

[Read-Write] Enabled: Enabled state of the component

Type

(bool)

get_all_modifiers()

Returns all the Modifiers in the Component’s Stack Note: It’s possible not all Modifiers will be valid (such as if the user has not set a class for the modifier in the details panel)

Returns

modifiers (Array(VCamModifier)):

Return type

Array(VCamModifier)

get_all_output_providers()

Get All Output Providers

Returns

providers (Array(VCamOutputProviderBase)):

Return type

Array(VCamOutputProviderBase)

Get Live Link Data for Current Frame

Returns

live_link_data (LiveLinkCameraBlueprintData):

Return type

LiveLinkCameraBlueprintData

get_modifier_by_index(index) → VCamModifier

Returns the Modifier in the Stack with the given index if it exist.

Parameters

index (int32) –

Return type

VCamModifier

get_modifier_by_name(name) → VCamModifier

Tries to find a Modifier in the Stack with the given name. The returned Modifier must be checked before it is used.

Parameters

name (Name) –

Return type

VCamModifier

get_modifier_context() → VCamModifierContext

Get the current Modifier Context

Returns

Current Context

Return type

VCamModifierContext

get_modifiers_by_class(modifier_class)

Given a specific Modifier class, returns a list of matching Modifiers

Parameters

modifier_class (type(Class)) –

Returns

found_modifiers (Array(VCamModifier)):

Return type

Array(VCamModifier)

get_modifiers_by_interface(interface_class)

Given a specific Interface class, returns a list of matching Modifiers

Parameters

interface_class (type(Class)) –

Returns

found_modifiers (Array(VCamModifier)):

Return type

Array(VCamModifier)

get_number_of_modifiers() → int32

Returns the number of Modifiers in the Component’s Stack

Return type

int32

get_number_of_output_providers() → int32

Get Number Of Output Providers

Return type

int32

get_output_provider_by_index(provider_index) → VCamOutputProviderBase

Get Output Provider by Index

Parameters

provider_index (int32) –

Return type

VCamOutputProviderBase

get_output_providers_by_class(provider_class)

Get Output Providers by Class

Parameters

provider_class (type(Class)) –

Returns

found_providers (Array(VCamOutputProviderBase)):

Return type

Array(VCamOutputProviderBase)

get_target_camera() → CineCameraComponent

Returns the Target CineCameraComponent

Return type

CineCameraComponent

insert_modifier(name, index, modifier_class) → VCamModifier or None

Insert a modifier to the stack with a given name and index. If that name is already in use then the modifier will not be added. The index must be between zero and the number of existing modifiers inclusive Returns the created modifier if the Add succeeded

Parameters

  • name (Name) –

  • index (int32) –

  • modifier_class (type(Class)) –

Returns

created_modifier (VCamModifier):

Return type

VCamModifier or None

insert_output_provider(index, provider_class) → VCamOutputProviderBase or None

Insert Output Provider

Parameters

  • index (int32) –

  • provider_class (type(Class)) –

Returns

created_provider (VCamOutputProviderBase):

Return type

VCamOutputProviderBase or None

[Read-Write] Live Link Subject: LiveLink subject name for the incoming camera transform

Type

(LiveLinkSubjectName)

property lock_viewport_to_camera

[Read-Write] Lock Viewport to Camera: If true, render the viewport from the point of view of the parented CineCamera

Type

(bool)

property on_component_replaced

[Read-Write] On Component Replaced: There are situations in the editor where the component may be replaced by another component as part of the actor being reconstructed This event will notify you of that change and give you a reference to the new component. Bindings will be copied to the new component so you do not need to rebind this event

Note: When the component is replaced you will need to get all properties on the component again such as Modifiers and Output Providers

Type

(OnComponentReplaced)

remove_all_modifiers() → None

Remove all Modifiers from the Stack.

remove_all_output_providers() → None

Remove all Output Providers from the Component.

remove_modifier(modifier) → bool

Remove the given Modifier from the Stack. Returns true if the modifier was removed successfully

Parameters

modifier (VCamModifier) –

Return type

bool

remove_modifier_by_index(modifier_index) → bool

Remove the Modifier at a specified index from the Stack. Returns true if the modifier was removed successfully

Parameters

modifier_index (int32) –

Return type

bool

remove_modifier_by_name(name) → bool

Remove the Modifier with a specific name from the Stack. Returns true if the modifier was removed successfully

Parameters

name (Name) –

Return type

bool

remove_output_provider(provider) → bool

Remove Output Provider

Parameters

provider (VCamOutputProviderBase) –

Return type

bool

remove_output_provider_by_index(provider_index) → bool

Remove Output Provider by Index

Parameters

provider_index (int32) –

Return type

bool

property role

[Read-Write] Role: The role of this virtual camera. If this value is set and the corresponding tag set on the editor matches this value, then this camera is the sender and the authority in the case when connected to a multi-user session.

Type

(GameplayTag)

set_modifier_context_class(context_class) → VCamModifierContext

Sets the Modifier Context to a new instance of the provided class

Parameters

context_class (type(Class)) – The Class to create the context from

Returns

created_context (VCamModifierContext): The created Context, can be invalid if Context Class was None

Return type

VCamModifierContext

set_modifier_index(original_index, new_index) → bool

Moves an existing modifier in the stack from its current index to a new index

Parameters

  • original_index (int32) –

  • new_index (int32) –

Return type

bool

set_output_provider_index(original_index, new_index) → bool

Moves an existing Output Provider in the stack from its current index to a new index

Parameters

  • original_index (int32) –

  • new_index (int32) –

Return type

bool

property target_viewport

[Read-Write] Target Viewport: Which viewport to use for this VCam

Type

(VCamTargetViewportID)