Interface ICoordinateTransforms

Functions to transform positions between World, Screen and Window coordinates

Namespace: Yak2D

Assembly: Yak2D.Api.dll

Syntax

public interface ICoordinateTransforms

Methods

ScreenFromWindow(Vector2, UInt64, Nullable<UInt64>)

Converts a Window Position (Origin Top-Left) to a Camera's Screen Position

Declaration

TransformResult ScreenFromWindow(Vector2 position, ulong camera, ulong? viewport = null)

Parameters

Type	Name	Description
Vector2	position	Window Position To Transform (Origin Top-Left)
System.UInt64	camera	Camera id key through which the world is viewed
System.Nullable<System.UInt64>	viewport	The viewport id key which defines a camera's window area (default null is whole window)

Returns

Type	Description
TransformResult

ScreenFromWindow(Vector2, ICamera2D, IViewport)

Converts a Window Position (Origin Top-Left) to a Camera's Screen Position

Declaration

TransformResult ScreenFromWindow(Vector2 position, ICamera2D camera, IViewport viewport = null)

Parameters

Type	Name	Description
Vector2	position	Window Position To Transform (Origin Top-Left)
ICamera2D	camera	Camera through which the world is viewed
IViewport	viewport	The viewport which defines a camera's window area (default null is whole window)

Returns

Type	Description
TransformResult

ScreenFromWorld(Vector2, UInt64)

Converts a Camera's World position to it's Screen Position

Declaration

Vector2 ScreenFromWorld(Vector2 position, ulong camera)

Parameters

Type	Name	Description
Vector2	position	World Position To Transform
System.UInt64	camera	Camera id key through which the world is viewed

Returns

Type	Description
Vector2

ScreenFromWorld(Vector2, ICamera2D)

Converts a Camera's World position to it's Screen Position

Declaration

Vector2 ScreenFromWorld(Vector2 position, ICamera2D camera)

Parameters

Type	Name	Description
Vector2	position	World Position To Transform
ICamera2D	camera	Camera through which the world is viewed

Returns

Type	Description
Vector2

WindowFromScreen(Vector2, UInt64, Nullable<UInt64>)

Converts a Screen Position to a Window Position (Origin Top-Left)

Declaration

TransformResult WindowFromScreen(Vector2 position, ulong camera, ulong? viewport = null)

Parameters

Type	Name	Description
Vector2	position	Screen Position To Transform
System.UInt64	camera	Camera id key through which the world is viewed
System.Nullable<System.UInt64>	viewport	The viewport id key which defines a camera's window area (default null is whole window)

Returns

Type	Description
TransformResult

WindowFromScreen(Vector2, ICamera2D, IViewport)

Converts a Screen Position to a Window Position (Origin Top-Left)

Declaration

TransformResult WindowFromScreen(Vector2 position, ICamera2D camera, IViewport viewport = null)

Parameters

Type	Name	Description
Vector2	position	Screen Position To Transform
ICamera2D	camera	Camera through which the world is viewed
IViewport	viewport	The viewport which defines a camera's window area (default null is whole window)

Returns

Type	Description
TransformResult

WindowFromWorld(Vector2, UInt64, Nullable<UInt64>)

Converts a World Position to a Window Position (Origin Top-Left)

Declaration

TransformResult WindowFromWorld(Vector2 position, ulong camera, ulong? viewport = null)

Parameters

Type	Name	Description
Vector2	position	World Position To Transform
System.UInt64	camera	Camera through which the world is viewed
System.Nullable<System.UInt64>	viewport	The viewport which defines a camera's window area (default null is whole window)

Returns

Type	Description
TransformResult

WindowFromWorld(Vector2, ICamera2D, IViewport)

Converts a World Position to a Window Position (Origin Top-Left)

Declaration

TransformResult WindowFromWorld(Vector2 position, ICamera2D camera, IViewport viewport = null)

Parameters

Type	Name	Description
Vector2	position	World Position To Transform
ICamera2D	camera	Camera through which the world is viewed
IViewport	viewport	The viewport which defines a camera's window area (default null is whole window)

Returns

Type	Description
TransformResult

WorldFromScreen(Vector2, UInt64)

Converts a Camera's Screen position to it's World Position

Declaration

Vector2 WorldFromScreen(Vector2 position, ulong camera)

Parameters

Type	Name	Description
Vector2	position	Screen Position To Transform
System.UInt64	camera	Camera id key through which the world is viewed

Returns

Type	Description
Vector2

WorldFromScreen(Vector2, ICamera2D)

Converts a Camera's Screen position to it's World Position

Declaration

Vector2 WorldFromScreen(Vector2 position, ICamera2D camera)

Parameters

Type	Name	Description
Vector2	position	Screen Position To Transform
ICamera2D	camera	Camera through which the world is viewed

Returns

Type	Description
Vector2

WorldFromWindow(Vector2, UInt64, Nullable<UInt64>)

Converts a Window Position (Origin Top-Left) to a Camera's World Position

Declaration

TransformResult WorldFromWindow(Vector2 position, ulong camera, ulong? viewport = null)

Parameters

Type	Name	Description
Vector2	position	Window Position To Transform (Origin Top-Left)
System.UInt64	camera	Camera through which the world is viewed
System.Nullable<System.UInt64>	viewport	The viewport which defines a camera's window area (default null is whole window)

Returns

Type	Description
TransformResult

WorldFromWindow(Vector2, ICamera2D, IViewport)

Converts a Window Position (Origin Top-Left) to a Camera's World Position

Declaration

TransformResult WorldFromWindow(Vector2 position, ICamera2D camera, IViewport viewport = null)

Parameters

Type	Name	Description
Vector2	position	Window Position To Transform (Origin Top-Left)
ICamera2D	camera	Camera through which the world is viewed
IViewport	viewport	The viewport which defines a camera's window area (default null is whole window)

Returns

Type	Description
TransformResult