Photomechanics API
Photomechanics.Photo3DStudio.TurntableControl.Interfaces.IEmbeddedPhotoShootingProvider Interface Reference

Provides methods to shoot photos directly from table through sync cable. More...

Inheritance diagram for Photomechanics.Photo3DStudio.TurntableControl.Interfaces.IEmbeddedPhotoShootingProvider:
[legend]

Public Member Functions

Task< Boolean > GetIsShootingPhotos ()
 Get info on whether turn table is currently shooting photos. More...
 
Task SetPhotoShootingStartAngle (Double degrees)
 Set shooting starting angle. The first photo will be triggered when given value reached. More...
 
Task SetPhotoShootingDegreesPerPhoto (Double degrees)
 Set degrees interval between photos. More...
 
Task< Int32 > ShootPhotos (Int32 numberOfPhotos)
 Start rotation with photo triggering. More...
 

Detailed Description

Provides methods to shoot photos directly from table through sync cable.

WIP, currently not implemented.

Member Function Documentation

◆ GetIsShootingPhotos()

Task<Boolean> Photomechanics.Photo3DStudio.TurntableControl.Interfaces.IEmbeddedPhotoShootingProvider.GetIsShootingPhotos ( )

Get info on whether turn table is currently shooting photos.

Exceptions
TurntableOperationFailedExceptionThrown when turn table returns fail result of operation.

◆ SetPhotoShootingStartAngle()

Task Photomechanics.Photo3DStudio.TurntableControl.Interfaces.IEmbeddedPhotoShootingProvider.SetPhotoShootingStartAngle ( Double  degrees)

Set shooting starting angle. The first photo will be triggered when given value reached.

Parameters
degreesStarting angle in degrees.
Exceptions
TurntableOperationFailedExceptionThrown when turn table returns fail result of operation.

◆ SetPhotoShootingDegreesPerPhoto()

Task Photomechanics.Photo3DStudio.TurntableControl.Interfaces.IEmbeddedPhotoShootingProvider.SetPhotoShootingDegreesPerPhoto ( Double  degrees)

Set degrees interval between photos.

The photo is triggered when steps count minus start step is a multiple of given value.

Parameters
degreesStarting angle in degrees.
Exceptions
TurntableOperationFailedExceptionThrown when turn table returns fail result of operation.

◆ ShootPhotos()

Task<Int32> Photomechanics.Photo3DStudio.TurntableControl.Interfaces.IEmbeddedPhotoShootingProvider.ShootPhotos ( Int32  numberOfPhotos)

Start rotation with photo triggering.

Parameters
numberOfPhotosNon-zero number of photos. Negative value for counter-clockwise rotation.
Exceptions
TurntableOperationFailedExceptionThrown when turn table returns fail result of operation. Either common reasons (turn table is already rotating or in manual mode) or necessary parameters were not provided (start angle, degrees per photo).
Returns
Degrees the turn table rotated while it was shooting photos. Calculated from photos count.

Return value is actually received from turn table immediately after the photo shooting start. For the sake of simplicity, it is returned from API only after the command is fully executed. If value is needed early, then this method must be rewritten to return object like MftCommandBase.