Class PreviewSession

Namespace

nadena.dev.ndmf.preview

TODO: Document

(For now, this isn't very useful; use DeclaringPass.PreviewingWith instead)

public class PreviewSession : IDisposable

Inheritance

object

PreviewSession

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PreviewSession()

public PreviewSession()

Properties

Current

The PreviewSession used for any cameras not overriden using OverrideCamera.

public static PreviewSession? Current { get; set; }

Property Value

PreviewSession

Methods

AddMutator(SequencePoint, IRenderFilter)

public IDisposable AddMutator(SequencePoint sequencePoint, IRenderFilter filter)

Parameters

sequencePoint SequencePoint

filter IRenderFilter

Returns

IDisposable

ClearCameraOverride(Camera)

Removes all camera overrides from the target camera.

public static void ClearCameraOverride(Camera target)

Parameters

target Camera

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

ForceRebuild()

public void ForceRebuild()

Fork(string)

Returns a new PreviewSession which inherits all mutators from the parent session. Any mutators added to this new session run after the parent session's mutators.

public PreviewSession Fork(string name = "Preview session")

Parameters

name string

Returns

PreviewSession

Exceptions

NotImplementedException

OverrideCamera(Camera)

Applies this PreviewSession to the target camera.

public void OverrideCamera(Camera target)

Parameters

target Camera

SetSequence(IEnumerable<SequencePoint>)

Sets the order in which mesh mutations are executed. Any sequence points not listed in this sequence will be executed after these registered points, in AddMutator invocation order.

public void SetSequence(IEnumerable<SequencePoint> sequencePoints)

Parameters

sequencePoints IEnumerable<SequencePoint>