Ivf/IvfDocument.h

Go to the documentation of this file.

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/

#ifndef __CIVFDOCUMENT_H__
#define __CIVFDOCUMENT_H__

#define IVF_MAX_URL_NAME_LENGTH     1024
#define MAX_SCRATCH_FILES     4  

#define DEF_CAMERA_GROUP_NAME           "TGS_DEFCAMERA"
#define NEW_CAMERA_GROUP_NAME           "TGS_NEWCAMERA"

#define ID_FIRST_VIEWPOINT 17410

#include <Inventor/SbBasic.h>

#include <Ivf/IvfComponent.h>
#include <Inventor/actions/SoCallbackAction.h>

class SbColor;
class SbString;
class SbPList;
class SoSwitch;
class SoGroup;
class SoSeparator;
class SoInput;
class SoInfo;
class SoNode;
class SoOutput;
class SoPathList;
class SoTexture2;
class SoWWWAnchor;
class SoWWWInline;
class SoPrimitiveVertex;

class CArchive;

class CInlineQueue;
class CInlineItem;
class CAsyncFileQueue;
class CIvfAsyncFile;
class SoDEPRECATED  CIvfDocument
{
  friend CIvfComponent;

 public:
  CIvfDocument();
  ~CIvfDocument();

 public:
  void IvfSetFileHeader(LPCSTR header) { strcpy(m_fileHeader, header); }

  virtual BOOL IvfOnNewDocument();

  virtual BOOL IvfOnOpenDocument(LPCTSTR lpszPathName);

  virtual BOOL IvfOnSaveDocument(LPCTSTR lpszPathName);

  virtual BOOL IvfOnOpenDocument(UINT hFile);
   
  virtual BOOL IvfOnSaveDocument(UINT hFile);

#if _MSC_VER >= 1300
  //  --romain dec2001 
  virtual BOOL IvfOnOpenDocument(HANDLE hFile);
  virtual BOOL IvfOnSaveDocument(HANDLE hFile);
#endif

  virtual BOOL IvfOnSaveDocument(const CFile* cFile);

  virtual BOOL IvfOnOpenDocument(CArchive &rArchive);

  virtual BOOL IvfOnSaveDocument(CArchive &rArchive);

  BOOL IvfOnOpenDocumentMessage(LPCTSTR lpszPathName);

  void IvfImportDocument(LPTSTR PathName);

  enum IVFDOC_OPEN_ENUM {
    IVFDOC_OPEN_NORMAL, 
    IVFDOC_OPEN_LOAD, 
    IVFDOC_OPEN_IMPORT,
    IVFDOC_OPEN_PLUGIN
  };
  IVFDOC_OPEN_ENUM m_eOpenType;

  void CIvfDocument::IvfInitDocument(void *pCreateArgs);

  virtual void IvfDeleteContents();

  virtual LPCTSTR IvfGetUrlName(void);

  virtual BOOL IvfIsEmbedded();

  virtual BOOL IvfIsTitleSet(void);
  virtual void  IvfUpdateTitle(void);
  virtual LPCTSTR IvfGetTitleString(void);

  virtual BOOL IvfIsInfoSet(void);
  virtual LPCTSTR IvfGetDocInfoString(void);

  virtual void OnFileViewInfo(void);

  virtual void IvfSetSceneGraph(SoSeparator *pRoot);
  SoSeparator *IvfGetDocSceneGraph();

  SoCamera *IvfGetActiveCamera(int in_ix = -1);
  int IvfGetActiveCameraIX();
  SoGroup *IvfGetActiveCamParent();
  SbPList *IvfGetCameraList();
  
  virtual void setCameraType(SoType type);
  
  SoType       getCameraType()
    { return m_cameraType; }

  SoCamera *IvfReplaceCamera(SoCamera *cam, int ix);

  virtual void IvfPrepareForSave();

  virtual void IvfPostSave();

  virtual void IvfFindAnchors(SoGroup *root);

  BOOL IvfIsOleSrvr();

  void IvfUpdateHeadlightHint(BOOL bOn);

  static SoSeparator *IvfReadAll(SoInput *, CIvfDocument *);

  static BOOL IvfSaveSceneGraph(LPCTSTR lpFname, SoSeparator *pRoot, 
                                CIvfDocument *);

  static SoSeparator *IvfLoadSceneGraph(LPCTSTR lpFname,
                                        CIvfDocument *);

  static BOOL IvfSaveSceneGraph(UINT hFile, SoSeparator *pRoot,
                                CIvfDocument *);
   
  static BOOL IvfSaveSceneGraph(SoOutput* out, SoSeparator *pRoot,
                                CIvfDocument *);

  static SoSeparator *IvfLoadSceneGraph(UINT hFile, CIvfDocument *);

  static BOOL IvfSaveSceneGraph(CArchive &rArchive, SoSeparator *pRoot,
                                CIvfDocument *);

  static SoSeparator *IvfLoadSceneGraph(CArchive &rArchive,
                                        CIvfDocument *);

  virtual void IvfDeleteSceneGraph();
   
  virtual void IvfSceneGraphChanged();

  virtual void IvfSceneGraphCompleted();

  virtual void IvfScrubInlines();

  virtual void IvfOnLocationChanged(LPCTSTR urlName);

  virtual void IvfOnUpdateViewpoints(CCmdUI* pCmdUI);

  virtual void IvfRemoveViewpointMenu(CCmdUI* pCmdUI);

  int IvfGetNumComponents();

  virtual BOOL IdleProcessInlines(void);

  static BOOL IvfIsInventorFile(LPCTSTR lpszFileName);

  enum IVF_FILETYPE {
    IVF_FILETYPE_IV, 
    IVF_FILETYPE_VRML,
    IVF_FILETYPE_VRML2,
    IVF_FILETYPE_VRML3
  };

  void IvfSetFileType(IVF_FILETYPE);
  IVF_FILETYPE IvfGetFileType(void);

  virtual void IvfSetBgColor(const SbColor &);
  virtual SbColor &IvfGetBgColor(void);

  virtual BOOL IvfPreTranslateMessage(MSG *);

  virtual CIvfAsyncFile *IvfCreateAsyncFile(void *data);

  virtual BOOL IvfOnOpenUrl(LPCTSTR url);

  void IvfRemoveAsyncFile(CIvfAsyncFile *file);
  void IvfAbortAllAsyncFiles();

  BOOL IvfIsAsyncFilesPending();

  int IvfIsInlinesPending();

  virtual void IvfEnableStatAccumulation(BOOL bDoAccum);

  virtual void IvfClearStatCounters(BOOL bClearAll=FALSE);

  ULONG m_nTriCount, m_nNodeCount, m_nLineCount, m_nPointCount;

  BOOL  m_bHasTouchSensors;
  static BOOL m_queueingOff;
  void SetBaseUrlPath(LPCTSTR b_path);
  LPCTSTR GetBaseUrlPath(void) { return(m_BasePath); }
  static TCHAR m_StaticPath[IVF_MAX_URL_NAME_LENGTH];

 private: protected:
  SoSeparator *m_pSceneRoot;

  virtual void IvfRemoveCameras(SoGroup *root);

  virtual void IvfRestoreCameras(SoGroup *root);

  virtual void IvfDeleteCameraList();

  virtual BOOL IvfOnLoadUrlMessage(CIvfAsyncFile *pIvfASFile);

  virtual void IvfSetupUrlFetchCallback();

  virtual void IvfRemoveUrlFetchCallback();

  virtual void IvfOnFetchUrl(LPCTSTR urlName);

  static void IvfStaticFetchUrlCB(const SbString &url, 
                                  void *userData, 
                                  SoWWWAnchor *node);

  static void IvfStaticFetchInlineUrlCB(const SbString &url, 
                                        void *userData,
                                        SoNode *node);

  static BOOL IvfStaticFetchTexture2UrlCB(const SbString &url, 
                                          void *userData,
                                          void *node);

  BOOL IsPendingAsyncRequest(CIvfAsyncFile *pIvfASFile, int &status);

  void OpenLocalAsyncDoc(CIvfAsyncFile *);
   
  void OnProcessPendingInline(WPARAM, LPARAM);
  void ProcessPendingTexture2(CInlineItem *, BOOL);

  void PostInlineLocation(SoNode *, LPTSTR , void *);
  LPTSTR MakeFullUrlPath(LPTSTR out_url, LPCTSTR in_url);

  BOOL IsOKFile(LPTSTR filename);
  BOOL MakeScratchName(LPTSTR new_path, LPTSTR filename);
  void CleanupScratchFile(LPTSTR filename);

  void CountPrimitives();

  SoSwitch *m_pCameraSwitch;
  SoGroup *m_pCameraSwitchParent;
  SoInfo *m_pCameraSwitchInfo;

  SoType  m_cameraType;

  SoGroup *m_pDefaultCameraGroup;
   
  SbPList *m_pCamList;

  SbPList *m_pCamParentList;

  int m_nActiveCameraIX;

  BOOL IVOpenError;

  SbPList *m_pInfoList;

  SoPathList *m_pAnchorList;

  SoInfo *m_pBackColorInfo, *m_pHLInfo;

  SoGroup *m_pVPWindowSizePar; 
  SoInfo *m_pVPWindowSize;

  BOOL m_nEnableUrlFetch;

  BOOL m_nEnableUrlDisplay;

  BOOL m_nEnableViewpoints;

  TCHAR m_urlName[IVF_MAX_URL_NAME_LENGTH];

  IVF_FILETYPE m_fileType;
  char m_fileHeader[256];

  void AddInlineChild(CInlineItem *);
  void AddInlineChild(SoNode *node, LPTSTR filename, void *cb);
  CInlineQueue *m_pInlineQueue;
  CAsyncFileQueue *m_pAsyncQueue;
  TCHAR m_BasePath[IVF_MAX_URL_NAME_LENGTH];
  TCHAR m_OriginalPath[IVF_MAX_URL_NAME_LENGTH];
  BOOL m_bSceneGraphComplete, m_bNewGraphPrepped, m_bBasePathPreset,
    m_bContainsInlines;

  TCHAR* lcl_scratch_filename[MAX_SCRATCH_FILES];
  int n_scratch_files;
  static BOOL viewerSpeedHintSet;
  static BOOL autoClipOffHintSet;
  static BOOL titleHintSet;
  static BOOL anyLightsSet;

  BOOL m_bTitleHintSet;
  BOOL m_bDocInfoSet;
  BOOL m_bSaveAsBinary;
  BOOL m_bDefHeadlightVal;
  float motionSpeedHintVal;
  CIvfComponent::IvfViewerType viewerTypeHintSet;

  SbString *sceneTitle, *docInfoString;
  void IvfScanForHints(SoNode *root);

  void DetermineViewerType(const SoInfo *info);
  void DetermineViewerSpeed(const SoInfo *info);
  void DetermineBackgroundColor(const SoInfo *info);
  void DetermineTitle(const SoInfo *info);
    
  static SoCallbackAction::Response InfoHintCB(void *userData, 
                                               SoCallbackAction *action,
                                               const SoNode *node);

  static SoCallbackAction::Response NavInfoCB(void *userData, 
                                              SoCallbackAction *action,
                                              const SoNode *node);

  static SoCallbackAction::Response WorldInfoCB(void *userData, 
                                                SoCallbackAction *action,
                                                const SoNode *node);

  static SoCallbackAction::Response WWWInlineCB(void *userData,
                                                SoCallbackAction *action,
                                                const SoNode *node);

  static SoCallbackAction::Response VRMLInlineCB(void *userData,
                                                 SoCallbackAction *action,
                                                 const SoNode *node);

  static SoCallbackAction::Response CheckForLightsCB(void *userData, 
                                                     SoCallbackAction *action,
                                                     const SoNode *node);

  static SoCallbackAction::Response CountNodesCB(void *userData, 
                                                 SoCallbackAction *action,
                                                 const SoNode *node);

  static void CountTrisCB(void *userData, 
                          SoCallbackAction *action,
                          const SoPrimitiveVertex *,
                          const SoPrimitiveVertex *,
                          const SoPrimitiveVertex *);

  static void CountLinesCB(void *userData, 
                           SoCallbackAction *action,
                           const SoPrimitiveVertex *,
                           const SoPrimitiveVertex *);

  static void CountPointsCB(void *userData, 
                            SoCallbackAction *action,
                            const SoPrimitiveVertex *);
};

extern UINT WMIVF_PROCPENDINGINLINE;
extern UINT WMIVF_LOADURL;

#if defined(_DEBUG)
void DumpSceneGraph(SoNode *pGraph);
#endif

#endif

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/