OpenCVForUnity.DisposableObject Class Reference

Base class for disposable OpenCV wrapper types implementing the standard dispose pattern. More...

Public Member Functions
void	Dispose ()
	Releases resources used by this object.
void	ThrowIfDisposed ()
	Throws ObjectDisposedException if this object has been disposed.

Static Public Member Functions
static IntPtr	ThrowIfNullIntPtr (IntPtr ptr)
	Returns the native pointer, or throws CoreModule.CvException if it is zero.

Protected Member Functions
	DisposableObject ()
	Initializes a new instance with dispose enabled.
	DisposableObject (bool isEnabledDispose)
	Initializes a new instance.
virtual void	Dispose (bool disposing)

Properties
bool	IsDisposed [get, protected set]
bool	IsEnabledDispose [get, set]

Detailed Description

Base class for disposable OpenCV wrapper types implementing the standard dispose pattern.

Constructor & Destructor Documentation

DisposableObject() [1/2]

OpenCVForUnity.DisposableObject.DisposableObject ( )

protected

Initializes a new instance with dispose enabled.

DisposableObject() [2/2]

OpenCVForUnity.DisposableObject.DisposableObject ( bool isEnabledDispose )

protected

Initializes a new instance.

Parameters

isEnabledDispose

Whether Dispose releases resources.

Member Function Documentation

Dispose() [1/2]

void OpenCVForUnity.DisposableObject.Dispose

(

)

Releases resources used by this object.

Dispose() [2/2]

virtual void OpenCVForUnity.DisposableObject.Dispose ( bool disposing )

protectedvirtual

Reimplemented in OpenCVForUnity.BgsegmModule.BackgroundSubtractorCNT, OpenCVForUnity.BgsegmModule.BackgroundSubtractorGMG, OpenCVForUnity.BgsegmModule.BackgroundSubtractorGSOC, OpenCVForUnity.BgsegmModule.BackgroundSubtractorLSBP, OpenCVForUnity.BgsegmModule.BackgroundSubtractorLSBPDesc, OpenCVForUnity.BgsegmModule.BackgroundSubtractorMOG, OpenCVForUnity.BgsegmModule.SyntheticSequenceGenerator, OpenCVForUnity.BioinspiredModule.Retina, OpenCVForUnity.BioinspiredModule.RetinaFastToneMapping, OpenCVForUnity.BioinspiredModule.TransientAreasSegmentationModule, OpenCVForUnity.CoreModule.Algorithm, OpenCVForUnity.CoreModule.CleanableMat, OpenCVForUnity.CoreModule.TickMeter, OpenCVForUnity.DisposableOpenCVObject, OpenCVForUnity.Dnn_superresModule.DnnSuperResImpl, OpenCVForUnity.DnnModule.ClassificationModel, OpenCVForUnity.DnnModule.DetectionModel, OpenCVForUnity.DnnModule.DictValue, OpenCVForUnity.DnnModule.Image2BlobParams, OpenCVForUnity.DnnModule.KeypointsModel, OpenCVForUnity.DnnModule.Layer, OpenCVForUnity.DnnModule.Model, OpenCVForUnity.DnnModule.Net, OpenCVForUnity.DnnModule.SegmentationModel, OpenCVForUnity.DnnModule.TextDetectionModel, OpenCVForUnity.DnnModule.TextDetectionModel_DB, OpenCVForUnity.DnnModule.TextDetectionModel_EAST, OpenCVForUnity.DnnModule.TextRecognitionModel, OpenCVForUnity.DnnModule.Tokenizer, OpenCVForUnity.FaceModule.BasicFaceRecognizer, OpenCVForUnity.FaceModule.BIF, OpenCVForUnity.FaceModule.EigenFaceRecognizer, OpenCVForUnity.FaceModule.Facemark, OpenCVForUnity.FaceModule.FacemarkAAM, OpenCVForUnity.FaceModule.FacemarkKazemi, OpenCVForUnity.FaceModule.FacemarkLBF, OpenCVForUnity.FaceModule.FacemarkTrain, OpenCVForUnity.FaceModule.FaceRecognizer, OpenCVForUnity.FaceModule.FisherFaceRecognizer, OpenCVForUnity.FaceModule.LBPHFaceRecognizer, OpenCVForUnity.FaceModule.MACE, OpenCVForUnity.FaceModule.PredictCollector, OpenCVForUnity.FaceModule.StandardCollector, OpenCVForUnity.FeaturesModule.AffineFeature, OpenCVForUnity.FeaturesModule.ALIKED, OpenCVForUnity.FeaturesModule.ALIKED_Params, OpenCVForUnity.FeaturesModule.ANNIndex, OpenCVForUnity.FeaturesModule.BFMatcher, OpenCVForUnity.FeaturesModule.DescriptorMatcher, OpenCVForUnity.FeaturesModule.DISK, OpenCVForUnity.FeaturesModule.FastFeatureDetector, OpenCVForUnity.FeaturesModule.Feature2D, OpenCVForUnity.FeaturesModule.FlannBasedMatcher, OpenCVForUnity.FeaturesModule.GFTTDetector, OpenCVForUnity.FeaturesModule.LightGlueMatcher, OpenCVForUnity.FeaturesModule.MSER, OpenCVForUnity.FeaturesModule.ORB, OpenCVForUnity.FeaturesModule.SIFT, OpenCVForUnity.FeaturesModule.SimpleBlobDetector, OpenCVForUnity.FeaturesModule.SimpleBlobDetector_Params, OpenCVForUnity.GeometryModule.MSTEdge, OpenCVForUnity.GeometryModule.Subdiv2D, OpenCVForUnity.GeometryModule.UsacParams, OpenCVForUnity.Img_hashModule.AverageHash, OpenCVForUnity.Img_hashModule.BlockMeanHash, OpenCVForUnity.Img_hashModule.ColorMomentHash, OpenCVForUnity.Img_hashModule.ImgHashBase, OpenCVForUnity.Img_hashModule.MarrHildrethHash, OpenCVForUnity.Img_hashModule.PHash, OpenCVForUnity.Img_hashModule.RadialVarianceHash, OpenCVForUnity.ImgcodecsModule.Animation, OpenCVForUnity.ImgprocModule.CLAHE, OpenCVForUnity.ImgprocModule.Filter2DParams, OpenCVForUnity.ImgprocModule.FontFace, OpenCVForUnity.ImgprocModule.GeneralizedHough, OpenCVForUnity.ImgprocModule.GeneralizedHoughBallard, OpenCVForUnity.ImgprocModule.GeneralizedHoughGuil, OpenCVForUnity.ImgprocModule.LineSegmentDetector, OpenCVForUnity.MlModule.ANN_MLP, OpenCVForUnity.MlModule.Boost, OpenCVForUnity.MlModule.DTrees, OpenCVForUnity.MlModule.EM, OpenCVForUnity.MlModule.KNearest, OpenCVForUnity.MlModule.LogisticRegression, OpenCVForUnity.MlModule.NormalBayesClassifier, OpenCVForUnity.MlModule.ParamGrid, OpenCVForUnity.MlModule.RTrees, OpenCVForUnity.MlModule.StatModel, OpenCVForUnity.MlModule.SVM, OpenCVForUnity.MlModule.SVMSGD, OpenCVForUnity.MlModule.TrainData, OpenCVForUnity.ObjdetectModule.ArucoDetector, OpenCVForUnity.ObjdetectModule.BarcodeDetector, OpenCVForUnity.ObjdetectModule.Board, OpenCVForUnity.ObjdetectModule.CChecker, OpenCVForUnity.ObjdetectModule.CCheckerDetector, OpenCVForUnity.ObjdetectModule.CharucoBoard, OpenCVForUnity.ObjdetectModule.CharucoDetector, OpenCVForUnity.ObjdetectModule.CharucoParameters, OpenCVForUnity.ObjdetectModule.CirclesGridFinderParameters, OpenCVForUnity.ObjdetectModule.DetectorParameters, OpenCVForUnity.ObjdetectModule.DetectorParametersMCC, OpenCVForUnity.ObjdetectModule.Dictionary, OpenCVForUnity.ObjdetectModule.FaceDetectorYN, OpenCVForUnity.ObjdetectModule.FaceRecognizerSF, OpenCVForUnity.ObjdetectModule.GraphicalCodeDetector, OpenCVForUnity.ObjdetectModule.GridBoard, OpenCVForUnity.ObjdetectModule.QRCodeDetector, OpenCVForUnity.ObjdetectModule.QRCodeDetectorAruco, OpenCVForUnity.ObjdetectModule.QRCodeDetectorAruco_Params, OpenCVForUnity.ObjdetectModule.QRCodeEncoder, OpenCVForUnity.ObjdetectModule.QRCodeEncoder_Params, OpenCVForUnity.ObjdetectModule.RefineParameters, OpenCVForUnity.Phase_unwrappingModule.HistogramPhaseUnwrapping, OpenCVForUnity.Phase_unwrappingModule.HistogramPhaseUnwrapping_Params, OpenCVForUnity.Phase_unwrappingModule.PhaseUnwrapping, OpenCVForUnity.PhotoModule.AlignExposures, OpenCVForUnity.PhotoModule.AlignMTB, OpenCVForUnity.PhotoModule.CalibrateCRF, OpenCVForUnity.PhotoModule.CalibrateDebevec, OpenCVForUnity.PhotoModule.CalibrateRobertson, OpenCVForUnity.PhotoModule.ColorCorrectionModel, OpenCVForUnity.PhotoModule.IntelligentScissorsMB, OpenCVForUnity.PhotoModule.MergeDebevec, OpenCVForUnity.PhotoModule.MergeExposures, OpenCVForUnity.PhotoModule.MergeMertens, OpenCVForUnity.PhotoModule.MergeRobertson, OpenCVForUnity.PhotoModule.Tonemap, OpenCVForUnity.PhotoModule.TonemapDrago, OpenCVForUnity.PhotoModule.TonemapMantiuk, OpenCVForUnity.PhotoModule.TonemapReinhard, OpenCVForUnity.PlotModule.Plot2d, OpenCVForUnity.PtcloudModule.Octree, OpenCVForUnity.PtcloudModule.Odometry, OpenCVForUnity.PtcloudModule.OdometryFrame, OpenCVForUnity.PtcloudModule.OdometrySettings, OpenCVForUnity.PtcloudModule.PoseGraph, OpenCVForUnity.PtcloudModule.RgbdNormals, OpenCVForUnity.PtcloudModule.TriangleRasterizeSettings, OpenCVForUnity.PtcloudModule.Volume, OpenCVForUnity.PtcloudModule.VolumeSettings, OpenCVForUnity.SaliencyModule.MotionSaliency, OpenCVForUnity.SaliencyModule.MotionSaliencyBinWangApr2014, OpenCVForUnity.SaliencyModule.Objectness, OpenCVForUnity.SaliencyModule.ObjectnessBING, OpenCVForUnity.SaliencyModule.Saliency, OpenCVForUnity.SaliencyModule.StaticSaliency, OpenCVForUnity.SaliencyModule.StaticSaliencyFineGrained, OpenCVForUnity.SaliencyModule.StaticSaliencySpectralResidual, OpenCVForUnity.StereoModule.StereoBM, OpenCVForUnity.StereoModule.StereoMatcher, OpenCVForUnity.StereoModule.StereoSGBM, OpenCVForUnity.Structured_lightModule.GrayCodePattern, OpenCVForUnity.Structured_lightModule.SinusoidalPattern, OpenCVForUnity.Structured_lightModule.SinusoidalPattern_Params, OpenCVForUnity.Structured_lightModule.StructuredLightPattern, OpenCVForUnity.TextModule.BaseOCR, OpenCVForUnity.TextModule.ERFilter, OpenCVForUnity.TextModule.ERFilter_Callback, OpenCVForUnity.TextModule.OCRBeamSearchDecoder, OpenCVForUnity.TextModule.OCRBeamSearchDecoder_ClassifierCallback, OpenCVForUnity.TextModule.OCRHMMDecoder, OpenCVForUnity.TextModule.OCRHMMDecoder_ClassifierCallback, OpenCVForUnity.TextModule.TextDetector, OpenCVForUnity.TextModule.TextDetectorCNN, OpenCVForUnity.TrackingModule.legacy_MultiTracker, OpenCVForUnity.TrackingModule.legacy_Tracker, OpenCVForUnity.TrackingModule.legacy_TrackerBoosting, OpenCVForUnity.TrackingModule.legacy_TrackerCSRT, OpenCVForUnity.TrackingModule.legacy_TrackerKCF, OpenCVForUnity.TrackingModule.legacy_TrackerMedianFlow, OpenCVForUnity.TrackingModule.legacy_TrackerMIL, OpenCVForUnity.TrackingModule.legacy_TrackerMOSSE, OpenCVForUnity.TrackingModule.legacy_TrackerTLD, OpenCVForUnity.TrackingModule.TrackerCSRT, OpenCVForUnity.TrackingModule.TrackerCSRT_Params, OpenCVForUnity.TrackingModule.TrackerKCF, OpenCVForUnity.TrackingModule.TrackerKCF_Params, OpenCVForUnity.VideoioModule.IStreamReader, OpenCVForUnity.VideoioModule.VideoCapture, OpenCVForUnity.VideoioModule.VideoWriter, OpenCVForUnity.VideoModule.BackgroundSubtractor, OpenCVForUnity.VideoModule.BackgroundSubtractorKNN, OpenCVForUnity.VideoModule.BackgroundSubtractorMOG2, OpenCVForUnity.VideoModule.DenseOpticalFlow, OpenCVForUnity.VideoModule.DISOpticalFlow, OpenCVForUnity.VideoModule.ECCParameters, OpenCVForUnity.VideoModule.FarnebackOpticalFlow, OpenCVForUnity.VideoModule.KalmanFilter, OpenCVForUnity.VideoModule.SparseOpticalFlow, OpenCVForUnity.VideoModule.SparsePyrLKOpticalFlow, OpenCVForUnity.VideoModule.Tracker, OpenCVForUnity.VideoModule.TrackerDaSiamRPN, OpenCVForUnity.VideoModule.TrackerDaSiamRPN_Params, OpenCVForUnity.VideoModule.TrackerMIL, OpenCVForUnity.VideoModule.TrackerMIL_Params, OpenCVForUnity.VideoModule.TrackerNano, OpenCVForUnity.VideoModule.TrackerNano_Params, OpenCVForUnity.VideoModule.TrackerVit, OpenCVForUnity.VideoModule.TrackerVit_Params, OpenCVForUnity.VideoModule.VariationalRefinement, OpenCVForUnity.Wechat_qrcodeModule.WeChatQRCode, OpenCVForUnity.Xfeatures2dModule.AffineFeature2D, OpenCVForUnity.Xfeatures2dModule.AgastFeatureDetector, OpenCVForUnity.Xfeatures2dModule.AKAZE, OpenCVForUnity.Xfeatures2dModule.BEBLID, OpenCVForUnity.Xfeatures2dModule.BoostDesc, OpenCVForUnity.Xfeatures2dModule.BOWImgDescriptorExtractor, OpenCVForUnity.Xfeatures2dModule.BOWKMeansTrainer, OpenCVForUnity.Xfeatures2dModule.BOWTrainer, OpenCVForUnity.Xfeatures2dModule.BriefDescriptorExtractor, OpenCVForUnity.Xfeatures2dModule.BRISK, OpenCVForUnity.Xfeatures2dModule.DAISY, OpenCVForUnity.Xfeatures2dModule.FREAK, OpenCVForUnity.Xfeatures2dModule.HarrisLaplaceFeatureDetector, OpenCVForUnity.Xfeatures2dModule.KAZE, OpenCVForUnity.Xfeatures2dModule.LATCH, OpenCVForUnity.Xfeatures2dModule.LUCID, OpenCVForUnity.Xfeatures2dModule.MSDDetector, OpenCVForUnity.Xfeatures2dModule.PCTSignatures, OpenCVForUnity.Xfeatures2dModule.PCTSignaturesSQFD, OpenCVForUnity.Xfeatures2dModule.StarDetector, OpenCVForUnity.Xfeatures2dModule.TBMR, OpenCVForUnity.Xfeatures2dModule.TEBLID, OpenCVForUnity.Xfeatures2dModule.VGG, OpenCVForUnity.XimgprocModule.AdaptiveManifoldFilter, OpenCVForUnity.XimgprocModule.ContourFitting, OpenCVForUnity.XimgprocModule.DisparityFilter, OpenCVForUnity.XimgprocModule.DisparityWLSFilter, OpenCVForUnity.XimgprocModule.DTFilter, OpenCVForUnity.XimgprocModule.EdgeAwareInterpolator, OpenCVForUnity.XimgprocModule.EdgeBoxes, OpenCVForUnity.XimgprocModule.EdgeDrawing, OpenCVForUnity.XimgprocModule.EdgeDrawing_Params, OpenCVForUnity.XimgprocModule.FastBilateralSolverFilter, OpenCVForUnity.XimgprocModule.FastGlobalSmootherFilter, OpenCVForUnity.XimgprocModule.FastLineDetector, OpenCVForUnity.XimgprocModule.GraphSegmentation, OpenCVForUnity.XimgprocModule.GuidedFilter, OpenCVForUnity.XimgprocModule.RFFeatureGetter, OpenCVForUnity.XimgprocModule.RICInterpolator, OpenCVForUnity.XimgprocModule.RidgeDetectionFilter, OpenCVForUnity.XimgprocModule.ScanSegment, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentation, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentationStrategy, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentationStrategyColor, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentationStrategyFill, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentationStrategyMultiple, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentationStrategySize, OpenCVForUnity.XimgprocModule.SelectiveSearchSegmentationStrategyTexture, OpenCVForUnity.XimgprocModule.SparseMatchInterpolator, OpenCVForUnity.XimgprocModule.StructuredEdgeDetection, OpenCVForUnity.XimgprocModule.SuperpixelLSC, OpenCVForUnity.XimgprocModule.SuperpixelSEEDS, OpenCVForUnity.XimgprocModule.SuperpixelSLIC, OpenCVForUnity.XobjdetectModule.BaseCascadeClassifier, OpenCVForUnity.XobjdetectModule.CascadeClassifier, OpenCVForUnity.XobjdetectModule.HOGDescriptor, OpenCVForUnity.XphotoModule.GrayworldWB, OpenCVForUnity.XphotoModule.LearningBasedWB, OpenCVForUnity.XphotoModule.SimpleWB, OpenCVForUnity.XphotoModule.TonemapDurand, and OpenCVForUnity.XphotoModule.WhiteBalancer.

ThrowIfDisposed()

void OpenCVForUnity.DisposableObject.ThrowIfDisposed

(

)

Throws ObjectDisposedException if this object has been disposed.

ThrowIfNullIntPtr()

static IntPtr OpenCVForUnity.DisposableObject.ThrowIfNullIntPtr ( IntPtr ptr )

static

Returns the native pointer, or throws CoreModule.CvException if it is zero.

Parameters

ptr	Native pointer to validate.

Returns

The validated native pointer.

Property Documentation

IsDisposed

bool OpenCVForUnity.DisposableObject.IsDisposed

getprotected set

IsEnabledDispose

bool OpenCVForUnity.DisposableObject.IsEnabledDispose

getset

---

The documentation for this class was generated from the following file:

• OpenCVForUnity/Assets/OpenCVForUnity/Scripts/Core/org/DisposableObject.cs