fbshader.h

Go to the documentation of this file.

#ifndef _FB_SHADER_H_
#define _FB_SHADER_H_
/**************************************************************************
Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
All Rights Reserved.

The coded instructions, statements, computer programs, and/or related 
material (collectively the "Data") in these files contain unpublished 
information proprietary to Autodesk, Inc. and/or its licensors, which is 
protected by Canada and United States of America federal copyright law 
and by international treaties.

The Data may not be disclosed or distributed to third parties, in whole 
or in part, without the prior written consent of Autodesk, Inc. 
("Autodesk").

THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
FREE.

IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL 

#define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbcore.h>

K_FORWARD( KRenderOptions );
K_FORWARD( KModelRenderInfo );
K_FORWARD( KShaderModelInfo );

#ifdef FBSDKUseNamespace
namespace FBSDKNamespace {
#endif

#define FBRegisterShader( UniqueNameStr, ClassName, Label, Description, IconFilename ) \
    HIObject RegisterShader##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
    ClassName *Class = new ClassName( pName ); \
    Class->UniqueName = UniqueNameStr; \
    Class->ShaderDescription = Description; \
    if (Class->FBCreate()) { \
    return Class->GetHIObject(); \
    } else { \
    delete Class; \
    return NULL; \
    } \
} \
    FBLibraryModule( ClassName )    \
    {   \
    FBRegisterObject( ClassName##R1,"renderer/usershader/ogl",Label,Description,RegisterShader##ClassName,true, IconFilename ); \
    FBRegisterObject( ClassName##R2,"FbxStorable/Shader",UniqueNameStr,Description,RegisterShader##ClassName,true, IconFilename );  \
}

#define FBShaderDeclare( ClassName, Parent  ) \
    FBClassDeclare( ClassName,Parent); \
public: \
    ClassName(const char* pName):Parent(pName) { FBClassInit; } \
private:

#define FBShaderImplementation( ThisComponent ) \
    FBClassImplementation( ThisComponent )

    // FBShaderManager
    FB_FORWARD( FBShaderManager );
    FB_FORWARD( FBShader );
    FB_FORWARD( FBMaterial );
    FB_FORWARD( FBCamera );

    class FBSDK_DLL FBShaderManager
    {
        FBShaderManager( const FBShaderManager& );

        FBShaderManager& operator=( const FBShaderManager& );

    public:

        FBShaderManager();

        ~FBShaderManager();

        FBShader* CreateShader( const char* pShaderTypeName );

        FBStringList ShaderTypeNames;

        FBStringList ShaderTypeNamesLocalized;
    };


    // FBShader - Shader layer on top of internals.

    FB_FORWARD( FBShaderModelInfo );
    class FBSDK_DLL FBShaderModelInfo
    {
    public:
        FBShaderModelInfo(FBShader* pShader, HKModelRenderInfo pInfo, int pSubRegionIndex);
        virtual ~FBShaderModelInfo();

        virtual void UpdateModelShaderInfo(int pShader_Version);

        FBModel* GetFBModel() { return mFBModel; }

        FBMaterial* GetFBMaterial();

        int GetSubRegionIndex();

        KShaderModelInfo* GetShaderModelInfo() const { return mLocalPtr; }

        int GetModelVersion() const;

        int GetShaderVersion() const;

        bool GetOriginalTextureFlag() const;

        unsigned int GetGeometryArrayIds() const; 

        void SetGeometryArrayIds(unsigned int pArrayIds); 

    private:
        KShaderModelInfo* mLocalPtr;
        FBModel*    mFBModel;
    };

    FB_FORWARD( FBViewingOptions );
    FB_FORWARD( FBRenderOptions );

    class FBSDK_DLL FBRenderOptions
    {
    public:
        FBRenderOptions(HKRenderOptions pOptions);

        FBCamera* GetRenderingCamera();

        int GetRenderFrameId() const;

        K_DEPRECATED_2014 bool IsIDBufferPicking() const;

        bool IsIDBufferRendering() const;

        float GetIDBufferPickingAlphaThreshold() const;

        bool IsOfflineRendering() const;

        FBViewingOptions* GetViewerOptions() const;

#ifndef DOXYGEN_SHOULD_SKIP_THIS

        HKRenderOptions mRenderOptions;
#endif
    };


    enum FBRenderingPass {
        kFBPassInvalid                  = 0,        
        kFBPassPreRender                = 1 << 0,   
        kFBPassFlat                     = 1 << 1,   
        kFBPassLighted                  = 1 << 2,   
        kFBPassMatte                    = 1 << 3,   
        kFBPassZTranslucent             = 1 << 4,   
        kFBPassZTranslucentAlphaTest    = 1 << 5,   
        kFBPassTranslucent              = 1 << 6,   
        kFBPassAddColor                 = 1 << 7,   
        kFBPassTranslucentZSort         = 1 << 8,   
        kFBPassPostRender               = 1 << 9    
    };
    FB_DEFINE_ENUM( FBSDK_DLL, RenderingPass );

    enum FBAlphaSource
    {
        kFBAlphaSourceNoAlpha               ,   
        kFBAlphaSourceAccurateAlpha         ,   
        kFBAlphaSourceTransluscentAlpha     ,   
        kFBAlphaSourceMatteAlpha            ,   
        kFBAlphaSource2DTransparency        ,   
        kFBAlphaSourceAdditiveAlpha         ,   
        kFBAlphaSourceTransluscentZSortAlpha,   
    };
    FB_DEFINE_ENUM( FBSDK_DLL, AlphaSource );

    enum FBShaderCapacity
    { 
        kFBShaderCapacityNone            = 0,
        kFBShaderCapacityMaterialEffect  = 1 << 0,     
        kFBShaderCapacityDrawInstanced   = 1 << 1,     
        kFBShaderCapacityDrawShadow      = 1 << 2,     
        kFBShaderCapactiyDrawTextureLayer= 1 << 3      
    };
    FB_DEFINE_ENUM( FBSDK_DLL, ShaderCapacity );

    enum FBShaderPassActionCallback
    {
        kFBShaderPassActionNone         = 0,  
        kFBShaderPassTypeBegin          = 1 << 0,
        kFBShaderPassTypeEnd            = 1 << 1,
        kFBShaderPassInstanceBegin      = 1 << 2, 
        kFBShaderPassInstanceEnd        = 1 << 3, 
        kFBShaderPassMaterialBegin      = 1 << 4, 
        kFBShaderPassMaterialEnd        = 1 << 5,
        kFBShaderPassGeometryBegin      = 1 << 6,
        kFBShaderPassGeometryEnd        = 1 << 7,
        kFBShaderPassModelsDraw         = 1 << 8,
        kFBShaderPassModelDraw          = 1 << 9
    };
    FB_DEFINE_ENUM( FBSDK_DLL, ShaderPassActionCallback );

    FB_FORWARD( FBRenderer );
    __FB_FORWARD( FBShader );
    FB_DEFINE_COMPONENT ( FBSDK_DLL, Shader );
    FB_DEFINE_LIST      ( FBSDK_DLL, Shader );

    class FBSDK_DLL FBShader : public FBBox
    {
        //--- Open Reality declaration.
        __FBClassDeclare( FBShader, FBBox );

    public:
        FBShader( const char* pName, HIObject pObject=NULL);

        IObject_Declare(K_IMPLEMENTATION);      // Interface to IObject.

        virtual FBShaderModelInfo* NewShaderModelInfo(HKModelRenderInfo pModelRenderInfo, int pSubRegionIndex);

        virtual void UpdateModelShaderInfo( FBRenderOptions* pOptions, FBShaderModelInfo* pInfo );

        virtual void DestroyShaderModelInfo( FBRenderOptions* pOptions, FBShaderModelInfo* pInfo );

        virtual void ReplaceAll( FBModel* pModel );

        virtual void Append( FBModel* pModel );

        virtual bool ShaderNeedBeginRender();

        virtual void ShaderBeginRender( FBRenderOptions* pOptions, FBShaderModelInfo* pInfo );

        virtual void ShadeModel( FBRenderOptions* pOptions, FBShaderModelInfo* pInfo, FBRenderingPass pPass );

        virtual void ShadeModelShadow(FBRenderOptions* pRenderOptions, FBShaderModelInfo* pInfo);


        virtual void ShaderPassTypeBegin    ( FBRenderOptions* pRenderOptions, FBRenderingPass pPass);  

        virtual void ShaderPassTypeEnd      ( FBRenderOptions* pRenderOptions, FBRenderingPass pPass);     

        virtual void ShaderPassInstanceBegin( FBRenderOptions* pRenderOptions, FBRenderingPass pPass);  

        virtual void ShaderPassInstanceEnd  ( FBRenderOptions* pRenderOptions, FBRenderingPass pPass);  

        virtual void ShaderPassMaterialBegin( FBRenderOptions* pRenderOptions, FBRenderingPass pPass, FBShaderModelInfo* pInfo);  

        virtual void ShaderPassMaterialEnd  ( FBRenderOptions* pRenderOptions, FBRenderingPass pPass, FBShaderModelInfo* pInfo);  

        virtual void ShaderPassGeometryBegin( FBRenderOptions* pRenderOptions, FBRenderingPass pPass, FBShaderModelInfo* pInfo);  

        virtual void ShaderPassGeometryEnd  ( FBRenderOptions* pRenderOptions, FBRenderingPass pPass, FBShaderModelInfo* pInfo);
    
        virtual void ShaderPassModelsDraw ( FBRenderOptions* pRenderOptions, FBRenderingPass pPass, const FBArrayTemplate<FBShaderModelInfo*>& pInfoArray);

        virtual void ShaderPassModelDraw ( FBRenderOptions* pRenderOptions, FBRenderingPass pPass, FBShaderModelInfo* pInfo);

        virtual void ShaderPassDrawShadowBegin( FBRenderOptions* pRenderOptions);

        virtual void ShaderPassDrawShadowEnd ( FBRenderOptions* pRenderOptions);

        FBShaderPassActionCallback   GetShaderPassActionCallback() const;
        void         SetShaderPassActionCallback( FBShaderPassActionCallback pCallback);
   

        virtual void CloneShaderParameter( FBShader* pNewShader );

        virtual void DetachDisplayContext( FBRenderOptions* pOptions, FBShaderModelInfo* pInfo );

        virtual bool FbxStore   (FBFbxObject* pFbxObject);

        virtual bool FbxRetrieve(FBFbxObject* pFbxObject, FBRenderer* pRenderer);

        const char* ShaderDescription;  

        void    InvalidateShaderVersion ();

        int     GetShaderVersion        ()  const;

        FBShaderCapacity GetShaderCapacity( ) const;

        bool         HasShaderCapacity    (FBShaderCapacity pCapacity);  

        void         SetShaderCapacity    (FBShaderCapacity pCapacity, bool pOn);

        int          GetDrawInstancedMaximumSize() const;

        void         SetDrawInstancedMaximumSize(int pMaxSize);

        virtual void UploadModelViewMatrixArrayForDrawInstanced(const double* pModelViewMatrixArray, int pCount);


    public:
        FBPropertyBool              Enable;

        FBPropertyRenderingPass     RenderingPass;

    protected:
        static FBRenderingPass GetRenderingPassNeededForAlpha(FBAlphaSource pTransparency);
    };

    // FBPropertyListShader - List of shaders
    class FBSDK_DLL FBPropertyListShader : public FBPropertyListComponent
    {
    public:
        FBPropertyListShader();
        FBShader* operator[](int pIndex);
    };

    // FBShaderLighted
    FB_FORWARD( FBShaderLighted );
    FB_DEFINE_COMPONENT( FBSDK_DLL, ShaderLighted );

    class FBSDK_DLL FBShaderLighted : public FBShader
    {
        //--- Open Reality declaration.
        FBClassDeclare( FBShaderLighted, FBShader );

    public:
        FBShaderLighted( const char* pName, HIObject pObject=NULL );

        FBPropertyBool             UseContrast;   
        FBPropertyDouble           Contrast;      

        FBPropertyBool             UseLuminosity; 
        FBPropertyDouble           Luminosity;    

        FBPropertyBool             UseSpecular;   
        FBPropertyDouble           Specular;      

        FBPropertyAlphaSource      Transparency;  
        FBPropertyAnimatableDouble Alpha;         
    };


    // FBShaderShadowLive
    FB_FORWARD( FBShaderShadowLive );
    FB_DEFINE_COMPONENT( FBSDK_DLL, ShaderShadowLive );

    enum FBShadowType
    { 
        kFBShadowTypeShadowTranslucentPlanar              ,    
        kFBShadowTypeShadowProjectiveTexture   ,    
        kFBShadowTypeLightMapProjectiveTexture ,    
        kFBShadowTypeZShadowProjectiveTexture  ,    
        kFBShadowTypeZLightMapProjectiveTexture,    
        kFBShadowTypeShadowOpaquePlanar        ,    
    };
    FB_DEFINE_ENUM( FBSDK_DLL, ShadowType );

    enum FBShadowFrameType
    {
        kFBShadowFrameTypeShadowReceiver,   
        kFBShadowFrameTypeShadowCaster  ,   
        kFBShadowFrameTypeShadowCubeMap ,   
    };
    FB_DEFINE_ENUM( FBSDK_DLL, ShadowFrameType );


    class FBSDK_DLL FBShaderShadowLive : public FBShader
    {
        //--- Open Reality declaration.
        FBClassDeclare( FBShaderShadowLive, FBShader );

    public:
        FBShaderShadowLive( const char* pName, HIObject pObject=NULL );

        FBPropertyShadowType       ShadowType;      
        FBPropertyAnimatableDouble ShadowIntensity; 
        FBPropertyBool             LocalShadow;     
        FBPropertyBool             UseGobo;         
        FBPropertyDouble           ShadowZOffset;   
        FBPropertyShadowFrameType  ShadowFrameType; 

        FBPropertyListObject       Lights;          
        FBPropertyListObject       Models;          

    };


#ifdef FBSDKUseNamespace
}
#endif
#endif /* _FB_SHADER_H_ */