IViewportShadingMgr.h

Go to the documentation of this file.

/**********************************************************************
*<
FILE:           IViewportShadingMgr.h

DESCRIPTION:    Core interface to control siewport shading, including shadows

CREATED BY:     Neil Hazzard

HISTORY:        created March 8th, 2007

*>  Copyright (c) 2007, All Rights Reserved.
**********************************************************************/

#pragma once

#include "iFnPub.h"
#include "GetCOREInterface.h"
// forward declarations
class ViewExp;

#define IVIEWPORTSHADINGMGR_INTERFACE Interface_ID(0x7eba45d1, 0x2b3d454b)
#define IVIEWPORTSHADINGMGR2_INTERFACE Interface_ID(0x245b423f, 0x9df3b47)


class IViewportShadingMgr : public FPStaticInterface
{

public:
    enum EViewportDisplayQuality
    {
        kNone,  
        kGood,  
        kBest,  
    };

    enum EViewportLightFlags{
        kShadowCasting, 
        kIlluminating,  
        kLocked,        
    };
    

    virtual void SetViewportShadingLimits(int limit, bool bQuiet = true)=0;


    virtual int GetViewportShadingLimits()=0;


    virtual bool GetAutoDisplayOfSelLights()=0;


    virtual void SetAutoDisplayOfSelLights(bool bSet)=0;


    virtual void SetCastShadowDefaultLights(bool bSet)=0;


    virtual bool GetCastShadowDefaultLights()=0;


    virtual void DisplayOnlySelectedLights()=0;


    virtual void LockSelectedLights(bool bSet)=0;


    virtual void GetViewportShadingLights(Tab<INode*> &lightList, int type) = 0;


    virtual void SetGlobalShadowIntensity(float intensity) = 0;


    virtual float GetGlobalShadowIntensity()=0;


    virtual void SetUseTransparencyInShadows(bool bSet) = 0;


    virtual bool GetUseTransparencyInShadows() = 0;


    virtual void SetUpdateShadowInActiveViewOnly(bool bSet) =0;


    virtual bool GetUpdateShadowInActiveViewOnly()=0;


    virtual bool IsShadingLimitValid(int limit)=0;


    virtual Color GetLightIconColor(INode &lightNode)=0;

    virtual void SetUseTransparencyInGI(bool bSet) =0;

    virtual bool GetUseTransparencyInGI() = 0;


    virtual void SetShadowFilterSize(float filterSize)=0;


    virtual float GetShadowFilterSize()=0;

};

class IViewportShadingMgr2  : public IViewportShadingMgr
{
public:
    //* Get the active viewport's hardware enabled flag.  
    virtual bool IsHWShadingEnabled(bool bCurrentlyTraversed = false)const=0;


    virtual bool IsHWShadingEnabled(const ViewExp &view)const=0;
};


inline IViewportShadingMgr* GetIViewportShadingMgr() {

    return dynamic_cast<IViewportShadingMgr*>(GetCOREInterface(IVIEWPORTSHADINGMGR_INTERFACE));
};

inline IViewportShadingMgr2* GetIViewportShadingMgr2() 
{
    IViewportShadingMgr * lpVpMgr = GetIViewportShadingMgr();
    return dynamic_cast<IViewportShadingMgr2*>(lpVpMgr->GetInterface(IVIEWPORTSHADINGMGR2_INTERFACE));
};