| SoRemoteVizClient Class |
Client node enables to integrate RemoteViz into Open Inventor applications.
Inheritance HierarchyOIV.InventorSoNetBase
OIV.InventorSoDisposable
OIV.Inventor.MiscSoBase
OIV.Inventor.FieldsSoFieldContainer
OIV.Inventor.NodesSoNode
OIV.RemoteViz.Clients.NodesSoRemoteVizClient
Namespace: OIV.RemoteViz.Clients.Nodes
Assembly: OIV.RemoteViz.Client (in OIV.RemoteViz.Client.dll) Version: 2024.1.0.0 (2024.1.0)
SyntaxThe SoRemoteVizClient type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SoRemoteVizClient | Default constructor. |
Methods| Name | Description | |
|---|---|---|
| AffectsState | Returns true if a node has an effect on the state during traversal. |
| Callback | (Inherited from SoNode.) |
| Copy | Calls Copy(false). (Inherited from SoNode.) |
| Copy(Boolean) | Creates and returns an exact copy of the node. |
| CopyFieldValues(SoFieldContainer) | Calls CopyFieldValues(fc, false). (Inherited from SoFieldContainer.) |
| CopyFieldValues(SoFieldContainer, Boolean) | Copies the contents of fc's fields into this object's fields. |
| Dispose |
Releases all resources used by SoDisposable.
(Inherited from SoDisposable.) |
| Distribute | (Inherited from SoNode.) |
| DoAction | (Inherited from SoNode.) |
| EnableNotify | Notification at this Field Container is enabled (if flag == true) or disabled (if flag == false). |
| EnableSecureConnection(String, String) | Calls EnableSecureConnection(publicCertificateFilePath, privateKeyFilePath, OIV.RemoteViz.Clients.Nodes.SoRemoteVizClient.SecurityProtocols( .SoRemoteVizClient.TLSv1_1 | .SoRemoteVizClient.TLSv1_2 | .SoRemoteVizClient.TLSv1_3 ), ""). |
| EnableSecureConnection(String, String, SoRemoteVizClientSecurityProtocols) | Calls EnableSecureConnection(publicCertificateFilePath, privateKeyFilePath, enabledSecurityProtocols, ""). |
| EnableSecureConnection(String, String, SoRemoteVizClientSecurityProtocols, String) | Secures the connection between the client and the server. |
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| FieldsAreEqual | Returns true if this object's fields are exactly equal to fc's fields. |
| Get | Returns the values of the fields of this object in the Open Inventor ASCII file format in the given string. |
| GetAllFields | Returns a list of fields, including the eventIn's and eventOut's. |
| GetAlternateRep | This method is called by actions to allow the node to provide an "alternate representation" when appropriate (typically depending on the action type). |
| GetBoundingBox | (Inherited from SoNode.) |
| GetContainerSize | Returns the size of the renderArea container. |
| GetEnabledSecurityProtocols | Gets the security procotols used in RemoteViz. |
| GetEventIn | Returns a the eventIn with the given name. |
| GetEventOut | Returns the eventOut with the given name. |
| GetField | Returns a the field of this object whose name is fieldName. |
| GetFieldName | Returns the name of the given field in the fieldName argument. |
| GetFields | Appends references to all of this object's fields to resultList, and returns the number of fields appended. |
| GetHashCode |
Overrides GetHashCode().
(Inherited from SoNetBase.) |
| GetMatrix | (Inherited from SoNode.) |
| GetName | Returns the name of an instance. |
| GetPrimitiveCount | (Inherited from SoNode.) |
| GetRenderAreaSize | Returns the size of the renderArea managed by the RemoteViz service. |
| GetRenderEngineMode | Returns the supported Render engine mode. |
| GetRenderUnitID | (Inherited from SoNode.) |
| GetStreamingMode | Returns the type of streaming currently used by the client. |
| GetStringName | (Inherited from SoBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetVideoDecoder | Returns the video decoder that has been successfully initialized and currently used by the client to decode video stream. |
| GLRender | (Inherited from SoNode.) |
| GLRenderBelowPath | (Inherited from SoNode.) |
| GLRenderInPath | (Inherited from SoNode.) |
| GLRenderOffPath | (Inherited from SoNode.) |
| GrabEventsCleanup | (Inherited from SoNode.) |
| GrabEventsSetup | (Inherited from SoNode.) |
| HandleEvent | (Inherited from SoNode.) |
| HasDefaultValues | Returns true if all of the object's fields have their default values. |
| IsBoundingBoxIgnoring | This method is used by getBoundingBox action traversal to know if the current node must be traversed or not, ie the bounding should be ignored. |
| IsImageStreamingSupported | Checks if the client supports image streaming. |
| IsNotifyEnabled | Notification is the process of telling interested objects that this object has changed. |
| IsOverride | Returns the state of the override flag. |
| IsSecureConnection | Gets the SSL engine activation. |
| IsSynchronizable | Gets the ScaleViz synchronizable state of this object. |
| IsVideoStreamingSupported | Checks if the client supports video streaming. |
| Pick | (Inherited from SoNode.) |
| RayPick | (Inherited from SoNode.) |
| RequestRenderAreaSize | Sends a request to resize the renderArea associated with the connection. |
| Search | (Inherited from SoNode.) |
| SendMessage(String) | Sends a text message to the server. |
| SendMessage(SoCpuBufferObject) | Sends a binary message to the server. |
| Set | Sets one or more fields in this object to the values specified in the given string, which should be a string in the Open Inventor file format. |
| SetName | (Inherited from SoBase.) |
| SetOverride | Turns the override flag on or off. |
| SetSynchronizable | Sets this to be a ScaleViz synchronizable object. |
| SetToDefaults | Sets all fields in this object to their default values. |
| ToString |
Converts this SoBase structure to a human readable string.
(Inherited from SoBase.) |
| Touch | Marks an instance as modified, simulating a change to it. |
| Write | (Inherited from SoNode.) |
Properties| Name | Description | |
|---|---|---|
 | connect | Opens/Closes a connection between the client and the RemoteViz service. |
| connectionParameters | Connection parameters that will be sent to the RemoteViz service during the connection establishment. |
| displayMode | This setting allows you to specify how to map the renderArea image (server-side) into the container (client-side). |
| ipAddress | Specifies the IP address of the RemoteViz Service to which the client will connect. |
| IsDisposable | ISafeDisposable interface implementation.
(Inherited from SoDisposable.) |
| port | Specifies the port of the RemoteViz Service to which the client will connect. |
| renderAreaName | Specifies the renderArea name to which the client will connect. |
| UserData |
Gets or sets the user data to be contained by the field container.
(Inherited from SoFieldContainer.) |
| videoDecoders | This setting allows you to specify a preference list of video decoders. |
Events| Name | Description | |
|---|---|---|
 | OnDecodedFrame | Triggered when a frame is decoded and displayed. |
| OnKeyboardEvent | Triggered when a keyboard event is fired on the client. |
| OnMouseButtonEvent | Triggered when a mouse button event is fired on the client. |
| OnMouseLocationEvent | Triggered when a mouse location event is fired on the client. |
| OnMouseWheelEvent | Triggered when a mouse wheel event is fired on the client. |
| OnReceivedBinaryMessage | Triggered when a binary message is received from the RemoteViz service. |
| OnReceivedFrame | Triggered when a frame is received from the RemoteViz service. |
| OnReceivedMessage | Triggered when a text message is received from the RemoteViz service. |
| OnRenderAreaResize | Triggered when the renderArea has been resized. |
| OnServiceMessage | Triggered when a service message is received from the RemoteViz service. |
| OnTouchEvent | Triggered when a touch event is fired on the client. |
RemarksThis node is a RemoteViz client enabling software developers to easily integrate remote 3D interaction and visualization into their Open Inventor applications. It enables to establish a connection to a RemoteViz service so that display frames into an Open Inventor viewer.
See Also