MSS/MSS_EditState.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.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        MSS_EditState.h
 *
 * COMMENTS:
 *      This is the state for interactively editing geometry
 *      and attributes, used with the Edit SOP.
 */

#ifndef __MSS_EditState_H__
#define __MSS_EditState_H__

#include "MSS_API.h"
#include "MSS_SingleOpState.h"
#include "MSS_EditSelector.h"

#include <SOP/SOP_BrushBase.h>
#include <UT/UT_String.h>
#include <UT/UT_Vector2.h>
#include <GU/GU_Detail.h>
#include <GU/GU_RayIntersect.h>
#include <BM/BM_MoveTool.h>
#include "MSS_PaintSelector.h"

class UT_Matrix4;
class UI_Menu;
class OP_Context;
class PRM_Template;
class DM_Workbench;
class JEDI_View;
class SOP_Edit;
class SOP_Node;


class MSS_API MSS_EditState : public MSS_SingleOpState, public BM_MoveTool
{
public:
    // Class constructor and destructor.
             MSS_EditState(JEDI_View &view, PI_StateTemplate &templ,
                           BM_SceneManager *scene,
                           const char *cursor);
    virtual ~MSS_EditState();

    // This constructor and parameter template list go into the
    // DM_StateTemplate for this state.
    static BM_State     *ourConstructor(BM_View &view, PI_StateTemplate &templ,
                                        BM_SceneManager *scene);
    static PRM_Template  ourTemplateList[];
    static PRM_Template  ourToolTemplateList[];

    // The name and type of this class:
    virtual const char  *className() const;

    // Restart the selection...
    virtual void         restart();

    virtual void         stopGenerating();

    // Flatten selection to the c-plane
    void                 flattenSelection();

    virtual void         handleOpNodeChange(OP_Node &node);

    // Return 1 if the node is generated by a state that matches our name,
    // or if the node's name matches our name:
    virtual int          matchesNode(OP_Node &node) const;

    virtual UI_Menu     *getStateMenu(int ortho = 0);

    virtual void         setMoveToolType(Type move_type);
    virtual Type         getMoveToolType() const;

    virtual const char  *getOperationBarIconName() const;
    virtual const char  *getOperationBarLabel() const;

protected:
    // Events from menu or keyboard
    virtual int          handleKeyTypeEvent(UI_Event *event,
                                            BM_Viewport &/*viewport*/);
    
    // Generate the necessary nodes and connect them
    virtual bool         generateAllNodes();

    // Set the state's node
    virtual void         setNode(OP_Node *node);

    // If this state is reselecting and it tries to reselect within the same
    // node then that node's unique id is returned.  Otherwise, 0 is returned.
    virtual int          nodeIdToReselectWithin() const;

    SOP_Edit            *getEditSOP() const
                        { return (SOP_Edit *)BM_SingleOpState::getNode(); }

    // Convert an op menu entry to a brush operation:
    virtual SOP_BrushOp  menuToBrushOp(const UI_Value &menuvalue) const;

    virtual int          enter(BM_SimpleState::BM_EntryType how);
    virtual void         exit (void);
    virtual void         interrupt(BM_SimpleState * = 0);
    virtual void         resume   (BM_SimpleState * = 0);

    // We're done selecting and we've been successful. In this class we simply 
    // display the state prompt.
    virtual void         doneSelecting(void);
    
    // Respond to mouse or keyboard events.
    virtual int          handleMouseEvent(UI_Event *event);
    virtual int          handleParameterEvent(UI_Event *event);
    
    // Render the brush "cursor" geometry:
    virtual void         doRender(RE_Render *r, short x, short y, int ghost);

    UI_Value            &getPrimaryVal  () { return myPrimaryButtonVal; }
    UI_Value            &getSecondaryVal() { return mySecondaryButtonVal; }

    virtual void         updatePrompt();

    virtual bool         getSelectionBoundingBox( DM_Viewport &vport,
                                                  UT_BoundingBox &bbox );
  
    virtual bool         getAllowQuickSelect() const
                            {
                                return (myHandlingKeyEvent
                                        || !myDoingRestartFlag);
                            }

    virtual const char  *getTemplateName() const;

    virtual void         handleSelectionTypeChange(UI_Event *event);

    virtual void         updateCurrentSelector(
                                OP3D_InputSelector *cur_sel,
                                const PI_BindingSelectorInfo *selector_info);

    virtual bool         allowDeleteEmptyEditSops() const;

    virtual bool         allowOpMaxExportToDialog() const;

private:    // methods

    // Flattening functions
    void                 flattenPoints(
                                        SOP_Edit &node,
                                        const GB_PointGroup &grp);
    void                 flattenBreakpoints(
                                        SOP_Edit &node,
                                        const GB_BreakpointGroup &grp);

    void                 handleBrushShapeChange (UI_Event *event);
    void                 handleBrushOrientChange(UI_Event *event);
    void                 handleAccumStencilChange(UI_Event *event);
    void                 handlePrimaryTieChange(UI_Event *event);
    void                 handleSecondaryTieChange(UI_Event *event);

    // Set the appropriate operation whether we use the primary or secondary
    // mouse button.
    void                 usePrimaryButton  (void);
    void                 useSecondaryButton(void);

    int                  sendRay(UI_Event *event, bool isuv,
                                 float t, UT_Vector3 &rayorig,
                                 UT_Vector3 &hitpos,
                                 UT_Vector3 &dir, GU_RayInfo &hinfo,
                                 GEO_Point *&hitpt,
                                 float &scalehistory,
                                 int checkgeo);

    // This orients the cursor.
    void                 orientCursor(float t, const UT_Vector3 &hitpos,
                                      const UT_Vector3 &nml,
                                      float scalehistory,
                                      bool isuv,
                                      const GEO_Primitive *prim,
                                      float u, float v);
            
    // This rebuilds the cursor orientation from the last stashed
    // value.
    void                 reorientCursor();

    void                 updateFixedType();

    enum mssInputMode
    {
        mssEditMode,
        mssSculptMode
    };
    bool                 changeMode(mssInputMode new_mode);
    void                 modeChanged(); 

    void                 deleteEmptyEditSopIfNeeded();
    void                 updateDetailLookSelection(OP_Context &context,
                                                   SOP_Node &sop);

private:    // data
    SOP_Edit            *mySavedEditNode;
    GU_RayIntersect      myRayIntersect;
    GU_Detail            myBrushCursor;
    UT_Matrix4           myBrushCursorXform;
    bool                 myRenderBrushCursor;
    bool                 myBrushCursorIsUV;
    bool                 myOneHit;
    bool                 myLocatedFlag;
    UT_Vector2           myOldCoord;

    // These are used track the resizing of the cursor in the viewport
    bool                 myResizingCursor;
    short                myLastCursorX, myLastCursorY;

    // This is used to stash the last valid cursor orientation.
    // This allows us to rebuild the orientation to resize on
    // the users request without reintersecting.
    bool                 myOldOrientValid;
    float                myOldOrientT;
    UT_Vector3           myOldOrientHitPos;
    UT_Vector3           myOldOrientHitNml;
    float                myOldOrientScaleHistory;
    bool                 myOldOrientIsUV;
    const GEO_Primitive *myOldOrientHitPrim;
    float                myOldOrientHitU;
    float                myOldOrientHitV;

    UI_Value             myPrimaryButtonVal;
    UI_Value             mySecondaryButtonVal;
    UI_Value             myBrushShapeVal;
    UI_Value             myBrushOrientVal;
    UI_Value             myAccumStencilVal;

    UT_IntArray          myOldEditSops;

    bool                 myFirstEntry:1,
                         myHandlingKeyEvent:1,
                         myDoingRestartFlag:1;

    BM_MoveTool::Type    myMoveType;
    UT_String            myToolMenuName;

    mssInputMode         myInputMode;
    static mssInputMode  theLastInputMode;
};

#endif

---