OpenCV for Unity  2.6.3
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.
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
OpenCVForUnity.ObjdetectModule.GridBoard Class Reference

Planar board with grid arrangement of markers. More...

Inheritance diagram for OpenCVForUnity.ObjdetectModule.GridBoard:
OpenCVForUnity.ObjdetectModule.Board OpenCVForUnity.DisposableOpenCVObject OpenCVForUnity.DisposableObject

Public Member Functions

 GridBoard (Size size, float markerLength, float markerSeparation, Dictionary dictionary, Mat ids)
 GridBoard constructor. More...
 
 GridBoard (Size size, float markerLength, float markerSeparation, Dictionary dictionary)
 GridBoard constructor. More...
 
Size getGridSize ()
 
float getMarkerLength ()
 
float getMarkerSeparation ()
 
- Public Member Functions inherited from OpenCVForUnity.ObjdetectModule.Board
IntPtr getNativeObjAddr ()
 
 Board (List< Mat > objPoints, Dictionary dictionary, Mat ids)
 Common Board constructor. More...
 
Dictionary getDictionary ()
 return the Dictionary of markers employed for this board More...
 
List< MatOfPoint3fgetObjPoints ()
 return array of object points of all the marker corners in the board. More...
 
MatOfInt getIds ()
 vector of the identifiers of the markers in the board (should be the same size as objPoints) More...
 
Point3 getRightBottomCorner ()
 get coordinate of the bottom right corner of the board, is set when calling the function create() More...
 
void matchImagePoints (List< Mat > detectedCorners, Mat detectedIds, Mat objPoints, Mat imgPoints)
 Given a board configuration and a set of detected markers, returns the corresponding image points and object points, can be used in solvePnP() More...
 
void generateImage (Size outSize, Mat img, int marginSize, int borderBits)
 Draw a planar board. More...
 
void generateImage (Size outSize, Mat img, int marginSize)
 Draw a planar board. More...
 
void generateImage (Size outSize, Mat img)
 Draw a planar board. More...
 
- Public Member Functions inherited from OpenCVForUnity.DisposableObject
void Dispose ()
 
void ThrowIfDisposed ()
 

Static Public Member Functions

static new GridBoard __fromPtr__ (IntPtr addr)
 
- Static Public Member Functions inherited from OpenCVForUnity.ObjdetectModule.Board
static Board __fromPtr__ (IntPtr addr)
 
- Static Public Member Functions inherited from OpenCVForUnity.DisposableObject
static IntPtr ThrowIfNullIntPtr (IntPtr ptr)
 

Protected Member Functions

override void Dispose (bool disposing)
 
- Protected Member Functions inherited from OpenCVForUnity.DisposableOpenCVObject
 DisposableOpenCVObject ()
 
 DisposableOpenCVObject (IntPtr ptr)
 
 DisposableOpenCVObject (bool isEnabledDispose)
 
 DisposableOpenCVObject (IntPtr ptr, bool isEnabledDispose)
 
- Protected Member Functions inherited from OpenCVForUnity.DisposableObject
 DisposableObject ()
 
 DisposableObject (bool isEnabledDispose)
 

Additional Inherited Members

- Properties inherited from OpenCVForUnity.DisposableObject
bool IsDisposed [get, protected set]
 
bool IsEnabledDispose [get, set]
 

Detailed Description

Planar board with grid arrangement of markers.

More common type of board. All markers are placed in the same plane in a grid arrangement. The board image can be drawn using generateImage() method.

Constructor & Destructor Documentation

◆ GridBoard() [1/2]

OpenCVForUnity.ObjdetectModule.GridBoard.GridBoard ( Size  size,
float  markerLength,
float  markerSeparation,
Dictionary  dictionary,
Mat  ids 
)

GridBoard constructor.

Parameters
sizenumber of markers in x and y directions
markerLengthmarker side length (normally in meters)
markerSeparationseparation between two markers (same unit as markerLength)
dictionarydictionary of markers indicating the type of markers
idsset of marker ids in dictionary to use on board.

◆ GridBoard() [2/2]

OpenCVForUnity.ObjdetectModule.GridBoard.GridBoard ( Size  size,
float  markerLength,
float  markerSeparation,
Dictionary  dictionary 
)

GridBoard constructor.

Parameters
sizenumber of markers in x and y directions
markerLengthmarker side length (normally in meters)
markerSeparationseparation between two markers (same unit as markerLength)
dictionarydictionary of markers indicating the type of markers
idsset of marker ids in dictionary to use on board.

Member Function Documentation

◆ __fromPtr__()

static new GridBoard OpenCVForUnity.ObjdetectModule.GridBoard.__fromPtr__ ( IntPtr  addr)
static

◆ Dispose()

override void OpenCVForUnity.ObjdetectModule.GridBoard.Dispose ( bool  disposing)
protectedvirtual

◆ getGridSize()

Size OpenCVForUnity.ObjdetectModule.GridBoard.getGridSize ( )

◆ getMarkerLength()

float OpenCVForUnity.ObjdetectModule.GridBoard.getMarkerLength ( )

◆ getMarkerSeparation()

float OpenCVForUnity.ObjdetectModule.GridBoard.getMarkerSeparation ( )

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