Skip to main content

VisualizationOverlay

rustial_engine::visualization

Enum VisualizationOverlay

pub enum VisualizationOverlay {
    GridScalar {
        layer_id: LayerId,
        grid: GeoGrid,
        field: ScalarField2D,
        ramp: ColorRamp,
    },
    GridExtrusion {
        layer_id: LayerId,
        grid: GeoGrid,
        field: ScalarField2D,
        ramp: ColorRamp,
        params: ExtrusionParams,
    },
    Columns {
        layer_id: LayerId,
        columns: ColumnInstanceSet,
        ramp: ColorRamp,
    },
    Points {
        layer_id: LayerId,
        points: PointInstanceSet,
        ramp: ColorRamp,
    },
}

Expand description

A single visualization overlay collected from the layer stack during MapState::update_with_dt.

Renderers read these from [FrameOutput::visualization] alongside terrain, vectors, and models.

Variants§

GridScalar

Flat georeferenced colour grid.

Fields

§layer_id: LayerId

Layer identity.

§grid: GeoGrid

Grid geometry.

§field: ScalarField2D

Scalar values.

§ramp: ColorRamp

Colour transfer function.

GridExtrusion

Extruded georeferenced grid.

Fields

§layer_id: LayerId

Layer identity.

§grid: GeoGrid

Grid geometry.

§field: ScalarField2D

Scalar values driving extrusion height.

§ramp: ColorRamp

Colour transfer function.

§params: ExtrusionParams

Extrusion parameters.

Columns

Instanced columns.

Fields

§layer_id: LayerId

Layer identity.

§columns: ColumnInstanceSet

Column instances.

§ramp: ColorRamp

Colour transfer function (fallback for columns without per-instance colour).

Points

Point-cloud / scatter instances.

Fields

§layer_id: LayerId

Layer identity.

§points: PointInstanceSet

Point instances.

§ramp: ColorRamp

Colour transfer function (fallback for points without per-instance colour).

Trait Implementations§

impl Clone for VisualizationOverlay

fn clone(&self) -> VisualizationOverlay

Returns a duplicate of the value. Read more

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for VisualizationOverlay

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for VisualizationOverlay

impl RefUnwindSafe for VisualizationOverlay

impl Send for VisualizationOverlay

impl Sync for VisualizationOverlay

impl Unpin for VisualizationOverlay

impl UnsafeUnpin for VisualizationOverlay

impl UnwindSafe for VisualizationOverlay

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.