Class TofArPlaneManager
Manage the connection with TofAr Plane component
Has the following functions
- Set plane detection parameter
- Get plane detection data
- Notice on (data) stream starting event
- Notice on (data) stream ending event
- Notice on arrival of frame
- Addition of reference points of plane detection
- Removal of reference points of plane detection
- Playback of recording file
Inheritance
Inherited Members
Namespace: TofAr.V0.Plane
Assembly: TofArPlaneAssembly.dll
Syntax
public class TofArPlaneManager : Singleton<TofArPlaneManager>, IStreamStoppable, IDisposable, IStreamHolder, IDependManager
Fields
autoStart
If true, Plane data stream will automatically start when the application is started
Declaration
public bool autoStart
Field Value
Type |
---|
System.Boolean |
Properties
FrameRate
Actual FPS
Declaration
public float FrameRate { get; }
Property Value
Type |
---|
System.Single |
IsPlaying
True if recording file is being played
Declaration
public bool IsPlaying { get; }
Property Value
Type |
---|
System.Boolean |
IsStreamActive
If true, it is streaming
Declaration
public bool IsStreamActive { get; }
Property Value
Type |
---|
System.Boolean |
PlaneData
Latest Plane data
Declaration
public PlaneData PlaneData { get; }
Property Value
Type |
---|
PlaneData |
Stream
Stream
Declaration
public Stream Stream { get; }
Property Value
Type |
---|
SensCord.Stream |
StreamPlay
Playback stream
Declaration
public Stream StreamPlay { get; }
Property Value
Type |
---|
SensCord.Stream |
Version
Component version No.
Declaration
public string Version { get; }
Property Value
Type |
---|
System.String |
Methods
AddPlane()
Add reference point of plane detection
Declaration
public void AddPlane()
ClearPlanes()
Clear all planes
Declaration
public void ClearPlanes()
Dispose()
Disposal method
Declaration
public void Dispose()
FinalizeRestartStreamByDependManager(Object)
Post-processing of stream restart requested by dependent managers
Declaration
public void FinalizeRestartStreamByDependManager(object requestSource)
Parameters
Type | Name | Description |
---|---|---|
System.Object | requestSource | Requester |
GetProperty<T>()
Get component property
Declaration
public T GetProperty<T>()
where T : class, IBaseProperty, new()
Returns
Type | Description |
---|---|
T | Property class |
Type Parameters
Name | Description |
---|---|
T | IBaseProperty inherited class |
GetProperty<T>(T)
Set the size of the serialization buffer and get component properties
Declaration
public T GetProperty<T>(T value)
where T : class, IBaseProperty
Parameters
Type | Name | Description |
---|---|---|
T | value | Input parameter |
Returns
Type | Description |
---|---|
T | Property class |
Type Parameters
Name | Description |
---|---|
T | IBaseProperty inherited class |
GetProperty<T>(T, Int32)
Get component property
Declaration
public T GetProperty<T>(T value, int bufferSize)
where T : class, IBaseProperty, new()
Parameters
Type | Name | Description |
---|---|---|
T | value | Input parameter |
System.Int32 | bufferSize | Serialization buffer size |
Returns
Type | Description |
---|---|
T | Property class |
Type Parameters
Name | Description |
---|---|
T | IBaseProperty inherited class |
GetPropertyList()
Get property list
Declaration
public string[] GetPropertyList()
Returns
Type | Description |
---|---|
System.String[] | Property list |
RegisterPlanePreProcessing(IPreProcessPlaneData)
Register plane data preprocessing
Declaration
public void RegisterPlanePreProcessing(IPreProcessPlaneData preProcessTof)
Parameters
Type | Name | Description |
---|---|---|
IPreProcessPlaneData | preProcessTof |
RemovePlane(Int32)
Remove reference point of plane detection
Declaration
public void RemovePlane(int idx)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | idx | Reference point of plane detection to delete |
RestartStreamByDependManager(Object)
Restart stream as requested by dependent managers
Declaration
public void RestartStreamByDependManager(object requestSource)
Parameters
Type | Name | Description |
---|---|---|
System.Object | requestSource | Requester |
SetProperty<T>(T)
Set component property
Declaration
public void SetProperty<T>(T value)
where T : class, IBaseProperty
Parameters
Type | Name | Description |
---|---|---|
T | value | Input parameter |
Type Parameters
Name | Description |
---|---|
T | IBaseProperty inherited class |
StartPlayback()
Start playback using ToF stream from recording file being played as source
Declaration
public void StartPlayback()
StartPlayback(String)
Start playback of the recording file from the specified path
Declaration
public void StartPlayback(string path)
Parameters
Type | Name | Description |
---|---|---|
System.String | path | Directory path of recording file to playback |
StartStream()
Start streaming
Declaration
public void StartStream()
StartStream(AlgorithmConfigProperty)
Start streaming
Declaration
public void StartStream(AlgorithmConfigProperty config)
Parameters
Type | Name | Description |
---|---|---|
AlgorithmConfigProperty | config | plane detection parameter used for streaming |
StopPlayback()
Stop playback of recording file
Declaration
public void StopPlayback()
StopStream(Object)
Stop streaming
Declaration
public void StopStream(object sender = null)
Parameters
Type | Name | Description |
---|---|---|
System.Object | sender | Caller object |
UnregisterPlanePreProcessing(IPreProcessPlaneData)
Unregister plane data preprocessing
Declaration
public void UnregisterPlanePreProcessing(IPreProcessPlaneData preProcessTof)
Parameters
Type | Name | Description |
---|---|---|
IPreProcessPlaneData | preProcessTof |
Events
OnApplicationPausing
Application pausing
Declaration
public static event TofArPlaneManager.ApplicationPausingEventHandler OnApplicationPausing
Event Type
Type | Description |
---|---|
TofArPlaneManager.ApplicationPausingEventHandler |
OnApplicationResuming
Application resuming
Declaration
public static event TofArPlaneManager.ApplicationResumingEventHandler OnApplicationResuming
Event Type
Type | Description |
---|---|
TofArPlaneManager.ApplicationResumingEventHandler |
OnFrameArrived
Notice on arrival of new frame
Declaration
public static event TofArPlaneManager.FrameArrivedEventHandler OnFrameArrived
Event Type
Type | Description |
---|---|
TofArPlaneManager.FrameArrivedEventHandler |
OnPlaneAdded
Notice on reference point of plane detection added
Declaration
public static event TofArPlaneManager.PlaneAddedEventHandler OnPlaneAdded
Event Type
Type | Description |
---|---|
TofArPlaneManager.PlaneAddedEventHandler |
OnPlaneRemoved
Even for when plane reference point has been removed
Declaration
public static event TofArPlaneManager.PlaneRemovedEventHandler OnPlaneRemoved
Event Type
Type | Description |
---|---|
TofArPlaneManager.PlaneRemovedEventHandler |
OnStreamStarted
Notice on starting of streaming
Declaration
public static event TofArPlaneManager.StreamStartedEventHandler OnStreamStarted
Event Type
Type | Description |
---|---|
TofArPlaneManager.StreamStartedEventHandler |
OnStreamStopped
Notice on ending of streaming
Declaration
public static event TofArPlaneManager.StreamStoppedEventHandler OnStreamStopped
Event Type
Type | Description |
---|---|
TofArPlaneManager.StreamStoppedEventHandler |