Class for getting and setting builder options.
More...
#include <SceneBuilderOptions.h>
|
MaxUSDAPI Log::Options & | GetLogOptions () |
| Returns the builder's logging options. More...
|
|
MaxUSDAPI const Log::Options & | GetLogOptions () const |
|
MaxUSDAPI void | GetCallBacks (USDIOEventType type, std::vector< std::shared_ptr< USDIOCallback > > &eventCallbacks) const |
| Gets all registered callbacks for the given event type. More...
|
|
MaxUSDAPI const std::map< USDIOEventType, std::map< std::wstring, std::shared_ptr< USDIOCallback > > > & | GetCallBacks () const |
| Returns all registered callbacks organized by event types and callback Id. More...
|
|
MaxUSDAPI void | RemoveCallbacks (USDIOEventType type=USDIOEventType::None, const std::wstring &id=L"") |
| Removes callbacks by event type and/or id. More...
|
|
MaxUSDAPI void | AddCallback (USDIOEventType type, const std::wstring &id, std::shared_ptr< USDIOCallback > callback) |
| Registers a new callback. More...
|
|
|
Log::Options | logOptions |
| Logging options.
|
|
std::map< USDIOEventType, std::map< std::wstring, std::shared_ptr< USDIOCallback > > > | callbacks |
| Registered callbacks.
|
|
Class for getting and setting builder options.
◆ AddCallback()
MaxUSDAPI void MAXUSD_NS_DEF::SceneBuilderOptions::AddCallback |
( |
USDIOEventType |
type, |
|
|
const std::wstring & |
id, |
|
|
std::shared_ptr< USDIOCallback > |
callback |
|
) |
| |
Registers a new callback.
- Parameters
-
type | The event type for which to register the callback. |
id | The callback's Id. |
callback | The callback to be added. |
◆ GetCallBacks() [1/2]
MaxUSDAPI const std::map< USDIOEventType, std::map< std::wstring, std::shared_ptr< USDIOCallback > > > & MAXUSD_NS_DEF::SceneBuilderOptions::GetCallBacks |
( |
| ) |
const |
Returns all registered callbacks organized by event types and callback Id.
- Returns
- A map of all registered callbacks.
◆ GetCallBacks() [2/2]
MaxUSDAPI void MAXUSD_NS_DEF::SceneBuilderOptions::GetCallBacks |
( |
USDIOEventType |
type, |
|
|
std::vector< std::shared_ptr< USDIOCallback > > & |
eventCallbacks |
|
) |
| const |
Gets all registered callbacks for the given event type.
- Parameters
-
type | The event type for which to get the callbacks. |
eventCallbacks | Callback vector to be filled. |
◆ GetLogOptions()
MaxUSDAPI Log::Options & MAXUSD_NS_DEF::SceneBuilderOptions::GetLogOptions |
( |
| ) |
|
Returns the builder's logging options.
- Returns
- The logging options.
◆ RemoveCallbacks()
MaxUSDAPI void MAXUSD_NS_DEF::SceneBuilderOptions::RemoveCallbacks |
( |
USDIOEventType |
type = USDIOEventType::None , |
|
|
const std::wstring & |
id = L"" |
|
) |
| |
Removes callbacks by event type and/or id.
- If neither are specified, all callbacks are removed.
- If only the event type is specified, all callbacks for that event type are removed.
- If only the callback id is specified, all callbacks with that Id are removed, whatever the event type.
- If both are specified, only the callback of that Id for that event type is removed.
- Parameters
-
type | The event type for which to remove the callback. |
id | The id of the callback to be removed. |
The documentation for this class was generated from the following file: