VRExportSettings

3VR Export Settings.

@example:
# settings class to export the scene as a 3vr file.
view = ce.get3DViews()[0]
exportSettings = VRExportSettings()
exportSettings.setOutputPath(ce.toFSPath("models"))
exportSettings.setExperienceName("RedevelopmentVR")
exportSettings.setRenderSettings(view)
exportSettings.setBookmarks(view.getBookmarks())
exportSettings.setScenarios(ce.getScenarioIds())
# The 3VR export always exports the complete scene.
# Therefore no selection is needed and we pass None.
ce.export(None, exportSettings)

 

Methods defined here:

getBookmarks

getBookmarks(self):

Gets the list of bookmark names which are exported.

@return: result. [sequence]

@example:
exportSettings = VRExportSettings()
print exportSettings.getBookmarks()

getExperienceName

getExperienceName(self):

Gets the name of the 3VR experience.

@return: result. [str]

@example:
exportSettings = VRExportSettings()
print exportSettings.getExperienceName()

getOutputPath

getOutputPath(self):

Gets the export folder path.

@return: The absolute system path to the folder for the exported file. [str]

@example:
exportSettings = VRExportSettings()
print exportSettings.getOutputPath()

getScenarios

getScenarios(self):

Gets the list of scenario ids which are included in the export or None if the current layer visibility is used.

@return: result. [sequence]

@example:
exportSettings = VRExportSettings()
print exportSettings.getScenarios()

setBookmarks

setBookmarks(self, bookmarks):

Sets the list of bookmark names which are exported.

@param bookmarks: The list of bookmarks which are used for the export. If a given bookmark name does not exist, it will not be added to the list of exported bookmarks.  [sequence]

@example:
view = ce.get3DViews()[0]
exportSettings = VRExportSettings()
exportSettings.setBookmarks(view.getBookmarks())

setExperienceName

setExperienceName(self, experienceName):

Sets the exported name of the 3VR experience.

@param experienceName: The name of the exported 3VR experience.  [str]

@example:
exportSettings = VRExportSettings()
exportSettings.setExperienceName("RedevelopmentVR")

setOutputPath

setOutputPath(self, outputPath):

Sets the folder path in which to export.

@param outputPath: The absolute system path to the folder which will contain the exported file.  [str]

@example:
exportSettings = VRExportSettings()
exportSettings.setOutputPath(ce.toFSPath("models"))

setRenderSettings

setRenderSettings(self, settings):

Sets the 3D view whose render settings are used when exporting the panoramas or None to use default render settings.

@param settings: The 3D view whose render settings are used when exporting the panoramas or None to use default render settings.

@example:
view = ce.get3DViews()[0]
exportSettings = VRExportSettings()
exportSettings.setRenderSettings(view)

setScenarios

setScenarios(self, scenarios):

Sets the scenarios which are included in the export.

@param scenarios: The list of scenarios which will be included in the export or None to use the current layer visibility. If a given scenario id does not exist, it will not be added to the list of exported scenarios.  [sequence]

@example:
exportSettings = VRExportSettings()
exportSettings.setScenarios(ce.getScenarioIds())