Table of Contents

Class ParameterSnapshot

Namespace
PluginUI
Assembly
PluginUI.dll

Values of a set of parameters captured at one moment, restored later as user edits (A/B comparison, undo points, "random" with revert…).

public sealed class ParameterSnapshot
Inheritance
ParameterSnapshot
Inherited Members

Properties

Count

Number of parameters captured.

public int Count { get; }

Property Value

int

Methods

Capture(IEnumerable<IParameter>)

Captures the current normalized values.

public static ParameterSnapshot Capture(IEnumerable<IParameter> parameters)

Parameters

parameters IEnumerable<IParameter>

The parameters.

Returns

ParameterSnapshot

The snapshot.

Exceptions

ArgumentNullException

parameters is null.

Restore()

Restores every value that differs, each as a complete edit gesture (recorded by the host).

public void Restore()

ValueOf(IParameter)

Normalized value captured for a parameter, or null if it is not part of the snapshot.

public double? ValueOf(IParameter parameter)

Parameters

parameter IParameter

A parameter.

Returns

double?

The captured value.