Note: The following code samples demonstrate how to call OgreMax commands using the JScript language.

OgreMax Version

To get the version of the installed OgreMax plugin:

• var version = OgreMaxGetVersion()

Scene, Object, and Animation Settings

The scene and object settings that are normally accessible through the Scene Settings and Object Settings dialogs can also be accessed through script.

Scene Settings

To get the scene settings:

• var sceneSettings = OgreMaxGetSceneSettings()

Object Settings

• To access the settings for the currently selected object: var objectSettings = OgreMaxGetObjectSettingsByName("")
• To access the settings for an object by name: var objectSettings = OgreMaxGetObjectSettingsByName("Box01")
• To access the settings for a particular object: var objectSettings = OgreMaxGetObjectSettingsByObject(theObject)

Mesh and Node Animation Settings

To add a mesh animation:

• To add an animation to an object with a particular name: var animSettings = OgreMaxAddMeshAnimationForObjectName("Box01", "Idle")
• To add an animation to a particular object or its object settings: var animSettings = OgreMaxAddMeshAnimationForObject(theObject or objectSettings, "Idle")

To add a node animation:

• To add an animation to an object with a particular name: var animSettings = OgreMaxAddNodeAnimationForObjectName("Box01", "Box01Move")
• To add an animation to a particular object or its object settings: var animSettings = OgreMaxAddNodeAnimationForObject(theObject or objectSettings, "Box01Move")

Inspecting Settings

After retrieving any of the settings objects, you can inspect their parameters:

• InspectObj(sceneSettings)
• InspectObj(objectSettings)
• InspectObj(animSettings)

Exporting

In the following lines of code fileName is assumed to contain the path to the file where the scene will be exported. It must have the '.scene', '.model', or '.mesh' extension.

• To export the scene: OgreMaxExportScene(fileName)
• To export the selected objects: OgreMaxExportSelectedObjects(fileName)

Shader Program Names

To get all the shader program names for a particular shader type, shaderType must contain "VertexShader", "PixelShader", "ShadowCasterVertexShader", "ShadowReceiverVertexShader", or "ShadowReceiverPixelShader":

• OgreMaxGetShaderNames(shaderType)

Synchronizing Submesh Settings

When you open the Object Settings dialog for a mesh, the submesh settings are automatically synchronized to the mesh and its materials so that the Customize Submeshes settings may be set. The synchronization can also be performed by script:

• To synchronize the submesh settings for the selected objects: OgreMaxSyncSubmeshSettingsByName("")
• To synchronize the submesh settings for objects by name: OgreMaxSyncSubmeshSettingsByName("Box01", "Box02", "Box03")
• To synchronize the submesh settings for particular objects: OgreMaxSyncSubmeshSettingsByObject(theObject1, theObject2, theObject3)