interface.h

Go to the documentation of this file.

#ifndef LWPP_INTERFACE_H
#define LWPP_INTERFACE_H

#include <lwpp/global.h>

// For the schematicPosition function
#include <lwpp/point3d.h>

// Standard C++ Library includes
#include <vector>

namespace lwpp
{
  class LWItem; // Forward declaration

  class InterfaceInfo : protected GlobalBase<LWInterfaceInfo>
  {
    private:
      std::vector<LWItem *> selItems;

    public:
      InterfaceInfo( void ) { ; }

      // CURRENT TIME
      LWTime currentTime(void)
      {
        if (globPtr) return globPtr->curTime;
        else return 0;
      }

      // SELECTED ITEMS
      // const LWItem selectedItem( void );
      lwpp::LWItem selectedItem( ) const;

      std::vector<lwpp::LWItem> selectedItems() const;

      //ITEM FLAGS
      unsigned int itemFlags(LWItemID item)
      {
        if (globPtr) return globPtr->itemFlags(item);
        return 0;
      }

      // PREVIEW OPTIONS
      LWFrame previewStart(void)
      {
        if (globPtr) return globPtr->previewStart;
        return 0;
      }
      LWFrame previewEnd(void)
      {
        if (globPtr) return globPtr->previewEnd;
        return 0;
      }
      LWFrame previewStep(void)
      {
        if (globPtr) return globPtr->previewStep;
        return 0;
      }

      // DYNAMIC UPDATE
      int dynamicUpdate(void)
      {
        if (globPtr) return (globPtr->dynaUpdate);
        return 0;
      }
      bool isDynamicUpdateOff(void)
      {
        return (dynamicUpdate() & LWDYNUP_OFF);
      }
      bool isDynamicUpdateDelayed(void)
      {
        return (dynamicUpdate() & LWDYNUP_DELAYED) != 0;
      }
      bool isDynamicUpdateInteractive(void)
      {
        return (dynamicUpdate() & LWDYNUP_INTERACTIVE)!= 0;
      }

      // SCHEMATIC POSITION
      Point3d schematicPosition(LWItemID item)
      {
        if (globPtr)
        {
          double x, y;
          globPtr->schemaPos(item, &x, &y);
          return Point3d (x,y,0);
        }
        return Point3d();
      }

      // ITEM DISPLAY
      int itemVisibility(LWItemID item)
      {
        if (globPtr) return globPtr->itemVis(item);
        return 0;
      }
      bool isItemHidden(LWItemID item)
      {
        return (itemVisibility(item) & LWOVIS_HIDDEN);
      }
      bool isItemBBox(LWItemID item)
      {
        return (itemVisibility(item) & LWOVIS_BOUNDINGBOX) !=0;
      }
      bool isItemVertices(LWItemID item)
      {
        return (itemVisibility(item) & LWOVIS_VERTICES) !=0;
      }
      bool isItemWireframe(LWItemID item)
      {
        return (itemVisibility(item) & LWOVIS_WIREFRAME) !=0;
      }
      bool isItemFrontFace(LWItemID item)
      {
        return (itemVisibility(item) & LWOVIS_FFWIREFRAME) !=0;
      }
      bool isItemShaded(LWItemID item)
      {
        return (itemVisibility(item) & LWOVIS_SHADED) !=0;
      }
      bool isItemTextured(LWItemID item)
      {
        return (itemVisibility(item) & LWOVIS_TEXTURED) !=0;
      }
      bool isItemTexturedShaded(LWItemID item)
      {
        return (itemVisibility(item) & LWOVIS_TEXTURED_WIRE) !=0;
      }

      // DISPLAY FLAGS
      unsigned int displayFlags(void)
      {
        if (globPtr) return globPtr->displayFlags;
        return 0;
      }
      bool isMotionPathsDisplayed( void )
      {
        return (displayFlags()  & LWDISPF_MOTIONPATHS) !=0;
      }
      bool isHandlesDisplayed( void )
      {
        return (displayFlags()  & LWDISPF_HANDLES) !=0;
      }
      bool isIKChainsDisplayed( void )
      {
        return (displayFlags()  & LWDISPF_IKCHAINS) !=0;
      }
      bool isCagesDisplayed( void )
      {
        return (displayFlags()  & LWDISPF_CAGES) !=0;
      }
      bool isSafeAreasDisplayed( void )
      {
        return (displayFlags()  & LWDISPF_SAFEAREAS) !=0;
      }
      bool isFieldChartDisplayed( void )
      {
        return (displayFlags()  & LWDISPF_FIELDCHART) !=0;
      }

      // GENERAL FLAGS
      unsigned int generalFlags(void)
      {
        if (globPtr) return globPtr->generalFlags;
        return 0;
      }
      bool isToolBarHidden( void )
      {
        return (generalFlags()  & LWGENF_HIDETOOLBAR) !=0;
      }
      bool isToolBarRight( void )
      {
        return (generalFlags()  & LWGENF_RIGHTTOOLBAR) !=0;
      }
      bool isParentInPlace( void )
      {
        return (generalFlags()  & LWGENF_PARENTINPLACE) !=0;
      }
      bool isFractionalFrames( void )
      {
        return (generalFlags()  & LWGENF_FRACTIONALFRAME) !=0;
      }
      bool isKeyFramesVisible( void )
      {
        return (generalFlags()  & LWGENF_KEYSINSLIDER) !=0;
      }
      bool isPlayAtExactRate( void )
      {
        return (generalFlags()  & LWGENF_PLAYEXACTRATE) !=0;
      }
      bool isAutoKeyOn( void )
      {
        return (generalFlags()  & LWGENF_AUTOKEY) !=0;
      }
      bool isIKOn( void )
      {
        return (generalFlags()  & LWGENF_IKENABLE) !=0;
      }
      bool isLMBSelectionOn( void )
      {
        return (generalFlags()  & LWGENF_LMBITEMSELECT) !=0;
      }
#if (LW_SDK >= 96)

      bool isDBLClickBoneOn( void )
      {
        return (generalFlags()  & LWGENF_DOUBLECLICKBONEMODE) !=0;
      }
      bool isMotionControllersOn( void )
      {
        return (generalFlags()  & LWGENF_MCENABLE) !=0;
      }
#endif
      // BOUNDINGBOX THRESHOLD
      int boxThreshold()
      {
        if (globPtr) return (globPtr->boxThreshold);
        return 0;
      }

      // ALERT LEVELS
      int alertLevel(void)
      {
        if (globPtr) return globPtr->alertLevel;
        else return 0;
      }
      bool showInfo(void) {return (alertLevel() <= LWALERT_BEGINNER);}
      bool showWarning(void) {return (alertLevel() <= LWALERT_INTERMEDIATE);}
      bool showError(void) {return (alertLevel() <= LWALERT_EXPERT);}

      //AUTO KEY
      int autoKeyCreate()
      {
        if (globPtr) return globPtr->autoKeyCreate;
        return 0;
      }
      bool isAutoKeyCreateOff(void)
      {
        return (autoKeyCreate() == LWAKC_OFF);
      }
      bool isAutoKeyCreateModChannels(void)
      {
        return (autoKeyCreate() == LWAKC_MODIFIED);
      }
      bool isAutoKeyCreateAllChannels(void)
      {
        return (autoKeyCreate() == LWAKC_ALL);
      }

      // ITEM COLORS
      int  itemColor  (LWItemID item)
      {
        if (globPtr) return globPtr->itemColor(item);
        else return 0;
      }

      void setItemColorIndex(LWItemID item, int color)
      {
        if (globPtr) globPtr->setItemColorIndex(item, color);
      }

      void setItemColorCustom(LWItemID item, double *color)
      {
        if (globPtr) globPtr->setItemColorCustom(item, color);
      }
#if (LW_SDK >= 92)


      void setObjectsDefaultColor(float color)
      {
        if (globPtr) globPtr->defaultItemTypeColor(LWI_OBJECT, &color, 1);
      }

      void setLightsDefaultColor(float color)
      {
        if (globPtr) globPtr->defaultItemTypeColor(LWI_LIGHT, &color, 1);
      }

      void setCamerasDefaultColor(float color[3])
      {
        if (globPtr) globPtr->defaultItemTypeColor(LWI_CAMERA, color, 1);
      }

      void setBonesDefaultColor(float color[3])
      {
        if (globPtr) globPtr->defaultItemTypeColor(LWI_BONE, color, 1);
      }

      void getObjectsDefaultColor(float color[3])
      {
        if (globPtr) globPtr->defaultItemTypeColor(LWI_OBJECT, color, 0);
      }

      void getLightsDefaultColor(float color[3])
      {
        if (globPtr) globPtr->defaultItemTypeColor(LWI_LIGHT, color, 0);
      }

      void getCamerasDefaultColor(float color[3])
      {
        if (globPtr) globPtr->defaultItemTypeColor(LWI_CAMERA, color, 0);
      }

      void getBonesDefaultColor(float color[3])
      {
        if (globPtr) globPtr->defaultItemTypeColor(LWI_BONE, color, 0);
      }
#if (LW_SDK >= 96)
      void getItemColour( LWItemID item, unsigned int state, float rgba[4])
      {
        if (globPtr) globPtr->itemColorRgba(item, state, rgba);
      }
      void getItemColour( LWItemID item, float rgba[4])
      {
        getItemColour(item, LWITEMCOL_CURRENT, rgba);
      }
#else
      void getItemColour( LWItemID item, float rgba[4])
      {
        if (globPtr) globPtr->itemColorRgba(item, rgba);
      }
#endif

#if (LW_SDK >= 96)



      void getItemsCurrentColor( LWItemID item, float rgba[4])
      {
        if (globPtr) globPtr->itemColorRgba(item, LWITEMCOL_CURRENT, rgba);
      }
      void getItemsNormalColor( LWItemID item, float rgba[4])
      {
        if (globPtr) globPtr->itemColorRgba(item, LWITEMCOL_NORMAL, rgba);
      }
      void getItemsSelectedColor( LWItemID item, float rgba[4])
      {
        if (globPtr) globPtr->itemColorRgba(item, LWITEMCOL_SELECTED, rgba);
      }
#endif // LW_SDK 96+


      float getItemIconScale( LWItemID item)
      {
        if (globPtr) return globPtr->itemIconScale(item);
        return 1.0;
      }
#endif
  };
}

#endif

// OLD VERSION //
//#ifndef LWPP_INTERFACE_H
//#define LWPP_INTERFACE_H
//
//#include <lwpp/global.h>
//
//namespace lwpp
//{
//
//  class LWItem; // Forward declaration
//
//  //! @ingroup Globals
//  class InterfaceInfo : protected GlobalBase<LWInterfaceInfo>
//  {
//    public:
//      InterfaceInfo( void ) { ; }
//
//      // CURRENT TIME
//      //! Returns the current time indicated by the frame slider on Layout
//      LWTime currentTime(void)
//      {
//        if (globPtr) return globPtr->curTime;
//        else return 0;
//      }
//
//      // SELECTED ITEMS
//      //! Returns the lwpp::LWItem of the selected Item in Layout, or the first selected item of a multiple selection
//      void * selectedItem( void );
//
//
//      int alertLevel(void)
//      {
//        if (globPtr) return globPtr->alertLevel;
//        else return 0;
//      }
//      bool showInfo() {return (alertLevel() <= LWALERT_BEGINNER);}
//      bool showWarning() {return (alertLevel() <= LWALERT_INTERMEDIATE);}
//      bool showError() {return (alertLevel() <= LWALERT_EXPERT);}
//      int  itemColor  (LWItemID id)
//      {
//        return globPtr->itemColor(id);
//      }
//  };
//
//}
//
//typedef struct st_LWInterfaceInfo {
//        LWTime            curTime;
//        const LWItemID   *selItems;
//        unsigned int    (*itemFlags)     (LWItemID);
//        LWFrame           previewStart;
//        LWFrame           previewEnd;
//        LWFrame           previewStep;
//        int               dynaUpdate;
//        void            (*schemaPos)     (LWItemID, double *x, double *y);
//        int             (*itemVis)       (LWItemID);
//        unsigned int      displayFlags;
//        unsigned int      generalFlags;
//        int               boxThreshold;
//        int             (*itemColor)     (LWItemID);
//        int               alertLevel;
//        int               autoKeyCreate;
//} LWInterfaceInfo;
//*/
//
//#endif