Objective-C wrapper of the VisageSDK::FDP class.
More...
#import <objc_FDP.h>
Inherits NSObject, and <NSCopying>.
Objective-C wrapper of the VisageSDK::FDP class.
Definition at line 21 of file objc_FDP.h.
◆ copyWithZone:()
| - (id) copyWithZone: |
|
(NSZone *) |
zone |
|
Copy operator.
- Parameters
-
◆ createNewFile:()
| - (void) createNewFile: |
|
(NSString *) |
name |
|
Create a new (empty) FDP file.
- Parameters
-
◆ FPIsDefined:()
| - (bool) FPIsDefined: |
|
(NSString *) |
name |
|
Returns true if the feature point is defined.
For more information see FeaturePoint::defined.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
- Returns
- True if the feature point is defined, false otherwise.
◆ FPIsDefined:withIndex:()
Returns true if the feature point is defined.
For more information see FeaturePoint::defined.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
- Returns
- True if the feature point is defined, false otherwise.
◆ FPIsDetected:()
| - (bool) FPIsDetected: |
|
(NSString *) |
name |
|
Returns true if the feature point is detected.
For more information see FeaturePoint::detected.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
- Returns
- True if the feature point is detected, false otherwise.
◆ FPIsDetected:withIndex:()
Returns true if the feature point is detected.
For more information see FeaturePoint::detected.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
- Returns
- True if the feature point is detected, false otherwise.
◆ FPIsValid:()
| + (bool) FPIsValid: |
|
(NSString *) |
name |
|
Returns true if specified feature point identifier is valid.
Identifier i.e. feature point name is valid if it consists of feature point group and feature point index within valid ranges and is of the correct format. Valid range for feature point group is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. Valid range for feature point index is from 1 to the size of particular group.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
- Returns
- True if specified feature point identifier is valid, false otherwise.
◆ FPIsValid:withIndex:()
| + (bool) FPIsValid: |
|
(int) |
group |
| withIndex: |
|
(int) |
n |
|
|
| |
Returns true if specified feature point identifier is valid.
Identifier is valid if it consists of feature point group and feature point index within valid ranges.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
- Returns
- True if specified feature point identifier is valid, false otherwise.
◆ getFP:()
Get a feature point by its name.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
- Returns
- Feature point.
◆ getFP:withIndex:()
Get a feature point by its group and index.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
- Returns
- Feature point.
◆ getFPName:withIndex:()
| + (NSString *) getFPName: |
|
(int) |
group |
| withIndex: |
|
(int) |
n |
|
|
| |
Get feature point name from group and index.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
- Returns
- Feature point name.
◆ getFPPos:()
| - (const float *) getFPPos: |
|
(NSString *) |
name |
|
Get the position of a feature point specified by its name.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
- Returns
- Vertex position (array of 3 floating point numbers).
◆ getFPPos:withIndex:()
| - (const float *) getFPPos: |
|
(int) |
group |
| withIndex: |
|
(int) |
n |
|
|
| |
Get the position of a feature point specified by its group and index.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
- Returns
- Vertex position (array of 3 floating point numbers).
◆ getFPQuality:()
| - (float) getFPQuality: |
|
(NSString *) |
name |
|
Get the quality of a feature point specified by its name.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
- Returns
- quality value.
◆ getFPQuality:withIndex:()
Get the quality of a feature point specified by its group and index.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
- Returns
- quality value.
◆ getFPSurfVert:withIndex:withSurface:withVertex:()
| - (bool) getFPSurfVert: |
|
(int) |
group |
| withIndex: |
|
(int) |
n |
| withSurface: |
|
(NSString *) |
surf |
| withVertex: |
|
(int) |
vert |
|
|
| |
Get the mesh and vertex mapping for a feature point specified by its group and index.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
| surf | Returned mesh identifier. |
| vert | Returned vertex index. |
- Returns
- True if feature point is defined, false if not.
◆ getFPSurfVert:withSurface:withVertex:()
| - (bool) getFPSurfVert: |
|
(NSString *) |
name |
| withSurface: |
|
(NSString *) |
surf |
| withVertex: |
|
(int) |
vert |
|
|
| |
Get the mesh and vertex mapping for a feature point specified by its name.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
| surf | Returned mesh identifier. |
| vert | Returned vertex index. |
- Returns
- True if feature point is defined, false if not.
◆ getMirrorPointIndex:withIndex:()
| + (int) getMirrorPointIndex: |
|
(int) |
group |
| withIndex: |
|
(int) |
n |
|
|
| |
Get the mirror point index for the point defined by given group and index.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
- Returns
- Index of the mirror point (group is the same).
◆ groupSize:()
| + (int) groupSize: |
|
(int) |
group |
|
Get the size of the specified feature point group.
Valid range for group is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
- Returns
- Size of the specified feature point group.
◆ initWithFilename:()
| - (FDP *) initWithFilename: |
|
(NSString *) |
name |
|
◆ initWithNativeFDP:()
| - (FDP *) initWithNativeFDP: |
|
(void *) |
nativeFDP |
|
Copy constructor.
Makes a copy of native FDP object.
◆ parseFPName:withGroup:withIndex:()
| + (void) parseFPName: |
|
(NSString *) |
name |
| withGroup: |
|
(int) |
group |
| withIndex: |
|
(int) |
n |
|
|
| |
Get feature point group and index from its name.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
| group | Returned feature point group. |
| n | Returned feature point index. |
◆ readFromFile:()
| - (int) readFromFile: |
|
(NSString *) |
name |
|
Read from an FDP file.
The FDP file format consists of one line of text for each feature point, in the following format: (group).(index) (x) (y) (z) (mesh_index).(vertex_index)
- Parameters
-
- Returns
- 0 - failure, 1 - success, -1 - old version, needs reindexing.
◆ reset()
Resets all feature points.
The value of all feature points is set to "undefined".
◆ saveToFile()
Write feature point definitions to the current FDP file.
File name is the one currently used.
◆ saveToFile:()
| - (void) saveToFile: |
|
(NSString *) |
name |
|
Write feature point definitions to the FDP file, changing the FDP file name.
- Parameters
-
◆ setFP:withFeaturePoint:()
| - (void) setFP: |
|
(NSString *) |
name |
| withFeaturePoint: |
|
(FeaturePoint *) |
f |
|
|
| |
Set a feature specified by its name.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
| f | The feature point to set. |
◆ setFP:withIndex:withFeaturePoint:()
| - (void) setFP: |
|
(int) |
group |
| withIndex: |
|
(int) |
n |
| withFeaturePoint: |
|
(FeaturePoint *) |
f |
|
|
| |
Set a feature specified by its group and index.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
| f | The feature point to set. |
◆ setFPPos:withIndex:withPos:()
| - (void) setFPPos: |
|
(int) |
group |
| withIndex: |
|
(int) |
n |
| withPos: |
|
(NSArray *) |
pos |
|
|
| |
Set the position of a feature point specified by its group and index.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
| pos | Vertex position (array of 3 floating point values). |
◆ setFPPos:withIndex:withX:withY:withZ:()
| - (void) setFPPos: |
|
(int) |
group |
| withIndex: |
|
(int) |
n |
| withX: |
|
(float) |
x |
| withY: |
|
(float) |
y |
| withZ: |
|
(float) |
z |
|
|
| |
Set the position of a feature point specified by its group and index.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
| x | Vertex x position. |
| y | Vertex y position. |
| z | Vertex z position. |
◆ setFPPos:withPos:()
| - (void) setFPPos: |
|
(NSString *) |
name |
| withPos: |
|
(NSArray *) |
pos |
|
|
| |
Set the position of a feature point specified by its name.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
| pos | Vertex position (array of 3 floating point values). |
◆ setFPPos:withX:withY:withZ:()
| - (void) setFPPos: |
|
(NSString *) |
name |
| withX: |
|
(float) |
x |
| withY: |
|
(float) |
y |
| withZ: |
|
(float) |
z |
|
|
| |
Set the position of a feature point specified by its name.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
| x | Vertex x position. |
| y | Vertex y position. |
| z | Vertex z position. |
◆ setFPQuality:withIndex:withQuality:()
| - (void) setFPQuality: |
|
(int) |
group |
| withIndex: |
|
(int) |
n |
| withQuality: |
|
(float) |
quality |
|
|
| |
Set the quality of a feature point specified by its group and index.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
| quality | quality value. |
◆ setFPQuality:withQuality:()
| - (void) setFPQuality: |
|
(NSString *) |
name |
| withQuality: |
|
(float) |
quality |
|
|
| |
Set the position of a feature point specified by its name.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
| quality | quality value. |
◆ setFPSurfVert:withIndex:withSurface:withVertex:()
| - (void) setFPSurfVert: |
|
(int) |
group |
| withIndex: |
|
(int) |
n |
| withSurface: |
|
(NSString *) |
surf |
| withVertex: |
|
(int) |
vert |
|
|
| |
Assign a feature point, specified by its group and index, to a specific vertex.
- Parameters
-
| group | Feature point group. Valid range is from FDP_FP_START_GROUP_INDEX to FDP_FP_END_GROUP_INDEX. |
| n | Feature point index. Valid range is from 1 to the size of particular group. Group sizes can be obtained using groupSize(). |
| surf | Mesh id. |
| vert | Vertex index. |
◆ setFPSurfVert:withSurface:withVertex:()
| - (void) setFPSurfVert: |
|
(NSString *) |
name |
| withSurface: |
|
(NSString *) |
surf |
| withVertex: |
|
(int) |
vert |
|
|
| |
Assign a feature point, specified by its name, to a specific vertex.
- Parameters
-
| name | Feature point name (e.g. "7.1"). |
| surf | Mesh id. |
| vert | Vertex index. |
The documentation for this class was generated from the following file: