s&box docs
API ReferenceSandbox.MovieMaker

MovieTimeclass

Represents a duration of time in a movie. Uses fixed point so precision is consistent at any absolute time. Defaults to `Sandbox.MovieMaker.MovieTime.Zero`.

object→MovieTime
Namespace
Sandbox.MovieMaker
Assembly
Sandbox.Engine
Declaration
public sealed struct Sandbox.MovieMaker.MovieTime

Methods17

Showing 17 methods

public virtual sealed int CompareTo(Sandbox.MovieMaker.MovieTime other)PUBLICVIRTUAL

ParameterTypeDescription
otherMovieTime—
Returns:int—

public static Sandbox.MovieMaker.MovieTime FromFrames(int frameCount, int frameRate)PUBLICSTATIC

ParameterTypeDescription
frameCountint—
frameRateint—
Returns:MovieTime—

public static Sandbox.MovieMaker.MovieTime FromSeconds(double time)PUBLICSTATIC

ParameterTypeDescription
timedouble—
Returns:MovieTime—

public static Sandbox.MovieMaker.MovieTime FromTicks(int ticks)PUBLICSTATIC

ParameterTypeDescription
ticksint—
Returns:MovieTime—

public float GetFraction(Sandbox.MovieMaker.MovieTime time)PUBLIC

ParameterTypeDescription
timeMovieTime—
Returns:float—

public int GetFrameCount(int frameRate)PUBLIC

Given a `frameRate`, how many frames would need to be allocated to represent every moment of time up until now. This is always at least `1`, and will be `1` more than `Sandbox.MovieMaker.MovieTime.GetFrameIndex(System.Int32)` unless this time is exactly on a frame boundary.

ParameterTypeDescription
frameRateint—
Returns:int—

Properties11

Showing 11 properties

public bool Sandbox.MovieMaker.MovieTime.IsNegative { get; set; }PUBLICGETSET

Returns:bool—

public bool Sandbox.MovieMaker.MovieTime.IsPositive { get; set; }PUBLICGETSET

Returns:bool—

public bool Sandbox.MovieMaker.MovieTime.IsZero { get; set; }PUBLICGETSET

Returns:bool—

public static System.Collections.Generic.IReadOnlyList`1<int> Sandbox.MovieMaker.MovieTime.SupportedFrameRates { get; set; }PUBLICSTATICGETSET

Frame rates `<= 120` that can be perfectly represented by `Sandbox.MovieMaker.MovieTime.TickRate`, in ascending order. Venturing outside these rates will lead to some frames being slightly different durations than others.

Returns:IReadOnlyList<int>—

public int Sandbox.MovieMaker.MovieTime.Ticks { get; set; }PUBLICGETSET

Returns:int—

public double Sandbox.MovieMaker.MovieTime.TotalSeconds { get; set; }PUBLICGETSET

Returns:double—

StateHasChanged()

Previous Page

Absolute

Next Page

On this page

Methodspublic Sandbox.MovieMaker.MovieTime Clamp(System.Nullable`1<Sandbox.MovieMaker.MovieTimeRange> range)public virtual sealed System.Int32 CompareTo(Sandbox.MovieMaker.MovieTime other)public static Sandbox.MovieMaker.MovieTime Distance(Sandbox.MovieMaker.MovieTime a, Sandbox.MovieMaker.MovieTime b)public Sandbox.MovieMaker.MovieTime Floor(Sandbox.MovieMaker.MovieTime gridInterval)public static Sandbox.MovieMaker.MovieTime FromFrames(System.Int32 frameCount, System.Int32 frameRate)public static Sandbox.MovieMaker.MovieTime FromSeconds(System.Double time)public static Sandbox.MovieMaker.MovieTime FromTicks(System.Int32 ticks)public System.Single GetFraction(Sandbox.MovieMaker.MovieTime time)public System.Int32 GetFrameCount(System.Int32 frameRate)public System.Int32 GetFrameIndex(Sandbox.MovieMaker.MovieTime frameInterval, Sandbox.MovieMaker.MovieTime remainder)public System.Int32 GetFrameIndex(Sandbox.MovieMaker.MovieTime frameInterval)public System.Int32 GetFrameIndex(System.Int32 frameRate, Sandbox.MovieMaker.MovieTime remainder)public System.Int32 GetFrameIndex(System.Int32 frameRate)public static Sandbox.MovieMaker.MovieTime Lerp(Sandbox.MovieMaker.MovieTime a, Sandbox.MovieMaker.MovieTime b, System.Double fraction)public static Sandbox.MovieMaker.MovieTime Max(Sandbox.MovieMaker.MovieTime a, Sandbox.MovieMaker.MovieTime b)public static Sandbox.MovieMaker.MovieTime Min(Sandbox.MovieMaker.MovieTime a, Sandbox.MovieMaker.MovieTime b)public Sandbox.MovieMaker.MovieTime Round(Sandbox.MovieMaker.MovieTime gridInterval)Propertiespublic Sandbox.MovieMaker.MovieTime Sandbox.MovieMaker.MovieTime.Absolute { get; set; }public static Sandbox.MovieMaker.MovieTime Sandbox.MovieMaker.MovieTime.Epsilon { get; set; }public System.Boolean Sandbox.MovieMaker.MovieTime.IsNegative { get; set; }public System.Boolean Sandbox.MovieMaker.MovieTime.IsPositive { get; set; }public System.Boolean Sandbox.MovieMaker.MovieTime.IsZero { get; set; }public static Sandbox.MovieMaker.MovieTime Sandbox.MovieMaker.MovieTime.MaxValue { get; set; }public static Sandbox.MovieMaker.MovieTime Sandbox.MovieMaker.MovieTime.MinValue { get; set; }public static System.Collections.Generic.IReadOnlyList`1<System.Int32> Sandbox.MovieMaker.MovieTime.SupportedFrameRates { get; set; }public System.Int32 Sandbox.MovieMaker.MovieTime.Ticks { get; set; }public System.Double Sandbox.MovieMaker.MovieTime.TotalSeconds { get; set; }public static Sandbox.MovieMaker.MovieTime Sandbox.MovieMaker.MovieTime.Zero { get; set; }Metadata