documentation

Visometry.VisionLib.SDK.Core.API.MultiModelTrackerCommands Class Reference

Commands for communicating with the multi-model tracker. More...

Inherits Visometry.VisionLib.SDK.Core.API.ModelTrackerCommands.

Inherited by Visometry.VisionLib.SDK.Core.API.Internal.MultiModelTrackerCommandsInternal.

Data Structures

class  AnchorAddModelDataCommand
 
class  AnchorAttribute
 
class  BinaryAnchorCommandDescription
 

Static Public Member Functions

static async Task AddAnchorAsync (Worker worker, string anchorName, bool enabled)
 Adds a new anchor to the tracker More...
 
static async Task AnchorAddModelAsync (Worker worker, string anchorName, ModelProperties modelProperties)
 
static async Task< ModelDeserializationResultListAnchorAddModelDataAsync (Worker worker, string anchorName, ModelDataDescriptorList models, IntPtr data, UInt32 dataSize)
 
static async Task< bool > AnchorExistsAsync (Worker worker, string anchorName)
 Returns true if the given anchor exists; returns false otherwise More...
 
static async Task< InitPose?> AnchorGetInitPoseAsync (Worker worker, string anchorName)
 
static async Task AnchorRemoveModelAsync (Worker worker, string anchorName, string modelName)
 
static async Task AnchorResetHardAsync (Worker worker, string anchorName)
 Performs a Hard Reset to a specific anchor More...
 
static async Task AnchorResetSoftAsync (Worker worker, string anchorName)
 Performs a Soft Reset to a specific anchor More...
 
static async Task AnchorSetAttributeAsync (Worker worker, string attributeName, List< AnchorAttribute > anchorValueList)
 Sets an attribute of a specific anchor More...
 
static async Task AnchorSetModelPropertiesAsync (Worker worker, string anchorName, ModelDataDescriptorList models)
 
static async Task AnchorSetModelPropertyAsync (Worker worker, string anchorName, ModelProperty property, string name, bool value)
 
static async Task AnchorSetModelPropertyEnabledAsync (Worker worker, string anchorName, string name, bool value)
 
static async Task AnchorSetModelPropertyOccluderAsync (Worker worker, string anchorName, string name, bool value)
 
static async Task AnchorSetModelPropertyURIAsync (Worker worker, string anchorName, string name, string uri)
 
static async Task AnchorSetWorkSpaceAsync (Worker worker, string anchorName, WorkSpace.Configuration config)
 Performs a SetWorkSpaceCommand to a specific anchor More...
 
static async Task DisableAnchorAsync (Worker worker, string anchorName)
 Disables an anchor More...
 
static async Task DisableConstraintAsync (Worker worker, string anchorName)
 
static async Task DisableInitPoseAsync (Worker worker, string anchorName)
 Disables the use of an init pose for the anchor. More...
 
static async Task EnableAnchorAsync (Worker worker, string anchorName)
 Enables an anchor More...
 
static async Task RemoveAnchorAsync (Worker worker, string anchorName)
 Removes am existing anchor from the tracker More...
 
static async Task Set1DRotationConstraintAsync (Worker worker, string anchorName, Vector3 worldUpVector, Vector3 modelUpVector, Vector3 modelCenter)
 
static async Task SetGlobalObjectPoseAsync (Worker worker, string anchorName, InitPose initPose)
 Sets the global object pose of the given anchor More...
 
- Static Public Member Functions inherited from Visometry.VisionLib.SDK.Core.API.ModelTrackerCommands
static async Task AddModelAsync (Worker worker, ModelProperties properties)
 
static async Task< ModelDeserializationResultListAddModelDataAsync (Worker worker, ModelDataDescriptorList models, IntPtr data, UInt32 dataSize)
 
static async Task DisableConstraintAsync (Worker worker)
 
static async Task< InitPose?> GetInitPoseAsync (Worker worker)
 Get the initial pose. More...
 
static async Task< ModelPropertiesStructureGetModelPropertiesAsync (Worker worker)
 
static async Task< string > GetNonDefaultAttributesAsync (Worker worker)
 Get the current state of all model tracker parameters that do not have their default value. More...
 
static async Task ReadInitDataAsync (Worker worker, string filePrefix)
 Read init data from custom location with custom file name. More...
 
static async Task RemoveModelAsync (Worker worker, string modelName)
 
static async Task ResetHardAsync (Worker worker)
 Resets the tracking and all keyframes. More...
 
static async Task ResetInitDataAsync (Worker worker)
 Reset Offline init data More...
 
static async Task ResetSoftAsync (Worker worker)
 Resets the tracking. More...
 
static async Task Set1DRotationConstraintAsync (Worker worker, Vector3 worldUpVector, Vector3 modelUpVector, Vector3 modelCenter)
 
static async Task SetGlobalCoordinateSystemAsync (Worker worker, IntPtr nativeISpatialCoordinateSystemPtr)
 Set the global coordinate system of Unity to be used in the vlSDK More...
 
static async Task SetGlobalObjectPoseAsync (Worker worker, InitPose objectPose)
 Set the global pose of the object to track. More...
 
static async Task SetInitPoseAsync (Worker worker, InitPose initPose)
 Set the initial pose. More...
 
static async Task SetModelPropertyAsync (Worker worker, ModelProperty property, string name, bool value)
 
static async Task SetModelPropertyEnabledAsync (Worker worker, string name, bool value)
 
static async Task SetModelPropertyOccluderAsync (Worker worker, string name, bool value)
 
static async Task SetModelPropertyURIAsync (Worker worker, string name, string uri)
 
static async Task SetMultipleModelPropertiesAsync (Worker worker, ModelDataDescriptorList models)
 
static async Task SetOpenXRCallbackAsync (Worker worker, IntPtr extractExtrinsicDataCallback)
 Set the extrinsic extraction callback function for OpenXR support on HoloLens More...
 
static async Task SetWorkSpacesAsync (Worker worker, WorkSpace.Configuration config)
 Set the WorkSpaces for AutoInit. More...
 
static async Task WriteInitDataAsync (Worker worker, string filePrefix=null)
 Write init data to default location (filePrefix == null) or custom location. More...
 

Additional Inherited Members

- Public Types inherited from Visometry.VisionLib.SDK.Core.API.ModelTrackerCommands
enum  ModelProperty { Enabled, Occluder }
 

Detailed Description

Commands for communicating with the multi-model tracker.

Member Function Documentation

◆ AddAnchorAsync()

static async Task Visometry.VisionLib.SDK.Core.API.MultiModelTrackerCommands.AddAnchorAsync ( Worker  worker,
string  anchorName,
bool  enabled 
)
inlinestatic

Adds a new anchor to the tracker

◆ AnchorExistsAsync()

static async Task<bool> Visometry.VisionLib.SDK.Core.API.MultiModelTrackerCommands.AnchorExistsAsync ( Worker  worker,
string  anchorName 
)
inlinestatic

Returns true if the given anchor exists; returns false otherwise

◆ AnchorResetHardAsync()

static async Task Visometry.VisionLib.SDK.Core.API.MultiModelTrackerCommands.AnchorResetHardAsync ( Worker  worker,
string  anchorName 
)
inlinestatic

Performs a Hard Reset to a specific anchor

◆ AnchorResetSoftAsync()

static async Task Visometry.VisionLib.SDK.Core.API.MultiModelTrackerCommands.AnchorResetSoftAsync ( Worker  worker,
string  anchorName 
)
inlinestatic

Performs a Soft Reset to a specific anchor

◆ AnchorSetAttributeAsync()

static async Task Visometry.VisionLib.SDK.Core.API.MultiModelTrackerCommands.AnchorSetAttributeAsync ( Worker  worker,
string  attributeName,
List< AnchorAttribute anchorValueList 
)
inlinestatic

Sets an attribute of a specific anchor

◆ AnchorSetWorkSpaceAsync()

static async Task Visometry.VisionLib.SDK.Core.API.MultiModelTrackerCommands.AnchorSetWorkSpaceAsync ( Worker  worker,
string  anchorName,
WorkSpace.Configuration  config 
)
inlinestatic

Performs a SetWorkSpaceCommand to a specific anchor

◆ DisableAnchorAsync()

static async Task Visometry.VisionLib.SDK.Core.API.MultiModelTrackerCommands.DisableAnchorAsync ( Worker  worker,
string  anchorName 
)
inlinestatic

Disables an anchor

◆ DisableInitPoseAsync()

static async Task Visometry.VisionLib.SDK.Core.API.MultiModelTrackerCommands.DisableInitPoseAsync ( Worker  worker,
string  anchorName 
)
inlinestatic

Disables the use of an init pose for the anchor.

◆ EnableAnchorAsync()

static async Task Visometry.VisionLib.SDK.Core.API.MultiModelTrackerCommands.EnableAnchorAsync ( Worker  worker,
string  anchorName 
)
inlinestatic

Enables an anchor

◆ RemoveAnchorAsync()

static async Task Visometry.VisionLib.SDK.Core.API.MultiModelTrackerCommands.RemoveAnchorAsync ( Worker  worker,
string  anchorName 
)
inlinestatic

Removes am existing anchor from the tracker

◆ SetGlobalObjectPoseAsync()

static async Task Visometry.VisionLib.SDK.Core.API.MultiModelTrackerCommands.SetGlobalObjectPoseAsync ( Worker  worker,
string  anchorName,
InitPose  initPose 
)
inlinestatic

Sets the global object pose of the given anchor