UT_HUDInfoArgs.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        UT_HUDInfoArgs.h (UT Library, C++)
 *
 * COMMENTS:    UT_HUDInfoArgs holds the arguments for BM_SceneManager::hudInfo.
 */

#ifndef __UT_HUDInfoArgs_H__
#define __UT_HUDInfoArgs_H__

#include "UT_API.h"

#include "UT_Array.h"
#include "UT_Vector4.h"
#include "UT_StringHolder.h"

// Holds the arguments for BM_SceneManager::hudInfo
class UT_HUDInfoArgs
{
    public:
    enum class State : short
    {
        // Flags for setting the hud states.
        NoState = 0,
        Maximize,
        Minimize,
        Toggle
    };

    enum class Command : short
    {
        // Flags for driving the mutually exclusive hud commands.
        NoCommand = 0,
        Create,
        Close,
        Clear,
        Enter,
        Exit,
        Interrupt,
        Resume,
        SetHUDOptionsFromPrefs,
        SetHUDToolInfoHeader,           // Set state HUD header
        UpdateHUDToolInfoHeader,        // Update state HUD header
    };

    enum class Panel : short
    {
        // Flags to identify HUD panels.
        NoPanel = 0,
        ToolInfo,
        User,
        Prompt,
        Stats
    };

    enum class HOMPanel : short
    {
        // Flags used by the HOM API.
        NoPanel     = (short)Panel::NoPanel,
        ToolInfo    = (short)Panel::ToolInfo,
        User        = (short)Panel::User
        //Prompt    = (short)Panel::Prompt,
        //Stats     = (short)Panel::Stats
    };

    UT_HUDInfoArgs() = default;
    ~UT_HUDInfoArgs() = default;

    static UT_Array<Panel> const& panelIDs()
    {
        static UT_Array<Panel> hud_panels = []()
        {           
            return UT_Array<Panel>{Panel::ToolInfo, Panel::User, Panel::Prompt, Panel::Stats};
        }();
        return hud_panels;
    }

    Command     command = Command::NoCommand;               // Command to execute
        
    int         update_texture = 0;                         // 0: No texture update
                                                            // 1: Update the texture if panel is dirty.
                                                            // -1: Force update of all textures
    int         show = -1;                                  // Display/Hide
    State       hud_state = State::NoState;                 // HUD state operation
    void*       hud_template = nullptr;                     // Template python dictionary
    void*       hud_values = nullptr;                       // Value python dictionary
    Panel       hud_panel = Panel::ToolInfo;                // HUD panel ID
    UT_StringHolder hud_kwargs;                             // python dictionary string representation
                                                            // holding key/value parameters for 
                                                            // the command to execute.
    UT_StringHolder hud_key;                                // Optional key to index the HUD cache.

    // Options
    int         hud_text_shadow = -1;                       // Draw text shadow
    int         hud_backg_vis = -1;                         // Background visibility
    int         hud_panel_size = -1;                        // HUD panel size
    UT_Vector4D hud_label_color = UT_Vector4D(-1,-1,-1);    // Label color
    UT_Vector4D hud_value_color = UT_Vector4D(-1,-1,-1);    // Value color
    UT_Vector4D hud_backg_color = UT_Vector4D(-1,-1,-1);    // Background color
};

#endif // __UT_HUDInfoArgs_H__