This class defines WebAssembly window (HTML5 canvas) intended for creation of OpenGL (WebGL) context. More...

#include <Wasm_Window.hxx>

Inheritance diagram for Wasm_Window:

[legend]

Public Member Functions
	Wasm_Window (const TCollection_AsciiString &theCanvasId, const bool theToScaleBacking=true)
	Wraps existing HTML5 canvas into window.

virtual	~Wasm_Window ()
	Destroys the window.

virtual Standard_Boolean	IsMapped () const override
	Return true if window is not hidden.

virtual void	Map () const override
	Change window mapped flag to TRUE.

virtual void	Unmap () const override
	Change window mapped flag to FALSE.

virtual Aspect_TypeOfResize	DoResize () override
	Resize window. In case of ToScaleBacking flag, this method will resize the backing store of canvas basing on DevicePixelRatio() scale factor and CSS canvas size.

virtual Standard_Boolean	DoMapping () const override
	Apply the mapping change to the window.

virtual Standard_Real	Ratio () const override
	Returns window ratio equal to the physical width/height dimensions.

virtual void	Position (Standard_Integer &theX1, Standard_Integer &theY1, Standard_Integer &theX2, Standard_Integer &theY2) const override
	Returns The Window POSITION in PIXEL.

virtual void	Size (Standard_Integer &theWidth, Standard_Integer &theHeight) const override
	Return the window size in pixels.

void	SetSizeLogical (const Graphic3d_Vec2d &theSize)
	Set new window size in logical (density-independent units). Backing store will be resized basing on DevicePixelRatio().

void	SetSizeBacking (const Graphic3d_Vec2i &theSize)
	Set new window size in pixels. Logical size of the element will be resized basing on DevicePixelRatio().

const TCollection_AsciiString &	CanvasId () const
	Returns canvas id.

virtual Aspect_Drawable	NativeHandle () const override
	Current EGL implementation in Emscripten accepts only 0 for native window id.

virtual Aspect_Drawable	NativeParentHandle () const override
	Always returns 0 for this class.

virtual Aspect_FBConfig	NativeFBConfig () const override
	Always returns 0 for this class.

virtual Standard_Real	DevicePixelRatio () const override
	Return device pixel ratio (logical to backing store scale factor).

void	SetDevicePixelRatio (Standard_Real theDevicePixelRatio)
	Sets device pixel ratio for a window with IsVirtual() flag.

virtual void	InvalidateContent (const Handle< Aspect_DisplayConnection > &theDisp) override
	Invalidate entire window content through generation of Expose event.

virtual bool	ProcessMessage (Aspect_WindowInputListener &theListener, int theEventType, const void *theEvent)
	Process a single window message.

virtual bool	ProcessMouseEvent (Aspect_WindowInputListener &theListener, int theEventType, const EmscriptenMouseEvent *theEvent)
	Process a mouse input message.

virtual bool	ProcessWheelEvent (Aspect_WindowInputListener &theListener, int theEventType, const EmscriptenWheelEvent *theEvent)
	Process a (mouse) wheel input message.

virtual bool	ProcessTouchEvent (Aspect_WindowInputListener &theListener, int theEventType, const EmscriptenTouchEvent *theEvent)
	Process a mouse input message.

virtual bool	ProcessKeyEvent (Aspect_WindowInputListener &theListener, int theEventType, const EmscriptenKeyboardEvent *theEvent)
	Process a keyboard input message.

virtual bool	ProcessUiEvent (Aspect_WindowInputListener &theListener, int theEventType, const EmscriptenUiEvent *theEvent)
	Process a UI input message (like window resize).

virtual bool	ProcessFocusEvent (Aspect_WindowInputListener &theListener, int theEventType, const EmscriptenFocusEvent *theEvent)
	Process a focus input change message.

Public Member Functions inherited from Aspect_Window
Standard_Boolean	IsVirtual () const
	Returns True if the window <me> is virtual.

void	SetVirtual (const Standard_Boolean theVirtual)
	Setup the virtual state.

Graphic3d_Vec2i	TopLeft () const
	Returns window top-left corner.

Graphic3d_Vec2i	Dimensions () const
	Returns window dimensions.

const Handle< Aspect_DisplayConnection > &	DisplayConnection () const
	Returns connection to Display or NULL.

Aspect_Background	Background () const
	Returns the window background.

Aspect_FillMethod	BackgroundFillMethod () const
	Returns the current image background fill mode.

Aspect_GradientBackground	GradientBackground () const
	Returns the window gradient background.

void	SetBackground (const Aspect_Background &theBack)
	Modifies the window background.

void	SetBackground (const Quantity_Color &theColor)
	Modifies the window background.

void	SetBackground (const Aspect_GradientBackground &theBackground)
	Modifies the window gradient background.

void	SetBackground (const Quantity_Color &theFirstColor, const Quantity_Color &theSecondColor, const Aspect_GradientFillMethod theFillMethod)
	Modifies the window gradient background.

virtual void	SetTitle (const TCollection_AsciiString &theTitle)
	Sets window title.

virtual Graphic3d_Vec2d	ConvertPointToBacking (const Graphic3d_Vec2d &thePnt) const
	Convert point from logical units into backing store units.

virtual Graphic3d_Vec2d	ConvertPointFromBacking (const Graphic3d_Vec2d &thePnt) const
	Convert point from backing store units to logical units.

void	DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const
	Dumps the content of me into the stream.

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Static Public Member Functions
static Aspect_VKeyMouse	MouseButtonsFromNative (unsigned short theButtons)
	Convert Emscripten mouse buttons into Aspect_VKeyMouse.

static Aspect_VKey	VirtualKeyFromNative (Standard_Integer theKey)
	Convert DOM virtual key into Aspect_VKey.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Protected Attributes
TCollection_AsciiString	myCanvasId

Graphic3d_Vec2i	mySize

Standard_Real	myDevicePixelRatio

Standard_Boolean	myToScaleBacking

Standard_Boolean	myIsMapped

Protected Attributes inherited from Aspect_Window
Handle< Aspect_DisplayConnection >	myDisplay
	Display connection.

Aspect_Background	MyBackground

Aspect_GradientBackground	MyGradientBackground

Aspect_FillMethod	MyBackgroundFillMethod

Standard_Boolean	MyIsVirtual

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Protected Member Functions inherited from Aspect_Window
	Aspect_Window ()
	Initializes the data of a Window.

Detailed Description

This class defines WebAssembly window (HTML5 canvas) intended for creation of OpenGL (WebGL) context.

Note that canvas may define an independent dimensions for backing store (WebGL buffer to render) and for CSS (logical units to present buffer onto screen). These dimensions differ when browser is dragged into a high pixel density screen (HiDPI), or when user scales page in the browser (in both cases window.devicePixelRatio JavaScript property becomes not equal to 1.0).

By default, Wasm_Window::DoResize() will scale backing store of a canvas basing on DevicePixelRatio() scale factor to ensure canvas content being rendered with the native resolution and not stretched by browser. This, however, might have side effects:

a slow GPU might experience performance issues on drawing into larger buffer (e.g. HiDPI);
user interface displayed in 3D Viewer (e.g. AIS presentations) should be scaled proportionally to be accessible, which might require extra processing at application level. Consider changing ToScaleBacking flag passed to Wasm_Window constructor in case of issues.

Constructor & Destructor Documentation

◆ Wasm_Window()

Wasm_Window::Wasm_Window	(	const TCollection_AsciiString &	theCanvasId,
		const bool	theToScaleBacking = `true`
	)

Wraps existing HTML5 canvas into window.

Parameters

[in]	theCanvasId	target HTML element id defined in a querySelector() syntax
[in]	theToScaleBacking	when TRUE, window will automatically scale backing store of canvas basing on DevicePixelRatio() scale factor within DoResize()

◆ ~Wasm_Window()

virtual Wasm_Window::~Wasm_Window ( )

virtual

Destroys the window.

Member Function Documentation

◆ CanvasId()

const TCollection_AsciiString & Wasm_Window::CanvasId ( ) const

inline

Returns canvas id.

◆ DevicePixelRatio()

virtual Standard_Real Wasm_Window::DevicePixelRatio ( ) const

inlineoverridevirtual

Return device pixel ratio (logical to backing store scale factor).

Reimplemented from Aspect_Window.

◆ DoMapping()

virtual Standard_Boolean Wasm_Window::DoMapping ( ) const

inlineoverridevirtual

Apply the mapping change to the window.

Implements Aspect_Window.

◆ DoResize()

virtual Aspect_TypeOfResize Wasm_Window::DoResize ( )

overridevirtual

Resize window. In case of ToScaleBacking flag, this method will resize the backing store of canvas basing on DevicePixelRatio() scale factor and CSS canvas size.

Implements Aspect_Window.

◆ InvalidateContent()

virtual void Wasm_Window::InvalidateContent ( const Handle< Aspect_DisplayConnection > & theDisp )

overridevirtual

Invalidate entire window content through generation of Expose event.

Reimplemented from Aspect_Window.

◆ IsMapped()

virtual Standard_Boolean Wasm_Window::IsMapped ( ) const

inlineoverridevirtual

Return true if window is not hidden.

Implements Aspect_Window.

◆ Map()

virtual void Wasm_Window::Map ( ) const

inlineoverridevirtual

Change window mapped flag to TRUE.

Implements Aspect_Window.

◆ MouseButtonsFromNative()

static Aspect_VKeyMouse Wasm_Window::MouseButtonsFromNative ( unsigned short theButtons )

static

Convert Emscripten mouse buttons into Aspect_VKeyMouse.

◆ NativeFBConfig()

virtual Aspect_FBConfig Wasm_Window::NativeFBConfig ( ) const

inlineoverridevirtual

Always returns 0 for this class.

Implements Aspect_Window.

◆ NativeHandle()

virtual Aspect_Drawable Wasm_Window::NativeHandle ( ) const

inlineoverridevirtual

Current EGL implementation in Emscripten accepts only 0 for native window id.

Implements Aspect_Window.

◆ NativeParentHandle()

virtual Aspect_Drawable Wasm_Window::NativeParentHandle ( ) const

inlineoverridevirtual

Always returns 0 for this class.

Implements Aspect_Window.

◆ Position()

virtual void Wasm_Window::Position	(	Standard_Integer &	theX1,
		Standard_Integer &	theY1,
		Standard_Integer &	theX2,
		Standard_Integer &	theY2
	)		const

overridevirtual

Returns The Window POSITION in PIXEL.

Implements Aspect_Window.

◆ ProcessFocusEvent()

virtual bool Wasm_Window::ProcessFocusEvent	(	Aspect_WindowInputListener &	theListener,
		int	theEventType,
		const EmscriptenFocusEvent *	theEvent
	)

virtual

Process a focus input change message.

Parameters

[in,out]	theListener	listener to redirect message
[in]	theEventType	message type to process
[in]	theEvent	message to process

Returns: TRUE if message has been processed

◆ ProcessKeyEvent()

virtual bool Wasm_Window::ProcessKeyEvent	(	Aspect_WindowInputListener &	theListener,
		int	theEventType,
		const EmscriptenKeyboardEvent *	theEvent
	)

virtual

Process a keyboard input message.

Parameters

[in,out]	theListener	listener to redirect message
[in]	theEventType	message type to process
[in]	theEvent	message to process

Returns: TRUE if message has been processed

◆ ProcessMessage()

virtual bool Wasm_Window::ProcessMessage	(	Aspect_WindowInputListener &	theListener,
		int	theEventType,
		const void *	theEvent
	)

virtual

Process a single window message.

Parameters

[in,out]	theListener	listener to redirect message
[in]	theEventType	message type to process
[in]	theEvent	message to process

Returns: TRUE if message has been processed

◆ ProcessMouseEvent()

virtual bool Wasm_Window::ProcessMouseEvent	(	Aspect_WindowInputListener &	theListener,
		int	theEventType,
		const EmscriptenMouseEvent *	theEvent
	)

virtual

Process a mouse input message.

Parameters

[in,out]	theListener	listener to redirect message
[in]	theEventType	message type to process
[in]	theEvent	message to process

Returns: TRUE if message has been processed

◆ ProcessTouchEvent()

virtual bool Wasm_Window::ProcessTouchEvent	(	Aspect_WindowInputListener &	theListener,
		int	theEventType,
		const EmscriptenTouchEvent *	theEvent
	)

virtual

Process a mouse input message.

Parameters

[in,out]	theListener	listener to redirect message
[in]	theEventType	message type to process
[in]	theEvent	message to process

Returns: TRUE if message has been processed

◆ ProcessUiEvent()

virtual bool Wasm_Window::ProcessUiEvent	(	Aspect_WindowInputListener &	theListener,
		int	theEventType,
		const EmscriptenUiEvent *	theEvent
	)

virtual

Process a UI input message (like window resize).

Parameters

[in,out]	theListener	listener to redirect message
[in]	theEventType	message type to process
[in]	theEvent	message to process

Returns: TRUE if message has been processed

◆ ProcessWheelEvent()

virtual bool Wasm_Window::ProcessWheelEvent	(	Aspect_WindowInputListener &	theListener,
		int	theEventType,
		const EmscriptenWheelEvent *	theEvent
	)

virtual

Process a (mouse) wheel input message.

Parameters

[in,out]	theListener	listener to redirect message
[in]	theEventType	message type to process
[in]	theEvent	message to process

Returns: TRUE if message has been processed

◆ Ratio()

virtual Standard_Real Wasm_Window::Ratio ( ) const

overridevirtual

Returns window ratio equal to the physical width/height dimensions.

Implements Aspect_Window.

◆ SetDevicePixelRatio()

void Wasm_Window::SetDevicePixelRatio ( Standard_Real theDevicePixelRatio )

inline

Sets device pixel ratio for a window with IsVirtual() flag.

◆ SetSizeBacking()

void Wasm_Window::SetSizeBacking ( const Graphic3d_Vec2i & theSize )

Set new window size in pixels. Logical size of the element will be resized basing on DevicePixelRatio().

◆ SetSizeLogical()

void Wasm_Window::SetSizeLogical ( const Graphic3d_Vec2d & theSize )

Set new window size in logical (density-independent units). Backing store will be resized basing on DevicePixelRatio().

◆ Size()

virtual void Wasm_Window::Size	(	Standard_Integer &	theWidth,
		Standard_Integer &	theHeight
	)		const

overridevirtual

Return the window size in pixels.

Implements Aspect_Window.

◆ Unmap()

virtual void Wasm_Window::Unmap ( ) const

inlineoverridevirtual

Change window mapped flag to FALSE.

Implements Aspect_Window.

◆ VirtualKeyFromNative()

static Aspect_VKey Wasm_Window::VirtualKeyFromNative ( Standard_Integer theKey )

static

Convert DOM virtual key into Aspect_VKey.

Field Documentation

◆ myCanvasId

TCollection_AsciiString Wasm_Window::myCanvasId

protected

◆ myDevicePixelRatio

Standard_Real Wasm_Window::myDevicePixelRatio

protected

◆ myIsMapped

Standard_Boolean Wasm_Window::myIsMapped

mutableprotected

◆ mySize

Graphic3d_Vec2i Wasm_Window::mySize

protected

◆ myToScaleBacking

Standard_Boolean Wasm_Window::myToScaleBacking

protected

The documentation for this class was generated from the following file:

Wasm_Window.hxx

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Wasm_Window()

◆ ~Wasm_Window()

Member Function Documentation

◆ CanvasId()

◆ DevicePixelRatio()

◆ DoMapping()

◆ DoResize()

◆ InvalidateContent()

◆ IsMapped()

◆ Map()

◆ MouseButtonsFromNative()

◆ NativeFBConfig()

◆ NativeHandle()

◆ NativeParentHandle()

◆ Position()

◆ ProcessFocusEvent()

◆ ProcessKeyEvent()

◆ ProcessMessage()

◆ ProcessMouseEvent()

◆ ProcessTouchEvent()

◆ ProcessUiEvent()

◆ ProcessWheelEvent()

◆ Ratio()

◆ SetDevicePixelRatio()

◆ SetSizeBacking()

◆ SetSizeLogical()

◆ Size()

◆ Unmap()

◆ VirtualKeyFromNative()

Field Documentation

◆ myCanvasId

◆ myDevicePixelRatio

◆ myIsMapped

◆ mySize

◆ myToScaleBacking