Moray Plugin SDK Documentation

This release of the Plugin SDK can be used by Moray V3.5 (Build 9065) and later.

Scene Interface	Files Interface	Menu Interface	Import Interface
Export Interface	Object Interface	Controller Interface	External Interface
Data Structures	C++ Support	Compiler Settings

What's New

Files Interface

The Files Interface allows a plugin to use the custom File handling capabilities that Moray offers, like maintaining Search Paths and Directory histories. It also handles saving these settings across sessions.

It is recommended that you use this interface, unless you need to use your own File Dialog template, since users will be used to the functionality the File Selector offers (Last used directory and Search Paths).

Reference List of Functions
By Function Group	Alphabetically
PromptForFilename QualifyFilename	PromptForFilename QualifyFilename

PromptForFilename

The function PromptForFilename prompts the user for a filename of a certain type.

long WINAPI fnPromptForFilename(int nType, char *pszName, int nAttribs);

Parameters

nType	Contains the type of file that should be prompted for. See Remarks.
pszName	Contains the location where the name of the file should be written to.
nAttribs	Contains flags that determine the behaviour of the File Selector that pops up. See Remarks.

Return Values

MRY_SUCCESS	if the function was successful.
MRY_ERR_NO_FILE_SELECTED	if no file was selected (Cancel was pressed).

Remarks

This function can be used to prompt the user for a file and have Moray handle the maintenance of the Search paths associated with the file type.

The nType parameter can be one of the following values:

MRY_FILES_MORAY_SCENE - The location of the normal Moray (*.MDL) scenes.
MRY_FILES_POLYRAY_SCENE - The location of Polyray (*.PI) scenes, i.e. the output directory for Polyray.
MRY_FILES_POVRAY_SCENE - The location of POV-Ray (*.POV) scenes, i.e. the output directory for POV-Ray.
MRY_FILES_IMAGEMAP - The location of bitmap files for use with image maps.
MRY_FILES_BUMPMAP - The location of bitmap files for use with bump maps.
MRY_FILES_HEIGHTFIELD - The location of bitmap files for use with heightfields.
MRY_FILES_USER_OBJECT - The location of user-defined object (*.UDO) files.
MRY_FILES_RAWFILE - The location of raw triangle mesh (*.RAW) files.
MRY_FILES_BLOBFILE - The location of blob (*.BLB) files.
MRY_FILES_GLYPHFILE - The location of glyph (*.DAT) files. Not used.
MRY_FILES_BACKDROP - The location of bitmap files for use with backdrops.
MRY_FILES_TRUETYPE - The location of font files for use with the TTF object.
MRY_FILES_INCFILE - The location of include (*.INC) files.
MRY_FILES_MORAY_OBJECTS - The location of the Moray Object (*.MDL) files.
MRY_FILES_TEXTURE_LIB - The location of the Moray Texture Library (*.MTX) files.
MRY_FILES_PLUGINS - The location of Moray Plugins (*.DLL).
nTypeID - The location of files that this interface is handling.

The nAttribs parameter can be a combination of the following flags:

MRY_FILES_LOADDIALOG - The File Selector should ask for a file to load.
MRY_FILES_SAVEDIALOG - The File Selector should ask for a file to save.
MRY_FILES_FILEMUSTEXIST - The file that is selected must exist.
MRY_FILES_OVERWRITEPROMPT - If the selected file exists, ask whether it is to be overwritten.
MRY_FILES_PATHMUSTEXIST - The directory of the file that was selected/entered must exist.
MRY_FILES_HIDEREADONLY - The File Selector should not show read-only files.

The pszName parameter will contain only the filename, not the path, unless the file type is MRY_FILES_MORAY_SCENE, MRY_FILES_MORAY_OBJECTS or MRY_FILES_TEXTURE_LIB. In those cases the parameter will contain the full path name. To obtain the full path name in the other cases, use the QualifyFilename function.

The pszName parameter must be initialized and should contain the default filename. If you do not want a default name, set it to a zero-length string.

MRY_SUCCESS	if the function was successful.
MRY_ERR_FILE_NOT_FOUND	if the file could not be found.