Struct PageTurnSnapshot

Namespace

PageCurl.Core

Assembly

PageCurl.Core.dll

A read-only snapshot of the page turn controller.

public readonly struct PageTurnSnapshot : IEquatable<PageTurnSnapshot>

Implements

IEquatable<PageTurnSnapshot>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

PageTurnSnapshot(PageTurnState, PageTurnDirection, Vector2, Vector2, float, float)

A read-only snapshot of the page turn controller.

public PageTurnSnapshot(PageTurnState State, PageTurnDirection Direction, Vector2 DragStartPosition, Vector2 PointerPosition, float Progress, float TargetProgress)

Parameters

State PageTurnState

Direction PageTurnDirection

DragStartPosition Vector2

PointerPosition Vector2

Progress float

TargetProgress float

Properties

Direction

public PageTurnDirection Direction { get; init; }

Property Value

PageTurnDirection

DragStartPosition

public Vector2 DragStartPosition { get; init; }

Property Value

Vector2

FreeEdge

The physical edge or corner the user is pulling from.

public PageEdge FreeEdge { get; init; }

Property Value

PageEdge

HingeEdge

The physical edge currently acting as the stationary hinge.

public PageEdge HingeEdge { get; init; }

Property Value

PageEdge

LockedAnchor

The edge or corner that remains stationary during the turn.

public PageAnchor LockedAnchor { get; init; }

Property Value

PageAnchor

PointerPosition

public Vector2 PointerPosition { get; init; }

Property Value

Vector2

Progress

public float Progress { get; init; }

Property Value

float

State

public PageTurnState State { get; init; }

Property Value

PageTurnState

TargetProgress

public float TargetProgress { get; init; }

Property Value

float

Methods

Deconstruct(out PageTurnState, out PageTurnDirection, out Vector2, out Vector2, out float, out float)

public void Deconstruct(out PageTurnState State, out PageTurnDirection Direction, out Vector2 DragStartPosition, out Vector2 PointerPosition, out float Progress, out float TargetProgress)

Parameters

State PageTurnState

Direction PageTurnDirection

DragStartPosition Vector2

PointerPosition Vector2

Progress float

TargetProgress float

Equals(PageTurnSnapshot)

public bool Equals(PageTurnSnapshot other)

Parameters

other PageTurnSnapshot

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(PageTurnSnapshot, PageTurnSnapshot)

public static bool operator ==(PageTurnSnapshot left, PageTurnSnapshot right)

Parameters

left PageTurnSnapshot

right PageTurnSnapshot

Returns

bool

operator !=(PageTurnSnapshot, PageTurnSnapshot)

public static bool operator !=(PageTurnSnapshot left, PageTurnSnapshot right)

Parameters

left PageTurnSnapshot

right PageTurnSnapshot

Returns

bool