API component that serves as entry point for the client-side Iray Bridge API. More...
Public Member Functions | |
| virtual Sint32 | set_application_url (const char *application_url)=0 |
| Sets the web socket URL to the server-side Iray Bridge application. More... |
|
| virtual const char * | get_application_url () const =0 |
| Returns the configured Iray Bridge application URL. More... |
|
| virtual Sint32 | set_security_token (const char *security_token)=0 |
| Sets the security token to use when connecting the server-side Iray Bridge application. More... |
|
| virtual const char * | get_security_token () const =0 |
| Returns the configured security token. More... |
|
| virtual IIray_bridge_snapshot_context * |
create_snapshot_context (neuraylib::ITransaction *transaction, const char *scene_name)=0 |
| Creates a snapshot context. More... |
|
| virtual Sint32 | set_log_forwarding_level (base::Message_severity level)=0 |
| Sets the log level of messages that are forwarded from the Iray Bridge server. More... |
|
| virtual base::Message_severity | get_log_forwarding_level () const =0 |
| Returns the currently set log level for messages forwarded from the Iray Bridge server. More... |
|
| virtual void | set_receiving_logger (base::ILogger *logger)=0 |
| Sets the receiving logger for log messages forwarded from the Iray Bridge server. More... |
|
| virtual base::ILogger * | get_receiving_logger () const =0 |
| Returns the receiving logger for log messages forwarded from the Iray Bridge server. More... |
|
| virtual const char * | get_bridge_protocol_version () const =0 |
| Returns the Iray Bridge protocol version. More... |
|
Additional Inherited Members | |
 Public Types inherited from mi::base::Interface_declare< 0x2e3322ff, 0xc7a1, 0x4664, 0x99, 0x6d, 0xef, 0xd1, 0xf2, 0x24, 0x83, 0xa4 >
| |
| typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface > |
Self |
| Own type. More... |
|
| typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 > |
IID |
| Declares the interface ID (IID) of this interface. More... |
|
|
Static Public Member Functions inherited from mi::base::Interface_declare< 0x2e3322ff, 0xc7a1, 0x4664, 0x99, 0x6d, 0xef, 0xd1, 0xf2, 0x24, 0x83, 0xa4 >
| |
| static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... |
|
API component that serves as entry point for the client-side Iray Bridge API.
This API component is provided by the iray_bridge_client plugin.
|
pure virtual |
Creates a snapshot context.
| transaction | The transaction determines the scope of the context. All transactions used with the context need to be from the same scope. |
| scene_name | The scene of the context. |
NULL if creation failed.
|
pure virtual |
Returns the configured Iray Bridge application URL.
|
pure virtual |
Returns the Iray Bridge protocol version.
|
pure virtual |
Returns the currently set log level for messages forwarded from the Iray Bridge server.
|
pure virtual |
Returns the receiving logger for log messages forwarded from the Iray Bridge server.
Note that if no receiving logger has been set, this method returns NULL and logging is done using the currently general configured logger.
|
pure virtual |
Returns the configured security token.
|
pure virtual |
Sets the web socket URL to the server-side Iray Bridge application.
Bridge renderer contexts and snapshot contexts will use this address when connecting to the Iray Bridge server application and will also detect changes and reconnect to the new server automatically.
| application_url | The web socket URL to the server-side Iray Bridge application. If the HTTP server listens on host "somehost" and port 80, and the application path on the server side is set to "/myapp", then the client will connect using the URL "ws://somehost:80/myapp". If the connection is encrypted using the SSL protocol, then the prefix "wss" needs to be used instead of "ws". Note that the port must be specified. The standard port for web sockets is 80 and 443 for secure web sockets. Iray Bridge server instances running on the VCA use SSL, run on port 443, and use the application path "/bridge". |
|
pure virtual |
Sets the log level of messages that are forwarded from the Iray Bridge server.
Note that this does not affect the log level of the server, nor the log level of the client. It only filters the messages forwarded by the server to the client.
|
pure virtual |
Sets the receiving logger for log messages forwarded from the Iray Bridge server.
If the provided logger is NULL then forwarded log entries will be written to the general configured logger as if they were generated locally, but with a prefix identifying the server that they originated from (default behavior).
| logger | The receiving logger. It is valid to pass NULL in which case logging is reset to be done to the general configured logger. |
|
pure virtual |
Sets the security token to use when connecting the server-side Iray Bridge application.