MaskTemplate Class Reference

#import <FeatureTemplate.h>

Inherits NSObject.

Instance Methods
(NSMutableDictionary *)	- ToJSON

Class Methods
(MaskTemplate *)	+ FromJSON:

Properties
NSString *	name
NSString *	texture

Detailed Description

Contains a definition of a custom mask Custom mask is defined by name and a reference which is used to determine the location of the image file containg the mask.

The location for storing of custom masks is <path to platform dependent assets folder> + "/Textures/" + MaskTemnplate.texture + "/" + FeatureTemplate.type + "/" + FeatureTemplate.area.

The mesh custom mask should use is derived from the type of FeatureTemplate instance this MaskTemplate is contained in.

Method Documentation

FromJSON:

+ (MaskTemplate *) FromJSON:

(NSDictionary *)

jsonDictionary

Returns MaskTemplate object out of JSON dictionary

Parameters

jsonDictionary

JSON dictionary

Returns

deserialized MaskTemplate object

ToJSON

- (NSMutableDictionary *) ToJSON

Returns JSON dictionary out of this MaskTemplate object

Returns

JSON representation of this FeatureTemplate returned as NSMutableDictionary

Property Documentation

name

- (NSString*) name

readwritenonatomicstrong

Name of the custom texture used for identification purposes. Should be unique within a single FeatureTemplate instance.

texture

- (NSString*) texture

readwritenonatomicstrong

Location reference used to determine the location of the image file containg the mask.