fbrenderer.h

Go to the documentation of this file.

#ifndef __FBRENDERER_H__
#define __FBRENDERER_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
 
#if !defined(K_NO_MANIPULATOR)
#include <fbsdk/fbmanipulator.h>
#endif
 
#include <fbsdk/fbcomponent.h>
#include <fbsdk/fbmodel.h>
#include <fbsdk/fbcamera.h>
#include <fbsdk/fblight.h>
#include <fbsdk/fbshader.h>
#include <fbcontrols/fbcontrols.h>  // FBInputType
 
#ifdef FBSDKUseNamespace
namespace FBSDKNamespace {
#endif
 
    __FB_FORWARD( FBRenderer );
    __FB_FORWARD( FBRendererCallback );
 
    FB_FORWARD( FBView );
 
    FB_DEFINE_COMPONENT( FBSDK_DLL, Renderer );
 
    FB_FORWARD( FBViewingOptions );
 
    enum FBDisplayMode {
        kFBDisplayModeDefault = 0,  
        kFBDisplayModeTexture,      
        kFBDisplayModeHardShade,    
        kFBDisplayModeFlatShade,    
        kFBDisplayModeWireFrame,    
        kFBDisplayModeCount         
    };
 
    enum FBArrangeMode { 
        kHorizontalMode,        
        kVerticalMode,          
    };
 
    enum FBStereoDisplayMode   
    {
        kFBStereoDisplayCenterEye = 0,          
        kFBStereoDisplayLeftEye,                
        kFBStereoDisplayRightEye,               
        kFBStereoDisplayActive,                 
        kFBStereoDisplayHorizontalInterlace,    
        kFBStereoDisplayCheckerboard,           
        kFBStereoDisplayAnaglyph,               
        kFBStereoDisplayAnaglyphLuminance,       
        kFBStereoDisplayFreeviewParallel,       
        kFBStereoDisplayFreeviewCrossed,        
        kFBStereoDisplayModeCount = 10          
    };
 
 
    enum FBDisplayWhat {
        kFBDisplayNone      = 0,            
        kFBDisplayNull      = (1 << 0),     
        kFBDisplayMarker    = (1 << 1),     
        kFBDisplaySkeleton  = (1 << 2),     
        kFBDisplayCenter    = (1 << 3),     
        kFBDisplayLight     = (1 << 4),     
        kFBDisplayCamera    = (1 << 5),     
        kFBDisplay3dIcon    = (1 << 6),     
        kFBDisplayAll       = 0xff          
    };
 
 
    enum FBPickingMode {
        kFBPickingModeStandard = 0,     
        kFBPickingModeXRay,             
        kFBPickingModeModelsOnly,       
        kFBPickingModeCount             
    };
 
 
    enum FBDeviceKeyboardKey {
        kFBDKeyPageUp,          
        kFBDKeyPageDown,        
        kFBDKeyEnd,             
        kFBDKeyHome,            
        kFBDKeyArrowLeft,       
        kFBDKeyArrowUp,         
        kFBDKeyArrowRight,      
        kFBDKeyArrowDown,       
        kFBDKeyReturn,          
        kFBDKeyEscape,          
        kFBDKeySpace,           
        kFBDKey1,               
        kFBDKey2,               
        kFBDKey3,               
        kFBDKey4,               
        kFBDKey5,               
        kFBDKey6,               
        kFBDKey7,               
        kFBDKey8,               
        kFBDKey9,               
        kFBDKey0,               
        kFBDKeyF1,              
        kFBDKeyF2,              
        kFBDKeyF3,              
        kFBDKeyF4,              
        kFBDKeyF5,              
        kFBDKeyF6,              
        kFBDKeyF7,              
        kFBDKeyF8,              
        kFBDKeyF9,              
        kFBDKeyF10,             
        kFBDKeyF11,             
        kFBDKeyF12              
    };
 
    FB_DEFINE_ENUM( FBSDK_DLL, DeviceKeyboardKey );
 
    class FBSDK_DLL FBViewingOptions
    {
    public:
        FBCamera*   GetViewingCamera();
 
        FBModelShadingMode& ShadingMode();
 
        FBStereoDisplayMode& StereoDisplayMode();
 
        int& DisplayWhat();
 
        FBPickingMode& PickingMode();
 
        bool& ShowTimeCode();
 
        bool& ShowSafeArea();
 
        bool& ShowCameraLabel();
 
        bool IsInSelectionBufferPicking() const;
 
        bool IsInColorBufferPicking() const;
 
        unsigned int RenderCallbackPrefIndex() const;
 
        int PaneIndex() const;
 
    private:
        FBViewingOptions();
        FBViewingOptions(const FBViewingOptions &);
        FBViewingOptions & operator =(const FBViewingOptions &);
    };
 
 
    // FBPickInfos
 
    struct FBPickInfos 
    {
        FBPickInfos( FBModel* pModel, FBVector3d pPoint, FBVector3d pNormal, int pSubItemIndex ) 
            : mModel( pModel ), mPoint( pPoint ), mNormal (pNormal), mSubItemIndex(pSubItemIndex) {};
 
        FBModel*   mModel;          
        FBVector3d mPoint;          
        FBVector3d mNormal;         
        int        mSubItemIndex;   
    };
 
    bool operator==( const FBPickInfos& pLhs, const FBPickInfos& pRhs );
 
    typedef class FBSDK_DLL FBArrayTemplate<FBPickInfos> FBPickInfosList;
 
    FBSDK_DLL FBPickInfosList* FBCreatePickInfosList();
 
    FBSDK_DLL void FBDestroyPickInfosList( FBPickInfosList* pPickInfosList );
 
    // FBRendererCallback
 
    class FBSDK_DLL FBRendererCallback : public FBComponent 
    {
        //--- Open Reality declaration.
        __FBClassDeclare( FBRendererCallback,FBComponent );
    public:
 
        FBRendererCallback(const char* pName);
 
        virtual const char* GetCallbackName() const = 0;
 
        virtual const char* GetCallbackDesc() const = 0;
 
        virtual unsigned int GetCallbackPrefCount() const;
 
        virtual const char*  GetCallbackPrefName(unsigned int pIndex) const;
 
        virtual void Render(FBRenderOptions* pRenderOptions);
 
        virtual void Attach();
 
        virtual void Detach();
 
        virtual void DetachDisplayContext(FBViewingOptions* pViewOption);
 
        FBPropertyBool SupportIDBufferPicking;                  
        FBPropertyBool DefaultCameraFrontPlateRendering;        
        FBPropertyBool DefaultCameraBackPlateRendering;         
        FBPropertyBool DefaultLightGroundProjectionRendering;   
        FBPropertyBool DefaultLightVolumeRendering;             
    };
 
    FB_DEFINE_COMPONENT ( FBSDK_DLL, RendererCallback );
 
#define FBRegisterRendererCallback( UniqueNameStr, ClassName, Label, Description, IconFilename ) \
    HIObject CreateRendererCallback##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
    ClassName *Class = new ClassName( pName ); \
    if (Class->FBCreate()) { \
    return Class->GetHIObject(); \
    } else { \
    delete Class; \
    return NULL; \
    } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
    FBRegisterObject( ClassName##R1,"renderer/callback/ogl",Label,Description,CreateRendererCallback##ClassName,true, IconFilename );   \
    }
 
#define FBRendererCallbackDeclare( ClassName, Parent  ) \
    FBClassDeclare( ClassName,Parent); \
public: \
    ClassName(const char* pName):Parent(pName) { FBClassInit; } \
private:
 
#define FBRendererCallbackImplementation( ThisComponent ) \
    FBClassImplementation( ThisComponent )
 
 
    // FBPropertyListRendererCallback
 
    class FBSDK_DLL FBPropertyListRendererCallback : public FBPropertyListComponent
    {
    public:
        FBPropertyListRendererCallback();
        virtual int Add( FBRendererCallback* pItem );
        FBRendererCallback* operator[](int pIndex);
 
    private:
        inline virtual int Add    ( FBComponent* pItem ) { return Add((FBRendererCallback*)pItem); }
    };
 
    // FBRenderer
 
    class FBSDK_DLL FBRenderer : public FBComponent 
    {
        //--- Open Reality declaration.
        __FBClassDeclare( FBRenderer,FBComponent );
    public:
        FBRenderer(HIObject pObject);
 
        //--- Rendering manipulation
        void SetViewport(int pX,int pY,int pW,int pH);
 
        bool RenderBegin(int pX,int pY,int pW,int pH);
 
        bool RenderEnd(FBView* pView=NULL);
 
        bool PreRender(int pLayer = -1);
 
        bool Render(int pLayer = -1);
 
        void OGLSetupSceneLights(FBRenderOptions& pRenderOptions);
 
        void OGLModelDisplay(FBRenderOptions& pRenderOptions, FBModel& pModel);
 
        bool SetViewingOptions(FBViewingOptions & pOptions);
 
        FBViewingOptions * GetViewingOptions();
 
        bool FrameCurrentCameraWithModels(bool pAll);
 
        void ArrangeSelectedObjectsInSchematic();
 
        bool ArrangeObjectsInSchematicFromModel( const FBModel& pModel );
 
        void ArrangeAllInSchematic(FBArrangeMode pMode);
 
        bool GetSchematicNodesBoundingBox( bool pConsiderCollapsedNodes, int& pTop, int& pLeft, int& pBottom, int& pRight );
 
        bool GetSchematicNodesBoundingBoxFromModel( FBModel* pModel, bool pConsiderCollapsedNodes, int& pTop, int& pLeft, int& pBottom, int& pRight );
 
        FBStringList GetSchematicBookmarkNames() const;
 
        const char* GetCurrentSchematicBookmarkName() const;
 
        bool IsCurrentSchematicBookmarkDirty() const;
 
        bool CreateSchematicBookmark(const char* pBookmarkName);
 
        bool DeleteSchematicBookmark(const char* pBookmarkName);
 
        bool RenameSchematicBookmark(const char* pOldBookmarkName, const char* pNewBookmarkName);
 
        bool SelectSchematicBookmark(const char* pBookmarkName);
 
        bool UpdateCurrentSchematicBookmark();
 
        //--- \internal Camera manipulation, Manipulators
        bool MouseInput(int pX,int pY,FBInputType pInputType,int pButtonKey,FBInputModifier pModifier,int pWheelDeltaValue=0,int pLayer = -1);
 
        bool MouseInputNormalized(float pX,float pY,FBInputType pInputType,int pButtonKey,FBInputModifier pModifier,int pWheelDeltaValue, int pLayer = -1, int pPaneId = -1);
 
        bool Pick(int pX, int pY, FBPickInfosList& pPickInfosList, bool pNeedIntersectPosition = false );
 
        bool PickNormalized(float pX, float pY, FBPickInfosList& pPickInfosList, bool pNeedIntersectPosition = false, int pPaneId = -1);
 
        bool RectPick(int pX1, int pY1, int pX2, int pY2, FBPickInfosList& pPickInfosList);
 
        bool RectPickNormalized(float pX1, float pY1, float pX2, float pY2, FBPickInfosList& pPickInfosList, int pPaneId = -1);
 
        int  GetLastPickInfoList(FBPickInfosList& pPickInfosList);
 
        void KeyboardInput(FBDeviceKeyboardKey pKeyIndex, bool pKeyState, bool pIsTrigger = false);
 
        FBModel* GetDisplayableGeometry(int pIndex );
 
        FBLight* GetDisplayableLight(int pIndex );
 
        const FBModelList& GetDisplayableGeometryInCameraFrustum(FBModelList* pModelList = NULL, FBCamera* pCamera = NULL);
 
        bool IsModelInsideCameraFrustum(FBModel* pGeometry, FBCamera* pCamera = NULL);
 
        // Properties
        FBPropertyCamera                CurrentCamera;          
        FBPropertyBool                  UseCameraSwitcher;      
 
#if !defined(K_NO_MANIPULATOR)
        FBPropertyManipulatorTransform  ManipulatorTransform;   
        FBPropertyListManipulator       Manipulators;           
#endif
 
        FBPropertyScene                 Scene;                  
        FBPropertyBool                  AutoEvaluate;           
        FBPropertyBool                  EvaluateMode;           
        FBPropertyBool                  Background;             
        FBPropertyBool                  ShowStats;              
        FBPropertyBool                  FrustumCulling;         
        FBPropertyBool                  DisplayNormals;         
        FBPropertyBool                  PickingEnabled;         
        FBPropertyBool                  IDBufferPicking;        
        FBPropertyDouble                IDBufferPickingAlpha;   
        FBPropertyBool                  IDBufferDisplay;        
        FBPropertyBool                  SelectionOverride;      
        FBPropertyDouble                SelectionOverrideTransparency;  
        FBPropertyColor                 SelectionOverrideColor; 
        FBPropertyBool                  SelectionForceSnapPointsDisplay;
        FBPropertyInt                   DisplaySetUpdateId;     
        FBPropertyInt                   RendererUpdateId;       
        FBPropertyInt                   DisplayableGeometryCount;
        FBPropertyInt                   DisplayableLightCount;  
        FBPropertyListRendererCallback  RendererCallbacks;      
        FBPropertyInt                   RegisteredCallbackCount;
        FBPropertyInt                   CurrentPaneCallbackIndex;       
        FBPropertyInt                   CurrentPaneCallbackPrefIndex;   
        FBPropertyBool                  HideManipulatorsOnManip;        
        FBPropertyBool                  HideManipulatorsOnPlayback;     
 
        FBPropertyBool                  AdvancedMaterialMode;   
 
        FBPropertyBool                  AdvancedLightingMode;   
 
        int GetViewerTextureId();
 
        void CloneViewAdd(FBView* pView);
 
        void CloneViewRemove(FBView* pView);
 
        void CloneViewRender(int pWidth, int pHeight);
 
        void SetCameraInPane( FBCamera* pCamera, unsigned int pPaneIndex );
 
        FBCamera* GetCameraInPane( unsigned int pPaneIndex );
 
        void SetPaneCount( unsigned int pPaneCount );
 
        unsigned int GetPaneCount();
 
        bool SetSelectedPaneIndex( unsigned int pPaneIndex );
 
        unsigned int GetSelectedPaneIndex() const;
 
        void SetSchematicViewInPane( unsigned int pPaneIndex, bool pActive );
 
        int GetSchematicViewPaneIndex();
 
        void SetCameraSwitcherInPane( unsigned int pPaneIndex, bool pActive );
 
        bool IsCameraSwitcherInPane( unsigned int pPaneIndex );
    };
 
#ifdef FBSDKUseNamespace
}
#endif
#endif /* this must be the last line of this file */