CIvfApp Class Reference
[Ivf Classes]

Interface of the IVF application class. More...

#include <Ivf/IvfApp.h>

List of all members.

Public Member Functions
	CIvfApp ()
	~CIvfApp ()
Static Public Member Functions
static void	IvfInitInstance (CWinApp *pApp, CIvfApp *pIvfApp, IvfCvtAfxViewProc pAfxViewProc, IvfCvtIvfComponentProc pIvfComponentProc, IvfCvtAfxWndProc pAfxWndProc, IvfCvtIvfComponentProcW pIvfComponentProcW, IvfCvtAfxDocProc pAfxDocProc, IvfCvtIvfDocProc pIvfDocProc, IvfCvtAfxFrameProc pAfxFrameProc, void *pCreateArgs, BOOL nCreateComponent)
static void	IvfExitInstance ()
static void	IvfOnIdle (LONG lCount)
static void	IvfInitSoWin (CWnd *pTopLevel)
static CIvfApp *	IvfGetApp ()
static CDocTemplate *	IvfGetDocTemplate ()
static CIvfDocument *	IvfGetDocument (CIvfComponent *pIvfComponent=NULL)
static CIvfComponent *	IvfGetComponent (CIvfDocument *pIvfDoc=NULL)
static CFrameWnd *	IvfGetAfxFrame (CIvfComponent *pIvfComponent=NULL)
static CIvfMainFrame *	IvfGetIvfFrame ()
static CView *	IvfGetAfxView (CIvfComponent *pIvfComponent=NULL)
static CWnd *	IvfGetAfxWnd (CIvfComponent *pIvfComponent=NULL)
static CDocument *	IvfGetAfxDocument (CIvfComponent *pIvfComponent=NULL)
static CDocument *	IvfGetAfxDocument (CIvfDocument *pIvfDoc)
static CIvfComponent *	ToIvfComponent (CView *pAfxView)
static CView *	ToAfxView (CIvfComponent *pIvfComponent)
static CIvfComponent *	ToIvfComponentW (CWnd *pAfxWnd)
static CWnd *	ToAfxWnd (CIvfComponent *pIvfComponent)
static CIvfDocument *	ToIvfDocument (CDocument *pAfxDoc)
static CDocument *	ToAfxDocument (CIvfDocument *pIvfDoc)
static CIvfMainFrame *	ToIvfFrame (CFrameWnd *pFrame)
static void *	IvfCreateArgs ()
static BOOL	IvfIsMdi ()
static void	IvfAddToIvfAfxObjectList (CObject *pAfxObj)
static void	IvfRemoveFromIvfAfxObjectList (CObject *pAfxObj)
static BOOL	IvfIsIvfComponent (CView *pAfxView)
static BOOL	IvfIsIvfDocument (CDocument *pAfxDoc)
static void	enableMultiThread (void)
Static Public Attributes
static CIvfApp *	m_pApp
static CDocTemplate *	m_pDocTemplate
static void *	m_pCreateArgs
static BOOL	m_nMDI

---

Detailed Description

Interface of the IVF application class.

This class provides methods for initialization of Open Inventor and the IVF Class library.

Note: Although the class name is CIvfApp, the header file name is IvfApp.h.

m_pCreateArgs is a pointer to an array of type int containing (at least) the following:

• m_pCreateArgs[0] = Enable viewer decorations (default = TRUE)
  If enabled, the viewer decorations (thumbwheels, etc.) are turned on.
• m_pCreateArgs[1] = Enable display of URL (default = FALSE)
  If enabled, IvfOnUrlDisplayChanged will be called.
• m_pCreateArgs[2] = Enable viewpoints menu (default = FALSE)
  If enabled, a Viewpoints menu will be added to the menu bar.
• m_pCreateArgs[3] = Enable URL fetch callback (default = FALSE)
  If enabled, IvfOnFetchUrl will be called.

SEE ALSO

CIvfArchiveInput, CIvfArchiveOutput, CIvfComponent, CIvfDocument, CIvfMainFrame

Deprecated:

Deprecated since Open Inventor 9500
The whole Ivf viewer API is no longer supported. Examples of custom viewers can be found in section MFC examples user interface of the Reference Manual.

---

Constructor & Destructor Documentation

CIvfApp::CIvfApp

(

)

Constructor.

CIvfApp::~CIvfApp

(

)

Destructor.

---

Member Function Documentation

static void CIvfApp::enableMultiThread

(

void

)

[static]

Enable MT support in Open Inventor (call SoDB::threadInit instead of SoDB::init).

static void CIvfApp::IvfAddToIvfAfxObjectList

(

CObject *

pAfxObj

)

[static]

Utility routine to add afx object to Ivf corresponding list.

Not all objects in an IVF application have to be derived from CIvfComponent or CIvfDocument. To distinguish between IVF and non-IVF objects, we keep a list of all views and documents that have been derived from Ivf equivalent classes.

static void* CIvfApp::IvfCreateArgs

(

)

[static]

This method returns a pointer to the arguments passed to the of the IVF view class for component creation.

static void CIvfApp::IvfExitInstance

(

)

[static]

This method releases any resources allocated by Ivf.

static CDocument* CIvfApp::IvfGetAfxDocument

(

CIvfDocument *

pIvfDoc

)

[static]

Given a pointer to an IVF document object, calls the application-supplied conversion method to perform a type safe cast of the IVF document object pointer down to the application document class, and then a cast up to the MFC document class.

A pointer to the MFC document object corresponding to the IVF document object is returned.

static CDocument* CIvfApp::IvfGetAfxDocument

(

CIvfComponent *

pIvfComponent = NULL

)

[static]

Given a pointer to an IVF component object, this method first locates the corresponding IVF document object.

It then calls the application supplied conversion method to perform a type safe cast of the IVF document object pointer down to the application document class and then a cast up to the MFC document class. A pointer to the MFC document object corresponding to the IVF component object is returned. If the argument is NULL, a pointer to the document object corresponding to the active MFC view is returned. If the application is dialog based, this method returns NULL.

static CFrameWnd* CIvfApp::IvfGetAfxFrame

(

CIvfComponent *

pIvfComponent = NULL

)

[static]

This method returns a pointer to the application frame window.

static CView* CIvfApp::IvfGetAfxView

(

CIvfComponent *

pIvfComponent = NULL

)

[static]

Given a pointer to an IVF component object, this method calls the application-supplied conversion method to perform a type safe cast down to the application view class and then a cast up to the MFC view class.

A pointer to the MFC view object corresponding to the IVF component object is returned. If the argument is NULL, a pointer to the active view is returned. If the application is dialog based, this method returns NULL.

static CWnd* CIvfApp::IvfGetAfxWnd

(

CIvfComponent *

pIvfComponent = NULL

)

[static]

Given a pointer to an IVF component object, this method calls the application-supplied conversion method to perform a type safe cast down to the application window class and then a cast up to the MFC window class.

A pointer to the MFC window object corresponding to the IVF component object is returned. If the argument is NULL, a pointer to the active component is returned. If the application is not dialog based, this method returns NULL.

static CIvfApp* CIvfApp::IvfGetApp

(

)

[static]

This method returns a pointer to the application object.

static CIvfComponent* CIvfApp::IvfGetComponent

(

CIvfDocument *

pIvfDoc = NULL

)

[static]

Given a pointer to an IVF document object, this method will return a pointer to the corresponding IVF component object.

The corresponding component is derived by locating the active MFC view associated with the document, and converting the MFC view pointer to an IVF component pointer using the application supplied conversion method.

static CDocTemplate* CIvfApp::IvfGetDocTemplate

(

)

[static]

This method returns a pointer to the application document template object.

static CIvfDocument* CIvfApp::IvfGetDocument

(

CIvfComponent *

pIvfComponent = NULL

)

[static]

Given a pointer to an IVF component object, this method will return a pointer to the corresponding IVF document object.

If the argument is NULL, the document corresponding to the active component is returned. If the application is an MFC dialog-based application, this method returns NULL.

static CIvfMainFrame* CIvfApp::IvfGetIvfFrame

(

)

[static]

This method returns a pointer to the application frame window.

static void CIvfApp::IvfInitInstance	(	CWinApp *	pApp,
		CIvfApp *	pIvfApp,
		IvfCvtAfxViewProc	pAfxViewProc,
		IvfCvtIvfComponentProc	pIvfComponentProc,
		IvfCvtAfxWndProc	pAfxWndProc,
		IvfCvtIvfComponentProcW	pIvfComponentProcW,
		IvfCvtAfxDocProc	pAfxDocProc,
		IvfCvtIvfDocProc	pIvfDocProc,
		IvfCvtAfxFrameProc	pAfxFrameProc,
		void *	pCreateArgs,
		BOOL	nCreateComponent
	)			[static]

This method intializes the IVF class library.

It is called from InitInstance in the MFC application object.

static void CIvfApp::IvfInitSoWin

(

CWnd *

pTopLevel

)

[static]

This method is used to initialize the SoWin component library.

static BOOL CIvfApp::IvfIsIvfComponent

(

CView *

pAfxView

)

[static]

Check if a CView object is derived from CIvfComponent.

static BOOL CIvfApp::IvfIsIvfDocument

(

CDocument *

pAfxDoc

)

[static]

Same for documents.

static BOOL CIvfApp::IvfIsMdi

(

)

[static]

This method returns a Boolean that indicates if this an MDI application.

static void CIvfApp::IvfOnIdle

(

LONG

lCount

)

[static]

This method connects MFC's Idle processing to the SoWin component library's delay queue processing mechanism.

static void CIvfApp::IvfRemoveFromIvfAfxObjectList

(

CObject *

pAfxObj

)

[static]

Remove a view from the IVF view list.

static CDocument* CIvfApp::ToAfxDocument

(

CIvfDocument *

pIvfDoc

)

[static]

This method invokes the application-supplied conversion method to convert an IVF document object pointer into an MFC document object pointer.

If the application is dialog based, NULL is returned.

static CView* CIvfApp::ToAfxView

(

CIvfComponent *

pIvfComponent

)

[static]

This method invokes the application-supplied conversion method to convert an IVF component object pointer into an MFC view object pointer.

If the application is dialog based, NULL is returned.

static CWnd* CIvfApp::ToAfxWnd

(

CIvfComponent *

pIvfComponent

)

[static]

This method invokes the application-supplied conversion method to convert an IVF component object pointer into an MFC window object pointer.

If the application is not dialog based, NULL is returned.

static CIvfComponent* CIvfApp::ToIvfComponent

(

CView *

pAfxView

)

[static]

This method invokes the application-supplied conversion method to convert an MFC view object pointer into an IVF component object pointer.

If the application is dialog based, NULL is returned.

static CIvfComponent* CIvfApp::ToIvfComponentW

(

CWnd *

pAfxWnd

)

[static]

This method invokes the application-supplied conversion method to convert an MFC window object pointer into an IVF component object pointer.

If the application is not dialog based, NULL is returned.

static CIvfDocument* CIvfApp::ToIvfDocument

(

CDocument *

pAfxDoc

)

[static]

This method invokes the application-supplied conversion method to convert an MFC document object pointer into an IVF document object pointer.

If the application is dialog based, NULL is returned.

static CIvfMainFrame* CIvfApp::ToIvfFrame

(

CFrameWnd *

pFrame

)

[static]

This method invokes the application-supplied conversion method to convert an IVF document object pointer into an MFC document object pointer.

If the application is dialog based, NULL is returned.

---

Member Data Documentation

BOOL CIvfApp::m_nMDI [static]

MDI flag.

CIvfApp* CIvfApp::m_pApp [static]

pointer to the IVF application object

void* CIvfApp::m_pCreateArgs [static]

Pointer to the arguments for SoWin component creation.

CDocTemplate* CIvfApp::m_pDocTemplate [static]

Pointer to the application document template object.

---

The documentation for this class was generated from the following file:

• Ivf/IvfApp.h