@novorender/api / ScreenSpaceConversions
Class: ScreenSpaceConversions
Defined in: @novorender/src/web_app/screen_space_conversions.ts:14
Constructors
Constructor
new ScreenSpaceConversions(drawContext): ScreenSpaceConversions;
Defined in: @novorender/src/web_app/screen_space_conversions.ts:15
Parameters
| Parameter | Type |
|---|---|
drawContext | DrawContext |
Returns
ScreenSpaceConversions
Methods
isInView()
isInView(point): boolean;
Defined in: @novorender/src/web_app/screen_space_conversions.ts:21
Check if world space point is inside the current view.
Parameters
| Parameter | Type | Description |
|---|---|---|
point | ReadonlyVec3 | World space point that will be checked. |
Returns
boolean
True if the point is inside the view false otherwise.
screenSpaceToWorldSpace()
screenSpaceToWorldSpace(points, drawContext): ReadonlyVec3[];
Defined in: @novorender/src/web_app/screen_space_conversions.ts:158
Convert 2D pixel point to 3D positions.
Parameters
| Parameter | Type | Description |
|---|---|---|
points | ReadonlyVec2[] | Screen points in points that will be projected to world space. |
drawContext | DrawContext | - |
Returns
ReadonlyVec3[]
Corresponding 3D positions at the view plane in world space.
worldSpaceToScreenSpace()
worldSpaceToScreenSpace(points, __namedParameters): (undefined | vec2)[];
Defined in: @novorender/src/web_app/screen_space_conversions.ts:92
Converts world space points to on screen space points.
Parameters
| Parameter | Type | Description |
|---|---|---|
points | ReadonlyVec3[] | World space points that will be projected to screen space. |
__namedParameters | { camera?: Camera; height?: number; round?: boolean; width?: number; } | - |
__namedParameters.camera? | Camera | - |
__namedParameters.height? | number | - |
__namedParameters.round? | boolean | - |
__namedParameters.width? | number | - |
Returns
(undefined | vec2)[]
Screen space points regadless if they are within the current canvas size or undefined if point is outside screen space.
worldSpaceToScreenSpaceConverter()
worldSpaceToScreenSpaceConverter(__namedParameters): (p) => undefined | vec2;
Defined in: @novorender/src/web_app/screen_space_conversions.ts:49
Makes a converter for world space points to on screen space points.
Function is correct only for the current settings/frame.
Same as worldSpaceToScreenSpace but returns a function, which is often more convenient.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | { camera?: Camera; height?: number; round?: boolean; width?: number; } |
__namedParameters.camera? | Camera |
__namedParameters.height? | number |
__namedParameters.round? | boolean |
__namedParameters.width? | number |
Returns
Function to convert points from screen to world space. Can return undefined if point is outside screen space.
(p): undefined | vec2;
Parameters
| Parameter | Type |
|---|---|
p | ReadonlyVec3 |
Returns
undefined | vec2
worldSpaceToViewSpace()
worldSpaceToViewSpace(points): ReadonlyVec2[];
Defined in: @novorender/src/web_app/screen_space_conversions.ts:135
Converts world space points to view space points.
Parameters
| Parameter | Type | Description |
|---|---|---|
points | ReadonlyVec3[] | World space points that will be projected to view space. |
Returns
ReadonlyVec2[]
View space points regadless if they are within the current canvas size. Coordinates are in [0, 1] range.
Properties
drawContext
readonly drawContext: DrawContext;
Defined in: @novorender/src/web_app/screen_space_conversions.ts:15