Renderer options

RendererOptionsBase ¶

Bases: SettingsView

A renderer's options, as both a mapping and a typed object.

Subclasses [SettingsView][py_aep.models.renderqueue.settings.SettingsView] with itself as the owner, so one object satisfies both idioms.

Example

comp.renderer_options["Quality"] = 61     # mapping
comp.renderer_options.quality = 61        # typed, validated

The CompItem is held because Advanced 3D stores its Casting Box values as fractions of the composition's own pixel dimensions.

ClassicRendererOptions ¶

Bases: RendererOptionsBase

Options for the Classic 3D renderer.

Attributes¶

shadow_map_resolution ¶

shadow_map_resolution = enum(
    ShadowMapResolution, "_body", "shadow_map_resolution"
)

Resolution of the shadow map, as set in the Classic 3D Options dialog. Read / Write.

AdvancedRendererOptions ¶

Bases: RendererOptionsBase

Options for the Advanced 3D renderer.

Casting Box Size and Casting Box Center are stored as fractions of the composition's raw pixel dimensions - pixel aspect ratio is not applied - and are exposed here in the pixel values the Options dialog shows. Two things worth knowing:

Resizing a composition silently rescales these options in pixel terms, because the stored fraction does not move. That is After Effects' own behaviour.
Values that cross a save are stored as float32, so a pixel value read back after saving can differ from the one written by a tiny fraction of a pixel.

Attributes¶

casting_box_center ¶

casting_box_center: list[float]

Centre of the shadow casting box as [x, y, z] in pixels, as shown in the Options dialog. X and Y are offsets from the composition centre; Z is measured from zero. Read / Write.

casting_box_size ¶

casting_box_size: float

Size of the shadow casting box, in pixels, as shown in the Options dialog. One dialog control drives all three stored axes, so reads report the X axis. Read / Write.

quality ¶

quality = ChunkField[int](
    "_body", "quality", validate=validate_advanced_quality
)

Renderer quality, 1 to 125. Read / Write.

resolution ¶

resolution = enum(
    EnvironmentLightShadowResolution, "_body", "resolution"
)

Environment light shadow resolution. Read / Write.

smoothness ¶

smoothness = ChunkField[int](
    "_body",
    "smoothness",
    validate=validate_shadow_smoothness,
)

Environment light shadow smoothness, 1 to 20. Read / Write.

Cinema4DRendererOptions ¶

Bases: RendererOptionsBase

Options for the Cinema 4D renderer.

Attributes¶

quality ¶

quality = ChunkField[int](
    "_body", "quality", validate=validate_cinema_4d_quality
)

Renderer quality, 1 to 99. Read / Write.

RayTracedRendererOptions ¶

Bases: RendererOptionsBase

Options for the Ray-traced 3D renderer.

Deliberately empty. The renderer was removed in AE 2020 (17.0), so its Options dialog cannot be opened and its stored fields could never be matched to controls. Files using it parse and re-save byte-exact; there is nothing safe to expose. Read-only.