MAX_S3D_Plugin |
This class provides a predefined interface between 3D Studio MAX§ and the Shockwave 3D§ exporter. It is derived from a 3D Studio MAX common base class called SceneExport.
When to use
3D Studio MAX instantiates this class on a per need basis. Methods from this class are called when a user chooses to export a scene to W3D format. This is not, however, the top level exporter class as there is a descriptor class which is used to instantiate this class and provide plug-in information to the MAX core system.
|
Interface Method |
Description |
|
Class constructor |
|
|
Class destructor |
|
|
Returns the author name for this plugin |
|
|
Builds a bitstring for the different export options available |
|
|
Outputs a copyright message |
|
|
Called by the MAX framework when the S3D export format is selected |
|
|
Returns filename extensions associated with this plugin |
|
|
Returns the number of filename extensions that this plugin provides |
|
|
Returns the name of the configuration file which is used to save various user settings |
|
|
Returns TRUE if surface subdivision is enabled |
|
|
Returns TRUE if progressive download is enabled |
|
|
Returns TRUE if the the exported scene is to be previewed |
|
|
Returns TRUE if the user chooses to export animation data |
|
|
Returns TRUE if geometry data is exported |
|
|
Returns TRUE if the user chooses to export lights |
|
|
Returns TRUE if the user chooses to export texture maps |
|
|
Returns TRUE if the user chooses to export materials |
|
|
Returns TRUE if the user chooses to export shaders |
|
|
Returns TRUE if the user chooses to export the scenegraph hierarchy |
|
|
Returns the length of time for which animation is to be sampled for export |
|
|
Returns the start time of the animation sample range |
|
|
Returns the ending time of the animation sample range |
|
|
Returns a scalar that describes the degree of animation compression used for a given export |
|
|
Returns the overall image quality metric used by the exporter |
|
|
Returns a long ASCII description of the file type being exported |
|
|
Outputs a developer-defined message |
|
|
Outputs a developer-defined message |
|
|
Reads user configuration data from the configuration file |
|
|
Synchronizes user input that specifies whether or not to preview the exported scene |
|
|
Synchronizes user input that specifies whether or not to export animation data |
|
|
Synchronizes user input that specifies whether or not to export geometry data |
|
|
Synchronizes user input that specifies whether or not to export lights |
|
|
Synchronizes user input that specifies whether or not to export texture maps |
|
|
Synchronizes user input that specifies whether or not to export materials |
|
|
Synchronizes user input that specifies whether or not to export the scenegraph |
|
|
Returns a scalar that describes the precision (or quality) of exported geometry |
|
|
Synchronizes user input that specifies whether or not to export shader data |
|
|
Synchronizes user input from the main dialog, which specifies the animation sampling interval |
|
|
Returns a scalar that describes the precision (or quality) of exported textures |
|
|
Returns texture cap size |
|
|
Returns TRUE if export results are to be displayed |
|
|
Returns TRUE if authoring checks are enabled |
|
|
Synchronizes user input that specifies the animation sampling start time |
|
|
Synchronizes user input that specifies the animation sampling stop time |
|
|
Returns a scalar that describes the precision (or quality) of exported textures |
|
|
Synchronizes user input that is obtained via the main dialog, which specifies the overall export quality metric |
|
|
Sets a scalar that controls quality of exported geometry |
|
|
Sets a scalar that controls quality of exported textures |
|
|
Sets state of whether or not to enable surface |
|
|
Sets texture cap size |
|
|
Sets state of whether or not to display export results |
|
|
Sets state of whether or not to display authoring warnings |
|
|
Returns a short ASCII description of the file type being exported |
|
|
Displays an About dialog box |
|
|
Determines if one or more export options are supported by a plug-in for a given extension |
|
|
Returns the version number of the plugin |
|
|
Writes user-configuration data to a configuration file |
This is the class constructor. It initializes various internal fields used by the class.
Parameters:
None
Return Values:
None
This is the class destructor.
Parameters:
None
Return Values:
None
This method returns the author name for this plug-in.
Parameters:
None
Return Values:
|
virtual const TCHAR* |
This is the authors name. |
This method builds a bitstring for the different export options available. These include geometry resources and material resources.
Parameters:
None
This method outputs a copyright message.
Parameters:
None
Return Values:
|
const TCHAR* |
This is the copyright message. |
This method is called by the MAX framework when the S3D export format is selected. The S3D converter classes are instatiated from within this method. Calls to the converter classes that handle the actual conversion are also called from this method.
Parameters:
|
pName |
This is the name of the output (S3D) file. |
|
ei |
This is an exporter base class that the MAX API provides for plugin authors. |
|
i |
This is the interface of the core of the MAX API. |
|
suppressPrompts |
This indicates whether or not the plugin is to be run in automated (batch) mode, or if the plugin requires user intervention. If this parameter is true, this plugin is to be run in batch mode. |
|
options |
This provides for expanded user-definable parameters. |
Return Values:
|
I32 |
This returns non-zero if this method functioned correctly, 0 otherwise. |
This method returns filename extensions associated with this plug-in.
Parameters:
|
i |
Determines which extenstion is returned. |
Return Values:
|
const TCHAR* |
This is the actual filename extension. |
This method returns the number of filename extensions that this plug-in provides.
Parameters:
None
Return Values:
|
I32 |
This is the number of filename extensions provided. |
This method returns the ending time of the animation sample range. This time (along with the animation start time) specifies how much of the animation is to be exported.
Parameters:
None
Return Values:
|
U32 |
This is the end time for the animation sampling range. |
This method returns the start time of the animation sample range. This time (along with the animation end time) specifies how much of the animation is to be exported.
Parameters:
None
Return Values:
|
U32 |
This is the start time for the animation sampling range. |
This method returns a scalar that describes the degree of animation compression used for a given export.
Parameters:
None
Return Values:
|
F32 |
This is the animation compression metric. |
This method returns the name of the configuration file which is used to save various user settings. An example would be the export options or the animation sampling times.
Parameters:
None
Return Values:
|
TSTR |
This is the configuration filename. |
This method returns True if the user chooses to export animation data.
Parameters:
None
Return Values:
|
BOOL |
This is TRUE if the animation is to be exported. It will be false otherwise. |
This method returns TRUE if geometry data is exported.
Parameters:
None
Return Values:
|
BOOL |
This is TRUE if the geometry is to be exported. It will be false otherwise. |
This method returns TRUE if the user chooses to export lights.
Parameters:
None
Return Values:
|
BOOL |
This is TRUE if the lights are to be exported. It will be false otherwise. |
This method returns TRUE if the user chooses to export texture maps.
Parameters:
None
Return Values
|
BOOL |
This is TRUE if the texture maps are to be exported. It will be false otherwise. |
This method returns TRUE if the user chooses to export materials.
Parameters:
None
Return Values:
|
BOOL |
This is TRUE if the materials are to be exported. It will be false otherwise. |
This method returns TRUE if the user chooses to export shaders.
Parameters:
None
Return Values:
|
BOOL |
This is TRUE if the shaders are to be exported. It will be false otherwise. |
This method returns TRUE if the user chooses to export the scenegraph hierarchy.
Parameters:
None
Return Values:
|
BOOL |
This is TRUE if the scenegraph hierarchy is to be exported. It will be false otherwise. |
This method returns a scalar that describes the precision (or quality) of exported geometry.
Parameters:
None
Return Values:
|
F32 |
This is the precision of the exported geometry. |
This method returns True if the the exported scene is to be previewed.
Parameters:
None
Return Values:
|
BOOL |
This is true if the export preview is to be displayed. It will be false otherwise. |
This method returns the overall image quality metric used by the exporter. The range is from 0 to 1000, with 1000 being minimal compression, and 0 being maximum compression.
Parameters:
None
Return Values:
|
U32 |
This is the quality metric. |
This method returns the length of time for which animation is to be sampled for export.
Parameters:
None
Return Values:
|
U32 |
This is the sample interval. |
This method returns a scalar that describes the precision (or quality) of exported textures.
Parameters:
None
Return Values:
|
F32 |
This is the precision of the exported textures. |
This method returns a long ASCII description of the file type being exported.
Parameters:
None
Return Values:
|
const TCHAR* |
This is the long description of the type of export. |
This method writes out a developer-defined message.
Parameters:
None
Return Values:
|
const TCHAR* |
The message. |
This method writes out a developer-defined message.
Parameters:
None
Return Values:
|
const TCHAR* |
The message. |
This method reads user-configuration data from the configuration file.
Parameters:
None
Return Values:
|
BOOL |
0 if successful, 1 otherwise. |
Comments:
See GetCfgFilename and WriteConfig.
This method synchronizes user input that specifies whether or not to preview the exported scene with an internal state variable.
Parameters:
|
val |
This is TRUE if the preview state variable is to be asserted. It will be FALSE otherwise. |
Return Values:
None
This method synchronizes user input that specifies whether or not to export animation data with an internal state variable.
Parameters:
|
val |
This is TRUE if the animation export state variable is to be asserted. It will be FALSE otherwise. |
Return Values:
None
This method synchronizes user input that specifies whether or not to export geometry data with an internal state variable.
Parameters:
|
val |
This is TRUE if the geometry export state variable is to be asserted. It will be FALSE otherwise. |
Return Values:
None
This method synchronizes user input that specifies whether or not to export lights with an internal state variable.
Parameters:
|
val |
This is TRUE if the lights export state variable is to be asserted. It will be FALSE otherwise. |
Return Values:
None
This method synchronizes user input that specifies whether or not to export texture maps with an internal state variable.
Parameters:
|
val |
This is TRUE if the map export state variable is to be asserted. It will be FALSE otherwise. |
Return Values:
None
This method synchronizes user input that specifies whether or not to export materials with an internal state variable.
Parameters:
|
val |
This is TRUE if the material export state variable is to be asserted. It will be FALSE otherwise. |
Return Values:
None
This method synchronizes user input that specifies whether or not to export the scenegraph with an internal state variable.
Parameters
|
val |
This is TRUE if the scenegraph export state variable is to be asserted. It will be FALSE otherwise. |
Return Values:
None
This method synchronizes user input that specifies whether or not to export shader data with an internal state variable.
Parameters:
|
val |
This is TRUE if the shader export state variable is to be asserted. It will be FALSE otherwise. |
Return Values:
None
This method synchronizes user input that specifies the animation sampling interval with an internal state variable.
Parameters:
|
val |
This specifies the animation sampling interval. |
Return Values:
None
This method synchronizes user input that specifies the animation sampling start time with an internal state variable.
Parameters:
|
val |
This specifies the animation sampling start time. |
Return Values:
None
This method synchronizes user input that specifies the animation sampling end time with an internal state variable.
Parameters
|
val |
This specifies the animation sampling end time. |
Return Values:
None
This method returns a scalar that describes the precision (or quality) of exported textures.
Parameters:
|
val |
This is the animation compression metric. |
Return Values:
None
This method sets a scalar that controls the quality of exported geometry.
Parameters:
|
val |
This is the geometric compression metric. |
Return Values:
None
This method sets a scalar that controls quality of exported textures.
Parameters:
|
val |
This is the textures compression metric. |
Return Values:
None
This method synchronizes user input that specifies the overall export quality metric with an internal state variable.
Parameters:
|
val |
This specifies the quality metric. |
Return Values:
None
This method returns a short ASCII description of the file type being exported.
Parameters:
None
Return Values:
|
const TCHAR* |
This is the short file type description. |
This method displays an About dialog box.
Parameters:
|
hWnd |
Handle to MAX main window. |
Return Values:
None
This method determines if one or more export options are supported by a plug-in for a given extension. It returns TRUE if all option bits set are supported for this extension; otherwise it returns FALSE.
Parameters:
|
ext |
This parameter indicates for which extension the options are being queried. |
|
options |
This specifies which options are being queried. |
Return Values:
|
BOOL |
1 if successful, 0 otherwise. |
This method returns the version number of the plug-in.
Parameters:
None
Return Values:
|
U32 |
This is the plugin version number. |
This method writes configuration data to a file.
Parameters:
None
Return values:
None
This method determines if subdivision subdivision is enabled. It returns TRUE if it is enabled; otherwise it returns FALSE.
Parameters:
None
Return Values:
|
BOOL |
1 if successful, 0 otherwise. |
This method determines if progressive downlead is enabled. It returns TRUE if it is enabled; otherwise it returns FALSE.
Parameters:
None
Return Values:
|
BOOL |
1 if successful, 0 otherwise. |
This method returns texture cap size.
Parameters:
None
Return Values:
|
U32 |
Size |
This method determines if export results are to be displayed. It returns TRUE if it is enabled; otherwise it returns FALSE.
Parameters:
None
Return Values:
|
BOOL |
1 if successful, 0 otherwise. |
This method determines if authoirng checks are enabled. It returns TRUE if all option bits set are supported for this extension; otherwise it returns FALSE.
Parameters:
None
Return Values:
|
BOOL |
1 if successful, 0 otherwise. |
This method sets state of whether or not to enable surface subdivision.
Parameters:
|
val |
This is TRUE if the surface subdivsion is enabled. It will be FALSE otherwise. |
Return Values:
None
This method sets texture cap size.
Parameters:
|
val |
Texture cap size |
Return Values:
None
This method state of whether or not to display export results.
Parameters:
|
val |
This is TRUE (=any number except 0) if the export results are displayed. It will be FALSE (=0) otherwise. |
Return Values:
None
This method sets state of whether or not to display authoring warnings.
Parameters:
|
val |
This is TRUE (=any number except 0) if the export results are displayed. It will be FALSE (=0) otherwise. |
Return Values:
None
§See asterisked (*) statement at Legal Information © 2001 Intel Corporation.