SceneExport Class Reference

This reference page is linked to from the following overview topics: Data Import and Export Plug-ins, Lesson 2: The Scene Graph and Nodes, Overview: Class Hierarchy, Plug-in Base Classes, Writing Exporter Plug-ins, Writing Importer Plug-ins.

---

Search for all occurrences

---

Detailed Description

See also:

Class ExpInterface, Class Interface.

Description:

This is a base class for creating file export plug-ins. The plug-in implements methods of this class to describe the properties of the export plug-in and a method that handles the actual export process.

#include <impexp.h>

Inheritance diagram for SceneExport:

List of all members.

Public Member Functions
	SceneExport ()
virtual	~SceneExport ()
virtual int	ExtCount ()=0
virtual const MCHAR *	Ext (int n)=0
virtual const MCHAR *	LongDesc ()=0
virtual const MCHAR *	ShortDesc ()=0
virtual const MCHAR *	AuthorName ()=0
virtual const MCHAR *	CopyrightMessage ()=0
virtual const MCHAR *	OtherMessage1 ()=0
virtual const MCHAR *	OtherMessage2 ()=0
virtual unsigned int	Version ()=0
virtual void	ShowAbout (HWND hWnd)=0
virtual int	DoExport (const MCHAR *name, ExpInterface *ei, Interface *i, BOOL suppressPrompts=FALSE, DWORD options=0)=0
virtual BOOL	SupportsOptions (int ext, DWORD options)

---

Constructor & Destructor Documentation

SceneExport

(

)

[inline]

Remarks:

Constructor.

{};

virtual ~SceneExport

(

)

[inline, virtual]

Remarks:

Destructor.

{};

---

Member Function Documentation

virtual int ExtCount

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the number of file name extensions supported by the plug-in.

virtual const MCHAR* Ext

(

int

n

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the 'i-th' file name extension (i.e. "3DS").

Parameters:

int i

The index of the file name extension to return.

virtual const MCHAR* LongDesc

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns a long ASCII description of the file type being exported (i.e. "Autodesk 3D Studio File").

virtual const MCHAR* ShortDesc

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns a short ASCII description of the file type being exported (i.e. "3D Studio").

virtual const MCHAR* AuthorName

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the ASCII Author name.

virtual const MCHAR* CopyrightMessage

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the ASCII Copyright message for the plug-in.

virtual const MCHAR* OtherMessage1

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the first message string that is displayed.

virtual const MCHAR* OtherMessage2

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the second message string that is displayed.

virtual unsigned int Version

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the version number of the export plug-in. The format is the version number * 100 (i.e. v3.01 = 301).

virtual void ShowAbout

(

HWND

hWnd

)

[pure virtual]

Search for all occurrences

Remarks:

This method is called to have the plug-in display its "About..." box.

Parameters:

HWND hWnd

The parent window handle for the dialog.

virtual int DoExport	(	const MCHAR *	name,
		ExpInterface *	ei,
		Interface *	i,
		BOOL	suppressPrompts = FALSE,
		DWORD	options = 0
	)		[pure virtual]

Search for all occurrences

Remarks:

This method is called for the plug-in to perform its file export.

Parameters:

const MCHAR *name

The export file name.

ExpInterface *ei

A pointer the plug-in may use to call methods to enumerate the scene.

Interface *i

An interface pointer the plug-in may use to call methods of 3ds Max.

BOOL suppressPrompts=FALSE

This parameter is available in release 2.0 and later only.

When TRUE, the plug-in must not display any dialogs requiring user input. It is up to the plug-in as to how to handle error conditions or situations requiring user input. This is an option set up for the 3ds Max API in order for plug-in developers to create batch export plugins which operate unattended. See Interface::ExportToFile().

DWORD options=0

This parameter is available in release 3.0 and later only.

In order to support export of selected objects (as well as future enhancements), this method now has this additional parameter. The only currently defined option is:

SCENE_EXPORT_SELECTED

When this bit is set the export module should only export the selected nodes.

Returns:

One of the following three values should be returned

#define IMPEXP_FAIL 0

#define IMPEXP_SUCCESS 1

#define IMPEXP_CANCEL 2

virtual BOOL SupportsOptions	(	int	ext,
		DWORD	options
	)		[inline, virtual]

Search for all occurrences

Remarks:

This method is called by 3ds Max to determine if one or more export options are supported by a plug-in for a given extension. It should return TRUE if all option bits set are supported for this extension; otherwise FALSE.

Note that the method has a default implementation defined in order to provide easy backward compatibility. It returns FALSE, indicating that no options are supported.

Parameters:

int ext

This parameter indicates which extension the options are being queried for, based on the number of extensions returned by the SceneExport::ExtCount() method. This index is zero based.

DWORD options

This parameter specifies which options are being queried, and may have more than one option specified. At present, the only export option is SCENE_EXPORT_SELECTED, but this may change in the future. If more than one option is specified in this field, the plugin should only return TRUE if all of the options are supported. If one or more of the options are not supported, the plugin should return FALSE.

Default Implementation:

{return FALSE;}

{ UNUSED_PARAM(ext); UNUSED_PARAM(options); return FALSE;}