hwIH3DExportOptions SetWritePreviewImage

Dictates whether a JPEG preview image is embedded in the file.

Syntax

hwIH3DExportOptions_handle SetWritePreviewImage flag

Application

Tcl Modify

Description

The H3D format supports holding a JPEG preview image which the HyperView player plugin can display in a browser before the player is activated.

This command is related to the H3D option on the Publish Session dialog.

Inputs

flag
True or false.

Example

To disable writing the preview image:
hwi GetSessionHandle mySessionName
mySessionName GetH3DExportOptionsHandle option_handle
option_handle SetWritePreviewImage true

Errors

None.