unreal.MovieGraphRenderPropertyModifier

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

Bases: MovieGraphCollectionModifier

Modifies actor visibility.

C++ Source:

  • Plugin: MovieRenderPipeline

  • Module: MovieRenderPipelineCore

  • File: MovieGraphRenderLayerSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • affect_indirect_lighting_while_hidden (bool): [Read-Write] Controls whether the primitive should affect indirect lighting when hidden.

  • cast_shadow_while_hidden (bool): [Read-Write] If true, the primitive will cast shadows even if it is hidden.

  • casts_shadows (bool): [Read-Write] If true, the primitive will cast shadows.

  • holdout (bool): [Read-Write] If true, the primitive will render black with an alpha of 0, but all secondary effects (shadows, reflections, indirect lighting) remain. This feature is currently only implemented in the Path Tracer.

  • is_hidden (bool): [Read-Write] If true, the actor will not be visible and will not contribute to any secondary effects (shadows, indirect lighting) unless their respective flags are set below.

  • override_b_affect_indirect_lighting_while_hidden (bool): [Read-Write]

  • override_b_cast_shadow_while_hidden (bool): [Read-Write]

  • override_b_casts_shadows (bool): [Read-Write]

  • override_b_holdout (bool): [Read-Write]

  • override_b_is_hidden (bool): [Read-Write]

property affect_indirect_lighting_while_hidden: bool

[Read-Write] Controls whether the primitive should affect indirect lighting when hidden.

Type:

(bool)

apply_modifier(world) → None

Apply Modifier

Parameters:

world (World) –

property cast_shadow_while_hidden: bool

[Read-Write] If true, the primitive will cast shadows even if it is hidden.

Type:

(bool)

property casts_shadows: bool

[Read-Write] If true, the primitive will cast shadows.

Type:

(bool)

property holdout: bool

[Read-Write] If true, the primitive will render black with an alpha of 0, but all secondary effects (shadows, reflections, indirect lighting) remain. This feature is currently only implemented in the Path Tracer.

Type:

(bool)

is_hidden() → bool

Is Hidden

Return type:

bool

property override_b_affect_indirect_lighting_while_hidden: bool

[Read-Write]

Type:

(bool)

property override_b_cast_shadow_while_hidden: bool

[Read-Write]

Type:

(bool)

property override_b_casts_shadows: bool

[Read-Write]

Type:

(bool)

property override_b_holdout: bool

[Read-Write]

Type:

(bool)

property override_b_is_hidden: bool

[Read-Write]

Type:

(bool)

set_hidden(is_hidden) → None

Set Hidden

Parameters:

is_hidden (bool) –

undo_modifier() → None

Undo Modifier