Class Viewport

Hierarchy

Viewport

Index

Constructors

Properties

canvas textRenderer

Accessors

Methods

ResizeToParent dispose getAspectRatio getParentSize getSize

Constructors

constructor

new Viewport(settings: Settings): Viewport
Constructs a new instance of the class with the provided settings.
Parameters
- settings: Settings
  
  The settings object defining viewer configurations.
Returns Viewport
- Defined in src/vim-webgl-viewer/viewport.ts:37

Properties

`Readonly` canvas

canvas: HTMLCanvasElement

HTML Canvas on which the model is rendered

`Readonly` textRenderer

textRenderer: CSS2DRenderer

HTML Element in which text is rendered

Accessors

onResize

get onResize(): ISignal
Signal dispatched when the canvas is resized.

Returns ISignal
- Defined in src/vim-webgl-viewer/viewport.ts:29

text

get text(): HTMLElement
Returns HTMLElement
- Defined in src/vim-webgl-viewer/viewport.ts:18

Methods

ResizeToParent

ResizeToParent(): void
Resizes the canvas and updates the camera to match new parent dimensions.

Returns void
- Defined in src/vim-webgl-viewer/viewport.ts:127

dispose

dispose(): void
Removes the canvas if it's owned by the viewer.

Returns void
- Defined in src/vim-webgl-viewer/viewport.ts:89

getAspectRatio

getAspectRatio(): number
Calculates and returns the aspect ratio of the parent element.

Returns
The aspect ratio (width divided by height) of the parent element.

Returns number
- Defined in src/vim-webgl-viewer/viewport.ts:119

getParentSize

getParentSize(): Vector2
Returns the pixel size of the parent element.

Returns
The pixel size of the parent element.

Returns Vector2
- Defined in src/vim-webgl-viewer/viewport.ts:100

getSize

getSize(): Vector2
Returns the pixel size of the canvas.

Returns
The pixel size of the canvas.

Returns Vector2
- Defined in src/vim-webgl-viewer/viewport.ts:111

Generated using TypeDoc