Skip to content

Commit 8c3e14d

Browse files
DMGithubPublisherDMGithubPublisher
authored
Merge pull request #50 from dynamsoft-docs/preview
Preview
2 parents bac0b84 + fc10377 commit 8c3e14d

18 files changed

+88
-142
lines changed

‎programming/cplusplus/api-reference/buffered-character-item-set.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The `CBufferedCharacterItemSet` class represents a collection of buffered charac
2323
class CBufferedCharacterItemSet
2424
```
2525
26-
## Methods Summary
26+
## Methods
2727
2828
| Method | Description |
2929
|----------------------|-------------|

‎programming/cplusplus/api-reference/buffered-character-item.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The `CBufferedCharacterItem` class represents a buffered character item. Each bu
2323
class CBufferedCharacterItem
2424
```
2525
26-
## Methods Summary
26+
## Methods
2727
2828
| Method | Description |
2929
|----------------------|-------------|

‎programming/cplusplus/api-reference/character-cluster.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The `CCharacterCluster` class represents a character cluster generated from the
2323
class CCharacterCluster
2424
```
2525
26-
## Methods Summary
26+
## Methods
2727
2828
| Method | Description |
2929
|----------------------|-------------|

‎programming/cplusplus/api-reference/label-recognizer-module.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The `CLabelRecognizerModule` class defines general functions in the label recogn
2222
class CLabelRecognizerModule
2323
```
2424
25-
## Methods Summary
25+
## Methods
2626
2727
| Method | Description |
2828
| --------------------------------------------------------- | -------------------------------------------------- |

‎programming/cplusplus/api-reference/localized-text-line-element.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@ class CLocalizedTextLineElement : public CRegionObjectElement
3232
| [`GetCharacterQuadsCount`](#getcharacterquadscount) | Gets the number of character quads in the text line.|
3333
| [`GetCharacterQuad`](#getcharacterquad) | Gets the quadrilateral of a specific character in the text line. |
3434
| [`GetRowNumber`](#getrownumber) | Gets the row number of the text line. |
35+
| **Methods Inherited from [CRegionObjectElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html):** | |
36+
| [`GetLocation`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getlocation) | Gets the location of the region object element. |
37+
| [`GetReferencedElement`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Gets a pointer to a referenced region object element. |
38+
| [`GetElementType`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getelementtype) | Gets the type of the region object element. |
39+
| [`GetImageData`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getimagedata) | Gets the imageData of the region object element. |
40+
| [`Clone`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#clone) | Clone the region object element. |
41+
| [`Retain`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#retain) | Increases the reference count of the `CRegionObjectElement` object. |
42+
| [`Release`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#release) | Decreases the reference count of the `CRegionObjectElement` object. |
3543
3644
### GetCharacterQuadsCount
3745

‎programming/cplusplus/api-reference/localized-text-lines-unit.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,19 @@ class CLocalizedTextLinesUnit : public CIntermediateResultUnit
3636
| [`RemoveLocalizedTextLine`](#removelocalizedtextline) | Removes the localized text line at the specified index.|
3737
| [`AddLocalizedTextLine`](#addlocalizedtextline) | Adds a localized text line.|
3838
| [`SetLocalizedTextLine`](#setlocalizedtextline) | Sets the localized text line at the specified index.|
39+
| **Methods Inherited from [CIntermediateResultUnit]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html):** | |
40+
| [`GetHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gethashid) | Gets the hash ID of the unit.|
41+
| [`GetOriginalImageHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagehashid) | Gets the hash ID of the original image. |
42+
| [`GetOriginalImageTag`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagetag) | Gets the image tag of the original image. |
43+
| [`GetType`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gettype) | Gets the type of the intermediate result unit. |
44+
| [`Clone`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#clone) | Creates a copy of the intermediate result unit. |
45+
| [`SetHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#sethashid) | Sets the hash ID of the unit. |
46+
| [`SetOriginalImageHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#setoriginalimagehashid) | Sets the hash ID of the original image. |
47+
| [`SetOriginalImageTag`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#setoriginalimagetag) | Sets the image tag of the original image. |
48+
| [`Retain`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#retain) | Increases the reference count of the unit. |
49+
| [`Release`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#release) | Decreases the reference count of the unit. |
50+
| [`GetTransformMatrix`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gettransformmatrix) | Gets the transformation matrix via TransformMatrixType. |
51+
| [`SetTransformMatrix`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#settransformmatrix) | Sets the transformation matrix via TransformMatrixType. |
3952
4053
### GetCount
4154

‎programming/cplusplus/api-reference/raw-text-lines-unit.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,19 @@ class CRawTextLinesUnit : public CIntermediateResultUnit
3636
| [`RemoveRawTextLine`](#removerawtextline) | Removes the raw text line at the specified index.|
3737
| [`AddRawTextLine`](#addrawtextline) | Adds a raw text line.|
3838
| [`SetRawTextLine`](#setrawtextline) | Sets the raw text line at the specified index.|
39+
| **Methods Inherited from [CIntermediateResultUnit]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html):** | |
40+
| [`GetHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gethashid) | Gets the hash ID of the unit.|
41+
| [`GetOriginalImageHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagehashid) | Gets the hash ID of the original image. |
42+
| [`GetOriginalImageTag`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#getoriginalimagetag) | Gets the image tag of the original image. |
43+
| [`GetType`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gettype) | Gets the type of the intermediate result unit. |
44+
| [`Clone`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#clone) | Creates a copy of the intermediate result unit. |
45+
| [`SetHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#sethashid) | Sets the hash ID of the unit. |
46+
| [`SetOriginalImageHashId`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#setoriginalimagehashid) | Sets the hash ID of the original image. |
47+
| [`SetOriginalImageTag`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#setoriginalimagetag) | Sets the image tag of the original image. |
48+
| [`Retain`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#retain) | Increases the reference count of the unit. |
49+
| [`Release`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#release) | Decreases the reference count of the unit. |
50+
| [`GetTransformMatrix`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#gettransformmatrix) | Gets the transformation matrix via TransformMatrixType. |
51+
| [`SetTransformMatrix`]({{ site.dcvb_cpp_api }}core/intermediate-results/intermediate-result-unit.html#settransformmatrix) | Sets the transformation matrix via TransformMatrixType. |
3952
4053
### GetCount
4154

‎programming/cplusplus/api-reference/recognized-text-line-element.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,14 @@ class CRecognizedTextLineElement : public CRegionObjectElement
3636
| [`GetRowNumber`](#getrownumber) | Gets the row number of the text line within the image. |
3737
| [`GetSpecificationName`](#getspecificationname) | Gets the name of the text line specification that generated this element. |
3838
| [`GetRawText`](#getrawtext) | Gets the recognized raw text, excluding any concatenation separators. |
39+
| **Methods Inherited from [CRegionObjectElement]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html):** | |
40+
| [`GetLocation`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getlocation) | Gets the location of the region object element. |
41+
| [`GetReferencedElement`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getreferencedelement) | Gets a pointer to a referenced region object element. |
42+
| [`GetElementType`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getelementtype) | Gets the type of the region object element. |
43+
| [`GetImageData`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#getimagedata) | Gets the imageData of the region object element. |
44+
| [`Clone`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#clone) | Clone the region object element. |
45+
| [`Retain`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#retain) | Increases the reference count of the `CRegionObjectElement` object. |
46+
| [`Release`]({{ site.dcvb_cpp_api }}core/intermediate-results/region-object-element.html#release) | Decreases the reference count of the `CRegionObjectElement` object. |
3947
4048
### GetText
4149

‎programming/cplusplus/api-reference/recognized-text-lines-result-array.md‎

Lines changed: 0 additions & 59 deletions
This file was deleted.

‎programming/cplusplus/api-reference/recognized-text-lines-result.md‎

Lines changed: 13 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -19,51 +19,30 @@ The `CRecognizedTextLinesResult` class represents the result of a text recogniti
1919

2020
*Assembly:* DynamsoftLabelRecognizer
2121

22+
*Inheritance:* [CCapturedResultBase]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-base.html) -> CRecognizedTextLinesResult
23+
2224
```cpp
23-
class CRecognizedTextLinesResult
25+
class CRecognizedTextLinesResult : public CCapturedResultBase
2426
```
2527
26-
## Methods Summary
28+
## Methods
2729
2830
| Method | Description |
2931
|----------------------|-------------|
30-
| [`GetOriginalImageHashId`](#getoriginalimagehashid) | Gets the hash ID of the original image. |
31-
| [`GetOriginalImageTag`](#getoriginalimagetag) | Gets the tag of the original image. |
3232
| [`GetItemsCount`](#getitemscount) | Gets the number of text line result items in the recognition result. |
3333
| [`GetItem`](#getitem) | Gets the text line result item at the specified index. |
34-
| [`HasItem`](#hasitem) | Check if the item is present in the array.|
35-
| [`RemoveItem`](#removeitem) | Remove a specific item from the array in the recognition result.|
36-
| [`GetRotationTransformMatrix`](#getrotationtransformmatrix) | Get the rotation transformation matrix of the original image relative to the rotated image.|
37-
| [`GetErrorCode`](#geterrorcode) | Gets the error code of the recognition result, if an error occurred. |
38-
| [`GetErrorString`](#geterrorstring) | Gets the error message of the recognition result, if an error occurred. |
34+
| [`HasItem`](#hasitem) | Checks if the item is present in the array. |
35+
| [`RemoveItem`](#removeitem) | Removes a specific item from the array in the recognition result. |
3936
| [`operator[]`](#operator) | Gets the text line result item at the specified index. |
37+
| [`AddItem`](#additem) | Adds a specific item to the array in the recognized text lines result. |
4038
| [`Retain`](#retain) | Increases the reference count of the CRecognizedTextLinesResult object. |
4139
| [`Release`](#release) | Decreases the reference count of the CRecognizedTextLinesResult object. |
42-
| [`AddItem`](#additem) | Add a specific item to the array in the recognized text lines result. |
43-
44-
### GetOriginalImageHashId
45-
46-
Gets the hash ID of the original image.
47-
48-
```cpp
49-
virtual const char* GetOriginalImageHashId() const = 0;
50-
```
51-
52-
**Return value**
53-
54-
Returns a pointer to a null-terminated string containing the hash ID of the original image.
55-
56-
### GetOriginalImageTag
57-
58-
Gets the tag of the original image.
59-
60-
```cpp
61-
virtual const CImageTag* GetOriginalImageTag() const = 0;
62-
```
63-
64-
**Return value**
65-
66-
Returns a pointer to a CImageTag object representing the tag of the original image.
40+
| **Methods Inherited from [CCapturedResultBase]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-base.html):** | |
41+
| [`GetOriginalImageHashId`]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-base.html#getoriginalimagehashid) | Gets the hash ID of the original image. |
42+
| [`GetOriginalImageTag`]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-base.html#getoriginalimagetag) | Gets the tag of the original image. |
43+
| [`GetRotationTransformMatrix`]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-base.html#getrotationtransformmatrix) | Gets the rotation transformation matrix of the original image relative to the rotated image. |
44+
| [`GetErrorCode`]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-base.html#geterrorcode) | Gets the error code of the recognition result, if an error occurred. |
45+
| [`GetErrorString`]({{ site.dcvb_cpp_api }}core/basic-structures/captured-result-base.html#geterrorstring) | Gets the error message of the recognition result, if an error occurred. |
6746
6847
### GetItemsCount
6948
@@ -125,43 +104,6 @@ int RemoveItem(const CTextLineResultItem* item)
125104
126105
Return value indicating whether the deletion was successful or not.
127106
128-
### GetRotationTransformMatrix
129-
130-
Get the rotation transformation matrix of the original image relative to the rotated image.
131-
132-
```cpp
133-
void GetRotationTransformMatrix(double matrix[9]) const;
134-
```
135-
136-
**Parameters**
137-
138-
`[out] matrix` A double array which represents the rotation transform matrix.
139-
140-
141-
### GetErrorCode
142-
143-
Gets the error code of the recognition result, if an error occurred.
144-
145-
```cpp
146-
virtual int GetErrorCode() const = 0;
147-
```
148-
149-
**Return value**
150-
151-
Returns the error code of the recognition result, or 0 if no error occurred.
152-
153-
### GetErrorString
154-
155-
Gets the error message of the recognition result, if an error occurred.
156-
157-
```cpp
158-
virtual const char* GetErrorString() const = 0;
159-
```
160-
161-
**Return value**
162-
163-
Returns a pointer to a null-terminated string containing the error message of the recognition result, or a pointer to an empty string if no error occurred.
164-
165107
### operator[]
166108
167109
Gets the text line result item at the specified index.

0 commit comments

Comments
 (0)