ALScanViewPluginConfig Class Reference
| Inherits from | NSObject |
|---|---|
| Conforms to | ALJSONStringRepresentable |
| Declared in | ALScanViewPluginConfig.h |
cutoutConfig
Configuration object for the associated cutout config
@property (nonatomic, readonly) ALCutoutConfig *cutoutConfigDeclared In
ALScanViewPluginConfig.h
scanFeedbackConfig
Configuration object for the associated scan feedback config
@property (nonatomic, readonly) ALScanFeedbackConfig *scanFeedbackConfigDeclared In
ALScanViewPluginConfig.h
pluginConfig
Configuration object for the associated plugin config
@property (nonatomic, readonly) ALPluginConfig *pluginConfigDeclared In
ALScanViewPluginConfig.h
– initWithPluginConfig:cutoutConfig:scanFeedbackConfig:error:
Initializes an ALScanViewPluginConfig with PluginConfig, CutoutConfig, and
ScanFeedbackConfig components.
- (instancetype _Nullable)initWithPluginConfig:(ALPluginConfig *)pluginConfig cutoutConfig:(ALCutoutConfig *_Nullable)cutoutConfig scanFeedbackConfig:(ALScanFeedbackConfig *_Nullable)scanFeedbackConfig error:(NSError *_Nullable *_Nullable)errorParameters
pluginConfig |
Configuration object for the associated plugin config |
|---|---|
cutoutConfig |
Configuration object for the associated cutout config |
scanFeedbackConfig |
Configuration object for the associated scan feedback config |
error |
NSError object which is filled with appropriate information when initialization fails |
Return Value
the ALScanViewPluginConfig instance
Declared In
ALScanViewPluginConfig.h
– initWithPluginConfig:error:
Initializes the ScanViewPluginConfig with an ALPluginConfig instance
- (instancetype _Nullable)initWithPluginConfig:(ALPluginConfig *)pluginConfig error:(NSError *_Nullable *_Nullable)errorParameters
pluginConfig |
The PluginConfig instance |
|---|---|
error |
An NSError object that is filled with the appropriate error information when initialization fails |
Return Value
the ALScanViewPluginConfig instance
Declared In
ALScanViewPluginConfig.h
– initWithJSONDictionary:error:
Initializes a ScanViewPluginConfig with an NSDictionary representing the configuration
- (instancetype _Nullable)initWithJSONDictionary:(NSDictionary *)JSONDictionary error:(NSError *_Nullable *_Nullable)errorParameters
JSONDictionary |
the JSON object representing the configuration |
|---|---|
error |
NSError object that is filled with the appropriate error information when initialization fails |
Declared In
ALScanViewPluginConfig.h
+ withPluginConfig:cutoutConfig:scanFeedbackConfig:
Creates a ScanViewPluginConfig with with PluginConfig, CutoutConfig, and ScanFeedbackConfig components.
+ (ALScanViewPluginConfig *_Nullable)withPluginConfig:(ALPluginConfig *)pluginConfig cutoutConfig:(ALCutoutConfig *_Nullable)cutoutConfig scanFeedbackConfig:(ALScanFeedbackConfig *_Nullable)scanFeedbackConfigParameters
pluginConfig |
Configuration object for the associated plugin config |
|---|---|
cutoutConfig |
(Optional) Configuration object for the associated cutout config |
scanFeedbackConfig |
(Optional) Configuration object for the associated scan feedback config |
Return Value
the ALScanViewPluginConfig instance
Declared In
ALScanViewPluginConfig.h
+ withPluginConfig:
Creates a ScanViewPluginConfig with with PluginConfig, CutoutConfig, and ScanFeedbackConfig components.
+ (ALScanViewPluginConfig *_Nullable)withPluginConfig:(ALPluginConfig *)pluginConfigParameters
pluginConfig |
Configuration object for the associated plugin config |
|---|
Return Value
the ALScanViewPluginConfig instance
Declared In
ALScanViewPluginConfig.h
+ withJSONDictionary:
Creates a ScanViewPluginConfig with an NSDictionary representing the configuration
+ (instancetype _Nullable)withJSONDictionary:(NSDictionary *)JSONDictionaryParameters
JSONDictionary |
the JSON object representing the configuration |
|---|
Return Value
the ALScanViewPluginConfig instance
Declared In
ALScanViewPluginConfig.h