OpenCV for Unity 2.6.4
Enox Software / Please refer to OpenCV official document ( http://docs.opencv.org/4.10.0/index.html ) for the details of the argument of the method.
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
OpenCVForUnity.UnityUtils.Helper.Image2MatHelper Class Reference

A helper component class for loading an image file using OpenCV's Imgcodecs.imread method and converting it to an OpenCV Mat format. More...

Public Member Functions

virtual bool DidUpdateThisFrame ()
 Indicate whether the image buffer of the frame has been updated.
 
virtual void Dispose ()
 Releases all resource used by the Image2MatHelper object.
 
virtual Source2MatHelperColorFormat GetBaseColorFormat ()
 Return the image base color format.
 
virtual string GetDeviceName ()
 Return the active image device name.
 
virtual int GetHeight ()
 Return the image height.
 
virtual Mat GetMat ()
 Get the mat of the current frame.
 
virtual int GetWidth ()
 Return the image width.
 
virtual void Initialize (bool autoPlay=true)
 Initialize this instance.
 
virtual void Initialize (string requestedImageFilePath, bool autoPlay=true)
 Initialize this instance.
 
virtual bool IsInitialized ()
 Indicate whether this instance has been initialized.
 
virtual bool IsPaused ()
 Indicate whether the image is paused.
 
virtual bool IsPlaying ()
 Indicate whether the image is currently playing.
 
virtual void Pause ()
 Pause the image.
 
virtual void Play ()
 Start the image.
 
virtual void Stop ()
 Stop the image.
 
- Public Member Functions inherited from OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper

Protected Member Functions

virtual IEnumerator _Initialize ()
 Initialize this instance by coroutine.
 
virtual void CancelInitCoroutine ()
 Cancel Init Coroutine.
 
virtual void LateUpdate ()
 
virtual void OnDestroy ()
 Raises the destroy event.
 
virtual void OnValidate ()
 
virtual void ReleaseResources ()
 To release the resources.
 
virtual void StartWaitFrameTimeThread ()
 
virtual void StopWaitFrameTimeThread ()
 
virtual IEnumerator WaitFrameTimeThreadWorker ()
 

Protected Attributes

UnityEvent _onDisposed
 UnityEvent that is triggered when this instance is disposed.
 
Source2MatHelperErrorUnityEvent _onErrorOccurred
 UnityEvent that is triggered when this instance is error Occurred.
 
UnityEvent _onInitialized
 UnityEvent that is triggered when this instance is initialized.
 
Source2MatHelperColorFormat _outputColorFormat = Source2MatHelperColorFormat.BGR
 Select the output color format.
 
bool _repeat = true
 Indicate whether to play this image in a repeat.
 
string _requestedImageFilePath = string.Empty
 Set the image file path, relative to the starting point of the "StreamingAssets" folder, or absolute path.
 
int _timeoutFrameCount = 1500
 The number of frames before the initialization process times out.
 
bool autoPlayAfterInitialize
 If set to true play after completion of initialization.
 
Source2MatHelperColorFormat baseColorFormat = Source2MatHelperColorFormat.BGR
 The base color format.
 
bool didUpdateImageBufferInCurrentFrame = false
 
bool didUpdateThisFrame = false
 
Mat frameMat
 The frame mat.
 
IEnumerator getFilePathCoroutine
 The get file path coroutine.
 
bool hasInitDone = false
 Indicates whether this instance has been initialized.
 
string imageFileFullPath
 
IEnumerator initCoroutine
 The initialization coroutine.
 
bool isInitWaiting = false
 Indicates whether this instance is waiting for initialization to complete.
 
bool isPlaying = false
 
bool isThreadRunning = false
 
bool shouldStopThread = false
 
IEnumerator waitFrameTimeCoroutine
 The wait frame time coroutine.
 

Properties

UnityEvent onDisposed [get, set]
 
Source2MatHelperErrorUnityEvent onErrorOccurred [get, set]
 
UnityEvent onInitialized [get, set]
 
virtual Source2MatHelperColorFormat outputColorFormat [get, set]
 
virtual bool repeat [get, set]
 
virtual string requestedImageFilePath [get, set]
 
virtual int timeoutFrameCount [get, set]
 
- Properties inherited from OpenCVForUnity.UnityUtils.Helper.IImageSource2MatHelper
- Properties inherited from OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper

Detailed Description

A helper component class for loading an image file using OpenCV's Imgcodecs.imread method and converting it to an OpenCV Mat format.

The Image2MatHelper class reads an image file from the specified path and converts it to an OpenCV Mat object using Imgcodecs.imread. This component simplifies the process of loading images for applications that require image processing in Unity with OpenCV.

This component is particularly useful for static image processing tasks, enabling seamless integration of OpenCV-based algorithms with image files directly within Unity.

Note: By setting outputColorFormat to GRAY or BGR, processing that does not include extra color conversion is performed.

Attach this component to a GameObject and call GetMat() to retrieve the latest image frame in Mat format.

Member Function Documentation

◆ _Initialize()

virtual IEnumerator OpenCVForUnity.UnityUtils.Helper.Image2MatHelper._Initialize ( )
protectedvirtual

Initialize this instance by coroutine.

◆ CancelInitCoroutine()

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.CancelInitCoroutine ( )
protectedvirtual

Cancel Init Coroutine.

◆ DidUpdateThisFrame()

virtual bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.DidUpdateThisFrame ( )
virtual

Indicate whether the image buffer of the frame has been updated.

Returns
true, if the image buffer has been updated false otherwise.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ Dispose()

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.Dispose ( )
virtual

Releases all resource used by the Image2MatHelper object.

Call Dispose when you are finished using the Image2MatHelper. The Dispose method leaves the Image2MatHelper in an unusable state. After calling Dispose, you must release all references to the Image2MatHelper so the garbage collector can reclaim the memory that the Image2MatHelper was occupying.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ GetBaseColorFormat()

virtual Source2MatHelperColorFormat OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.GetBaseColorFormat ( )
virtual

Return the image base color format.

Returns
The image base color format.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ GetDeviceName()

virtual string OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.GetDeviceName ( )
virtual

Return the active image device name.

Returns
The active image device name.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ GetHeight()

virtual int OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.GetHeight ( )
virtual

Return the image height.

Returns
The image height.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ GetMat()

virtual Mat OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.GetMat ( )
virtual

Get the mat of the current frame.

The Mat object's type is 'CV_8UC4' or 'CV_8UC3' or 'CV_8UC1' (ColorFormat is determined by the outputColorFormat setting). Please do not dispose of the returned mat as it will be reused.

Returns
The mat of the current frame.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ GetWidth()

virtual int OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.GetWidth ( )
virtual

Return the image width.

Returns
The image width.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ Initialize() [1/2]

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.Initialize ( bool autoPlay = true)
virtual

Initialize this instance.

Parameters
autoPlayIf set to true play after completion of initialization.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ Initialize() [2/2]

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.Initialize ( string requestedImageFilePath,
bool autoPlay = true )
virtual

Initialize this instance.

Parameters
requestedImageFilePathRequested image file path.
autoPlayIf set to true play after completion of initialization.

◆ IsInitialized()

virtual bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.IsInitialized ( )
virtual

Indicate whether this instance has been initialized.

Returns
true, if this instance has been initialized, false otherwise.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ IsPaused()

virtual bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.IsPaused ( )
virtual

Indicate whether the image is paused.

Returns
true, if the image is paused, false otherwise.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ IsPlaying()

virtual bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.IsPlaying ( )
virtual

Indicate whether the image is currently playing.

Returns
true, if the image is playing, false otherwise.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ LateUpdate()

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.LateUpdate ( )
protectedvirtual

◆ OnDestroy()

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.OnDestroy ( )
protectedvirtual

Raises the destroy event.

◆ OnValidate()

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.OnValidate ( )
protectedvirtual

◆ Pause()

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.Pause ( )
virtual

Pause the image.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ Play()

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.Play ( )
virtual

Start the image.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ ReleaseResources()

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.ReleaseResources ( )
protectedvirtual

To release the resources.

◆ StartWaitFrameTimeThread()

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.StartWaitFrameTimeThread ( )
protectedvirtual

◆ Stop()

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.Stop ( )
virtual

Stop the image.

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ StopWaitFrameTimeThread()

virtual void OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.StopWaitFrameTimeThread ( )
protectedvirtual

◆ WaitFrameTimeThreadWorker()

virtual IEnumerator OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.WaitFrameTimeThreadWorker ( )
protectedvirtual

Member Data Documentation

◆ _onDisposed

UnityEvent OpenCVForUnity.UnityUtils.Helper.Image2MatHelper._onDisposed
protected

UnityEvent that is triggered when this instance is disposed.

◆ _onErrorOccurred

Source2MatHelperErrorUnityEvent OpenCVForUnity.UnityUtils.Helper.Image2MatHelper._onErrorOccurred
protected

UnityEvent that is triggered when this instance is error Occurred.

◆ _onInitialized

UnityEvent OpenCVForUnity.UnityUtils.Helper.Image2MatHelper._onInitialized
protected

UnityEvent that is triggered when this instance is initialized.

◆ _outputColorFormat

Source2MatHelperColorFormat OpenCVForUnity.UnityUtils.Helper.Image2MatHelper._outputColorFormat = Source2MatHelperColorFormat.BGR
protected

Select the output color format.

◆ _repeat

bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper._repeat = true
protected

Indicate whether to play this image in a repeat.

◆ _requestedImageFilePath

string OpenCVForUnity.UnityUtils.Helper.Image2MatHelper._requestedImageFilePath = string.Empty
protected

Set the image file path, relative to the starting point of the "StreamingAssets" folder, or absolute path.

◆ _timeoutFrameCount

int OpenCVForUnity.UnityUtils.Helper.Image2MatHelper._timeoutFrameCount = 1500
protected

The number of frames before the initialization process times out.

◆ autoPlayAfterInitialize

bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.autoPlayAfterInitialize
protected

If set to true play after completion of initialization.

◆ baseColorFormat

Source2MatHelperColorFormat OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.baseColorFormat = Source2MatHelperColorFormat.BGR
protected

The base color format.

◆ didUpdateImageBufferInCurrentFrame

bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.didUpdateImageBufferInCurrentFrame = false
protected

◆ didUpdateThisFrame

bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.didUpdateThisFrame = false
protected

◆ frameMat

Mat OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.frameMat
protected

The frame mat.

◆ getFilePathCoroutine

IEnumerator OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.getFilePathCoroutine
protected

The get file path coroutine.

◆ hasInitDone

bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.hasInitDone = false
protected

Indicates whether this instance has been initialized.

◆ imageFileFullPath

string OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.imageFileFullPath
protected

◆ initCoroutine

IEnumerator OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.initCoroutine
protected

The initialization coroutine.

◆ isInitWaiting

bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.isInitWaiting = false
protected

Indicates whether this instance is waiting for initialization to complete.

◆ isPlaying

bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.isPlaying = false
protected

◆ isThreadRunning

bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.isThreadRunning = false
protected

◆ shouldStopThread

bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.shouldStopThread = false
protected

◆ waitFrameTimeCoroutine

IEnumerator OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.waitFrameTimeCoroutine
protected

The wait frame time coroutine.

Property Documentation

◆ onDisposed

UnityEvent OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.onDisposed
getset

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ onErrorOccurred

Source2MatHelperErrorUnityEvent OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.onErrorOccurred
getset

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ onInitialized

UnityEvent OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.onInitialized
getset

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ outputColorFormat

virtual Source2MatHelperColorFormat OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.outputColorFormat
getset

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

◆ repeat

virtual bool OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.repeat
getset

Implements OpenCVForUnity.UnityUtils.Helper.IImageSource2MatHelper.

◆ requestedImageFilePath

virtual string OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.requestedImageFilePath
getset

Implements OpenCVForUnity.UnityUtils.Helper.IImageSource2MatHelper.

◆ timeoutFrameCount

virtual int OpenCVForUnity.UnityUtils.Helper.Image2MatHelper.timeoutFrameCount
getset

Implements OpenCVForUnity.UnityUtils.Helper.ISource2MatHelper.

The documentation for this class was generated from the following file:
Generated by doxygen 1.12.0