OPUI_GraphBadge.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:        OPUI_GraphBadge.h (User Interface Library, C++)
 *
 * COMMENTS:
 *              A class to describe a node badge.
 *
 */

#ifndef __OPUI_GraphBadge__
#define __OPUI_GraphBadge__

#include "OPUI_API.h"
#include <UT/UT_Array.h>
#include <UT/UT_Color.h>
#include <UT/UT_StringHolder.h>
#include <UT/UT_Error.h>
#include <variant>

class OPUI_GraphBadge;
class OP_Context;
class OP_Node;

enum OPUI_GraphBadgeVisibility {
    BADGEVIS_HIDE,
    BADGEVIS_NORMAL,
    BADGEVIS_LARGE,
    BADGEVIS_NUM_ENTRIES
};

enum OPUI_GraphBadgeThreading {
    BADGE_SINGLE_THREADED,
    BADGE_MULTI_THREADED
};

/// Holder of the UN_Node handle. 
// Using this holder instead of directly UN_Node handle to avoid exporting UN 
// headers to HDK. 
// TODO: FIXME: Once UN headers are available in HDK, remove this holder class!
#include <UT/UT_UniquePtr.h>
class UN_ConstNode;

class OPUI_API OPUI_UnNodeHolder 
{
public:
             OPUI_UnNodeHolder();
             OPUI_UnNodeHolder( const OPUI_UnNodeHolder &other );
    explicit OPUI_UnNodeHolder( const UN_ConstNode &un_node );
            ~OPUI_UnNodeHolder();

             OPUI_UnNodeHolder& operator=(const OPUI_UnNodeHolder& other);

    explicit operator           bool() const;

    const UN_ConstNode *        get() const { return myUnNode.get(); }
    const UN_ConstNode *        operator->() const { return myUnNode.get(); }
    const UN_ConstNode &        operator*() const { return *myUnNode; }
                

private:
    UT_UniquePtr<UN_ConstNode>  myUnNode;
};


class OPUI_API OPUI_GraphBadgeInfo
{
public:
    using Node = std::variant<OP_Node*, OPUI_UnNodeHolder>;

    OP_Node *               opNode() const
                            {
                                auto p = std::get_if<OP_Node*>(&myItem);
                                return p ? *p : nullptr;
                            }

    const UN_ConstNode *    unNode() const
                            {
                                auto p =std::get_if<OPUI_UnNodeHolder>(&myItem);
                                return p ? p->get() : nullptr;
                            }

    Node                     myItem;
    UT_ErrorSeverity         myErrorSeverity;
    int                      myBadgeDataId;
    bool                     myCurrent;
    bool                     myPicked;
};

typedef bool (*OPUI_GraphBadgeTest)(const OPUI_GraphBadgeInfo &info,
                                    OPUI_GraphBadgeVisibility visibility,
                                    OP_Context &context,
                                    UT_StringHolder &icon,
                                    UT_Color &clr);
typedef UT_Array<OPUI_GraphBadge> OPUI_GraphBadgeArray;

class OPUI_API OPUI_GraphBadge
{
public:
                                 OPUI_GraphBadge(const UT_StringHolder &pref,
                                        const UT_StringHolder &category,
                                        const UT_StringHolder &description,
                                        const UT_StringHolder &icon,
                                        OPUI_GraphBadgeVisibility vis,
                                        OPUI_GraphBadgeTest test,
                                        OPUI_GraphBadgeThreading threading);
                                ~OPUI_GraphBadge();

    const UT_StringHolder       &getPreferenceName() const
                                 {  return myPreferenceName; }
    const UT_StringHolder       &getPreferenceCategory() const
                                 {  return myPreferenceCategory; }
    const UT_StringHolder       &getDescription() const
                                 {  return myDescription; }
    const UT_StringHolder       &getIcon() const
                                 {  return myIcon; }
    OPUI_GraphBadgeVisibility    getDefaultVisibility() const
                                 { return myDefaultVisibility; }
    OPUI_GraphBadgeTest          getBadgeTest() const
                                 { return myBadgeTest; }
    bool                         getThreadSafe() const
                                 { return myThreadSafe; }

    OPUI_GraphBadgeVisibility    getVisibility() const
                                 { return myVisibility; }
    void                         setVisibility(OPUI_GraphBadgeVisibility vis)
                                 { myVisibility = vis; }

    static void                  addBadges(OPUI_GraphBadgeArray &add_badges);

    static const UT_StringHolder theErrorPref;
    static const UT_StringHolder theChildErrorPref;
    static const UT_StringHolder theWarningPref;
    static const UT_StringHolder theMessagePref;
    static const UT_StringHolder theCommentPref;
    static const UT_StringHolder theNodeLockedPref;
    static const UT_StringHolder theNodeUnloadPref;
    static const UT_StringHolder theNodeHasDataPref;
    static const UT_StringHolder theNeedsCookPref;
    static const UT_StringHolder theHDALockedPref;
    static const UT_StringHolder theHDAUnlockedPref;
    static const UT_StringHolder theHDADelaySyncPref;
    static const UT_StringHolder theNodeDiveablePref;
    static const UT_StringHolder theLoadFromDiskPref;
    static const UT_StringHolder theTimeDepPref;
    static const UT_StringHolder theTagsPref;

    static const UT_StringHolder theVexCachePref;
    static const UT_StringHolder theNotCompilablePref;
    static const UT_StringHolder the64bitPref;
    static const UT_StringHolder theContinuousCookPref;
    static const UT_StringHolder theDynamicTOPPref;
    static const UT_StringHolder theLiveRenderPref;
    static const UT_StringHolder theLopDebugPref;
    static const UT_StringHolder theLopUnloadedPayloadsPref;
    static const UT_StringHolder theLopPopulationMaskPref;

    static const UT_StringHolder theConstraintsPref;
    static const UT_StringHolder theKinematicsPref;
    static const UT_StringHolder theHasTakeDataPref;

    static const UT_StringHolder theMQServerAuthPref;
    static const UT_StringHolder theMQClientsAuthPref;

    static const UT_StringHolder theMainBadgeCategory;
    static const UT_StringHolder theContextSpecificBadgeCategory;
    static const UT_StringHolder theParametersBadgeCategory;

private:
    UT_StringHolder              myPreferenceName;
    UT_StringHolder              myPreferenceCategory;
    UT_StringHolder              myDescription;
    UT_StringHolder              myIcon;
    OPUI_GraphBadgeVisibility    myDefaultVisibility;
    OPUI_GraphBadgeVisibility    myVisibility;
    OPUI_GraphBadgeTest          myBadgeTest;
    bool                         myThreadSafe;
};

#endif