Click or drag to resize

IMcImageSetGetOptimalZLocation Method

Returns the optimal Z location for a specified location of the set

Namespace:  MediaCy.IQL.Sets
Assembly:  MediaCy.IQL.Sets (in MediaCy.IQL.Sets.dll) Version: 10.0.6912.0
Syntax
VB
Copy
Function GetOptimalZLocation ( 
	Location As McImageSetLocations
) As Integer

Parameters

Location
Type: MediaCy.IQL.SetsMcImageSetLocations

Return Value

Type: Int32
Remarks
The optimal Z location is an attribute of the set that is typically used in navigating the set. While McImageSet does not directly support navigating through sets (i.e. displaying the correct frame of the correct image while playing along the active dimension), McImageSet does implement the properties necessary to support this navigation. The optimal Z location can be specified for all of the locations of the set along the other dimensions. Typically it is set to the best focus position or by the user to a position of interest. Note that the location returned is a location along the Z dimension, not a Z position in some absolute unit of measurement. Parameters Location : The location for which to return the optimal Z position. This location must exist within the set.
See Also