vrdFileExportSettings

class vrdFileExportSettings

(Inherits vrdData)

class SurfaceExportMode

Keeps surfaces as surfaces, converts surfaces to a mesh, or excludes all surfaces.

Surface

Keeps surfaces as surfaces.

Mesh

Converts surfaces to a mesh.

Both

Converts surfaces to a mesh and a surface.

None_

Excludes all surfaces.

Summary

Functions:

Functions

vrdFileExportSettings.getExportAnimationClips()

Check if it is allowed to export animation clips.

Returns:The present state of animation clip export
Return type:bool
vrdFileExportSettings.getExportAnimationCurves()

Check if it is allowed to export animation curves.

Returns:The present state of animation curve export
Return type:bool
vrdFileExportSettings.getExportAnnotations()

Check if it is allowed to export annotations.

Returns:The present state of annotation export
Return type:bool
vrdFileExportSettings.getExportCameras()

Check if it is allowed to export cameras.

Returns:The present state of camera export
Return type:bool
vrdFileExportSettings.getExportColors()

Check if it is allowed to export colors.

Returns:The present state of color export
Return type:bool
vrdFileExportSettings.getExportEnvironmentGeometries()

Check if it is allowed to export environment geometries.

Returns:The present state of environment geometry export
Return type:bool
vrdFileExportSettings.getExportGeometrySwitches()

Check if it is allowed to export geometry switches.

Returns:The present state of geometry switch export
Return type:bool
vrdFileExportSettings.getExportInvisibleData()

Check if it is allowed to export invisible data.

Returns:The present state of invisible data export
Return type:bool
vrdFileExportSettings.getExportLightmaps()

Check if it is allowed to export lightmaps.

Returns:The present state of lightmap export
Return type:bool
vrdFileExportSettings.getExportLights()

Check if it is allowed to export lights.

Returns:The present state of light export
Return type:bool
vrdFileExportSettings.getExportMaterialSwitches()

Check if it is allowed to export material switches.

Returns:The present state of material switch export
Return type:bool
vrdFileExportSettings.getExportMeshes()

Check if it is allowed to export meshes.

Returns:The present state of mesh export
Return type:bool
vrdFileExportSettings.getExportMetadata()

Check if it is allowed to export metadata.

Returns:The present state of metadata export
Return type:bool
vrdFileExportSettings.getExportSceneplates()

Check if it is allowed to export sceneplates.

Returns:The present state of sceneplate export
Return type:bool
vrdFileExportSettings.getExportScripts()

Check if it is allowed to export scripts.

Returns:The present state of script export
Return type:bool
vrdFileExportSettings.getExportSurfaces()

Check if it is allowed to export surfaces.

Returns:The present state of surface export
Return type:SurfaceExportMode
vrdFileExportSettings.getExportTouchSensors()

Check if it is allowed to export touch sensors.

Returns:The present state of touch sensor export
Return type:bool
vrdFileExportSettings.getExportTransformVariants()

Check if it is allowed to export transform variants.

Returns:The present state of transform variant export
Return type:bool
vrdFileExportSettings.getExportVariants()

Check if it is allowed to export variants.

Returns:The present state of variant export
Return type:bool
vrdFileExportSettings.getExportVariantSets()

Check if it is allowed to export variant sets with their different geometry and material switches.

Returns:The present state of variant set export
Return type:bool
vrdFileExportSettings.getExportVertexColors()

Check if it is allowed to export vertex colors.

Returns:The present state of vertex color export
Return type:bool
vrdFileExportSettings.getFbxFormat()

Query the FBX format.

Returns:The present used FBX format
Return type:integer
vrdFileExportSettings.getFbxVersionId()

Query the used FBX version id.

Returns:The present used FBX version id
Return type:integer
vrdFileExportSettings.getInlineTextures()

Query if textures in exported files will be inlined.

Returns:The present state of inline texture clearance
Return type:bool
vrdFileExportSettings.getKeepDefaultCameras()

Check if default cameras should be included when exporting cameras.

Returns:The present state of default camera export
Return type:bool
vrdFileExportSettings.getKeepEmptyGeometryNodes()

Query how empty geometries are handled.

Returns:The present state of empty geometry export handling
Return type:bool
vrdFileExportSettings.getKeepEmptyGroupNodes()

Query how empty groups are handled.

Returns:The present state of empty group export handling
Return type:bool
vrdFileExportSettings.getKeepEmptyMaterialGroupNodes()

Query how empty material groups are handled.

Returns:The present state of empty material group export handling
Return type:bool
vrdFileExportSettings.getKeepEmptyShellNodes()

Query how empty shells are handled.

Returns:The present state of empty shell export handling
Return type:bool
vrdFileExportSettings.getKeepUnusedMaterials()

Query how unused materials are handled. Keeps material group nodes that contain no child nodes.

Returns:The present state of unused material export handling
Return type:bool
vrdFileExportSettings.getRemoveBSides()

Check if it is allowed to remove all B sides.

Returns:The present state of B-Side remove clearance
Return type:bool
vrdFileExportSettings.getStlFormat()

Query the used STL format.

Returns:The present used STL format
Return type:integer
vrdFileExportSettings.getTextureCompressionMode()
Returns:The present texture compression state
Return type:vrFileTypes.TextureCompressionMode
vrdFileExportSettings.getTextureCompressionQuality()
Returns:The present texture compression quality
Return type:integer
vrdFileExportSettings.setExportAnimationClips(enable)

Allows to export animation clips.

Parameters:enable (bool) – The new state of animation clip export
vrdFileExportSettings.setExportAnimationCurves(enable)

Allows to export animation curves.

Parameters:enable (bool) – The new state of animation curve export
vrdFileExportSettings.setExportAnnotations(enable)

Allows to export annotations.

Parameters:enable (bool) – The new state of annotation export
vrdFileExportSettings.setExportCameras(enable)

Allows to export cameras.

Parameters:enable (bool) – The new state of camera export
vrdFileExportSettings.setExportColors(enable)

Allows to export colors on polygon mesh segments.

Parameters:enable (bool) – The new state of color export
vrdFileExportSettings.setExportEnvironmentGeometries(enable)

Allows to export environment geometries.

Parameters:enable (bool) – The new state of environment geometry export
vrdFileExportSettings.setExportGeometrySwitches(enable)

Allows to export geometry switches If geometry switches are not enabled, this could affect variants and variant sets.

Parameters:enable (bool) – The new state of geometry switch export
vrdFileExportSettings.setExportInvisibleData(enable)

Export invisible nodes as visible nodes (true) or remove all invisible nodes from export (false).

Parameters:enable (bool) – The new state of invisible data export
vrdFileExportSettings.setExportLightmaps(enable)

Allows to export lightmaps. Depending on the resolution, lightmaps can be very large, in terms of the amount of data.

Parameters:enable (bool) – The new state of lightmap export
vrdFileExportSettings.setExportLights(enable)

Allows to export lights.

Parameters:enable (bool) – The new state of light export
vrdFileExportSettings.setExportMaterialSwitches(enable)

Allows to export material switches If material switches are not enabled, this could affect variants and variant sets.

Parameters:enable (bool) – The new state of material switch export
vrdFileExportSettings.setExportMeshes(enable)

Allows to export meshes.

Parameters:enable (bool) – The new state of mesh export
vrdFileExportSettings.setExportMetadata(enable)

Allows to export metadata.

Parameters:enable (bool) – The new state of metadata export
vrdFileExportSettings.setExportSceneplates(enable)

Allows to export sceneplates.

Parameters:enable (bool) – The new state of sceneplate export
vrdFileExportSettings.setExportScripts(enable)

Allows to export scripts.

Parameters:enable (bool) – The new state of script export
vrdFileExportSettings.setExportSurfaces(mode)

Allows to export surfaces.

Parameters:mode (SurfaceExportMode) –
vrdFileExportSettings.setExportTouchSensors(enable)

Allows to export touch sensors.

Parameters:enable (bool) – The new state of touch sensor export
vrdFileExportSettings.setExportTransformVariants(enable)

Allows to export transform variants.

Parameters:enable (bool) – The new state of transform variant export
vrdFileExportSettings.setExportVariants(enable)

Allows to export variants.

Parameters:enable (bool) – The new state of variant export
vrdFileExportSettings.setExportVariantSets(enable)

Allows to export variant sets.

Parameters:enable (bool) – The new state of variant set export
vrdFileExportSettings.setExportVertexColors(enable)

Keeps existing red, green, and blue values stored for each vertex in the model.

Parameters:enable (bool) – The new state of vertex color export
vrdFileExportSettings.setFbxFormat(format)

Set the FBX format 0: Binary 1: ASCII.

Parameters:format (integer) – The new FBX format
vrdFileExportSettings.setFbxVersionId(id)

Set the FBX version id 0: FBX 2020 2019: FBX 2019 2018: FBX 2018 2016: FBX 2016/2017 2014: FBX 2014/2015 2013: FBX 2013 2012: FBX 2012 2011: FBX 2011.

Parameters:id (integer) – The new FBX version id
vrdFileExportSettings.setInlineTextures(enable)

Embeds the texture data in the geometry file. When disabled, texture images are stored in separate files that are referenced in the geometry file.

Parameters:enable (bool) – New state of inline texture clearance
vrdFileExportSettings.setKeepDefaultCameras(enable)

Include default cameras when exporting cameras, i.e., this setting only has an effect if cameras are exported.

Parameters:enable (bool) – The new state of default camera export
vrdFileExportSettings.setKeepEmptyGeometryNodes(keep)

Keeps geometry nodes containing no polygons in exported data.

Parameters:keep (bool) – The new state of empty geometry export handling
vrdFileExportSettings.setKeepEmptyGroupNodes(keep)

Keeps empty groups in exported data.

Parameters:keep (bool) – The new state of empty group export handling
vrdFileExportSettings.setKeepEmptyMaterialGroupNodes(keep)

Keeps empty material groups in exported data.

Parameters:keep (bool) – The new state of empty material group export handling
vrdFileExportSettings.setKeepEmptyShellNodes(keep)

Keeps empty shell nodes without children in exported data.

Parameters:keep (bool) – The new state of empty shell export handling
vrdFileExportSettings.setKeepUnusedMaterials(keep)

Keeps unused materials in exported data. A large number of unused materials can increase the amount of data.

Parameters:keep (bool) – The new state of unused material export handling
vrdFileExportSettings.setRemoveBSides(enable)

A B-Side definition is comparable with the No Show feature in CAD software. When enabled, this removes all shapes and components set as a B-Side.

Parameters:enable (bool) – The new state of B-Side remove clearance
vrdFileExportSettings.setStlFormat(format)

Set the used STL format 0: Binary 1: ASCII.

Parameters:format (integer) – The new STL format
vrdFileExportSettings.setTextureCompressionMode(mode)

Sets the texture compression mode for osb and vpb file formats. Using ‘Lossy’ will take the compression quality into account.

Parameters:mode (vrFileTypes.TextureCompressionMode) – New texture compression mode
vrdFileExportSettings.setTextureCompressionQuality(quality)

Sets the texture compression quality for the lossy compression mode. The value will be clamped to the range 1 .. 100.

Parameters:quality (integer) – New texture compression quality
vrdFileExportSettings.vrdFileExportSettings()

Create an empty vrdFileExportSettings object.

vrdFileExportSettings.vrdFileExportSettings(other)

Create a copy of another vrdFileExportSettings object.

Parameters:other (vrdFileExportSettings) – The template object, we will copy from
vrdFileExportSettings.~vrdFileExportSettings()