unreal.ViewportGrid

class unreal.ViewportGrid(spacing_cm: float = 0.0, extent_cm: float = 0.0, height: float = 0.0)

Bases: StructBase

Grid parameters echoed back from an annotated viewport capture for round-tripping / reporting.

C++ Source:

  • Plugin: EditorToolset

  • Module: EditorToolset

  • File: EditorAppToolset.h

Editor Properties: (see get_editor_property/set_editor_property)

  • extent_cm (float): [Read-Write] How far the grid extends from the origin in each axis (cm).

  • height (float): [Read-Write] Height of the ground-plane grid in world space.

  • spacing_cm (float): [Read-Write] World-space distance between grid lines (cm). Zero if the grid was disabled.

property extent_cm: float

[Read-Only] How far the grid extends from the origin in each axis (cm).

Type:

(float)

property height: float

[Read-Only] Height of the ground-plane grid in world space.

Type:

(float)

property spacing_cm: float

[Read-Only] World-space distance between grid lines (cm). Zero if the grid was disabled.

Type:

(float)