Rebel Fork Framework
Urho3D::Console Class Reference

Console window with log history and command line prompt. More...

#include <Urho3D/SystemUI/Console.h>

Inheritance diagram for Urho3D::Console:
Urho3D::Object Urho3D::RefCounted

Classes

struct  LogEntry
 

Public Member Functions

 Console (Context *context)
 Construct.
 
 ~Console () override
 Destruct.
 
void SetVisible (bool enable)
 Show or hide.
 
void Toggle ()
 Toggle visibility.
 
void SetAutoVisibleOnError (bool enable)
 Automatically set console to visible when receiving an error log message.
 
void SetCommandInterpreter (const ea::string &interpreter)
 Set the command interpreter.
 
void SetNumHistoryRows (unsigned rows)
 Set command history maximum size, 0 disables history.
 
void SetConsoleHeight (unsigned height)
 Set console height.
 
bool IsVisible () const
 Return whether is visible.
 
bool IsAutoVisibleOnError () const
 Return true when console is set to automatically visible when receiving an error log message.
 
const ea::string & GetCommandInterpreter () const
 Return the last used command interpreter.
 
unsigned GetNumHistoryRows () const
 Return history maximum size.
 
void Clear ()
 Remove all rows.
 
void RenderContent ()
 Render contents of the console window. Useful for embedding console into custom UI.
 
void RefreshInterpreters ()
 Populate the command line interpreters that could handle the console command.
 
StringVector GetLoggers () const
 Returns a set of loggers that exist in console history.
 
void SetLoggerVisible (const ea::string &loggerName, bool visible)
 Set visibility of certain loggers in the console.
 
bool GetLoggerVisible (const ea::string &loggerName) const
 Get visibility of certain loggers in the console.
 
void SetLevelVisible (LogLevel level, bool visible)
 Set visibility of certain log levels in the console.
 
bool GetLevelVisible (LogLevel level) const
 Get visibility of certain log levels in the console.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 
virtual const ea::string & GetTypeName () const =0
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual bool IsInstanceOf (StringHash type) const =0
 Check whether current instance implements specified type.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
 
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
 
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
 
template<typename T >
const T * Cast () const
 Cast the object to specified most derived class.
 
void SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
 
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T handler)
 Subscribe to a specific sender's event.
 
void UnsubscribeFromEvent (StringHash eventType)
 Unsubscribe from an event.
 
void UnsubscribeFromEvent (Object *sender, StringHash eventType)
 Unsubscribe from a specific sender's event.
 
void UnsubscribeFromEvents (Object *sender)
 Unsubscribe from a specific sender's events.
 
void UnsubscribeFromAllEvents ()
 Unsubscribe from all events.
 
void UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
 
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
 
void SendEvent (StringHash eventType)
 Send event to all subscribers.
 
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
 
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
 
template<typename... Args>
void SendEvent (StringHash eventType, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &value)
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () const
 Return active event handler. Null outside event handling.
 
bool HasSubscribedToEvent (StringHash eventType) const
 Return whether has subscribed to an event without specific sender.
 
bool HasSubscribedToEvent (Object *sender, StringHash eventType) const
 Return whether has subscribed to a specific sender's event.
 
bool HasEventHandlers () const
 Return whether has subscribed to any event.
 
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
 
const ea::string & GetCategory () const
 
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
 
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
 
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
 
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
 
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
 
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
 
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
 
bool IsScriptStrongRef () const
 Return true if script reference is strong.
 

Private Member Functions

 URHO3D_OBJECT (Console, Object)
 
void HandleScreenMode (StringHash eventType, VariantMap &eventData)
 Update console size on application window changes.
 
void HandleLogMessage (StringHash eventType, VariantMap &eventData)
 Handle a log message.
 
void RenderUi (StringHash eventType, VariantMap &eventData)
 Render system ui.
 
void ScrollToEnd ()
 Scroll console to the end.
 

Private Attributes

bool autoVisibleOnError_ = false
 Auto visible on error flag.
 
ea::vector< ea::string > interpreters_ {}
 List of command interpreters.
 
ea::vector< const char * > interpretersPointers_ {}
 Pointers to c strings in interpreters_ list for efficient UI rendering.
 
int currentInterpreter_ = 0
 Last used command interpreter.
 
ea::ring_buffer< LogEntryhistory_ {2000}
 Command history.
 
unsigned historyRows_ = 512
 Command history maximum rows.
 
bool isOpen_ = false
 Is console window open.
 
char inputBuffer_ [0x1000] {}
 Input box buffer.
 
IntVector2 windowSize_ {M_MAX_INT, 200}
 Console window size.
 
int scrollToEnd_ = 0
 Number of frames to attempt scrolling to the end. Usually two tries are required to properly complete the action (for some reason).
 
bool focusInput_ = false
 Flag indicating that console input should be focused on the next frame.
 
ea::hash_set< ea::string > loggersHidden_ {}
 Set of loggers to be omitted from rendering.
 
bool levelVisible_ [LOG_NONE]
 Log level visibility flags. More...
 
IntVector2 selection_ {}
 Current selection in console window. This range denote start and end of selected characters and may span multiple log lines.
 
ea::string copyBuffer_ {}
 Temporary variable for accumulating selection in order to copy it to clipboard.
 
bool isAtEnd_ = true
 When set to true scrollbar of messages panel is at the bottom.
 

Additional Inherited Members

- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 
- Static Public Attributes inherited from Urho3D::Object
static constexpr ea::array< StringHash, 0 > TypeHierarchy {}
 
- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.
 

Detailed Description

Console window with log history and command line prompt.

Member Data Documentation

◆ levelVisible_

bool Urho3D::Console::levelVisible_[LOG_NONE]
private
Initial value:
{
false,
false,
true,
true,
true
}

Log level visibility flags.


The documentation for this class was generated from the following files: