GUI_GroupData.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:        GUI_GroupData.h (GUI Library)
 *
 * COMMENTS:
 */
#ifndef __GUI_GroupData_h__
#define __GUI_GroupData_h__

#include "GUI_API.h"
#include <GR/GR_Defines.h>
#include <GR/GR_TextureRef.h>
#include <GU/GU_Selection.h>
#include <GU/GU_SelectType.h>
#include <GA/GA_Types.h>
#include <RE/RE_RenderContext.h>
#include <RE/RE_Texture.h>
#include <UT/UT_IntrusivePtr.h>

#ifdef USE_VULKAN
#include <RV/RV_TypePtrs.h>
#endif

class RE_Render;
class RE_Geometry;
class RE_ShaderHandle;
class GUI_GeoRender;
class GR_CommonDispOption;
class GU_Detail;
class UT_Color;

class RV_VKImage;
class RV_VKBuffer;
class RV_ShaderProgram;
class RV_Geometry;

/// Holds information sbout groups for display in the viewport.
class GUI_API GUI_GroupData : public UT_IntrusiveRefCounter<GUI_GroupData>
{
public:
                                 GUI_GroupData(
                                     GUI_GeoRender &owner,
                                     const GR_CommonDispOption &options,
                                     RE_RenderContext r,
                                     GU_SelectionHandle *selection = nullptr,
                                     UT_StringHolder *name = nullptr);
                                ~GUI_GroupData();

    const UT_StringHolder       &groupMask() const;
    GA_GroupType                 groupType() const;
    GR_TextureRef                colorTexture() const;
    bool                         hasColorTexture() const;

    // These values are used for drawing primitive groups.
    RE_Texture                  *idTexture() const;
    RV_VKBuffer                 *idBuffer() const;
    int                          minId() const;
    int                          maxId() const;

    // These values are used for drawing point and edge groups.
    RE_ShaderHandle             *shader(bool uv_viewport) const;
    RE_Geometry                 *geometry() const;
    RV_ShaderProgram            *shader(RV_Render *r, bool uv_viewport) const;
    RV_Geometry                 *geometryVK() const;

    // Returns true if the provided mask specifies an adhoc group
    // (basically anything that isn't recognized as a connectivity
    // specifier, attribute range, or group name mask.
    static bool                  isAdhocGroupMask(const char *mask);

    // Returns a magic group name that is used to trigger the use of the
    // cook selection group from the detail, rather than a named group or  
    // an ad-hoc group.
    static UT_StringRef          cookSelectionGroupMask();
    
private:
    void                 createIdTexture(RE_RenderContext r,
                                const int *id_data,
                                int numids);
    void                 createColorTexture(RE_RenderContext r,
                                const UT_ValArray<uint8> &color_data);

    void                 createGeometry(RE_RenderContext r,
                                RE_PrimType              prim_type,
                                const UT_Vector3FArray  &pos,
                                const UT_Array<int32>   &id_data,
                                const UT_Vector3FArray  &ppos = UT_Vector3FArray(),
                                const UT_Vector3FArray  &npos = UT_Vector3FArray(),
                                exint                    min_id = 0,
                                exint                    max_id = SYS_EXINT_MAX);

    void                 initializePackedPrimsFromPoints(RE_RenderContext r,
                                const GU_Detail &gdp,
                                const UT_Array<int32> &id_data);
    void                 initializeFromConnectivity(RE_RenderContext  r);
    void                 initializeFromAttrib(RE_RenderContext r);
    void                 initializeFromAdhocGroup(RE_RenderContext r);

    bool                 initializeFromGroup(
                                RE_RenderContext r,
                                GA_GroupType type = GA_GROUP_INVALID,
                                const GA_Group *group = nullptr,
                                const UT_StringRef *name = nullptr,
                                const UT_Color *override_color = nullptr);
    void                 initializeFromPrimGroups(RE_RenderContext r,
                                const GA_PrimitiveGroup *group = nullptr,
                                const UT_StringRef *name = nullptr,
                                const UT_Color *override_color = nullptr);
    void                 initializeFromPointGroups(RE_RenderContext r,
                                const GA_PointGroup *group = nullptr,
                                const UT_StringRef *name = nullptr,
                                const UT_Color *override_color = nullptr);
    void                 initializeFromEdgeGroups(RE_RenderContext r,
                                const GA_EdgeGroup *group = nullptr,
                                const UT_StringRef *name = nullptr,
                                const UT_Color *override_color = nullptr);
    void                 initializeFromVertexGroups(RE_RenderContext r,
                                const GA_VertexGroup *group = nullptr,
                                const UT_StringRef *name = nullptr,
                                const UT_Color *override_color = nullptr);

    GUI_GeoRender       &myOwnerGeoRender;
    UT_StringHolder      myGroupMask;
    GA_GroupType         myGroupType;
    UT_StringHolder      myAttribName;
    UT_StringHolder      myAttribValueMask;
    GA_AttributeOwner    myAttribOwner;
    GU_Connectivity      myConnectivity;
    RE_Texture          *myColorTextureGL;

    RE_Texture          *myIdTextureGL;
    int                  myMinId;
    int                  myMaxId;

    RE_Geometry         *myGeometryGL;

#ifdef USE_VULKAN
    UT_UniquePtr<RV_VKImage>  myColorTextureVK;
    UT_UniquePtr<RV_VKBuffer> myIdBufferVK;
    UT_UniquePtr<RV_Geometry> myGeometryVK;
#endif
};

typedef UT_IntrusivePtr<const GUI_GroupData> GUI_GroupDataHandle;

#endif