RRAvatar3DUserAdjustmentsLayoutConfig

Objective-C

@interface RRAvatar3DUserAdjustmentsLayoutConfig : NSObject

Swift

class RRAvatar3DUserAdjustmentsLayoutConfig : NSObject

This class represents the configuration of the RRAvatar3DUserAdjustmentsLayout class. It can be loaded and stored from/to JSON files.

  • Load a configuration from a JSON file

    Declaration

    Objective-C

    + (RRAvatar3DUserAdjustmentsLayoutConfig *_Nullable)loadFromConfigFile:
        (nonnull NSString *)filePath;

    Swift

    class func load(fromConfigFile filePath: String) -> RRAvatar3DUserAdjustmentsLayoutConfig?

    Parameters

    filePath

    The file path to the JSON file which should be loaded.

    Return Value

    The loaded configuration instance on success. nil otherwise.

  • Store a configuration to a JSON file

    Declaration

    Objective-C

    - (BOOL)storeToConfigFile:(nonnull NSString *)filePath
             didFailWithError:(NSError *_Nullable *_Nullable)error;

    Swift

    func store(toConfigFile filePath: String) throws

    Parameters

    filePath

    The file path the JSON file should be stored to.

    error

    An optional pointer to an NSError pointer. When this method fails, it will set an NSError instance to this pointer if provided.

    Return Value

    YES if successful, NO otherwise.

  • Creates a template config file that can then be edited manually. Use this method as a starting point when creating a custom config file.

    Declaration

    Objective-C

    + (BOOL)createTemplateConfigFile:(nonnull NSString *)filePath
                    didFailWithError:(NSError *_Nullable *_Nullable)error;

    Swift

    class func createTemplateConfigFile(_ filePath: String) throws

    Parameters

    filePath

    The file path the template JSON file should be stored to.

    error

    An optional pointer to an NSError pointer. When this method fails, it will set an NSError instance to this pointer if provided.

    Return Value

    YES if successful, NO otherwise.