COM object EvScene

EvApplication>EvFileCollection > EvFile > EvScenesCollection > EvScene

 

View the COM map and the COM summary.

The EvScene object gives you the ability access and export information about scenes in an EV file.

The EvFile.Scenes[] property lists all the scenes in an EV file and is an EvScenesCollection.

EvScene methods and properties:

DetectRegionTracks
Export
Export3dAnalysisByRegionsByRegionTracks
Export3dRegionInspectionData
Name

 

Description

DetectRegionTracks

DetectRegionTracks(EvRegionClass, [Name])

Summary

Detect region tracks within a group of 3D regions in a scene. The detection requires the scene analysis variable to be pre-specified and 3D regions from a prior multibeam schools detection to be displayed in a scene.

Parameters
  • EvRegionClass
  • Specify a region class. This is equivalent to displaying a region class object on a scene. The region class is output by a prior schools detection on a multibeam variable.
  • Name (optional)
  • The name of a new region tracks group. Echoview can apply a default name when a name is not supplied. The default names is of the form '3D region track group #', where # is a unique ID number.
Return

Number of regions tracks detected. Returns -1 when the region detection has failed.

Example
'Open the EV file
Set EvApp = CreateObject("EchoviewCom.EvApplication")
Set vEvFile = EvApp.OpenFile("PathToYourEVFile.EV")

'Specify a scene and 3D regions for the scene
Dim vScene1: Set vScene1 = vEvFile.Scenes.FindByName("Scene1")
Dim v3DRegions: Set v3DRegions = vEvFile.RegionClasses.FindByName("3DRegions")

'Detect region tracks
Dim vTracks: vTracks = vScene1.DetectRegionTracks(v3DRegions, "")
MsgBox "Detected " & CStr(vTracks) & " region tracks"

Export

Export(string FileName)

Summary

Export the scene to the given file.

Parameters
  • FileName
  • Name of the file to export the scene to.
Return

Whether successful.

Export3dAnalysisByRegionsByRegionTracks

Export3dAnalysisByRegionsByRegionTracks(string FileName)

Summary

Export the scene's 3D analysis by regions by region tracks to the given file. The export operates on a 3D region class object.

Parameters
Return

Whether successful.

Export3dRegionInspectionData

Export3dRegionInspectionData(string FileName, EvRegion)

Summary

Export the scene's region inspection data to the given file. The file extension dictates the export format, refer to Exporting 3D objects for more information.

Parameters
  • FileName
  • Name of the file to export to.
  • EvRegion
  • The 3D region, as specified by EvRegion.Name.
Return

Whether successful.

Name

(read-write) string Name

Summary

Access or change the name of the scene.

See also

Scripting with COM objects
COM object hierarchy
EvScenesCollection