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( IGraphicPrimitives  );

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

#define FBRegisterShader( UniqueNameStr, ClassName, Label, Description, IconFilename ) \
    HIObject RegisterShader##ClassName( HIObject /*pOwner*/,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(char * pName):Parent(pName) { FBClassInit; } \
  private:

#define FBShaderImplementation( ThisComponent ) \
        FBClassImplementation( ThisComponent )

// FBShaderManager
FB_FORWARD( FBShaderManager );
FB_FORWARD( FBShader );

class FBSDK_DLL FBShaderManager
{
    FBShaderManager( const FBShaderManager& );

    FBShaderManager& operator=( const FBShaderManager& );

public:

    FBShaderManager();

    ~FBShaderManager();

    HFBShader CreateShader( const char* pShaderTypeName );

    FBStringList ShaderTypeNames;

    FBStringList ShaderTypeNamesLocalized;
};


// FBShader - Shader layer on top of internals.


FB_FORWARD( FBShaderModelInfo );
class FBSDK_DLL FBShaderModelInfo
{
public:
    FBShaderModelInfo(HIGraphicPrimitives pGPS);
    virtual ~FBShaderModelInfo();

    virtual void UpdateModelShaderInfo(int pShader_Version);

    HFBModel GetFBModel();

public:
    HIGraphicPrimitives mGPS;

    int mModel_Version; 

    int mShader_Version;

    bool mOriginal_Texture_Flag;
};

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

    int GetRenderFrameId();

#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    
};

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


FB_DEFINE_ENUM( FBSDK_DLL, RenderingPass );

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(Implementation);        // Interface to IObject.

    virtual HFBShaderModelInfo NewShaderModelInfo( HFBRenderOptions pOptions, HIGraphicPrimitives pGPS );

    virtual void DestroyShaderModelInfo( HFBRenderOptions pOptions, HFBShaderModelInfo pInfo );

    virtual void ReplaceAll( HFBModel pModel );

    virtual void Append( HFBModel pModel );

    virtual bool ShaderNeedBeginRender();

    virtual void ShaderBeginRender( HFBRenderOptions pOptions, HFBShaderModelInfo pInfo );

    virtual void ShadeModel( HFBRenderOptions pOptions, HFBShaderModelInfo pInfo, FBRenderingPass pPass );

    virtual void CloneShaderParameter( HFBShader pNewShader );

    virtual void DetachDisplayContext( HFBRenderOptions pOptions, HFBShaderModelInfo pInfo );

    virtual bool FbxStore   (HFBFbxObject pFbxObject);

    virtual bool FbxRetrieve(HFBFbxObject pFbxObject, HFBRenderer pRenderer);

    char*                       ShaderDescription;  

    FBPropertyRenderingPass     RenderingPass;

    int GetShaderVersion() const { return mShader_Version; }

protected:
    static FBRenderingPass GetRenderingPassNeededForAlpha(FBAlphaSource pTransparency);

    int mShader_Version;
};

// 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
{ 
    kFBShadowTypeShadowPlanar              ,    
    kFBShadowTypeShadowProjectiveTexture   ,    
    kFBShadowTypeLightMapProjectiveTexture ,    
    kFBShadowTypeZShadowProjectiveTexture  ,    
    kFBShadowTypeZLightMapProjectiveTexture,    
};
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_ */