Events
[neuray Services API]
Description
Classes
- class
- A helper class to facilitate event creation and sending. More...
- class
- A helper class to facilitate neuray event creation and sending. More...
- class
- Used to specify and send an event. More...
- class
- The event context. More...
- class
- An Event handler. These are implemented by the user. More...
- class
- The event handler context. This is passed to event handlers when they are triggered,. More...
Typedefs
- typedef base::Uuid_t< 0x165FCF31, 0xC8D7, 0x01A0, 0x5D, 0x20, 0x89, 0xE2, 0xD3, 0xE7, 0x46, 0x4C> mi::nservices::CHANGE_SCOPE
- Triggered when the command context changes scope. More...
- typedef base::Uuid_t< 0x165B084A, 0xC4D3, 0xB626, 0xD7, 0x95, 0xEE, 0xA9, 0x65, 0x5A, 0xF6, 0xFC> mi::nservices::POST_COMMAND_EXECUTION
- Triggered after each command is executed. More...
- typedef base::Uuid_t< 0x165F88A2, 0xA33C, 0x425F, 0x52, 0x31, 0xB9, 0x1E, 0xA0, 0xE5, 0xE8, 0xB2> mi::nservices::POST_RENDER
- Triggered after every render. More...
- typedef base::Uuid_t< 0x165B083A, 0x9175, 0xAA14, 0x77, 0x18, 0x35, 0x44, 0x07, 0x88, 0x2A, 0x0B> mi::nservices::PRE_COMMAND_EXECUTION
- Triggered before each command is executed. More...
- typedef base::Uuid_t< 0x165F8892, 0xA75A, 0x5EFD, 0x75, 0x47, 0xD1, 0xE5, 0x3A, 0xFB, 0x66, 0xFA> mi::nservices::PRE_RENDER
- Triggered before every render. More...
Typedefs
- typedef base::Uuid_t< 0x165FCF31, 0xC8D7, 0x01A0, 0x5D, 0x20, 0x89, 0xE2, 0xD3, 0xE7, 0x46, 0x4C> mi::nservices::CHANGE_SCOPE
-
Triggered when the command context changes scope. See ICommand_context::change_scope.
event_data
-
0 the name of the previous scope (mi::IString).
-
1 the name of the next scope (mi::IString).
-
- typedef base::Uuid_t< 0x165B084A, 0xC4D3, 0xB626, 0xD7, 0x95, 0xEE, 0xA9, 0x65, 0x5A, 0xF6, 0xFC> mi::nservices::POST_COMMAND_EXECUTION
-
Triggered after each command is executed. The handler may modify the response.
event_data
-
0 the ICommand_response for this command (mi::nservices::ICommand_response).
-
- typedef base::Uuid_t< 0x165F88A2, 0xA33C, 0x425F, 0x52, 0x31, 0xB9, 0x1E, 0xA0, 0xE5, 0xE8, 0xB2> mi::nservices::POST_RENDER
-
Triggered after every render. This post render event is actually triggered twice. The first time, the phase (event data 1) is set to 0 and the canvas data is the raw canvas directly from the renderer. The event is triggered a second time (with phase == 1) after core tonemapping has occurred and in that case the event handler receives the tonemapped canvas.
Note:This pre/post tonemapping feature does not apply if rendering with iray and using the built in iray tonemapper. In that case the image is tonemapped by iray itself so both the pre and post phases receive the tonemapped image.
event_data
-
0 the IScene the canvas was rendered from (mi::nservices::IScene).
-
1 the post render phase, 0 is pre-tonemapping, 1 is post-tonemapping (mi::IUint32).
-
2 the ICanvas result of the render (mi::neuraylib::ICanvas).
-
3 the name of the renderer used (mi::IString).
-
- typedef base::Uuid_t< 0x165B083A, 0x9175, 0xAA14, 0x77, 0x18, 0x35, 0x44, 0x07, 0x88, 0x2A, 0x0B> mi::nservices::PRE_COMMAND_EXECUTION
-
Triggered before each command is executed. The handler may modify the arguments of the command if desired. If the handler returns 0 the command is not executed, otherwise it is executed. If execution is denied then the POST_COMMAND_EXECUTION event for this command is not sent.
event_data
-
0 the ICommand_request for this command (mi::nservices::ICommand_request).
-
- typedef base::Uuid_t< 0x165F8892, 0xA75A, 0x5EFD, 0x75, 0x47, 0xD1, 0xE5, 0x3A, 0xFB, 0x66, 0xFA> mi::nservices::PRE_RENDER
-
Triggered before every render. All data can be modified
event_data
-
0 the IScene about to be rendered (mi::nservices::IScene).
-
1 the name of the canvas to render to (mi::IString).
-
2 the pixel type of the canvas to render to (mi::IString).
-
3 the renderer to use (mi::IString).
-
4 x resolution (mi::IUint32).
-
5 y resolution (mi::IUint32).
-