PKTMarker Class Reference

PKTMarker class. More...

#import <PKTMarker.h>

Inheritance diagram for PKTMarker:

Instance Methods
(instancetype)	- initWithMarker:withInternalId:andCustomData:andMarkerDatabase:andWidth:andHeight:
	initialize PKTMarker object More...

Class Methods
(PKTMarker *)	+ PKTMarker:withInternalId:andCustomData:andMarkerDatabase:andWidth:andHeight:
	create and initialize PKTMarker object More...

Properties
NSString *	markerId
	markerId property More...
NSNumber *	internalId
	internalId property More...
float	width
	width property More...
float	height
	height property More...
NSString *	customData
	customData property More...
PKTMarkerDatabase *	markerDatabase
	markerDatabase property More...
bool	tracking
bool	arLogoEnabled
int	patternCode

Detailed Description

PKTMarker class.

The PKTMarker is a class that model a single marker used into recognition process

Method Documentation

initWithMarker:withInternalId:andCustomData:andMarkerDatabase:andWidth:andHeight:()

- (instancetype) initWithMarker:		(NSString *)	markerId
withInternalId:		(NSNumber *)	internalId
andCustomData:		(NSString *)	customData
andMarkerDatabase:		(PKTMarkerDatabase *)	markerDatabase
andWidth:		(float)	width
andHeight:		(float)	height

initialize PKTMarker object

Parameters

markerId	marker identifier
internalId	marker internal identifier
customData	custom Data
markerDatabase	marker Database
width	marker Width
height	marker Height

Returns

a PKTMarker object

PKTMarker:withInternalId:andCustomData:andMarkerDatabase:andWidth:andHeight:()

+ (PKTMarker *) PKTMarker:		(NSString *)	markerId
withInternalId:		(NSNumber *)	internalId
andCustomData:		(NSString *)	customData
andMarkerDatabase:		(PKTMarkerDatabase *)	markerDatabase
andWidth:		(float)	width
andHeight:		(float)	height

create and initialize PKTMarker object

Parameters

markerId	marker identifier
internalId	marker internal identifier
customData	custom Data
markerDatabase	marker Database
width	marker Width
height	marker Height

Returns

a PKTMarker object

Property Documentation

customData

- (NSString*) customData

readwritenonatomicstrong

customData property

Returns

customData associated to marker

height

- (float) height

readnonatomicassign

height property

Returns

marker width

internalId

- (NSNumber*) internalId

readnonatomicassign

internalId property

Returns

a marker internal id

markerDatabase

- (PKTMarkerDatabase*) markerDatabase

readwritenonatomicstrong

markerDatabase property

Returns

PKTMarkerDatabase object associated to marker

markerId

- (NSString*) markerId

readnonatomicassign

markerId property

Returns

a marker identifier

width

- (float) width

readnonatomicassign

width property

Returns

marker width