GOP_VertexGroupParser.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.
 *
 * COMMENTS:  This class contains a parser for the vertex groups.
 *            The doIt() method returns the number of vertices parsed,
 *            or -1 if an error has occured.
 *
 */

#ifndef __GOP_VertexGroupParser_h__
#define __GOP_VertexGroupParser_h__

#include "GOP_API.h"
#include "GOP_Parser.h"
#include <GA/GA_ElementGroup.h>
#include <GA/GA_Types.h>

class GEO_Detail;
class GOP_Manager;
class GA_VertexGroup;

class GOP_API GOP_VertexGroupParser : public GOP_Parser
{
public:
    // When an ordered group is requested and an order needs to be imposed by
    // this parser, it uses the primitive vertex order, not the vertex index
    // map order.
    GOP_VertexGroupParser(GOP_Manager *manager, const GEO_Detail &gdp,
                          const UT_String &str, bool strict = true,
                          GA_Index prim_offset = GA_Index(0),
                          bool ordered = false);

    // Build a string that contains the id's of the vertices in a vertex
    // group.  The offset is the amount to add to the ids of the primitives for
    // each vertex in the group.
    static void          buildGroupToken(const GA_VertexGroup *vtxgrp,
                                         UT_String &token,
                                         GA_Index offset = GA_Index(0),
                                         bool ordered = false);

    // Build a string representing a single vertex element.  The offset is the
    // amount to add to the id of the primitive.
    static void          buildElementToken(const GEO_Detail *gdp,
                                           GA_Offset vertex, UT_String &token,
                                           GA_Index offset = GA_Index(0));

private:

    void                init() override;
    void                finish() override;
    bool                dispatch(char c) override;
    
    // State Handlers
    void                handleStart() override;
    void                handleError() override;

    void                handleCollectPrim();
    void                handleCollectPrim1();
    void                handleCollectName();
    void                handleCollectVertex0();
    void                handleCollectVertex1();

    // State Variables  
    GA_Index            myPrimIndex;
    GA_Index            myPrim1;
    int                 myVertex0;
    int                 myVertex1;

    // Vertex Specific Methods
    bool                addVertex();
    bool                addAllPrimVertices(GA_Offset primoff = GA_INVALID_OFFSET);
    bool                addVertexRange(int u0, int u1);
    bool                addPrimGroup(const char *name);
    bool                addVertexGroup(const char *name);

    // Primitive Specific Methods
    bool                addPrimRange(int u0, int u1);

    // Utility methods
    GA_Offset           getPrim();

    
    const GEO_Detail    &myGdp;
    GA_VertexGroupUPtr   myGroup;
    GOP_Manager         *myManager;
    bool                 myStrictFlag;
    bool                 myOrderedFlag;
    GA_Index             myPrimOffset;
};


#endif