RenderAreaListener Class

This class can be overridden by an application to receive notifications from a OIV.RemoteViz.Rendering.RenderArea.

Inheritance Hierarchy

SystemObject
OIV.InventorSoNetBase
OIV.RemoteViz.RenderingRenderAreaListener

Namespace: OIV.RemoteViz.Rendering
Assembly: OIV.RemoteViz (in OIV.RemoteViz.dll) Version: 2024.2.2.0 (10.16.2.0)

Syntax

C++

Copy

public class RenderAreaListener : SoNetBase

Public Class RenderAreaListener
	Inherits SoNetBase

public ref class RenderAreaListener : public SoNetBase

type RenderAreaListener =  
    class
        inherit SoNetBase
    end

The RenderAreaListener type exposes the following members.

Constructors

	Name	Description
	RenderAreaListener	Default constructor.

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	OnClosedConnection	Triggered when a connection is closed.
	OnInitializedConnection	Triggered when the connection and the frame encoders are initialized successfully.
	OnKeyDown	Triggered when a KeyDown event is received from the client.
	OnKeyUp	Triggered when a KeyUp event is received from the client.
	OnMouseDoubleClick	Triggered when a MouseDoubleClick event is received from the client.
	OnMouseDown	Triggered when a MouseDown event is received from the client.
	OnMouseEnter	Triggered when a MouseEnter event is received from the client.
	OnMouseLeave	Triggered when a MouseLeave event is received from the client.
	OnMouseMove	Triggered when a MouseMove event is received from the client.
	OnMouseUp	Triggered when a MouseUp event is received from the client.
	OnMouseWheel	Triggered when a mouse wheel event (rotatation) is received from the client.
	OnOpenedConnection	Triggered when a client connects to the OIV.RemoteViz.Rendering.RenderArea.
	OnPostRender	Triggered after a rendering is done.
	OnPreRender	Triggered before a rendering is done.
	OnReceivedMessage(RenderArea, Connection, IListByte)	Triggered when a binary message is received from a client.
	OnReceivedMessage(RenderArea, Connection, String)	Triggered when a text message is received from a client.
	OnRefusedEncoder	Triggered when a frame encoder cannot be initialized.
	OnRequestedFrame	Triggered when a new frame is requested by a connection.
	OnRequestedSize	Triggered when a client requests a new renderArea size.
	OnResize	Triggered when the renderArea is resized.
	OnSendingFrame	Triggered before sending a frame to the client.
	OnTouchEnd	Triggered when a TouchEnd event is received from the client.
	OnTouchMove	Triggered when a TouchMove event is received from the client.
	OnTouchStart	Triggered when a TouchStart event is received from the client.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

There are several categories of notifications:

OIV.RemoteViz.Rendering.Connection: To know when a connection has been created, initialized and disposed.
Render: To know the start/end of rendering and when an image is sent to the client.
Input events: To handle MouseDown, MouseUp, etc. events triggered by the user.
Messages: To handle messages sent from the client.

For notifications related to the lifetime of the OIV.RemoteViz.Rendering.RenderArea itself, see the OIV.RemoteViz.Rendering.ServiceListener class.

Typically the application will attach a listener to the OIV.RemoteViz.Rendering.RenderArea in the onInstantiatedRenderArea() method of its OIV.RemoteViz.Rendering.ServiceListener. But applications can also create a OIV.RemoteViz.Rendering.RenderArea explicitly and attach a listener.

A typical sequence of calls to this listener is:

OIV.RemoteViz.Rendering.RenderAreaListener.OnOpenedConnection(OIV.RemoteViz.Rendering.RenderArea, OIV.RemoteViz.Rendering.Connection, OIV.RemoteViz.Rendering.FrameEncoders)OIV.RemoteViz.Rendering.Connection object has been created (isOpen will return true)
OIV.RemoteViz.Rendering.RenderAreaListener.OnInitializedConnection(OIV.RemoteViz.Rendering.RenderArea, OIV.RemoteViz.Rendering.Connection, OIV.RemoteViz.Rendering.FrameEncoders)OIV.RemoteViz.Rendering.Connection is fully initialized (e.g. calibration has finished) While application is rendering...
- OIV.RemoteViz.Rendering.RenderAreaListener.OnPreRender(OIV.RemoteViz.Rendering.RenderArea, System.Boolean@, System.Boolean@) Scene will be rendered
- OIV.RemoteViz.Rendering.RenderAreaListener.OnPostRender(OIV.RemoteViz.Rendering.RenderArea) Scene has been rendered
- OIV.RemoteViz.Rendering.RenderAreaListener.OnSendingFrame(OIV.RemoteViz.Rendering.RenderArea, OIV.RemoteViz.Rendering.Connection, System.String@) Rendered image will be sent to client
OIV.RemoteViz.Rendering.RenderAreaListener.OnClosedConnection(OIV.RemoteViz.Rendering.RenderArea, System.String, System.Boolean)OIV.RemoteViz.Rendering.Connection object has been disposed (isOpen will return false)

Reference

OIV.RemoteViz.Rendering Namespace