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

CSceneInterface CFilesInterface CMenuInterface CImportInterface
CExportInterface CObjectInterface CExternalInterface
CPluginDialog CPluginObject
CAttributes CProgressBar C support Compiler Settings

What's New

CProgressBar

The CProgressBar is a helper class that takes care of setting up a MRY_PROGRESS_DATA struct and allows easier handling in C++.

Reference List of Functions

By Function Group Alphabetically
CProgressBar
~CProgressBar
IsOK
SetPos
Step
ChangeText
CProgressBar
ChangeText
IsOK
SetPos
Step
~CProgressBar



 

CProgressBar

The function CProgressBar is the constructor for the class.

    CProgressBar(LPMRY_SCENEFUNCS pFuncs, int nTotal, const char* pszPrompt);

Parameters

pFuncs

A pointer to a scene interface.

nTotal

Determines the total range of the progress bar.

pszPrompt

Determines the prompt that is displayed to the left of the progress bar. This can be NULL if you do not want a prompt.

Remarks

The progress bar is created and displayed as soon as the object is instantiated.
If the progress bar cannot be created, an internal flag is set that can be queried with the IsOK function.

See Also

IsOK


Top
 

~CProgressBar

The function ~CProgressBar is the destructor and takes care of deleting the progress bar from Moray's interface.

     ~CProgressBar();

Remarks

Removes and hides the progress bar from Moray's status bar. You never need to call this....


Top
 

IsOK

The function IsOK returns a flag indicating whether the progress bar could be created.

    bool IsOK();

Remarks

This is set by the constructor. Use this function if you need to know whether


Top
 

SetPos

The function SetPos sets the progress bar to a specific position.

    void SetPos(int nPos);

Parameters

nPos

contains the position to which the progress bar should be set to. This should be less than the nTotal parameter passed to the constructor.

See Also

Step


Top
 

Step

The function Step steps the progress bar by one unit.

    void Step();

See Also

SetPos


Top
 

ChangeText

The function ChangeText changes the text of the progress bar's prompt.

    void ChangeText(const char* pszPrompt);

Remarks

The prompt is displayed to the left of the actual progress bar. The progress bar is resized so that there is always the same amount of space between the prompt and the actual progress bar.


Top