MSS/MSS_SingleOpBaseState.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:
 *      Magdalena Georgescu
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        MSS_SingleOpBaseState.h
 *
 * COMMENTS:
 *      Parent class for SOP custom states.
 *
 */

#ifndef __MSS_SingleOpBaseState_H__
#define __MSS_SingleOpBaseState_H__

#include "MSS_API.h"
#include <BM/BM_SingleOpState.h>

class DM_Workbench;
class OP3D_View;
class JEDI_View;

class MSS_API MSS_SingleOpBaseState : public BM_SingleOpState
{
public:
    MSS_SingleOpBaseState(JEDI_View &view, PI_StateTemplate &templ,
                          BM_SceneManager *scene,
                          const char *cursor = BM_DEFAULT_CURSOR);
    virtual ~MSS_SingleOpBaseState(void);

    virtual const char  *className() const;

protected:
    // Provide the Op to work with. The criteria for which OP to use will
    // be specific to each network type. This method does NOT overwrite
    // the myOpNode pointer.
    virtual OP_Node     *getChosenOp(void) const;

    // Return the directory name for the UI file.
    virtual const char  *getUIDirectory() const;

    // Set the flags (display/current) of the given node:
    virtual void         setNodeFlags(OP_Node &node);

    // Respond to keyboard events
    virtual int          handleKeyTypeEvent(UI_Event *event, BM_Viewport &);

    // This depends on the secure selection button and 
    // whether a selector is active.
    virtual bool         isSelecting() const;
    virtual bool         needSelectMask() const { return true; }

    // map viewport coordinates to worldspace location and direction
    void                 mapToWorld(float x, float y,
                                    UT_Vector3 &dir, UT_Vector3 &rayorig);

    // get worldspace to cameraspace transform
    void                 getViewportTransform(UT_Matrix4 &xform);
    // get cameraspace to worldspace transform
    void                 getViewportItransform(UT_Matrix4 &xform);

    // get level of detail for the viewport
    float                getViewportLOD() const;

    // set the prompt's text
    void                 showPrompt(const char *msg);

          JEDI_View     &viewer()       { return (JEDI_View &)baseViewer(); }
    const JEDI_View     &viewer() const { return (JEDI_View &)baseViewer(); }

          DM_Workbench  &workbench()
                                    { return (DM_Workbench &)sceneManager(); }
    const DM_Workbench  &workbench() const
                                    { return (DM_Workbench &)sceneManager(); }
    
private:
};

#endif

---