MSS/MSS_CaptureLayerPaintState.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_CaptureLayerPaintState.h
 *
 * COMMENTS:
 *      This is the state for interactively painting geometry with brushes.
 */

#ifndef __MSS_CaptureLayerPaintState_H__
#define __MSS_CaptureLayerPaintState_H__

#include "MSS_API.h"
#include <BM/BM_SimpleState.h>
#include <OP/OP_Value.h>
#include <PRM/PRM_ChoiceList.h>
#include <UT/UT_PtrArray.h>
#include <UT/UT_RefArray.h>
#include <UT/UT_String.h>
#include "MSS_PaintBaseState.h"

class OP_Node;
class SOP_CaptureLayerPaint;

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

    // 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 *getTemplateList();

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

    /// Enters the Capture Layer Paint state.
    virtual int         enter(BM_SimpleState::BM_EntryType how);

    // Extra status information that this state will give to the display
    // manager.  In this case, the name of the currently selected region
    // and what kind of capture we're doing (metaball vs. bone).
    virtual void        status(UT_String &status_string) const;

    // Render the colour of the currently selected region.
    virtual void        renderStatusExtras(RE_Render *r);

    /// Builds the "Layer" menu.
    static void         buildLayerMenu( void *data, PRM_Name *menu, int count,
                                        const PRM_SpareData *, PRM_Parm * );

    /// Builds the capture "Region" menu.
    static void         buildRegionMenu(void *data, PRM_Name *menu, int count,
                                        const PRM_SpareData *sd, PRM_Parm *p);

protected:

    // Convert an op menu entry to a brush operation:
    virtual SOP_BrushOp  menuToBrushOp(const UI_Value &menuvalue) const;
    virtual int          handleMouseEvent(UI_Event *event);
    virtual int          handleKeyTypeEvent(UI_Event *, BM_Viewport &);

    virtual bool         getSelectionBoundingBox( DM_Viewport &vport,
                                                  UT_BoundingBox &bbox );
    virtual void         updatePrompt();

    virtual void         doRender(RE_Render *r, short x, short y, int ghost);
    
    /// Renders highlight for "current" bone.
    virtual void         doRenderBoneHighlight(RE_Render *r, short x, 
                                               short y, int ghost, 
                                               SOP_CaptureLayerPaint *captSop);

    /// Region menu handlers.
    static int          handleRegionMenuStatic(void *o, int index, float t,
                                               const PRM_Template *);

    /// Layer menu handlers.
    static bool         buildLayerMenuCallback(OP_Node &op, void *o);
    static int          handleLayerMenuStatic(void *o, int index, float t,
                                              const PRM_Template *);

    /// Op event handler.
    virtual void        handleOpEvent(OP_Node *caller, OP_EventType event_type,
                                      void *data );

    /// State parameter event handler.
    virtual int         handleParameterEvent( UI_Event *event );

    /// Get a human-readable name for the current operation deined by the
    /// value of the relevant menu (pass this getPrimaryVal() or
    /// getSecondaryVal()).
    const char          *getOpName(UI_Value &val);

    /// Sets the current node for this state.
    virtual void                 setNode(OP_Node *node);
  
    static PRM_ChoiceList        theLMBMenu;
    static PRM_ChoiceList        theMMBMenu;

private:

    UT_String                    myPreviousBone;
    
    UT_PtrArray<OP_Node *>       myLayers;
};

#endif

---