内容表

• 关于
• Custom Loggers
• Using Custom Loggers
• Built-In Loggers
• Logger Types
• 延伸阅读

关于

The logger interface allows to create new custom loggers for specific tasks and to access existing loggers. Loggers are presented in the "Console" window in Cinema 4D and registered at the maxon::Loggers registry.

Messages can be sent to the default logger using ApplicationOutput() .

Custom Loggers

A new custom logger can be created with maxon::LoggerRef::Create() and is then registered at maxon::Loggers . A logger type defines the target of the logger (see Logger Types ).

• maxon::LoggerInterface::AddLoggerType() : Adds the given logger type to the custom logger.
• maxon::LoggerInterface::RemoveLoggerType() : Removes the given logger type from the logger.
• maxon::LoggerInterface::RemoveLoggerTypes() : Removes all logger types of the given type.
• maxon::LoggerInterface::GetLoggerTypes() : Returns all logger types of the logger.

A custom logger is configured with:

• maxon::LoggerInterface::GetName() : Returns the name of the logger.
• maxon::LoggerInterface::SetName() : Sets the name of the logger.
• maxon::LoggerInterface::Enable() : Enables or disables the logger.
• maxon::LoggerInterface::IsEnabled() : Returns true if the logger is enabled.

// This example creates a new custom logger and adds it to the registered loggers. // g_exampleLogger is a maxon::LoggerRef instance.

// define logger ID const maxon::Id loggerID { "net.maxonexample.logger" };

// check if a logger with that ID already exists if (! maxon::Loggers::Get (loggerID)) { // create the new logger and store it in a global variable for later access // make sure to set this object to nullptr when Cinema shuts down iferr (g_exampleLogger = maxon::LoggerRef::Create()) { // if the logger could not be created, use the default logger instead g_exampleLogger = maxon::Loggers::Default(); } else { // if the logger could be created // add the logger type "Application" to display logged messages in the "Console" window g_exampleLogger.AddLoggerType( maxon::TARGETAUDIENCE::ALL , maxon::LoggerTypes::Application()) iferr_return ;

// define logger name g_exampleLogger.SetName( "Example Logger" _s); // insert the logger in the "Loggers" registry maxon::Loggers::Insert(loggerID, g_exampleLogger) iferr_return ;

// this message must be send to update the console window const maxon::Int32 BFM_REBUILDCONSOLETREE = 334295845; SpecialEventAdd (BFM_REBUILDCONSOLETREE); } }

// This example shows how to free the logger reference.